X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_notify.xml;h=d21820f67b815d17f11009a744a1294a88d0cdb0;hb=336c6e4690ea017a11799aa331ffedd4c59a31ad;hp=606ee1e57fd714a430dd80294097673ad731bb96;hpb=34511ca7b166b0e89d08ff9870b0cf2624a7815f;p=elogind.git
diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index 606ee1e57..d21820f67 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -77,9 +77,9 @@
notification.
If the unset_environment
- parameter is non-zero sd_notify()
+ parameter is non-zero, sd_notify()
will unset the $NOTIFY_SOCKET
- environment variable before returning (regardless
+ environment variable before returning (regardless of
whether the function call itself succeeded or
not). Further calls to
sd_notify() will then fail, but
@@ -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".
@@ -164,11 +164,15 @@
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.
+ $WATCHDOG_PID
+ environment variable has been set to
+ the PID of the service process, in
+ every half the time interval that is
+ specified in the
+ $WATCHDOG_USEC
+ environment variable. See
+ sd_watchdog_enabled3
+ for details.
@@ -197,10 +201,10 @@
errno-style error code. If
$NOTIFY_SOCKET was not set and
hence no status data could be sent, 0 is returned. If
- the status was sent these functions return with a
+ 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.
@@ -217,18 +221,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
@@ -236,25 +240,24 @@
the reference implementation's
sd-daemon.c and
sd-daemon.h files. These
- interfaces are available as shared library, which can
+ interfaces are available as a 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
+ more details about the reference implementation, see
sd-daemon3.
If the reference implementation is used as
drop-in files and -DDISABLE_SYSTEMD is set during
- compilation these functions will always return 0 and
+ compilation, these functions will always return 0 and
otherwise become a NOP.
Environment
-
+
$NOTIFY_SOCKET
@@ -312,7 +315,8 @@
systemd1,
sd-daemon3,
daemon7,
- systemd.service5
+ systemd.service5,
+ sd_watchdog_enabled3