]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: make separate "Errors" sections subsection of "Return value" 12046/head
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Thu, 21 Mar 2019 13:53:00 +0000 (14:53 +0100)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Thu, 21 Mar 2019 13:53:00 +0000 (14:53 +0100)
Logically, this is better, because we're describing a subset of possible
return values. Visually this also looks quite good because groff renders
refsect2 much less prominently.

Also rewrap things, add <constant> in various places, fix some typos.

74 files changed:
man/sd_bus_attach_event.xml
man/sd_bus_close.xml
man/sd_bus_creds_get_pid.xml
man/sd_bus_creds_new_from_pid.xml
man/sd_bus_default.xml
man/sd_bus_error.xml
man/sd_bus_error_add_map.xml
man/sd_bus_get_fd.xml
man/sd_bus_get_n_queued_read.xml
man/sd_bus_is_open.xml
man/sd_bus_message_append.xml
man/sd_bus_message_append_array.xml
man/sd_bus_message_append_basic.xml
man/sd_bus_message_append_string_memfd.xml
man/sd_bus_message_append_strv.xml
man/sd_bus_message_copy.xml
man/sd_bus_message_get_cookie.xml
man/sd_bus_message_get_monotonic_usec.xml
man/sd_bus_message_get_signature.xml
man/sd_bus_message_get_type.xml
man/sd_bus_message_new.xml
man/sd_bus_message_new_method_call.xml
man/sd_bus_message_new_method_error.xml
man/sd_bus_message_new_signal.xml
man/sd_bus_message_read.xml
man/sd_bus_message_read_array.xml
man/sd_bus_message_read_basic.xml
man/sd_bus_message_rewind.xml
man/sd_bus_message_set_destination.xml
man/sd_bus_message_set_expect_reply.xml
man/sd_bus_message_skip.xml
man/sd_bus_message_verify_type.xml
man/sd_bus_negotiate_fds.xml
man/sd_bus_new.xml
man/sd_bus_process.xml
man/sd_bus_reply_method_error.xml
man/sd_bus_request_name.xml
man/sd_bus_set_close_on_exit.xml
man/sd_bus_set_connected_signal.xml
man/sd_bus_set_description.xml
man/sd_bus_set_sender.xml
man/sd_bus_set_watch_bind.xml
man/sd_bus_slot_set_description.xml
man/sd_bus_slot_set_destroy_callback.xml
man/sd_bus_slot_set_floating.xml
man/sd_bus_track_add_name.xml
man/sd_bus_track_new.xml
man/sd_bus_wait.xml
man/sd_event_add_child.xml
man/sd_event_add_defer.xml
man/sd_event_add_inotify.xml
man/sd_event_add_io.xml
man/sd_event_add_signal.xml
man/sd_event_add_time.xml
man/sd_event_exit.xml
man/sd_event_get_fd.xml
man/sd_event_new.xml
man/sd_event_now.xml
man/sd_event_run.xml
man/sd_event_set_watchdog.xml
man/sd_event_source_get_pending.xml
man/sd_event_source_set_description.xml
man/sd_event_source_set_destroy_callback.xml
man/sd_event_source_set_enabled.xml
man/sd_event_source_set_prepare.xml
man/sd_event_source_set_priority.xml
man/sd_event_wait.xml
man/sd_get_seats.xml
man/sd_login_monitor_new.xml
man/sd_machine_get_class.xml
man/sd_pid_get_owner_uid.xml
man/sd_seat_get_active.xml
man/sd_session_is_active.xml
man/sd_uid_get_state.xml

index f84a7cc4c57f2ae4def594a50440e080530d4fb7..2a207d28487b2ec0134da56a37a9cc4ec926aa78 100644 (file)
     0 or a positive integer. On failure, they return a negative errno-style error code.</para>
 
     <para><function>sd_bus_get_event()</function> returns an event loop object or <constant>NULL</constant>.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection has been created in a different process.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus connection has been created in a different process.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index f7efc868a46097b1eae0a6ae4db9d654e5bd775a..b09f488874aee51e1f84f7f662eda37517c02c45 100644 (file)
 
     <para>On success, <function>sd_bus_flush()</function> returns 0 or a positive integer. On failure, it returns a
     negative errno-style error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection has been created in a different process.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus connection has been created in a different process.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 97ff01226b31a15d307a6e7c143aba7a59048b53..9e79d13cdd150427c1b353c6fd3592dcc484535a 100644 (file)
     <para>On success, these calls return 0 or a positive integer. On
     failure, these calls return a negative errno-style error code.
     </para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
-
-    <para>Returned errors may indicate the following problems:</para>
-
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENODATA</constant></term>
-
-        <listitem><para>The given field is not available in the
-        credentials object <parameter>c</parameter>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><constant>-ENXIO</constant></term>
-
-        <listitem><para>The given field is not specified for the described
-        process or peer. This will be returned by
-        <function>sd_bus_creds_get_unit()</function>,
-        <function>sd_bus_creds_get_slice()</function>,
-        <function>sd_bus_creds_get_user_unit()</function>,
-        <function>sd_bus_creds_get_user_slice()</function>, and
-        <function>sd_bus_creds_get_session()</function> if the process is
-        not part of a systemd system unit, systemd user unit, systemd
-        slice, or logind session. It will be returned by
-        <function>sd_bus_creds_get_owner_uid()</function> if the process is
-        not part of a systemd user unit or logind session. It will also be
-        returned by <function>sd_bus_creds_get_exe()</function> and
-        <function>sd_bus_creds_get_cmdline()</function> for kernel
-        threads (since these are not started from an executable binary,
-        nor have a command line), and by
-        <function>sd_bus_creds_get_audit_session_id()</function> and
-        <function>sd_bus_creds_get_audit_login_uid()</function> when
-        the process is not part of an audit session, and
-        <function>sd_bus_creds_get_tty()</function> if the process has
-        no controlling TTY.
-        </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
-
-        <listitem><para>Specified pointer parameter is <constant>NULL</constant>.
-        </para></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
-
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+    <refsect2>
+      <title>Errors</title>
+
+      <para>Returned errors may indicate the following problems:</para>
+
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENODATA</constant></term>
+
+          <listitem><para>The given field is not available in the credentials object
+          <parameter>c</parameter>.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><constant>-ENXIO</constant></term>
+
+          <listitem><para>The given field is not specified for the described process or peer. This will be
+          returned by <function>sd_bus_creds_get_unit()</function>,
+          <function>sd_bus_creds_get_slice()</function>, <function>sd_bus_creds_get_user_unit()</function>,
+          <function>sd_bus_creds_get_user_slice()</function>, and
+          <function>sd_bus_creds_get_session()</function> if the process is not part of a systemd system
+          unit, systemd user unit, systemd slice, or logind session. It will be returned by
+          <function>sd_bus_creds_get_owner_uid()</function> if the process is not part of a systemd user unit
+          or logind session. It will also be returned by <function>sd_bus_creds_get_exe()</function> and
+          <function>sd_bus_creds_get_cmdline()</function> for kernel threads (since these are not started
+          from an executable binary, nor have a command line), and by
+          <function>sd_bus_creds_get_audit_session_id()</function> and
+          <function>sd_bus_creds_get_audit_login_uid()</function> when the process is not part of an audit
+          session, and <function>sd_bus_creds_get_tty()</function> if the process has no controlling
+          TTY.</para></listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
+
+          <listitem><para>Specified pointer parameter is <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
+
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 21f58c0b3d35508f3c1c4160cfac336c2ec9f7a0..f5ee01ca3537cb347bb341c6d94b357ea207522c 100644 (file)
     not needed anymore, this reference should be destroyed with
     <citerefentry><refentrytitle>sd_bus_creds_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
     </para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-ESRCH</constant></term>
+        <varlistentry>
+          <term><constant>-ESRCH</constant></term>
 
-        <listitem><para>Specified <parameter>pid</parameter> could not
-        be found.</para></listitem>
-      </varlistentry>
+          <listitem><para>Specified <parameter>pid</parameter> could not be found.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>Specified parameter is invalid
-        (<constant>NULL</constant> in case of output
-        parameters).</para></listitem>
-      </varlistentry>
+          <listitem><para>Specified parameter is invalid (<constant>NULL</constant> in case of output
+          parameters).</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EOPNOTSUPP</constant></term>
+        <varlistentry>
+          <term><constant>-EOPNOTSUPP</constant></term>
 
-        <listitem><para>One of the requested fields is unknown to the local system.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>One of the requested fields is unknown to the local system.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 2109c2ddcbc16c0e0e55b05de264b12a1716d781..51c27f04fffb195ff5ddd574a1b1037b7317c277 100644 (file)
     <para>On success, these calls return 0 or a positive
     integer. On failure, these calls return a negative
     errno-style error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The specified parameters are invalid.</para></listitem>
-      </varlistentry>
+          <listitem><para>The specified parameters are invalid.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESOCKTNOSUPPORT</constant></term>
+        <varlistentry>
+          <term><constant>-ESOCKTNOSUPPORT</constant></term>
 
-        <listitem><para>The protocol version required to connect to the selected bus is not supported.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The protocol version required to connect to the selected bus is not
+          supported.</para></listitem>
+        </varlistentry>
+      </variablelist>
 
-    <para>In addition, any further connection-related errors may be
-    by returned. See <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
+      <para>In addition, any further connection-related errors may be by returned. See
+      <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 43e8f24effbf5de7d161e9160ed252d08fd787ee..8616f7ee43eab61b601debfa53dc9db604497860 100644 (file)
     project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     the memory held by the structure itself after freeing its contents
     with <function>sd_bus_error_free()</function>.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>Error was already set in
