systemd-tmpfiles.xml revision 195f8e36122b83bbfef27bf63afe888e7101a320
2N/A<?xml version='1.0'?> <!--*-nxml-*-->
2N/A<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2N/A "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
2N/A
2N/A<!--
2N/A This file is part of systemd.
2N/A
2N/A Copyright 2010 Lennart Poettering
2N/A
2N/A systemd is free software; you can redistribute it and/or modify it
2N/A under the terms of the GNU Lesser General Public License as published by
2N/A the Free Software Foundation; either version 2.1 of the License, or
2N/A (at your option) any later version.
2N/A
2N/A systemd is distributed in the hope that it will be useful, but
2N/A WITHOUT ANY WARRANTY; without even the implied warranty of
2N/A MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2N/A Lesser General Public License for more details.
2N/A
2N/A You should have received a copy of the GNU Lesser General Public License
2790N/A along with systemd; If not, see <http://www.gnu.org/licenses/>.
2790N/A-->
3739N/A
2N/A<refentry id="systemd-tmpfiles">
2N/A
2N/A <refentryinfo>
2N/A <title>systemd-tmpfiles</title>
2N/A <productname>systemd</productname>
2N/A
3817N/A <authorgroup>
2N/A <author>
2N/A <contrib>Developer</contrib>
2N/A <firstname>Lennart</firstname>
59N/A <surname>Poettering</surname>
59N/A <email>lennart@poettering.net</email>
2N/A </author>
2N/A </authorgroup>
2N/A </refentryinfo>
2N/A
26N/A <refmeta>
26N/A <refentrytitle>systemd-tmpfiles</refentrytitle>
2N/A <manvolnum>8</manvolnum>
26N/A </refmeta>
1470N/A
38N/A <refnamediv>
1470N/A <refname>systemd-tmpfiles</refname>
1470N/A <refname>systemd-tmpfiles-setup.service</refname>
1470N/A <refname>systemd-tmpfiles-setup-dev.service</refname>
181N/A <refname>systemd-tmpfiles-clean.service</refname>
26N/A <refname>systemd-tmpfiles-clean.timer</refname>
4811N/A <refpurpose>Creates, deletes and cleans up volatile
4811N/A and temporary files and directories</refpurpose>
4811N/A </refnamediv>
3739N/A
3739N/A <refsynopsisdiv>
3739N/A <cmdsynopsis>
3739N/A <command>systemd-tmpfiles <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">CONFIGURATION FILE</arg></command>
3739N/A </cmdsynopsis>
3739N/A
3739N/A <para><filename>systemd-tmpfiles-setup.service</filename></para>
3739N/A <para><filename>systemd-tmpfiles-setup-dev.service</filename></para>
3817N/A <para><filename>systemd-tmpfiles-clean.service</filename></para>
3817N/A <para><filename>systemd-tmpfiles-clean.timer</filename></para>
26N/A </refsynopsisdiv>
26N/A
26N/A <refsect1>
26N/A <title>Description</title>
26N/A
26N/A <para><command>systemd-tmpfiles</command> creates,
26N/A deletes and cleans up volatile and temporary files and
700N/A directories, based on the configuration file format and
700N/A location specified in <citerefentry>
26N/A <refentrytitle>tmpfiles.d</refentrytitle>
26N/A <manvolnum>5</manvolnum>
26N/A </citerefentry>.</para>
1498N/A
1498N/A <para>If invoked with no arguments, it applies all
26N/A directives from all configuration files. If one or
1498N/A more file names are passed on the command line, only
151N/A the directives in these files are applied. If only
206N/A the basename of a configuration file is specified,
26N/A all configuration directories as specified in <citerefentry>
26N/A <refentrytitle>tmpfiles.d</refentrytitle>
26N/A <manvolnum>5</manvolnum>
26N/A </citerefentry> are searched for a matching file.</para>
26N/A </refsect1>
3998N/A
2818N/A <refsect1>
2830N/A <title>Options</title>
3127N/A
3998N/A <para>The following options are understood:</para>
26N/A
3294N/A <variablelist>
26N/A
2N/A <varlistentry>
4747N/A <term><option>--create</option></term>
4437N/A <listitem><para>If this option is passed all
4437N/A files and directories marked with f,
4488N/A F, d, D in the configuration files are
4488N/A created. Files and directories marked with z,
4437N/A Z have their ownership, access mode and security
4437N/A labels set.</para></listitem>
26N/A </varlistentry>
26N/A
26N/A <varlistentry>
26N/A <term><option>--clean</option></term>
883N/A <listitem><para>If this option is
26N/A passed all files and directories with
26N/A an age parameter configured will be
26N/A cleaned up.</para></listitem>
26N/A </varlistentry>
1043N/A
4953N/A <varlistentry>
4953N/A <term><option>--remove</option></term>
586N/A <listitem><para>If this option is
26N/A passed all files and directories marked
5329N/A with r, R in the configuration files
5329N/A are removed.</para></listitem>
93N/A </varlistentry>
5329N/A <varlistentry>
5329N/A <term><option>--prefix=PATH</option></term>
166N/A <listitem><para>Only apply rules that
26N/A apply to paths with the specified
379N/A prefix.</para></listitem>
379N/A </varlistentry>
1498N/A
5123N/A
1498N/A <varlistentry>
4518N/A <term><option>--help</option></term>
4518N/A
2899N/A <listitem><para>Prints a short help
2236N/A text and exits.</para></listitem>
2818N/A </varlistentry>
4910N/A
2N/A </variablelist>
26N/A
26N/A <para>It is possible to combine
181N/A <option>--create</option>, <option>--clean</option>,
181N/A and <option>--remove</option> in one invocation. For
4353N/A example, during boot the following command line is
4353N/A executed to ensure that all temporary and volatile
4353N/A directories are removed and created according to the
4488N/A configuration file:</para>
99N/A
59N/A <programlisting>systemd-tmpfiles --remove --create</programlisting>
12N/A
30N/A </refsect1>
4811N/A
4811N/A <refsect1>
4811N/A <title>Exit status</title>
1256N/A
1256N/A <para>On success 0 is returned, a non-zero failure
1256N/A code otherwise.</para>
2818N/A </refsect1>
1256N/A
1256N/A <refsect1>
1256N/A <title>See Also</title>
1256N/A <para>
1256N/A <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1256N/A <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1256N/A </para>
1256N/A </refsect1>
1256N/A
2818N/A</refentry>
1256N/A