[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 General Public License as published by
  the Free Software Foundation; either version 2 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
  General Public License for more details.

  You should have received a copy of the GNU 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>/usr/lib/tmpfiles.d/*.conf</filename></para>
                <para><filename>/etc/tmpfiles.d/*.conf</filename></para>
                <para><filename>/run/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 is named in the style of
                <filename>&lt;program&gt;.conf</filename>.
                Files in <filename>/etc/</filename> overwrite
                files with the same name in <filename>/usr/lib/</filename>.
                Files in <filename>/run</filename> overwrite files with
                the same name in <filename>/etc/</filename> and
                <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
                administration, which possibly decides to overwrite the
                configurations installed from packages. All files are sorted
                by filename in alphabetical order, regardless in which of the
                directories they reside, to ensure that a specific
                configuration file takes precedence over another file with
                an alphabetically later name.</para>

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

                <programlisting>Type Path          Mode UID  GID  Age
d    /run/user 0755 root root 10d</programlisting>

                <refsect2>
                        <title>Type</title>
                        <variablelist>
                                <varlistentry>
                                        <term><varname>f</varname></term>
                                        <listitem><para>Create a file if it doesn't exist yet</para></listitem>
                                </varlistentry>

                                <varlistentry>
                                        <term><varname>F</varname></term>
                                        <listitem><para>Create or truncate a file</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>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>
                        </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 files. This parameter is
                        ignored for x, r, R 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. . These parameters are ignored for x,
                        r, R 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>
                </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>
                </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
	10	under the terms of the GNU General Public License as published by
	11	the Free Software Foundation; either version 2 of the License, or
	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
	17	General Public License for more details.
	18
	19	You should have received a copy of the GNU General Public License
	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	49	<refsynopsisdiv>
772f8371	50	<para><filename>/usr/lib/tmpfiles.d/*.conf</filename></para>
a7c64469	51	<para><filename>/etc/tmpfiles.d/*.conf</filename></para>
772f8371	52	<para><filename>/run/tmpfiles.d/*.conf</filename></para>
a7c64469 LP	53	</refsynopsisdiv>
a7c64469 LP	54
4149f86d BP	55	<refsect1>
	56	<title>Description</title>
	57
522d4a49	58	<para><command>systemd-tmpfiles</command> uses the
772f8371	59	configuration files from the above directories to describe the
522d4a49 LP	60	creation, cleaning and removal of volatile and
522d4a49 LP	61	temporary files and directories which usually reside
bb29785e	62	in directories such as <filename>/run</filename>
772f8371	63	or <filename>/tmp</filename>.</para>
4149f86d BP	64	</refsect1>
	65
	66	<refsect1>
	67	<title>Configuration Format</title>
	68
772f8371 KS	69	<para>Each configuration file is named in the style of
	70	<filename><program>.conf</filename>.
	71	Files in <filename>/etc/</filename> overwrite
	72	files with the same name in <filename>/usr/lib/</filename>.
	73	Files in <filename>/run</filename> overwrite files with
	74	the same name in <filename>/etc/</filename> and
	75	<filename>/usr/lib/</filename>. Packages should install their
	76	configuration files in <filename>/usr/lib/</filename>, files
	77	in <filename>/etc/</filename> are reserved for the local
	78	administration, which possibly decides to overwrite the
	79	configurations installed from packages. All files are sorted
	80	by filename in alphabetical order, regardless in which of the
	81	directories they reside, to ensure that a specific
	82	configuration file takes precedence over another file with
	83	an alphabetically later name.</para>
	84
aeee2322 LP	85	<para>The configuration format is one line per path
	86	containing action, mode, ownership and age
	87	fields:</para>
	88
88aebb62	89	<programlisting>Type Path Mode UID GID Age
bb29785e	90	d /run/user 0755 root root 10d</programlisting>
aeee2322 LP	91
aeee2322 LP	92	<refsect2>
88aebb62	93	<title>Type</title>
aeee2322 LP	94	<variablelist>
	95	<varlistentry>
	96	<term><varname>f</varname></term>
a7c64469	97	<listitem><para>Create a file if it doesn't exist yet</para></listitem>
aeee2322 LP	98	</varlistentry>
	99
	100	<varlistentry>
	101	<term><varname>F</varname></term>
a7c64469	102	<listitem><para>Create or truncate a file</para></listitem>
aeee2322 LP	103	</varlistentry>
	104
	105	<varlistentry>
	106	<term><varname>d</varname></term>
a7c64469	107	<listitem><para>Create a directory if it doesn't exist yet</para></listitem>
aeee2322 LP	108	</varlistentry>
	109
	110	<varlistentry>
	111	<term><varname>D</varname></term>
a7c64469	112	<listitem><para>Create or empty a directory</para></listitem>
aeee2322 LP	113	</varlistentry>
	114
	115	<varlistentry>
	116	<term><varname>x</varname></term>
b8bb3e8f LP	117	<listitem><para>Ignore a path
	118	during cleaning. Use this type
	119	to exclude paths from clean-up
	120	as controlled with the Age
	121	parameter. Note that lines of
	122	this type do not influence the
	123	effect of r or R lines. Lines
	124	of this type accept
	125	shell-style globs in place of
	126	of normal path
	127	names.</para></listitem>
aeee2322 LP	128	</varlistentry>
	129
	130	<varlistentry>
	131	<term><varname>r</varname></term>
b8bb3e8f LP	132	<listitem><para>Remove a file
	133	or directory if it
	134	exists. This may not be used
	135	to remove non-empty
	136	directories, use R for
	137	that. Lines of this type
	138	accept shell-style globs in
	139	place of normal path
	140	names.</para></listitem>
aeee2322 LP	141	</varlistentry>
	142
	143	<varlistentry>
	144	<term><varname>R</varname></term>
b8bb3e8f LP	145	<listitem><para>Recursively
	146	remove a path and all its
	147	subdirectories (if it is a
	148	directory). Lines of this type
	149	accept shell-style globs in
	150	place of normal path
	151	names.</para></listitem>
aeee2322 LP	152	</varlistentry>
	153	</variablelist>
	154	</refsect2>
	155
	156	<refsect2>
88aebb62 LP	157	<title>Mode</title>
88aebb62 LP	158
b8bb3e8f LP	159	<para>The file access mode to use when
	160	creating this file or directory. If omitted or
	161	when set to - the default is used: 0755 for
	162	directories, 0644 for files. This parameter is
	163	ignored for x, r, R lines.</para>
88aebb62 LP	164	</refsect2>
	165
	166	<refsect2>
	167	<title>UID, GID</title>
	168
	169	<para>The user and group to use for this file
	170	or directory. This may either be a numeric
	171	user/group ID or a user or group name. If
b8bb3e8f LP	172	omitted or when set to - the default 0 (root)
	173	is used. . These parameters are ignored for x,
	174	r, R lines.</para>
88aebb62 LP	175	</refsect2>
	176
	177	<refsect2>
	178	<title>Age</title>
aeee2322 LP	179	<para>The date field, when set, is used to
	180	decide what files to delete when cleaning. If
	181	a file or directory is older than the current
	182	time minus the age field it is deleted. The
	183	field format is a series of integers each
	184	followed by one of the following
	185	postfixes for the respective time units:</para>
	186
	187	<variablelist>
	188	<varlistentry>
	189	<term><varname>s</varname></term>
	190	<term><varname>min</varname></term>
	191	<term><varname>h</varname></term>
	192	<term><varname>d</varname></term>
	193	<term><varname>w</varname></term>
	194	<term><varname>ms</varname></term>
	195	<term><varname>m</varname></term>
	196	<term><varname>us</varname></term></varlistentry>
	197	</variablelist>
4149f86d	198
772f8371 KS	199	<para>If multiple integers and units are specified the time
772f8371 KS	200	values are summed up.</para>
4149f86d	201
772f8371 KS	202	<para>The age field only applies to lines starting with
	203	d, D and x. If omitted or set to - no automatic clean-up
	204	is done.</para>
aeee2322	205	</refsect2>
4149f86d BP	206
	207	</refsect1>
	208
	209	<refsect1>
	210	<title>Example</title>
	211	<example>
	212	<title>/etc/tmpfiles.d/screen.conf example</title>
	213	<para><command>screen</command> needs two directories created at boot with specific modes and ownership.</para>
	214
	215	<programlisting>d /var/run/screens 1777 root root 10d
aeee2322	216	d /var/run/uscreens 0755 root root 10d12h</programlisting>
4149f86d BP	217	</example>
	218	</refsect1>
	219
	220	<refsect1>
	221	<title>See Also</title>
	222	<para>
522d4a49 LP	223	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
522d4a49 LP	224	<citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>
4149f86d BP	225	</para>
	226	</refsect1>
	227
	228	</refentry>