-        <structname>sd_bus_error</structname> structure when one the
-        error-setting functions was called.</para></listitem>
-      </varlistentry>
+          <listitem><para>Error was already set in <structname>sd_bus_error</structname> structure when one
+          the error-setting functions was called.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 9a39c0fef48fe03b957880951f378ae01221c4a3..1dfc7259e2368f277dc77685e486fd153e4ce56e 100644 (file)
     tables. It returns zero when the same array was already added
     before. On error, a negative <varname>errno</varname>-style error
     code is returned. See below for known error codes.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The specified mapping array is invalid.</para></listitem>
-      </varlistentry>
+          <listitem><para>The specified mapping array is invalid.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index a8c1b1a63dc52e241071f74511a6a104c625137f..6a022b1a19053f91239b21418b6f9854a63ec869 100644 (file)
 
     <para><function>sd_bus_get_timeout()</function> returns zero or positive on success, or a negative
     <varname>errno</varname>-style error code on error.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An invalid bus object was passed.</para></listitem>
-      </varlistentry>
+          <listitem><para>An invalid bus object was passed.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection was allocated in a parent process and is being reused in a child process
-        after <function>fork()</function>.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus connection was allocated in a parent process and is being reused in a child
+          process after <function>fork()</function>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOTCONN</constant></term>
+        <varlistentry>
+          <term><constant>-ENOTCONN</constant></term>
 
-        <listitem><para>The bus connection has been terminated.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus connection has been terminated.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>Two distinct file descriptors were passed for input and output using
-        <function>sd_bus_set_fd()</function>, which <function>sd_bus_get_fd()</function> cannot
-        return.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Two distinct file descriptors were passed for input and output using
+          <function>sd_bus_set_fd()</function>, which <function>sd_bus_get_fd()</function> cannot
+          return.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 3112ca7a8ad650c6443d4b50b6ac172d55b1dcb4..f949c936c21403432eadc29c361921ce666cbf10 100644 (file)
 
     <para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
     error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection was created in a different process.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus connection was created in a different process.</para></listitem>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <refsect1>
index ff3f836bb411700f2b8bc67ddb59f57ae739dfa2..d993142cb5c9d45d9bfd0272685a050fa7942b57 100644 (file)
 
     <para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
     error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection has been created in a different process.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus connection has been created in a different process.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index f7e6007129de94cfde3b5abef993fe67aff9b9a8..b87468e37336c79604846cc3a53a8a462e22b3b8 100644 (file)
@@ -227,12 +227,11 @@ sd_bus_message_append(m, "ynqiuxtd", y, n, q, i, u, x, t, d);</programlisting>
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, these functions return 0 or a positive
-    integer. On failure, these functions return a negative
+    <para>On success, these functions return 0 or a positive integer. On failure, they return a negative
     errno-style error code.</para>
-  </refsect1>
 
-  <xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
+    <xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
+  </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
 
index 7da94c2664861a84fabbeef7b6834c0ac0a5f516..b9595d6a0a224f7dd9aada88304476e5928a9503 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, these calls return 0 or a positive integer. On
-    failure, they return a negative errno-style error code.</para>
-  </refsect1>
+    <para>On success, these calls return 0 or a positive integer. On failure, they return a negative
+    errno-style error code.</para>
 
-  <xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
+    <xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
+  </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
 
index 852d42c962b7ebc78d9a1fd44604a2751b18f663..a180046b963e1f512e8fa686518c7418d297650a 100644 (file)
 
     <para>On success, this call returns 0 or a positive integer. On
     failure, it returns a negative errno-style error code.</para>
-  </refsect1>
 
-  <refsect1 id='errors'>
-    <title>Errors</title>
+    <refsect2 id='errors'>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>Specified parameter is invalid.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para>Specified parameter is invalid.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>Message has been sealed.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para>Message has been sealed.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>Message is in invalid state.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para>Message is in invalid state.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENXIO</constant></term>
+        <varlistentry>
+          <term><constant>-ENXIO</constant></term>
 
-        <listitem><para>Message cannot be appended to.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para>Message cannot be appended to.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index fc68e023609cae512df2287622d163c179fb9b62..c59b8a4284271a0fdf4e472554c680ac4bc20738 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, those calls return 0 or a positive integer. On
-    failure, they returns a negative errno-style error code.</para>
-  </refsect1>
+    <para>On success, those calls return 0 or a positive integer. On failure, they return a negative
+    errno-style error code.</para>
 
-  <xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
+    <xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
+  </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
 
index 3d2921b3ca452826986deb93164d00bd46287d0c..2ce321633d51971c5af12ebd24411c03cd312d02 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, this call returns 0 or a positive integer. On
-    failure, a negative errno-style error code is returned.</para>
-  </refsect1>
+    <para>On success, this call returns 0 or a positive integer. On failure, a negative errno-style error
+    code is returned.</para>
 
-  <xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
+    <xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
+  </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
 
index 3f74a1c8d25d19f5091cc6cfaa648e7a985e850e..cd8ad72e46e34122b617a3c20a9864066ef0309e 100644 (file)
     <para>On success, this call returns true if anything was copied, and false if
     there was nothing to copy. On failure, it returns a negative errno-style error
     code.</para>
-  </refsect1>
 
-  <refsect1 id='errors'>
-    <title>Errors</title>
+    <refsect2 id='errors'>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para><parameter>source</parameter> or <parameter>m</parameter> are
-        <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
+          <listitem><para><parameter>source</parameter> or <parameter>m</parameter> are
+          <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>Message <parameter>m</parameter> has been sealed or
-        <parameter>source</parameter> has <emphasis>not</emphasis> been sealed.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para>Message <parameter>m</parameter> has been sealed or <parameter>source</parameter>
+          has <emphasis>not</emphasis> been sealed.  </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>Destination message is in invalid state.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para>Destination message is in invalid state.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENXIO</constant></term>
+        <varlistentry>
+          <term><constant>-ENXIO</constant></term>
 
-        <listitem><para>Destination message cannot be appended to.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para>Destination message cannot be appended to.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 3cb57d25ad7840c482c9b72620bf4283143d0c61..7b9408c049b688a57c03902f568bf2212a13ad3b 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, these calls return 0 or a positive integer. On
-    failure, these calls return a negative errno-style error
-    code.</para>
+    <para>On success, these calls return 0 or a positive integer. On failure, they return a negative
+    errno-style error code.</para>
 
-    <para>On success, the cookie/reply cookie is returned in the
-    specified 64-bit unsigned integer variable.</para>
-  </refsect1>
+    <para>On success, the cookie/reply cookie is returned in the specified 64-bit unsigned integer
+    variable.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>A specified parameter
-        is invalid.</para></listitem>
-      </varlistentry>
+          <listitem><para>A specified parameter is invalid.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENODATA</constant></term>
+        <varlistentry>
+          <term><constant>-ENODATA</constant></term>
 
-        <listitem><para>No cookie has been assigned to this message.
-        This either indicates that the message has not been sent yet
-        and hence has no cookie assigned, or that the message is not a
-        method response message and hence carries a reply cookie
-        field.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>No cookie has been assigned to this message.  This either indicates that the
+          message has not been sent yet and hence has no cookie assigned, or that the message is not a method
+          response message and hence carries a reply cookie field.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 6110fb8059b49fa1451b5de3c97a495f9f77cf44..958b832534f83d7439ebd8c5c995c53cd5a62166 100644 (file)
 
     <para>On success, the timestamp or sequence number is returned in
     the specified 64-bit unsigned integer variable.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>A specified parameter is
-        invalid.</para></listitem>
-      </varlistentry>
+          <listitem><para>A specified parameter is invalid.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENODATA</constant></term>
+        <varlistentry>
+          <term><constant>-ENODATA</constant></term>
 
-        <listitem><para>No timestamp or sequence number information is
-        attached to the passed message. This error is returned if the
-        underlying transport does not support timestamping or
-        assigning of sequence numbers, or if this feature has not been
-        negotiated with
-        <citerefentry><refentrytitle>sd_bus_negotiate_timestamp</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>No timestamp or sequence number information is attached to the passed message. This
+          error is returned if the underlying transport does not support timestamping or assigning of
+          sequence numbers, or if this feature has not been negotiated with
+          <citerefentry><refentrytitle>sd_bus_negotiate_timestamp</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 607fdba6c8b635c7f1c9733b280a21f8f21df1cf..e3f41346b657b2734c67929f22826b60a071a254 100644 (file)
 
     <para>The other functions return 0 or a positive integer on success. On failure, they return a
     negative errno-style error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The <parameter>message</parameter> parameter is <constant>NULL</constant>.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para>The <parameter>message</parameter> parameter is <constant>NULL</constant>.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>NULL</constant></term>
+        <varlistentry>
+          <term><constant>NULL</constant></term>
 
-        <listitem><para>The <parameter>message</parameter> parameter is <constant>NULL</constant>.
-        </para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The <parameter>message</parameter> parameter is <constant>NULL</constant>.
+          </para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index d6304478c75eeaac9e37d7bbff1ad250a69c9461..d8a45ce7a07dda66c6905be2f78b55e7a6602b71 100644 (file)
 
     <para>On success, those functions return 0 or a positive
     integer. On failure, it returns a negative errno-style error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The <parameter>message</parameter> parameter or the output parameter are
-        <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The <parameter>message</parameter> parameter or the output parameter are
+          <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 89ba88151e279b55c75cb4457e0299bb70882f63..efe650dea7e46e84ba0e20b01143f8b94aa7289c 100644 (file)
     <constant>NULL</constant>.</para>
 
     <para><function>sd_bus_message_get_bus()</function> always returns the bus object.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>Specified <parameter>type</parameter> is invalid.</para></listitem>
-      </varlistentry>
+          <listitem><para>Specified <parameter>type</parameter> is invalid.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOTCONN</constant></term>
+        <varlistentry>
+          <term><constant>-ENOTCONN</constant></term>
 
