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