File: systemd-tmpfiles.8

package info (click to toggle)
manpages-de 2.12-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 71,404 kB
  • sloc: sh: 1,059; makefile: 71; python: 64; perl: 37; sed: 11
file content (204 lines) | stat: -rw-r--r-- 6,865 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
'\" t
.TH "SYSTEMD\-TMPFILES" "8" "" "systemd 241" "systemd-tmpfiles"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
systemd-tmpfiles, systemd-tmpfiles-setup.service, systemd-tmpfiles-setup-dev.service, systemd-tmpfiles-clean.service, systemd-tmpfiles-clean.timer \- Creates, deletes and cleans up volatile and temporary files and directories
.SH "SYNOPSIS"
.HP \w'\fBsystemd\-tmpfiles\fR\ 'u
\fBsystemd\-tmpfiles\fR [OPTIONS...] [\fICONFIGFILE\fR...]
.PP
System units:
.sp
.nf
systemd\-tmpfiles\-setup\&.service
systemd\-tmpfiles\-setup\-dev\&.service
systemd\-tmpfiles\-clean\&.service
systemd\-tmpfiles\-clean\&.timer
.fi
.PP
User units:
.sp
.nf
systemd\-tmpfiles\-setup\&.service
systemd\-tmpfiles\-clean\&.service
systemd\-tmpfiles\-clean\&.timer
.fi
.SH "DESCRIPTION"
.PP
\fBsystemd\-tmpfiles\fR
creates, deletes, and cleans up volatile and temporary files and directories, based on the configuration file format and location specified in
\fBtmpfiles.d\fR(5)\&.
.PP
If invoked with no arguments, it applies all directives from all configuration files\&. When invoked with
\fB\-\-replace=\fR\fB\fIPATH\fR\fR, arguments specified on the command line are used instead of the configuration file
\fIPATH\fR\&. Otherwise, if one or more absolute filenames are passed on the command line, only the directives in these files are applied\&. If
"\-"
is specified instead of a filename, directives are read from standard input\&. If only the basename of a configuration file is specified, all configuration directories as specified in
\fBtmpfiles.d\fR(5)
are searched for a matching file and the file found that has the highest priority is executed\&.
.SH "OPTIONS"
.PP
The following options are understood:
.PP
\fB\-\-create\fR
.RS 4
If this option is passed, all files and directories marked with
\fIf\fR,
\fIF\fR,
\fIw\fR,
\fId\fR,
\fID\fR,
\fIv\fR,
\fIp\fR,
\fIL\fR,
\fIc\fR,
\fIb\fR,
\fIm\fR
in the configuration files are created or written to\&. Files and directories marked with
\fIz\fR,
\fIZ\fR,
\fIt\fR,
\fIT\fR,
\fIa\fR, and
\fIA\fR
have their ownership, access mode and security labels set\&.
.RE
.PP
\fB\-\-clean\fR
.RS 4
If this option is passed, all files and directories with an age parameter configured will be cleaned up\&.
.RE
.PP
\fB\-\-remove\fR
.RS 4
If this option is passed, the contents of directories marked with
\fID\fR
or
\fIR\fR, and files or directories themselves marked with
\fIr\fR
or
\fIR\fR
are removed\&.
.RE
.PP
\fB\-\-user\fR
.RS 4
Execute "user" configuration, i\&.e\&.
tmpfiles\&.d
files in user configuration directories\&.
.RE
.PP
\fB\-\-boot\fR
.RS 4
Also execute lines with an exclamation mark\&.
.RE
.PP
\fB\-\-prefix=\fR\fB\fIpath\fR\fR
.RS 4
Only apply rules with paths that start with the specified prefix\&. This option can be specified multiple times\&.
.RE
.PP
\fB\-\-exclude\-prefix=\fR\fB\fIpath\fR\fR
.RS 4
Ignore rules with paths that start with the specified prefix\&. This option can be specified multiple times\&.
.RE
.PP
\fB\-\-root=\fR\fB\fIroot\fR\fR
.RS 4
Takes a directory path as an argument\&. All paths will be prefixed with the given alternate
\fIroot\fR
path, including config search paths\&.
.sp
Note that this option does not alter how the users and groups specified in the configuration files are resolved\&. With or without this option, users and groups are always resolved according to the host\*(Aqs user and group databases, any such databases stored under the specified root directories are not consulted\&.
.RE
.PP
\fB\-\-replace=\fR\fB\fIPATH\fR\fR
.RS 4
When this option is given, one ore more positional arguments must be specified\&. All configuration files found in the directories listed in
\fBtmpfiles.d\fR(5)
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
\fIPATH\fR\&.
.sp
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\&.
.RE
.PP
\fB\-\-cat\-config\fR
.RS 4
Copy the contents of config files to standard output\&. Before each file, the filename is printed as a comment\&.
.RE
.PP
\fB\-\-no\-pager\fR
.RS 4
Do not pipe output into a pager\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Print a short help text and exit\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Print a short version string and exit\&.
.RE
.PP
It is possible to combine
\fB\-\-create\fR,
\fB\-\-clean\fR, and
\fB\-\-remove\fR
in one invocation (in which case removal and clean\-up 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:
.sp
.if n \{\
.RS 4
.\}
.nf
systemd\-tmpfiles \-\-remove \-\-create
.fi
.if n \{\
.RE
.\}
.SH "UNPRIVILEGED \-\-CLEANUP OPERATION"
.PP
\fBsystemd\-tmpfiles\fR
tries to avoid changing the access and modification times on the directories it accesses, which requires
\fBCAP_FOWNER\fR
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\&.
.SH "EXIT STATUS"
.PP
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,
\fB65\fR
is returned (\fBEX_DATAERR\fR
from
/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
/sys/
values, \&...),
\fB73\fR
is returned (\fBEX_CANTCREAT\fR
from
/usr/include/sysexits\&.h)\&. Otherwise,
\fB1\fR
is returned (\fBEXIT_FAILURE\fR
from
/usr/include/stdlib\&.h)\&.
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBtmpfiles.d\fR(5)