tmpfiles.d.xml revision 31ed59c51126fce7d958c188772a397e2a1ed010
12b42c76672a66c2d4ea7212c14f8f1b5a62b78dTom Gundersen<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
19887cd06a3af2f045e763986eda19e208bd3f85Zbigniew Jędrzejewski-Szmek This file is part of systemd.
19887cd06a3af2f045e763986eda19e208bd3f85Zbigniew Jędrzejewski-Szmek Copyright 2010 Brandon Philips
19887cd06a3af2f045e763986eda19e208bd3f85Zbigniew Jędrzejewski-Szmek systemd is free software; you can redistribute it and/or modify it
19887cd06a3af2f045e763986eda19e208bd3f85Zbigniew Jędrzejewski-Szmek under the terms of the GNU General Public License as published by
19887cd06a3af2f045e763986eda19e208bd3f85Zbigniew Jędrzejewski-Szmek the Free Software Foundation; either version 2 of the License, or
19887cd06a3af2f045e763986eda19e208bd3f85Zbigniew Jędrzejewski-Szmek (at your option) any later version.
19887cd06a3af2f045e763986eda19e208bd3f85Zbigniew Jędrzejewski-Szmek systemd is distributed in the hope that it will be useful, but
19887cd06a3af2f045e763986eda19e208bd3f85Zbigniew Jędrzejewski-Szmek WITHOUT ANY WARRANTY; without even the implied warranty of
19887cd06a3af2f045e763986eda19e208bd3f85Zbigniew Jędrzejewski-Szmek MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19887cd06a3af2f045e763986eda19e208bd3f85Zbigniew Jędrzejewski-Szmek General Public License for more details.
19887cd06a3af2f045e763986eda19e208bd3f85Zbigniew Jędrzejewski-Szmek You should have received a copy of the GNU General Public License
19887cd06a3af2f045e763986eda19e208bd3f85Zbigniew Jędrzejewski-Szmek along with systemd; If not, see <http://www.gnu.org/licenses/>.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <productname>systemd</productname>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <contrib>Documentation</contrib>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refentrytitle>tmpfiles.d</refentrytitle>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refpurpose>Configuration for creation, deletion and
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek cleaning of volatile and temporary files</refpurpose>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refsynopsisdiv>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para><filename>/usr/lib/tmpfiles.d/*.conf</filename></para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para><filename>/etc/tmpfiles.d/*.conf</filename></para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para><filename>/run/tmpfiles.d/*.conf</filename></para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek </refsynopsisdiv>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para><command>systemd-tmpfiles</command> uses the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek configuration files from the above directories to describe the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek creation, cleaning and removal of volatile and
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek temporary files and directories which usually reside
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek in directories such as <filename>/run</filename>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek or <filename>/tmp</filename>.</para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <title>Configuration Format</title>
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering <para>Each configuration file is named in the style of
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering <filename><program>.conf</filename>. Files in
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering <filename>/etc/</filename> override files with the
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering same name in <filename>/usr/lib/</filename>. Files in
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering <filename>/run</filename> override files with the same
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering <filename>/usr/lib/</filename>. Packages should
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering install their configuration files in
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering <filename>/etc/</filename> are reserved for the local
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering administrator, who may choose to override the
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering configurations installed from packages. The list of
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering configuration files are sorted by their filename in
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering alphabetical order, regardless in which of the
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering directories they reside, to guarantee that a
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering configuration file takes precedence over another
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering configuration file with an alphabetically later
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt <para>The configuration format is one line per path
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering containing action, path, mode, ownership, age and argument
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering fields:</para>
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering <programlisting>Type Path Mode UID GID Age Argument
91913f584af38b29a816cca959ba648acd60ac9fLennart PoetteringL /tmp/foobar - - - - /dev/null</programlisting>
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering <variablelist>
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering <varlistentry>
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering <listitem><para>Create a file if it doesn't exist yet (optionally writing a short string into it, if the argument parameter is passed)</para></listitem>
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering </varlistentry>
91913f584af38b29a816cca959ba648acd60ac9fLennart Poettering <varlistentry>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>F</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <listitem><para>Create or truncate a file (optionally writing a short string into it, if the argument parameter is passed)</para></listitem>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>w</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <listitem><para>Write the argument parameter to a file, if it exists.</para></listitem>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>d</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <listitem><para>Create a directory if it doesn't exist yet</para></listitem>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>D</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <listitem><para>Create or empty a directory</para></listitem>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>p</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <listitem><para>Create a named pipe (FIFO) if it doesn't exist yet</para></listitem>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>L</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <listitem><para>Create a symlink if it doesn't exist yet</para></listitem>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>c</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <listitem><para>Create a character device node if it doesn't exist yet</para></listitem>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>b</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <listitem><para>Create a block device node if it doesn't exist yet</para></listitem>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>x</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek during cleaning. Use this type
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek to exclude paths from clean-up
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek as controlled with the Age
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek parameter. Note that lines of
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek this type do not influence the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek effect of r or R lines. Lines
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek of this type accept
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek shell-style globs in place of
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>r</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek or directory if it
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek exists. This may not be used
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek to remove non-empty
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek directories, use R for
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek that. Lines of this type
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek accept shell-style globs in
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek place of normal path
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>R</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek remove a path and all its
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek subdirectories (if it is a
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering directory). Lines of this type
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering accept shell-style globs in
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering place of normal path
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering </varlistentry>
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering <varlistentry>
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering mode and relabel security context of
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering a file or directory if it exists.
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering Lines of this type accept shell-style
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering globs in place of normal path names.
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering </varlistentry>
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering <varlistentry>
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering ownership, access mode and relabel
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering security context of a path and
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering all its subdirectories (if it is a
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering directory). Lines of this type accept
c454426c54c9beb274f415a80c64a4f1580700e7Lennart Poettering shell-style globs in place of normal
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para>The file access mode to use when
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek creating this file or directory. If omitted or
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek when set to - the default is used: 0755 for
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt directories, 0644 for all other file
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek objects. For z, Z lines if omitted or when set
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek to - the file access mode will not be
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek modified. This parameter is ignored for x, r,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek R, L lines.</para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para>The user and group to use for this file
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek or directory. This may either be a numeric
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek user/group ID or a user or group name. If
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek omitted or when set to - the default 0 (root)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek is used. For z, Z lines when omitted or when set to -
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek the file ownership will not be modified.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek These parameters are ignored for x, r, R, L lines.</para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para>The date field, when set, is used to
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek decide what files to delete when cleaning. If
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek a file or directory is older than the current
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek time minus the age field it is deleted. The
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek field format is a series of integers each
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek followed by one of the following
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek postfixes for the respective time units:</para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>s</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>min</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>h</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>m</varname></term>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <term><varname>us</varname></term></varlistentry>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para>If multiple integers and units are specified the time
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek values are summed up.</para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para>The age field only applies to lines starting with
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek d, D and x. If omitted or set to - no automatic clean-up
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para>For L lines determines the destination
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek path of the symlink. For c, b determines the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek major/minor of the device node, with major and
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek minor formatted as integers, separated by :,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek e.g. "1:3". For f, F, w may be used to specify
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek a short string that is written to the file,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek suffixed by a newline. Ignored for all other
6e9efa59209d48fc69a456fbadb2b5c113f503a6Lennart Poettering <title>/etc/tmpfiles.d/screen.conf example</title>
6e9efa59209d48fc69a456fbadb2b5c113f503a6Lennart Poettering <para><command>screen</command> needs two directories created at boot with specific modes and ownership.</para>
6e9efa59209d48fc69a456fbadb2b5c113f503a6Lennart Poettering <programlisting>d /var/run/screens 1777 root root 10d
6e9efa59209d48fc69a456fbadb2b5c113f503a6Lennart Poetteringd /var/run/uscreens 0755 root root 10d12h</programlisting>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>