man: explain the precise syntax and feature set of unit names at the end of the man...

[elogind.git] / man / tmpfiles.d.xml

diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml
index 2872cc0add463e4d484e40a4c4e355bff68eda21..1c079f64bcbc6e152b39c5bbf442c78111de00f0 100644 (file)
--- a/man/tmpfiles.d.xml
+++ b/man/tmpfiles.d.xml
@@ -67,7 +67,7 @@
                 <title>Configuration Format</title>
 
                 <para>Each configuration file shall be named in the
                 <title>Configuration Format</title>
 
                 <para>Each configuration file shall be named in the

-                style of <filename>&lt;program&gt;.conf</filename>.
+                style of <filename>&lt;package&gt;.conf</filename>.

                 Files in <filename>/etc/</filename> override files
                 with the same name in <filename>/usr/lib/</filename>
                 and <filename>/run/</filename>.  Files in
                 Files in <filename>/etc/</filename> override files
                 with the same name in <filename>/usr/lib/</filename>
                 and <filename>/run/</filename>.  Files in


@@ -79,14 +79,14 @@
                 administrator, who may use this logic to override the
                 configuration files installed by vendor packages. All
                 configuration files are sorted by their filename in
                 administrator, who may use this logic to override the
                 configuration files installed by vendor packages. All
                 configuration files are sorted by their filename in

-                alphabetical order, regardless in which of the
+                lexicographic order, regardless in which of the

                 directories they reside. If multiple files specify the
                 directories they reside. If multiple files specify the

-                same path, the entry in the file with the alphabetically
+                same path, the entry in the file with the lexicographically

                 earliest name will be applied, all all other conflicting
                 entries logged as errors.</para>
 
                 <para>If the administrator wants to disable a
                 earliest name will be applied, all all other conflicting
                 entries logged as errors.</para>
 
                 <para>If the administrator wants to disable a

-                configuration file supplied by the vendor the
+                configuration file supplied by the vendor, the

                 recommended way is to place a symlink to
                 <filename>/dev/null</filename> in
                 <filename>/etc/tmpfiles.d/</filename> bearing the
                 recommended way is to place a symlink to
                 <filename>/dev/null</filename> in
                 <filename>/etc/tmpfiles.d/</filename> bearing the


@@ -100,8 +100,12 @@
 d    /run/user   0755 root root 10d -
 L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
 
 d    /run/user   0755 root root 10d -
 L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
 

+

                 <refsect2>
                         <title>Type</title>
                 <refsect2>
                         <title>Type</title>

+
+                        <para>The following line types are understood:</para>
+

                         <variablelist>
                                 <varlistentry>
                                         <term><varname>f</varname></term>
                         <variablelist>
                                 <varlistentry>
                                         <term><varname>f</varname></term>


@@ -151,6 +155,17 @@ L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
                                         <listitem><para>Create a block device node if it does not exist yet</para></listitem>
                                 </varlistentry>
 
                                         <listitem><para>Create a block device node if it does not exist yet</para></listitem>
                                 </varlistentry>
 

+                                <varlistentry>
+                                        <term><varname>m</varname></term>
+                                        <listitem><para>If the
+                                        specified file path exists,
+                                        adjust its access mode, group
+                                        and user to the specified
+                                        values and reset the SELinux
+                                        label. If it does not exist, do
+                                        nothing.</para></listitem>
+                                </varlistentry>
+

                                 <varlistentry>
                                         <term><varname>x</varname></term>
                                         <listitem><para>Ignore a path
                                 <varlistentry>
                                         <term><varname>x</varname></term>
                                         <listitem><para>Ignore a path


@@ -169,15 +184,18 @@ L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
                                 <varlistentry>
                                         <term><varname>X</varname></term>
                                         <listitem><para>Ignore a path
                                 <varlistentry>
                                         <term><varname>X</varname></term>
                                         <listitem><para>Ignore a path

-                                        during cleanup. Use this type
-                                        to prevent path removal as
-                                        controlled with the Age parameter.
-                                        Note that if path is a directory,
-                                        content of a directory is not
-                                        excluded from clean-up, only
-                                        directory itself. Lines of this
-                                        type accept shell-style globs
-                                        in place of normal path
+                                        during cleaning. Use this type
+                                        to exclude paths from clean-up
+                                        as controlled with the Age
+                                        parameter. Unlike x, this
+                                        parameter will not exclude the
+                                        content if path is a directory,
+                                        but only directory itself.
+                                        Note that lines of this type do
+                                        not influence the effect of r
+                                        or R lines. Lines of this type
+                                        accept shell-style globs in
+                                        place of normal path

                                         names.</para></listitem>
                                 </varlistentry>
 
                                         names.</para></listitem>
                                 </varlistentry>
 


@@ -233,15 +251,66 @@ L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
                         </variablelist>
                 </refsect2>
 
                         </variablelist>
                 </refsect2>
 

