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 Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 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   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser 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>/etc/tmpfiles.d/*.conf</filename></para>
  51                 <para><filename>/run/tmpfiles.d/*.conf</filename></para>
  52                 <para><filename>/usr/lib/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 shall be named in the
  70                 style of <filename>&lt;program&gt;.conf</filename>.
  71                 Files in <filename>/etc/</filename> override files
  72                 with the same name in <filename>/usr/lib/</filename>
  73                 and <filename>/run/</filename>.  Files in
  74                 <filename>/run/</filename> override files with the same
  75                 name in <filename>/usr/lib/</filename>. Packages
  76                 should install their configuration files in
  77                 <filename>/usr/lib/</filename>. Files in
  78                 <filename>/etc/</filename> are reserved for the local
  79                 administrator, who may use this logic to override the
  80                 configuration files installed by vendor packages. All
  81                 configuration files are sorted by their filename in
  82                 alphabetical order, regardless in which of the
  83                 directories they reside, to guarantee that a specific
  84                 configuration file takes precedence over another file
  85                 with an alphabetically later name.</para>
  86
  87                 <para>If the administrator wants to disable a
  88                 configuration file supplied by the vendor the
  89                 recommended way is to place a symlink to
  90                 <filename>/dev/null</filename> in
  91                 <filename>/etc/tmpfiles.d/</filename> bearing the
  92                 same file name.</para>
  93
  94                 <para>The configuration format is one line per path
  95                 containing action, path, mode, ownership, age and argument
  96                 fields:</para>
  97
  98                 <programlisting>Type Path        Mode UID  GID  Age Argument
  99 d    /run/user   0755 root root 10d -
 100 L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
 101
 102                 <refsect2>
 103                         <title>Type</title>
 104                         <variablelist>
 105                                 <varlistentry>
 106                                         <term><varname>f</varname></term>
 107                                         <listitem><para>Create a file if it doesn't exist yet (optionally writing a short string into it, if the argument parameter is passed)</para></listitem>
 108                                 </varlistentry>
 109
 110                                 <varlistentry>
 111                                         <term><varname>F</varname></term>
 112                                         <listitem><para>Create or truncate a file (optionally writing a short string into it, if the argument parameter is passed)</para></listitem>
 113                                 </varlistentry>
 114
 115                                 <varlistentry>
 116                                         <term><varname>w</varname></term>
 117                                         <listitem><para>Write the argument parameter to a file, if it exists.</para></listitem>
 118                                 </varlistentry>
 119
 120                                 <varlistentry>
 121                                         <term><varname>d</varname></term>
 122                                         <listitem><para>Create a directory if it doesn't exist yet</para></listitem>
 123                                 </varlistentry>
 124
 125                                 <varlistentry>
 126                                         <term><varname>D</varname></term>
 127                                         <listitem><para>Create or empty a directory</para></listitem>
 128                                 </varlistentry>
 129
 130                                 <varlistentry>
 131                                         <term><varname>p</varname></term>
 132                                         <listitem><para>Create a named pipe (FIFO) if it doesn't exist yet</para></listitem>
 133                                 </varlistentry>
 134
 135                                 <varlistentry>
 136                                         <term><varname>L</varname></term>
 137                                         <listitem><para>Create a symlink if it doesn't exist yet</para></listitem>
 138                                 </varlistentry>
 139
 140                                 <varlistentry>
 141                                         <term><varname>c</varname></term>
 142                                         <listitem><para>Create a character device node if it doesn't exist yet</para></listitem>
 143                                 </varlistentry>
 144
 145                                 <varlistentry>
 146                                         <term><varname>b</varname></term>
 147                                         <listitem><para>Create a block device node if it doesn't exist yet</para></listitem>
 148                                 </varlistentry>
 149
 150                                 <varlistentry>
 151                                         <term><varname>x</varname></term>
 152                                         <listitem><para>Ignore a path
 153                                         during cleaning. Use this type
 154                                         to exclude paths from clean-up
 155                                         as controlled with the Age
 156                                         parameter. Note that lines of
 157                                         this type do not influence the
 158                                         effect of r or R lines. Lines
 159                                         of this type accept
 160                                         shell-style globs in place of
 161                                         of normal path
 162                                         names.</para></listitem>
 163                                 </varlistentry>
 164
 165                                 <varlistentry>
 166                                         <term><varname>r</varname></term>
 167                                         <listitem><para>Remove a file
 168                                         or directory if it
 169                                         exists. This may not be used
 170                                         to remove non-empty
 171                                         directories, use R for
 172                                         that. Lines of this type
 173                                         accept shell-style globs in
 174                                         place of normal path
 175                                         names.</para></listitem>
 176                                 </varlistentry>
 177
 178                                 <varlistentry>
 179                                         <term><varname>R</varname></term>
 180                                         <listitem><para>Recursively
 181                                         remove a path and all its
 182                                         subdirectories (if it is a
 183                                         directory). Lines of this type
 184                                         accept shell-style globs in
 185                                         place of normal path
 186                                         names.</para></listitem>
 187                                 </varlistentry>
 188
 189                                 <varlistentry>
 190                                         <term><varname>z</varname></term>
 191                                         <listitem><para>Restore
 192                                         SELinux security context label
 193                                         and set ownership and access
 194                                         mode of a file or directory if
 195                                         it exists.  Lines of this type
 196                                         accept shell-style globs in
 197                                         place of normal path names.
 198                                         </para></listitem>
 199                                 </varlistentry>
 200
 201                                 <varlistentry>
 202                                         <term><varname>Z</varname></term>
 203                                         <listitem><para>Recursively
 204                                         restore SELinux security
 205                                         context label and set
 206                                         ownership and access mode of a
 207                                         path and all its
 208                                         subdirectories (if it is a
 209                                         directory). Lines of this type
 210                                         accept shell-style globs in
 211                                         place of normal path
 212                                         names.</para></listitem>
 213                                 </varlistentry>
 214                         </variablelist>
 215                 </refsect2>
 216
 217                 <refsect2>
 218                         <title>Mode</title>
 219
 220                         <para>The file access mode to use when
 221                         creating this file or directory. If omitted or
 222                         when set to - the default is used: 0755 for
 223                         directories, 0644 for all other file
 224                         objects. For z, Z lines if omitted or when set
 225                         to - the file access mode will not be
 226                         modified. This parameter is ignored for x, r,
 227                         R, L lines.</para>
 228                 </refsect2>
 229
 230                 <refsect2>
 231                         <title>UID, GID</title>
 232
 233                         <para>The user and group to use for this file
 234                         or directory. This may either be a numeric
 235                         user/group ID or a user or group name. If
 236                         omitted or when set to - the default 0 (root)
 237                         is used. For z, Z lines when omitted or when set to -
 238                         the file ownership will not be modified.
 239                         These parameters are ignored for x, r, R, L lines.</para>
 240                 </refsect2>
 241
 242                 <refsect2>
 243                         <title>Age</title>
 244                         <para>The date field, when set, is used to
 245                         decide what files to delete when cleaning. If
 246                         a file or directory is older than the current
 247                         time minus the age field it is deleted. The
 248                         field format is a series of integers each
 249                         followed by one of the following
 250                         postfixes for the respective time units:</para>
 251
 252                         <variablelist>
 253                                 <varlistentry>
 254                                 <term><varname>s</varname></term>
 255                                 <term><varname>min</varname></term>
 256                                 <term><varname>h</varname></term>
 257                                 <term><varname>d</varname></term>
 258                                 <term><varname>w</varname></term>
 259                                 <term><varname>ms</varname></term>
 260                                 <term><varname>m</varname></term>
 261                                 <term><varname>us</varname></term></varlistentry>
 262                         </variablelist>
 263
 264                         <para>If multiple integers and units are specified the time
 265                         values are summed up.</para>
 266
 267                         <para>The age field only applies to lines starting with
 268                         d, D and x. If omitted or set to - no automatic clean-up
 269                         is done.</para>
 270
 271                         <para>If the age field starts with a tilde
 272                         character (~) the clean-up is only applied to
 273                         files and directories one level inside the
 274                         directory specified, but not the files and
 275                         directories immediately inside it.</para>
 276                 </refsect2>
 277
 278                 <refsect2>
 279                         <title>Argument</title>
 280
 281                         <para>For L lines determines the destination
 282                         path of the symlink. For c, b determines the
 283                         major/minor of the device node, with major and
 284                         minor formatted as integers, separated by :,
 285                         e.g. "1:3". For f, F, w may be used to specify
 286                         a short string that is written to the file,
 287                         suffixed by a newline. Ignored for all other
 288                         lines.</para>
 289                 </refsect2>
 290
 291         </refsect1>
 292
 293         <refsect1>
 294                 <title>Example</title>
 295                 <example>
 296                         <title>/etc/tmpfiles.d/screen.conf example</title>
 297                         <para><command>screen</command> needs two directories created at boot with specific modes and ownership.</para>
 298
 299                         <programlisting>d /var/run/screens  1777 root root 10d
 300 d /var/run/uscreens 0755 root root 10d12h</programlisting>
 301                 </example>
 302         </refsect1>
 303
 304         <refsect1>
 305                 <title>See Also</title>
 306                 <para>
 307                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 308                         <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 309                         <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 310                 </para>
 311         </refsect1>
 312
 313 </refentry>