man: wording and grammar updates

[thirdparty/systemd.git] / man / systemd-delta.xml

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2012 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="systemd-delta">

        <refentryinfo>
                <title>systemd-delta</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>systemd-delta</refentrytitle>
                <manvolnum>1</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>systemd-delta</refname>
                <refpurpose>Find overridden configuration files</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <cmdsynopsis>
                        <command>systemd-delta <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">SUFFIX</arg></command>
                </cmdsynopsis>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>systemd-delta</command> may be used to
                identify and compare configuration files in
                <filename>/etc</filename> that override default
                counterparts in <filename>/usr</filename>. The command
                line argument can be one or more name of a subdirectories of
                <filename>/etc</filename> or
                <filename>/usr/lib</filename> to compare, such as
                <filename>tmpfiles.d</filename>, <filename>sysctl.d</filename> or
                <filename>systemd/system</filename>.</para>

                <para>When no argument is specified a number of
                well-known subdirectories are searched for overridden
                files.</para>
        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>The following options are understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><option>-h</option></term>
                                <term><option>--help</option></term>

                                <listitem><para>Prints a short help
                                text and exits.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--version</option></term>

                                <listitem><para>Prints a short version
                                string and exits.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--no-pager</option></term>

                                <listitem><para>Do not pipe output into a
                                pager.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-t</option></term>
                                <term><option>--type=</option></term>

                                <listitem><para>When listing the
                                differences, only list those that are
                                asked for. The list itself is a
                                comma-separated list of desired
                                difference types.</para>

                                <para>Recognized types are:

                                        <variablelist>
                                                <varlistentry>
                                                        <term><varname>masked</varname></term>

                                                        <listitem><para>Show masked files</para></listitem>
                                                </varlistentry>

                                                <varlistentry>
                                                        <term><varname>equivalent</varname></term>

                                                        <listitem><para>Show overridden
                                                        files that while overridden, do
                                                        not differ in content.</para></listitem>
                                                </varlistentry>

                                                <varlistentry>
                                                        <term><varname>redirected</varname></term>

                                                        <listitem><para>Show files that
                                                        are redirected to another.</para></listitem>
                                                </varlistentry>

                                                <varlistentry>
                                                        <term><varname>overridden</varname></term>

                                                        <listitem><para>Show overridden,
                                                        and changed files.</para></listitem>
                                                </varlistentry>

                                                <varlistentry>
                                                        <term><varname>extended</varname></term>

                                                        <listitem><para>Show *.conf files in drop-in
                                                        directories for units.</para></listitem>
                                                </varlistentry>

                                                <varlistentry>
                                                        <term><varname>unchanged</varname></term>

                                                        <listitem><para>Show unmodified
                                                        files too.</para></listitem>
                                                </varlistentry>
                                        </variablelist>
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--diff=</option></term>

                                <listitem><para>When showing modified
                                files, when a file is overridden show a
                                diff as well. This option takes a
                                boolean argument. If omitted, it defaults
                                to <option>true</option>.</para></listitem>
                        </varlistentry>

                </variablelist>

        </refsect1>

        <refsect1>
                <title>Exit status</title>

                <para>On success 0 is returned, a non-zero failure
                code otherwise.</para>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>