X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd-notify.xml;h=684f490099c831459f6aa380eeb0b884e17ee40d;hp=46f3f1afaf6a82f741cb3007cb2a483e806276d2;hb=baade8cc237c37bd8905d86ec6e9c7872d4abe03;hpb=c5abba08873903d80a2dcdd46aace959fcae1b0f

diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml
index 46f3f1afa..684f49009 100644
--- a/man/systemd-notify.xml
+++ b/man/systemd-notify.xml
@@ -8,20 +8,21 @@
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
   (at your option) any later version.
 
   systemd is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-  General Public License for more details.
+  Lesser General Public License for more details.
 
-  You should have received a copy of the GNU General Public License
+  You should have received a copy of the GNU Lesser General Public License
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="systemd-notify">
+<refentry id="systemd-notify"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>systemd-notify</title>
@@ -44,7 +45,7 @@
 
         <refnamediv>
                 <refname>systemd-notify</refname>
-                <refpurpose>Notify init system about start-up completion and other daemon status changes</refpurpose>
+                <refpurpose>Notify service manager about start-up completion and other daemon status changes</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -73,6 +74,11 @@
                 environment variables to send as part of the status
                 update.</para>
 
+                <para>Note that systemd will refuse reception of
+                status updates from this command unless
+                <varname>NotifyAccess=all</varname> is set for the
+                service unit this command is called from.</para>
+
         </refsect1>
 
         <refsect1>
@@ -81,14 +87,6 @@
                 <para>The following options are understood:</para>
 
                 <variablelist>
-                        <varlistentry>
-                                <term><option>--h</option></term>
-                                <term><option>--help</option></term>
-
-                                <listitem><para>Prints a short help
-                                text and exits.</para></listitem>
-                        </varlistentry>
-
                         <varlistentry>
                                 <term><option>--ready</option></term>
 
@@ -107,7 +105,7 @@
                                 <listitem><para>Inform the init system
                                 about the main PID of the
                                 daemon. Takes a PID as argument. If
-                                the argument is omitted the PID of the
+                                the argument is omitted, the PID of the
                                 process that invoked
                                 <command>systemd-notify</command> is
                                 used. This is equivalent to
@@ -136,12 +134,15 @@
                                 <listitem><para>Returns 0 if the
                                 system was booted up with systemd,
                                 non-zero otherwise. If this option is
-                                passed no message is sent. This option
+                                passed, no message is sent. This option
                                 is hence unrelated to the other
                                 options. For details about the
-                                semantics of this option see
+                                semantics of this option, see
                                 <citerefentry><refentrytitle>sd_booted</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
                         </varlistentry>
+
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
                 </variablelist>
 
         </refsect1>
@@ -149,10 +150,38 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
+        <refsect1>
+                <title>Example</title>
+
+                <example>
+                        <title>Start-up Notification and Status Updates</title>
+
+                        <para>A simple shell daemon that sends
+                        start-up notifications after having set up its
+                        communication channel. During runtime it sends
+                        further status updates to the init
+                        system:</para>
+
+                        <programlisting>#!/bin/bash
+
+mkfifo /tmp/waldo
+systemd-notify --ready --status="Waiting for data..."
+
+while : ; do
+        read a &lt; /tmp/waldo
+        systemd-notify --status="Processing $a"
+
+        # Do something with $a ...
+
+        systemd-notify --status="Waiting for data..."
+done</programlisting>
+                </example>
+        </refsect1>
+
         <refsect1>
                 <title>See Also</title>
                 <para>