Debian Codegraph @

upstream/debian-unstable/man8/systemd-tmpfiles.8

raw
1 '\" t
2 .TH "SYSTEMD\-TMPFILES" "8" "" "systemd 261~rc3" "systemd-tmpfiles"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd-tmpfiles, systemd-tmpfiles-setup.service, systemd-tmpfiles-setup-dev-early.service, systemd-tmpfiles-setup-dev.service, systemd-tmpfiles-clean.service, systemd-tmpfiles-clean.timer \- Create, delete, and clean up files and directories
24 .SH "SYNOPSIS"
25 .HP \w'\fBsystemd\-tmpfiles\fR\ 'u
26 \fBsystemd\-tmpfiles\fR [OPTIONS...] [\fICONFIGFILE\fR...]
27 .PP
28 System units:
29 .RS 4
30 systemd\-tmpfiles\-setup\&.service
31 .RE
32 .RS 4
33 systemd\-tmpfiles\-setup\-dev\-early\&.service
34 .RE
35 .RS 4
36 systemd\-tmpfiles\-setup\-dev\&.service
37 .RE
38 .RS 4
39 systemd\-tmpfiles\-clean\&.service
40 .RE
41 .RS 4
42 systemd\-tmpfiles\-clean\&.timer
43 .RE
44 .PP
45 User units:
46 .RS 4
47 systemd\-tmpfiles\-setup\&.service
48 .RE
49 .RS 4
50 systemd\-tmpfiles\-clean\&.service
51 .RE
52 .RS 4
53 systemd\-tmpfiles\-clean\&.timer
54 .RE
55 .SH "DESCRIPTION"
56 .PP
57 \fBsystemd\-tmpfiles\fR
58 creates, deletes, and cleans up files and directories, using the configuration file format and location specified in
59 \fBtmpfiles.d\fR(5)\&. Historically, it was designed to manage volatile and temporary files, as the name suggests, but it provides generic file management functionality and can be used to manage any kind of files\&. It must be invoked with one or more commands
60 \fB\-\-create\fR,
61 \fB\-\-remove\fR, and
62 \fB\-\-clean\fR, to select the respective subset of operations\&.
63 .PP
64 If invoked with no arguments, directives from the configuration files found in the directories specified by
65 \fBtmpfiles.d\fR(5)
66 are executed\&. When invoked with positional arguments, if option
67 \fB\-\-replace=\fR\fB\fIPATH\fR\fR
68 is specified, arguments specified on the command line are used instead of the configuration file
69 \fIPATH\fR\&. Otherwise, just the configuration specified by the command line arguments is executed\&. If the string
70 "\-"
71 is specified instead of a filename, the configuration is read from standard input\&. If the argument is a file name (without any slashes), all configuration directories are searched for a matching file and the file found that has the highest priority is executed\&. If the argument is a path, that file is used directly without searching the configuration directories for any other matching file\&.
72 .PP
73 System services (systemd\-tmpfiles\-setup\&.service,
74 systemd\-tmpfiles\-setup\-dev\-early\&.service,
75 systemd\-tmpfiles\-setup\-dev\&.service,
76 systemd\-tmpfiles\-clean\&.service) invoke
77 \fBsystemd\-tmpfiles\fR
78 to create system files and to perform system wide cleanup\&. Those services read administrator\-controlled configuration files in
79 tmpfiles\&.d/
80 directories\&. User services (systemd\-tmpfiles\-setup\&.service,
81 systemd\-tmpfiles\-clean\&.service) also invoke
82 \fBsystemd\-tmpfiles\fR, but it reads a separate set of files, which includes user\-controlled files under
83 ~/\&.config/user\-tmpfiles\&.d/
84 and
85 ~/\&.local/share/user\-tmpfiles\&.d/, and administrator\-controlled files under
86 /usr/share/user\-tmpfiles\&.d/\&. Users may use this to create and clean up files under their control, but the system instance performs global cleanup and is not influenced by user configuration\&. Note that this means a time\-based cleanup configured in the system instance, such as the one typically configured for
87 /tmp/, will thus also affect files created by the user instance if they are placed in
88 /tmp/, even if the user instance\*(Aqs time\-based cleanup is turned off\&.
89 .PP
90 To re\-apply settings after configuration has been modified, simply restart
91 systemd\-tmpfiles\-clean\&.service, which will apply any settings which can be safely executed at runtime\&. To debug
92 \fBsystemd\-tmpfiles\fR, it may be useful to invoke it directly from the command line with increased log level (see
93 \fI$SYSTEMD_LOG_LEVEL\fR
94 below)\&.
95 .SH "COMMANDS AND OPTIONS"
96 .PP
97 The following commands are understood:
98 .PP
99 \fB\-\-create\fR
100 .RS 4
101 If this command is passed, all files and directories marked with
102 \fIf\fR,
103 \fIF\fR,
104 \fIw\fR,
105 \fId\fR,
106 \fID\fR,
107 \fIv\fR,
108 \fIp\fR,
109 \fIL\fR,
110 \fIc\fR,
111 \fIb\fR,
112 \fIm\fR
113 in the configuration files are created or written to\&. Files and directories marked with
114 \fIz\fR,
115 \fIZ\fR,
116 \fIt\fR,
117 \fIT\fR,
118 \fIa\fR, and
119 \fIA\fR
120 have their ownership, access mode and security labels set\&.
121 .RE
122 .PP
123 \fB\-\-clean\fR
124 .RS 4
125 If this command is passed, all files and directories with an age parameter configured will be cleaned up\&.
126 .RE
127 .PP
128 \fB\-\-remove\fR
129 .RS 4
130 If this command is passed, the contents of directories marked with
131 \fID\fR
132 or
133 \fIR\fR, and files or directories themselves marked with
134 \fIr\fR
135 or
136 \fIR\fR
137 are removed unless an exclusive or shared BSD lock is taken on them (see
138 \fBflock\fR(2))\&.
139 .RE
140 .PP
141 \fB\-\-purge\fR
142 .RS 4
143 If this option is passed, all files and directories declared for
144 \fIcreation\fR
145 and marked with the
146 "$"
147 character by the
148 tmpfiles\&.d/
149 files specified on the command line will be
150 \fIdeleted\fR\&. Specifically, this acts on all files and directories marked with
151 \fIf\fR,
152 \fIF\fR,
153 \fId\fR,
154 \fID\fR,
155 \fIv\fR,
156 \fIq\fR,
157 \fIQ\fR,
158 \fIp\fR,
159 \fIL\fR,
160 \fIc\fR,
161 \fIb\fR,
162 \fIC\fR,
163 \fIw\fR,
164 \fIe\fR\&. If this switch is used at least one
165 tmpfiles\&.d/
166 file (or
167 \-
168 for standard input) must be specified on the command line or the invocation will be refused, for safety reasons (as otherwise much of the installed system files might be removed)\&.
169 .sp
170 The primary usecase for this option is to automatically remove files and directories that originally have been created on behalf of an installed package at package removal time\&.
171 .sp
172 It is recommended to first run this command in combination with
173 \fB\-\-dry\-run\fR
174 (see below) to verify which files and directories will be deleted\&.
175 .sp
176 \fIWarning!\fR
177 This is usually not the command you want! In most cases
178 \fB\-\-remove\fR
179 is what you are looking for\&.
180 .sp
181 Added in version 256\&.
182 .RE
183 .PP
184 \fB\-\-user\fR
185 .RS 4
186 Execute "user" configuration, i\&.e\&.
187 tmpfiles\&.d/
188 files in user configuration directories\&.
189 .sp
190 Added in version 236\&.
191 .RE
192 .PP
193 \fB\-\-boot\fR
194 .RS 4
195 Also execute lines with an exclamation mark\&. Lines that are not safe to be executed on a running system may be marked in this way\&.
196 \fBsystemd\-tmpfiles\fR
197 is executed in early boot with
198 \fB\-\-boot\fR
199 specified and will execute those lines\&. When invoked again later, it should be called without
200 \fB\-\-boot\fR\&.
201 .sp
202 Added in version 209\&.
203 .RE
204 .PP
205 \fB\-\-graceful\fR
206 .RS 4
207 Ignore configuration lines pertaining to unknown users or groups\&. This option is intended to be used in early boot before all users or groups have been created\&.
208 .sp
209 Added in version 254\&.
210 .RE
211 .PP
212 \fB\-\-dry\-run\fR
213 .RS 4
214 Process the configuration and print what operations would be performed, but do not actually change anything in the file system\&.
215 .sp
216 Added in version 256\&.
217 .RE
218 .PP
219 \fB\-\-inline\fR
220 .RS 4
221 Treat each positional argument as a separate configuration line instead of a file name\&.
222 .sp
223 Added in version 261\&.
224 .RE
225 .PP
226 \fB\-\-prefix=\fR\fB\fIpath\fR\fR
227 .RS 4
228 Only apply rules with paths that start with the specified prefix\&. This option can be specified multiple times\&.
229 .sp
230 Added in version 212\&.
231 .RE
232 .PP
233 \fB\-\-exclude\-prefix=\fR\fB\fIpath\fR\fR
234 .RS 4
235 Ignore rules with paths that start with the specified prefix\&. This option can be specified multiple times\&.
236 .sp
237 Added in version 207\&.
238 .RE
239 .PP
240 \fB\-E\fR
241 .RS 4
242 A shortcut for
243 "\-\-exclude\-prefix=/dev \-\-exclude\-prefix=/proc \-\-exclude\-prefix=/run \-\-exclude\-prefix=/sys", i\&.e\&. exclude the hierarchies typically backed by virtual or memory file systems\&. This is useful in combination with
244 \fB\-\-root=\fR, if the specified directory tree contains an OS tree without these virtual/memory file systems mounted in, as it is typically not desirable to create any files and directories below these subdirectories if they are supposed to be overmounted during runtime\&.
245 .sp
246 Added in version 247\&.
247 .RE
248 .PP
249 \fB\-\-root=\fR\fB\fIroot\fR\fR
250 .RS 4
251 Takes a directory path as an argument\&. All paths will be prefixed with the given alternate
252 \fIroot\fR
253 path, including config search paths\&.
254 .sp
255 When this option is used, the libc Name Service Switch (NSS) is bypassed for resolving users and groups\&. Instead the files
256 /etc/passwd
257 and
258 /etc/group
259 inside the alternate root are read directly\&. This means that users/groups not listed in these files will not be resolved, i\&.e\&. LDAP NIS and other complex databases are not considered\&.
260 .sp
261 Consider combining this with
262 \fB\-E\fR
263 to ensure the invocation does not create files or directories below mount points in the OS image operated on that are typically overmounted during runtime\&.
264 .sp
265 Added in version 212\&.
266 .RE
267 .PP
268 \fB\-\-image=\fR\fB\fIimage\fR\fR
269 .RS 4
270 Takes a path to a disk image file or block device node\&. If specified all operations are applied to file system in the indicated disk image\&. This is similar to
271 \fB\-\-root=\fR
272 but operates on file systems stored in disk images or block devices\&. The disk image should either contain just a file system or a set of file systems within a GPT partition table, following the
273 \m[blue]\fBUAPI\&.2 Discoverable Partitions Specification\fR\m[]\&\s-2\u[1]\d\s+2\&. For further information on supported disk images, see
274 \fBsystemd-nspawn\fR(1)\*(Aqs switch of the same name\&.
275 .sp
276 Implies
277 \fB\-E\fR\&.
278 .sp
279 Added in version 247\&.
280 .RE
281 .PP
282 \fB\-\-image\-policy=\fR\fB\fIpolicy\fR\fR
283 .RS 4
284 Takes an image policy string as argument, as per
285 \fBsystemd.image-policy\fR(7)\&. The policy is enforced when operating on the disk image specified via
286 \fB\-\-image=\fR, see above\&. If not specified, defaults to the
287 "*"
288 policy, i\&.e\&. all recognized file systems in the image are used\&.
289 .RE
290 .PP
291 \fB\-\-replace=\fR\fB\fIPATH\fR\fR
292 .RS 4
293 When this option is given, one or more positional arguments must be specified\&. All configuration files found in the directories listed in
294 \fBtmpfiles.d\fR(5)
295 will be read, and the configuration given on the command line will be handled instead of and with the same priority as the configuration file
296 \fIPATH\fR\&.
297 .sp
298 This option is intended to be used when package installation scripts are running and files belonging to that package are not yet available on disk, so their contents must be given on the command line, but the admin configuration might already exist and should be given higher priority\&.
299 .sp
300 Added in version 238\&.
301 .RE
302 .PP
303 \fB\-\-cat\-config\fR
304 .RS 4
305 Copy the contents of config files to standard output\&. Before each file, the filename is printed as a comment\&.
306 .RE
307 .PP
308 \fB\-\-tldr\fR
309 .RS 4
310 Copy the contents of config files to standard output\&. Only the "interesting" parts of the configuration files are printed, comments and empty lines are skipped\&. Before each file, the filename is printed as a comment\&.
311 .RE
312 .PP
313 \fB\-\-no\-pager\fR
314 .RS 4
315 Do not pipe output into a pager\&.
316 .RE
317 .PP
318 \fB\-h\fR, \fB\-\-help\fR
319 .RS 4
320 Print a short help text and exit\&.
321 .RE
322 .PP
323 \fB\-\-version\fR
324 .RS 4
325 Print a short version string and exit\&.
326 .RE
327 .PP
328 It is possible to combine
329 \fB\-\-create\fR,
330 \fB\-\-clean\fR, and
331 \fB\-\-remove\fR
332 in one invocation (in which case removal and cleanup are executed before creation of new files)\&. 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:
333 .sp
334 .if n \{\
335 .RS 4
336 .\}
337 .nf
338 systemd\-tmpfiles \-\-remove \-\-create
339 .fi
340 .if n \{\
341 .RE
342 .\}
343 .SH "CREDENTIALS"
344 .PP
345 \fBsystemd\-tmpfiles\fR
346 supports the service credentials logic as implemented by
347 \fIImportCredential=\fR/\fILoadCredential=\fR/\fISetCredential=\fR
348 (see
349 \fBsystemd.exec\fR(5)
350 for details)\&. The following credentials are used when passed in:
351 .PP
352 \fItmpfiles\&.extra\fR
353 .RS 4
354 The contents of this credential may contain additional lines to operate on\&. The credential contents should follow the same format as any other
355 tmpfiles\&.d/
356 drop\-in configuration file\&. If this credential is passed it is processed after all of the drop\-in files read from the file system\&. The lines in the credential can hence augment existing lines of the OS, but not override them\&.
357 .sp
358 Added in version 252\&.
359 .RE
360 .PP
361 Note that by default the
362 systemd\-tmpfiles\-setup\&.service
363 unit file (and related unit files) is set up to inherit the
364 "tmpfiles\&.extra"
365 credential from the service manager\&.
366 .SH "ENVIRONMENT"
367 .PP
368 \fI$SYSTEMD_LOG_LEVEL\fR
369 .RS 4
370 The maximum log level of emitted messages (messages with a higher log level, i\&.e\&. less important ones, will be suppressed)\&. Takes a comma\-separated list of values\&. A value may be either one of (in order of decreasing importance)
371 \fBemerg\fR,
372 \fBalert\fR,
373 \fBcrit\fR,
374 \fBerr\fR,
375 \fBwarning\fR,
376 \fBnotice\fR,
377 \fBinfo\fR,
378 \fBdebug\fR, or an integer in the range 0\&...7\&. See
379 \fBsyslog\fR(3)
380 for more information\&. Each value may optionally be prefixed with one of
381 \fBconsole\fR,
382 \fBsyslog\fR,
383 \fBkmsg\fR
384 or
385 \fBjournal\fR
386 followed by a colon to set the maximum log level for that specific log target (e\&.g\&.
387 \fBSYSTEMD_LOG_LEVEL=debug,console:info\fR
388 specifies to log at debug level except when logging to the console which should be at info level)\&. Note that the global maximum log level takes priority over any per target maximum log levels\&.
389 .RE
390 .PP
391 \fI$SYSTEMD_LOG_COLOR\fR
392 .RS 4
393 A boolean\&. If true, messages written to the tty will be colored according to priority\&.
394 .sp
395 This setting is only useful when messages are written directly to the terminal, because
396 \fBjournalctl\fR(1)
397 and other tools that display logs will color messages based on the log level on their own\&.
398 .RE
399 .PP
400 \fI$SYSTEMD_LOG_TIME\fR
401 .RS 4
402 A boolean\&. If true, console log messages will be prefixed with a timestamp\&.
403 .sp
404 This setting is only useful when messages are written directly to the terminal or a file, because
405 \fBjournalctl\fR(1)
406 and other tools that display logs will attach timestamps based on the entry metadata on their own\&.
407 .RE
408 .PP
409 \fI$SYSTEMD_LOG_LOCATION\fR
410 .RS 4
411 A boolean\&. If true, messages will be prefixed with a filename and line number in the source code where the message originates\&.
412 .sp
413 Note that the log location is often attached as metadata to journal entries anyway\&. Including it directly in the message text can nevertheless be convenient when debugging programs\&.
414 .RE
415 .PP
416 \fI$SYSTEMD_LOG_TARGET\fR
417 .RS 4
418 The destination for log messages\&. One of
419 \fBconsole\fR
420 (log to the attached tty),
421 \fBconsole\-prefixed\fR
422 (log to the attached tty but with prefixes encoding the log level and "facility", see
423 \fBsyslog\fR(3),
424 \fBkmsg\fR
425 (log to the kernel circular log buffer),
426 \fBjournal\fR
427 (log to the journal),
428 \fBjournal\-or\-kmsg\fR
429 (log to the journal if available, and to kmsg otherwise),
430 \fBauto\fR
431 (determine the appropriate log target automatically, the default),
432 \fBnull\fR
433 (disable log output)\&.
434 .RE
435 .PP
436 \fI$SYSTEMD_PAGER\fR, \fI$PAGER\fR
437 .RS 4
438 Pager to use when
439 \fB\-\-no\-pager\fR
440 is not given\&.
441 \fI$SYSTEMD_PAGER\fR
442 is used if set; otherwise
443 \fI$PAGER\fR
444 is used\&. If neither
445 \fI$SYSTEMD_PAGER\fR
446 nor
447 \fI$PAGER\fR
448 are set, a set of well\-known pager implementations is tried in turn, including
449 \fBless\fR(1)
450 and
451 \fBmore\fR(1), until one is found\&. If no pager implementation is discovered, no pager is invoked\&. Setting those environment variables to an empty string or the value
452 "cat"
453 is equivalent to passing
454 \fB\-\-no\-pager\fR\&.
455 .sp
456 Note: if
457 \fI$SYSTEMD_PAGERSECURE\fR
458 is not set,
459 \fI$SYSTEMD_PAGER\fR
460 and
461 \fI$PAGER\fR
462 can only be used to disable the pager (with
463 "cat"
464 or
465 ""), and are otherwise ignored\&.
466 .RE
467 .PP
468 \fI$SYSTEMD_LESS\fR
469 .RS 4
470 Override the options passed to
471 \fBless\fR
472 (by default
473 "FRSXMK")\&.
474 .sp
475 Users might want to change two options in particular:
476 .PP
477 \fBK\fR
478 .RS 4
479 This option instructs the pager to exit immediately when
480 Ctrl+C
481 is pressed\&. To allow
482 \fBless\fR
483 to handle
484 Ctrl+C
485 itself to switch back to the pager command prompt, unset this option\&.
486 .sp
487 If the value of
488 \fI$SYSTEMD_LESS\fR
489 does not include
490 "K", and the pager that is invoked is
491 \fBless\fR,
492 Ctrl+C
493 will be ignored by the executable, and needs to be handled by the pager\&.
494 .RE
495 .PP
496 \fBX\fR
497 .RS 4
498 This option instructs the pager to not send termcap initialization and deinitialization strings to the terminal\&. It is set by default to allow command output to remain visible in the terminal even after the pager exits\&. Nevertheless, this prevents some pager functionality from working, in particular paged output cannot be scrolled with the mouse\&.
499 .RE
500 .sp
501 Note that setting the regular
502 \fI$LESS\fR
503 environment variable has no effect for
504 \fBless\fR
505 invocations by systemd tools\&.
506 .sp
507 See
508 \fBless\fR(1)
509 for more discussion\&.
510 .RE
511 .PP
512 \fI$SYSTEMD_LESSCHARSET\fR
513 .RS 4
514 Override the charset passed to
515 \fBless\fR
516 (by default
517 "utf\-8", if the invoking terminal is determined to be UTF\-8 compatible)\&.
518 .sp
519 Note that setting the regular
520 \fI$LESSCHARSET\fR
521 environment variable has no effect for
522 \fBless\fR
523 invocations by systemd tools\&.
524 .RE
525 .PP
526 \fI$SYSTEMD_PAGERSECURE\fR
527 .RS 4
528 Common pager commands like
529 \fBless\fR(1), in addition to "paging", i\&.e\&. scrolling through the output, support opening of or writing to other files and running arbitrary shell commands\&. When commands are invoked with elevated privileges, for example under
530 \fBsudo\fR(8)
531 or
532 \fBpkexec\fR(1), the pager becomes a security boundary\&. Care must be taken that only programs with strictly limited functionality are used as pagers, and unintended interactive features like opening or creation of new files or starting of subprocesses are not allowed\&. "Secure mode" for the pager may be enabled as described below,
533 \fIif the pager supports that\fR
534 (most pagers are not written in a way that takes this into consideration)\&. It is recommended to either explicitly enable "secure mode" or to completely disable the pager using
535 \fB\-\-no\-pager\fR
536 or
537 \fIPAGER=cat\fR
538 when allowing untrusted users to execute commands with elevated privileges\&.
539 .sp
540 This option takes a boolean argument\&. When set to true, the "secure mode" of the pager is enabled\&. In "secure mode",
541 \fBLESSSECURE=1\fR
542 will be set when invoking the pager, which instructs the pager to disable commands that open or create new files or start new subprocesses\&. Currently only
543 \fBless\fR(1)
544 is known to understand this variable and implement "secure mode"\&.
545 .sp
546 When set to false, no limitation is placed on the pager\&. Setting
547 \fISYSTEMD_PAGERSECURE=0\fR
548 or not removing it from the inherited environment may allow the user to invoke arbitrary commands\&.
549 .sp
550 When
551 \fI$SYSTEMD_PAGERSECURE\fR
552 is not set, systemd tools attempt to automatically figure out if "secure mode" should be enabled and whether the pager supports it\&. "Secure mode" is enabled if the effective UID is not the same as the owner of the login session, see
553 \fBgeteuid\fR(2)
554 and
555 \fBsd_pid_get_owner_uid\fR(3), or when running under
556 \fBsudo\fR(8)
557 or similar tools (\fI$SUDO_UID\fR
558 is set
559 \&\s-2\u[2]\d\s+2)\&. In those cases,
560 \fISYSTEMD_PAGERSECURE=1\fR
561 will be set and pagers which are not known to implement "secure mode" will not be used at all\&. Note that this autodetection only covers the most common mechanisms to elevate privileges and is intended as convenience\&. It is recommended to explicitly set
562 \fI$SYSTEMD_PAGERSECURE\fR
563 or disable the pager\&.
564 .sp
565 Note that if the
566 \fI$SYSTEMD_PAGER\fR
567 or
568 \fI$PAGER\fR
569 variables are to be honoured, other than to disable the pager,
570 \fI$SYSTEMD_PAGERSECURE\fR
571 must be set too\&.
572 .RE
573 .PP
574 \fI$SYSTEMD_COLORS\fR
575 .RS 4
576 Takes a boolean argument, or a special value\&. By default (unset),
577 \fBsystemd\fR
578 and related utilities will use colors in their output if possible\&. If
579 \fI$COLORTERM\fR
580 is set to
581 "truecolor"
582 or
583 "24bit", 24\-bit colors will be enabled, 256 colors otherwise, unless
584 \fI$NO_COLOR\fR
585 or
586 \fI$TERM\fR
587 indicates colors are disabled\&.
588 .PP
589 \fBtrue\fR
590 .RS 4
591 Same as unset, except that
592 \fI$NO_COLOR\fR
593 is ignored\&.
594 .RE
595 .PP
596 \fBfalse\fR
597 .RS 4
598 The output will be monochrome\&.
599 .RE
600 .PP
601 "16", "256", "24bit"
602 .RS 4
603 Always use the base 16 ANSI colors, 256 colors, or 24 bit color, respectively\&.
604 .RE
605 .PP
606 "auto\-16", "auto\-256", "auto\-24bit"
607 .RS 4
608 Use the given quantity of colours, subject to
609 \fI$TERM\fR, and what the console is connected to\&.
610 .RE
611 .RE
612 .PP
613 \fI$SYSTEMD_URLIFY\fR
614 .RS 4
615 The value must be a boolean\&. Controls whether clickable links should be generated in the output for terminal emulators supporting this\&. This can be specified to override the decision that
616 \fBsystemd\fR
617 makes based on
618 \fI$TERM\fR
619 and other conditions\&.
620 .RE
621 .SH "UNPRIVILEGED \-\-CLEANUP OPERATION"
622 .PP
623 \fBsystemd\-tmpfiles\fR
624 tries to avoid changing the access and modification times on the directories it accesses, which requires
625 \fBCAP_FOWNER\fR
626 privileges\&. When running as non\-root, directories which are checked for files to clean up will have their access time bumped, which might prevent their cleanup\&.
627 .SH "EXIT STATUS"
628 .PP
629 On success, 0 is returned\&. If the configuration was syntactically invalid (syntax errors, missing arguments, \&...), so some lines had to be ignored, but no other errors occurred,
630 \fB65\fR
631 is returned (\fBEX_DATAERR\fR
632 from
633 /usr/include/sysexits\&.h)\&. If the configuration was syntactically valid, but could not be executed (lack of permissions, creation of files in missing directories, invalid contents when writing to
634 /sys/
635 values, \&...),
636 \fB73\fR
637 is returned (\fBEX_CANTCREAT\fR
638 from
639 /usr/include/sysexits\&.h)\&. Otherwise,
640 \fB1\fR
641 is returned (\fBEXIT_FAILURE\fR
642 from
643 /usr/include/stdlib\&.h)\&.
644 .PP
645 Note: when creating items, if the target already exists, but is of the wrong type or otherwise does not match the requested state, and forced operation has not been requested with
646 "+", a message is emitted, but the failure is otherwise ignored\&.
647 .SH "SEE ALSO"
648 .PP
649 \fBsystemd\fR(1), \fBtmpfiles.d\fR(5)
650 .SH "NOTES"
651 .IP " 1." 4
652 UAPI.2 Discoverable Partitions Specification
653 .RS 4
654 \%https://uapi-group.org/specifications/specs/discoverable_partitions_specification
655 .RE
656 .IP " 2." 4
657 It is recommended for other tools to set and check
658 \fI$SUDO_UID\fR
659 as appropriate, treating it is a common interface.
660