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=c3791ce39ff43a3492ab3dcf9ca5a0f5297c4195;hb=06d9d3efa554ffc63b5977f1d86e393edeef8ad1;hpb=dc1ecd78e9f046880d10ddb45cf9b06df1084b10 diff --git a/man/sd_notify.xml b/man/sd_notify.xml index c3791ce39..55965ffce 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 @@ -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". @@ -151,6 +151,25 @@ itself. Example: "MAINPID=4711" + + + WATCHDOG=1 + + Tells systemd to + 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. + It is recommended to prefix variable names that @@ -178,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. @@ -198,19 +217,19 @@ 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 sd_notifyf() are implemented in @@ -219,23 +238,22 @@ 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 - compilation these functions will always return 0 and + compilation, these functions will always return 0 and otherwise become a NOP. Environment - + $NOTIFY_SOCKET @@ -291,7 +309,7 @@ See Also systemd1, - sd_daemon7, + sd-daemon3, daemon7, systemd.service5