diff --git a/man/sd_notify.xml b/man/sd_notify.xml index a6a9a9bed8..0f2f931477 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -258,7 +258,8 @@ BUSERROR=… If a service fails, the D-Bus error-style error code. Example: - BUSERROR=org.freedesktop.DBus.Error.TimedOut + BUSERROR=org.freedesktop.DBus.Error.TimedOut. Note that this assignment is + currently not used by systemd. @@ -266,8 +267,15 @@ EXIT_STATUS=… - If a service exits, the return value of its main() function. - + The exit status of a service or the manager itself. Note that + systemd currently does not consume this value when sent by services, so this + assignment is only informational. The manager will send this notification to its + notification socket, which may be used to to collect an exit status from the system (a container or + VM) as it shuts down. For example, + mkosi1 + makes use of this. The value to return may be set via the + systemctl1 + exit verb. @@ -434,8 +442,10 @@ - It is recommended to prefix variable names that are not listed above with X_ to - avoid namespace clashes. + The notification messages sent by services are interpreted by the service manager. Unknown + assignments may be logged, but are otherwise ignored. Thus, it is not useful to send assignments which + are not in this list. The service manager also sends some messages to its + notification socket, which are then consumed by the machine or container manager.