chiark / gitweb /
man: document x-systemd-device-timeout=
[elogind.git] / man / systemd.mount.xml
index bb969bb..1986784 100644 (file)
                 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
                 <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
+                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>
-                <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
                 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
-                <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>
-                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
+                <filename>/etc/fstab</filename> and a unit file, the
                 configuration in the latter takes precedence.</para>
         </refsect1>
 
                                 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.)
                                 <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>
 
                                 <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>
 
                                 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>
 
                                 <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
                                 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>
                                 processes of this mount shall be
                                 killed. One of
                                 <option>control-group</option>,
-                                <option>process-group</option>,
                                 <option>process</option>,
                                 <option>none</option>.</para>
 
                                 <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>
-                          <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>,