summaryrefslogtreecommitdiffstats
path: root/man/systemd-tmpfiles.xml
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-12 03:50:40 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-12 03:50:40 +0000
commitfc53809803cd2bc2434e312b19a18fa36776da12 (patch)
treeb4b43bd6538f51965ce32856e9c053d0f90919c8 /man/systemd-tmpfiles.xml
parentAdding upstream version 255.5. (diff)
downloadsystemd-fc53809803cd2bc2434e312b19a18fa36776da12.tar.xz
systemd-fc53809803cd2bc2434e312b19a18fa36776da12.zip
Adding upstream version 256.upstream/256
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man/systemd-tmpfiles.xml')
-rw-r--r--man/systemd-tmpfiles.xml82
1 files changed, 53 insertions, 29 deletions
diff --git a/man/systemd-tmpfiles.xml b/man/systemd-tmpfiles.xml
index d0f8ed3..008bff6 100644
--- a/man/systemd-tmpfiles.xml
+++ b/man/systemd-tmpfiles.xml
@@ -1,6 +1,6 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="systemd-tmpfiles"
@@ -23,8 +23,7 @@
<refname>systemd-tmpfiles-setup-dev.service</refname>
<refname>systemd-tmpfiles-clean.service</refname>
<refname>systemd-tmpfiles-clean.timer</refname>
- <refpurpose>Creates, deletes and cleans up volatile
- and temporary files and directories</refpurpose>
+ <refpurpose>Create, delete, and clean up files and directories</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -35,16 +34,22 @@
</cmdsynopsis>
<para>System units:
-<literallayout><filename>systemd-tmpfiles-setup.service</filename>
-<filename>systemd-tmpfiles-setup-dev-early.service</filename>
-<filename>systemd-tmpfiles-setup-dev.service</filename>
-<filename>systemd-tmpfiles-clean.service</filename>
-<filename>systemd-tmpfiles-clean.timer</filename></literallayout></para>
+ <simplelist>
+ <member><filename>systemd-tmpfiles-setup.service</filename></member>
+ <member><filename>systemd-tmpfiles-setup-dev-early.service</filename></member>
+ <member><filename>systemd-tmpfiles-setup-dev.service</filename></member>
+ <member><filename>systemd-tmpfiles-clean.service</filename></member>
+ <member><filename>systemd-tmpfiles-clean.timer</filename></member>
+ </simplelist>
+ </para>
<para>User units:
-<literallayout><filename>systemd-tmpfiles-setup.service</filename>
-<filename>systemd-tmpfiles-clean.service</filename>
-<filename>systemd-tmpfiles-clean.timer</filename></literallayout></para>
+ <simplelist>
+ <member><filename>systemd-tmpfiles-setup.service</filename></member>
+ <member><filename>systemd-tmpfiles-clean.service</filename></member>
+ <member><filename>systemd-tmpfiles-clean.timer</filename></member>
+ </simplelist>
+ </para>
</refsynopsisdiv>
<refsect1>
@@ -53,17 +58,20 @@
<para><command>systemd-tmpfiles</command> creates, deletes, and cleans up volatile and temporary files
and directories, using the configuration file format and location specified in
<citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>. It must
- be invoked with one or more options <option>--create</option>, <option>--remove</option>, and
+ be invoked with one or more commands <option>--create</option>, <option>--remove</option>, and
<option>--clean</option>, to select the respective subset of operations.</para>
- <para>By default, directives from all configuration files are applied. When invoked with
- <option>--replace=<replaceable>PATH</replaceable></option>, arguments specified on the command line are
- used instead of the configuration file <replaceable>PATH</replaceable>. Otherwise, if one or more
- absolute filenames are passed on the command line, only the directives in these files are applied. If
- <literal>-</literal> is specified instead of a filename, directives are read from standard input. If only
- the basename of a configuration file is specified, all configuration directories as specified in
- <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> are
- searched for a matching file and the file found that has the highest priority is executed.</para>
+ <para>If invoked with no arguments, directives from the configuration files found in the directories
+ specified by
+ <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>. When
+ invoked with positional arguments, if option <option>--replace=<replaceable>PATH</replaceable></option>
+ is specified, arguments specified on the command line are used instead of the configuration file
+ <replaceable>PATH</replaceable>. Otherwise, just the configuration specified by the command line
+ arguments is executed. If the string <literal>-</literal> is specified instead of a filename, the
+ configuration is read from standard input. If the argument is a file name (without any slashes), all
+ configuration directories are searched for a matching file and the file found that has the highest
+ priority is executed. If the argument is a path, that file is used directly without searching the
+ configuration directories for any other matching file.</para>
<para>System services (<filename>systemd-tmpfiles-setup.service</filename>,
<filename>systemd-tmpfiles-setup-dev-early.service</filename>,
@@ -90,14 +98,14 @@
</refsect1>
<refsect1>
- <title>Options</title>
+ <title>Commands and options</title>
- <para>The following options are understood:</para>
+ <para>The following commands are understood:</para>
<variablelist>
<varlistentry>
<term><option>--create</option></term>
- <listitem><para>If this option is passed, all files and
+ <listitem><para>If this command is passed, all files and
directories marked with
<varname>f</varname>,
<varname>F</varname>,
@@ -123,14 +131,14 @@
<varlistentry>
<term><option>--clean</option></term>
- <listitem><para>If this option is passed, all files and
+ <listitem><para>If this command is passed, all files and
directories with an age parameter configured will be cleaned
up.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--remove</option></term>
- <listitem><para>If this option is passed, the contents of
+ <listitem><para>If this command is passed, the contents of
directories marked with <varname>D</varname> or
<varname>R</varname>, and files or directories themselves
marked with <varname>r</varname> or <varname>R</varname> are
@@ -140,6 +148,14 @@
</varlistentry>
<varlistentry>
+ <term><option>--purge</option></term>
+ <listitem><para>If this option is passed, all files and directories created by a
+ <filename>tmpfiles.d/</filename> entry will be deleted.</para>
+
+ <xi:include href="version-info.xml" xpointer="v256"/></listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>--user</option></term>
<listitem><para>Execute "user" configuration, i.e. <filename>tmpfiles.d</filename>
files in user configuration directories.</para>
@@ -166,6 +182,14 @@
</varlistentry>
<varlistentry>
+ <term><option>--dry-run</option></term>
+ <listitem><para>Process the configuration and print what operations would be performed, but don't
+ actually change anything in the file system.</para>
+
+ <xi:include href="version-info.xml" xpointer="v256"/></listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>--prefix=<replaceable>path</replaceable></option></term>
<listitem><para>Only apply rules with paths that start with
the specified prefix. This option can be specified multiple
@@ -340,10 +364,10 @@
<refsect1>
<title>See Also</title>
- <para>
- <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- </para>
+ <para><simplelist type="inline">
+ <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ </simplelist></para>
</refsect1>
</refentry>