man: document x-systemd-device-timeout=

[elogind.git] / man / systemd.mount.xml

diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
index 94ed66453a644cd6bacd1d458a5d3964291d961b..1986784947dd9a99c8e355e3445e9794a8667ad3 100644 (file)
--- a/man/systemd.mount.xml
+++ b/man/systemd.mount.xml
@@ -69,10 +69,13 @@
                 in the [Mount] section.</para>
 
                 <para>Additional options are listed in
                 in the [Mount] section.</para>
 
                 <para>Additional options are listed in

-                <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+                <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                which define the execution environment the
+                <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                binary is executed in.</para>

 
 

-                <para>Mount units must be named after the file paths
-                they reflect. Example: the mount point
+                <para>Mount units must be named after the mount point
+                directories they control. Example: the mount point

                 <filename>/home/lennart</filename> must be configured
                 in a unit file
                 <filename>home-lennart.mount</filename>. For details
                 <filename>/home/lennart</filename> must be configured
                 in a unit file
                 <filename>home-lennart.mount</filename>. For details


@@ -84,10 +87,19 @@
                 an automount unit, to allow on-demand or parallelized
                 mounting. See
                 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
                 an automount unit, to allow on-demand or parallelized
                 mounting. See
                 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>

+
+                <para>If an mount point is beneath another mount point
+                in the file system hierarchy, a dependency between both
+                units is created automatically.</para>
+
+                <para>Mount points created at runtime independent on
+                unit files or <filename>/etc/fstab</filename> will be
+                monitored by systemd and appear like any other mount
+                unit in systemd.</para>

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

