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