update fixme

[elogind.git] / man / sd_notify.xml

diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index 140e795979083150192cc88a5b9b9b71826270e0..7c1d982d855e4f37654ce653f9fd600bac7cdcfe 100644 (file)
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -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>
@@ -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>
 
@@ -227,6 +227,24 @@
                 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>
                 <title>Examples</title>
 
@@ -234,7 +252,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 +285,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>