X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_notify.xml;h=55965ffce4e999d9f0a1b34e1b674683976cf497;hp=1cd5b0aa7ecbdca538475ea4289a2bcbfc069abb;hb=23a7f0f721ff4e3b3fd4ed87f7d8e01ebad20093;hpb=cb07866b1b7c11e687a322d70dd9f9d73bbbe488 diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 1cd5b0aa7..55965ffce 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -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 @@ -77,7 +77,7 @@ 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 whether the function call itself succeeded or @@ -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". @@ -197,10 +197,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 +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 @@ -238,8 +238,7 @@ 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 @@ -247,14 +246,14 @@ 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