2011-02-13 22:08:15 +08:00
|
|
|
<?xml version='1.0'?> <!--*-nxml-*-->
|
2019-03-14 21:40:58 +08:00
|
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
2023-12-25 22:48:33 +08:00
|
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
|
2020-11-09 12:23:58 +08:00
|
|
|
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
|
2011-02-13 22:08:15 +08:00
|
|
|
|
2014-02-14 03:33:51 +08:00
|
|
|
<refentry id="systemd-tmpfiles"
|
2015-02-04 10:14:13 +08:00
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
|
|
|
|
|
|
|
|
<refentryinfo>
|
|
|
|
|
<title>systemd-tmpfiles</title>
|
|
|
|
|
<productname>systemd</productname>
|
|
|
|
|
</refentryinfo>
|
|
|
|
|
|
|
|
|
|
<refmeta>
|
|
|
|
|
<refentrytitle>systemd-tmpfiles</refentrytitle>
|
|
|
|
|
<manvolnum>8</manvolnum>
|
|
|
|
|
</refmeta>
|
|
|
|
|
|
|
|
|
|
<refnamediv>
|
|
|
|
|
<refname>systemd-tmpfiles</refname>
|
|
|
|
|
<refname>systemd-tmpfiles-setup.service</refname>
|
2023-08-12 06:54:32 +08:00
|
|
|
<refname>systemd-tmpfiles-setup-dev-early.service</refname>
|
2015-02-04 10:14:13 +08:00
|
|
|
<refname>systemd-tmpfiles-setup-dev.service</refname>
|
|
|
|
|
<refname>systemd-tmpfiles-clean.service</refname>
|
|
|
|
|
<refname>systemd-tmpfiles-clean.timer</refname>
|
2023-12-04 19:15:27 +08:00
|
|
|
<refpurpose>Create, delete, and clean up files and directories</refpurpose>
|
2015-02-04 10:14:13 +08:00
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
|
|
|
|
<cmdsynopsis>
|
|
|
|
|
<command>systemd-tmpfiles</command>
|
|
|
|
|
<arg choice="opt" rep="repeat">OPTIONS</arg>
|
|
|
|
|
<arg choice="opt" rep="repeat"><replaceable>CONFIGFILE</replaceable></arg>
|
|
|
|
|
</cmdsynopsis>
|
|
|
|
|
|
2017-11-23 17:54:29 +08:00
|
|
|
<para>System units:
|
2023-12-14 19:52:03 +08:00
|
|
|
<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>
|
2017-11-23 17:54:29 +08:00
|
|
|
|
|
|
|
|
<para>User units:
|
2023-12-14 19:52:03 +08:00
|
|
|
<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>
|
2015-02-04 10:14:13 +08:00
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Description</title>
|
|
|
|
|
|
2024-06-15 23:27:33 +08:00
|
|
|
<para><command>systemd-tmpfiles</command> creates, deletes, and cleans up files and directories, using
|
|
|
|
|
the configuration file format and location specified in
|
|
|
|
|
<citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
|
|
|
|
|
Historically, it was designed to manage volatile and temporary files, as the name suggests, but it provides
|
|
|
|
|
generic file management functionality and can be used to manage any kind of files. It must
|
2023-12-04 19:15:27 +08:00
|
|
|
be invoked with one or more commands <option>--create</option>, <option>--remove</option>, and
|
2021-03-01 03:44:25 +08:00
|
|
|
<option>--clean</option>, to select the respective subset of operations.</para>
|
2015-02-04 10:14:13 +08:00
|
|
|
|
tmpfiles,sysusers: rework path argument handling
Previously, if given an absolute path, we would open the file, but when given a
relative path, we'd attempt to search the directories. If the user wants to open
a file from the search path, allowing paths is very confusing. E.g. with a path
like 'sysusers/foo.conf', we'd try to open '/etc/sysusers.d/sysusers/foo.conf',
'/run/sysusers.d/sysusers/foo.conf', …, and with '../foo.conf', we'd try to open
'/etc/sysusers.d/../foo.conf', '/run/sysusers.d/../foo.conf', …. This just isn't
useful, and in fact for a scheme like sysusers.d and tmpfiles.d where there we
have a flat directory with config files, only searching for plain names can
result in success. When a user specifies a relative path, it's more likely that
they wanted to open some local file. OTOH, to correctly open a local file, e.g.
one that they're just writing, this interface is also awkward, because something
like '$PWD/file.conf' has to be used to open a file with a relative path.
This patch changes the interface so that any path (i.e. an argument with "/") is
used to open a file directly, and only plain basenames are used for searching.
(Note that tpmfiles and sysusers are somewhat special here: their "config files"
make sense without the other config and users are likely to want to test them
without the other config. I was trying to do just that when writing a spec file
for a package and attempting to convert the existing scripts to sysusers and
tmpfiles. The same logic wouldn't apply for example to units or udev rules,
because they generally can only be interpreted with the whole rest of config
also available.)
2023-12-04 00:06:06 +08:00
|
|
|
<para>If invoked with no arguments, directives from the configuration files found in the directories
|
|
|
|
|
specified by
|
2024-08-13 09:53:24 +08:00
|
|
|
<citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> are
|
|
|
|
|
executed. 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>
|
2019-05-21 23:08:35 +08:00
|
|
|
|
|
|
|
|
<para>System services (<filename>systemd-tmpfiles-setup.service</filename>,
|
2023-08-12 06:54:32 +08:00
|
|
|
<filename>systemd-tmpfiles-setup-dev-early.service</filename>,
|
2019-05-21 23:08:35 +08:00
|
|
|
<filename>systemd-tmpfiles-setup-dev.service</filename>,
|
|
|
|
|
<filename>systemd-tmpfiles-clean.service</filename>) invoke <command>systemd-tmpfiles</command> to create
|
|
|
|
|
system files and to perform system wide cleanup. Those services read administrator-controlled
|
|
|
|
|
configuration files in <filename>tmpfiles.d/</filename> directories. User services
|
|
|
|
|
(<filename>systemd-tmpfiles-setup.service</filename>,
|
|
|
|
|
<filename>systemd-tmpfiles-clean.service</filename>) also invoke <command>systemd-tmpfiles</command>, but
|
|
|
|
|
it reads a separate set of files, which includes user-controlled files under
|
|
|
|
|
<filename>~/.config/user-tmpfiles.d/</filename> and <filename>~/.local/share/user-tmpfiles.d/</filename>,
|
2020-08-20 00:36:32 +08:00
|
|
|
and administrator-controlled files under <filename>/usr/share/user-tmpfiles.d/</filename>. Users may use
|
2019-05-21 23:08:35 +08:00
|
|
|
this to create and clean up files under their control, but the system instance performs global cleanup
|
|
|
|
|
and is not influenced by user configuration. Note that this means a time-based cleanup configured in the
|
2020-10-06 00:08:21 +08:00
|
|
|
system instance, such as the one typically configured for <filename>/tmp/</filename>, will thus also
|
|
|
|
|
affect files created by the user instance if they are placed in <filename>/tmp/</filename>, even if the
|
2019-05-21 23:08:35 +08:00
|
|
|
user instance's time-based cleanup is turned off.</para>
|
2021-03-01 01:08:53 +08:00
|
|
|
|
2021-03-01 03:44:25 +08:00
|
|
|
<para>To re-apply settings after configuration has been modified, simply restart
|
|
|
|
|
<filename>systemd-tmpfiles-clean.service</filename>, which will apply any settings which can be safely
|
|
|
|
|
executed at runtime. To debug <command>systemd-tmpfiles</command>, it may be useful to invoke it
|
|
|
|
|
directly from the command line with increased log level (see <varname>$SYSTEMD_LOG_LEVEL</varname>
|
|
|
|
|
below).</para>
|
2015-02-04 10:14:13 +08:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
2023-12-04 19:15:27 +08:00
|
|
|
<title>Commands and options</title>
|
2015-02-04 10:14:13 +08:00
|
|
|
|
2023-12-04 19:15:27 +08:00
|
|
|
<para>The following commands are understood:</para>
|
2015-02-04 10:14:13 +08:00
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--create</option></term>
|
2023-12-04 19:15:27 +08:00
|
|
|
<listitem><para>If this command is passed, all files and
|
2015-02-04 10:14:13 +08:00
|
|
|
directories marked with
|
|
|
|
|
<varname>f</varname>,
|
|
|
|
|
<varname>F</varname>,
|
|
|
|
|
<varname>w</varname>,
|
|
|
|
|
<varname>d</varname>,
|
|
|
|
|
<varname>D</varname>,
|
|
|
|
|
<varname>v</varname>,
|
|
|
|
|
<varname>p</varname>,
|
|
|
|
|
<varname>L</varname>,
|
|
|
|
|
<varname>c</varname>,
|
|
|
|
|
<varname>b</varname>,
|
|
|
|
|
<varname>m</varname>
|
|
|
|
|
in the configuration files are created or written to. Files
|
|
|
|
|
and directories marked with
|
|
|
|
|
<varname>z</varname>,
|
|
|
|
|
<varname>Z</varname>,
|
|
|
|
|
<varname>t</varname>,
|
|
|
|
|
<varname>T</varname>,
|
|
|
|
|
<varname>a</varname>, and
|
|
|
|
|
<varname>A</varname> have their ownership, access mode and
|
2017-11-23 18:20:29 +08:00
|
|
|
security labels set.</para></listitem>
|
2015-02-04 10:14:13 +08:00
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--clean</option></term>
|
2023-12-04 19:15:27 +08:00
|
|
|
<listitem><para>If this command is passed, all files and
|
2015-02-04 10:14:13 +08:00
|
|
|
directories with an age parameter configured will be cleaned
|
|
|
|
|
up.</para></listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--remove</option></term>
|
2023-12-04 19:15:27 +08:00
|
|
|
<listitem><para>If this command is passed, the contents of
|
2015-02-04 10:14:13 +08:00
|
|
|
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
|
2023-03-28 17:05:46 +08:00
|
|
|
removed unless an exclusive or shared BSD lock is taken on them (see <citerefentry
|
|
|
|
|
project='man-pages'><refentrytitle>flock</refentrytitle><manvolnum>2</manvolnum></citerefentry>).
|
|
|
|
|
</para></listitem>
|
2015-02-04 10:14:13 +08:00
|
|
|
</varlistentry>
|
2017-11-22 21:13:32 +08:00
|
|
|
|
2022-10-13 06:46:28 +08:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--purge</option></term>
|
2024-06-18 15:55:20 +08:00
|
|
|
|
|
|
|
|
<listitem><para>If this option is passed, all files and directories marked for
|
|
|
|
|
<emphasis>creation</emphasis> by the <filename>tmpfiles.d/</filename> files specified on the command
|
|
|
|
|
line will be <emphasis>deleted</emphasis>. Specifically, this acts on all files and directories
|
|
|
|
|
marked with <varname>f</varname>, <varname>F</varname>, <varname>d</varname>, <varname>D</varname>,
|
|
|
|
|
<varname>v</varname>, <varname>q</varname>, <varname>Q</varname>, <varname>p</varname>,
|
|
|
|
|
<varname>L</varname>, <varname>c</varname>, <varname>b</varname>, <varname>C</varname>,
|
|
|
|
|
<varname>w</varname>, <varname>e</varname>. If this switch is used at least one
|
|
|
|
|
<filename>tmpfiles.d/</filename> file (or <filename>-</filename> for standard input) must be
|
|
|
|
|
specified on the command line or the invocation will be refused, for safety reasons (as otherwise
|
|
|
|
|
much of the installed system files might be removed).</para>
|
|
|
|
|
|
|
|
|
|
<para>The primary usecase for this option is to automatically remove files and directories that
|
2024-06-20 08:15:38 +08:00
|
|
|
originally have been created on behalf of an installed package at package removal time.</para>
|
2024-06-18 15:55:20 +08:00
|
|
|
|
|
|
|
|
<para>It is recommended to first run this command in combination with <option>--dry-run</option>
|
|
|
|
|
(see below) to verify which files and directories will be deleted.</para>
|
|
|
|
|
|
2024-06-22 10:46:32 +08:00
|
|
|
<para><emphasis>Warning!</emphasis> This is usually not the command you want! In most cases
|
2024-06-18 15:55:20 +08:00
|
|
|
<option>--remove</option> is what you are looking for.</para>
|
2022-10-13 06:46:28 +08:00
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v256"/></listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2017-11-23 18:20:29 +08:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--user</option></term>
|
2024-06-18 16:27:06 +08:00
|
|
|
<listitem><para>Execute "user" configuration, i.e. <filename>tmpfiles.d/</filename>
|
2023-08-23 00:52:36 +08:00
|
|
|
files in user configuration directories.</para>
|
|
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v236"/></listitem>
|
2017-11-23 18:20:29 +08:00
|
|
|
</varlistentry>
|
|
|
|
|
|
2015-02-04 10:14:13 +08:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--boot</option></term>
|
2022-10-10 00:58:01 +08:00
|
|
|
<listitem><para>Also execute lines with an exclamation mark. Lines that are not safe to be executed
|
|
|
|
|
on a running system may be marked in this way. <command>systemd-tmpfiles</command> is executed in
|
|
|
|
|
early boot with <option>--boot</option> specified and will execute those lines. When invoked again
|
2023-08-23 00:52:36 +08:00
|
|
|
later, it should be called without <option>--boot</option>.</para>
|
|
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
|
2015-02-04 10:14:13 +08:00
|
|
|
</varlistentry>
|
2017-11-22 21:13:32 +08:00
|
|
|
|
2022-10-10 00:57:25 +08:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--graceful</option></term>
|
|
|
|
|
<listitem><para>Ignore configuration lines pertaining to unknown users or groups. This option is
|
2023-08-23 00:52:36 +08:00
|
|
|
intended to be used in early boot before all users or groups have been created.</para>
|
|
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v254"/></listitem>
|
2022-10-10 00:57:25 +08:00
|
|
|
</varlistentry>
|
|
|
|
|
|
2023-12-08 16:50:38 +08:00
|
|
|
<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>
|
|
|
|
|
|
2015-02-04 10:14:13 +08:00
|
|
|
<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
|
2023-08-23 00:52:36 +08:00
|
|
|
times.</para>
|
|
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v212"/></listitem>
|
2015-02-04 10:14:13 +08:00
|
|
|
</varlistentry>
|
2020-07-28 23:52:23 +08:00
|
|
|
|
2015-02-04 10:14:13 +08:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--exclude-prefix=<replaceable>path</replaceable></option></term>
|
|
|
|
|
<listitem><para>Ignore rules with paths that start with the
|
|
|
|
|
specified prefix. This option can be specified multiple
|
2023-08-23 00:52:36 +08:00
|
|
|
times.</para>
|
|
|
|
|
|
2023-09-18 23:03:38 +08:00
|
|
|
<xi:include href="version-info.xml" xpointer="v207"/></listitem>
|
2015-02-04 10:14:13 +08:00
|
|
|
</varlistentry>
|
2017-11-16 11:00:56 +08:00
|
|
|
|
2020-07-28 23:52:23 +08:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>-E</option></term>
|
|
|
|
|
<listitem><para>A shortcut for <literal>--exclude-prefix=/dev --exclude-prefix=/proc
|
|
|
|
|
--exclude-prefix=/run --exclude-prefix=/sys</literal>, i.e. exclude the hierarchies typically backed
|
|
|
|
|
by virtual or memory file systems. This is useful in combination with <option>--root=</option>, if
|
|
|
|
|
the specified directory tree contains an OS tree without these virtual/memory file systems mounted
|
|
|
|
|
in, as it is typically not desirable to create any files and directories below these subdirectories
|
2023-08-23 00:52:36 +08:00
|
|
|
if they are supposed to be overmounted during runtime.</para>
|
|
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v247"/></listitem>
|
2020-07-28 23:52:23 +08:00
|
|
|
</varlistentry>
|
|
|
|
|
|
2015-02-04 10:14:13 +08:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--root=<replaceable>root</replaceable></option></term>
|
2017-11-16 11:00:56 +08:00
|
|
|
<listitem><para>Takes a directory path as an argument. All paths will be prefixed with the given alternate
|
|
|
|
|
<replaceable>root</replaceable> path, including config search paths.</para>
|
|
|
|
|
|
2020-05-06 05:23:00 +08:00
|
|
|
<para>When this option is used, the libc Name Service Switch (NSS) is bypassed for resolving users
|
|
|
|
|
and groups. Instead the files <filename>/etc/passwd</filename> and <filename>/etc/group</filename>
|
|
|
|
|
inside the alternate root are read directly. This means that users/groups not listed in these files
|
2020-07-28 23:52:23 +08:00
|
|
|
will not be resolved, i.e. LDAP NIS and other complex databases are not considered.</para>
|
|
|
|
|
|
|
|
|
|
<para>Consider combining this with <option>-E</option> to ensure the invocation does not create files
|
|
|
|
|
or directories below mount points in the OS image operated on that are typically overmounted during
|
2023-08-23 00:52:36 +08:00
|
|
|
runtime.</para>
|
|
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v212"/></listitem>
|
2015-02-04 10:14:13 +08:00
|
|
|
</varlistentry>
|
|
|
|
|
|
2020-07-29 01:28:43 +08:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--image=<replaceable>image</replaceable></option></term>
|
|
|
|
|
|
|
|
|
|
<listitem><para>Takes a path to a disk image file or block device node. If specified all operations
|
|
|
|
|
are applied to file system in the indicated disk image. This is similar to <option>--root=</option>
|
|
|
|
|
but operates on file systems stored in disk images or block devices. The disk image should either
|
|
|
|
|
contain just a file system or a set of file systems within a GPT partition table, following the
|
2022-11-14 16:44:39 +08:00
|
|
|
<ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions
|
2020-07-29 01:28:43 +08:00
|
|
|
Specification</ulink>. For further information on supported disk images, see
|
|
|
|
|
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
|
|
|
|
|
switch of the same name.</para>
|
|
|
|
|
|
2023-08-23 00:52:36 +08:00
|
|
|
<para>Implies <option>-E</option>.</para>
|
|
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v247"/></listitem>
|
2020-07-29 01:28:43 +08:00
|
|
|
</varlistentry>
|
|
|
|
|
|
2022-12-02 05:41:47 +08:00
|
|
|
<xi:include href="standard-options.xml" xpointer="image-policy-open" />
|
|
|
|
|
|
2018-02-05 21:53:11 +08:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--replace=<replaceable>PATH</replaceable></option></term>
|
2021-10-20 15:38:57 +08:00
|
|
|
<listitem><para>When this option is given, one or more positional arguments
|
2018-02-05 21:53:11 +08:00
|
|
|
must be specified. All configuration files found in the directories listed in
|
|
|
|
|
<citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
|
|
|
|
will be read, and the configuration given on the command line will be
|
|
|
|
|
handled instead of and with the same priority as the configuration file
|
|
|
|
|
<replaceable>PATH</replaceable>.</para>
|
|
|
|
|
|
|
|
|
|
<para>This option is intended to be used when package installation scripts
|
|
|
|
|
are running and files belonging to that package are not yet available on
|
|
|
|
|
disk, so their contents must be given on the command line, but the admin
|
|
|
|
|
configuration might already exist and should be given higher priority.
|
2023-08-23 00:52:36 +08:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v238"/></listitem>
|
2018-02-05 21:53:11 +08:00
|
|
|
</varlistentry>
|
|
|
|
|
|
2018-04-27 01:07:54 +08:00
|
|
|
<xi:include href="standard-options.xml" xpointer="cat-config" />
|
2023-10-16 00:33:10 +08:00
|
|
|
<xi:include href="standard-options.xml" xpointer="tldr" />
|
2018-06-12 21:37:53 +08:00
|
|
|
<xi:include href="standard-options.xml" xpointer="no-pager" />
|
2015-02-04 10:14:13 +08:00
|
|
|
<xi:include href="standard-options.xml" xpointer="help" />
|
|
|
|
|
<xi:include href="standard-options.xml" xpointer="version" />
|
|
|
|
|
</variablelist>
|
|
|
|
|
|
2018-10-30 02:40:42 +08:00
|
|
|
<para>It is possible to combine <option>--create</option>, <option>--clean</option>, and <option>--remove</option>
|
2019-05-21 23:08:35 +08:00
|
|
|
in one invocation (in which case removal and cleanup are executed before creation of new files). For example,
|
2018-10-30 02:40:42 +08:00
|
|
|
during boot the following command line is executed to ensure that all temporary and volatile directories are
|
2015-02-04 10:14:13 +08:00
|
|
|
removed and created according to the configuration file:</para>
|
|
|
|
|
|
|
|
|
|
<programlisting>systemd-tmpfiles --remove --create</programlisting>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
2022-07-13 17:32:39 +08:00
|
|
|
<refsect1>
|
|
|
|
|
<title>Credentials</title>
|
|
|
|
|
|
|
|
|
|
<para><command>systemd-tmpfiles</command> supports the service credentials logic as implemented by
|
2023-01-13 23:22:46 +08:00
|
|
|
<varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname>
|
2024-01-11 16:46:05 +08:00
|
|
|
(see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
|
2022-07-13 17:32:39 +08:00
|
|
|
details). The following credentials are used when passed in:</para>
|
|
|
|
|
|
2023-06-30 16:22:35 +08:00
|
|
|
<variablelist class='system-credentials'>
|
2022-07-13 17:32:39 +08:00
|
|
|
<varlistentry>
|
2023-06-30 16:22:35 +08:00
|
|
|
<term><varname>tmpfiles.extra</varname></term>
|
2022-07-13 17:32:39 +08:00
|
|
|
|
|
|
|
|
<listitem><para> The contents of this credential may contain additional lines to operate on. The
|
|
|
|
|
credential contents should follow the same format as any other <filename>tmpfiles.d/</filename>
|
|
|
|
|
drop-in configuration file. If this credential is passed it is processed after all of the drop-in
|
|
|
|
|
files read from the file system. The lines in the credential can hence augment existing lines of the
|
2023-08-23 00:52:36 +08:00
|
|
|
OS, but not override them.</para>
|
|
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v252"/></listitem>
|
2022-07-13 17:32:39 +08:00
|
|
|
</varlistentry>
|
|
|
|
|
</variablelist>
|
|
|
|
|
|
|
|
|
|
<para>Note that by default the <filename>systemd-tmpfiles-setup.service</filename> unit file (and related
|
|
|
|
|
unit files) is set up to inherit the <literal>tmpfiles.extra</literal> credential from the service
|
|
|
|
|
manager.</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
2021-03-01 01:08:53 +08:00
|
|
|
<refsect1>
|
|
|
|
|
<title>Environment</title>
|
|
|
|
|
|
|
|
|
|
<variablelist class='environment-variables'>
|
|
|
|
|
<xi:include href="common-variables.xml" xpointer="log-level" />
|
|
|
|
|
<xi:include href="common-variables.xml" xpointer="log-color" />
|
|
|
|
|
<xi:include href="common-variables.xml" xpointer="log-time" />
|
|
|
|
|
<xi:include href="common-variables.xml" xpointer="log-location" />
|
|
|
|
|
<xi:include href="common-variables.xml" xpointer="log-target" />
|
|
|
|
|
<xi:include href="common-variables.xml" xpointer="pager" />
|
|
|
|
|
<xi:include href="common-variables.xml" xpointer="less" />
|
|
|
|
|
<xi:include href="common-variables.xml" xpointer="lesscharset" />
|
|
|
|
|
<xi:include href="common-variables.xml" xpointer="lesssecure" />
|
|
|
|
|
<xi:include href="common-variables.xml" xpointer="colors" />
|
|
|
|
|
<xi:include href="common-variables.xml" xpointer="urlify" />
|
|
|
|
|
</variablelist>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
2015-02-04 10:14:13 +08:00
|
|
|
<refsect1>
|
|
|
|
|
<title>Unprivileged --cleanup operation</title>
|
|
|
|
|
|
|
|
|
|
<para><command>systemd-tmpfiles</command> tries to avoid changing
|
|
|
|
|
the access and modification times on the directories it accesses,
|
2018-02-09 10:05:49 +08:00
|
|
|
which requires <constant>CAP_FOWNER</constant> privileges. When
|
2015-02-04 10:14:13 +08:00
|
|
|
running as non-root, directories which are checked for files to
|
|
|
|
|
clean up will have their access time bumped, which might prevent
|
|
|
|
|
their cleanup.
|
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Exit status</title>
|
|
|
|
|
|
tmpfiles: make handling of existing-but-different targets more consistent
create_fifo() was added in a2fc2f8dd30c17ad1e23a31fc6ff2aeba4c6fa27, and
would always ignore failure. The test was trying to fail in this case, but
we actually don't fail, which seems to be correct. We didn't notice before
because the test was ineffective.
To make things consistent, generally log at warning level, but don't propagate
the error. For symlinks, log at debug level, as before.
For 'e', failure is not propagated now. The test is adjusted to match.
I think warning is appropriate in most cases: we do not expect a device node to
be replaced by a different device node or even a non-device file. This would
most likely be an error somewhere. An exception is made for symlinks, which are
mismatched on purpose, for example /etc/resolv.conf. With this patch, we don't
get any warnings with the any of the 74 tmpfiles.d files, which suggests that
increasing the warning levels will not cause too many unexpected warnings. If
it turns out that there are valid cases where people have expected mismatches
for non-symlink types, we can always decrease the log levels again.
2021-04-08 06:48:35 +08:00
|
|
|
<para>On success, 0 is returned. If the configuration was syntactically invalid (syntax errors, missing
|
|
|
|
|
arguments, …), so some lines had to be ignored, but no other errors occurred, <constant>65</constant> is
|
|
|
|
|
returned (<constant>EX_DATAERR</constant> from <filename>/usr/include/sysexits.h</filename>). If the
|
|
|
|
|
configuration was syntactically valid, but could not be executed (lack of permissions, creation of files
|
|
|
|
|
in missing directories, invalid contents when writing to <filename>/sys/</filename> values, …),
|
|
|
|
|
<constant>73</constant> is returned (<constant>EX_CANTCREAT</constant> from
|
|
|
|
|
<filename>/usr/include/sysexits.h</filename>). Otherwise, <constant>1</constant> is returned
|
|
|
|
|
(<constant>EXIT_FAILURE</constant> from <filename>/usr/include/stdlib.h</filename>).</para>
|
|
|
|
|
|
|
|
|
|
<para>Note: when creating items, if the target already exists, but is of the wrong type or otherwise does
|
|
|
|
|
not match the requested state, and forced operation has not been requested with <literal>+</literal>,
|
|
|
|
|
a message is emitted, but the failure is otherwise ignored.</para>
|
2015-02-04 10:14:13 +08:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>See Also</title>
|
2023-12-23 02:09:32 +08:00
|
|
|
<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>
|
2015-02-04 10:14:13 +08:00
|
|
|
</refsect1>
|
2011-02-13 22:08:15 +08:00
|
|
|
|
|
|
|
|
</refentry>
|
