2011-02-13 17:08:15 +03:00
<?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
2012-04-12 02:20:58 +04:00
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
2011-02-13 17:08:15 +03:00
(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
2012-04-12 02:20:58 +04:00
Lesser General Public License for more details.
2011-02-13 17:08:15 +03:00
2012-04-12 02:20:58 +04:00
You should have received a copy of the GNU Lesser General Public License
2011-02-13 17:08:15 +03:00
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
2014-02-13 23:33:51 +04:00
<refentry id= "systemd-tmpfiles"
xmlns:xi="http://www.w3.org/2001/XInclude">
2011-02-13 17:08:15 +03:00
<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>
2012-06-27 17:39:51 +04:00
<refname > systemd-tmpfiles-setup.service</refname>
2013-04-23 11:56:32 +04:00
<refname > systemd-tmpfiles-setup-dev.service</refname>
2012-06-27 17:39:51 +04:00
<refname > systemd-tmpfiles-clean.service</refname>
<refname > systemd-tmpfiles-clean.timer</refname>
2011-02-13 17:08:15 +03:00
<refpurpose > Creates, deletes and cleans up volatile
2012-07-16 20:08:25 +04:00
and temporary files and directories</refpurpose>
2011-02-13 17:08:15 +03:00
</refnamediv>
<refsynopsisdiv >
<cmdsynopsis >
2013-12-24 19:21:45 +04:00
<command > systemd-tmpfiles</command>
<arg choice= "opt" rep= "repeat" > OPTIONS</arg>
<arg choice= "opt" rep= "repeat" > <replaceable > CONFIGFILE</replaceable> </arg>
2011-02-13 17:08:15 +03:00
</cmdsynopsis>
2012-06-27 17:39:51 +04:00
<para > <filename > systemd-tmpfiles-setup.service</filename> </para>
2013-04-23 11:56:32 +04:00
<para > <filename > systemd-tmpfiles-setup-dev.service</filename> </para>
2012-06-27 17:39:51 +04:00
<para > <filename > systemd-tmpfiles-clean.service</filename> </para>
<para > <filename > systemd-tmpfiles-clean.timer</filename> </para>
2011-02-13 17:08:15 +03:00
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > <command > systemd-tmpfiles</command> creates,
2013-12-24 19:21:45 +04:00
deletes, and cleans up volatile and temporary files and
2012-06-10 20:26:11 +04:00
directories, based on the configuration file format and
2013-12-24 19:21:45 +04:00
location specified in
<citerefentry > <refentrytitle > tmpfiles.d</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .
</para>
2012-06-10 20:26:11 +04:00
<para > If invoked with no arguments, it applies all
directives from all configuration files. If one or
2013-06-27 23:51:44 +04:00
more filenames are passed on the command line, only
2012-06-10 21:21:50 +04:00
the directives in these files are applied. If only
the basename of a configuration file is specified,
2013-12-24 19:21:45 +04:00
all configuration directories as specified in
<citerefentry > <refentrytitle > tmpfiles.d</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
are searched for a matching file.</para>
2011-02-13 17:08:15 +03:00
</refsect1>
<refsect1 >
<title > Options</title>
<para > The following options are understood:</para>
<variablelist >
<varlistentry >
<term > <option > --create</option> </term>
2013-12-24 19:21:45 +04:00
<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>
2011-02-13 17:08:15 +03:00
</varlistentry>
<varlistentry >
<term > <option > --clean</option> </term>
<listitem > <para > If this option is
2013-09-12 23:12:49 +04:00
passed, all files and directories with
2011-02-13 17:08:15 +03:00
an age parameter configured will be
cleaned up.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > --remove</option> </term>
<listitem > <para > If this option is
2013-12-24 19:21:45 +04:00
passed, all files and directories
marked with <varname > r</varname> ,
<varname > R</varname> in the
configuration files are
removed.</para> </listitem>
2013-12-21 05:25:39 +04:00
</varlistentry>
<varlistentry >
2013-12-30 22:00:38 +04:00
<term > <option > --boot</option> </term>
2013-12-21 05:25:39 +04:00
<listitem > <para > Also execute lines
with an exclamation mark.
</para> </listitem>
2011-02-13 17:08:15 +03:00
</varlistentry>
<varlistentry >
<term > <option > --prefix=PATH</option> </term>
<listitem > <para > Only apply rules that
apply to paths with the specified
2013-07-24 19:10:05 +04:00
prefix. This option can be specified
multiple times.</para> </listitem>
2011-02-13 17:08:15 +03:00
</varlistentry>
2013-07-24 19:19:24 +04:00
<varlistentry >
<term > <option > --exclude-prefix=PATH</option> </term>
<listitem > <para > Ignore rules that
apply to paths with the specified
prefix. This option can be specified
multiple times.</para> </listitem>
</varlistentry>
2014-02-13 23:33:51 +04:00
<xi:include href= "standard-options.xml" xpointer= "help" />
<xi:include href= "standard-options.xml" xpointer= "version" />
2011-02-13 17:08:15 +03:00
</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
2011-04-23 23:55:24 +04:00
directories are removed and created according to the
2011-02-13 17:08:15 +03:00
configuration file:</para>
2011-07-30 21:01:01 +04:00
<programlisting > systemd-tmpfiles --remove --create</programlisting>
2011-02-13 17:08:15 +03:00
</refsect1>
<refsect1 >
<title > Exit status</title>
2013-12-26 05:47:44 +04:00
<para > On success, 0 is returned, a non-zero failure
2011-02-13 17:08:15 +03:00
code otherwise.</para>
</refsect1>
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2013-09-18 01:33:30 +04:00
<citerefentry > <refentrytitle > tmpfiles.d</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
2011-02-13 17:08:15 +03:00
</para>
</refsect1>
</refentry>