man: add reference to systemd-delta to tmpfiles

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

diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml
index 25a7c9ba48351d96b84388c65de4a16a6eca5449..96b1872318efcaf9024fd1a1f9c5a407fbfd4eb8 100644 (file)
--- a/man/tmpfiles.d.xml
+++ b/man/tmpfiles.d.xml
@@ -7,16 +7,16 @@
   Copyright 2010 Brandon Philips
 
   systemd is free software; you can redistribute it and/or modify it
   Copyright 2010 Brandon Philips
 
   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
   (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="tmpfiles.d">
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 <refentry id="tmpfiles.d">


@@ -47,47 +47,53 @@
         </refnamediv>
 
         <refsynopsisdiv>
         </refnamediv>
 
         <refsynopsisdiv>

-                <para><filename>/usr/lib/tmpfiles.d/*.conf</filename></para>

                 <para><filename>/etc/tmpfiles.d/*.conf</filename></para>
                 <para><filename>/run/tmpfiles.d/*.conf</filename></para>
                 <para><filename>/etc/tmpfiles.d/*.conf</filename></para>
                 <para><filename>/run/tmpfiles.d/*.conf</filename></para>

+                <para><filename>/usr/lib/tmpfiles.d/*.conf</filename></para>

         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 

-               <para><command>systemd-tmpfiles</command> uses the
-               configuration files from the above directories to describe the
-               creation, cleaning and removal of volatile and
-               temporary files and directories which usually reside
-               in directories such as <filename>/run</filename>
-               or <filename>/tmp</filename>.</para>
+                <para><command>systemd-tmpfiles</command> uses the
+                configuration files from the above directories to describe the
+                creation, cleaning and removal of volatile and
+                temporary files and directories which usually reside
+                in directories such as <filename>/run</filename>
+                or <filename>/tmp</filename>.</para>

         </refsect1>
 
         <refsect1>
         </refsect1>
 
         <refsect1>

-               <title>Configuration Format</title>
-
-                <para>Each configuration file is named in the style of
-                <filename>&lt;program&gt;.conf</filename>.  Files in
-                <filename>/etc/</filename> override files with the
-                same name in <filename>/usr/lib/</filename>.  Files in
-                <filename>/run</filename> override files with the same
-                name in <filename>/etc/</filename> and
-                <filename>/usr/lib/</filename>. Packages should
-                install their configuration files in
-                <filename>/usr/lib/</filename>, files in
+                <title>Configuration Format</title>
+
+                <para>Each configuration file shall be named in the
+                style of <filename>&lt;program&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
+                <filename>/run/</filename> override files with the same
+                name in <filename>/usr/lib/</filename>. Packages
+                should install their configuration files in
+                <filename>/usr/lib/</filename>. Files in

                 <filename>/etc/</filename> are reserved for the local
                 <filename>/etc/</filename> are reserved for the local

-                administrator, who may choose to override the
-                configurations installed from packages. The list of
+                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
                 configuration files are sorted by their filename in
                 alphabetical order, regardless in which of the

-                directories they reside, to guarantee that a
-                configuration file takes precedence over another
-                configuration file with an alphabetically later
-                name.</para>
+                directories they reside, to guarantee that a specific
+                configuration file takes precedence over another file
+                with an alphabetically later name</para>
+
+                <para>If the administrator wants to disable a
+                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
+                same file name.</para>

 
 

-               <para>The configuration format is one line per path
-               containing action, path, mode, ownership, age and argument
-               fields:</para>
+                <para>The configuration format is one line per path
+                containing action, path, mode, ownership, age and argument
+                fields:</para>

 
                 <programlisting>Type Path        Mode UID  GID  Age Argument
 d    /run/user   0755 root root 10d -
 
                 <programlisting>Type Path        Mode UID  GID  Age Argument
 d    /run/user   0755 root root 10d -


@@ -182,23 +188,28 @@ L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
 
                                 <varlistentry>
                                         <term><varname>z</varname></term>
 
                                 <varlistentry>
                                         <term><varname>z</varname></term>

-                                        <listitem><para>Set ownership, access
-                                        mode and relabel security context of
-                                        a file or directory if it exists.
-                                        Lines of this type accept shell-style
-                                        globs in place of normal path names.
+                                        <listitem><para>Restore
+                                        SELinux security context label
+                                        and set ownership and access
+                                        mode of a file or directory if
+                                        it exists.  Lines of this type
+                                        accept shell-style globs in
+                                        place of normal path names.

                                         </para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>Z</varname></term>
                                         </para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>Z</varname></term>

-                                        <listitem><para>Recursively set
-                                        ownership, access mode and relabel
-                                        security context of 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>
+                                        <listitem><para>Recursively
+                                        restore SELinux security
+                                        context label and set
+                                        ownership and access mode of 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>
                                 </varlistentry>
                         </variablelist>
                 </refsect2>


@@ -256,6 +267,12 @@ L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
                         <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>
                         <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>

+
+                        <para>If the age field starts with a tilde
+                        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>

                 </refsect2>
 
                 <refsect2>
                 </refsect2>
 
                 <refsect2>


@@ -288,7 +305,8 @@ d /var/run/uscreens 0755 root root 10d12h</programlisting>
                 <title>See Also</title>
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                 <title>See Also</title>
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

-                        <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>

                 </para>
         </refsect1>
 
                 </para>
         </refsect1>