X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_watchdog_enabled.xml;h=41640276405080abeb041d31cbb13ca536ee06c9;hb=708281b81177f3a32d11770126727737a6a69483;hp=e42ae430ece19f43cb403e8c7d9c2a8cd8a5baae;hpb=09812eb764b440651f3ff4cb5d37bd343f800560;p=elogind.git
diff --git a/man/sd_watchdog_enabled.xml b/man/sd_watchdog_enabled.xml
index e42ae430e..416402764 100644
--- a/man/sd_watchdog_enabled.xml
+++ b/man/sd_watchdog_enabled.xml
@@ -21,7 +21,8 @@
along with systemd; If not, see .
-->
-
+
sd_watchdog_enabled
@@ -54,7 +55,7 @@
int sd_watchdog_enabled
int unset_environment
- const uint64_t *usec
+ uint64_t *usec
@@ -73,14 +74,14 @@
sd_watchdog_enabled() will unset
the $WATCHDOG_USEC and
$WATCHDOG_PID environment variables
- before returning (regardless whether the function call
+ before returning (regardless of whether the function call
itself succeeded or not). Further calls to
sd_watchdog_enabled() will then
return with zero, but the variable is no longer
inherited by child processes.
If the usec parameter is
- non-NULL sd_watchdog_enabled()
+ non-NULL, sd_watchdog_enabled()
will return the timeout in µs for the watchdog
logic. The service manager will usually terminate a
service when it did not get a notification message
@@ -94,7 +95,7 @@
WATCHDOG=1.
To enable service supervision with the watchdog
- logic use WatchdogSec= in service
+ logic, use WatchdogSec= in service
files. See
systemd.service5
for details.
@@ -107,7 +108,7 @@
errno-style error code. If the service manager expects
watchdog keep-alive notification messages to be sent,
> 0 is returned, otherwise 0 is returned. Only if
- the return value is > 0 the
+ the return value is > 0, the
usec parameter is valid after
the call.
@@ -115,13 +116,7 @@
Notes
- This function is provided by the reference
- implementation of APIs for new-style daemons and
- distributed with the systemd package. The algorithm
- it implements is simple, and can easily be
- reimplemented in daemons if it is important to support
- this interface without using the reference
- implementation.
+
Internally, this functions parses the
$WATCHDOG_PID and
@@ -129,32 +124,9 @@
variable. The call will ignore these variables if
$WATCHDOG_PID does containe the PID
of the current process, under the assumption that in
- that case the variables were set for a different
+ that case, the variables were set for a different
process further up the process tree.
- For details about the algorithm check the
- liberally licensed reference implementation sources:
-
- and
-
- sd_watchdog_enabled() is
- implemented in the reference implementation's
- sd-daemon.c and
- 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-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
- otherwise become a NOP.