-        <listitem><para>The bus parameter <parameter>bus</parameter> is <constant>NULL</constant> or
-        the bus is not connected.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus parameter <parameter>bus</parameter> is <constant>NULL</constant> or
+          the bus is not connected.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 08ff4a0e022b1c389f8c9b2a017d17a4e836a915..0d181ed82eb71c46d90e19a0b6d6aaf27dc9544a 100644 (file)
 
     <para>This function returns 0 if the message object was successfully created, and a negative
     errno-style error code otherwise.</para>
-  </refsect1>
 
-  <refsect1 id='errors'>
-    <title>Errors</title>
+    <refsect2 id='errors'>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The output parameter <parameter>m</parameter> is
-        <constant>NULL</constant>.</para>
+          <listitem><para>The output parameter <parameter>m</parameter> is
+          <constant>NULL</constant>.</para>
 
-        <para>The <parameter>destination</parameter> parameter is non-null and is not a valid D-Bus
-        service name (<literal>org.somewhere.Something</literal>), the <parameter>path</parameter>
-        parameter is not a valid D-Bus path (<literal>/an/object/path</literal>), the
-        <parameter>interface</parameter> parameter is non-null and is not a valid D-Bus interface
-        name (<literal>an.interface.name</literal>), or the <parameter>member</parameter> parameter
-        is not a valid D-Bus member (<literal>Name</literal>).</para>
+          <para>The <parameter>destination</parameter> parameter is non-null and is not a valid D-Bus
+          service name (<literal>org.somewhere.Something</literal>), the <parameter>path</parameter>
+          parameter is not a valid D-Bus path (<literal>/an/object/path</literal>), the
+          <parameter>interface</parameter> parameter is non-null and is not a valid D-Bus interface
+          name (<literal>an.interface.name</literal>), or the <parameter>member</parameter> parameter
+          is not a valid D-Bus member (<literal>Name</literal>).</para>
 
-        <para>The <parameter>call</parameter> parameter is not a method call object.</para>
-        </listitem>
-      </varlistentry>
+          <para>The <parameter>call</parameter> parameter is not a method call object.</para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOTCONN</constant></term>
+        <varlistentry>
+          <term><constant>-ENOTCONN</constant></term>
 
-        <listitem><para>The bus parameter <parameter>bus</parameter> is <constant>NULL</constant> or
-        the bus is not connected.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus parameter <parameter>bus</parameter> is <constant>NULL</constant> or
+          the bus is not connected.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem>
-        <para>The <parameter>call</parameter> parameter is not sealed.</para>
-        </listitem>
-      </varlistentry>
+          <listitem>
+            <para>The <parameter>call</parameter> parameter is not sealed.</para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EOPNOTSUPP</constant></term>
+        <varlistentry>
+          <term><constant>-EOPNOTSUPP</constant></term>
 
-        <listitem>
-        <para>The <parameter>call</parameter> message does not have a cookie.</para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem>
+            <para>The <parameter>call</parameter> message does not have a cookie.</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 3b7aa36d784bbda4d66af0c4fd5fe3199b5aef9e..27cec8ed0107aef9413b70ebc7e42733d78a11b4 100644 (file)
 
     <para>These functions return 0 if the error reply was successfully created, and a
     negative errno-style error code otherwise.</para>
-  </refsect1>
 
-  <refsect1 id='errors'>
-    <title>Errors</title>
+    <refsect2 id='errors'>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The call message <parameter>call</parameter> or the output
-        parameter <parameter>m</parameter> are <constant>NULL</constant>.</para>
+          <listitem><para>The call message <parameter>call</parameter> or the output
+          parameter <parameter>m</parameter> are <constant>NULL</constant>.</para>
 
-        <para>Message <parameter>call</parameter> is not a method call
-        message.</para>
+          <para>Message <parameter>call</parameter> is not a method call
+          message.</para>
 
-        <para>The error <parameter>error</parameter> parameter to
-        <function>sd_bus_message_new_method_error</function> is not set, see
-        <citerefentry><refentrytitle>sd_bus_error_is_set</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
-        </para>
-        </listitem>
-      </varlistentry>
+          <para>The error <parameter>error</parameter> parameter to
+          <function>sd_bus_message_new_method_error</function> is not set, see
+          <citerefentry><refentrytitle>sd_bus_error_is_set</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
+          </para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>Message <parameter>call</parameter> has been sealed.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para>Message <parameter>call</parameter> has been sealed.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOTCONN</constant></term>
+        <varlistentry>
+          <term><constant>-ENOTCONN</constant></term>
 
-        <listitem><para>The bus to which message <parameter>call</parameter> is
-        attached is not connected.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus to which message <parameter>call</parameter> is
+          attached is not connected.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 9a890c6f3169cfffb01955bc3954eb2001fba2ad..61619304db9513fd53ffec4999f46246c6cc7311 100644 (file)
 
     <para>This function returns 0 if the message object was successfully created, and a negative
     errno-style error code otherwise.</para>
-  </refsect1>
 
-  <refsect1 id='errors'>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The output parameter <parameter>m</parameter> is
-        <constant>NULL</constant>.</para>
+          <listitem><para>The output parameter <parameter>m</parameter> is
+          <constant>NULL</constant>.</para>
 
-        <para>The <parameter>path</parameter> parameter is not a valid D-Bus path
-        (<literal>/an/object/path</literal>), the <parameter>interface</parameter> parameter is not
-        a valid D-Bus interface name (<literal>an.interface.name</literal>), or the
-        <parameter>member</parameter> parameter is not a valid D-Bus member
-        (<literal>Name</literal>).</para></listitem>
-      </varlistentry>
+          <para>The <parameter>path</parameter> parameter is not a valid D-Bus path
+          (<literal>/an/object/path</literal>), the <parameter>interface</parameter> parameter is not
+          a valid D-Bus interface name (<literal>an.interface.name</literal>), or the
+          <parameter>member</parameter> parameter is not a valid D-Bus member
+          (<literal>Name</literal>).</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOTCONN</constant></term>
+        <varlistentry>
+          <term><constant>-ENOTCONN</constant></term>
 
-        <listitem><para>The bus parameter <parameter>bus</parameter> is <constant>NULL</constant> or
-        the bus is not connected.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus parameter <parameter>bus</parameter> is <constant>NULL</constant> or
+          the bus is not connected.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 5e2f08ce9c5611b57b437f9a5b266f08c3e906fa..526fb0e70afec161b380b748f20af762b3dc2265 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>
-      On success, <function>sd_bus_message_read()</function> and
-      <function>sd_bus_message_readv()</function> return 0 or a positive integer. On
-      failure, they return a negative errno-style error code.
-    </para>
-  </refsect1>
+    <para>On success, <function>sd_bus_message_read()</function> and
+    <function>sd_bus_message_readv()</function> return 0 or a positive integer. On failure, they return a
+    negative errno-style error code.</para>
 
-  <xi:include href="sd_bus_message_read_basic.xml" xpointer="errors" />
+    <xi:include href="sd_bus_message_read_basic.xml" xpointer="errors" />
+  </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
 
index 6986b577552872f6cea739893206d3c512991eb9..117afa9e31e199483b28585454dcbd8aaa86935d 100644 (file)
       a positive integer. On failure, it returns a negative errno-style error
       code.
     </para>
-  </refsect1>
 
-  <refsect1 id='errors'>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>Specified type is invalid or the message parameter or one of the output
-        parameters are <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
+          <listitem><para>Specified type is invalid or the message parameter or one of the output
+          parameters are <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EOPNOTSUPP</constant></term>
+        <varlistentry>
+          <term><constant>-EOPNOTSUPP</constant></term>
 
-        <listitem><para>The byte order in the message is different than native byte
-        order.</para></listitem>
-      </varlistentry>
+          <listitem><para>The byte order in the message is different than native byte
+          order.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>The message is not sealed.</para></listitem>
-      </varlistentry>
+          <listitem><para>The message is not sealed.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EBADMSG</constant></term>
+        <varlistentry>
+          <term><constant>-EBADMSG</constant></term>
 
-        <listitem><para>The message cannot be parsed.</para></listitem>
-      </varlistentry>
+          <listitem><para>The message cannot be parsed.</para></listitem>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <refsect1>
index cbcd53f9b8ceb7bbfb7460a69a2283fb2f45de73..101f5d21a4998bf78cebf19314d8faa60ef85d55 100644 (file)
       a positive integer. On failure, it returns a negative errno-style error
       code.
     </para>
-  </refsect1>
 
-  <refsect1 id='errors'>
-    <title>Errors</title>
+    <refsect2 id='errors'>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>Specified type string is invalid or the message parameter is
-        <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
+          <listitem><para>Specified type string is invalid or the message parameter is
+          <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENXIO</constant></term>
+        <varlistentry>
+          <term><constant>-ENXIO</constant></term>
 
-        <listitem><para>The message does not contain the specified type at current
-        position.</para></listitem>
-      </varlistentry>
+          <listitem><para>The message does not contain the specified type at current position.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EBADMSG</constant></term>
+        <varlistentry>
+          <term><constant>-EBADMSG</constant></term>
 
-        <listitem><para>The message cannot be parsed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The message cannot be parsed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <refsect1>
index 0a4d0be80acc22bcf233ab0bab579721ac7e6d98..aa8aea987b5fc578b51890a53daa7e110126de1d 100644 (file)
       container or whole message in case no container is open is empty, and positive otherwise. On
       failure, it returns a negative errno-style error code.
     </para>
-  </refsect1>
-
-  <xi:include href="libsystemd-pkgconfig.xml" />
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The <parameter>m</parameter> parameter is <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
+          <listitem><para>The <parameter>m</parameter> parameter is <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>The message <parameter>m</parameter> has not been sealed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The message <parameter>m</parameter> has not been sealed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
+  <xi:include href="libsystemd-pkgconfig.xml" />
+
   <refsect1>
     <title>See Also</title>
 
