]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/tmpfiles.d.xml
capability: add new ambient_capabilities_supported() helper
[thirdparty/systemd.git] / man / tmpfiles.d.xml
CommitLineData
5fb13eb5 1<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
12b42c76 2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4149f86d
BP
3<!--
4 This file is part of systemd.
5
6 Copyright 2010 Brandon Philips
7
8 systemd is free software; you can redistribute it and/or modify it
5430f7f2
LP
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
4149f86d
BP
11 (at your option) any later version.
12
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5430f7f2 16 Lesser General Public License for more details.
4149f86d 17
5430f7f2 18 You should have received a copy of the GNU Lesser General Public License
4149f86d
BP
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
20-->
21<refentry id="tmpfiles.d">
22
302fbdf2
ZJS
23 <refentryinfo>
24 <title>tmpfiles.d</title>
25 <productname>systemd</productname>
26
27 <authorgroup>
28 <author>
29 <contrib>Documentation</contrib>
30 <firstname>Brandon</firstname>
31 <surname>Philips</surname>
32 <email>brandon@ifup.org</email>
33 </author>
34 </authorgroup>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>tmpfiles.d</refentrytitle>
39 <manvolnum>5</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>tmpfiles.d</refname>
44 <refpurpose>Configuration for creation, deletion and cleaning of
45 volatile and temporary files</refpurpose>
46 </refnamediv>
47
48 <refsynopsisdiv>
49 <para><filename>/etc/tmpfiles.d/*.conf</filename></para>
50 <para><filename>/run/tmpfiles.d/*.conf</filename></para>
51 <para><filename>/usr/lib/tmpfiles.d/*.conf</filename></para>
52 </refsynopsisdiv>
53
54 <refsect1>
55 <title>Description</title>
56
57 <para><command>systemd-tmpfiles</command> uses the configuration
58 files from the above directories to describe the creation,
59 cleaning and removal of volatile and temporary files and
60 directories which usually reside in directories such as
61 <filename>/run</filename> or <filename>/tmp</filename>.</para>
62
63 <para>Volatile and temporary files and directories are those
64 located in <filename>/run</filename> (and its alias
65 <filename>/var/run</filename>), <filename>/tmp</filename>,
66 <filename>/var/tmp</filename>, the API file systems such as
67 <filename>/sys</filename> or <filename>/proc</filename>, as well
68 as some other directories below <filename>/var</filename>.</para>
69
70 <para>System daemons frequently require private runtime
71 directories below <filename>/run</filename> to place communication
72 sockets and similar in. For these, consider declaring them in
73 their unit files using <varname>RuntimeDirectory=</varname> (see
74 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
75 for details), if this is feasible.</para>
76 </refsect1>
77
78 <refsect1>
79 <title>Configuration Format</title>
80
81 <para>Each configuration file shall be named in the style of
82 <filename><replaceable>package</replaceable>.conf</filename> or
83 <filename><replaceable>package</replaceable>-<replaceable>part</replaceable>.conf</filename>.
84 The second variant should be used when it is desirable to make it
85 easy to override just this part of configuration.</para>
86
87 <para>Files in <filename>/etc/tmpfiles.d</filename> override files
88 with the same name in <filename>/usr/lib/tmpfiles.d</filename> and
89 <filename>/run/tmpfiles.d</filename>. Files in
90 <filename>/run/tmpfiles.d</filename> override files with the same
91 name in <filename>/usr/lib/tmpfiles.d</filename>. Packages should
92 install their configuration files in
93 <filename>/usr/lib/tmpfiles.d</filename>. Files in
94 <filename>/etc/tmpfiles.d</filename> are reserved for the local
95 administrator, who may use this logic to override the
96 configuration files installed by vendor packages. All
97 configuration files are sorted by their filename in lexicographic
98 order, regardless of which of the directories they reside in. If
99 multiple files specify the same path, the entry in the file with
100 the lexicographically earliest name will be applied. All other
101 conflicting entries will be logged as errors. When two lines are
102 prefix and suffix of each other, then the prefix is always
6d785b6d
LP
103 processed first, the suffix later. Lines that take globs are
104 applied after those accepting no globs. If multiple operations
b938cb90
JE
105 shall be applied on the same file, (such as ACL, xattr, file
106 attribute adjustments), these are always done in the same fixed
6d785b6d
LP
107 order. Otherwise, the files/directories are processed in the order
108 they are listed.</para>
302fbdf2
ZJS
109
110 <para>If the administrator wants to disable a configuration file
111 supplied by the vendor, the recommended way is to place a symlink
112 to <filename>/dev/null</filename> in
113 <filename>/etc/tmpfiles.d/</filename> bearing the same filename.
114 </para>
115
116 <para>The configuration format is one line per path containing
117 type, path, mode, ownership, age, and argument fields:</para>
118
119 <programlisting>#Type Path Mode UID GID Age Argument
ed7fd549
ZJS
120d /run/user 0755 root root 10d -
121L /tmp/foobar - - - - /dev/null</programlisting>
302fbdf2 122
657cf7f4 123 <para>Fields may be enclosed within quotes and contain C-style escapes.</para>
124
302fbdf2
ZJS
125 <refsect2>
126 <title>Type</title>
127
128 <para>The type consists of a single letter and optionally an
129 exclamation mark.</para>
130
131 <para>The following line types are understood:</para>
132
133 <variablelist>
134 <varlistentry>
135 <term><varname>f</varname></term>
136 <listitem><para>Create a file if it does not exist yet. If
137 the argument parameter is given, it will be written to the
6a9171d2 138 file. Does not follow symlinks.</para></listitem>
302fbdf2
ZJS
139 </varlistentry>
140
141 <varlistentry>
142 <term><varname>F</varname></term>
143 <listitem><para>Create or truncate a file. If the argument
6a9171d2 144 parameter is given, it will be written to the file. Does not follow symlinks.</para>
302fbdf2
ZJS
145 </listitem>
146 </varlistentry>
147
148 <varlistentry>
149 <term><varname>w</varname></term>
150 <listitem><para>Write the argument parameter to a file, if
151 the file exists. Lines of this type accept shell-style
152 globs in place of normal path names. The argument parameter
153 will be written without a trailing newline. C-style
6a9171d2
LP
154 backslash escapes are interpreted. Follows
155 symlinks.</para></listitem>
302fbdf2
ZJS
156 </varlistentry>
157
158 <varlistentry>
159 <term><varname>d</varname></term>
4b743d67
ZJS
160 <listitem><para>Create a directory. The mode and ownership will be adjusted if
161 specified and the directory already exists. Contents of this directory are subject
ed7fd549 162 to time based cleanup if the age argument is specified.</para></listitem>
302fbdf2
ZJS
163 </varlistentry>
164
165 <varlistentry>
166 <term><varname>D</varname></term>
4b743d67
ZJS
167 <listitem><para>Similar to <varname>d</varname>, but in addition the contents
168 of the directory will be removed when <option>--remove</option> is used.
169 </para></listitem>
170 </varlistentry>
df8dee85
ZJS
171
172 <varlistentry>
173 <term><varname>e</varname></term>
ed7fd549
ZJS
174 <listitem><para>Similar to <varname>d</varname>, but the directory will not be created if
175 it does not exist. Lines of this type accept shell-style globs in place of normal path
176 names. For this entry to be useful, at least one of the mode, uid, gid, or age arguments
177 must be specified, since otherwise this entry has no effect. If the age argument is
178 <literal>0</literal>, contents of the directory will be unconditionally deleted every time
179 <command>systemd-tmpfiles --clean</command> is run. This can be useful when combined with
180 <varname>!</varname>, see the examples.</para></listitem>
302fbdf2
ZJS
181 </varlistentry>
182
183 <varlistentry>
184 <term><varname>v</varname></term>
185 <listitem><para>Create a subvolume if the path does not
2904e949
LP
186 exist yet, the file system supports subvolumes (btrfs), and
187 the system itself is installed into a subvolume
188 (specifically: the root directory <filename>/</filename> is
189 itself a subvolume). Otherwise, create a normal directory, in
190 the same way as <varname>d</varname>. A subvolume created
191 with this line type is not assigned to any higher-level
192 quota group. For that, use <varname>q</varname> or
193 <varname>Q</varname>, which allow creating simple quota
194 group hierarchies, see below.</para></listitem>
5fb13eb5
LP
195 </varlistentry>
196
197 <varlistentry>
198 <term><varname>q</varname></term>
b938cb90 199 <listitem><para>Similar to <varname>v</varname>. However,
5fb13eb5
LP
200 makes sure that the subvolume will be assigned to the same
201 higher-level quota groups as the subvolume it has been
202 created in. This ensures that higher-level limits and
203 accounting applied to the parent subvolume also include the
204 specified subvolume. On non-btrfs file systems, this line
205 type is identical to <varname>d</varname>. If the subvolume
206 already exists and is already assigned to one or more higher
b938cb90 207 level quota groups, no change to the quota hierarchy is
5fb13eb5
LP
208 made. Also see <varname>Q</varname> below. See <citerefentry
209 project='die-net'><refentrytitle>btrfs-qgroup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
210 for details about the btrfs quota group
211 concept.</para></listitem>
212 </varlistentry>
213
214 <varlistentry>
215 <term><varname>Q</varname></term>
b938cb90 216 <listitem><para>Similar to <varname>q</varname>. However,
5fb13eb5
LP
217 instead of copying the higher-level quota group assignments
218 from the parent as-is, the lowest quota group of the parent
219 subvolume is determined that is not the leaf quota
220 group. Then, an "intermediary" quota group is inserted that
221 is one level below this level, and shares the same ID part
222 as the specified subvolume. If no higher-level quota group
223 exists for the parent subvolume, a new quota group at level
224 255 sharing the same ID as the specified subvolume is
225 inserted instead. This new intermediary quota group is then
226 assigned to the parent subvolume's higher-level quota
227 groups, and the specified subvolume's leaf quota group is
228 assigned to it.</para>
229
230 <para>Effectively, this has a similar effect as
231 <varname>q</varname>, however introduces a new higher-level
232 quota group for the specified subvolume that may be used to
233 enforce limits and accounting to the specified subvolume and
234 children subvolume created within it. Thus, by creating
235 subvolumes only via <varname>q</varname> and
b938cb90 236 <varname>Q</varname>, a concept of "subtree quotas" is
5fb13eb5
LP
237 implemented. Each subvolume for which <varname>Q</varname>
238 is set will get a "subtree" quota group created, and all
239 child subvolumes created within it will be assigned to
240 it. Each subvolume for which <varname>q</varname> is set
241 will not get such a "subtree" quota group, but it is ensured
242 that they are added to the same "subtree" quota group as their
243 immediate parents.</para>
244
245 <para>It is recommended to use
246 <varname>Q</varname> for subvolumes that typically contain
247 further subvolumes, and where it is desirable to have
248 accounting and quota limits on all child subvolumes
249 together. Examples for <varname>Q</varname> are typically
250 <filename>/home</filename> or
251 <filename>/var/lib/machines</filename>. In contrast,
252 <varname>q</varname> should be used for subvolumes that
253 either usually do not include further subvolumes or where no
254 accounting and quota limits are needed that apply to all
255 child subvolumes together. Examples for <varname>q</varname>
256 are typically <filename>/var</filename> or
257 <filename>/var/tmp</filename>. As with <varname>Q</varname>,
258 <varname>q</varname> has no effect on the quota group
259 hierarchy if the subvolume exists and already has at least
260 one higher-level quota group assigned.</para></listitem>
302fbdf2
ZJS
261 </varlistentry>
262
263 <varlistentry>
264 <term><varname>p</varname></term>
265 <term><varname>p+</varname></term>
266 <listitem><para>Create a named pipe (FIFO) if it does not
267 exist yet. If suffixed with <varname>+</varname> and a file
268 already exists where the pipe is to be created, it will be
269 removed and be replaced by the pipe.</para></listitem>
270 </varlistentry>
271
272 <varlistentry>
273 <term><varname>L</varname></term>
274 <term><varname>L+</varname></term>
275 <listitem><para>Create a symlink if it does not exist
b3f5897f
WD
276 yet. If suffixed with <varname>+</varname> and a file or
277 directory already exists where the symlink is to be created,
278 it will be removed and be replaced by the symlink. If the
279 argument is omitted, symlinks to files with the same name
280 residing in the directory
281 <filename>/usr/share/factory/</filename> are created. Note
282 that permissions and ownership on symlinks are ignored.
283 </para></listitem>
302fbdf2
ZJS
284 </varlistentry>
285
286 <varlistentry>
287 <term><varname>c</varname></term>
288 <term><varname>c+</varname></term>
289 <listitem><para>Create a character device node if it does
290 not exist yet. If suffixed with <varname>+</varname> and a
291 file already exists where the device node is to be created,
292 it will be removed and be replaced by the device node. It is
293 recommended to suffix this entry with an exclamation mark to
294 only create static device nodes at boot, as udev will not
295 manage static device nodes that are created at runtime.
296 </para></listitem>
297 </varlistentry>
298
299 <varlistentry>
300 <term><varname>b</varname></term>
301 <term><varname>b+</varname></term>
302 <listitem><para>Create a block device node if it does not
303 exist yet. If suffixed with <varname>+</varname> and a file
304 already exists where the device node is to be created, it
305 will be removed and be replaced by the device node. It is
306 recommended to suffix this entry with an exclamation mark to
307 only create static device nodes at boot, as udev will not
308 manage static device nodes that are created at runtime.
309 </para></listitem>
310 </varlistentry>
311
312 <varlistentry>
313 <term><varname>C</varname></term>
314 <listitem><para>Recursively copy a file or directory, if the
315 destination files or directories do not exist yet. Note that
316 this command will not descend into subdirectories if the
317 destination directory already exists. Instead, the entire
318 copy operation is skipped. If the argument is omitted, files
319 from the source directory
320 <filename>/usr/share/factory/</filename> with the same name
6a9171d2 321 are copied. Does not follow symlinks.</para></listitem>
302fbdf2
ZJS
322 </varlistentry>
323
324 <varlistentry>
325 <term><varname>x</varname></term>
326 <listitem><para>Ignore a path during cleaning. Use this type
327 to exclude paths from clean-up as controlled with the Age
328 parameter. Note that lines of this type do not influence the
329 effect of <varname>r</varname> or <varname>R</varname>
50d9e46d 330 lines. Lines of this type accept shell-style globs in place
302fbdf2
ZJS
331 of normal path names. </para></listitem>
332 </varlistentry>
333
334 <varlistentry>
335 <term><varname>X</varname></term>
336 <listitem><para>Ignore a path during cleaning. Use this type
337 to exclude paths from clean-up as controlled with the Age
338 parameter. Unlike <varname>x</varname>, this parameter will
339 not exclude the content if path is a directory, but only
340 directory itself. Note that lines of this type do not
341 influence the effect of <varname>r</varname> or
50d9e46d 342 <varname>R</varname> lines. Lines of this type accept
302fbdf2
ZJS
343 shell-style globs in place of normal path names.
344 </para></listitem>
345 </varlistentry>
346
347 <varlistentry>
348 <term><varname>r</varname></term>
349 <listitem><para>Remove a file or directory if it exists.
350 This may not be used to remove non-empty directories, use
351 <varname>R</varname> for that. Lines of this type accept
352 shell-style globs in place of normal path
6a9171d2 353 names. Does not follow symlinks.</para></listitem>
302fbdf2
ZJS
354 </varlistentry>
355
356 <varlistentry>
357 <term><varname>R</varname></term>
358 <listitem><para>Recursively remove a path and all its
359 subdirectories (if it is a directory). Lines of this type
360 accept shell-style globs in place of normal path
6a9171d2 361 names. Does not follow symlinks.</para></listitem>
302fbdf2
ZJS
362 </varlistentry>
363
364 <varlistentry>
365 <term><varname>z</varname></term>
366 <listitem><para>Adjust the access mode, group and user, and
367 restore the SELinux security context of a file or directory,
368 if it exists. Lines of this type accept shell-style globs in
6a9171d2 369 place of normal path names. Does not follow symlinks.</para></listitem>
302fbdf2
ZJS
370 </varlistentry>
371
372 <varlistentry>
373 <term><varname>Z</varname></term>
374 <listitem><para>Recursively set the access mode, group and
375 user, and restore the SELinux security context of a file or
376 directory if it exists, as well as of its subdirectories and
377 the files contained therein (if applicable). Lines of this
6a9171d2
LP
378 type accept shell-style globs in place of normal path
379 names. Does not follow symlinks. </para></listitem>
302fbdf2
ZJS
380 </varlistentry>
381
382 <varlistentry>
383 <term><varname>t</varname></term>
b705ab6a
ZJS
384 <listitem><para>Set extended attributes. Lines of this type
385 accept shell-style globs in place of normal path names.
6a9171d2
LP
386 This can be useful for setting SMACK labels. Does not follow
387 symlinks.</para></listitem>
b705ab6a
ZJS
388 </varlistentry>
389
390 <varlistentry>
391 <term><varname>T</varname></term>
392 <listitem><para>Recursively set extended attributes. Lines
393 of this type accept shell-style globs in place of normal
6a9171d2
LP
394 path names. This can be useful for setting SMACK
395 labels. Does not follow symlinks. </para></listitem>
302fbdf2 396 </varlistentry>
f8eeeaf9 397
fa3f5fd2
GB
398 <varlistentry>
399 <term><varname>h</varname></term>
400 <listitem><para>Set file/directory attributes. Lines of this type
401 accept shell-style globs in place of normal path names.</para>
402
1ae705fb
LP
403 <para>The format of the argument field is
404 <varname>[+-=][aAcCdDeijsStTu] </varname>. The prefix
405 <varname>+</varname> (the default one) causes the
fa3f5fd2 406 attribute(s) to be added; <varname>-</varname> causes the
1ae705fb 407 attribute(s) to be removed; <varname>=</varname> causes the
a8eaaee7 408 attributes to be set exactly as the following letters. The
1ae705fb 409 letters <literal>aAcCdDeijsStTu</literal> select the new
fa3f5fd2 410 attributes for the files, see
c30c611c 411 <citerefentry project='man-pages'><refentrytitle>chattr</refentrytitle>
fa3f5fd2
GB
412 <manvolnum>1</manvolnum></citerefentry> for further information.
413 </para>
1ae705fb
LP
414 <para>Passing only <varname>=</varname> as argument resets
415 all the file attributes listed above. It has to be pointed
b938cb90 416 out that the <varname>=</varname> prefix limits itself to
1ae705fb
LP
417 the attributes corresponding to the letters listed here. All
418 other attributes will be left untouched. Does not follow
419 symlinks.</para>
fa3f5fd2
GB
420 </listitem>
421 </varlistentry>
422
423 <varlistentry>
424 <term><varname>H</varname></term>
425 <listitem><para>Recursively set file/directory attributes. Lines
426 of this type accept shell-style globs in place of normal
6a9171d2 427 path names. Does not follow symlinks.
fa3f5fd2
GB
428 </para></listitem>
429 </varlistentry>
430
f8eeeaf9
ZJS
431 <varlistentry>
432 <term><varname>a</varname></term>
50d9e46d
ZJS
433 <term><varname>a+</varname></term>
434 <listitem><para>Set POSIX ACLs (access control lists). If
a8eaaee7 435 suffixed with <varname>+</varname>, the specified entries will
dd4105b0
ZJS
436 be added to the existing set.
437 <command>systemd-tmpfiles</command> will automatically add
438 the required base entries for user and group based on the
439 access mode of the file, unless base entries already exist
7f3fdb7f 440 or are explicitly specified. The mask will be added if not
dd4105b0
ZJS
441 specified explicitly or already present. Lines of this type
442 accept shell-style globs in place of normal path names. This
443 can be useful for allowing additional access to certain
6a9171d2 444 files. Does not follow symlinks.</para></listitem>
b705ab6a
ZJS
445 </varlistentry>
446
447 <varlistentry>
448 <term><varname>A</varname></term>
50d9e46d
ZJS
449 <term><varname>A+</varname></term>
450 <listitem><para>Same as <varname>a</varname> and
6a9171d2
LP
451 <varname>a+</varname>, but recursive. Does not follow
452 symlinks.</para></listitem>
f8eeeaf9 453 </varlistentry>
302fbdf2
ZJS
454 </variablelist>
455
456 <para>If the exclamation mark is used, this line is only safe of
457 execute during boot, and can break a running system. Lines
458 without the exclamation mark are presumed to be safe to execute
459 at any time, e.g. on package upgrades.
460 <command>systemd-tmpfiles</command> will execute line with an
461 exclamation mark only if option <option>--boot</option> is
462 given.</para>
463
464 <para>For example:
465 <programlisting># Make sure these are created by default so that nobody else can
466 d /tmp/.X11-unix 1777 root root 10d
467
468 # Unlink the X11 lock files
469 r! /tmp/.X[0-9]*-lock</programlisting>
470 The second line in contrast to the first one would break a
471 running system, and will only be executed with
472 <option>--boot</option>.</para>
473 </refsect2>
474
475 <refsect2>
476 <title>Path</title>
477
478 <para>The file system path specification supports simple
479 specifier expansion. The following expansions are
480 understood:</para>
481
482 <table>
483 <title>Specifiers available</title>
484 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
485 <colspec colname="spec" />
486 <colspec colname="mean" />
487 <colspec colname="detail" />
488 <thead>
489 <row>
490 <entry>Specifier</entry>
491 <entry>Meaning</entry>
492 <entry>Details</entry>
493 </row>
494 </thead>
495 <tbody>
496 <row>
497 <entry><literal>%m</literal></entry>
498 <entry>Machine ID</entry>
499 <entry>The machine ID of the running system, formatted as string. See <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry>
500 </row>
501 <row>
502 <entry><literal>%b</literal></entry>
503 <entry>Boot ID</entry>
504 <entry>The boot ID of the running system, formatted as string. See <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry> for more information.</entry>
505 </row>
506 <row>
507 <entry><literal>%H</literal></entry>
508 <entry>Host name</entry>
509 <entry>The hostname of the running system.</entry>
510 </row>
511 <row>
512 <entry><literal>%v</literal></entry>
513 <entry>Kernel release</entry>
514 <entry>Identical to <command>uname -r</command> output.</entry>
515 </row>
516 <row>
517 <entry><literal>%%</literal></entry>
518 <entry>Escaped %</entry>
519 <entry>Single percent sign.</entry>
520 </row>
521 </tbody>
522 </tgroup>
523 </table>
524 </refsect2>
525
526 <refsect2>
527 <title>Mode</title>
528
529 <para>The file access mode to use when creating this file or
530 directory. If omitted or when set to <literal>-</literal>, the
531 default is used: 0755 for directories, 0644 for all other file
532 objects. For <varname>z</varname>, <varname>Z</varname> lines,
533 if omitted or when set to <literal>-</literal>, the file access
534 mode will not be modified. This parameter is ignored for
535 <varname>x</varname>, <varname>r</varname>,
f8eeeaf9
ZJS
536 <varname>R</varname>, <varname>L</varname>, <varname>t</varname>,
537 and <varname>a</varname> lines.</para>
302fbdf2
ZJS
538
539 <para>Optionally, if prefixed with <literal>~</literal>, the
540 access mode is masked based on the already set access bits for
541 existing file or directories: if the existing file has all
542 executable bits unset, all executable bits are removed from the
543 new access mode, too. Similarly, if all read bits are removed
544 from the old access mode, they will be removed from the new
545 access mode too, and if all write bits are removed, they will be
546 removed from the new access mode too. In addition, the
547 sticky/SUID/SGID bit is removed unless applied to a
548 directory. This functionality is particularly useful in
549 conjunction with <varname>Z</varname>.</para>
550 </refsect2>
551
552 <refsect2>
553 <title>UID, GID</title>
554
555 <para>The user and group to use for this file or directory. This
556 may either be a numeric user/group ID or a user or group
557 name. If omitted or when set to <literal>-</literal>, the
a8eaaee7 558 default 0 (root) is used. For <varname>z</varname> and
f8eeeaf9
ZJS
559 <varname>Z</varname> lines, when omitted or when set to
560 <literal>-</literal>, the file ownership will not be
561 modified. These parameters are ignored for <varname>x</varname>,
562 <varname>r</varname>, <varname>R</varname>,
563 <varname>L</varname>, <varname>t</varname>, and
564 <varname>a</varname> lines.</para>
302fbdf2
ZJS
565 </refsect2>
566
567 <refsect2>
568 <title>Age</title>
569 <para>The date field, when set, is used to decide what files to
570 delete when cleaning. If a file or directory is older than the
571 current time minus the age field, it is deleted. The field
572 format is a series of integers each followed by one of the
a8eaaee7 573 following suffixes for the respective time units:
00c53f42
ZJS
574 <constant>s</constant>,
575 <constant>m</constant> or <constant>min</constant>,
576 <constant>h</constant>,
577 <constant>d</constant>,
578 <constant>w</constant>,
a8eaaee7 579 <constant>ms</constant>, and
00c53f42 580 <constant>us</constant>,
a8eaaee7
JE
581 meaning seconds, minutes, hours, days, weeks,
582 milliseconds, and microseconds, respectively. Full names of the time units can
00c53f42
ZJS
583 be used too.
584 </para>
302fbdf2
ZJS
585
586 <para>If multiple integers and units are specified, the time
00c53f42
ZJS
587 values are summed. If an integer is given without a unit,
588 <constant>s</constant> is assumed.
302fbdf2
ZJS
589 </para>
590
591 <para>When the age is set to zero, the files are cleaned
592 unconditionally.</para>
593
5fb13eb5 594 <para>The age field only applies to lines starting with
df8dee85 595 <varname>d</varname>, <varname>D</varname>, <varname>e</varname>,
5fb13eb5
LP
596 <varname>v</varname>, <varname>q</varname>,
597 <varname>Q</varname>, <varname>C</varname>, <varname>x</varname>
598 and <varname>X</varname>. If omitted or set to
599 <literal>-</literal>, no automatic clean-up is done.</para>
302fbdf2
ZJS
600
601 <para>If the age field starts with a tilde character
602 <literal>~</literal>, the clean-up is only applied to files and
603 directories one level inside the directory specified, but not
604 the files and directories immediately inside it.</para>
605 </refsect2>
606
607 <refsect2>
608 <title>Argument</title>
609
610 <para>For <varname>L</varname> lines determines the destination
a8eaaee7
JE
611 path of the symlink. For <varname>c</varname> and
612 <varname>b</varname>, determines the major/minor of the device
302fbdf2
ZJS
613 node, with major and minor formatted as integers, separated by
614 <literal>:</literal>, e.g. <literal>1:3</literal>. For
615 <varname>f</varname>, <varname>F</varname>, and
a8eaaee7 616 <varname>w</varname>, the argument may be used to specify a short string that
302fbdf2
ZJS
617 is written to the file, suffixed by a newline. For
618 <varname>C</varname>, specifies the source file or
a8eaaee7 619 directory. For <varname>t</varname> and <varname>T</varname>,
0ac0b1e7 620 determines extended attributes to be set. For
a8eaaee7
JE
621 <varname>a</varname> and <varname>A</varname>, determines ACL
622 attributes to be set. For <varname>h</varname> and
b938cb90 623 <varname>H</varname>, determines the file attributes to
0ac0b1e7 624 set. Ignored for all other lines.</para>
302fbdf2
ZJS
625 </refsect2>
626
627 </refsect1>
628
629 <refsect1>
4b743d67 630 <title>Examples</title>
302fbdf2 631 <example>
4b743d67
ZJS
632 <title>Create directories with specific mode and ownership</title>
633 <para>
0a07667d 634 <citerefentry project='die-net'><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
4b743d67
ZJS
635 needs two directories created at boot with specific modes and ownership:</para>
636
637 <programlisting># /usr/lib/tmpfiles.d/screen.conf
638d /run/screens 1777 root screen 10d
639d /run/uscreens 0755 root screen 10d12h
640</programlisting>
641
642 <para>Contents of <filename>/run/screens</filename> and /run/uscreens will
643 cleaned up after 10 and 10½ days, respectively.</para>
644 </example>
302fbdf2 645
4b743d67
ZJS
646 <example>
647 <title>Create a directory with a SMACK attribute</title>
648 <programlisting>D /run/cups - - - -
649t /run/cups - - - - security.SMACK64=printing user.attr-with-spaces="foo bar"
650 </programlisting>
651
b17649ee 652 <para>The directory will be owned by root and have default mode. Its contents are
4b743d67
ZJS
653 not subject to time based cleanup, but will be obliterated when
654 <command>systemd-tmpfiles --remove</command> runs.</para>
302fbdf2 655 </example>
4b743d67 656
302fbdf2 657 <example>
4b743d67
ZJS
658 <title>Create a directory and prevent its contents from cleanup</title>
659 <para>
0a07667d 660 <citerefentry project='die-net'><refentrytitle>abrt</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
4b743d67
ZJS
661 needs a directory created at boot with specific mode and ownership and its content
662 should be preserved from the automatic cleanup applied to the contents of
663 <filename>/var/tmp</filename>:</para>
664
665 <programlisting># /usr/lib/tmpfiles.d/tmp.conf
666d /var/tmp 1777 root root 30d
667</programlisting>
668
669 <programlisting># /usr/lib/tmpfiles.d/abrt.conf
670d /var/tmp/abrt 0755 abrt abrt -
df8dee85
ZJS
671</programlisting>
672 </example>
673
674 <example>
675 <title>Apply clean up during boot and based on time</title>
676
677 <programlisting># /usr/lib/tmpfiles.d/dnf.conf
678r! /var/cache/dnf/*/*/download_lock.pid
679r! /var/cache/dnf/*/*/metadata_lock.pid
680r! /var/lib/dnf/rpmdb_lock.pid
681e /var/chache/dnf/ - - - 30d
4b743d67 682</programlisting>
302fbdf2 683
df8dee85
ZJS
684 <para>The lock files will be removed during boot. Any files and directories in
685 <filename>/var/chache/dnf/</filename> will be removed after they have not been
686 accessed in 30 days.</para>
302fbdf2 687 </example>
ed7fd549
ZJS
688
689 <example>
b719b26c 690 <title>Empty the contents of a cache directory on boot</title>
ed7fd549
ZJS
691
692 <programlisting># /usr/lib/tmpfiles.d/krb5rcache.conf
693e! /var/cache/krb5rcache - - - 0
694</programlisting>
695
696 <para>Any files and subdirectories in <filename>/var/cache/krb5rcache/</filename>
697 will be removed on boot. The directory will not be created.
698 </para>
699 </example>
302fbdf2
ZJS
700 </refsect1>
701
702 <refsect1>
703 <title>See Also</title>
704 <para>
705 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
706 <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
707 <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
f8eeeaf9
ZJS
708 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
709 <citerefentry project='man-pages'><refentrytitle>attr</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
710 <citerefentry project='man-pages'><refentrytitle>getfattr</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
711 <citerefentry project='man-pages'><refentrytitle>setfattr</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
712 <citerefentry project='man-pages'><refentrytitle>setfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
fa3f5fd2 713 <citerefentry project='man-pages'><refentrytitle>getfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
5fb13eb5
LP
714 <citerefentry project='man-pages'><refentrytitle>chattr</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
715 <citerefentry project='die-net'><refentrytitle>btrfs-subvolume</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
716 <citerefentry project='die-net'><refentrytitle>btrfs-qgroup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
302fbdf2
ZJS
717 </para>
718 </refsect1>
4149f86d
BP
719
720</refentry>