From: Lennart Poettering <lennart@poettering.net>
Date: Thu, 24 Jun 2010 14:13:56 +0000 (+0200)
Subject: man: extend systemd-notify man page a bit
X-Git-Tag: v1~102
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=c61fbdfcb9bcd405c5a0a9b5f7050a58a871db6e

man: extend systemd-notify man page a bit
---

diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml
index 46f3f1afa..5286418cc 100644
--- a/man/systemd-notify.xml
+++ b/man/systemd-notify.xml
@@ -73,6 +73,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>
@@ -153,6 +158,34 @@
                 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>