chiark / gitweb /
build-sys: update intructions for Makefile-man.am regeneration
[elogind.git] / man / systemd-tmpfiles.xml
index 986a442..0b62640 100644 (file)
@@ -8,20 +8,21 @@
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
+  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
-  General Public License for more details.
+  Lesser General Public License for more details.
 
-  You should have received a copy of the GNU General Public License
+  You should have received a copy of the GNU Lesser General Public License
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="systemd-tmpfiles">
+<refentry id="systemd-tmpfiles"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>systemd-tmpfiles</title>
 
         <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>
+                and temporary files and directories</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
                 <cmdsynopsis>
-                        <command>systemd-tmpfiles <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">CONFIGURATION FILE</arg></command>
+                        <command>systemd-tmpfiles</command>
+                        <arg choice="opt" rep="repeat">OPTIONS</arg>
+                        <arg choice="opt" rep="repeat"><replaceable>CONFIGFILE</replaceable></arg>
                 </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,
-                deletes and cleans up volatile ad temporary files and
-                directories, based on the configuration from
-                <filename>/etc/tmpfiles.d/</filename>. See
+                deletes, and cleans up volatile and temporary files and
+                directories, based on the configuration file format and
+                location specified in
+                <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+                </para>
+
+                <para>If invoked with no arguments, it applies all
+                directives from all configuration files. If one or
+                more filenames are passed on the command line, only
+                the directives in these files are applied. If only
+                the basename of a configuration file is specified,
+                all configuration directories as specified in
                 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-                for more details on these files.</para>
-
-                <para>If invoked with no arguments applies all
-                directives from all configuration files in
-                <filename>/etc/tmpfiles.d/*.conf</filename>. If one or
-                more absolute file names are passed on the command
-                line only the directives in these files are
-                applied.</para>
+                are searched for a matching file.</para>
         </refsect1>
 
         <refsect1>
                 <para>The following options are understood:</para>
 
                 <variablelist>
-
                         <varlistentry>
                                 <term><option>--create</option></term>
-                                <listitem><para>If this option is passed all
-                                files and directories marked with f,
-                                F, d, D in the configuration files are
-                                created.</para></listitem>
+                                <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>
                         </varlistentry>
 
                         <varlistentry>
                                 <term><option>--clean</option></term>
                                 <listitem><para>If this option is
-                                passed all files and directories with
+                                passed, all files and directories with
                                 an age parameter configured will be
                                 cleaned up.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><option>--remove</option></term>
                                 <listitem><para>If this option is
-                                passed all files and directories marked
-                                with r, R in the configuration files
-                                are removed.</para></listitem>
+                                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>
                         </varlistentry>
                         <varlistentry>
                                 <term><option>--prefix=PATH</option></term>
                                 <listitem><para>Only apply rules that
                                 apply to paths with the specified
-                                prefix.</para></listitem>
+                                prefix. This option can be specified
+                                multiple times.</para></listitem>
                         </varlistentry>
-
-
                         <varlistentry>
-                                <term><option>--help</option></term>
-
-                                <listitem><para>Prints a short help
-                                text and exits.</para></listitem>
+                                <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>
 
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
                 </variablelist>
 
                 <para>It is possible to combine
                 and <option>--remove</option> in one invocation. For
                 example, during boot the following command line is
                 executed to ensure that all temporary and volatile
-                directores are removed and created according to the
+                directories are removed and created according to the
                 configuration file:</para>
 
-                <programlisting>systemctl-tmpfiles --remove --create</programlisting>
+                <programlisting>systemd-tmpfiles --remove --create</programlisting>
 
         </refsect1>
 
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
                 <title>See Also</title>
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>tmpwatch</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 </para>
         </refsect1>