summaryrefslogtreecommitdiffstats
path: root/man/sd_notify.xml
diff options
context:
space:
mode:
authorAbderrahim Kitouni <abderrahim.kitouni@codethink.co.uk>2023-08-22 18:52:36 +0200
committerAbderrahim Kitouni <abderrahim.kitouni@codethink.co.uk>2023-08-29 15:07:24 +0200
commitec07c3c80b2b1bfa6788500202006ff85f5ae4f4 (patch)
treeab6fb6ca9620a58fc32cdf3dba9b8a0f77d48d18 /man/sd_notify.xml
parentman: Add xinclude namespace (diff)
downloadsystemd-ec07c3c80b2b1bfa6788500202006ff85f5ae4f4.tar.xz
systemd-ec07c3c80b2b1bfa6788500202006ff85f5ae4f4.zip
man: add version info
This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
Diffstat (limited to 'man/sd_notify.xml')
-rw-r--r--man/sd_notify.xml68
1 files changed, 51 insertions, 17 deletions
diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index a286beaf45..af6863ec6b 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -133,7 +133,9 @@
service manager is notified about with this mechanisms are propagated in the same way as they are
when originally initiated through the service manager. This message is particularly relevant for
<varname>Type=notify-reload</varname> services, to inform the service manager that the request to
- reload the service has been received and is now being processed.</para></listitem>
+ reload the service has been received and is now being processed.</para>
+
+ <xi:include href="version-info.xml" xpointer="v217"/></listitem>
</varlistentry>
<varlistentry>
@@ -144,7 +146,9 @@
generated by the client. This is typically used in combination with <literal>RELOADING=1</literal>,
to allow the service manager to properly synchronize reload cycles. See
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- for details, specifically <literal>Type=notify-reload</literal>.</para></listitem>
+ for details, specifically <literal>Type=notify-reload</literal>.</para>
+
+ <xi:include href="version-info.xml" xpointer="v253"/></listitem>
</varlistentry>
<varlistentry>
@@ -152,7 +156,9 @@
<listitem><para>Tells the service manager that the service is beginning its shutdown. This is useful
to allow the service manager to track the service's internal state, and present it to the
- user.</para></listitem>
+ user.</para>
+
+ <xi:include href="version-info.xml" xpointer="v217"/></listitem>
</varlistentry>
<varlistentry>
@@ -162,7 +168,9 @@
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
error message. Example: <literal>STATUS=Completed 66% of file system
- check…</literal></para></listitem>
+ check…</literal></para>
+
+ <xi:include href="version-info.xml" xpointer="v233"/></listitem>
</varlistentry>
<varlistentry>
@@ -172,35 +180,45 @@
<varname>NotifyAccess=</varname> setting in the service unit file. See
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details, specifically <literal>NotifyAccess=</literal> for a list of accepted
- values.</para></listitem>
+ values.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
<term>ERRNO=…</term>
<listitem><para>If a service fails, the errno-style error code, formatted as string. Example:
- <literal>ERRNO=2</literal> for ENOENT.</para></listitem>
+ <literal>ERRNO=2</literal> for ENOENT.</para>
+
+ <xi:include href="version-info.xml" xpointer="v233"/></listitem>
</varlistentry>
<varlistentry>
<term>BUSERROR=…</term>
<listitem><para>If a service fails, the D-Bus error-style error code. Example:
- <literal>BUSERROR=org.freedesktop.DBus.Error.TimedOut</literal></para></listitem>
+ <literal>BUSERROR=org.freedesktop.DBus.Error.TimedOut</literal></para>
+
+ <xi:include href="version-info.xml" xpointer="v233"/></listitem>
</varlistentry>
<varlistentry>
<term>EXIT_STATUS=…</term>
<listitem><para>If a service exits, the return value of its <function>main()</function> function.
- </para></listitem>
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
<term>MAINPID=…</term>
<listitem><para>The main process ID (PID) of the service, in case the service manager did not fork
- off the process itself. Example: <literal>MAINPID=4711</literal></para></listitem>
+ off the process itself. Example: <literal>MAINPID=4711</literal></para>
+
+ <xi:include href="version-info.xml" xpointer="v233"/></listitem>
</varlistentry>
<varlistentry>
@@ -224,7 +242,9 @@
in time. Note that <varname>WatchdogSec=</varname> does not need to be enabled for
<literal>WATCHDOG=trigger</literal> to trigger the watchdog action. See
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- for information about the watchdog behavior. </para></listitem>
+ for information about the watchdog behavior. </para>
+
+ <xi:include href="version-info.xml" xpointer="v243"/></listitem>
</varlistentry>
<varlistentry>
@@ -233,7 +253,9 @@
<listitem><para>Reset <varname>watchdog_usec</varname> value during runtime. Notice that this is not
available when using <function>sd_event_set_watchdog()</function> or
<function>sd_watchdog_enabled()</function>. Example :
- <literal>WATCHDOG_USEC=20000000</literal></para></listitem>
+ <literal>WATCHDOG_USEC=20000000</literal></para>
+
+ <xi:include href="version-info.xml" xpointer="v233"/></listitem>
</varlistentry>
<varlistentry>
@@ -246,7 +268,9 @@
<varname>TimeoutStartSec=</varname>, <varname>RuntimeMaxSec=</varname>, and
<varname>TimeoutStopSec=</varname>. See
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- for effects on the service timeouts.</para></listitem>
+ for effects on the service timeouts.</para>
+
+ <xi:include href="version-info.xml" xpointer="v236"/></listitem>
</varlistentry>
<varlistentry>
@@ -274,7 +298,9 @@
stopped, its file descriptor store is discarded and all file descriptors in it are closed. Use
<function>sd_pid_notify_with_fds()</function> to send messages with <literal>FDSTORE=1</literal>, see
below. The service manager will set the <varname>$FDSTORE</varname> environment variable for services
- that have the file descriptor store enabled.</para></listitem>
+ that have the file descriptor store enabled.</para>
+
+ <xi:include href="version-info.xml" xpointer="v219"/></listitem>
</varlistentry>
<varlistentry>
@@ -282,7 +308,9 @@
<listitem><para>Removes file descriptors from the file descriptor store. This field needs to be
combined with <varname>FDNAME=</varname> to specify the name of the file descriptors to
- remove.</para></listitem>
+ remove.</para>
+
+ <xi:include href="version-info.xml" xpointer="v236"/></listitem>
</varlistentry>
<varlistentry>
@@ -299,7 +327,9 @@
them in separate invocations of <function>sd_pid_notify_with_fds()</function>. The name may consist
of arbitrary ASCII characters except control characters or <literal>:</literal>. It may not be longer
than 255 characters. If a submitted name does not follow these restrictions, it is
- ignored.</para></listitem>
+ ignored.</para>
+
+ <xi:include href="version-info.xml" xpointer="v233"/></listitem>
</varlistentry>
<varlistentry>
@@ -310,7 +340,9 @@
automatic cleanup of the stored file descriptors on EPOLLERR and EPOLLHUP, care must be taken to
ensure proper manual cleanup. Use of this option is not generally recommended except for when
automatic cleanup has unwanted behavior such as prematurely discarding file descriptors from the
- store.</para></listitem>
+ store.</para>
+
+ <xi:include href="version-info.xml" xpointer="v246"/></listitem>
</varlistentry>
<varlistentry>
@@ -323,7 +355,9 @@
file descriptor can be used to synchronize against reception of all previous status messages. Note
that this command cannot be mixed with other notifications, and has to be sent in a separate message
to the service manager, otherwise all assignments will be ignored. Note that sending 0 or more than 1
- file descriptor with this command is a violation of the protocol.</para></listitem>
+ file descriptor with this command is a violation of the protocol.</para>
+
+ <xi:include href="version-info.xml" xpointer="v246"/></listitem>
</varlistentry>
</variablelist>