chiark / gitweb /
tmpfiles: apply chown, chmod for 'Z' entries too
[elogind.git] / man / tmpfiles.d.xml
index 7bdb6de0b0368781e10375f7979d5e7d54e490eb..e137967654e795abb74c4e89a643864aaadc85c5 100644 (file)
 
         <refnamediv>
                 <refname>tmpfiles.d</refname>
-                <refpurpose>configuration for creation, deletion and cleaning of tmpfiles</refpurpose>
+                <refpurpose>Configuration for creation, deletion and
+                cleaning of volatile and temporary files</refpurpose>
         </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>
+        </refsynopsisdiv>
+
         <refsect1>
                 <title>Description</title>
 
-               <para><command>systemd</command> uses
-               <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
-               is named in the style of
-               <filename>/etc/tmpfiles.d/&lt;program&gt;.conf</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>
                <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> overwrite
+                files with the same name in <filename>/usr/lib/</filename>.
+                Files in <filename>/run</filename> overwrite 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 <filename>/etc/</filename> are reserved for the local
+                administration, which possibly decides to overwrite the
+                configurations installed from packages. All files are sorted
+                by filename in alphabetical order, regardless in which of the
+                directories they reside, to ensure that a specific
+                configuration file takes precedence over another file with
+                an alphabetically later name.</para>
+
                <para>The configuration format is one line per path
                containing action, mode, ownership and age
                fields:</para>
 
                 <programlisting>Type Path          Mode UID  GID  Age
-d    /var/run/user 0755 root root 10d</programlisting>
+d    /run/user 0755 root root 10d</programlisting>
 
                 <refsect2>
                         <title>Type</title>
                         <variablelist>
                                 <varlistentry>
                                         <term><varname>f</varname></term>
-                                        <listitem><para>create a file if it doesn't exist yet</para></listitem>
+                                        <listitem><para>Create a file if it doesn't exist yet</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>F</varname></term>
-                                        <listitem><para>create or truncate a file</para></listitem>
+                                        <listitem><para>Create or truncate a file</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>d</varname></term>
-                                        <listitem><para>create a directory if it doesn't exist yet</para></listitem>
+                                        <listitem><para>Create a directory if it doesn't exist yet</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>D</varname></term>
-                                        <listitem><para>create or empty a directory</para></listitem>
+                                        <listitem><para>Create or empty a directory</para></listitem>
+                                </varlistentry>
+
+                                <varlistentry>
+                                        <term><varname>p</varname></term>
+                                        <listitem><para>Create a named pipe (FIFO) if it doesn't exist yet</para></listitem>
                                 </varlistentry>
 
                                 <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>
+
+                                <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>
                                 </varlistentry>
                         </variablelist>
                 </refsect2>
@@ -111,10 +172,13 @@ 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. For Z lines
+                        if omitted or when set to - the file access mode will
+                        not be modified. This parameter is ignored for x, r, R
+                        lines.</para>
                 </refsect2>
 
                 <refsect2>
@@ -123,8 +187,10 @@ 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. For Z lines when omitted or when set to -
+                        the file ownership will not be modified.
+                        These parameters are ignored for x, r, R lines.</para>
                 </refsect2>
 
                 <refsect2>
@@ -149,10 +215,12 @@ d    /var/run/user 0755 root root 10d</programlisting>
                                 <term><varname>us</varname></term></varlistentry>
                         </variablelist>
 
-                        <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>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 omitted or set to - no automatic clean-up
+                        is done.</para>
                 </refsect2>
 
         </refsect1>
@@ -171,7 +239,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>