Prep v231: Update man pages to include upstream changes

diff --git a/man/custom-html.xsl b/man/custom-html.xsl
index 545f4b306e3163ecbe4f1655d849bda8f2a28d4f..f1271dcb1fc46db807e163857d510af6f53f4923 100644 (file)
--- a/man/custom-html.xsl
+++ b/man/custom-html.xsl
@@ -126,7 +126,7 @@
 
 <!--
   - helper template to do conflict resolution between various headings with the same inferred ID attribute/tag from the headerlink template
 
 <!--
   - helper template to do conflict resolution between various headings with the same inferred ID attribute/tag from the headerlink template

-  - this conflict resolution is necessary to prevent malformed HTML output (multiple id attributes with the same value)
+  - this conflict resolution is necessary to prevent malformed HTML output (multiple ID attributes with the same value)

   - and it fixes xsltproc warnings during compilation of HTML man pages
   -
   - A simple top-to-bottom numbering scheme is implemented for nodes with the same ID value to derive unique ID values for HTML output.
   - and it fixes xsltproc warnings during compilation of HTML man pages
   -
   - A simple top-to-bottom numbering scheme is implemented for nodes with the same ID value to derive unique ID values for HTML output.


@@ -172,7 +172,7 @@
   <!--
     - If stable URLs with fragment markers (references to the ID) turn out not to be important:
     - generatedID could simply take the value of generate-id(), and various other helper templates may be dropped entirely.
   <!--
     - If stable URLs with fragment markers (references to the ID) turn out not to be important:
     - generatedID could simply take the value of generate-id(), and various other helper templates may be dropped entirely.

-    - Alternatively if xsltproc is patched to generate reproducible generate-id() output the same simplifications can be
+    - Alternatively, if xsltproc is patched to generate reproducible generate-id() output, the same simplifications can be

     - applied at the cost of breaking compatibility with URLs generated from output of previous versions of this stylesheet.
    -->
   <xsl:variable name="generatedID">
     - applied at the cost of breaking compatibility with URLs generated from output of previous versions of this stylesheet.
    -->
   <xsl:variable name="generatedID">

diff --git a/man/loginctl.xml b/man/loginctl.xml
index fd2f15c0ac61beb68320d969922d6c8a9e8a644a..46f1a990f8ffd2132f50bde6f00fa7407d9da9e8 100644 (file)
--- a/man/loginctl.xml
+++ b/man/loginctl.xml
@@ -196,9 +196,9 @@
         <term><command>activate</command> <optional><replaceable>ID</replaceable></optional></term>
 
         <listitem><para>Activate a session. This brings a session into
         <term><command>activate</command> <optional><replaceable>ID</replaceable></optional></term>
 
         <listitem><para>Activate a session. This brings a session into

-        the foreground, if another session is currently in the
+        the foreground if another session is currently in the

         foreground on the respective seat. Takes a session identifier
         foreground on the respective seat. Takes a session identifier

-        as argument. If no argument is specified the session of the
+        as argument. If no argument is specified, the session of the

         caller is put into foreground.</para></listitem>
       </varlistentry>
 
         caller is put into foreground.</para></listitem>
       </varlistentry>
 


@@ -209,7 +209,7 @@
         <listitem><para>Activates/deactivates the screen lock on one
         or more sessions, if the session supports it. Takes one or
         more session identifiers as arguments. If no argument is
         <listitem><para>Activates/deactivates the screen lock on one
         or more sessions, if the session supports it. Takes one or
         more session identifiers as arguments. If no argument is

-        specified the session of the caller is locked/unlocked.
+        specified, the session of the caller is locked/unlocked.

         </para></listitem>
       </varlistentry>
 
         </para></listitem>
       </varlistentry>
 


@@ -284,8 +284,11 @@
         spawned for the user at boot and kept around after logouts.
         This allows users who are not logged in to run long-running
         services. Takes one or more user names or numeric UIDs as
         spawned for the user at boot and kept around after logouts.
         This allows users who are not logged in to run long-running
         services. Takes one or more user names or numeric UIDs as

-        argument. If no argument is specified enables/disables
-        lingering for the user of the session of the caller.
+        argument. If no argument is specified, enables/disables
+        lingering for the user of the session of the caller.</para>
+
+        <para>See also <varname>KillUserProcesses=</varname> setting in
+        <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.

         </para></listitem>
       </varlistentry>
 
         </para></listitem>
       </varlistentry>
 


