man: document the WATCHDOG_USEC environment variable

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

diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index 7200525c030ce412f6cb3d642d1e18d018ee860b..a1d8a523ef25f25ececb73a2334e8309b25bf37c 100644 (file)
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -180,7 +180,7 @@
                                 acquired. Service units with this
                                 option configured implicitly gain
                                 dependencies on the
                                 acquired. Service units with this
                                 option configured implicitly gain
                                 dependencies on the

-                                <filename>dbus.target</filename>
+                                <filename>dbus.socket</filename>

                                 unit.</para>
 
                                 <para>Behaviour of
                                 unit.</para>
 
                                 <para>Behaviour of


@@ -311,20 +311,28 @@
                                 main process of the daemon. The
                                 command line accepts % specifiers as
                                 described in
                                 main process of the daemon. The
                                 command line accepts % specifiers as
                                 described in

-                                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. On
-                                top of that basic environment variable
-                                substitution is supported, where
-                                <literal>${FOO}</literal> is replaced
-                                by the string value of the environment
-                                variable of the same name. Also
-                                <literal>$FOO</literal> may appear as
-                                separate word on the command line in
-                                which case the variable is replaced by
-                                its value split at whitespaces. Note
-                                that the first argument (i.e. the
-                                binary to execute) may not be a
-                                variable, and must be a literal and
-                                absolute path name.</para></listitem>
+                                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+
+                                <para>On top of that basic environment
+                                variable substitution is
+                                supported. Use
+                                <literal>${FOO}</literal> as part of a
+                                word, or as word of its own on the
+                                command line, in which case it will be
+                                replaced by the value of the
+                                environment variable including all
+                                whitespace it contains, resulting in a
+                                single argument.  Use
+                                <literal>$FOO</literal> as a separate
+                                word on the command line, in which
+                                case it will be replaced by the value
+                                of the environment variable split up
+                                at whitespace, resulting in no or more
+                                arguments. Note that the first
+                                argument (i.e. the program to execute)
+                                may not be a variable, and must be a
+                                literal and absolute path
+                                name.</para></listitem>

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


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

-                                60s.</para></listitem>
+                                90s.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>WatchdogSec=</varname></term>
+                                <listitem><para>Configures the
+                                watchdog timeout for a service. This
+                                is activated when the start-up is
+                                completed. The service must call
+                                <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                                regularly with "WATCHDOG=1". If the
+                                time between two such calls is larger
+                                than the configured time then the
+                                service is placed in a failure
+                                state. By setting
+                                <term><varname>Restart=</varname></term>
+                                to <option>on-failure</option> or
+                                <option>always</option> the service
+                                will be automatically restarted. The
+                                time configured here will be passed to
+                                the executed service process in the
+                                <varname>WATCHDOG_USEC=</varname>
+                                environment variable. Defaults to 0s,
+                                which disables this
+                                feature.</para></listitem>

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


@@ -558,7 +590,6 @@
                                 processes of this service shall be
                                 killed. One of
                                 <option>control-group</option>,
                                 processes of this service 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>
 


@@ -570,10 +601,6 @@
                                 stop command (as configured with
                                 <varname>ExecStop=</varname>) is
                                 executed. If set to
                                 stop command (as configured with
                                 <varname>ExecStop=</varname>) is
                                 executed. If set to

-                                <option>process-group</option> only
-                                the members of the process group of
-                                the main service process are
-                                killed. If set to

                                 <option>process</option> only the main
                                 process itself is killed. If set to
                                 <option>none</option> no process is
                                 <option>process</option> only the main
                                 process itself is killed. If set to
                                 <option>none</option> no process is


@@ -668,11 +695,11 @@
                                 <listitem><para>Specifies the name of
                                 the socket units this service shall
                                 inherit the sockets from when the
                                 <listitem><para>Specifies the name of
                                 the socket units this service shall
                                 inherit the sockets from when the

-                                service (ignoring the different suffix
-                                of course) is started. Normally it
+                                service is started. Normally it

                                 should not be necessary to use this
                                 setting as all sockets whose unit
                                 shares the same name as the service
                                 should not be necessary to use this
                                 setting as all sockets whose unit
                                 shares the same name as the service

+                                (ignoring the different suffix of course)

                                 are passed to the spawned
                                 process.</para>
 
                                 are passed to the spawned
                                 process.</para>