chiark / gitweb /
build-sys: update intructions for Makefile-man.am regeneration
[elogind.git] / man / systemd-tmpfiles.xml
index 403592d..0b62640 100644 (file)
@@ -21,7 +21,8 @@
   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>
@@ -54,7 +55,9 @@
 
         <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>
                 <title>Description</title>
 
                 <para><command>systemd-tmpfiles</command> creates,
-                deletes and cleans up volatile and temporary files and
+                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>
+                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> are searched for a matching file.</para>
+                all configuration directories as specified in
+                <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                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. Files and directories marked with z,
-                                Z have their ownership, access mode and security
-                                labels set.</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>
                                 multiple times.</para></listitem>
                         </varlistentry>
 
-
-                        <varlistentry>
-                                <term><option>--help</option></term>
-
-                                <listitem><para>Prints a short help
-                                text and exits.</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
         <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>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 </para>
         </refsect1>