@@ -348,7 +351,7 @@
         seat. The devices should be specified via device paths in the
         <filename>/sys</filename> file system. To create a new seat,
         attach at least one graphics card to a previously unused seat
         seat. The devices should be specified via device paths in the
         <filename>/sys</filename> file system. To create a new seat,
         attach at least one graphics card to a previously unused seat

-        name. Seat names may consist only of a-z, A-Z, 0-9,
+        name. Seat names may consist only of a–z, A–Z, 0–9,

         <literal>-</literal> and <literal>_</literal> and must be
         prefixed with <literal>seat</literal>. To drop assignment of a
         device to a specific seat, just reassign it to a different
         <literal>-</literal> and <literal>_</literal> and must be
         prefixed with <literal>seat</literal>. To drop assignment of a
         device to a specific seat, just reassign it to a different


@@ -436,6 +439,37 @@
     otherwise.</para>
   </refsect1>
 
     otherwise.</para>
   </refsect1>
 

+  <refsect1>
+    <title>Examples</title>
+
+    <example>
+      <title>Querying user status</title>
+
+      <programlisting>$ loginctl user-status
+fatima (1005)
+           Since: Sat 2016-04-09 14:23:31 EDT; 54min ago
+           State: active
+        Sessions: 5 *3
+            Unit: user-1005.slice
+                  ├─user@1005.service
+                    ...
+                  ├─session-3.scope
+                    ...
+                  └─session-5.scope
+                    ├─3473 login -- fatima
+                    └─3515 -zsh
+
+Apr 09 14:40:30 laptop login[2325]: pam_unix(login:session):
+                       session opened for user fatima by LOGIN(uid=0)
+Apr 09 14:40:30 laptop login[2325]: LOGIN ON tty3 BY fatima
+</programlisting>
+
+      <para>There are two sessions, 3 and 5. Session 3 is a graphical session,
+      marked with a star. The tree of processing including the two corresponding
+      scope units and the user manager unit are shown.</para>
+    </example>
+  </refsect1>
+

   <xi:include href="less-variables.xml" />
 
   <refsect1>
   <xi:include href="less-variables.xml" />
 
   <refsect1>

diff --git a/man/sd_event_add_io.xml b/man/sd_event_add_io.xml
index 5c363f96b33d90276f9bc2e67d6aae574e5cb769..3ba7c3bd3e4eff6b3f990001fedfb740708909c5 100644 (file)
--- a/man/sd_event_add_io.xml
+++ b/man/sd_event_add_io.xml
@@ -120,36 +120,35 @@
     returned in the <parameter>source</parameter> parameter. The
     <parameter>fd</parameter> parameter takes the UNIX file descriptor
     to watch, which may refer to a socket, a FIFO, a message queue, a
     returned in the <parameter>source</parameter> parameter. The
     <parameter>fd</parameter> parameter takes the UNIX file descriptor
     to watch, which may refer to a socket, a FIFO, a message queue, a

-    serial connection, a character device or any other file descriptor
-    compatible with Linux <citerefentry
-    project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry>. The
-    <parameter>events</parameter> parameter takes a bit mask of I/O
-    events to watch the file descriptor for, a combination of the
-    following event flags: <constant>EPOLLIN</constant>,
-    <constant>EPOLLOUT</constant>, <constant>EPOLLRDHUP</constant>,
-    <constant>EPOLLPRI</constant> and <constant>EPOLLET</constant>,
-    see <citerefentry
-    project='man-pages'><refentrytitle>epoll_ctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+    serial connection, a character device, or any other file descriptor
+    compatible with Linux
+    <citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry>. The
+    <parameter>events</parameter> parameter takes a bit mask of events
+    to watch for, a combination of the following event flags:
+    <constant>EPOLLIN</constant>, <constant>EPOLLOUT</constant>,
+    <constant>EPOLLRDHUP</constant>, <constant>EPOLLPRI</constant>,
+    and <constant>EPOLLET</constant>, see
+    <citerefentry project='man-pages'><refentrytitle>epoll_ctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>

     for details. The <parameter>handler</parameter> shall reference a
     for details. The <parameter>handler</parameter> shall reference a

