diff options
Diffstat (limited to 'man/sd_notify.xml')
| -rw-r--r-- | man/sd_notify.xml | 68 |
1 files changed, 40 insertions, 28 deletions
diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 7d7b0077be..c28f303c7e 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -3,6 +3,8 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> <!-- + SPDX-License-Identifier: LGPL-2.1+ + This file is part of systemd. Copyright 2010 Lennart Poettering @@ -122,12 +124,10 @@ <varlistentry> <term>READY=1</term> - <listitem><para>Tells the service manager that service startup - is finished. This is only used by systemd if the service - definition file has Type=notify set. Since there is little - value in signaling non-readiness, the only value services - should send is <literal>READY=1</literal> (i.e. - <literal>READY=0</literal> is not defined).</para></listitem> + <listitem><para>Tells the service manager that service startup is finished, or the service finished loading its + configuration. This is only used by systemd if the service definition file has <varname>Type=notify</varname> + set. Since there is little value in signaling non-readiness, the only value services should send is + <literal>READY=1</literal> (i.e. <literal>READY=0</literal> is not defined).</para></listitem> </varlistentry> <varlistentry> @@ -202,6 +202,26 @@ watchdog is enabled. </para></listitem> </varlistentry> + <varlistentry> + <term>WATCHDOG_USEC=…</term> + + <listitem><para>Reset <varname>watchdog_usec</varname> value during runtime. + Notice that this is not available when using <function>sd_event_set_watchdog()</function> + or <function>sd_watchdog_enabled()</function>. + Example : <literal>WATCHDOG_USEC=20000000</literal></para></listitem> + </varlistentry> + + <varlistentry> + <term>EXTEND_TIMEOUT_USEC=…</term> + + <listitem><para>Tells the service manager to extend the startup, runtime or shutdown service timeout + corresponding the current state. The value specified is a time in microseconds during which the service must + send a new message. A service timeout will occur if the message isn't received, but only if the runtime of the + current state is beyond the original maximium times of <varname>TimeoutStartSec=</varname>, <varname>RuntimeMaxSec=</varname>, + and <varname>TimeoutStopSec=</varname>. + See <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for effects on the service timeouts.</para></listitem> + </varlistentry> <varlistentry> <term>FDSTORE=1</term> @@ -227,33 +247,25 @@ </varlistentry> <varlistentry> - <term>FDNAME=…</term> + <term>FDSTOREREMOVE=1</term> - <listitem><para>When used in combination with - <varname>FDSTORE=1</varname>, specifies a name for the - submitted file descriptors. This name is passed to the service - during activation, and may be queried using - <citerefentry><refentrytitle>sd_listen_fds_with_names</refentrytitle><manvolnum>3</manvolnum></citerefentry>. File - descriptors submitted without this field set, will implicitly - get the name <literal>stored</literal> assigned. Note that, if - multiple file descriptors are submitted at once, the specified - name will be assigned to all of them. In order to assign - different names to submitted file descriptors, submit them in - separate invocations of - <function>sd_pid_notify_with_fds()</function>. The name may - consist of any ASCII character, but must not contain control - characters or <literal>:</literal>. It may not be longer than - 255 characters. If a submitted name does not follow these - restrictions, it is ignored.</para></listitem> + <listitem><para>Removes file descriptors from the file descriptor store. This field needs to be combined with + <varname>FDNAME=</varname> to specify the name of the file descriptors to remove.</para></listitem> </varlistentry> <varlistentry> - <term>WATCHDOG_USEC=…</term> + <term>FDNAME=…</term> - <listitem><para>Reset <varname>watchdog_usec</varname> value during runtime. - Notice that this is not available when using <function>sd_event_set_watchdog()</function> - or <function>sd_watchdog_enabled()</function>. - Example : <literal>WATCHDOG_USEC=20000000</literal></para></listitem> + <listitem><para>When used in combination with <varname>FDSTORE=1</varname>, specifies a name for the submitted + file descriptors. When used with <varname>FDSTOREREMOVE=1</varname>, specifies the name for the file + descriptors to remove. This name is passed to the service during activation, and may be queried using + <citerefentry><refentrytitle>sd_listen_fds_with_names</refentrytitle><manvolnum>3</manvolnum></citerefentry>. File + descriptors submitted without this field set, will implicitly get the name <literal>stored</literal> + assigned. Note that, if multiple file descriptors are submitted at once, the specified name will be assigned to + all of them. In order to assign different names to submitted file descriptors, submit them in separate + invocations of <function>sd_pid_notify_with_fds()</function>. The name may consist of arbitrary ASCII + characters except control characters or <literal>:</literal>. It may not be longer than 255 characters. If a + submitted name does not follow these restrictions, it is ignored.</para></listitem> </varlistentry> </variablelist> |