index ed40bd24877b015047d0ab1bf854379cad338684..ca3e466d7a95e3e15cba6b0126fdd77ff695fdc3 100644 (file)
 
     <para>On success, these calls return 0 or a positive integer. On failure, these calls return a
     negative errno-style error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The <parameter>message</parameter> parameter or the output parameter are
-        <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
+          <listitem><para>The <parameter>message</parameter> parameter or the output parameter are
+          <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>For <function>sd_bus_message_set_destination</function> or
-        <function>sd_bus_message_set_sender</function>, the message is already
-        sealed.</para></listitem>
-      </varlistentry>
+          <listitem><para>For <function>sd_bus_message_set_destination</function> or
+          <function>sd_bus_message_set_sender</function>, the message is already
+          sealed.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EEXIST</constant></term>
+        <varlistentry>
+          <term><constant>-EEXIST</constant></term>
 
-        <listitem><para>The message already has a destination or sender field set.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The message already has a destination or sender field set.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 44f260da751d5a7b9e1f27fcd0e4cb03749d9e0f..6f22e82057f716882ed2dd071ce5e8afb4093139 100644 (file)
 
     <para>On success, these functions return 0 or a positive integer. On failure, they return a
     negative errno-style error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The <parameter>message</parameter> parameter is
-        <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
+          <listitem><para>The <parameter>message</parameter> parameter is
+          <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>The message <parameter>message</parameter> is sealed
-        when trying to set a flag.</para>
+          <listitem><para>The message <parameter>message</parameter> is sealed
+          when trying to set a flag.</para>
 
-        <para>The message <parameter>message</parameter> has wrong
-        type.</para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
+          <para>The message <parameter>message</parameter> has wrong
+          type.</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 9495f9409ed3e3e6af0d1998296df3cfe24eb5f1..0e740ab26152aedca449ece013d809ced121e6d9 100644 (file)
 
     <para>On success, <function>sd_bus_message_skip()</function> returns 0 or a positive integer. On
     failure, it returns a negative errno-style error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The <parameter>m</parameter> parameter is
-        <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
+          <listitem><para>The <parameter>m</parameter> parameter is
+          <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EBADMSG</constant></term>
+        <varlistentry>
+          <term><constant>-EBADMSG</constant></term>
 
-        <listitem><para>The message cannot be parsed.</para></listitem>
-      </varlistentry>
+          <listitem><para>The message cannot be parsed.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>The message is not sealed.</para></listitem>
-      </varlistentry>
+          <listitem><para>The message is not sealed.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENXIO</constant></term>
+        <varlistentry>
+          <term><constant>-ENXIO</constant></term>
 
-        <listitem><para>The message end has been reached and the requested elements cannot be read.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para>The message end has been reached and the requested elements cannot be read.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 1cf4df82e38698649d9e745af785ba89eac3c55e..c3230e583397ea589d04b8b243d9b8f373450c21 100644 (file)
     <para>On success, this call returns true if the type matches and zero if not (the message
     <parameter>m</parameter> contains different data or the end of the message has been reached). On
     failure, it returns a negative errno-style error code.</para>
-  </refsect1>
 
-  <refsect1 id='errors'>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para><parameter>m</parameter> or both <parameter>type</parameter> and
-        <parameter>contents</parameter> are <constant>NULL</constant>.</para>
+          <listitem><para><parameter>m</parameter> or both <parameter>type</parameter> and
+          <parameter>contents</parameter> are <constant>NULL</constant>.</para>
 
-        <para>Arguments do not satisfy other contraints listed above.</para>
-        </listitem>
-      </varlistentry>
+          <para>Arguments do not satisfy other contraints listed above.</para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>Message <parameter>m</parameter> is not sealed.
-        </para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Message <parameter>m</parameter> is not sealed.
+          </para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index ccbadb2b403059688e910b991c40b50c35744854..c12b65c983994249b4aec4f0eab478025f2cb660 100644 (file)
     <para>On success, these functions return 0 or a
     positive integer. On failure, they return a negative errno-style
     error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>The bus connection has already been started.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus connection has already been started.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 6a27109892262be829c76a47a94e7803316a2bcd..8506ee87e42c76efd26d9cd0620fd0dc4fe62ff2 100644 (file)
 
     <para><function>sd_bus_unref()</function> and <function>sd_bus_flush_close_unref()</function> always return
     <constant>NULL</constant>.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 51799459c277572e08b36d4bde4558d40f0b6f61..8f35388da3f0977f0e18ee19425f13559b3456b1 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>If progress was made, a positive integer is returned. If no progress was made, 0 is returned. If an error
-    occurs, a negative <varname>errno</varname>-style error code is returned.</para>
-  </refsect1>
+    <para>If progress was made, a positive integer is returned. If no progress was made, 0 is returned. If an
+    error occurs, a negative <varname>errno</varname>-style error code is returned.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An invalid bus object was passed.</para></listitem>
-      </varlistentry>
+          <listitem><para>An invalid bus object was passed.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection was allocated in a parent process and is being reused in a child process
-        after <function>fork()</function>.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus connection was allocated in a parent process and is being reused in a child
+          process after <function>fork()</function>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOTCONN</constant></term>
+        <varlistentry>
+          <term><constant>-ENOTCONN</constant></term>
 
-        <listitem><para>The bus connection has been terminated already.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus connection has been terminated already.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECONNRESET</constant></term>
+        <varlistentry>
+          <term><constant>-ECONNRESET</constant></term>
 
-        <listitem><para>The bus connection has been terminated just now.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus connection has been terminated just now.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EBUSY</constant></term>
+        <varlistentry>
+          <term><constant>-EBUSY</constant></term>
 
-        <listitem><para>This function is already being called, i.e. <function>sd_bus_process()</function> has been
-        called from a callback function that itself was called by
-        <function>sd_bus_process()</function>.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>This function is already being called, i.e. <function>sd_bus_process()</function>
+          has been called from a callback function that itself was called by
+          <function>sd_bus_process()</function>.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 77ac3c4b16db6122ce2987cd848efebdb324d5a6..5a6cef6badfae9bd5ac13e808226e52afea02c4b 100644 (file)
 
     <para>These functions return 0 if the error reply was successfully sent or if
     none was expected, and a negative errno-style error code otherwise.</para>
-  </refsect1>
 
-  <refsect1 id='errors'>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The call message <parameter>call</parameter> is
-        <constant>NULL</constant>.</para>
+          <listitem><para>The call message <parameter>call</parameter> is
+          <constant>NULL</constant>.</para>
 
-        <para>Message <parameter>call</parameter> is not a method call message.
-        </para>
+          <para>Message <parameter>call</parameter> is not a method call message.
+          </para>
 
-        <para>Message <parameter>call</parameter> is not attached to a bus.</para>
+          <para>Message <parameter>call</parameter> is not attached to a bus.</para>
 
-        <para>The error <parameter>error</parameter> parameter to
-        <function>sd_bus_reply_method_error</function> is not set, see
-        <citerefentry><refentrytitle>sd_bus_error_is_set</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
-        </para>
-        </listitem>
-      </varlistentry>
+          <para>The error <parameter>error</parameter> parameter to
+          <function>sd_bus_reply_method_error</function> is not set, see
+          <citerefentry><refentrytitle>sd_bus_error_is_set</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
+          </para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>Message <parameter>call</parameter> has been sealed.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para>Message <parameter>call</parameter> has been sealed.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOTCONN</constant></term>
+        <varlistentry>
+          <term><constant>-ENOTCONN</constant></term>
 
-        <listitem><para>The bus to which message <parameter>call</parameter> is
-        attached is not connected.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus to which message <parameter>call</parameter> is attached is not
+          connected.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
 
-    <para>In addition, any error message returned by
-    <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-    may be returned.</para>
+      <para>In addition, any error message returned by
+      <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+      may be returned.</para>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 0edba533faa8729b178966e3eba46a2b83aa06d3..0f6a4ec3137b3ac87ccb2f0340032004cfa3afc3 100644 (file)
     case, the caller can subscribe to <literal>NameOwnerChanged</literal> signals to be notified when the name is
     successfully acquired.  <function>sd_bus_request_name()</function> returns &gt; 0 when the name has immediately
     been acquired successfully.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EALREADY</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EALREADY</constant></term>
 
-        <listitem><para>The caller already is the owner of the specified name.</para></listitem>
-      </varlistentry>
+          <listitem><para>The caller already is the owner of the specified name.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EEXIST</constant></term>
+        <varlistentry>
+          <term><constant>-EEXIST</constant></term>
 
-        <listitem><para>The name has already been acquired by a different peer, and SD_BUS_NAME_REPLACE_EXISTING was
-        not specified or the other peer did not specify SD_BUS_NAME_ALLOW_REPLACEMENT while acquiring the
-        name.</para></listitem>
-      </varlistentry>
+          <listitem><para>The name has already been acquired by a different peer, and SD_BUS_NAME_REPLACE_EXISTING was
+          not specified or the other peer did not specify SD_BUS_NAME_ALLOW_REPLACEMENT while acquiring the
+          name.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESRCH</constant></term>
+        <varlistentry>
+          <term><constant>-ESRCH</constant></term>
 
-        <listitem><para>It was attempted to release a name that is currently not registered on the
-        bus.</para></listitem>
-      </varlistentry>
+          <listitem><para>It was attempted to release a name that is currently not registered on the
+          bus.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EADDRINUSE</constant></term>
+        <varlistentry>
+          <term><constant>-EADDRINUSE</constant></term>
 