+                <refsect2>
+                        <title>Path</title>
+
+                        <para>The file system path specification supports simple specifier
+                        expansion. The following expansions are
+                        understood:</para>
+
+                        <table>
+                                <title>Specifiers available</title>
+                                <tgroup cols='3' align='left' colsep='1' rowsep='1'>
+                                        <colspec colname="spec" />
+                                        <colspec colname="mean" />
+                                        <colspec colname="detail" />
+                                        <thead>
+                                                <row>
+                                                        <entry>Specifier</entry>
+                                                        <entry>Meaning</entry>
+                                                        <entry>Details</entry>
+                                                </row>
+                                        </thead>
+                                        <tbody>
+                                                <row>
+                                                        <entry><literal>%m</literal></entry>
+                                                        <entry>Machine ID</entry>
+                                                        <entry>The machine ID of the running system, formatted as string. See <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry>
+                                                </row>
+                                                <row>
+                                                        <entry><literal>%b</literal></entry>
+                                                        <entry>Boot ID</entry>
+                                                        <entry>The boot ID of the running system, formatted as string. See <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry> for more information.</entry>
+                                                </row>
+                                                <row>
+                                                        <entry><literal>%H</literal></entry>
+                                                        <entry>Host name</entry>
+                                                        <entry>The hostname of the running system.</entry>
+                                                </row>
+                                                <row>
+                                                        <entry><literal>%v</literal></entry>
+                                                        <entry>Kernel release</entry>
+                                                        <entry>Identical to <command>uname -r</command> output.</entry>
+                                                </row>
+                                                <row>
+                                                        <entry><literal>%%</literal></entry>
+                                                        <entry>Escaped %</entry>
+                                                        <entry>Single percent sign.</entry>
+                                                </row>
+                                        </tbody>
+                                </tgroup>
+                        </table>
+                </refsect2>
+

                 <refsect2>
                         <title>Mode</title>
 
                         <para>The file access mode to use when
                         creating this file or directory. If omitted or
                 <refsect2>
                         <title>Mode</title>
 
                         <para>The file access mode to use when
                         creating this file or directory. If omitted or

-                        when set to - the default is used: 0755 for
+                        when set to -, the default is used: 0755 for

                         directories, 0644 for all other file
                         directories, 0644 for all other file

-                        objects. For z, Z lines if omitted or when set
-                        to - the file access mode will not be
+                        objects. For z, Z lines, if omitted or when set
+                        to -, the file access mode will not be

                         modified. This parameter is ignored for x, r,
                         R, L lines.</para>
                 </refsect2>
                         modified. This parameter is ignored for x, r,
                         R, L lines.</para>
                 </refsect2>


@@ -252,8 +321,8 @@ L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
                         <para>The user and group to use for this file
                         or directory. This may either be a numeric
                         user/group ID or a user or group name. If
                         <para>The user and group to use for this file
                         or directory. This may either be a numeric
                         user/group ID or a user or group name. If

-                        omitted or when set to - the default 0 (root)
-                        is used. For z, Z lines when omitted or when set to -
+                        omitted or when set to -, the default 0 (root)
+                        is used. For z, Z lines, when omitted or when set to -,

                         the file ownership will not be modified.
                         These parameters are ignored for x, r, R, L lines.</para>
                 </refsect2>
                         the file ownership will not be modified.
                         These parameters are ignored for x, r, R, L lines.</para>
                 </refsect2>


@@ -263,7 +332,7 @@ L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
                         <para>The date field, when set, is used to
                         decide what files to delete when cleaning. If
                         a file or directory is older than the current
                         <para>The date field, when set, is used to
                         decide what files to delete when cleaning. If
                         a file or directory is older than the current

-                        time minus the age field it is deleted. The
+                        time minus the age field, it is deleted. The

                         field format is a series of integers each
                         followed by one of the following
                         postfixes for the respective time units:</para>
                         field format is a series of integers each
                         followed by one of the following
                         postfixes for the respective time units:</para>


@@ -280,7 +349,7 @@ L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
                                 <term><varname>us</varname></term></varlistentry>
                         </variablelist>
 
                                 <term><varname>us</varname></term></varlistentry>
                         </variablelist>
 

-                        <para>If multiple integers and units are specified the time
+                        <para>If multiple integers and units are specified, the time

                         values are summed up. If an integer is given without a unit,
                         s is assumed.
                         </para>
                         values are summed up. If an integer is given without a unit,
                         s is assumed.
                         </para>


@@ -289,11 +358,11 @@ L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
                         unconditionally.</para>
 
                         <para>The age field only applies to lines starting with
                         unconditionally.</para>
 
                         <para>The age field only applies to lines starting with

-                        d, D and x. If omitted or set to - no automatic clean-up
+                        d, D and x. If omitted or set to -, no automatic clean-up

                         is done.</para>
 
                         <para>If the age field starts with a tilde
                         is done.</para>
 
                         <para>If the age field starts with a tilde

-                        character (~) the clean-up is only applied to
+                        character (~), the clean-up is only applied to

                         files and directories one level inside the
                         directory specified, but not the files and
                         directories immediately inside it.</para>
                         files and directories one level inside the
                         directory specified, but not the files and
                         directories immediately inside it.</para>