-    function to call when the I/O event source is triggered. The
-    handler function will be passed the
-    <parameter>userdata</parameter> pointer, which may be chosen
-    freely by the caller. The handler will also be passed the file
-    descriptor the event was seen on as well as the actual event flags
-    seen. It's generally a subset of the events watched, however may
-    additionally have <constant>EPOLLERR</constant> and
-    <constant>EPOLLHUP</constant> set.</para>
-
-    <para>By default, the I/O event source will stay enabled
+    function to call when the event source is triggered. The
+    <parameter>userdata</parameter> pointer will be passed to the
+    handler function, and may be chosen freely by the caller. The
+    handler will also be passed the file descriptor the event was seen
+    on, as well as the actual event flags. It's generally a subset of
+    the events watched, however may additionally include
+    <constant>EPOLLERR</constant> and <constant>EPOLLHUP</constant>.
+    </para>
+
+    <para>By default, an event source will stay enabled

     continuously (<constant>SD_EVENT_ON</constant>), but this may be
     changed with
     <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
     If the handler function returns a negative error code, it will be
     disabled after the invocation, even if the
     <constant>SD_EVENT_ON</constant> mode was requested before. Note
     continuously (<constant>SD_EVENT_ON</constant>), but this may be
     changed with
     <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
     If the handler function returns a negative error code, it will be
     disabled after the invocation, even if the
     <constant>SD_EVENT_ON</constant> mode was requested before. Note

-    that an I/O event source set to <constant>SD_EVENT_ON</constant> will
-    fire continuously unless data is read or written to the file
-    descriptor in order to reset the mask of events seen.
+    that an event source set to <constant>SD_EVENT_ON</constant> will
+    fire continuously unless data is read from or written to the file
+    descriptor to reset the mask of events seen.

     </para>
 
     <para>Setting the I/O event mask to watch for to 0 does not mean
     </para>
 
     <para>Setting the I/O event mask to watch for to 0 does not mean


@@ -164,16 +163,17 @@
     <citerefentry><refentrytitle>sd_event_source_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
     but note that the event source is only removed from the event loop
     when all references to the event source are dropped. To make sure
     <citerefentry><refentrytitle>sd_event_source_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
     but note that the event source is only removed from the event loop
     when all references to the event source are dropped. To make sure

-    an event source does not fire anymore, even when there's still a
-    reference to it kept, consider setting the event source to
-    <constant>SD_EVENT_OFF</constant> with
-    <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
+    an event source does not fire anymore, even if it is still referenced,
+    disable the event source using
+    <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    with <constant>SD_EVENT_OFF</constant>.</para>

 
     <para>If the second parameter of
 
     <para>If the second parameter of

-    <function>sd_event_add_io()</function> is passed as NULL no
-    reference to the event source object is returned. In this case the
-    event source is considered "floating", and will be destroyed
-    implicitly when the event loop itself is destroyed.</para>
+    <function>sd_event_add_io()</function> is
+    <constant>NULL</constant> no reference to the event source object
+    is returned. In this case the event source is considered
+    "floating", and will be destroyed implicitly when the event loop
+    itself is destroyed.</para>

 
     <para>It is recommended to use
     <function>sd_event_add_io()</function> only in conjunction with
 
     <para>It is recommended to use
     <function>sd_event_add_io()</function> only in conjunction with


@@ -181,24 +181,24 @@
     ensure that all I/O operations from invoked handlers are properly
     asynchronous and non-blocking. Using file descriptors without
     <constant>O_NONBLOCK</constant> might result in unexpected
     ensure that all I/O operations from invoked handlers are properly
     asynchronous and non-blocking. Using file descriptors without
     <constant>O_NONBLOCK</constant> might result in unexpected

-    starving of other event sources. See <citerefentry
-    project='man-pages'><refentrytitle>fcntl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+    starvation of other event sources. See
+    <citerefentry project='man-pages'><refentrytitle>fcntl</refentrytitle><manvolnum>2</manvolnum></citerefentry>

     for details on enabling <constant>O_NONBLOCK</constant> mode.</para>
 
     <para><function>sd_event_source_get_io_events()</function> retrieves
     for details on enabling <constant>O_NONBLOCK</constant> mode.</para>
 
     <para><function>sd_event_source_get_io_events()</function> retrieves

