[thirdparty/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 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="systemd-tmpfiles">

        <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>
                <refpurpose>Creates, deletes and cleans up volatile
                and temporary files and directories.</refpurpose>
        </refnamediv>

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

        <refsect1>
                <title>Description</title>

                <para><command>systemd-tmpfiles</command> creates,
                deletes and cleans up volatile ad temporary files and
                directories, based on the configuration from
                <filename>/etc/tmpfiles.d/</filename>. See
                <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                for more details on these files.</para>

                <para>If invoked with no arguments applies all
                directives from all configuration files in
                <filename>/etc/tmpfiles.d/*.conf</filename>. If one or
                more absolute file names are passed on the command
                line only the directives in these files are
                applied.</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 f,
                                F, d, D in the configuration files are
                                created.</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 r, R in the configuration files
                                are removed.</para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><option>--prefix=PATH</option></term>
                                <listitem><para>Only apply rules that
                                apply to paths with the specified
                                prefix.</para></listitem>
                        </varlistentry>


                        <varlistentry>
                                <term><option>--help</option></term>

                                <listitem><para>Prints a short help
                                text and exits.</para></listitem>
                        </varlistentry>

                </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>systemctl-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>,
                        <citerefentry><refentrytitle>tmpwatch</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>
Commit	Line	Data
522d4a49 LP	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 General Public License as published by
	12	the Free Software Foundation; either version 2 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	General Public License for more details.
	19
	20	You should have received a copy of the GNU General Public License
	21	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	22	-->
	23
	24	<refentry id="systemd-tmpfiles">
	25
	26	<refentryinfo>
	27	<title>systemd-tmpfiles</title>
	28	<productname>systemd</productname>
	29
	30	<authorgroup>
	31	<author>
	32	<contrib>Developer</contrib>
	33	<firstname>Lennart</firstname>
	34	<surname>Poettering</surname>
	35	<email>lennart@poettering.net</email>
	36	</author>
	37	</authorgroup>
	38	</refentryinfo>
	39
	40	<refmeta>
	41	<refentrytitle>systemd-tmpfiles</refentrytitle>
	42	<manvolnum>8</manvolnum>
	43	</refmeta>
	44
	45	<refnamediv>
	46	<refname>systemd-tmpfiles</refname>
	47	<refpurpose>Creates, deletes and cleans up volatile
	48	and temporary files and directories.</refpurpose>
	49	</refnamediv>
	50
	51	<refsynopsisdiv>
	52	<cmdsynopsis>
	53	<command>systemd-tmpfiles <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">CONFIGURATION FILE</arg></command>
	54	</cmdsynopsis>
	55	</refsynopsisdiv>
	56
	57	<refsect1>
	58	<title>Description</title>
	59
	60	<para><command>systemd-tmpfiles</command> creates,
	61	deletes and cleans up volatile ad temporary files and
	62	directories, based on the configuration from
	63	<filename>/etc/tmpfiles.d/</filename>. See
	64	<citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
65	for more details on these files.</para>
66
67	<para>If invoked with no arguments applies all
68	directives from all configuration files in
69	<filename>/etc/tmpfiles.d/*.conf</filename>. If one or
70	more absolute file names are passed on the command
71	line only the directives in these files are
72	applied.</para>
73	</refsect1>
74
75	<refsect1>
76	<title>Options</title>
77
78	<para>The following options are understood:</para>
79
80	<variablelist>
81
82	<varlistentry>
83	<term><option>--create</option></term>
84	<listitem><para>If this option is passed all
85	files and directories marked with f,
86	F, d, D in the configuration files are
87	created.</para></listitem>
88	</varlistentry>
89
90	<varlistentry>
91	<term><option>--clean</option></term>
92	<listitem><para>If this option is
93	passed all files and directories with
94	an age parameter configured will be
95	cleaned up.</para></listitem>
96	</varlistentry>
97
98	<varlistentry>
99	<term><option>--remove</option></term>
100	<listitem><para>If this option is
101	passed all files and directories marked
102	with r, R in the configuration files
103	are removed.</para></listitem>
104	</varlistentry>
105	<varlistentry>
106	<term><option>--prefix=PATH</option></term>
107	<listitem><para>Only apply rules that
108	apply to paths with the specified
109	prefix.</para></listitem>
110	</varlistentry>
111
112
113	<varlistentry>
114	<term><option>--help</option></term>
115
116	<listitem><para>Prints a short help
117	text and exits.</para></listitem>
118	</varlistentry>
119
120	</variablelist>
121
122	<para>It is possible to combine
123	<option>--create</option>, <option>--clean</option>,
124	and <option>--remove</option> in one invocation. For
125	example, during boot the following command line is
126	executed to ensure that all temporary and volatile
8f28cbcd	127	directories are removed and created according to the
522d4a49 LP	128	configuration file:</para>
	129
	130	<programlisting>systemctl-tmpfiles --remove --create</programlisting>
	131
	132	</refsect1>
	133
	134	<refsect1>
	135	<title>Exit status</title>
	136
	137	<para>On success 0 is returned, a non-zero failure
	138	code otherwise.</para>
	139	</refsect1>
	140
	141	<refsect1>
	142	<title>See Also</title>
	143	<para>
	144	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
	145	<citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	146	<citerefentry><refentrytitle>tmpwatch</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	147	</para>
	148	</refsect1>
	149
	150	</refentry>