[systemd.git] / man / systemd-tmpfiles.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 Lennart Poettering

  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="systemd-tmpfiles"
          xmlns:xi="http://www.w3.org/2001/XInclude">

        <refentryinfo>
                <title>systemd-tmpfiles</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>systemd-tmpfiles</refentrytitle>
                <manvolnum>8</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>systemd-tmpfiles</refname>
                <refname>systemd-tmpfiles-setup.service</refname>
                <refname>systemd-tmpfiles-setup-dev.service</refname>
                <refname>systemd-tmpfiles-clean.service</refname>
                <refname>systemd-tmpfiles-clean.timer</refname>
                <refpurpose>Creates, deletes and cleans up volatile
                and temporary files and directories</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <cmdsynopsis>
                        <command>systemd-tmpfiles</command>
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                        <arg choice="opt" rep="repeat"><replaceable>CONFIGFILE</replaceable></arg>
                </cmdsynopsis>

                <para><filename>systemd-tmpfiles-setup.service</filename></para>
                <para><filename>systemd-tmpfiles-setup-dev.service</filename></para>
                <para><filename>systemd-tmpfiles-clean.service</filename></para>
                <para><filename>systemd-tmpfiles-clean.timer</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>systemd-tmpfiles</command> creates,
                deletes, and cleans up volatile and temporary files and
                directories, based on the configuration file format and
                location specified in
                <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
                </para>

                <para>If invoked with no arguments, it applies all
                directives from all configuration files. If one or
                more filenames are passed on the command line, only
                the directives in these files are applied. If only
                the basename of a configuration file is specified,
                all configuration directories as specified in
                <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                are searched for a matching file.</para>
        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>The following options are understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><option>--create</option></term>
                                <listitem><para>If this option is
                                passed, all files and directories
                                marked with <varname>f</varname>,
                                <varname>F</varname>,
                                <varname>w</varname>,
                                <varname>d</varname>,
                                <varname>D</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>m</varname> have their
                                ownership, access mode and security
                                labels set. </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--clean</option></term>
                                <listitem><para>If this option is
                                passed, all files and directories with
                                an age parameter configured will be
                                cleaned up.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--remove</option></term>
                                <listitem><para>If this option is
                                passed, all files and directories
                                marked with <varname>r</varname>,
                                <varname>R</varname> in the
                                configuration files are
                                removed.</para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><option>--boot</option></term>
                                <listitem><para>Also execute lines
                                with an exclamation mark.
                                </para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><option>--prefix=<replaceable>path</replaceable></option></term>
                                <listitem><para>Only apply rules that
                                apply to paths with the specified
                                prefix. This option can be specified
                                multiple times.</para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><option>--exclude-prefix=<replaceable>path</replaceable></option></term>
                                <listitem><para>Ignore rules that
                                apply to paths with the specified
                                prefix. This option can be specified
                                multiple times.</para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><option>--root=<replaceable>root</replaceable></option></term>
                                <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></listitem>
                        </varlistentry>

                        <xi:include href="standard-options.xml" xpointer="help" />
                        <xi:include href="standard-options.xml" xpointer="version" />
                </variablelist>

                <para>It is possible to combine
                <option>--create</option>, <option>--clean</option>,
                and <option>--remove</option> in one invocation. For
                example, during boot the following command line is
                executed to ensure that all temporary and volatile
                directories are removed and created according to the
                configuration file:</para>

                <programlisting>systemd-tmpfiles --remove --create</programlisting>

        </refsect1>

        <refsect1>
                <title>Exit status</title>

                <para>On success, 0 is returned, a non-zero failure
                code otherwise.</para>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>
Commit	Line	Data
663996b3 MS	1	<?xml version='1.0'?> <!---nxml--->
	2	<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
	3	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
	4
	5	<!--
	6	This file is part of systemd.
	7
	8	Copyright 2010 Lennart Poettering
	9
	10	systemd is free software; you can redistribute it and/or modify it
	11	under the terms of the GNU Lesser General Public License as published by
	12	the Free Software Foundation; either version 2.1 of the License, or
	13	(at your option) any later version.
	14
	15	systemd is distributed in the hope that it will be useful, but
	16	WITHOUT ANY WARRANTY; without even the implied warranty of
	17	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	18	Lesser General Public License for more details.
	19
	20	You should have received a copy of the GNU Lesser General Public License
	21	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	22	-->
	23
60f067b4 JS	24	<refentry id="systemd-tmpfiles"
60f067b4 JS	25	xmlns:xi="http://www.w3.org/2001/XInclude">
663996b3 MS	26
	27	<refentryinfo>
	28	<title>systemd-tmpfiles</title>
	29	<productname>systemd</productname>
	30
	31	<authorgroup>
	32	<author>
	33	<contrib>Developer</contrib>
	34	<firstname>Lennart</firstname>
	35	<surname>Poettering</surname>
	36	<email>lennart@poettering.net</email>
	37	</author>
	38	</authorgroup>
	39	</refentryinfo>
	40
	41	<refmeta>
	42	<refentrytitle>systemd-tmpfiles</refentrytitle>
	43	<manvolnum>8</manvolnum>
	44	</refmeta>
	45
	46	<refnamediv>
	47	<refname>systemd-tmpfiles</refname>
	48	<refname>systemd-tmpfiles-setup.service</refname>
	49	<refname>systemd-tmpfiles-setup-dev.service</refname>
	50	<refname>systemd-tmpfiles-clean.service</refname>
	51	<refname>systemd-tmpfiles-clean.timer</refname>
	52	<refpurpose>Creates, deletes and cleans up volatile
	53	and temporary files and directories</refpurpose>
	54	</refnamediv>
	55
	56	<refsynopsisdiv>
	57	<cmdsynopsis>