-    the configured I/O event mask to watch of an I/O event source created
+    the configured mask of watched I/O events of an event source created

     previously with <function>sd_event_add_io()</function>. It takes
     the event source object and a pointer to a variable to store the
     previously with <function>sd_event_add_io()</function>. It takes
     the event source object and a pointer to a variable to store the

-    event mask in.</para>
+    mask in.</para>

 
 

-    <para><function>sd_event_source_set_io_events()</function> changes the
-    configured I/O event mask to watch of an I/O event source created previously
-    with <function>sd_event_add_io()</function>. It takes the event
-    source object and the new event mask to set.</para>
+    <para><function>sd_event_source_set_io_events()</function>
+    configures the mask of watched I/O events of an event source created
+    previously with <function>sd_event_add_io()</function>. It takes the
+    event source object and the new event mask.</para>

 
 

-    <para><function>sd_event_source_get_io_events()</function>
+    <para><function>sd_event_source_get_io_revents()</function>

     retrieves the I/O event mask of currently seen but undispatched
     retrieves the I/O event mask of currently seen but undispatched

-    events from an I/O event source created previously with
+    events from an event source created previously with

     <function>sd_event_add_io()</function>. It takes the event source
     object and a pointer to a variable to store the event mask
     in. When called from a handler function on the handler's event
     <function>sd_event_add_io()</function>. It takes the event source
     object and a pointer to a variable to store the event mask
     in. When called from a handler function on the handler's event


@@ -214,15 +214,15 @@
     source types, the latter only to I/O event sources.</para>
 
     <para><function>sd_event_source_get_io_fd()</function> retrieves
     source types, the latter only to I/O event sources.</para>
 
     <para><function>sd_event_source_get_io_fd()</function> retrieves

-    the UNIX file descriptor of an I/O event source created previously
+    the UNIX file descriptor of an event source created previously

     with <function>sd_event_add_io()</function>. It takes the event
     with <function>sd_event_add_io()</function>. It takes the event

-    source object and returns the positive file descriptor in the return
-    value, or a negative error number on error (see below).</para>
+    source object and returns the non-negative file descriptor
+    or a negative error number on error (see below).</para>

 
     <para><function>sd_event_source_set_io_fd()</function>
     changes the UNIX file descriptor of an I/O event source created
     previously with <function>sd_event_add_io()</function>. It takes
 
     <para><function>sd_event_source_set_io_fd()</function>
     changes the UNIX file descriptor of an I/O event source created
     previously with <function>sd_event_add_io()</function>. It takes

-    the event source object and the new file descriptor to set.</para>
+    the event source object and the new file descriptor.</para>

   </refsect1>
 
   <refsect1>
   </refsect1>
 
   <refsect1>


@@ -230,13 +230,13 @@
 
     <para>On success, these functions return 0 or a positive
     integer. On failure, they return a negative errno-style error
 
     <para>On success, these functions return 0 or a positive
     integer. On failure, they return a negative errno-style error

-    code. </para>
+    code.</para>

   </refsect1>
 
   <refsect1>
     <title>Errors</title>
 
   </refsect1>
 
   <refsect1>
     <title>Errors</title>
 

-    <para>Returned errors may indicate the following problems:</para>
+    <para>Returned values may indicate the following problems:</para>

 
     <variablelist>
       <varlistentry>
 
     <variablelist>
       <varlistentry>

diff --git a/man/sd_event_now.xml b/man/sd_event_now.xml
index 219e261fd4a7031bca6fa870b3202f37bb8bf8e2..b419e7d8210aac15f21d6793ebe5177e90161c39 100644 (file)
--- a/man/sd_event_now.xml
+++ b/man/sd_event_now.xml
@@ -65,45 +65,44 @@
   <refsect1>
     <title>Description</title>
 
   <refsect1>
     <title>Description</title>
 

-    <para><function>sd_event_now()</function> returns the timestamp
-    the most recent event loop iteration began. This timestamp is
-    taken right after returning from the event sleep, and before
+    <para><function>sd_event_now()</function> returns the time when
+    the most recent event loop iteration began. A timestamp
+    is taken right after returning from the event sleep, and before

     dispatching any event sources. The <parameter>event</parameter>
     dispatching any event sources. The <parameter>event</parameter>

