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 635fba3b95dbb4db2ea1db10974d5bc8c95e141f..1986784947dd9a99c8e355e3445e9794a8667ad3 100644 (file)
--- a/man/systemd.mount.xml
+++ b/man/systemd.mount.xml
@@ -69,7 +69,10 @@
                 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 mount point
                 directories they control. Example: the mount point
 
                 <para>Mount units must be named after the mount point
                 directories they control. Example: the mount point


@@ -96,7 +99,7 @@
         </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


@@ -107,16 +110,25 @@
                 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
                 <filename>/etc/fstab</filename> and a unit file, the
 
                 <para>If a mount point is configured in both
                 <filename>/etc/fstab</filename> and a unit file, the


@@ -177,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>
 


@@ -188,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>
 


@@ -208,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>


@@ -217,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>
 


@@ -227,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>,