man: extend watchdog docs a bit

[elogind.git] / man / sd_notify.xml

diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index dd0ba935d6c24f16fc110fc67a472ebd17d3f368..a91c1bb4bf4c6893afaa7c85c6a34a0bbec3c7cf 100644 (file)
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -8,16 +8,16 @@
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
   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
   (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/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 


@@ -50,7 +50,7 @@
 
         <refsynopsisdiv>
                 <funcsynopsis>
 
         <refsynopsisdiv>
                 <funcsynopsis>

-                        <funcsynopsisinfo>#include "sd-daemon.h"</funcsynopsisinfo>
+                        <funcsynopsisinfo>#include &lt;systemd/sd-daemon.h&gt;</funcsynopsisinfo>

 
                         <funcprototype>
                                 <funcdef>int <function>sd_notify</function></funcdef>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_notify</function></funcdef>


@@ -151,6 +151,25 @@
                                 itself. Example:
                                 "MAINPID=4711"</para></listitem>
                         </varlistentry>
                                 itself. Example:
                                 "MAINPID=4711"</para></listitem>
                         </varlistentry>

+
+                        <varlistentry>
+                                <term>WATCHDOG=1</term>
+
+                                <listitem><para>Tells systemd to
+                                update the watchdog timestamp. This is
+                                the keep-alive ping that services need
+                                to issue in regular intervals if
+                                <varname>WatchdogSec=</varname> is
+                                enabled for it. See
+                                <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                                for details. It is recommended to send
+                                this message if the
+                                <varname>WATCHDOG_USEC=</varname>
+                                environment variable has been set for
+                                the service process, in every half the
+                                time interval that is specified in the
+                                variable.</para></listitem>
+                        </varlistentry>

                 </variablelist>
 
                 <para>It is recommended to prefix variable names that
                 </variablelist>
 
                 <para>It is recommended to prefix variable names that


@@ -166,7 +185,7 @@
                 for details.</para>
 
                 <para><function>sd_notifyf()</function> is similar to
                 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>
                 <function>printf()</function>-like format string plus
                 arguments.</para>
         </refsect1>


@@ -208,9 +227,9 @@
 
                 <para>For details about the algorithms check the
                 liberally licensed reference implementation sources:
 
                 <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/systemd/plain/src/sd-daemon.c"/>

                 resp. <ulink
                 resp. <ulink

-                url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para>
+                url="http://cgit.freedesktop.org/systemd/systemd/plain/src/systemd/sd-daemon.h"/></para>

 
                 <para><function>sd_notify()</function> and
                 <function>sd_notifyf()</function> are implemented in
 
                 <para><function>sd_notify()</function> and
                 <function>sd_notifyf()</function> are implemented in