-    parameter takes the even loop object to retrieve the timestamp
+    parameter specifies the event loop object to retrieve the timestamp

     from. The <parameter>clock</parameter> parameter specifies the clock to
     retrieve the timestamp for, and is one of
     from. The <parameter>clock</parameter> parameter specifies the clock to
     retrieve the timestamp for, and is one of

-    <constant>CLOCK_REALTIME</constant> (or its equivalent
+    <constant>CLOCK_REALTIME</constant> (or equivalently

     <constant>CLOCK_REALTIME_ALARM</constant>),
     <constant>CLOCK_REALTIME_ALARM</constant>),

-    <constant>CLOCK_MONOTONIC</constant> or
-    <constant>CLOCK_BOOTTIME</constant> (or its equivalent
-    <constant>CLOCK_BOOTTIME_ALARM</constant>), see <citerefentry
-    project='man-pages'><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+    <constant>CLOCK_MONOTONIC</constant>, or
+    <constant>CLOCK_BOOTTIME</constant> (or equivalently
+    <constant>CLOCK_BOOTTIME_ALARM</constant>), see
+    <citerefentry project='man-pages'><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>

     for more information on the various clocks. The retrieved
     timestamp is stored in the <parameter>usec</parameter> parameter,
     in µs since the clock's epoch. If this function is invoked before
     for more information on the various clocks. The retrieved
     timestamp is stored in the <parameter>usec</parameter> parameter,
     in µs since the clock's epoch. If this function is invoked before

-    the first event loop iteration the current time is returned, as
+    the first event loop iteration, the current time is returned, as

     reported by <function>clock_gettime()</function>. To distinguish
     this case from a regular invocation the return value will be
     reported by <function>clock_gettime()</function>. To distinguish
     this case from a regular invocation the return value will be

-    positive non-zero in this case, while it is zero when the returned
-    timestamp refers to the actual event loop iteration.</para>
+    positive, and zero when the returned timestamp refers to an actual
+    event loop iteration.</para>

   </refsect1>
 
   <refsect1>
     <title>Return Value</title>
 
     <para>If the first event loop iteration has not run yet
   </refsect1>
 
   <refsect1>
     <title>Return Value</title>
 
     <para>If the first event loop iteration has not run yet

-    <function>sd_event_now()</function> returns the requested
-    timestamp in <parameter>usec</parameter> and returns a positive,
-    non-zero return value. Otherwise, on success it will return the
-    iteration's timestamp in <parameter>usec</parameter> and 0 as
-    return value. On failure, the call returns a negative errno-style
+    <function>sd_event_now()</function> writes current time to
+    <parameter>usec</parameter> and returns a positive return value.
+    Otherwise, it will write the requested timestamp to <parameter>usec</parameter>
+    and return 0. On failure, the call returns a negative errno-style

     error code.</para>
   </refsect1>
 
   <refsect1>
     <title>Errors</title>
 
     error code.</para>
   </refsect1>
 
   <refsect1>
     <title>Errors</title>
 

-    <para>Returned errors may indicate the following problems:</para>
+    <para>Returned values may indicate the following problems:</para>

 
     <variablelist>
       <varlistentry>
 
     <variablelist>
       <varlistentry>

diff --git a/man/sd_event_source_get_pending.xml b/man/sd_event_source_get_pending.xml
index 1339d50461d622c89804ca325d6ef01c8cf5d53d..ea3c21db86fb57f03041bba29b2d9afbea4ae8ad 100644 (file)
--- a/man/sd_event_source_get_pending.xml
+++ b/man/sd_event_source_get_pending.xml
@@ -87,7 +87,7 @@
     <para>For I/O event sources, as created with
     <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
     the call
     <para>For I/O event sources, as created with
     <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
     the call

-    <citerefentry><refentrytitle>sd_event_get_io_revents</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    <citerefentry><refentrytitle>sd_event_source_get_io_revents</refentrytitle><manvolnum>3</manvolnum></citerefentry>

     may be used to query the type of event pending in more
     detail.</para>
 
     may be used to query the type of event pending in more
     detail.</para>
 

