<refsynopsisdiv>
<funcsynopsis>
- <funcsynopsisinfo>#include "sd-daemon.h"</funcsynopsisinfo>
+ <funcsynopsisinfo>#include <systemd/sd-daemon.h></funcsynopsisinfo>
<funcprototype>
<funcdef>int <function>sd_notify</function></funcdef>
processes.</para>
<para>The <parameter>state</parameter> parameter
- should contain an newline-seperated list of variable
+ should contain an 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
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 signalling non-readiness, the
only value daemons should send is
"READY=1".</para></listitem>
</varlistentry>
<listitem><para>Passes a single-line
status string back to the init system
that describes the daemon state. This
- is free-from and can be used for
+ is free-form and can be used for
various purposes: general state
feedback, fsck-like programs could
pass completion percentages and
for details.</para>
<para><function>sd_notifyf()</function> is similar to
- <function>sd_notifyf()</function> but takes a
+ <function>sd_notify()</function> but takes a
<function>printf()</function>-like format string plus
arguments.</para>
</refsect1>
<para>On failure, these calls return a negative
errno-style error code. If
<varname>$NOTIFY_SOCKET</varname> was not set and
- hence no status data could be sent 0 is returned. If
+ hence no status data could be sent, 0 is returned. If
the status was sent these functions return with a
- positive return value. In order to support both init
+ 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
+ don't, it is generally recommended to ignore the return
value of this call.</para>
</refsect1>
datagram is accompanied by the process credentials of
the sending daemon, using SCM_CREDENTIALS.</para>
- <para>For details about the algorithm check the
+ <para>For details about the algorithms check the
liberally licensed reference implementation sources:
- <ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.c"/>
+ <ulink url="http://cgit.freedesktop.org/systemd/plain/src/sd-daemon.c"/>
resp. <ulink
- url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para>
+ url="http://cgit.freedesktop.org/systemd/plain/src/systemd/sd-daemon.h"/></para>
<para><function>sd_notify()</function> and
<function>sd_notifyf()</function> are implemented in
- the reference implementation's drop-in
+ the reference implementation's
<filename>sd-daemon.c</filename> and
- <filename>sd-daemon.h</filename> files. It is
- recommended that applications consuming these APIs
- copy the implementation into their source tree. For
+ <filename>sd-daemon.h</filename> files. These
+ interfaces are available as shared library, which can
+ be compiled and linked to with the
+ <literal>libsystemd-daemon</literal>
+ <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ file. Alternatively, applications consuming these APIs
+ may copy the implementation into their source tree. For
more details about the reference implementation see
- <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para>
+ <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
- <para>If -DDISABLE_SYSTEMD is set during compilation
- this function will always return 0 and otherwise
- become a NOP.</para>
+ <para>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.</para>
</refsect1>
<refsect1>
<title>Start-up Notification</title>
<para>When a daemon finished starting up, it
- might issue the following call call to notify
+ might issue the following call to notify
the init system:</para>
<programlisting>sd_notify(0, "READY=1");</programlisting>