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