X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_notify.xml;h=d21820f67b815d17f11009a744a1294a88d0cdb0;hp=75edeeadf39f2c98f65d1f6779e73be1c7b3487d;hb=17d47d8d2dee22ee4f0a7319b9603d3e33a0b28a;hpb=bb31a4ac1997c189a344caf554f34c6aabc71aa7 diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 75edeeadf..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 @@ -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,10 +221,10 @@ 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. @@ -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