-                <title><filename>fstab</filename></title>
+                <title><filename>/etc/fstab</filename></title>

 
                 <para>Mount units may either be configured via unit
                 files, or via <filename>/etc/fstab</filename> (see
 
                 <para>Mount units may either be configured via unit
                 files, or via <filename>/etc/fstab</filename> (see


@@ -98,19 +110,28 @@
                 few special mount options are understood by systemd
                 which influence how dependencies are created for mount
                 points from <filename>/etc/fstab</filename>. If
                 few special mount options are understood by systemd
                 which influence how dependencies are created for mount
                 points from <filename>/etc/fstab</filename>. If

-                <option>comment=systemd.mount</option> is specified as
-                mount option then systemd will create a dependency of
-                type <option>Wants</option> from either
+                <option>x-systemd.mount</option> is specified as mount
+                option, then systemd will create a dependency of type
+                <option>Wants</option> from either

                 <filename>local-fs.target</filename> or
                 <filename>remote-fs.target</filename>, depending
                 whether the file system is local or remote. If
                 <filename>local-fs.target</filename> or
                 <filename>remote-fs.target</filename>, depending
                 whether the file system is local or remote. If

-                <option>comment=systemd.automount</option> is set, an
-                automount unit will be created for the file system. See
+                <option>x-systemd.automount</option> is set, an
+                automount unit will be created for the file
+                system. See

                 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>

-                for details.</para>
+                for details. If
+                <option>x-systemd-device-timeout=</option> is
+                specified it may be used to configure how long systemd
+                should wait for a device to show up before giving up
+                on an entry from
+                <filename>/etc/fstab</filename>. Specify a time in
+                seconds or explicitly specifiy a unit as
+                <literal>s</literal>, <literal>min</literal>,
+                <literal>h</literal>, <literal>ms</literal>.</para>

 
                 <para>If a mount point is configured in both
 
                 <para>If a mount point is configured in both

-                <filename>/etc/fstab</filename> and a unit file the
+                <filename>/etc/fstab</filename> and a unit file, the

                 configuration in the latter takes precedence.</para>
         </refsect1>
 
                 configuration in the latter takes precedence.</para>
         </refsect1>
 


@@ -135,7 +156,7 @@
                                 resource to mount. See
                                 <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                                 for details. If this refers to a
                                 resource to mount. See
                                 <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                                 for details. If this refers to a

-                                device node a dependency on the
+                                device node, a dependency on the

                                 respective device unit is
                                 automatically created. (See
                                 <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.)
                                 respective device unit is
                                 automatically created. (See
                                 <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.)


@@ -148,7 +169,7 @@
                                 <listitem><para>Takes an absolute path
                                 of a directory of the mount point. If
                                 the mount point is not existing at
                                 <listitem><para>Takes an absolute path
                                 of a directory of the mount point. If
                                 the mount point is not existing at

-                                time of mounting it is created. This
+                                time of mounting, it is created. This

                                 string must be reflected in the unit
                                 file name. (See above.) This option is
                                 mandatory.</para></listitem>
                                 string must be reflected in the unit
                                 file name. (See above.) This option is
                                 mandatory.</para></listitem>


@@ -168,7 +189,7 @@
 
                                 <listitem><para>Mount options to use
                                 when mounting. This takes a comma
 
                                 <listitem><para>Mount options to use
                                 when mounting. This takes a comma

-                                seperated list of options. This
+                                separated list of options. This

                                 setting is optional.</para></listitem>
                         </varlistentry>
 
                                 setting is optional.</para></listitem>
                         </varlistentry>
 


@@ -179,7 +200,8 @@
                                 are automatically created if
                                 needed. This option specifies the file
                                 system access mode used when creating
                                 are automatically created if
                                 needed. This option specifies the file
                                 system access mode used when creating

-                                these directories. Defaults to
+                                these directories. Takes an access
+                                mode in octal notation. Defaults to

                                 0755.</para></listitem>
                         </varlistentry>
 
                                 0755.</para></listitem>
                         </varlistentry>
 


@@ -187,7 +209,7 @@
                                 <term><varname>TimeoutSec=</varname></term>
                                 <listitem><para>Configures the time to
                                 wait for the mount command to
                                 <term><varname>TimeoutSec=</varname></term>
                                 <listitem><para>Configures the time to
                                 wait for the mount command to

-                                finish. If a comand does not exit
+                                finish. If a command does not exit

                                 within the configured time the mount
                                 will be considered failed and be shut
                                 down again. All commands still running
                                 within the configured time the mount
                                 will be considered failed and be shut
                                 down again. All commands still running


@@ -199,7 +221,7 @@
                                 a time span value such as "5min
                                 20s". Pass 0 to disable the timeout
                                 logic. Defaults to
                                 a time span value such as "5min
                                 20s". Pass 0 to disable the timeout
                                 logic. Defaults to

-                                60s.</para></listitem>
+                                90s.</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>


@@ -208,7 +230,6 @@
                                 processes of this mount shall be
                                 killed. One of
                                 <option>control-group</option>,
                                 processes of this mount shall be
                                 killed. One of
                                 <option>control-group</option>,

-                                <option>process-group</option>,

                                 <option>process</option>,
                                 <option>none</option>.</para>
 
                                 <option>process</option>,
                                 <option>none</option>.</para>
 


@@ -218,13 +239,32 @@
                                 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                 for details.</para></listitem>
                         </varlistentry>
                                 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                 for details.</para></listitem>
                         </varlistentry>

+
+                        <varlistentry>
+                                <term><varname>KillSignal=</varname></term>
+                                <listitem><para>Specifies which signal
+                                to use when killing a process of this
+                                mount. Defaults to SIGTERM.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>SendSIGKILL=</varname></term>
+                                <listitem><para>Specifies whether to
+                                send SIGKILL to remaining processes
+                                after a timeout, if the normal
+                                shutdown procedure left processes of
+                                the mount around. Takes a boolean
+                                value. Defaults to "yes".
+                                </para></listitem>
+                        </varlistentry>

                 </variablelist>
         </refsect1>
 
         <refsect1>
                   <title>See Also</title>
                   <para>
                 </variablelist>
         </refsect1>
 
         <refsect1>
                   <title>See Also</title>
                   <para>

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

                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,