chiark / gitweb /
namespace: include boot id in private tmp directories
[elogind.git] / man / systemd-tmpfiles.xml
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
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                 <refname>systemd-tmpfiles-setup.service</refname>
48                 <refname>systemd-tmpfiles-setup-dev.service</refname>
49                 <refname>systemd-tmpfiles-clean.service</refname>
50                 <refname>systemd-tmpfiles-clean.timer</refname>
51                 <refpurpose>Creates, deletes and cleans up volatile
52                 and temporary files and directories</refpurpose>
53         </refnamediv>
54
55         <refsynopsisdiv>
56                 <cmdsynopsis>
57                         <command>systemd-tmpfiles <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">CONFIGURATION FILE</arg></command>
58                 </cmdsynopsis>
59
60                 <para><filename>systemd-tmpfiles-setup.service</filename></para>
61                 <para><filename>systemd-tmpfiles-setup-dev.service</filename></para>
62                 <para><filename>systemd-tmpfiles-clean.service</filename></para>
63                 <para><filename>systemd-tmpfiles-clean.timer</filename></para>
64         </refsynopsisdiv>
65
66         <refsect1>
67                 <title>Description</title>
68
69                 <para><command>systemd-tmpfiles</command> creates,
70                 deletes and cleans up volatile and temporary files and
71                 directories, based on the configuration file format and
72                 location specified in <citerefentry>
73                         <refentrytitle>tmpfiles.d</refentrytitle>
74                         <manvolnum>5</manvolnum>
75                 </citerefentry>.</para>
76
77                 <para>If invoked with no arguments, it applies all
78                 directives from all configuration files. If one or
79                 more filenames are passed on the command line, only
80                 the directives in these files are applied. If only
81                 the basename of a configuration file is specified,
82                 all configuration directories as specified in <citerefentry>
83                         <refentrytitle>tmpfiles.d</refentrytitle>
84                         <manvolnum>5</manvolnum>
85                 </citerefentry> are searched for a matching file.</para>
86         </refsect1>
87
88         <refsect1>
89                 <title>Options</title>
90
91                 <para>The following options are understood:</para>
92
93                 <variablelist>
94                         <varlistentry>
95                                 <term><option>-h</option></term>
96                                 <term><option>--help</option></term>
97
98                                 <listitem><para>Prints a short help
99                                 text and exits.</para></listitem>
100                         </varlistentry>
101
102                         <varlistentry>
103                                 <term><option>--version</option></term>
104
105                                 <listitem><para>Prints a short version
106                                 string and exits.</para></listitem>
107                         </varlistentry>
108
109                         <varlistentry>
110                                 <term><option>--create</option></term>
111                                 <listitem><para>If this option is passed, all
112                                 files and directories marked with f,
113                                 F, d, D in the configuration files are
114                                 created. Files and directories marked with z,
115                                 Z have their ownership, access mode and security
116                                 labels set.</para></listitem>
117                         </varlistentry>
118
119                         <varlistentry>
120                                 <term><option>--clean</option></term>
121                                 <listitem><para>If this option is
122                                 passed, all files and directories with
123                                 an age parameter configured will be
124                                 cleaned up.</para></listitem>
125                         </varlistentry>
126
127                         <varlistentry>
128                                 <term><option>--remove</option></term>
129                                 <listitem><para>If this option is
130                                 passed, all files and directories marked
131                                 with r, R in the configuration files
132                                 are removed.</para></listitem>
133                         </varlistentry>
134                         <varlistentry>
135                                 <term><option>--prefix=PATH</option></term>
136                                 <listitem><para>Only apply rules that
137                                 apply to paths with the specified
138                                 prefix. This option can be specified
139                                 multiple times.</para></listitem>
140                         </varlistentry>
141                         <varlistentry>
142                                 <term><option>--exclude-prefix=PATH</option></term>
143                                 <listitem><para>Ignore rules that
144                                 apply to paths with the specified
145                                 prefix. This option can be specified
146                                 multiple times.</para></listitem>
147                         </varlistentry>
148                 </variablelist>
149
150                 <para>It is possible to combine
151                 <option>--create</option>, <option>--clean</option>,
152                 and <option>--remove</option> in one invocation. For
153                 example, during boot the following command line is
154                 executed to ensure that all temporary and volatile
155                 directories are removed and created according to the
156                 configuration file:</para>
157
158                 <programlisting>systemd-tmpfiles --remove --create</programlisting>
159
160         </refsect1>
161
162         <refsect1>
163                 <title>Exit status</title>
164
165                 <para>On success 0 is returned, a non-zero failure
166                 code otherwise.</para>
167         </refsect1>
168
169         <refsect1>
170                 <title>See Also</title>
171                 <para>
172                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
173                         <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
174                 </para>
175         </refsect1>
176
177 </refentry>