X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_notify.xml;h=fc0f2f69273f0377cf56f2f8cf62f49857e692f5;hb=1e44448168ff26ff391af83bf67d5bcc3ca368bc;hp=9d9ea4132f9b787b5807c45ca6177f441afb5216;hpb=19c5f19d69bb5f520fa7213239490c55de06d99d;p=elogind.git
diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index 9d9ea4132..fc0f2f692 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -8,16 +8,16 @@
Copyright 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ Lesser General Public License for more details.
- You should have received a copy of the GNU General Public License
+ You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see .
-->
@@ -45,7 +45,7 @@
sd_notify
sd_notifyf
- Notify init system about start-up completion and other daemon status changes
+ Notify service manager about start-up completion and other daemon status changes
@@ -87,7 +87,7 @@
processes.
The state parameter
- should contain an newline-separated list of variable
+ should contain a newline-separated list of variable
assignments, similar in style to an environment
block. A trailing newline is implied if none is
specified. The string may contain any kind of variable
@@ -104,7 +104,7 @@
definition file has Type=notify
set. The passed argument is a boolean
"1" or "0". Since there is little
- value in signalling non-readiness, the
+ value in signaling non-readiness, the
only value daemons should send is
"READY=1".
@@ -156,12 +156,19 @@
WATCHDOG=1
Tells systemd to
- update the watchdog timestamp.
- Services using this feature should do
- this in regular intervals. A watchdog
- framework can use the timestamps to
- detect failed
- services.
+ update the watchdog timestamp. This is
+ the keep-alive ping that services need
+ to issue in regular intervals if
+ WatchdogSec= is
+ enabled for it. See
+ systemd.service5
+ for details. It is recommended to send
+ this message if the
+ WATCHDOG_USEC=
+ environment variable has been set for
+ the service process, in every half the
+ time interval that is specified in the
+ variable.
@@ -193,7 +200,7 @@
the status was sent these functions return with a
positive return value. In order to support both, init
systems that implement this scheme and those which
- don't, it is generally recommended to ignore the return
+ do not, it is generally recommended to ignore the return
value of this call.
@@ -210,18 +217,18 @@
Internally, these functions send a single
datagram with the state string as payload to the
- AF_UNIX socket referenced in the
+ AF_UNIX socket referenced in the
$NOTIFY_SOCKET environment
variable. If the first character of
- $NOTIFY_SOCKET is @ the string is
+ $NOTIFY_SOCKET is @ the string is
understood as Linux abstract namespace socket. The
datagram is accompanied by the process credentials of
the sending daemon, using SCM_CREDENTIALS.
For details about the algorithms check the
liberally licensed reference implementation sources:
-
- resp.
+ and
sd_notify() and
@@ -231,12 +238,11 @@
sd-daemon.h files. These
interfaces are available as shared library, which can
be compiled and linked to with the
- libsystemd-daemon
- pkg-config1
+ libsystemd-daemon pkg-config1
file. Alternatively, applications consuming these APIs
may copy the implementation into their source tree. For
more details about the reference implementation see
- sd_daemon7.
+ sd-daemon3.
If the reference implementation is used as
drop-in files and -DDISABLE_SYSTEMD is set during
@@ -247,7 +253,7 @@
Environment
-
+
$NOTIFY_SOCKET
@@ -303,7 +309,7 @@
See Also
systemd1,
- sd_daemon7,
+ sd-daemon3,
daemon7,
systemd.service5