systemd-tmpfiles.xml 9.09 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

24 25
<refentry id="systemd-tmpfiles"
          xmlns:xi="http://www.w3.org/2001/XInclude">
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

        <refentryinfo>
                <title>systemd-tmpfiles</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>systemd-tmpfiles</refentrytitle>
                <manvolnum>8</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>systemd-tmpfiles</refname>
                <refname>systemd-tmpfiles-setup.service</refname>
                <refname>systemd-tmpfiles-setup-dev.service</refname>
                <refname>systemd-tmpfiles-clean.service</refname>
                <refname>systemd-tmpfiles-clean.timer</refname>
                <refpurpose>Creates, deletes and cleans up volatile
                and temporary files and directories</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <cmdsynopsis>
58 59 60
                        <command>systemd-tmpfiles</command>
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                        <arg choice="opt" rep="repeat"><replaceable>CONFIGFILE</replaceable></arg>
61 62 63 64 65 66 67 68 69 70 71 72
                </cmdsynopsis>

                <para><filename>systemd-tmpfiles-setup.service</filename></para>
                <para><filename>systemd-tmpfiles-setup-dev.service</filename></para>
                <para><filename>systemd-tmpfiles-clean.service</filename></para>
                <para><filename>systemd-tmpfiles-clean.timer</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>systemd-tmpfiles</command> creates,
73
                deletes, and cleans up volatile and temporary files and
74
                directories, based on the configuration file format and
75 76 77
                location specified in
                <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
                </para>
78 79 80

                <para>If invoked with no arguments, it applies all
                directives from all configuration files. If one or
81
                more filenames are passed on the command line, only
82 83
                the directives in these files are applied. If only
                the basename of a configuration file is specified,
84 85 86
                all configuration directories as specified in
                <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                are searched for a matching file.</para>
87 88 89 90 91 92 93 94 95 96
        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>The following options are understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><option>--create</option></term>
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
                                <listitem><para>If this option is
                                passed, all files and directories
                                marked with <varname>f</varname>,
                                <varname>F</varname>,
                                <varname>w</varname>,
                                <varname>d</varname>,
                                <varname>D</varname>,
                                <varname>p</varname>,
                                <varname>L</varname>,
                                <varname>c</varname>,
                                <varname>b</varname>,
                                <varname>m</varname> in the
                                configuration files are created or
                                written to. Files and directories
                                marked with <varname>z</varname>,
                                <varname>Z</varname>,
                                <varname>m</varname> have their
                                ownership, access mode and security
                                labels set. </para></listitem>
116 117 118 119 120
                        </varlistentry>

                        <varlistentry>
                                <term><option>--clean</option></term>
                                <listitem><para>If this option is
121
                                passed, all files and directories with
122 123 124 125 126 127 128
                                an age parameter configured will be
                                cleaned up.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--remove</option></term>
                                <listitem><para>If this option is
129 130 131 132 133 134 135 136 137 138 139
                                passed, all files and directories
                                marked with <varname>r</varname>,
                                <varname>R</varname> in the
                                configuration files are
                                removed.</para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><option>--boot</option></term>
                                <listitem><para>Also execute lines
                                with an exclamation mark.
                                </para></listitem>
140 141
                        </varlistentry>
                        <varlistentry>
142
                                <term><option>--prefix=<replaceable>path</replaceable></option></term>
143 144
                                <listitem><para>Only apply rules that
                                apply to paths with the specified
145 146 147 148
                                prefix. This option can be specified
                                multiple times.</para></listitem>
                        </varlistentry>
                        <varlistentry>
149
                                <term><option>--exclude-prefix=<replaceable>path</replaceable></option></term>
150 151 152 153
                                <listitem><para>Ignore rules that
                                apply to paths with the specified
                                prefix. This option can be specified
                                multiple times.</para></listitem>
154 155
                        </varlistentry>
                        <varlistentry>
156 157 158 159 160 161
                                <term><option>--root=<replaceable>root</replaceable></option></term>
                                <listitem><para>Takes a directory path
                                as an argument. All paths will be
                                prefixed with the given alternate <replaceable>root</replaceable>
                                path, including config search paths.
                                </para></listitem>
162 163
                        </varlistentry>

164 165
                        <xi:include href="standard-options.xml" xpointer="help" />
                        <xi:include href="standard-options.xml" xpointer="version" />
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
                </variablelist>

                <para>It is possible to combine
                <option>--create</option>, <option>--clean</option>,
                and <option>--remove</option> in one invocation. 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:</para>

                <programlisting>systemd-tmpfiles --remove --create</programlisting>

        </refsect1>

        <refsect1>
                <title>Exit status</title>

183
                <para>On success, 0 is returned, a non-zero failure
184 185 186 187 188 189 190
                code otherwise.</para>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
191
                        <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
192 193 194 195
                </para>
        </refsect1>

</refentry>