-        <listitem><para>It was attempted to release a name that is owned by a different peer on the
-        bus.</para></listitem>
-      </varlistentry>
+          <listitem><para>It was attempted to release a name that is owned by a different peer on the
+          bus.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>A specified parameter is invalid. This is also generated when the requested name is a special
-        service name reserved by the D-Bus specification, or when the operation is requested on a connection that does
-        not refer to a bus.</para></listitem>
-      </varlistentry>
+          <listitem><para>A specified parameter is invalid. This is also generated when the requested name is
+          a special service name reserved by the D-Bus specification, or when the operation is requested on a
+          connection that does not refer to a bus.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOTCONN</constant></term>
+        <varlistentry>
+          <term><constant>-ENOTCONN</constant></term>
 
-        <listitem><para>The bus connection has been disconnected.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus connection has been disconnected.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection has been created in a different process than the current
-        one.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus connection has been created in a different process than the current
+          one.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index d0cafb5ae6ff57e384b7c2d26cf98dd2ecd5fcc2..751fc0a729e672e23a6cf9726b06f641f8472ec3 100644 (file)
 
     <para><function>sd_bus_get_close_on_exit()</function> returns 0 if the feature is currently turned off or a
     positive integer if it is on. On failure, it returns a negative errno-style error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection has been created in a different process.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus connection has been created in a different process.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 7915ee2199383d6caafc41cdfe106ede2b25c389..edb0df205a88ba1e08de355657c5d125e65e4d70 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
-    error code.</para>
-  </refsect1>
+    <para>On success, these functions return 0 or a positive integer. On failure, they return a negative
+    errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection has been created in a different process.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus connection has been created in a different process.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index d6ab590708478e4c179111b068db1a22ad6188c6..cfcebdfb29eb79472d38b209c432b15120078adb 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, these functions return 0 or a positive integer. On failure,
-    they return a negative errno-style error code.</para>
-  </refsect1>
+    <para>On success, these functions return 0 or a positive integer. On failure, they return a negative
+    errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An argument is invalid.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>An argument is invalid.</para></listitem>
+        </varlistentry>
+      </variablelist>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENOPKG</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENOPKG</constant></term>
 
-        <listitem><para>The bus cannot be resolved.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus cannot be resolved.</para></listitem>
+        </varlistentry>
+      </variablelist>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>The bus has already been started.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus has already been started.</para></listitem>
+        </varlistentry>
+      </variablelist>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus was created in a different process.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus was created in a different process.</para></listitem>
+        </varlistentry>
+      </variablelist>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
 
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index beaaf45eb45cced3b87fba96ba09c3395ce97d12..b3f67d9f917a97c892449946c39c3c19a2db38c7 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
-    error code.</para>
-  </refsect1>
+    <para>On success, these functions return 0 or a positive integer. On failure, they return a negative
+    errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection has been created in a different process.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus connection has been created in a different process.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EPERM</constant></term>
+        <varlistentry>
+          <term><constant>-EPERM</constant></term>
 
-        <listitem><para>The specified bus connection object is a not a direct but a brokered connection.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The specified bus connection object is a not a direct but a brokered
+          connection.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index a05931eaf82e41d209b6684ba3ec89f018fdf2f4..cbdc7dd1eda47d3dc1f6ec88434615e179adf439 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
-    error code.</para>
-  </refsect1>
+    <para>On success, these functions return 0 or a positive integer. On failure, they return a negative
+    errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection has been created in a different process.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus connection has been created in a different process.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 11bcbc81cedead1bb6a58a002bd1ea6d3962f955..13dd6f8815820cb943de540e624f3b1fc0294f92 100644 (file)
 
     <para>On success, these functions return 0 or a positive integer. On failure,
     they return a negative errno-style error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An required argument is <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>An required argument is <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
+      </variablelist>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENXIO</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENXIO</constant></term>
 
-        <listitem><para>The bus slot object has no description.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus slot object has no description.</para></listitem>
+        </varlistentry>
+      </variablelist>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
 
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index c054e89a691bea0b8a6d3d8dc7b09597900ca10e..c6fe72e37b5ff541488db1cb523793d3678de9d2 100644 (file)
     <title>Return Value</title>
 
     <para>On success, <function>sd_bus_slot_set_destroy_callback()</function> and
-    <function>sd_bus_track_set_destroy_callback()</function> return 0 or a positive integer. On failure, they return a
-    negative errno-style error code.</para>
+    <function>sd_bus_track_set_destroy_callback()</function> return 0 or a positive integer. On failure, they
+    return a negative errno-style error code.</para>
 
     <para><function>sd_bus_slot_get_destroy_callback()</function> and
-    <function>sd_bus_track_get_destroy_callback()</function> return positive if the destroy callback function is set, 0
-    if not. On failure, they return a negative errno-style error code.</para>
-  </refsect1>
+    <function>sd_bus_track_get_destroy_callback()</function> return positive if the destroy callback function
+    is set, 0 if not. On failure, they return a negative errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The <parameter>slot</parameter> or <parameter>track</parameter> parameter is
-        <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The <parameter>slot</parameter> or <parameter>track</parameter> parameter is
+          <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index d0d75c01268be7f68aad8d228a6541dc935eecc4..f63907aa405f48702cede38f0db8b19bd5b065d6 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
-    error code.</para>
-  </refsect1>
+    <para>On success, these functions return 0 or a positive integer. On failure, they return a negative
+    errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The <parameter>slot</parameter> parameter is <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
+          <listitem><para>The <parameter>slot</parameter> parameter is <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection has been created in a different process.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus connection has been created in a different process.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The bus object the specified bus slot object is associated with has already been freed, and
-        hence no change in the floating state can be made anymore.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus object the specified bus slot object is associated with has already been
+          freed, and hence no change in the floating state can be made anymore.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index ba315451d36ea9590c820424ed041442bab04506..29501adf57da062154409e3074d2ae567df9cefb 100644 (file)
     <para><function>sd_bus_track_first()</function> and <function>sd_bus_track_next()</function> return the first/next
     name contained in the bus peer tracking object, and <constant>NULL</constant> if the end of the enumeration is
     reached and on error.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-EUNATCH</constant></term>
+        <varlistentry>
+          <term><constant>-EUNATCH</constant></term>
 
-        <listitem><para><function>sd_bus_track_remove_name()</function> or
-        <function>sd_bus_track_remove_sender()</function> have been invoked for a name not previously added to the bus
-        peer object.</para></listitem>
-      </varlistentry>
+          <listitem><para><function>sd_bus_track_remove_name()</function> or
+          <function>sd_bus_track_remove_sender()</function> have been invoked for a name not previously added
+          to the bus peer object.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>Specified parameter is invalid.</para></listitem>
-      </varlistentry>
+          <listitem><para>Specified parameter is invalid.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 1d19c1f9a68ddebb1cd77b53a641d233e8afb9f1..9b79eb4c2dad4673ef60e85592ccf9b1b1ce0a3b 100644 (file)
     reference. When not needed anymore, this reference should be destroyed with
     <function>sd_bus_track_unref()</function>.
     </para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-EBUSY</constant></term>
+        <varlistentry>
+          <term><constant>-EBUSY</constant></term>
 
-        <listitem><para>Bus peers have already been added to the bus peer tracking object and
-        <function>sd_bus_track_set_recursive()</function> was called to change tracking mode.</para></listitem>
-      </varlistentry>
+          <listitem><para>Bus peers have already been added to the bus peer tracking object and
+          <function>sd_bus_track_set_recursive()</function> was called to change tracking mode.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>Specified parameter is invalid
-        (<constant>NULL</constant> in case of output
-        parameters).</para></listitem>
-      </varlistentry>
+          <listitem><para>Specified parameter is invalid
+          (<constant>NULL</constant> in case of output
+          parameters).</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 522defb36255a5fa80df1a188ae61353a40faab0..7b97dc02fdd9be397cad8c682256d78972fe99e6 100644 (file)
 
     <para>If any I/O was seen, a positive value is returned, zero otherwise. If an error occurs, a negative
     <varname>errno</varname>-style error code is returned.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An invalid bus object was passed.</para></listitem>
-      </varlistentry>
+          <listitem><para>An invalid bus object was passed.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The bus connection was allocated in a parent process and is being reused in a child process
-        after <function>fork()</function>.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus connection was allocated in a parent process and is being reused in a child
+          process after <function>fork()</function>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOTCONN</constant></term>
+        <varlistentry>
+          <term><constant>-ENOTCONN</constant></term>
 
-        <listitem><para>The bus connection has been terminated already.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The bus connection has been terminated already.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index b19620b72eb288ea32026c6fa16cecb6a9a03802..23fa78ea7294e9a3e239ac06cb85058021f69f9b 100644 (file)
     <para>On success, these functions return 0 or a positive
     integer. On failure, they return a negative errno-style error
     code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory to allocate an object.</para></listitem>
-      </varlistentry>
+          <listitem><para>Not enough memory to allocate an object.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An invalid argument has been passed. This includes
-        specifying an empty mask in <parameter>options</parameter> or a mask
-        which contains values different than a combination of
-        <constant>WEXITED</constant>, <constant>WSTOPPED</constant>, and
-        <constant>WCONTINUED</constant>.
-        </para></listitem>
+          <listitem><para>An invalid argument has been passed. This includes
+          specifying an empty mask in <parameter>options</parameter> or a mask
+          which contains values different than a combination of
+          <constant>WEXITED</constant>, <constant>WSTOPPED</constant>, and
+          <constant>WCONTINUED</constant>.
+          </para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EBUSY</constant></term>
+        <varlistentry>
+          <term><constant>-EBUSY</constant></term>
 
-        <listitem><para>A handler is already installed for this
-        child process.</para></listitem>
+          <listitem><para>A handler is already installed for this
+          child process.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop is already terminated.</para></listitem>
+          <listitem><para>The event loop is already terminated.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EDOM</constant></term>
+        <varlistentry>
+          <term><constant>-EDOM</constant></term>
 
