X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_notify.xml;h=62347f8ab067692b5257d5583699ffd97dfb92d3;hp=140e795979083150192cc88a5b9b9b71826270e0;hb=9ba353983adc026b75a503c1381f6e5c8062f3e0;hpb=f9378423b9758861850748aeb49ae0d3300e56e6

diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index 140e79597..62347f8ab 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -87,7 +87,7 @@
                 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
@@ -104,7 +104,7 @@
                                 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>
@@ -115,7 +115,7 @@
                                 <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
@@ -153,7 +153,7 @@
                         </varlistentry>
                 </variablelist>
 
-                <para>It is recommened to prefix variable names that
+                <para>It is recommended to prefix variable names that
                 are not shown in the list above with
                 <varname>X_</varname> to avoid namespace
                 clashes.</para>
@@ -166,7 +166,7 @@
                 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>
@@ -177,11 +177,11 @@
                 <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>
 
@@ -206,7 +206,7 @@
                 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"/>
                 resp. <ulink
@@ -214,17 +214,40 @@
 
                 <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>Environment</title>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><varname>$NOTIFY_SOCKET</varname></term>
+
+                                <listitem><para>Set by the init system
+                                for supervised processes for status
+                                and start-up completion
+                                notification. This environment variable
+                                specifies the socket
+                                <function>sd_notify()</function> talks
+                                to. See above for details.</para></listitem>
+                        </varlistentry>
+                </variablelist>
         </refsect1>
 
         <refsect1>
@@ -234,7 +257,7 @@
                         <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>
@@ -267,9 +290,9 @@
         <refsect1>
                 <title>See Also</title>
                 <para>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 </para>
         </refsect1>