X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Ftmpfiles.d.xml;h=6a2193d67d637c3d768f42ebc625857756ed2d68;hp=5ff53ef76645ad31d1dec4ceac0b1623ad80d246;hb=431c72dc3d482732a01d3ab929aa9b2c36422d46;hpb=4149f86d816fc0fef41d35de5beb09bfe81e0d6a
diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml
index 5ff53ef76..6a2193d67 100644
--- a/man/tmpfiles.d.xml
+++ b/man/tmpfiles.d.xml
@@ -7,16 +7,16 @@
Copyright 2010 Brandon Philips
systemd is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ Lesser General Public License for more details.
- You should have received a copy of the GNU General Public License
+ You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see .
-->
@@ -42,88 +42,274 @@
tmpfiles.d
- configuration for creation, deletion and cleaning of tmpfiles
+ Configuration for creation, deletion and
+ cleaning of volatile and temporary files
+
+ /etc/tmpfiles.d/*.conf
+ /run/tmpfiles.d/*.conf
+ /usr/lib/tmpfiles.d/*.conf
+
+
Description
- systemd uses /etc/tmpfiles.d/ to describe the creation, cleaning and removal of temporary files and directories
-which usually reside in /var/run or /tmp).
-Each configuration file is named in the style of
-/etc/tmpfiles.d/<program>.conf
-
+ systemd-tmpfiles uses the
+ configuration files from the above directories to describe the
+ creation, cleaning and removal of volatile and
+ temporary files and directories which usually reside
+ in directories such as /run
+ or /tmp.
- Configuration Format
+ Configuration Format
+
+ Each configuration file shall be named in the
+ style of <program>.conf.
+ Files in /etc/ override files
+ with the same name in /usr/lib/
+ and /run/. Files in
+ /run/ override files with the same
+ name in /usr/lib/. Packages
+ should install their configuration files in
+ /usr/lib/. Files in
+ /etc/ are reserved for the local
+ administrator, who may use this logic to override the
+ configuration files installed by vendor packages. All
+ configuration files are sorted by their filename in
+ alphabetical order, regardless in which of the
+ directories they reside, to guarantee that a specific
+ configuration file takes precedence over another file
+ with an alphabetically later name.
+
+ If the administrator wants to disable a
+ configuration file supplied by the vendor the
+ recommended way is to place a symlink to
+ /dev/null in
+ /etc/tmpfiles.d/ bearing the
+ same filename.
+
+ The configuration format is one line per path
+ containing action, path, mode, ownership, age and argument
+ fields:
+
+ Type Path Mode UID GID Age Argument
+d /run/user 0755 root root 10d -
+L /tmp/foobar - - - - /dev/null
+
+
+ Type
+
+
+ f
+ Create a file if it doesn't exist yet (optionally writing a short string into it, if the argument parameter is passed)
+
+
+
+ F
+ Create or truncate a file (optionally writing a short string into it, if the argument parameter is passed)
+
+
+
+ w
+ Write the argument parameter to a file, if the file exists.
+ Lines of this type accept shell-style globs in place of normal path
+ names. The argument parameter will be written without a trailing
+ newline. C-style backslash escapes are interpreted.
+
+
+
+ d
+ Create a directory if it doesn't exist yet
+
+
+
+ D
+ Create or empty a directory
+
+
+
+ p
+ Create a named pipe (FIFO) if it doesn't exist yet
+
+
+
+ L
+ Create a symlink if it doesn't exist yet
+
+
+
+ c
+ Create a character device node if it doesn't exist yet
+
- The configuration format is one line per path containing
-action, mode, ownership and age fields:
+
+ b
+ Create a block device node if it doesn't exist yet
+
- type path mode uid gid age
-d /var/run/user 0755 root root 10d
-
+
+ x
+ Ignore a path
+ during cleaning. Use this type
+ to exclude paths from clean-up
+ as controlled with the Age
+ parameter. Note that lines of
+ this type do not influence the
+ effect of r or R lines. Lines
+ of this type accept
+ shell-style globs in place of
+ normal path
+ names.
+
-
- type
-
-
- f
- create a file
-
+
+ X
+ Ignore a path
+ during cleanup. Use this type
+ to prevent path removal as
+ controlled with the Age parameter.
+ Note that if path is a directory,
+ content of a directory is not
+ excluded from clean-up, only
+ directory itself. Lines of this
+ type accept shell-style globs
+ in place of normal path
+ names.
+
-
- F
- truncate a file
-
+
+ r
+ Remove a file
+ or directory if it
+ exists. This may not be used
+ to remove non-empty
+ directories, use R for
+ that. Lines of this type
+ accept shell-style globs in
+ place of normal path
+ names.
+
-
+
+ R
+ Recursively
+ remove a path and all its
+ subdirectories (if it is a
+ directory). Lines of this type
+ accept shell-style globs in
+ place of normal path
+ names.
+
+
+
+ z
+ Restore
+ SELinux security context label
+ and set ownership and access
+ mode of a file or directory if
+ it exists. Lines of this type
+ accept shell-style globs in
+ place of normal path names.
+
+
+
+
+ Z
+ Recursively
+ restore SELinux security
+ context label and set
+ ownership and access mode of a
+ path and all its
+ subdirectories (if it is a
+ directory). Lines of this type
+ accept shell-style globs in
+ place of normal path
+ names.
+
+
+
+
+
+ Mode
+
+ The file access mode to use when
+ creating this file or directory. If omitted or
+ when set to - the default is used: 0755 for
+ directories, 0644 for all other file
+ objects. For z, Z lines if omitted or when set
+ to - the file access mode will not be
+ modified. This parameter is ignored for x, r,
+ R, L lines.
+
+
+
+ UID, GID
+
+ The user and group to use for this file
+ or directory. This may either be a numeric
+ user/group ID or a user or group name. If
+ omitted or when set to - the default 0 (root)
+ is used. For z, Z lines when omitted or when set to -
+ the file ownership will not be modified.
+ These parameters are ignored for x, r, R, L lines.
+
+
+
+ Age
+ The date field, when set, is used to
+ decide what files to delete when cleaning. If
+ a file or directory is older than the current
+ time minus the age field it is deleted. The
+ field format is a series of integers each
+ followed by one of the following
+ postfixes for the respective time units:
+
+
+
+ s
+ min
+ h
d
- create a directory
-
-
-
- D
- truncate a directory
-
-
-
- x
- ignore the path
-
-
-
- r
- remove the path
-
-
-
- R
- recursively remove the path
-
-
-
-
-
- age
- The date field, when set, is used to decide what files to delete when cleaning. If a file or directory is older than the current time minus the age field it is deleted. The field format is an integer followed by one of the following postfixes:
-
- sec
- s
- min
- hr
- h
- d
- w
- msec
- ms
- m
- usec
- us
-
-
+ w
+ ms
+ m
+ us
+
+
+ If multiple integers and units are specified the time
+ values are summed up. If an integer is given without a unit,
+ s is assumed.
+
+
+ When the age is set to zero, the files are cleaned
+ unconditionally.
+
+ The age field only applies to lines starting with
+ d, D and x. If omitted or set to - no automatic clean-up
+ is done.
+
+ If the age field starts with a tilde
+ character (~) the clean-up is only applied to
+ files and directories one level inside the
+ directory specified, but not the files and
+ directories immediately inside it.
+
+
+
+ Argument
+ For L lines determines the destination
+ path of the symlink. For c, b determines the
+ major/minor of the device node, with major and
+ minor formatted as integers, separated by :,
+ e.g. "1:3". For f, F, w may be used to specify
+ a short string that is written to the file,
+ suffixed by a newline. Ignored for all other
+ lines.
+
@@ -133,16 +319,17 @@ d /var/run/user 0755 root root 10d
/etc/tmpfiles.d/screen.conf example
screen needs two directories created at boot with specific modes and ownership.
- d /var/run/screens 1777 root root 10d
-d /var/run/uscreens 0755 root root 10d
-
+ d /var/run/screens 1777 root root 10d
+d /var/run/uscreens 0755 root root 10d12h
See Also
- systemd1
+ systemd1,
+ systemd-tmpfiles8,
+ systemd-delta1