-        <listitem><para>The passed event source is not a child process event source.</para></listitem>
-      </varlistentry>
+          <listitem><para>The passed event source is not a child process event source.</para></listitem>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 891aa709b28bb0c16a2ee3467728e0f44705afc8..636c61e99c8de1485d2e0a5e272983bb1d719a81 100644 (file)
     <para>On success, these functions return 0 or a positive
     integer. On failure, they return a negative errno-style error
     code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory to allocate an object.</para></listitem>
-      </varlistentry>
+          <listitem><para>Not enough memory to allocate an object.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An invalid argument has been passed.</para></listitem>
-      </varlistentry>
+          <listitem><para>An invalid argument has been passed.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop is already terminated.</para></listitem>
-      </varlistentry>
+          <listitem><para>The event loop is already terminated.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
-      </varlistentry>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 2ab1ca236d283a61af52b9fccdf9aecdd3181e05..3c9f2fbe3eb6d1511e52c6dedd57b7b28c52930c 100644 (file)
 
     <para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
     error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory to allocate an object.</para></listitem>
-      </varlistentry>
+          <listitem><para>Not enough memory to allocate an object.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An invalid argument has been passed. This includes specifying a mask with
-        <constant>IN_MASK_ADD</constant> set.</para></listitem>
-      </varlistentry>
+          <listitem><para>An invalid argument has been passed. This includes specifying a mask with
+          <constant>IN_MASK_ADD</constant> set.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop is already terminated.</para></listitem>
+          <listitem><para>The event loop is already terminated.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EDOM</constant></term>
+        <varlistentry>
+          <term><constant>-EDOM</constant></term>
 
-        <listitem><para>The passed event source is not an inotify process event source.</para></listitem>
-      </varlistentry>
+          <listitem><para>The passed event source is not an inotify process event source.</para></listitem>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <refsect1>
index 0d6b4be3af29cba262b32654978f211c023eae93..4f2b09bf59f17cbe35533c8e166a190af3c758bd 100644 (file)
     <para>On success, these functions return 0 or a positive
     integer. On failure, they return a negative errno-style error
     code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned values may indicate the following problems:</para>
+      <para>Returned values may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory to allocate an object.</para></listitem>
-      </varlistentry>
+          <listitem><para>Not enough memory to allocate an object.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An invalid argument has been passed.</para></listitem>
+          <listitem><para>An invalid argument has been passed.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop is already terminated.</para></listitem>
+          <listitem><para>The event loop is already terminated.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
-      </varlistentry>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EDOM</constant></term>
+        <varlistentry>
+          <term><constant>-EDOM</constant></term>
 
-        <listitem><para>The passed event source is not an I/O event source.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The passed event source is not an I/O event source.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index d68923fe9a4543e9036d33f8723c55d9c8392c25..9bf777c10714e9281aa5550dc0a0fcf7505d22fb 100644 (file)
     <para>On success, these functions return 0 or a positive
     integer. On failure, they return a negative errno-style error
     code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory to allocate an object.</para></listitem>
-      </varlistentry>
+          <listitem><para>Not enough memory to allocate an object.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An invalid argument has been passed.</para></listitem>
-      </varlistentry>
+          <listitem><para>An invalid argument has been passed.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EBUSY</constant></term>
+        <varlistentry>
+          <term><constant>-EBUSY</constant></term>
 
-        <listitem><para>A handler is already installed for this
-        signal or the signal was not blocked previously.</para></listitem>
-      </varlistentry>
+          <listitem><para>A handler is already installed for this
+          signal or the signal was not blocked previously.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop is already terminated.</para></listitem>
-      </varlistentry>
+          <listitem><para>The event loop is already terminated.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
-      </varlistentry>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EDOM</constant></term>
+        <varlistentry>
+          <term><constant>-EDOM</constant></term>
 
-        <listitem><para>The passed event source is not a signal event source.</para></listitem>
-      </varlistentry>
+          <listitem><para>The passed event source is not a signal event source.</para></listitem>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index f99c8569e36debf6a104fc936c07c4971860f0f2..731636451c7265f3df9ad9bbce1a6665fd02d993 100644 (file)
     <para>On success, these functions return 0 or a positive
     integer. On failure, they return a negative errno-style error
     code. </para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned values may indicate the following problems:</para>
+      <para>Returned values may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory to allocate an object.</para></listitem>
-      </varlistentry>
+          <listitem><para>Not enough memory to allocate an object.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An invalid argument has been passed.</para></listitem>
+          <listitem><para>An invalid argument has been passed.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop is already terminated.</para></listitem>
+          <listitem><para>The event loop is already terminated.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EOPNOTSUPP</constant></term>
+        <varlistentry>
+          <term><constant>-EOPNOTSUPP</constant></term>
 
-        <listitem><para>The selected clock is not supported by the event loop implementation.</para></listitem>
+          <listitem><para>The selected clock is not supported by the event loop implementation.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EDOM</constant></term>
+        <varlistentry>
+          <term><constant>-EDOM</constant></term>
 
-        <listitem><para>The passed event source is not a timer event source.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The passed event source is not a timer event source.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 17cb9d2f5377935848e2f572ed8511a540e0d291..a02897af0b3a7cca679aae34abac9c3640503b06 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, <function>sd_event_exit()</function> and
-    <function>sd_event_get_exit_code()</function> return 0 or a positive
-    integer. On failure, they return a negative errno-style error
-    code.</para>
-  </refsect1>
+    <para>On success, <function>sd_event_exit()</function> and <function>sd_event_get_exit_code()</function>
+    return 0 or a positive integer. On failure, they return a negative errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The event loop object or error code pointer are invalid.</para></listitem>
+          <listitem><para>The event loop object or error code pointer are invalid.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop was created in a different process.</para></listitem>
-      </varlistentry>
+          <listitem><para>The event loop was created in a different process.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop has exited already and all exit handlers are already processed.</para></listitem>
-      </varlistentry>
+          <listitem><para>The event loop has exited already and all exit handlers are already processed.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENODATA</constant></term>
+        <varlistentry>
+          <term><constant>-ENODATA</constant></term>
 
-        <listitem><para>The event loop has not been requested to exit yet.</para></listitem>
-      </varlistentry>
+          <listitem><para>The event loop has not been requested to exit yet.</para></listitem>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 5575b8319646abc48a511b0e7e822fa2e6cc59f5..3e78182137542ba7418121257aa696cc3e8f55d9 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, <function>sd_event_get_fd()</function> returns a
-    non-negative file descriptor. On failure, it returns a negative
-    errno-style error code.</para>
-  </refsect1>
+    <para>On success, <function>sd_event_get_fd()</function> returns a non-negative file descriptor. On
+    failure, it returns a negative errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para><parameter>event</parameter> is not a valid
-        pointer to an <structname>sd_event</structname> structure.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para><parameter>event</parameter> is not a valid pointer to an
+          <structname>sd_event</structname> structure.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
 
-      </varlistentry>
-    </variablelist>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <refsect1>
index b37aeca7b2c1ea9b506b5b229b26f21c2c6e29a4..3db39c9d06bfdeaf824e4966e294045f279f8e64 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, <function>sd_event_new()</function>,
-    <function>sd_event_default()</function> and
-    <function>sd_event_get_tid()</function> return 0 or a positive
-    integer. On failure, they return a negative errno-style error
-    code. <function>sd_event_ref()</function> always returns a pointer
-    to the event loop object passed
-    in. <function>sd_event_unref()</function> always returns
+    <para>On success, <function>sd_event_new()</function>, <function>sd_event_default()</function> and
+    <function>sd_event_get_tid()</function> return 0 or a positive integer. On failure, they return a
+    negative errno-style error code. <function>sd_event_ref()</function> always returns a pointer to the
+    event loop object passed in. <function>sd_event_unref()</function> always returns
     <constant>NULL</constant>.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory to allocate the object.</para></listitem>
-      </varlistentry>
+          <listitem><para>Not enough memory to allocate the object.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EMFILE</constant></term>
+        <varlistentry>
+          <term><constant>-EMFILE</constant></term>
 
-        <listitem><para>The maximum number of event loops has been allocated.</para></listitem>
+          <listitem><para>The maximum number of event loops has been allocated.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENXIO</constant></term>
+        <varlistentry>
+          <term><constant>-ENXIO</constant></term>
 
-        <listitem><para><function>sd_event_get_tid()</function> was
-        invoked on an event loop object that was not allocated with
-        <function>sd_event_default()</function>.</para></listitem>
-      </varlistentry>
+          <listitem><para><function>sd_event_get_tid()</function> was invoked on an event loop object that
+          was not allocated with <function>sd_event_default()</function>.</para></listitem>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 9d64402f0b845f1f719781eb9227bc8f98b67d67..2d2b085015f5597954479271de2218841884db37 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>If the first event loop iteration has not run yet
-    <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>
+    <para>If the first event loop iteration has not run yet <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>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned values may indicate the following problems:</para>
+      <para>Returned values may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An invalid parameter was
-        passed.</para></listitem>
+          <listitem><para>An invalid parameter was passed.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EOPNOTSUPP</constant></term>
+        <varlistentry>
+          <term><constant>-EOPNOTSUPP</constant></term>
 
-        <listitem><para>Unsupported clock type.
-        </para></listitem>
-      </varlistentry>
+          <listitem><para>Unsupported clock type.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop object was created in a
-        different process.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The event loop object was created in a different process.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 245df3cd22014afaa7a116fd829f9a74451db33b..5c33d61fdf05d6d3518f0a2905f4df057087ad09 100644 (file)
     dispatched. <function>sd_event_loop()</function> returns the exit
     code specified when invoking
     <function>sd_event_exit()</function>.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The <parameter>event</parameter> parameter is
