[thirdparty/systemd.git] / man / tmpfiles.d.xml

<?xml version="1.0"?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
  This file is part of systemd.

  Copyright 2010 Brandon Philips

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="tmpfiles.d">

        <refentryinfo>
                <title>tmpfiles.d</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Documentation</contrib>
                                <firstname>Brandon</firstname>
                                <surname>Philips</surname>
                                <email>brandon@ifup.org</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>tmpfiles.d</refentrytitle>
                <manvolnum>5</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>tmpfiles.d</refname>
                <refpurpose>Configuration for creation, deletion and
                cleaning of volatile and temporary files</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>/etc/tmpfiles.d/*.conf</filename></para>
                <para><filename>/run/tmpfiles.d/*.conf</filename></para>
                <para><filename>/usr/lib/tmpfiles.d/*.conf</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>systemd-tmpfiles</command> uses the
                configuration files from the above directories to describe the
                creation, cleaning and removal of volatile and
                temporary files and directories which usually reside
                in directories such as <filename>/run</filename>
                or <filename>/tmp</filename>.</para>
        </refsect1>

        <refsect1>
                <title>Configuration Format</title>

                <para>Each configuration file shall be named in the
                style of <filename>&lt;program&gt;.conf</filename>.
                Files in <filename>/etc/</filename> override files
                with the same name in <filename>/usr/lib/</filename>
                and <filename>/run/</filename>.  Files in
                <filename>/run/</filename> override files with the same
                name in <filename>/usr/lib/</filename>. Packages
                should install their configuration files in
                <filename>/usr/lib/</filename>. Files in
                <filename>/etc/</filename> are reserved for the local
                administrator, who may use this logic to override the
                configuration files installed by vendor packages. All
                configuration files are sorted by their filename in
                alphabetical order, regardless in which of the
                directories they reside, to guarantee that a specific
                configuration file takes precedence over another file
                with an alphabetically later name.</para>

                <para>If the administrator wants to disable a
                configuration file supplied by the vendor the
                recommended way is to place a symlink to
                <filename>/dev/null</filename> in
                <filename>/etc/tmpfiles.d/</filename> bearing the
                same file name.</para>

                <para>The configuration format is one line per path
                containing action, path, mode, ownership, age and argument
                fields:</para>

                <programlisting>Type Path        Mode UID  GID  Age Argument
d    /run/user   0755 root root 10d -
L    /tmp/foobar -    -    -    -   /dev/null</programlisting>

                <refsect2>
                        <title>Type</title>
                        <variablelist>
                                <varlistentry>
                                        <term><varname>f</varname></term>
                                        <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>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>F</varname></term>
                                        <listitem><para>Create or truncate a file (optionally writing a short string into it, if the argument parameter is passed)</para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>w</varname></term>
                                        <listitem><para>Write the argument parameter to a file, if the file exists.
                                            Lines of this type accept shell-style globs in place of normal path
                                            names. The argument parameter will be written without a trailing
                                            newline. C-style backslash escapes are interpreted.</para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>d</varname></term>
                                        <listitem><para>Create a directory if it doesn't exist yet</para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>D</varname></term>
                                        <listitem><para>Create or empty a directory</para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>p</varname></term>
                                        <listitem><para>Create a named pipe (FIFO) if it doesn't exist yet</para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>L</varname></term>
                                        <listitem><para>Create a symlink if it doesn't exist yet</para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>c</varname></term>
                                        <listitem><para>Create a character device node if it doesn't exist yet</para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>b</varname></term>
                                        <listitem><para>Create a block device node if it doesn't exist yet</para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>x</varname></term>
                                        <listitem><para>Ignore a path
                                        during cleaning. Use this type
                                        to exclude paths from clean-up
                                        as controlled with the Age
                                        parameter. Note that lines of
                                        this type do not influence the
                                        effect of r or R lines. Lines
                                        of this type accept
                                        shell-style globs in place of
                                        of normal path
                                        names.</para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>r</varname></term>
                                        <listitem><para>Remove a file
                                        or directory if it
                                        exists. This may not be used
                                        to remove non-empty
                                        directories, use R for
                                        that. Lines of this type
                                        accept shell-style globs in
                                        place of normal path
                                        names.</para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>R</varname></term>
                                        <listitem><para>Recursively
                                        remove a path and all its
                                        subdirectories (if it is a
                                        directory). Lines of this type
                                        accept shell-style globs in
                                        place of normal path
                                        names.</para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>z</varname></term>
                                        <listitem><para>Restore
                                        SELinux security context label
                                        and set ownership and access
                                        mode of a file or directory if
                                        it exists.  Lines of this type
                                        accept shell-style globs in
                                        place of normal path names.
                                        </para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>Z</varname></term>
                                        <listitem><para>Recursively
                                        restore SELinux security
                                        context label and set
                                        ownership and access mode of a
                                        path and all its
                                        subdirectories (if it is a
                                        directory). Lines of this type
                                        accept shell-style globs in
                                        place of normal path
                                        names.</para></listitem>
                                </varlistentry>
                        </variablelist>
                </refsect2>

                <refsect2>
                        <title>Mode</title>

                        <para>The file access mode to use when
                        creating this file or directory. If omitted or
                        when set to - the default is used: 0755 for
                        directories, 0644 for all other file
                        objects. For z, Z lines if omitted or when set
                        to - the file access mode will not be
                        modified. This parameter is ignored for x, r,
                        R, L lines.</para>
                </refsect2>

                <refsect2>
                        <title>UID, GID</title>

                        <para>The user and group to use for this file
                        or directory. This may either be a numeric
                        user/group ID or a user or group name. If
                        omitted or when set to - the default 0 (root)
                        is used. For z, Z lines when omitted or when set to -
                        the file ownership will not be modified.
                        These parameters are ignored for x, r, R, L lines.</para>
                </refsect2>

                <refsect2>
                        <title>Age</title>
                        <para>The date field, when set, is used to
                        decide what files to delete when cleaning. If
                        a file or directory is older than the current
                        time minus the age field it is deleted. The
                        field format is a series of integers each
                        followed by one of the following
                        postfixes for the respective time units:</para>

                        <variablelist>
                                <varlistentry>
                                <term><varname>s</varname></term>
                                <term><varname>min</varname></term>
                                <term><varname>h</varname></term>
                                <term><varname>d</varname></term>
                                <term><varname>w</varname></term>
                                <term><varname>ms</varname></term>
                                <term><varname>m</varname></term>
                                <term><varname>us</varname></term></varlistentry>
                        </variablelist>

                        <para>If multiple integers and units are specified the time
                        values are summed up.</para>

                        <para>The age field only applies to lines starting with
                        d, D and x. If omitted or set to - no automatic clean-up
                        is done.</para>

                        <para>If the age field starts with a tilde
                        character (~) the clean-up is only applied to
                        files and directories one level inside the
                        directory specified, but not the files and
                        directories immediately inside it.</para>
                </refsect2>

                <refsect2>
                        <title>Argument</title>

                        <para>For L lines determines the destination
                        path of the symlink. For c, b determines the
                        major/minor of the device node, with major and
                        minor formatted as integers, separated by :,
                        e.g. "1:3". For f, F, w may be used to specify
                        a short string that is written to the file,
                        suffixed by a newline. Ignored for all other
                        lines.</para>
                </refsect2>

        </refsect1>

        <refsect1>
                <title>Example</title>
                <example>
                        <title>/etc/tmpfiles.d/screen.conf example</title>
                        <para><command>screen</command> needs two directories created at boot with specific modes and ownership.</para>

                        <programlisting>d /var/run/screens  1777 root root 10d
d /var/run/uscreens 0755 root root 10d12h</programlisting>
                </example>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>
Commit	Line	Data
4149f86d BP	1	<?xml version="1.0"?>
	2	<!---nxml--->
	3	<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
	4	<!--
	5	This file is part of systemd.
	6
	7	Copyright 2010 Brandon Philips
	8
	9	systemd is free software; you can redistribute it and/or modify it
5430f7f2 LP	10	under the terms of the GNU Lesser General Public License as published by
5430f7f2 LP	11	the Free Software Foundation; either version 2.1 of the License, or
4149f86d BP	12	(at your option) any later version.
	13
	14	systemd is distributed in the hope that it will be useful, but
	15	WITHOUT ANY WARRANTY; without even the implied warranty of
	16	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5430f7f2	17	Lesser General Public License for more details.
4149f86d	18
5430f7f2	19	You should have received a copy of the GNU Lesser General Public License
4149f86d BP	20	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	21	-->
	22	<refentry id="tmpfiles.d">
	23
	24	<refentryinfo>
	25	<title>tmpfiles.d</title>
	26	<productname>systemd</productname>
	27
	28	<authorgroup>
	29	<author>
	30	<contrib>Documentation</contrib>
	31	<firstname>Brandon</firstname>
	32	<surname>Philips</surname>
	33	<email>brandon@ifup.org</email>
	34	</author>
	35	</authorgroup>
	36	</refentryinfo>
	37
	38	<refmeta>
	39	<refentrytitle>tmpfiles.d</refentrytitle>
	40	<manvolnum>5</manvolnum>
	41	</refmeta>
	42
	43	<refnamediv>
	44	<refname>tmpfiles.d</refname>
522d4a49 LP	45	<refpurpose>Configuration for creation, deletion and
522d4a49 LP	46	cleaning of volatile and temporary files</refpurpose>
4149f86d BP	47	</refnamediv>
4149f86d BP	48
a7c64469 LP	49	<refsynopsisdiv>
a7c64469 LP	50	<para><filename>/etc/tmpfiles.d/*.conf</filename></para>
772f8371	51	<para><filename>/run/tmpfiles.d/*.conf</filename></para>
fc1a2e06	52	<para><filename>/usr/lib/tmpfiles.d/*.conf</filename></para>
a7c64469 LP	53	</refsynopsisdiv>
a7c64469 LP	54
4149f86d BP	55	<refsect1>
	56	<title>Description</title>
	57
0e25e94e KS	58	<para><command>systemd-tmpfiles</command> uses the
	59	configuration files from the above directories to describe the
	60	creation, cleaning and removal of volatile and
	61	temporary files and directories which usually reside
	62	in directories such as <filename>/run</filename>
	63	or <filename>/tmp</filename>.</para>
4149f86d BP	64	</refsect1>
	65
	66	<refsect1>
0e25e94e	67	<title>Configuration Format</title>
4149f86d	68
6110885c KS	69	<para>Each configuration file shall be named in the
	70	style of <filename><program>.conf</filename>.
	71	Files in <filename>/etc/</filename> override files
	72	with the same name in <filename>/usr/lib/</filename>
	73	and <filename>/run/</filename>. Files in
	74	<filename>/run/</filename> override files with the same
	75	name in <filename>/usr/lib/</filename>. Packages
	76	should install their configuration files in
	77	<filename>/usr/lib/</filename>. Files in
468d726b	78	<filename>/etc/</filename> are reserved for the local
6110885c KS	79	administrator, who may use this logic to override the
6110885c KS	80	configuration files installed by vendor packages. All
468d726b LP	81	configuration files are sorted by their filename in
468d726b LP	82	alphabetical order, regardless in which of the
6110885c KS	83	directories they reside, to guarantee that a specific
6110885c KS	84	configuration file takes precedence over another file
15324492	85	with an alphabetically later name.</para>
6110885c KS	86
	87	<para>If the administrator wants to disable a
	88	configuration file supplied by the vendor the
	89	recommended way is to place a symlink to
	90	<filename>/dev/null</filename> in
	91	<filename>/etc/tmpfiles.d/</filename> bearing the
	92	same file name.</para>
772f8371	93
0e25e94e KS	94	<para>The configuration format is one line per path
	95	containing action, path, mode, ownership, age and argument
	96	fields:</para>
aeee2322	97
468d726b LP	98	<programlisting>Type Path Mode UID GID Age Argument
	99	d /run/user 0755 root root 10d -
	100	L /tmp/foobar - - - - /dev/null</programlisting>
aeee2322 LP	101
aeee2322 LP	102	<refsect2>
88aebb62	103	<title>Type</title>
aeee2322 LP	104	<variablelist>
	105	<varlistentry>
	106	<term><varname>f</varname></term>
31ed59c5	107	<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>
aeee2322 LP	108	</varlistentry>
	109
	110	<varlistentry>
	111	<term><varname>F</varname></term>
31ed59c5 LP	112	<listitem><para>Create or truncate a file (optionally writing a short string into it, if the argument parameter is passed)</para></listitem>
	113	</varlistentry>
	114
	115	<varlistentry>
	116	<term><varname>w</varname></term>
54693d9b DR	117	<listitem><para>Write the argument parameter to a file, if the file exists.
	118	Lines of this type accept shell-style globs in place of normal path
	119	names. The argument parameter will be written without a trailing
	120	newline. C-style backslash escapes are interpreted.</para></listitem>
aeee2322 LP	121	</varlistentry>
	122
	123	<varlistentry>
	124	<term><varname>d</varname></term>
a7c64469	125	<listitem><para>Create a directory if it doesn't exist yet</para></listitem>
aeee2322 LP	126	</varlistentry>
	127
	128	<varlistentry>
	129	<term><varname>D</varname></term>
a7c64469	130	<listitem><para>Create or empty a directory</para></listitem>
aeee2322 LP	131	</varlistentry>
aeee2322 LP	132
ee17ee7c LP	133	<varlistentry>
	134	<term><varname>p</varname></term>
	135	<listitem><para>Create a named pipe (FIFO) if it doesn't exist yet</para></listitem>
	136	</varlistentry>
	137
468d726b LP	138	<varlistentry>
	139	<term><varname>L</varname></term>
	140	<listitem><para>Create a symlink if it doesn't exist yet</para></listitem>
	141	</varlistentry>
	142
	143	<varlistentry>
	144	<term><varname>c</varname></term>
	145	<listitem><para>Create a character device node if it doesn't exist yet</para></listitem>
	146	</varlistentry>
	147
	148	<varlistentry>
	149	<term><varname>b</varname></term>
	150	<listitem><para>Create a block device node if it doesn't exist yet</para></listitem>
	151	</varlistentry>
	152
aeee2322 LP	153	<varlistentry>
aeee2322 LP	154	<term><varname>x</varname></term>
b8bb3e8f LP	155	<listitem><para>Ignore a path
	156	during cleaning. Use this type
	157	to exclude paths from clean-up
	158	as controlled with the Age
	159	parameter. Note that lines of
	160	this type do not influence the
	161	effect of r or R lines. Lines
	162	of this type accept
	163	shell-style globs in place of
	164	of normal path
	165	names.</para></listitem>
aeee2322 LP	166	</varlistentry>
	167
	168	<varlistentry>
	169	<term><varname>r</varname></term>
b8bb3e8f LP	170	<listitem><para>Remove a file
	171	or directory if it
	172	exists. This may not be used
	173	to remove non-empty
	174	directories, use R for
	175	that. Lines of this type
	176	accept shell-style globs in
	177	place of normal path
	178	names.</para></listitem>
aeee2322 LP	179	</varlistentry>
	180
	181	<varlistentry>
	182	<term><varname>R</varname></term>
b8bb3e8f LP	183	<listitem><para>Recursively
	184	remove a path and all its
	185	subdirectories (if it is a
	186	directory). Lines of this type
	187	accept shell-style globs in
	188	place of normal path
	189	names.</para></listitem>
aeee2322	190	</varlistentry>
462d63db	191
777b87e7 MS	192	<varlistentry>
777b87e7 MS	193	<term><varname>z</varname></term>
669e49fe LP	194	<listitem><para>Restore
	195	SELinux security context label
	196	and set ownership and access
	197	mode of a file or directory if
	198	it exists. Lines of this type
	199	accept shell-style globs in
	200	place of normal path names.
777b87e7 MS	201	</para></listitem>
	202	</varlistentry>
	203
462d63db MS	204	<varlistentry>
462d63db MS	205	<term><varname>Z</varname></term>
669e49fe LP	206	<listitem><para>Recursively
	207	restore SELinux security
	208	context label and set
	209	ownership and access mode of a
	210	path and all its
	211	subdirectories (if it is a
	212	directory). Lines of this type
	213	accept shell-style globs in
	214	place of normal path
	215	names.</para></listitem>
462d63db	216	</varlistentry>
aeee2322 LP	217	</variablelist>
	218	</refsect2>
	219
	220	<refsect2>
88aebb62 LP	221	<title>Mode</title>
88aebb62 LP	222
b8bb3e8f LP	223	<para>The file access mode to use when
	224	creating this file or directory. If omitted or
	225	when set to - the default is used: 0755 for
468d726b LP	226	directories, 0644 for all other file
	227	objects. For z, Z lines if omitted or when set
	228	to - the file access mode will not be
	229	modified. This parameter is ignored for x, r,
	230	R, L lines.</para>
88aebb62 LP	231	</refsect2>
	232
	233	<refsect2>
	234	<title>UID, GID</title>
	235
	236	<para>The user and group to use for this file
	237	or directory. This may either be a numeric
	238	user/group ID or a user or group name. If
b8bb3e8f	239	omitted or when set to - the default 0 (root)
777b87e7	240	is used. For z, Z lines when omitted or when set to -
062e01bb	241	the file ownership will not be modified.
468d726b	242	These parameters are ignored for x, r, R, L lines.</para>
88aebb62 LP	243	</refsect2>
	244
	245	<refsect2>
	246	<title>Age</title>
aeee2322 LP	247	<para>The date field, when set, is used to
	248	decide what files to delete when cleaning. If
	249	a file or directory is older than the current
	250	time minus the age field it is deleted. The
	251	field format is a series of integers each
	252	followed by one of the following
	253	postfixes for the respective time units:</para>
	254
	255	<variablelist>
	256	<varlistentry>
	257	<term><varname>s</varname></term>
	258	<term><varname>min</varname></term>
	259	<term><varname>h</varname></term>
	260	<term><varname>d</varname></term>
	261	<term><varname>w</varname></term>
	262	<term><varname>ms</varname></term>
	263	<term><varname>m</varname></term>
	264	<term><varname>us</varname></term></varlistentry>
	265	</variablelist>
4149f86d	266
772f8371 KS	267	<para>If multiple integers and units are specified the time
772f8371 KS	268	values are summed up.</para>
4149f86d	269
772f8371 KS	270	<para>The age field only applies to lines starting with
	271	d, D and x. If omitted or set to - no automatic clean-up
	272	is done.</para>
24f3a374 LP	273
	274	<para>If the age field starts with a tilde
	275	character (~) the clean-up is only applied to
	276	files and directories one level inside the
	277	directory specified, but not the files and
	278	directories immediately inside it.</para>
aeee2322	279	</refsect2>
4149f86d	280
468d726b LP	281	<refsect2>
	282	<title>Argument</title>
	283
	284	<para>For L lines determines the destination
	285	path of the symlink. For c, b determines the
	286	major/minor of the device node, with major and
	287	minor formatted as integers, separated by :,
31ed59c5 LP	288	e.g. "1:3". For f, F, w may be used to specify
	289	a short string that is written to the file,
	290	suffixed by a newline. Ignored for all other
	291	lines.</para>
468d726b LP	292	</refsect2>
468d726b LP	293
4149f86d BP	294	</refsect1>
	295
	296	<refsect1>
	297	<title>Example</title>
	298	<example>
	299	<title>/etc/tmpfiles.d/screen.conf example</title>
	300	<para><command>screen</command> needs two directories created at boot with specific modes and ownership.</para>
	301
468d726b	302	<programlisting>d /var/run/screens 1777 root root 10d
aeee2322	303	d /var/run/uscreens 0755 root root 10d12h</programlisting>
4149f86d BP	304	</example>
	305	</refsect1>
	306
	307	<refsect1>
	308	<title>See Also</title>
	309	<para>
522d4a49	310	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
75945bad LP	311	<citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
75945bad LP	312	<citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>
4149f86d BP	313	</para>
	314	</refsect1>
	315
	316	</refentry>