]>
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 | |
5430f7f2 LP |
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 | |
522d4a49 LP |
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 | |
5430f7f2 | 18 | Lesser General Public License for more details. |
522d4a49 | 19 | |
5430f7f2 | 20 | You should have received a copy of the GNU Lesser General Public License |
522d4a49 LP |
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, | |
4e7f8bc8 | 61 | deletes and cleans up volatile and temporary files and |
522d4a49 LP |
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 | |
777b87e7 MS |
87 | created. Files and directories marked with z, |
88 | Z have their ownership, access mode and security | |
062e01bb | 89 | labels set.</para></listitem> |
522d4a49 LP |
90 | </varlistentry> |
91 | ||
92 | <varlistentry> | |
93 | <term><option>--clean</option></term> | |
94 | <listitem><para>If this option is | |
95 | passed all files and directories with | |
96 | an age parameter configured will be | |
97 | cleaned up.</para></listitem> | |
98 | </varlistentry> | |
99 | ||
100 | <varlistentry> | |
101 | <term><option>--remove</option></term> | |
102 | <listitem><para>If this option is | |
103 | passed all files and directories marked | |
104 | with r, R in the configuration files | |
105 | are removed.</para></listitem> | |
106 | </varlistentry> | |
107 | <varlistentry> | |
108 | <term><option>--prefix=PATH</option></term> | |
109 | <listitem><para>Only apply rules that | |
110 | apply to paths with the specified | |
111 | prefix.</para></listitem> | |
112 | </varlistentry> | |
113 | ||
114 | ||
115 | <varlistentry> | |
116 | <term><option>--help</option></term> | |
117 | ||
118 | <listitem><para>Prints a short help | |
119 | text and exits.</para></listitem> | |
120 | </varlistentry> | |
121 | ||
122 | </variablelist> | |
123 | ||
124 | <para>It is possible to combine | |
125 | <option>--create</option>, <option>--clean</option>, | |
126 | and <option>--remove</option> in one invocation. For | |
127 | example, during boot the following command line is | |
128 | executed to ensure that all temporary and volatile | |
8f28cbcd | 129 | directories are removed and created according to the |
522d4a49 LP |
130 | configuration file:</para> |
131 | ||
8b7d2212 | 132 | <programlisting>systemd-tmpfiles --remove --create</programlisting> |
522d4a49 LP |
133 | |
134 | </refsect1> | |
135 | ||
136 | <refsect1> | |
137 | <title>Exit status</title> | |
138 | ||
139 | <para>On success 0 is returned, a non-zero failure | |
140 | code otherwise.</para> | |
141 | </refsect1> | |
142 | ||
143 | <refsect1> | |
144 | <title>See Also</title> | |
145 | <para> | |
146 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
147 | <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
148 | <citerefentry><refentrytitle>tmpwatch</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
149 | </para> | |
150 | </refsect1> | |
151 | ||
152 | </refentry> |