chiark / gitweb /
man: updates to the passive target section
[elogind.git] / man / systemd-delta.xml
index 413ebd8..9117773 100644 (file)
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="systemd-delta">
+<refentry id="systemd-delta"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>systemd-delta</title>
@@ -49,7 +50,9 @@
 
         <refsynopsisdiv>
                 <cmdsynopsis>
-                        <command>systemd-delta <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">SUFFIX</arg></command>
+                        <command>systemd-delta</command>
+                        <arg choice="opt" rep="repeat">OPTIONS</arg>
+                        <arg choice="opt" rep="repeat"><replaceable>PREFIX</replaceable><optional>/<replaceable>SUFFIX</replaceable></optional>|<replaceable>SUFFIX</replaceable></arg>
                 </cmdsynopsis>
         </refsynopsisdiv>
 
                 <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>
+                identify and compare configuration files that override
+                other configuration files. Files in
+                <filename>/etc</filename> have highest priority, files
+                in <filename>/run</filename> have the second highest
+                priority, ..., files in <filename>/lib</filename> have
+                lowest priority. Files in a directory with higher
+                priority override files with the same name in
+                directories of lower priority. In addition, certain
+                configuration files can have <literal>.d</literal>
+                directories which contain "drop-in" files with
+                configuration snippets which augment the main
+                configuration file. "Drop-in" files can be overriden
+                in the same way by placing files with the same name in
+                a directory of higher priority (except that in case of
+                "drop-in" files, both the "drop-in" file name and the
+                name of the containing directory, which corresponds to
+                the name of the main configuration file, must match).
+                For a fuller explanation, see
+                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+                </para>
+
+                <para>The command line argument will be split into a
+                prefix and a suffix. Either is optional. The prefix
+                must be one of the directories containing
+                configuration files (<filename>/etc</filename>,
+                <filename>/run</filename>,
+                <filename>/usr/lib</filename>, ...). If it is given,
+                only overriding files contained in this directory will
+                be shown. Otherwise, all overriding files will be
+                shown. The suffix must be a name of a subdirectory
+                containing configuration files like
+                <filename>tmpfiles.d</filename>,
+                <filename>sysctl.d</filename> or
+                <filename>systemd/system</filename>. If it is given,
+                only configuration files in this subdirectory (across
+                all configuration paths) will be analyzed. Otherwise,
+                all configuration files will be analyzed. If the
+                commandline argument is not given at all, all
+                configuration files will be analyzed. See below for
+                some examples.</para>
         </refsect1>
 
         <refsect1>
 
                 <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>
 
                                 to <option>true</option>.</para></listitem>
                         </varlistentry>
 
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
+                        <xi:include href="standard-options.xml" xpointer="no-pager" />
                 </variablelist>
+        </refsect1>
+
+        <refsect1>
+                <title>Examples</title>
+
+                <para>To see all local configuration:</para>
+                <programlisting>systemd-delta</programlisting>
+
+                <para>To see all runtime configuration:</para>
+                <programlisting>systemd-delta /run</programlisting>
+
+                <para>To see all system unit configuration changes:</para>
+                <programlisting>systemd-delta systemd/system</programlisting>
 
+                <para>To see all runtime "drop-in" changes for system units:</para>
+                <programlisting>systemd-delta --type=extended /run/systemd/system</programlisting>
         </refsect1>
 
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <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>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 </para>
         </refsect1>