man: systemd.service(5): add some simple examples

[elogind.git] / man / systemd-tmpfiles.xml

diff --git a/man/systemd-tmpfiles.xml b/man/systemd-tmpfiles.xml
index c65636b0fe65b48336a984358b0339902321d62c..d4c5bf26e4c6473cf0aecf82b77226bcee5b5718 100644 (file)
--- a/man/systemd-tmpfiles.xml
+++ b/man/systemd-tmpfiles.xml
@@ -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>
@@ -91,21 +92,6 @@
                 <para>The following options are understood:</para>
 
                 <variablelist>
-                        <varlistentry>
-                                <term><option>-h</option></term>
-                                <term><option>--help</option></term>
-
-                                <listitem><para>Prints a short help
-                                text and exits.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><option>--version</option></term>
-
-                                <listitem><para>Prints a short version
-                                string and exits.</para></listitem>
-                        </varlistentry>
-
                         <varlistentry>
                                 <term><option>--create</option></term>
                                 <listitem><para>If this option is
@@ -115,6 +101,7 @@
                                 <varname>w</varname>,
                                 <varname>d</varname>,
                                 <varname>D</varname>,
+                                <varname>v</varname>,
                                 <varname>p</varname>,
                                 <varname>L</varname>,
                                 <varname>c</varname>,
@@ -124,7 +111,10 @@
                                 written to. Files and directories
                                 marked with <varname>z</varname>,
                                 <varname>Z</varname>,
-                                <varname>m</varname> have their
+                                <varname>t</varname>,
+                                <varname>T</varname>,
+                                <varname>a</varname>, and
+                                <varname>A</varname> have their
                                 ownership, access mode and security
                                 labels set. </para></listitem>
                         </varlistentry>
@@ -140,26 +130,46 @@
                         <varlistentry>
                                 <term><option>--remove</option></term>
                                 <listitem><para>If this option is
-                                passed, all files and directories
-                                marked with <varname>r</varname>,
-                                <varname>R</varname> in the
-                                configuration files are
+                                passed, the contents of
+                                directories marked with
+                                <varname>D</varname> or
+                                <varname>R</varname>, and files or
+                                directories themselves marked with
+                                <varname>r</varname> or
+                                <varname>R</varname> are
                                 removed.</para></listitem>
                         </varlistentry>
                         <varlistentry>
-                                <term><option>--prefix=PATH</option></term>
+                                <term><option>--boot</option></term>
+                                <listitem><para>Also execute lines
+                                with an exclamation mark.
+                                </para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><option>--prefix=<replaceable>path</replaceable></option></term>
                                 <listitem><para>Only apply rules that
                                 apply to paths with the specified
                                 prefix. This option can be specified
                                 multiple times.</para></listitem>
                         </varlistentry>
                         <varlistentry>
-                                <term><option>--exclude-prefix=PATH</option></term>
+                                <term><option>--exclude-prefix=<replaceable>path</replaceable></option></term>
                                 <listitem><para>Ignore rules that
                                 apply to paths with the specified
                                 prefix. This option can be specified
                                 multiple times.</para></listitem>
                         </varlistentry>
+                        <varlistentry>
+                                <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>
+                        </varlistentry>
+
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
                 </variablelist>
 
                 <para>It is possible to combine
@@ -174,10 +184,23 @@
 
         </refsect1>
 
+        <refsect1>
+                <title>Unprivileged --cleanup operation</title>
+
+                <para><command>systemd-tmpfiles</command> tries to
+                avoid changing the access and modification times on
+                the directories it accesses, which requires
+                <constant>CAP_ADMIN</constant> privileges. When
+                running as non-root, directories which are checked for
+                files to clean up will have their access time bumped,
+                which might prevent their cleanup.
+                </para>
+        </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>