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