man/systemd-delta.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="systemd-delta"
   7     xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>systemd-delta</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-delta</refentrytitle>
  16     <manvolnum>1</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-delta</refname>
  21     <refpurpose>Find overridden configuration files</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>systemd-delta</command>
  27       <arg choice="opt" rep="repeat">OPTIONS</arg>
  28       <group choice="opt" rep="repeat">
  29         <arg choice="plain"><replaceable>PREFIX</replaceable></arg>
  30         <arg choice="plain"><replaceable>PREFIX</replaceable>/<replaceable>SUFFIX</replaceable></arg>
  31         <arg choice="plain"><replaceable>SUFFIX</replaceable></arg>
  32       </group>
  33     </cmdsynopsis>
  34   </refsynopsisdiv>
  35
  36   <refsect1>
  37     <title>Description</title>
  38
  39     <para><command>systemd-delta</command> may be used to identify and
  40     compare configuration files that override other configuration
  41     files. Files in <filename>/etc/</filename> have highest priority,
  42     files in <filename>/run/</filename> have the second highest
  43     priority, …, files in <filename>/usr/lib/</filename> have lowest
  44     priority. Files in a directory with higher priority override files
  45     with the same name in directories of lower priority. In addition,
  46     certain configuration files can have <literal>.d</literal>
  47     directories which contain "drop-in" files with configuration
  48     snippets which augment the main configuration file. "Drop-in"
  49     files can be overridden in the same way by placing files with the
  50     same name in a directory of higher priority (except that, in case
  51     of "drop-in" files, both the "drop-in" file name and the name of
  52     the containing directory, which corresponds to the name of the
  53     main configuration file, must match). For a fuller explanation,
  54     see
  55     <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  56     </para>
  57
  58     <para>The command line argument will be split into a prefix and a
  59     suffix. Either is optional. The prefix must be one of the
  60     directories containing configuration files
  61     (<filename>/etc/</filename>, <filename>/run/</filename>,
  62     <filename>/usr/lib/</filename>, …). If it is given, only
  63     overriding files contained in this directory will be shown.
  64     Otherwise, all overriding files will be shown. The suffix must be
  65     a name of a subdirectory containing configuration files like
  66     <filename>tmpfiles.d</filename>, <filename>sysctl.d</filename> or
  67     <filename>systemd/system</filename>. If it is given, only
  68     configuration files in this subdirectory (across all configuration
  69     paths) will be analyzed. Otherwise, all configuration files will
  70     be analyzed. If the command line argument is not given at all, all
  71     configuration files will be analyzed. See below for some
  72     examples.</para>
  73   </refsect1>
  74
  75   <refsect1>
  76     <title>Options</title>
  77
  78     <para>The following options are understood:</para>
  79
  80     <variablelist>
  81       <varlistentry>
  82         <term><option>-t</option></term>
  83         <term><option>--type=</option></term>
  84
  85         <listitem><para>When listing the differences, only list those
  86         that are asked for. The list itself is a comma-separated list
  87         of desired difference types.</para>
  88
  89         <para>Recognized types are:
  90
  91           <variablelist>
  92             <varlistentry>
  93               <term><varname>masked</varname></term>
  94
  95               <listitem><para>Show masked files</para></listitem>
  96             </varlistentry>
  97
  98             <varlistentry>
  99               <term><varname>equivalent</varname></term>
 100
 101               <listitem><para>Show overridden files that while
 102               overridden, do not differ in content.</para></listitem>
 103             </varlistentry>
 104
 105             <varlistentry>
 106               <term><varname>redirected</varname></term>
 107
 108               <listitem><para>Show files that are redirected to
 109               another.</para></listitem>
 110             </varlistentry>
 111
 112             <varlistentry>
 113               <term><varname>overridden</varname></term>
 114
 115               <listitem><para>Show overridden, and changed
 116               files.</para></listitem>
 117             </varlistentry>
 118
 119             <varlistentry>
 120               <term><varname>extended</varname></term>
 121
 122               <listitem><para>Show <filename>*.conf</filename> files
 123               in drop-in directories for units.</para>
 124
 125               <xi:include href="version-info.xml" xpointer="v205"/></listitem>
 126             </varlistentry>
 127
 128             <varlistentry>
 129               <term><varname>unchanged</varname></term>
 130
 131               <listitem><para>Show unmodified files
 132               too.</para></listitem>
 133             </varlistentry>
 134           </variablelist>
 135         </para></listitem>
 136       </varlistentry>
 137
 138       <varlistentry>
 139         <term><option>--diff=</option></term>
 140
 141         <listitem><para>When showing modified files, when a file is
 142         overridden show a diff as well. This option takes a boolean
 143         argument. If omitted, it defaults to
 144         <option>true</option>.</para></listitem>
 145       </varlistentry>
 146
 147       <xi:include href="standard-options.xml" xpointer="help" />
 148       <xi:include href="standard-options.xml" xpointer="version" />
 149       <xi:include href="standard-options.xml" xpointer="no-pager" />
 150     </variablelist>
 151   </refsect1>
 152
 153   <refsect1>
 154     <title>Examples</title>
 155
 156     <para>To see all local configuration:</para>
 157     <programlisting>systemd-delta</programlisting>
 158
 159     <para>To see all runtime configuration:</para>
 160     <programlisting>systemd-delta /run</programlisting>
 161
 162     <para>To see all system unit configuration changes:</para>
 163     <programlisting>systemd-delta systemd/system</programlisting>
 164
 165     <para>To see all runtime "drop-in" changes for system units:</para>
 166     <programlisting>systemd-delta --type=extended /run/systemd/system</programlisting>
 167   </refsect1>
 168
 169   <refsect1>
 170     <title>Exit status</title>
 171
 172     <para>On success, 0 is returned, a non-zero failure code
 173     otherwise.</para>
 174   </refsect1>
 175
 176   <refsect1>
 177     <title>See Also</title>
 178     <para><simplelist type="inline">
 179       <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
 180       <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
 181     </simplelist></para>
 182   </refsect1>
 183
 184 </refentry>