man/systemd-tmpfiles.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="systemd-tmpfiles">
  25
  26         <refentryinfo>
  27                 <title>systemd-tmpfiles</title>
  28                 <productname>systemd</productname>
  29
  30                 <authorgroup>
  31                         <author>
  32                                 <contrib>Developer</contrib>
  33                                 <firstname>Lennart</firstname>
  34                                 <surname>Poettering</surname>
  35                                 <email>lennart@poettering.net</email>
  36                         </author>
  37                 </authorgroup>
  38         </refentryinfo>
  39
  40         <refmeta>
  41                 <refentrytitle>systemd-tmpfiles</refentrytitle>
  42                 <manvolnum>8</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>systemd-tmpfiles</refname>
  47                 <refpurpose>Creates, deletes and cleans up volatile
  48                 and temporary files and directories.</refpurpose>
  49         </refnamediv>
  50
  51         <refsynopsisdiv>
  52                 <cmdsynopsis>
  53                         <command>systemd-tmpfiles <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">CONFIGURATION FILE</arg></command>
  54                 </cmdsynopsis>
  55         </refsynopsisdiv>
  56
  57         <refsect1>
  58                 <title>Description</title>
  59
  60                 <para><command>systemd-tmpfiles</command> creates,
  61                 deletes and cleans up volatile and temporary files and
  62                 directories, based on the configuration file format and
  63                 location specified in <citerefentry>
  64                         <refentrytitle>tmpfiles.d</refentrytitle>
  65                         <manvolnum>5</manvolnum>
  66                 </citerefentry>.</para>
  67
  68                 <para>If invoked with no arguments, it applies all
  69                 directives from all configuration files. If one or
  70                 more file names are passed on the command line, only
  71                 the directives in these files are applied. If only
  72                 the basename of a configuration file is specified,
  73                 all configuration directories as specified in <citerefentry>
  74                         <refentrytitle>tmpfiles.d</refentrytitle>
  75                         <manvolnum>5</manvolnum>
  76                 </citerefentry> are searched for a matching file.</para>
  77         </refsect1>
  78
  79         <refsect1>
  80                 <title>Options</title>
  81
  82                 <para>The following options are understood:</para>
  83
  84                 <variablelist>
  85
  86                         <varlistentry>
  87                                 <term><option>--create</option></term>
  88                                 <listitem><para>If this option is passed all
  89                                 files and directories marked with f,
  90                                 F, d, D in the configuration files are
  91                                 created. Files and directories marked with z,
  92                                 Z have their ownership, access mode and security
  93                                 labels set.</para></listitem>
  94                         </varlistentry>
  95
  96                         <varlistentry>
  97                                 <term><option>--clean</option></term>
  98                                 <listitem><para>If this option is
  99                                 passed all files and directories with
 100                                 an age parameter configured will be
 101                                 cleaned up.</para></listitem>
 102                         </varlistentry>
 103
 104                         <varlistentry>
 105                                 <term><option>--remove</option></term>
 106                                 <listitem><para>If this option is
 107                                 passed all files and directories marked
 108                                 with r, R in the configuration files
 109                                 are removed.</para></listitem>
 110                         </varlistentry>
 111                         <varlistentry>
 112                                 <term><option>--prefix=PATH</option></term>
 113                                 <listitem><para>Only apply rules that
 114                                 apply to paths with the specified
 115                                 prefix.</para></listitem>
 116                         </varlistentry>
 117
 118
 119                         <varlistentry>
 120                                 <term><option>--help</option></term>
 121
 122                                 <listitem><para>Prints a short help
 123                                 text and exits.</para></listitem>
 124                         </varlistentry>
 125
 126                 </variablelist>
 127
 128                 <para>It is possible to combine
 129                 <option>--create</option>, <option>--clean</option>,
 130                 and <option>--remove</option> in one invocation. For
 131                 example, during boot the following command line is
 132                 executed to ensure that all temporary and volatile
 133                 directories are removed and created according to the
 134                 configuration file:</para>
 135
 136                 <programlisting>systemd-tmpfiles --remove --create</programlisting>
 137
 138         </refsect1>
 139
 140         <refsect1>
 141                 <title>Exit status</title>
 142
 143                 <para>On success 0 is returned, a non-zero failure
 144                 code otherwise.</para>
 145         </refsect1>
 146
 147         <refsect1>
 148                 <title>See Also</title>
 149                 <para>
 150                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 151                         <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 152                 </para>
 153         </refsect1>
 154
 155 </refentry>