man/tmpfiles.d.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!--
   5   This file is part of systemd.
   6
   7   Copyright 2010 Brandon Philips
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; either version 2 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 -->
  22 <refentry id="tmpfiles.d">
  23
  24         <refentryinfo>
  25                 <title>tmpfiles.d</title>
  26                 <productname>systemd</productname>
  27
  28                 <authorgroup>
  29                         <author>
  30                                 <contrib>Documentation</contrib>
  31                                 <firstname>Brandon</firstname>
  32                                 <surname>Philips</surname>
  33                                 <email>brandon@ifup.org</email>
  34                         </author>
  35                 </authorgroup>
  36         </refentryinfo>
  37
  38         <refmeta>
  39                 <refentrytitle>tmpfiles.d</refentrytitle>
  40                 <manvolnum>5</manvolnum>
  41         </refmeta>
  42
  43         <refnamediv>
  44                 <refname>tmpfiles.d</refname>
  45                 <refpurpose>Configuration for creation, deletion and
  46                 cleaning of volatile and temporary files</refpurpose>
  47         </refnamediv>
  48
  49         <refsynopsisdiv>
  50                 <para><filename>/usr/lib/tmpfiles.d/*.conf</filename></para>
  51                 <para><filename>/etc/tmpfiles.d/*.conf</filename></para>
  52                 <para><filename>/run/tmpfiles.d/*.conf</filename></para>
  53         </refsynopsisdiv>
  54
  55         <refsect1>
  56                 <title>Description</title>
  57
  58                 <para><command>systemd-tmpfiles</command> uses the
  59                 configuration files from the above directories to describe the
  60                 creation, cleaning and removal of volatile and
  61                 temporary files and directories which usually reside
  62                 in directories such as <filename>/run</filename>
  63                 or <filename>/tmp</filename>.</para>
  64         </refsect1>
  65
  66         <refsect1>
  67                 <title>Configuration Format</title>
  68
  69                 <para>Each configuration file is named in the style of
  70                 <filename>&lt;program&gt;.conf</filename>.
  71                 Files in <filename>/etc/</filename> overwrite
  72                 files with the same name in <filename>/usr/lib/</filename>.
  73                 Files in <filename>/run</filename> overwrite files with
  74                 the same name in <filename>/etc/</filename> and
  75                 <filename>/usr/lib/</filename>. Packages should install their
  76                 configuration files in <filename>/usr/lib/</filename>, files
  77                 in <filename>/etc/</filename> are reserved for the local
  78                 administration, which possibly decides to overwrite the
  79                 configurations installed from packages. All files are sorted
  80                 by filename in alphabetical order, regardless in which of the
  81                 directories they reside, to ensure that a specific
  82                 configuration file takes precedence over another file with
  83                 an alphabetically later name.</para>
  84
  85                 <para>The configuration format is one line per path
  86                 containing action, mode, ownership and age
  87                 fields:</para>
  88
  89                 <programlisting>Type Path          Mode UID  GID  Age
  90 d    /run/user 0755 root root 10d</programlisting>
  91
  92                 <refsect2>
  93                         <title>Type</title>
  94                         <variablelist>
  95                                 <varlistentry>
  96                                         <term><varname>f</varname></term>
  97                                         <listitem><para>Create a file if it doesn't exist yet</para></listitem>
  98                                 </varlistentry>
  99
 100                                 <varlistentry>
 101                                         <term><varname>F</varname></term>
 102                                         <listitem><para>Create or truncate a file</para></listitem>
 103                                 </varlistentry>
 104
 105                                 <varlistentry>
 106                                         <term><varname>d</varname></term>
 107                                         <listitem><para>Create a directory if it doesn't exist yet</para></listitem>
 108                                 </varlistentry>
 109
 110                                 <varlistentry>
 111                                         <term><varname>D</varname></term>
 112                                         <listitem><para>Create or empty a directory</para></listitem>
 113                                 </varlistentry>
 114
 115                                 <varlistentry>
 116                                         <term><varname>p</varname></term>
 117                                         <listitem><para>Create a named pipe (FIFO) if it doesn't exist yet</para></listitem>
 118                                 </varlistentry>
 119
 120                                 <varlistentry>
 121                                         <term><varname>x</varname></term>
 122                                         <listitem><para>Ignore a path
 123                                         during cleaning. Use this type
 124                                         to exclude paths from clean-up
 125                                         as controlled with the Age
 126                                         parameter. Note that lines of
 127                                         this type do not influence the
 128                                         effect of r or R lines. Lines
 129                                         of this type accept
 130                                         shell-style globs in place of
 131                                         of normal path
 132                                         names.</para></listitem>
 133                                 </varlistentry>
 134
 135                                 <varlistentry>
 136                                         <term><varname>r</varname></term>
 137                                         <listitem><para>Remove a file
 138                                         or directory if it
 139                                         exists. This may not be used
 140                                         to remove non-empty
 141                                         directories, use R for
 142                                         that. Lines of this type
 143                                         accept shell-style globs in
 144                                         place of normal path
 145                                         names.</para></listitem>
 146                                 </varlistentry>
 147
 148                                 <varlistentry>
 149                                         <term><varname>R</varname></term>
 150                                         <listitem><para>Recursively
 151                                         remove a path and all its
 152                                         subdirectories (if it is a
 153                                         directory). Lines of this type
 154                                         accept shell-style globs in
 155                                         place of normal path
 156                                         names.</para></listitem>
 157                                 </varlistentry>
 158
 159                                 <varlistentry>
 160                                         <term><varname>z</varname></term>
 161                                         <listitem><para>Set ownership, access
 162                                         mode and relabel security context of
 163                                         a file or directory if it exists.
 164                                         Lines of this type accept shell-style
 165                                         globs in place of normal path names.
 166                                         </para></listitem>
 167                                 </varlistentry>
 168
 169                                 <varlistentry>
 170                                         <term><varname>Z</varname></term>
 171                                         <listitem><para>Recursively set
 172                                         ownership, access mode and relabel
 173                                         security context of a path and
 174                                         all its subdirectories (if it is a
 175                                         directory). Lines of this type accept
 176                                         shell-style globs in place of normal
 177                                         path names.</para></listitem>
 178                                 </varlistentry>
 179                         </variablelist>
 180                 </refsect2>
 181
 182                 <refsect2>
 183                         <title>Mode</title>
 184
 185                         <para>The file access mode to use when
 186                         creating this file or directory. If omitted or
 187                         when set to - the default is used: 0755 for
 188                         directories, 0644 for files. For z, Z lines
 189                         if omitted or when set to - the file access mode will
 190                         not be modified. This parameter is ignored for x, r, R
 191                         lines.</para>
 192                 </refsect2>
 193
 194                 <refsect2>
 195                         <title>UID, GID</title>
 196
 197                         <para>The user and group to use for this file
 198                         or directory. This may either be a numeric
 199                         user/group ID or a user or group name. If
 200                         omitted or when set to - the default 0 (root)
 201                         is used. For z, Z lines when omitted or when set to -
 202                         the file ownership will not be modified.
 203                         These parameters are ignored for x, r, R lines.</para>
 204                 </refsect2>
 205
 206                 <refsect2>
 207                         <title>Age</title>
 208                         <para>The date field, when set, is used to
 209                         decide what files to delete when cleaning. If
 210                         a file or directory is older than the current
 211                         time minus the age field it is deleted. The
 212                         field format is a series of integers each
 213                         followed by one of the following
 214                         postfixes for the respective time units:</para>
 215
 216                         <variablelist>
 217                                 <varlistentry>
 218                                 <term><varname>s</varname></term>
 219                                 <term><varname>min</varname></term>
 220                                 <term><varname>h</varname></term>
 221                                 <term><varname>d</varname></term>
 222                                 <term><varname>w</varname></term>
 223                                 <term><varname>ms</varname></term>
 224                                 <term><varname>m</varname></term>
 225                                 <term><varname>us</varname></term></varlistentry>
 226                         </variablelist>
 227
 228                         <para>If multiple integers and units are specified the time
 229                         values are summed up.</para>
 230
 231                         <para>The age field only applies to lines starting with
 232                         d, D and x. If omitted or set to - no automatic clean-up
 233                         is done.</para>
 234                 </refsect2>
 235
 236         </refsect1>
 237
 238         <refsect1>
 239                 <title>Example</title>
 240                 <example>
 241                         <title>/etc/tmpfiles.d/screen.conf example</title>
 242                         <para><command>screen</command> needs two directories created at boot with specific modes and ownership.</para>
 243
 244                         <programlisting>d /var/run/screens 1777 root root 10d
 245 d /var/run/uscreens 0755 root root 10d12h</programlisting>
 246                 </example>
 247         </refsect1>
 248
 249         <refsect1>
 250                 <title>See Also</title>
 251                 <para>
 252                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 253                         <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 254                 </para>
 255         </refsect1>
 256
 257 </refentry>