60f067b4 JS	58	<command>systemd-tmpfiles</command>
	59	<arg choice="opt" rep="repeat">OPTIONS</arg>
	60	<arg choice="opt" rep="repeat"><replaceable>CONFIGFILE</replaceable></arg>
663996b3 MS	61	</cmdsynopsis>
	62
	63	<para><filename>systemd-tmpfiles-setup.service</filename></para>
	64	<para><filename>systemd-tmpfiles-setup-dev.service</filename></para>
	65	<para><filename>systemd-tmpfiles-clean.service</filename></para>
	66	<para><filename>systemd-tmpfiles-clean.timer</filename></para>
	67	</refsynopsisdiv>
	68
	69	<refsect1>
	70	<title>Description</title>
	71
	72	<para><command>systemd-tmpfiles</command> creates,
60f067b4	73	deletes, and cleans up volatile and temporary files and
663996b3	74	directories, based on the configuration file format and
60f067b4 JS	75	location specified in
	76	<citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
	77	</para>
663996b3 MS	78
	79	<para>If invoked with no arguments, it applies all
	80	directives from all configuration files. If one or
14228c0d	81	more filenames are passed on the command line, only
663996b3 MS	82	the directives in these files are applied. If only
663996b3 MS	83	the basename of a configuration file is specified,
60f067b4 JS	84	all configuration directories as specified in
	85	<citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
	86	are searched for a matching file.</para>
663996b3 MS	87	</refsect1>
	88
	89	<refsect1>
	90	<title>Options</title>
	91
	92	<para>The following options are understood:</para>
	93
	94	<variablelist>
663996b3 MS	95	<varlistentry>
663996b3 MS	96	<term><option>--create</option></term>
60f067b4 JS	97	<listitem><para>If this option is
	98	passed, all files and directories
	99	marked with <varname>f</varname>,
	100	<varname>F</varname>,
	101	<varname>w</varname>,
	102	<varname>d</varname>,
	103	<varname>D</varname>,
	104	<varname>p</varname>,
	105	<varname>L</varname>,
	106	<varname>c</varname>,
	107	<varname>b</varname>,
	108	<varname>m</varname> in the
	109	configuration files are created or
	110	written to. Files and directories
	111	marked with <varname>z</varname>,
	112	<varname>Z</varname>,
	113	<varname>m</varname> have their
	114	ownership, access mode and security
	115	labels set. </para></listitem>
663996b3 MS	116	</varlistentry>
	117
	118	<varlistentry>
	119	<term><option>--clean</option></term>
	120	<listitem><para>If this option is
14228c0d	121	passed, all files and directories with
663996b3 MS	122	an age parameter configured will be
	123	cleaned up.</para></listitem>
	124	</varlistentry>
	125
	126	<varlistentry>
	127	<term><option>--remove</option></term>
	128	<listitem><para>If this option is
60f067b4 JS	129	passed, all files and directories
	130	marked with <varname>r</varname>,
	131	<varname>R</varname> in the
	132	configuration files are
	133	removed.</para></listitem>
	134	</varlistentry>
	135	<varlistentry>
	136	<term><option>--boot</option></term>
	137	<listitem><para>Also execute lines
	138	with an exclamation mark.
	139	</para></listitem>
663996b3 MS	140	</varlistentry>
663996b3 MS	141	<varlistentry>
60f067b4	142	<term><option>--prefix=<replaceable>path</replaceable></option></term>
663996b3 MS	143	<listitem><para>Only apply rules that
663996b3 MS	144	apply to paths with the specified
14228c0d MB	145	prefix. This option can be specified
	146	multiple times.</para></listitem>
	147	</varlistentry>
	148	<varlistentry>
60f067b4	149	<term><option>--exclude-prefix=<replaceable>path</replaceable></option></term>
14228c0d MB	150	<listitem><para>Ignore rules that
	151	apply to paths with the specified
	152	prefix. This option can be specified
	153	multiple times.</para></listitem>
663996b3	154	</varlistentry>
663996b3	155	<varlistentry>
60f067b4 JS	156	<term><option>--root=<replaceable>root</replaceable></option></term>
	157	<listitem><para>Takes a directory path
	158	as an argument. All paths will be
	159	prefixed with the given alternate <replaceable>root</replaceable>
	160	path, including config search paths.
	161	</para></listitem>
663996b3 MS	162	</varlistentry>
663996b3 MS	163
60f067b4 JS	164	<xi:include href="standard-options.xml" xpointer="help" />
60f067b4 JS	165	<xi:include href="standard-options.xml" xpointer="version" />
663996b3 MS	166	</variablelist>
	167
	168	<para>It is possible to combine
	169	<option>--create</option>, <option>--clean</option>,
	170	and <option>--remove</option> in one invocation. For
	171	example, during boot the following command line is
	172	executed to ensure that all temporary and volatile
	173	directories are removed and created according to the
	174	configuration file:</para>
	175
	176	<programlisting>systemd-tmpfiles --remove --create</programlisting>
	177
	178	</refsect1>
	179
	180	<refsect1>
	181	<title>Exit status</title>
	182
60f067b4	183	<para>On success, 0 is returned, a non-zero failure
663996b3 MS	184	code otherwise.</para>
	185	</refsect1>
	186
	187	<refsect1>
	188	<title>See Also</title>
	189	<para>
	190	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
14228c0d	191	<citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
663996b3 MS	192	</para>
	193	</refsect1>
	194
	195	</refentry>