-        invalid or <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
+          <listitem><para>The <parameter>event</parameter> parameter is invalid or
+          <constant>NULL</constant>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EBUSY</constant></term>
+        <varlistentry>
+          <term><constant>-EBUSY</constant></term>
 
-        <listitem><para>The event loop object is not in the right
-        state (see
-        <citerefentry><refentrytitle>sd_event_prepare</refentrytitle><manvolnum>3</manvolnum></citerefentry>
-        for an explanation of possible states).</para></listitem>
-      </varlistentry>
+          <listitem><para>The event loop object is not in the right
+          state (see
+          <citerefentry><refentrytitle>sd_event_prepare</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+          for an explanation of possible states).</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop is already terminated.</para></listitem>
+          <listitem><para>The event loop is already terminated.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
 
-    <para>Other errors are possible, too.</para>
+      <para>Other errors are possible, too.</para>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 27bbd66682053efb6c28d482dcf8b7e7acda711a..faaaad39d967496c9a0bd12b1e2192a20108c66d 100644 (file)
     <title>Return Value</title>
 
     <para>On success, <function>sd_event_set_watchdog()</function> and
-    <function>sd_event_get_watchdog()</function> return a non-zero
-    positive integer if the service manager requested watchdog support
-    and watchdog support was successfully enabled. They return zero if
-    the service manager did not request watchdog support, or if
-    watchdog support was explicitly disabled with a false
-    <parameter>b</parameter> parameter. On failure, they return a
-    negative errno-style error
-    code.</para>
-  </refsect1>
+    <function>sd_event_get_watchdog()</function> return a non-zero positive integer if the service manager
+    requested watchdog support and watchdog support was successfully enabled. They return zero if the service
+    manager did not request watchdog support, or if watchdog support was explicitly disabled with a false
+    <parameter>b</parameter> parameter. On failure, they return a negative errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
-      </varlistentry>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The passed event loop object was invalid.</para></listitem>
-      </varlistentry>
+          <listitem><para>The passed event loop object was invalid.</para></listitem>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index dd07a46942496a6bff6767804ac6e080fb62cb04..603d4ad3775abc8d152cbda024bb6f28d9c3d5e6 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success,
-    <function>sd_event_source_get_pending()</function> returns an
-    integer greater than zero when the event source is marked pending,
-    and zero when the event source is not marked pending. On failure,
-    it returns a negative errno-style error code.</para>
-  </refsect1>
+    <para>On success, <function>sd_event_source_get_pending()</function> returns an integer greater than zero
+    when the event source is marked pending, and zero when the event source is not marked pending. On
+    failure, it returns a negative errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para><parameter>source</parameter> is not a valid
-        pointer to an <structname>sd_event_source</structname>
-        object.</para></listitem>
-      </varlistentry>
+          <listitem><para><parameter>source</parameter> is not a valid pointer to an
+          <structname>sd_event_source</structname> object.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EDOM</constant></term>
+        <varlistentry>
+          <term><constant>-EDOM</constant></term>
 
-        <listitem><para><parameter>source</parameter> refers to an
-        event source object created with
-        <citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
-      </varlistentry>
+          <listitem><para><parameter>source</parameter> refers to an event source object created with
+          <citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory.</para></listitem>
-      </varlistentry>
+          <listitem><para>Not enough memory.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop is already terminated.</para></listitem>
+          <listitem><para>The event loop is already terminated.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index d2ce7359753555a8f549c69549292fb803bd6b4a..717cc5be9e6adef9d031f74d62f4229f93f52800 100644 (file)
     <title>Return Value</title>
 
     <para>On success, <function>sd_event_source_set_description()</function> and
-    <function>sd_event_source_get_description()</function> return a
-    non-negative integer. On failure, they return a negative
-    errno-style error code.</para>
-  </refsect1>
+    <function>sd_event_source_get_description()</function> return a non-negative integer. On failure, they
+    return a negative errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para><parameter>source</parameter> is not a valid
-        pointer to an <structname>sd_event_source</structname>
-        object or the <parameter>description</parameter> argument for
-        <function>sd_event_source_get_description()</function> is
-        <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
+          <listitem><para><parameter>source</parameter> is not a valid pointer to an
+          <structname>sd_event_source</structname> object or the <parameter>description</parameter> argument
+          for <function>sd_event_source_get_description()</function> is <constant>NULL</constant>.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory to copy the
-        name.</para></listitem>
-      </varlistentry>
+          <listitem><para>Not enough memory to copy the name.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENXIO</constant></term>
+        <varlistentry>
+          <term><constant>-ENXIO</constant></term>
 
-        <listitem><para>No name was set for the event
-        source.</para></listitem>
-      </varlistentry>
+          <listitem><para>No name was set for the event source.</para></listitem>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index f3ebf0cc3a44d5541200d760be96c266b131f02d..2ffca9ec365bcec45c80619611c4da955763f292 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, <function>sd_event_source_set_destroy_callback()</function> returns 0 or a positive integer. On
-    failure, it returns a negative errno-style error code.</para>
+    <para>On success, <function>sd_event_source_set_destroy_callback()</function> returns 0 or a positive
+    integer. On failure, it returns a negative errno-style error code.</para>
 
-    <para><function>sd_event_source_get_destroy_callback()</function> returns positive if the destroy callback function
-    is set, 0 if not. On failure, returns a negative errno-style error code.</para>
-  </refsect1>
+    <para><function>sd_event_source_get_destroy_callback()</function> returns positive if the destroy
+    callback function is set, 0 if not. On failure, returns a negative errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The <parameter>source</parameter> parameter is <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>The <parameter>source</parameter> parameter is <constant>NULL</constant>.
+          </para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 699fffcdbcc7ea922deeb17ea15c5ac488f50118..6a7a39b4276c6617b34e725f882b88a06dec55df 100644 (file)
     <title>Return Value</title>
 
     <para>On success, <function>sd_event_source_set_enabled()</function> returns a non-negative
-    integer. <function>sd_event_source_get_enabled()</function> returns zero if the source is
-    disabled (<constant>SD_EVENT_OFF</constant>) and a positive integer otherwise. On failure, they
-    return a negative errno-style error code.</para>
-  </refsect1>
+    integer. <function>sd_event_source_get_enabled()</function> returns zero if the source is disabled
+    (<constant>SD_EVENT_OFF</constant>) and a positive integer otherwise. On failure, they return a negative
+    errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para><parameter>source</parameter> is not a valid
-        pointer to an <structname>sd_event_source</structname>
-        object.</para></listitem>
-      </varlistentry>
+          <listitem><para><parameter>source</parameter> is not a valid pointer to an
+          <structname>sd_event_source</structname> object.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory.</para></listitem>
-      </varlistentry>
+          <listitem><para>Not enough memory.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index f54bfb8a369e07f8325d73acee026dc27ad65cca..63c33ca19e41f9a5c3f04480fa0c367ca709ece2 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success,
-    <function>sd_event_source_set_prepare()</function> returns a
-    non-negative integer. On failure, it returns a negative
-    errno-style error code.</para>
-  </refsect1>
+    <para>On success, <function>sd_event_source_set_prepare()</function> returns a non-negative integer. On
+    failure, it returns a negative errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para><parameter>source</parameter> is not a valid
-        pointer to an <structname>sd_event_source</structname>
-        object.</para></listitem>
-      </varlistentry>
+          <listitem><para><parameter>source</parameter> is not a valid pointer to an
+          <structname>sd_event_source</structname> object.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop is already terminated.</para></listitem>
+          <listitem><para>The event loop is already terminated.</para></listitem>
 
-      </varlistentry>
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        </varlistentry>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory.</para></listitem>
-      </varlistentry>
+          <listitem><para>Not enough memory.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EDOM</constant></term>
+        <varlistentry>
+          <term><constant>-EDOM</constant></term>
 
-        <listitem><para>The specified event source has been created
-        with
-        <citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
+          <listitem><para>The specified event source has been created with
+          <citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index c17235958baee013406ef1ce630fe045038e7726..d1cb416dcb220afcc87deff1c17fb9fb46443a6d 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success,
-    <function>sd_event_source_set_priority()</function> and
-    <function>sd_event_source_get_priority()</function> return a
-    non-negative integer. On failure, they return a negative
-    errno-style error code.</para>
-  </refsect1>
+    <para>On success, <function>sd_event_source_set_priority()</function> and
+    <function>sd_event_source_get_priority()</function> return a non-negative integer. On failure, they
+    return a negative errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para><parameter>source</parameter> is not a valid
-        pointer to an <structname>sd_event_source</structname>
-        object.</para></listitem>
-      </varlistentry>
+          <listitem><para><parameter>source</parameter> is not a valid pointer to an
+          <structname>sd_event_source</structname> object.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory.</para></listitem>
-      </varlistentry>
+          <listitem><para>Not enough memory.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop is already terminated.</para></listitem>
+          <listitem><para>The event loop is already terminated.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 8e287e6a9f497256893f3b53cee58baf08d446e7..210a0c948d02d8b36a9b4b1b74cbd75d701d55b6 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, these functions return 0 or a positive integer.
-    On failure, they return a negative errno-style error code. In case
-    of <function>sd_event_prepare()</function> and
-    <function>sd_event_wait()</function>, a positive, non-zero return
-    code indicates that events are ready to be processed and zero
-    indicates that no events are ready. In case of
-    <function>sd_event_dispatch()</function>, a positive, non-zero
-    return code indicates that the event loop returned to its initial
-    state and zero indicates the event loop has
-    exited. <function>sd_event_get_state()</function> returns a
-    positive or zero state on success.</para>
-  </refsect1>
+    <para>On success, these functions return 0 or a positive integer.  On failure, they return a negative
+    errno-style error code. In case of <function>sd_event_prepare()</function> and
+    <function>sd_event_wait()</function>, a positive, non-zero return code indicates that events are ready to
+    be processed and zero indicates that no events are ready. In case of
+    <function>sd_event_dispatch()</function>, a positive, non-zero return code indicates that the event loop
+    returned to its initial state and zero indicates the event loop has
+    exited. <function>sd_event_get_state()</function> returns a positive or zero state on success.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The <parameter>event</parameter> parameter is
-        invalid or <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
+          <listitem><para>The <parameter>event</parameter> parameter is invalid or <constant>NULL</constant>.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EBUSY</constant></term>
+        <varlistentry>
+          <term><constant>-EBUSY</constant></term>
 
