X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_notify.xml;h=f2710b6ab3d07caa015e0efd3701ef7a18c64069;hp=05aae604a8347fd0da40c9cc54191a97f210a9cb;hb=8036e4d0b9ef0990597196155fe6fc6329a6a881;hpb=da2587d5154e11d4e643e326793f3ce2cc48dee6
diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index 05aae604a..f2710b6ab 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -1,4 +1,4 @@
-
+
@@ -100,7 +100,7 @@
sd_notify() may be called by a service
to notify the service manager about state changes. It can be used
to send arbitrary information, encoded in an
- environment-block-like string. Most importantly it can be used for
+ environment-block-like string. Most importantly, it can be used for
start-up completion notification.
If the unset_environment parameter is
@@ -158,7 +158,7 @@
to the service manager that describes the service state. This
is free-form and can be used for various purposes: general
state feedback, fsck-like programs could pass completion
- percentages and failing programs could pass a human readable
+ percentages and failing programs could pass a human-readable
error message. Example: STATUS=Completed 66% of file
system check...
@@ -194,7 +194,7 @@
watchdog timestamp. This is the keep-alive ping that services
need to issue in regular intervals if
WatchdogSec= is enabled for it. See
- logind.service5
+ systemd.service5
for information how to enable this functionality and
sd_watchdog_enabled3
for the details of how the service can check whether the
@@ -205,28 +205,55 @@
FDSTORE=1
- Stores additional file descriptors in the
- service manager. File descriptors sent this way will be
- maintained per-service by the service manager and be passed
- again using the usual file descriptor passing logic on the
- next invocation of the service (see
- sd_listen_fds3).
- This is useful for implementing service restart schemes where
- services serialize their state to /run,
- push their file descriptors to the system manager, and are
- then restarted, retrieving their state again via socket
- passing and /run. Note that the service
- manager will accept messages for a service only if
- FileDescriptorStoreMax= is set to non-zero
- for it (defaults to zero). See
- logind.service5
- for details. Multiple arrays of file descriptors may be sent
- in separate messages, in which case the arrays are combined.
- Note that the service manager removes duplicate file
- descriptors before passing them to the service. Use
- sd_pid_notify_with_fds() to send messages
- with FDSTORE=1, see
- below.
+ Stores additional file descriptors in the service manager. File
+ descriptors sent this way will be maintained per-service by the service manager
+ and will be passed again using the usual file descriptor passing logic on the next
+ invocation of the service, see
+ sd_listen_fds3.
+ This is useful for implementing service restart schemes where services serialize
+ their state to /run, push their file descriptors to the
+ system manager, and are then restarted, retrieving their state again via socket
+ passing and /run. Note that the service manager will accept
+ messages for a service only if FileDescriptorStoreMax= is set
+ to non-zero for it (defaults to zero, see
+ systemd.service5).
+ File descriptors must be pollable, see
+ epoll_ctl2.
+ Multiple arrays of file descriptors may be sent in separate messages, in which
+ case the arrays are combined. Note that the service manager removes duplicate
+ file descriptors before passing them to the service. Use
+ sd_pid_notify_with_fds() to send messages with
+ FDSTORE=1, see below.
+
+
+
+ FDNAME=...
+
+ When used in combination with
+ FDSTORE=1, specifies a name for the
+ submitted file descriptors. This name is passed to the service
+ during activation, and may be queried using
+ sd_listen_fds_with_names3. File
+ descriptors submitted without this field set, will implicitly
+ get the name stored assigned. Note that, if
+ multiple file descriptors are submitted at once, the specified
+ name will be assigned to all of them. In order to assign
+ different names to submitted file descriptors, submit them in
+ separate invocations of
+ sd_pid_notify_with_fds(). The name may
+ consist of any ASCII character, but must not contain control
+ characters or :. It may not be longer than
+ 255 characters. If a submitted name does not follow these
+ restrictions, it is ignored.
+
+
+
+ WATCHDOG_USEC=...
+
+ Reset watchdog_usec value during runtime.
+ Notice that this is not available when using sd_event_set_watchdog()
+ or sd_watchdog_enabled().
+ Example : WATCHDOG_USEC=20000000
@@ -238,7 +265,7 @@
Note that elogind will accept status data sent from a
service only if the NotifyAccess= option is
correctly set in the service definition file. See
- logind.service5
+ systemd.service5
for details.
sd_notifyf() is similar to
@@ -253,7 +280,7 @@
use as originating PID for the message as first argument. This is
useful to send notification messages on behalf of other processes,
provided the appropriate privileges are available. If the PID
- argument is specified as 0 the process ID of the calling process
+ argument is specified as 0, the process ID of the calling process
is used, in which case the calls are fully equivalent to
sd_notify() and
sd_notifyf().
@@ -356,20 +383,22 @@
To store an open file descriptor in the service manager,
in order to continue operation after a service restart without
- losing state use FDSTORE=1:
+ losing state, use FDSTORE=1:
- sd_pid_notify_with_fds(0, 0, "FDSTORE=1", &fd, 1);
+ sd_pid_notify_with_fds(0, 0, "FDSTORE=1\nFDNAME=foobar", &fd, 1);
See Also
- elogind1,
+ systemd1,
sd-daemon3,
+ sd_listen_fds3,
+ sd_listen_fds_with_names3,
+ sd_watchdog_enabled3,
daemon7,
- logind.service5,
- sd_watchdog_enabled3
+ systemd.service5