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