X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_notify.xml;h=dd0ba935d6c24f16fc110fc67a472ebd17d3f368;hb=e99fa3cba5c0a07bdcea22a308bf9b973e88b624;hp=140e795979083150192cc88a5b9b9b71826270e0;hpb=f9378423b9758861850748aeb49ae0d3300e56e6;p=elogind.git
diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index 140e79597..dd0ba935d 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -87,7 +87,7 @@
processes.
The state parameter
- should contain an newline-seperated list of variable
+ should contain an 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 signalling non-readiness, the
only value daemons should send is
"READY=1".
@@ -115,7 +115,7 @@
Passes a single-line
status string back to the init system
that describes the daemon state. This
- is free-from and can be used for
+ is free-form and can be used for
various purposes: general state
feedback, fsck-like programs could
pass completion percentages and
@@ -153,7 +153,7 @@
- It is recommened to prefix variable names that
+ It is recommended to prefix variable names that
are not shown in the list above with
X_ to avoid namespace
clashes.
@@ -177,11 +177,11 @@
On failure, these calls return a negative
errno-style error code. If
$NOTIFY_SOCKET was not set and
- hence no status data could be sent 0 is returned. If
+ hence no status data could be sent, 0 is returned. If
the status was sent these functions return with a
- positive return value. In order to support both init
+ 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
+ don't, it is generally recommended to ignore the return
value of this call.
@@ -206,7 +206,7 @@
datagram is accompanied by the process credentials of
the sending daemon, using SCM_CREDENTIALS.
- For details about the algorithm check the
+ For details about the algorithms check the
liberally licensed reference implementation sources:
resp. sd_notify() and
sd_notifyf() are implemented in
- the reference implementation's drop-in
+ the reference implementation's
sd-daemon.c and
- sd-daemon.h files. It is
- recommended that applications consuming these APIs
- copy the implementation into their source tree. For
+ sd-daemon.h files. These
+ interfaces are available as shared library, which can
+ be compiled and linked to with the
+ 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_daemon7.
- If -DDISABLE_SYSTEMD is set during compilation
- this function will always return 0 and otherwise
- become a NOP.
+ If the reference implementation is used as
+ drop-in files and -DDISABLE_SYSTEMD is set during
+ compilation these functions will always return 0 and
+ otherwise become a NOP.
+
+
+
+ Environment
+
+
+
+ $NOTIFY_SOCKET
+
+ Set by the init system
+ for supervised processes for status
+ and start-up completion
+ notification. This environment variable
+ specifies the socket
+ sd_notify() talks
+ to. See above for details.
+
+
@@ -234,7 +257,7 @@
Start-up Notification
When a daemon finished starting up, it
- might issue the following call call to notify
+ might issue the following call to notify
the init system:
sd_notify(0, "READY=1");
@@ -267,9 +290,9 @@
See Also
+ systemd1,
sd_daemon7,
daemon7,
- systemd8,
systemd.service5