diff --git a/man/sd_get_seats.xml b/man/sd_get_seats.xml
index a6c5e89479c95f37c7ce56f2a6fff26de67480a2..963213797075ec398f4df1b568deefd7a72bc477 100644 (file)
--- a/man/sd_get_seats.xml
+++ b/man/sd_get_seats.xml
@@ -127,7 +127,7 @@
         <term><constant>-EINVAL</constant></term>
 
         <listitem><para>An input parameter was invalid (out of range,
         <term><constant>-EINVAL</constant></term>
 
         <listitem><para>An input parameter was invalid (out of range,

-        or NULL, where that's not accepted).</para></listitem>
+        or NULL, where that is not accepted).</para></listitem>

       </varlistentry>
 
       <varlistentry>
       </varlistentry>
 
       <varlistentry>

diff --git a/man/sd_machine_get_class.xml b/man/sd_machine_get_class.xml
index 4a3f513f6e0eaea29c4293302d5b57771f71808b..be872eac815d47287abb97ecd4c02dedb85b75b3 100644 (file)
--- a/man/sd_machine_get_class.xml
+++ b/man/sd_machine_get_class.xml
@@ -116,7 +116,7 @@
         <term><constant>-EINVAL</constant></term>
 
         <listitem><para>An input parameter was invalid (out of range,
         <term><constant>-EINVAL</constant></term>
 
         <listitem><para>An input parameter was invalid (out of range,

-        or NULL, where that's not accepted).</para></listitem>
+        or NULL, where that is not accepted).</para></listitem>

       </varlistentry>
 
       <varlistentry>
       </varlistentry>
 
       <varlistentry>

diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index 2345aea4bf53ffed5141c8c84a128b61e0e908c2..03efe0193a7501bfd3bb4863feaa1903bc335156 100644 (file)
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -1,4 +1,4 @@
-<?xml version='1.0'?> <!--*-nxml-*-->
+<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->

 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 


@@ -100,7 +100,7 @@
     <para><function>sd_notify()</function> may be called by a service
     to notify the service manager about state changes. It can be used
     to send arbitrary information, encoded in an
     <para><function>sd_notify()</function> may be called by a service
     to notify the service manager about state changes. It can be used
     to send arbitrary information, encoded in an

-    environment-block-like string. Most importantly it can be used for
+    environment-block-like string. Most importantly, it can be used for

     start-up completion notification.</para>
 
     <para>If the <parameter>unset_environment</parameter> parameter is
     start-up completion notification.</para>
 
     <para>If the <parameter>unset_environment</parameter> parameter is


@@ -158,7 +158,7 @@
         to the service manager that describes the service state. This
         is free-form and can be used for various purposes: general
         state feedback, fsck-like programs could pass completion
         to the service manager that describes the service state. This
         is free-form and can be used for various purposes: general
         state feedback, fsck-like programs could pass completion

-        percentages and failing programs could pass a human readable
+        percentages and failing programs could pass a human-readable

         error message. Example: <literal>STATUS=Completed 66% of file
         system check...</literal></para></listitem>
       </varlistentry>
         error message. Example: <literal>STATUS=Completed 66% of file
         system check...</literal></para></listitem>
       </varlistentry>


@@ -194,7 +194,7 @@
         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
         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>logind.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+        <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>

         for information how to enable this functionality and
         <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>
         for the details of how the service can check whether the
         for information how to enable this functionality and
         <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>
         for the details of how the service can check whether the


@@ -219,7 +219,7 @@
         manager will accept messages for a service only if
         <varname>FileDescriptorStoreMax=</varname> is set to non-zero
         for it (defaults to zero). See
         manager will accept messages for a service only if
         <varname>FileDescriptorStoreMax=</varname> is set to non-zero
         for it (defaults to zero). See

-        <citerefentry><refentrytitle>logind.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+        <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>

         for details. Multiple arrays of file descriptors may be sent
         in separate messages, in which case the arrays are combined.
         Note that the service manager removes duplicate file
         for details. Multiple arrays of file descriptors may be sent
         in separate messages, in which case the arrays are combined.
         Note that the service manager removes duplicate file


@@ -229,6 +229,36 @@
         below.</para></listitem>
       </varlistentry>
 
         below.</para></listitem>
       </varlistentry>
 

+      <varlistentry>
+        <term>FDNAME=...</term>
+
+        <listitem><para>When used in combination with
+        <varname>FDSTORE=1</varname>, specifies a name for the
+        submitted file descriptors. This name is passed to the service
+        during activation, and may be queried using
+        <citerefentry><refentrytitle>sd_listen_fds_with_names</refentrytitle><manvolnum>3</manvolnum></citerefentry>. File
+        descriptors submitted without this field set, will implicitly
+        get the name <literal>stored</literal> assigned. Note that, if
+        multiple file descriptors are submitted at once, the specified
+        name will be assigned to all of them. In order to assign
+        different names to submitted file descriptors, submit them in
+        separate invocations of
+        <function>sd_pid_notify_with_fds()</function>. The name may
+        consist of any ASCII character, but must not contain control
+        characters or <literal>:</literal>. It may not be longer than
+        255 characters. If a submitted name does not follow these
+        restrictions, it is ignored.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>WATCHDOG_USEC=...</term>
+
+        <listitem><para>Reset <varname>watchdog_usec</varname> value during runtime.
+        Notice that this is not available when using <function>sd_event_set_watchdog()</function>
+        or <function>sd_watchdog_enabled()</function>.
+        Example : <literal>WATCHDOG_USEC=20000000</literal></para></listitem>
+      </varlistentry>
+

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


@@ -238,7 +268,7 @@
     <para>Note that elogind will accept status data sent from a
     service only if the <varname>NotifyAccess=</varname> option is
     correctly set in the service definition file. See
     <para>Note that elogind will accept status data sent from a
     service only if the <varname>NotifyAccess=</varname> option is
     correctly set in the service definition file. See

-    <citerefentry><refentrytitle>logind.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>

     for details.</para>
 
     <para><function>sd_notifyf()</function> is similar to
     for details.</para>
 
     <para><function>sd_notifyf()</function> is similar to


@@ -253,7 +283,7 @@
     use as originating PID for the message as first argument. This is
     useful to send notification messages on behalf of other processes,
     provided the appropriate privileges are available. If the PID
     use as originating PID for the message as first argument. This is
     useful to send notification messages on behalf of other processes,
     provided the appropriate privileges are available. If the PID

-    argument is specified as 0 the process ID of the calling process
+    argument is specified as 0, the process ID of the calling process

     is used, in which case the calls are fully equivalent to
     <function>sd_notify()</function> and
     <function>sd_notifyf()</function>.</para>
     is used, in which case the calls are fully equivalent to
     <function>sd_notify()</function> and
     <function>sd_notifyf()</function>.</para>


@@ -356,20 +386,22 @@
 
       <para>To store an open file descriptor in the service manager,
       in order to continue operation after a service restart without
 
       <para>To store an open file descriptor in the service manager,
       in order to continue operation after a service restart without

-      losing state use <literal>FDSTORE=1</literal>:</para>
+      losing state, use <literal>FDSTORE=1</literal>:</para>

 
 

-      <programlisting>sd_pid_notify_with_fds(0, 0, "FDSTORE=1", &amp;fd, 1);</programlisting>
+      <programlisting>sd_pid_notify_with_fds(0, 0, "FDSTORE=1\nFDNAME=foobar", &amp;fd, 1);</programlisting>

     </example>
   </refsect1>
 
   <refsect1>
     <title>See Also</title>
     <para>
     </example>
   </refsect1>
 
   <refsect1>
     <title>See Also</title>
     <para>

-      <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

       <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

+      <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_listen_fds_with_names</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

       <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>,

-      <citerefentry><refentrytitle>logind.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+      <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>

     </para>
   </refsect1>
 
     </para>
   </refsect1>
 

diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml
index 4ae756a9a5727b6e666189dd68be4a81716b6525..b4d044282d72289df148beae73bdad1d62c0102b 100644 (file)
--- a/man/sd_seat_get_active.xml
+++ b/man/sd_seat_get_active.xml
@@ -158,7 +158,7 @@
       <varlistentry>
         <term><constant>-ENODATA</constant></term>
 
       <varlistentry>
         <term><constant>-ENODATA</constant></term>
 

-        <listitem><para>Given field is not specified for the described
+        <listitem><para>The given field is not specified for the described

         seat.</para>
         </listitem>
       </varlistentry>
         seat.</para>
         </listitem>
       </varlistentry>


@@ -174,7 +174,7 @@
         <term><constant>-EINVAL</constant></term>
 
         <listitem><para>An input parameter was invalid (out of range,
         <term><constant>-EINVAL</constant></term>
 
         <listitem><para>An input parameter was invalid (out of range,

-        or NULL, where that's not accepted).</para></listitem>
+        or NULL, where that is not accepted).</para></listitem>

       </varlistentry>
 
       <varlistentry>
       </varlistentry>
 
       <varlistentry>

diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml
index 11171473b12b013b3ebc5c4ea683d6f31470a672..97721a56a507cd73ec20697d50d69313850337c1 100644 (file)
--- a/man/sd_session_is_active.xml
+++ b/man/sd_session_is_active.xml
@@ -306,7 +306,7 @@
       <varlistentry>
         <term><constant>-ENODATA</constant></term>
 
       <varlistentry>
         <term><constant>-ENODATA</constant></term>
 

-        <listitem><para>Given field is not specified for the described
+        <listitem><para>The given field is not specified for the described

         session.</para>
         </listitem>
       </varlistentry>
         session.</para>
         </listitem>
       </varlistentry>


@@ -315,7 +315,7 @@
         <term><constant>-EINVAL</constant></term>
 
         <listitem><para>An input parameter was invalid (out of range,
         <term><constant>-EINVAL</constant></term>
 
         <listitem><para>An input parameter was invalid (out of range,

-        or NULL, where that's not accepted).</para></listitem>
+        or NULL, where that is not accepted).</para></listitem>

       </varlistentry>
 
       <varlistentry>
       </varlistentry>
 
       <varlistentry>

diff --git a/man/sd_watchdog_enabled.xml b/man/sd_watchdog_enabled.xml
index b9670e8bf903a736d1ac9ce524e0b442c9ab1689..19401e6c0203c6d5ef7c92623af2a5ac622db9d2 100644 (file)
--- a/man/sd_watchdog_enabled.xml
+++ b/man/sd_watchdog_enabled.xml
@@ -96,8 +96,13 @@
 
     <para>To enable service supervision with the watchdog logic, use
     <varname>WatchdogSec=</varname> in service files. See
 
     <para>To enable service supervision with the watchdog logic, use
     <varname>WatchdogSec=</varname> in service files. See

-    <citerefentry><refentrytitle>logind.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>

     for details.</para>
     for details.</para>

+
+    <para>Use
+    <citerefentry><refentrytitle>sd_event_set_watchdog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    to enable automatic watchdog support in
+    <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>-based event loops.</para>

   </refsect1>
 
   <refsect1>
   </refsect1>
 
   <refsect1>


@@ -149,26 +154,15 @@
     </variablelist>
   </refsect1>
 
     </variablelist>
   </refsect1>
 

-  <refsect1>
-    <title>History</title>
-
-    <para>The watchdog functionality and the
-    <varname>$WATCHDOG_USEC</varname> variable were added in
-    elogind-41.</para>
-
-    <para><function>sd_watchdog_enabled()</function> function was
-    added in elogind-209. Since that version the
-    <varname>$WATCHDOG_PID</varname> variable is also set.</para>
-  </refsect1>
-

   <refsect1>
     <title>See Also</title>
     <para>
   <refsect1>
     <title>See Also</title>
     <para>

-      <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

       <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>,

-      <citerefentry><refentrytitle>logind.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+      <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_set_watchdog</refentrytitle><manvolnum>3</manvolnum></citerefentry>

     </para>
   </refsect1>
 
     </para>
   </refsect1>
 

diff --git a/man/standard-conf.xml b/man/standard-conf.xml
index 15268030f8648d5feff3605e6ddba1d02680f5e9..807702493c7c92e9fe319fbf04fd779d7cd01ab8 100644 (file)
--- a/man/standard-conf.xml
+++ b/man/standard-conf.xml
@@ -38,9 +38,9 @@
   <refsection id='main-conf'>
     <title>Configuration Directories and Precedence</title>
 
   <refsection id='main-conf'>
     <title>Configuration Directories and Precedence</title>
 

-    <para>Default configuration is defined during compilation, so a
+    <para>The default configuration is defined during compilation, so a

     configuration file is only needed when it is necessary to deviate
     configuration file is only needed when it is necessary to deviate

-    from those defaults. By default the configuration file in
+    from those defaults. By default, the configuration file in

     <filename>/etc/elogind/</filename> contains commented out entries
     showing the defaults as a guide to the administrator. This file
     can be edited to create local overrides.
     <filename>/etc/elogind/</filename> contains commented out entries
     showing the defaults as a guide to the administrator. This file
     can be edited to create local overrides.