diff options
74 files changed, 1577 insertions, 1655 deletions
diff --git a/man/sd_bus_attach_event.xml b/man/sd_bus_attach_event.xml index f84a7cc4c5..2a207d2848 100644 --- a/man/sd_bus_attach_event.xml +++ b/man/sd_bus_attach_event.xml @@ -84,20 +84,20 @@ 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" /> diff --git a/man/sd_bus_close.xml b/man/sd_bus_close.xml index f7efc868a4..b09f488874 100644 --- a/man/sd_bus_close.xml +++ b/man/sd_bus_close.xml @@ -66,20 +66,20 @@ <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" /> diff --git a/man/sd_bus_creds_get_pid.xml b/man/sd_bus_creds_get_pid.xml index 97ff01226b..9e79d13cdd 100644 --- a/man/sd_bus_creds_get_pid.xml +++ b/man/sd_bus_creds_get_pid.xml @@ -455,62 +455,53 @@ <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" /> diff --git a/man/sd_bus_creds_new_from_pid.xml b/man/sd_bus_creds_new_from_pid.xml index 21f58c0b3d..f5ee01ca35 100644 --- a/man/sd_bus_creds_new_from_pid.xml +++ b/man/sd_bus_creds_new_from_pid.xml @@ -261,42 +261,40 @@ 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" /> diff --git a/man/sd_bus_default.xml b/man/sd_bus_default.xml index 2109c2ddcb..51c27f04ff 100644 --- a/man/sd_bus_default.xml +++ b/man/sd_bus_default.xml @@ -269,36 +269,37 @@ <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" /> diff --git a/man/sd_bus_error.xml b/man/sd_bus_error.xml index 43e8f24eff..8616f7ee43 100644 --- a/man/sd_bus_error.xml +++ b/man/sd_bus_error.xml @@ -325,29 +325,28 @@ 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" /> diff --git a/man/sd_bus_error_add_map.xml b/man/sd_bus_error_add_map.xml index 9a39c0fef4..1dfc7259e2 100644 --- a/man/sd_bus_error_add_map.xml +++ b/man/sd_bus_error_add_map.xml @@ -98,27 +98,27 @@ 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" /> diff --git a/man/sd_bus_get_fd.xml b/man/sd_bus_get_fd.xml index a8c1b1a63d..6a022b1a19 100644 --- a/man/sd_bus_get_fd.xml +++ b/man/sd_bus_get_fd.xml @@ -104,41 +104,41 @@ <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" /> diff --git a/man/sd_bus_get_n_queued_read.xml b/man/sd_bus_get_n_queued_read.xml index 3112ca7a8a..f949c936c2 100644 --- a/man/sd_bus_get_n_queued_read.xml +++ b/man/sd_bus_get_n_queued_read.xml @@ -68,21 +68,21 @@ <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> diff --git a/man/sd_bus_is_open.xml b/man/sd_bus_is_open.xml index ff3f836bb4..d993142cb5 100644 --- a/man/sd_bus_is_open.xml +++ b/man/sd_bus_is_open.xml @@ -70,20 +70,20 @@ <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" /> diff --git a/man/sd_bus_message_append.xml b/man/sd_bus_message_append.xml index f7e6007129..b87468e373 100644 --- a/man/sd_bus_message_append.xml +++ b/man/sd_bus_message_append.xml @@ -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" /> diff --git a/man/sd_bus_message_append_array.xml b/man/sd_bus_message_append_array.xml index 7da94c2664..b9595d6a0a 100644 --- a/man/sd_bus_message_append_array.xml +++ b/man/sd_bus_message_append_array.xml @@ -154,11 +154,11 @@ <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" /> diff --git a/man/sd_bus_message_append_basic.xml b/man/sd_bus_message_append_basic.xml index 852d42c962..a180046b96 100644 --- a/man/sd_bus_message_append_basic.xml +++ b/man/sd_bus_message_append_basic.xml @@ -199,49 +199,49 @@ <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" /> diff --git a/man/sd_bus_message_append_string_memfd.xml b/man/sd_bus_message_append_string_memfd.xml index fc68e02360..c59b8a4284 100644 --- a/man/sd_bus_message_append_string_memfd.xml +++ b/man/sd_bus_message_append_string_memfd.xml @@ -97,11 +97,11 @@ <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" /> diff --git a/man/sd_bus_message_append_strv.xml b/man/sd_bus_message_append_strv.xml index 3d2921b3ca..2ce321633d 100644 --- a/man/sd_bus_message_append_strv.xml +++ b/man/sd_bus_message_append_strv.xml @@ -58,11 +58,11 @@ <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" /> diff --git a/man/sd_bus_message_copy.xml b/man/sd_bus_message_copy.xml index 3f74a1c8d2..cd8ad72e46 100644 --- a/man/sd_bus_message_copy.xml +++ b/man/sd_bus_message_copy.xml @@ -51,50 +51,49 @@ <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" /> diff --git a/man/sd_bus_message_get_cookie.xml b/man/sd_bus_message_get_cookie.xml index 3cb57d25ad..7b9408c049 100644 --- a/man/sd_bus_message_get_cookie.xml +++ b/man/sd_bus_message_get_cookie.xml @@ -63,37 +63,33 @@ <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" /> diff --git a/man/sd_bus_message_get_monotonic_usec.xml b/man/sd_bus_message_get_monotonic_usec.xml index 6110fb8059..958b832534 100644 --- a/man/sd_bus_message_get_monotonic_usec.xml +++ b/man/sd_bus_message_get_monotonic_usec.xml @@ -98,32 +98,29 @@ <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" /> diff --git a/man/sd_bus_message_get_signature.xml b/man/sd_bus_message_get_signature.xml index 607fdba6c8..e3f41346b6 100644 --- a/man/sd_bus_message_get_signature.xml +++ b/man/sd_bus_message_get_signature.xml @@ -72,28 +72,28 @@ <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" /> diff --git a/man/sd_bus_message_get_type.xml b/man/sd_bus_message_get_type.xml index d6304478c7..d8a45ce7a0 100644 --- a/man/sd_bus_message_get_type.xml +++ b/man/sd_bus_message_get_type.xml @@ -96,21 +96,21 @@ <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" /> diff --git a/man/sd_bus_message_new.xml b/man/sd_bus_message_new.xml index 89ba88151e..efe650dea7 100644 --- a/man/sd_bus_message_new.xml +++ b/man/sd_bus_message_new.xml @@ -141,33 +141,33 @@ <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" /> diff --git a/man/sd_bus_message_new_method_call.xml b/man/sd_bus_message_new_method_call.xml index 08ff4a0e02..0d181ed82e 100644 --- a/man/sd_bus_message_new_method_call.xml +++ b/man/sd_bus_message_new_method_call.xml @@ -82,60 +82,60 @@ <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" /> diff --git a/man/sd_bus_message_new_method_error.xml b/man/sd_bus_message_new_method_error.xml index 3b7aa36d78..27cec8ed01 100644 --- a/man/sd_bus_message_new_method_error.xml +++ b/man/sd_bus_message_new_method_error.xml @@ -127,50 +127,50 @@ <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" /> diff --git a/man/sd_bus_message_new_signal.xml b/man/sd_bus_message_new_signal.xml index 9a890c6f31..61619304db 100644 --- a/man/sd_bus_message_new_signal.xml +++ b/man/sd_bus_message_new_signal.xml @@ -56,40 +56,40 @@ <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" /> diff --git a/man/sd_bus_message_read.xml b/man/sd_bus_message_read.xml index 5e2f08ce9c..526fb0e70a 100644 --- a/man/sd_bus_message_read.xml +++ b/man/sd_bus_message_read.xml @@ -154,14 +154,12 @@ <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" /> diff --git a/man/sd_bus_message_read_array.xml b/man/sd_bus_message_read_array.xml index 6986b57755..117afa9e31 100644 --- a/man/sd_bus_message_read_array.xml +++ b/man/sd_bus_message_read_array.xml @@ -58,41 +58,41 @@ 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> diff --git a/man/sd_bus_message_read_basic.xml b/man/sd_bus_message_read_basic.xml index cbcd53f9b8..101f5d21a4 100644 --- a/man/sd_bus_message_read_basic.xml +++ b/man/sd_bus_message_read_basic.xml @@ -190,34 +190,34 @@ 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> diff --git a/man/sd_bus_message_rewind.xml b/man/sd_bus_message_rewind.xml index 0a4d0be80a..aa8aea987b 100644 --- a/man/sd_bus_message_rewind.xml +++ b/man/sd_bus_message_rewind.xml @@ -51,30 +51,30 @@ 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> diff --git a/man/sd_bus_message_set_destination.xml b/man/sd_bus_message_set_destination.xml index ed40bd2487..ca3e466d7a 100644 --- a/man/sd_bus_message_set_destination.xml +++ b/man/sd_bus_message_set_destination.xml @@ -106,35 +106,35 @@ <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" /> diff --git a/man/sd_bus_message_set_expect_reply.xml b/man/sd_bus_message_set_expect_reply.xml index 44f260da75..6f22e82057 100644 --- a/man/sd_bus_message_set_expect_reply.xml +++ b/man/sd_bus_message_set_expect_reply.xml @@ -84,32 +84,32 @@ <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" /> diff --git a/man/sd_bus_message_skip.xml b/man/sd_bus_message_skip.xml index 9495f9409e..0e740ab261 100644 --- a/man/sd_bus_message_skip.xml +++ b/man/sd_bus_message_skip.xml @@ -50,46 +50,46 @@ <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" /> diff --git a/man/sd_bus_message_verify_type.xml b/man/sd_bus_message_verify_type.xml index 1cf4df82e3..c3230e5833 100644 --- a/man/sd_bus_message_verify_type.xml +++ b/man/sd_bus_message_verify_type.xml @@ -56,32 +56,32 @@ <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" /> diff --git a/man/sd_bus_negotiate_fds.xml b/man/sd_bus_negotiate_fds.xml index ccbadb2b40..c12b65c983 100644 --- a/man/sd_bus_negotiate_fds.xml +++ b/man/sd_bus_negotiate_fds.xml @@ -108,20 +108,20 @@ <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" /> diff --git a/man/sd_bus_new.xml b/man/sd_bus_new.xml index 6a27109892..8506ee87e4 100644 --- a/man/sd_bus_new.xml +++ b/man/sd_bus_new.xml @@ -166,20 +166,20 @@ <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" /> diff --git a/man/sd_bus_process.xml b/man/sd_bus_process.xml index 51799459c2..8f35388da3 100644 --- a/man/sd_bus_process.xml +++ b/man/sd_bus_process.xml @@ -69,49 +69,49 @@ <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" /> diff --git a/man/sd_bus_reply_method_error.xml b/man/sd_bus_reply_method_error.xml index 77ac3c4b16..5a6cef6bad 100644 --- a/man/sd_bus_reply_method_error.xml +++ b/man/sd_bus_reply_method_error.xml @@ -91,56 +91,56 @@ <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" /> diff --git a/man/sd_bus_request_name.xml b/man/sd_bus_request_name.xml index 0edba533fa..0f6a4ec313 100644 --- a/man/sd_bus_request_name.xml +++ b/man/sd_bus_request_name.xml @@ -132,63 +132,63 @@ 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 > 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" /> diff --git a/man/sd_bus_set_close_on_exit.xml b/man/sd_bus_set_close_on_exit.xml index d0cafb5ae6..751fc0a729 100644 --- a/man/sd_bus_set_close_on_exit.xml +++ b/man/sd_bus_set_close_on_exit.xml @@ -68,20 +68,20 @@ <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" /> diff --git a/man/sd_bus_set_connected_signal.xml b/man/sd_bus_set_connected_signal.xml index 7915ee2199..edb0df205a 100644 --- a/man/sd_bus_set_connected_signal.xml +++ b/man/sd_bus_set_connected_signal.xml @@ -74,22 +74,22 @@ <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" /> diff --git a/man/sd_bus_set_description.xml b/man/sd_bus_set_description.xml index d6ab590708..cfcebdfb29 100644 --- a/man/sd_bus_set_description.xml +++ b/man/sd_bus_set_description.xml @@ -116,55 +116,55 @@ <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" /> diff --git a/man/sd_bus_set_sender.xml b/man/sd_bus_set_sender.xml index beaaf45eb4..b3f67d9f91 100644 --- a/man/sd_bus_set_sender.xml +++ b/man/sd_bus_set_sender.xml @@ -63,28 +63,29 @@ <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" /> diff --git a/man/sd_bus_set_watch_bind.xml b/man/sd_bus_set_watch_bind.xml index a05931eaf8..cbdc7dd1ed 100644 --- a/man/sd_bus_set_watch_bind.xml +++ b/man/sd_bus_set_watch_bind.xml @@ -80,22 +80,22 @@ <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" /> diff --git a/man/sd_bus_slot_set_description.xml b/man/sd_bus_slot_set_description.xml index 11bcbc81ce..13dd6f8815 100644 --- a/man/sd_bus_slot_set_description.xml +++ b/man/sd_bus_slot_set_description.xml @@ -60,37 +60,37 @@ <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" /> diff --git a/man/sd_bus_slot_set_destroy_callback.xml b/man/sd_bus_slot_set_destroy_callback.xml index c054e89a69..c6fe72e37b 100644 --- a/man/sd_bus_slot_set_destroy_callback.xml +++ b/man/sd_bus_slot_set_destroy_callback.xml @@ -88,27 +88,27 @@ <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" /> diff --git a/man/sd_bus_slot_set_floating.xml b/man/sd_bus_slot_set_floating.xml index d0d75c0126..f63907aa40 100644 --- a/man/sd_bus_slot_set_floating.xml +++ b/man/sd_bus_slot_set_floating.xml @@ -70,35 +70,35 @@ <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" /> diff --git a/man/sd_bus_track_add_name.xml b/man/sd_bus_track_add_name.xml index ba315451d3..29501adf57 100644 --- a/man/sd_bus_track_add_name.xml +++ b/man/sd_bus_track_add_name.xml @@ -181,36 +181,36 @@ <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" /> diff --git a/man/sd_bus_track_new.xml b/man/sd_bus_track_new.xml index 1d19c1f9a6..9b79eb4c2d 100644 --- a/man/sd_bus_track_new.xml +++ b/man/sd_bus_track_new.xml @@ -182,37 +182,38 @@ 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" /> diff --git a/man/sd_bus_wait.xml b/man/sd_bus_wait.xml index 522defb362..7b97dc02fd 100644 --- a/man/sd_bus_wait.xml +++ b/man/sd_bus_wait.xml @@ -66,33 +66,33 @@ <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" /> diff --git a/man/sd_event_add_child.xml b/man/sd_event_add_child.xml index b19620b72e..23fa78ea72 100644 --- a/man/sd_event_add_child.xml +++ b/man/sd_event_add_child.xml @@ -137,61 +137,61 @@ <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" /> diff --git a/man/sd_event_add_defer.xml b/man/sd_event_add_defer.xml index 891aa709b2..636c61e99c 100644 --- a/man/sd_event_add_defer.xml +++ b/man/sd_event_add_defer.xml @@ -129,39 +129,39 @@ <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" /> diff --git a/man/sd_event_add_inotify.xml b/man/sd_event_add_inotify.xml index 2ab1ca236d..3c9f2fbe3e 100644 --- a/man/sd_event_add_inotify.xml +++ b/man/sd_event_add_inotify.xml @@ -110,48 +110,48 @@ <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> diff --git a/man/sd_event_add_io.xml b/man/sd_event_add_io.xml index 0d6b4be3af..4f2b09bf59 100644 --- a/man/sd_event_add_io.xml +++ b/man/sd_event_add_io.xml @@ -228,46 +228,46 @@ <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" /> diff --git a/man/sd_event_add_signal.xml b/man/sd_event_add_signal.xml index d68923fe9a..9bf777c107 100644 --- a/man/sd_event_add_signal.xml +++ b/man/sd_event_add_signal.xml @@ -121,52 +121,52 @@ <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" /> diff --git a/man/sd_event_add_time.xml b/man/sd_event_add_time.xml index f99c8569e3..731636451c 100644 --- a/man/sd_event_add_time.xml +++ b/man/sd_event_add_time.xml @@ -209,54 +209,54 @@ <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" /> diff --git a/man/sd_event_exit.xml b/man/sd_event_exit.xml index 17cb9d2f53..a02897af0b 100644 --- a/man/sd_event_exit.xml +++ b/man/sd_event_exit.xml @@ -79,45 +79,44 @@ <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" /> diff --git a/man/sd_event_get_fd.xml b/man/sd_event_get_fd.xml index 5575b83196..3e78182137 100644 --- a/man/sd_event_get_fd.xml +++ b/man/sd_event_get_fd.xml @@ -58,32 +58,30 @@ <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> diff --git a/man/sd_event_new.xml b/man/sd_event_new.xml index b37aeca7b2..3db39c9d06 100644 --- a/man/sd_event_new.xml +++ b/man/sd_event_new.xml @@ -158,44 +158,40 @@ <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" /> diff --git a/man/sd_event_now.xml b/man/sd_event_now.xml index 9d64402f0b..2d2b085015 100644 --- a/man/sd_event_now.xml +++ b/man/sd_event_now.xml @@ -64,42 +64,37 @@ <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" /> diff --git a/man/sd_event_run.xml b/man/sd_event_run.xml index 245df3cd22..5c33d61fdf 100644 --- a/man/sd_event_run.xml +++ b/man/sd_event_run.xml @@ -96,47 +96,47 @@ 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" /> diff --git a/man/sd_event_set_watchdog.xml b/man/sd_event_set_watchdog.xml index 27bbd66682..faaaad39d9 100644 --- a/man/sd_event_set_watchdog.xml +++ b/man/sd_event_set_watchdog.xml @@ -93,36 +93,32 @@ <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" /> diff --git a/man/sd_event_source_get_pending.xml b/man/sd_event_source_get_pending.xml index dd07a46942..603d4ad377 100644 --- a/man/sd_event_source_get_pending.xml +++ b/man/sd_event_source_get_pending.xml @@ -69,56 +69,52 @@ <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" /> diff --git a/man/sd_event_source_set_description.xml b/man/sd_event_source_set_description.xml index d2ce735975..717cc5be9e 100644 --- a/man/sd_event_source_set_description.xml +++ b/man/sd_event_source_set_description.xml @@ -79,49 +79,45 @@ <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" /> diff --git a/man/sd_event_source_set_destroy_callback.xml b/man/sd_event_source_set_destroy_callback.xml index f3ebf0cc3a..2ffca9ec36 100644 --- a/man/sd_event_source_set_destroy_callback.xml +++ b/man/sd_event_source_set_destroy_callback.xml @@ -69,25 +69,26 @@ <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" /> diff --git a/man/sd_event_source_set_enabled.xml b/man/sd_event_source_set_enabled.xml index 699fffcdbc..6a7a39b427 100644 --- a/man/sd_event_source_set_enabled.xml +++ b/man/sd_event_source_set_enabled.xml @@ -100,39 +100,38 @@ <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" /> diff --git a/man/sd_event_source_set_prepare.xml b/man/sd_event_source_set_prepare.xml index f54bfb8a36..63c33ca19e 100644 --- a/man/sd_event_source_set_prepare.xml +++ b/man/sd_event_source_set_prepare.xml @@ -73,55 +73,51 @@ <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" /> diff --git a/man/sd_event_source_set_priority.xml b/man/sd_event_source_set_priority.xml index c17235958b..d1cb416dcb 100644 --- a/man/sd_event_source_set_priority.xml +++ b/man/sd_event_source_set_priority.xml @@ -106,48 +106,45 @@ <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" /> diff --git a/man/sd_event_wait.xml b/man/sd_event_wait.xml index 8e287e6a9f..210a0c948d 100644 --- a/man/sd_event_wait.xml +++ b/man/sd_event_wait.xml @@ -254,56 +254,51 @@ <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" /> diff --git a/man/sd_get_seats.xml b/man/sd_get_seats.xml index f52e816d22..ed4b77b3ea 100644 --- a/man/sd_get_seats.xml +++ b/man/sd_get_seats.xml @@ -83,27 +83,24 @@ <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" /> diff --git a/man/sd_login_monitor_new.xml b/man/sd_login_monitor_new.xml index 317981a655..be1c843ee0 100644 --- a/man/sd_login_monitor_new.xml +++ b/man/sd_login_monitor_new.xml @@ -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" /> diff --git a/man/sd_machine_get_class.xml b/man/sd_machine_get_class.xml index 5fdc759010..db6cf0dbc0 100644 --- a/man/sd_machine_get_class.xml +++ b/man/sd_machine_get_class.xml @@ -66,38 +66,37 @@ <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" /> diff --git a/man/sd_pid_get_owner_uid.xml b/man/sd_pid_get_owner_uid.xml index ead2f757f9..e9d7a8eb69 100644 --- a/man/sd_pid_get_owner_uid.xml +++ b/man/sd_pid_get_owner_uid.xml @@ -240,54 +240,50 @@ <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> diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml index 6e1cba1163..2dba6803f1 100644 --- a/man/sd_seat_get_active.xml +++ b/man/sd_seat_get_active.xml @@ -112,52 +112,47 @@ <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" /> diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml index 4e2e31ea1b..d4a12f533c 100644 --- a/man/sd_session_is_active.xml +++ b/man/sd_session_is_active.xml @@ -262,43 +262,42 @@ <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" /> diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml index 8c4bf014e0..ed38559bb3 100644 --- a/man/sd_uid_get_state.xml +++ b/man/sd_uid_get_state.xml @@ -131,55 +131,48 @@ <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" /> |