chiark / gitweb /
main: introduce /etc/machine-id
[elogind.git] / man / tmpfiles.d.xml
index 1df4a043e88545ee6169e4522ec47ee4149fdbb1..868b57e93517feab6b74c6d2f6ea8629a24f2269 100644 (file)
@@ -42,7 +42,8 @@
 
         <refnamediv>
                 <refname>tmpfiles.d</refname>
-                <refpurpose>Configuration for creation, deletion and cleaning of temporary and volatile files</refpurpose>
+                <refpurpose>Configuration for creation, deletion and
+                cleaning of volatile and temporary files</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
         <refsect1>
                 <title>Description</title>
 
-               <para><command>systemd</command> uses
+               <para><command>systemd-tmpfiles</command> uses the
+               configuration files in
                <filename>/etc/tmpfiles.d/</filename> to describe the
-               creation, cleaning and removal of temporary files and
-               directories which usually reside in
-               <filename>/var/run</filename> or
-               <filename>/tmp</filename>).  Each configuration file
+               creation, cleaning and removal of volatile and
+               temporary files and directories which usually reside
+               in directories such as <filename>/var/run</filename>
+               or <filename>/tmp</filename>. Each configuration file
                is named in the style of
                <filename>/etc/tmpfiles.d/&lt;program&gt;.conf</filename>.</para>
         </refsect1>
@@ -97,17 +99,41 @@ d    /var/run/user 0755 root root 10d</programlisting>
 
                                 <varlistentry>
                                         <term><varname>x</varname></term>
-                                        <listitem><para>Ignore a path</para></listitem>
+                                        <listitem><para>Ignore a path
+                                        during cleaning. Use this type
+                                        to exclude paths from clean-up
+                                        as controlled with the Age
+                                        parameter. 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
+                                        of normal path
+                                        names.</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>r</varname></term>
-                                        <listitem><para>Remove a path</para></listitem>
+                                        <listitem><para>Remove a file
+                                        or directory if it
+                                        exists. This may not be used
+                                        to remove non-empty
+                                        directories, use R for
+                                        that. Lines of this type
+                                        accept shell-style globs in
+                                        place of normal path
+                                        names.</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>R</varname></term>
-                                        <listitem><para>Recursively remove a path</para></listitem>
+                                        <listitem><para>Recursively
+                                        remove a path and all its
+                                        subdirectories (if it is a
+                                        directory). Lines of this type
+                                        accept shell-style globs in
+                                        place of normal path
+                                        names.</para></listitem>
                                 </varlistentry>
                         </variablelist>
                 </refsect2>
@@ -115,10 +141,11 @@ d    /var/run/user 0755 root root 10d</programlisting>
                 <refsect2>
                         <title>Mode</title>
 
-                        <para>The file access mode to use for this
-                        file or directory. If ommited or when set to -
-                        the default is used: 0755 for directories,
-                        0644 for files.</para>
+                        <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
+                        directories, 0644 for files. This parameter is
+                        ignored for x, r, R lines.</para>
                 </refsect2>
 
                 <refsect2>
@@ -127,8 +154,9 @@ d    /var/run/user 0755 root root 10d</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
-                        ommited or when set to - the default 0 is
-                        used.</para>
+                        omitted or when set to - the default 0 (root)
+                        is used. . These parameters are ignored for x,
+                        r, R lines.</para>
                 </refsect2>
 
                 <refsect2>
@@ -155,7 +183,7 @@ d    /var/run/user 0755 root root 10d</programlisting>
 
                         <para>If multiple integers and units are specified the time values are summed up.</para>
 
-                        <para>The age field only applies to lines starting with d, D and x. If ommited or set to - no automatic clean-up is done.</para>
+                        <para>The age field only applies to lines starting with d, D and x. If omitted or set to - no automatic clean-up is done.</para>
 
                 </refsect2>
 
@@ -175,7 +203,8 @@ d /var/run/uscreens 0755 root root 10d12h</programlisting>
         <refsect1>
                 <title>See Also</title>
                 <para>
-                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                 </para>
         </refsect1>