man/systemd-delta.xml

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