-        <listitem><para>The event loop object is not in the right
-        state.</para></listitem>
-      </varlistentry>
+          <listitem><para>The event loop object is not in the right state.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop is already terminated.</para></listitem>
+          <listitem><para>The event loop is already terminated.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
 
-    <para>Other errors are possible, too.</para>
+      <para>Other errors are possible, too.</para>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index f52e816d2222680b0f8d73e35a4b12857eaba7cf..ed4b77b3ea5ccf00bb9d90440ed09b00734fb5bc 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, <function>sd_get_seats()</function>,
-    <function>sd_get_sessions()</function>,
-    <function>sd_get_uids()</function> and
-    <function>sd_get_machine_names()</function> return the number of
-    entries in the arrays. On failure, these calls return a negative
-    errno-style error code.</para>
-  </refsect1>
+    <para>On success, <function>sd_get_seats()</function>, <function>sd_get_sessions()</function>,
+    <function>sd_get_uids()</function> and <function>sd_get_machine_names()</function> return the number of
+    entries in the arrays. On failure, these calls return a negative errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 317981a655ac25fd08a02c67097cd3f84e3b5d54..be1c843ee097a8a28fda34a80ea9fb249978bdd7 100644 (file)
@@ -206,29 +206,28 @@ else {
 
     <para><function>sd_login_monitor_unref()</function>
     always returns <constant>NULL</constant>.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An input parameter was invalid (out of range,
-        or NULL, where that is not accepted). The specified category to
-        watch is not known.</para></listitem>
-      </varlistentry>
+          <listitem><para>An input parameter was invalid (out of range, or <constant>NULL</constant>, where
+          that is not accepted). The specified category to watch is not known.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 5fdc759010484ca1568fa6d6238d4134c9f74366..db6cf0dbc09b30c8a3244d419507e39b22f2f44d 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, these calls return 0 or a positive integer. On
-    failure, these calls return a negative errno-style error
-    code.</para>
-  </refsect1>
+    <para>On success, these calls return 0 or a positive integer. On failure, these calls return a negative
+    errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-ENXIO</constant></term>
+        <varlistentry>
+          <term><constant>-ENXIO</constant></term>
 
-        <listitem><para>The specified machine does not exist or is currently not running.</para>
-        </listitem>
-      </varlistentry>
+          <listitem><para>The specified machine does not exist or is currently not running.</para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An input parameter was invalid (out of range,
-        or NULL, where that is not accepted).</para></listitem>
-      </varlistentry>
+          <listitem><para>An input parameter was invalid (out of range, or <constant>NULL</constant>, where
+          that is not accepted).</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index ead2f757f941d3842ea23ebb15b89daafda33cad..e9d7a8eb696899aa4119f66233c7b9ff78a58541 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, these calls return 0 or a positive integer. On
-    failure, these calls return a negative errno-style error
-    code.</para>
-  </refsect1>
+    <para>On success, these calls return 0 or a positive integer. On failure, these calls return a negative
+    errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-ESRCH</constant></term>
+        <varlistentry>
+          <term><constant>-ESRCH</constant></term>
 
-        <listitem><para>The specified PID does not refer to a running
-        process.</para>
-        </listitem>
-      </varlistentry>
+          <listitem><para>The specified PID does not refer to a running process.</para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EBADF</constant></term>
+        <varlistentry>
+          <term><constant>-EBADF</constant></term>
 
-        <listitem><para>The specified socket file descriptor was
-        invalid.</para></listitem>
-      </varlistentry>
+          <listitem><para>The specified socket file descriptor was invalid.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENODATA</constant></term>
+        <varlistentry>
+          <term><constant>-ENODATA</constant></term>
 
-        <listitem><para>The given field is not specified for the described
-        process or peer.</para>
-        </listitem>
-      </varlistentry>
+          <listitem><para>The given field is not specified for the described process or peer.</para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An input parameter was invalid (out of range,
-        or NULL, where that is not accepted).</para></listitem>
-      </varlistentry>
+          <listitem><para>An input parameter was invalid (out of range, or <constant>NULL</constant>, where
+          that is not accepted).</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <refsect1>
index 6e1cba11639bd41123d386ded1e8ca68b5b12d77..2dba6803f1e48962435207aeb4da7aa453f09c29 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para> On success, <function>sd_seat_get_active()</function>
-    returns 0 or a positive integer. On success,
-    <function>sd_seat_get_sessions()</function> returns the number of
-    entries in the session identifier array. If the test succeeds,
-    <function>sd_seat_can_multi_session</function>,
-    <function>sd_seat_can_tty</function> and
-    <function>sd_seat_can_graphical</function> return a positive
-    integer, if it fails 0. On failure, these calls return a negative
-    errno-style error code.</para>
-  </refsect1>
+    <para> On success, <function>sd_seat_get_active()</function> returns 0 or a positive integer. On success,
+    <function>sd_seat_get_sessions()</function> returns the number of entries in the session identifier
+    array. If the test succeeds, <function>sd_seat_can_multi_session</function>,
+    <function>sd_seat_can_tty</function> and <function>sd_seat_can_graphical</function> return a positive
+    integer, if it fails 0. On failure, these calls return a negative errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-ENODATA</constant></term>
+        <varlistentry>
+          <term><constant>-ENODATA</constant></term>
 
-        <listitem><para>The given field is not specified for the described
-        seat.</para>
-        </listitem>
-      </varlistentry>
+          <listitem><para>The given field is not specified for the described seat.</para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENXIO</constant></term>
+        <varlistentry>
+          <term><constant>-ENXIO</constant></term>
 
-        <listitem><para>The specified seat is unknown.</para>
-        </listitem>
-      </varlistentry>
+          <listitem><para>The specified seat is unknown.</para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An input parameter was invalid (out of range,
-        or NULL, where that is not accepted).</para></listitem>
-      </varlistentry>
+          <listitem><para>An input parameter was invalid (out of range, or <constant>NULL</constant>, where
+          that is not accepted).</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 4e2e31ea1b727a23ba1a42937c8cc11d4aa1951e..d4a12f533c04cfafe4a129a4d773ec1fb7f45184 100644 (file)
     <function>sd_session_get_tty()</function> return 0 or
     a positive integer. On failure, these calls return a
     negative errno-style error code.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-ENXIO</constant></term>
+        <varlistentry>
+          <term><constant>-ENXIO</constant></term>
 
-        <listitem><para>The specified session does not exist.</para>
-        </listitem>
-      </varlistentry>
+          <listitem><para>The specified session does not exist.</para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENODATA</constant></term>
+        <varlistentry>
+          <term><constant>-ENODATA</constant></term>
 
-        <listitem><para>The given field is not specified for the described
-        session.</para>
-        </listitem>
-      </varlistentry>
+          <listitem><para>The given field is not specified for the described session.</para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An input parameter was invalid (out of range,
-        or NULL, where that is not accepted).</para></listitem>
-      </varlistentry>
+          <listitem><para>An input parameter was invalid (out of range, or <constant>NULL</constant>, where
+          that is not accepted).</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />
index 8c4bf014e06c14617fda604b359a720c145dd96b..ed38559bb37f80709c1307478c475dec6b9b4e9b 100644 (file)
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, <function>sd_uid_get_state()</function> returns
-    0 or a positive integer. If the test succeeds,
-    <function>sd_uid_is_on_seat()</function> returns a positive
-    integer; if it fails, 0.
-    <function>sd_uid_get_sessions()</function> and
-    <function>sd_uid_get_seats()</function> return the number of
-    entries in the returned arrays.
-    <function>sd_uid_get_display()</function> returns a non-negative
-    code on success. On failure, these calls return a negative
-    errno-style error code.</para>
-  </refsect1>
+    <para>On success, <function>sd_uid_get_state()</function> returns 0 or a positive integer. If the test
+    succeeds, <function>sd_uid_is_on_seat()</function> returns a positive integer; if it fails, 0.
+    <function>sd_uid_get_sessions()</function> and <function>sd_uid_get_seats()</function> return the number
+    of entries in the returned arrays. <function>sd_uid_get_display()</function> returns a non-negative code
+    on success. On failure, these calls return a negative errno-style error code.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
+      <variablelist>
 
-      <varlistentry>
-        <term><constant>-ENODATA</constant></term>
+        <varlistentry>
+          <term><constant>-ENODATA</constant></term>
 
-        <listitem><para>The given field is not specified for the described
-        user.</para>
-        </listitem>
-      </varlistentry>
+          <listitem><para>The given field is not specified for the described user.</para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENXIO</constant></term>
+        <varlistentry>
+          <term><constant>-ENXIO</constant></term>
 
-        <listitem><para>The specified seat is unknown.</para>
-        </listitem>
-      </varlistentry>
+          <listitem><para>The specified seat is unknown.</para>
+          </listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>An input parameter was invalid (out of range,
-        or NULL, where that is not accepted). This is also returned if
-        the passed user ID is 0xFFFF or 0xFFFFFFFF, which are
-        undefined on Linux.</para></listitem>
-      </varlistentry>
+          <listitem><para>An input parameter was invalid (out of range, or NULL, where that is not
+          accepted). This is also returned if the passed user ID is <constant>0xFFFF</constant> or
+          <constant>0xFFFFFFFF</constant>, which are undefined on Linux.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />