From b1de39dec8e9acd875e2038e418d7193fb380b41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 21 Mar 2019 14:53:00 +0100 Subject: [PATCH] man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add in various places, fix some typos. --- man/sd_bus_attach_event.xml | 20 ++--- man/sd_bus_close.xml | 20 ++--- man/sd_bus_creds_get_pid.xml | 83 +++++++++----------- man/sd_bus_creds_new_from_pid.xml | 48 ++++++----- man/sd_bus_default.xml | 41 +++++----- man/sd_bus_error.xml | 31 ++++---- man/sd_bus_error_add_map.xml | 28 +++---- man/sd_bus_get_fd.xml | 50 ++++++------ man/sd_bus_get_n_queued_read.xml | 20 ++--- man/sd_bus_is_open.xml | 20 ++--- man/sd_bus_message_append.xml | 7 +- man/sd_bus_message_append_array.xml | 8 +- man/sd_bus_message_append_basic.xml | 60 +++++++------- man/sd_bus_message_append_string_memfd.xml | 8 +- man/sd_bus_message_append_strv.xml | 8 +- man/sd_bus_message_copy.xml | 61 +++++++------- man/sd_bus_message_get_cookie.xml | 44 +++++------ man/sd_bus_message_get_monotonic_usec.xml | 37 ++++----- man/sd_bus_message_get_signature.xml | 32 ++++---- man/sd_bus_message_get_type.xml | 22 +++--- man/sd_bus_message_new.xml | 38 ++++----- man/sd_bus_message_new_method_call.xml | 80 +++++++++---------- man/sd_bus_message_new_method_error.xml | 64 +++++++-------- man/sd_bus_message_new_signal.xml | 50 ++++++------ man/sd_bus_message_read.xml | 12 ++- man/sd_bus_message_read_array.xml | 48 +++++------ man/sd_bus_message_read_basic.xml | 40 +++++----- man/sd_bus_message_rewind.xml | 40 +++++----- man/sd_bus_message_set_destination.xml | 42 +++++----- man/sd_bus_message_set_expect_reply.xml | 38 ++++----- man/sd_bus_message_skip.xml | 56 ++++++------- man/sd_bus_message_verify_type.xml | 36 ++++----- man/sd_bus_negotiate_fds.xml | 20 ++--- man/sd_bus_new.xml | 20 ++--- man/sd_bus_process.xml | 62 +++++++-------- man/sd_bus_reply_method_error.xml | 72 ++++++++--------- man/sd_bus_request_name.xml | 82 +++++++++---------- man/sd_bus_set_close_on_exit.xml | 20 ++--- man/sd_bus_set_connected_signal.xml | 24 +++--- man/sd_bus_set_description.xml | 72 ++++++++--------- man/sd_bus_set_sender.xml | 33 ++++---- man/sd_bus_set_watch_bind.xml | 24 +++--- man/sd_bus_slot_set_description.xml | 44 +++++------ man/sd_bus_slot_set_destroy_callback.xml | 30 +++---- man/sd_bus_slot_set_floating.xml | 42 +++++----- man/sd_bus_track_add_name.xml | 40 +++++----- man/sd_bus_track_new.xml | 43 +++++----- man/sd_bus_wait.xml | 38 ++++----- man/sd_event_add_child.xml | 72 ++++++++--------- man/sd_event_add_defer.xml | 44 +++++------ man/sd_event_add_inotify.xml | 54 ++++++------- man/sd_event_add_io.xml | 52 ++++++------ man/sd_event_add_signal.xml | 62 +++++++-------- man/sd_event_add_time.xml | 60 +++++++------- man/sd_event_exit.xml | 51 ++++++------ man/sd_event_get_fd.xml | 36 ++++----- man/sd_event_new.xml | 50 ++++++------ man/sd_event_now.xml | 49 ++++++------ man/sd_event_run.xml | 54 ++++++------- man/sd_event_set_watchdog.xml | 40 +++++----- man/sd_event_source_get_pending.xml | 66 ++++++++-------- man/sd_event_source_set_description.xml | 58 +++++++------- man/sd_event_source_set_destroy_callback.xml | 29 +++---- man/sd_event_source_set_enabled.xml | 45 ++++++----- man/sd_event_source_set_prepare.xml | 64 +++++++-------- man/sd_event_source_set_priority.xml | 55 ++++++------- man/sd_event_wait.xml | 67 ++++++++-------- man/sd_get_seats.xml | 29 +++---- man/sd_login_monitor_new.xml | 31 ++++---- man/sd_machine_get_class.xml | 45 ++++++----- man/sd_pid_get_owner_uid.xml | 66 ++++++++-------- man/sd_seat_get_active.xml | 65 +++++++-------- man/sd_session_is_active.xml | 51 ++++++------ man/sd_uid_get_state.xml | 69 ++++++++-------- 74 files changed, 1572 insertions(+), 1650 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. sd_bus_get_event() returns an event loop object or NULL. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ECHILD + + + -ECHILD - The bus connection has been created in a different process. - - + The bus connection has been created in a different process. + + + 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 @@ On success, sd_bus_flush() returns 0 or a positive integer. On failure, it returns a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ECHILD + + + -ECHILD - The bus connection has been created in a different process. - - + The bus connection has been created in a different process. + + + 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 @@ On success, these calls return 0 or a positive integer. On failure, these calls return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ENODATA + + + -ENODATA - The given field is not available in the - credentials object c. - - + The given field is not available in the credentials object + c. + + - - -ENXIO + + -ENXIO - The given field is not specified for the described - process or peer. This will be returned by - sd_bus_creds_get_unit(), - sd_bus_creds_get_slice(), - sd_bus_creds_get_user_unit(), - sd_bus_creds_get_user_slice(), and - sd_bus_creds_get_session() if the process is - not part of a systemd system unit, systemd user unit, systemd - slice, or logind session. It will be returned by - sd_bus_creds_get_owner_uid() if the process is - not part of a systemd user unit or logind session. It will also be - returned by sd_bus_creds_get_exe() and - sd_bus_creds_get_cmdline() for kernel - threads (since these are not started from an executable binary, - nor have a command line), and by - sd_bus_creds_get_audit_session_id() and - sd_bus_creds_get_audit_login_uid() when - the process is not part of an audit session, and - sd_bus_creds_get_tty() if the process has - no controlling TTY. - - - + The given field is not specified for the described process or peer. This will be + returned by sd_bus_creds_get_unit(), + sd_bus_creds_get_slice(), sd_bus_creds_get_user_unit(), + sd_bus_creds_get_user_slice(), and + sd_bus_creds_get_session() if the process is not part of a systemd system + unit, systemd user unit, systemd slice, or logind session. It will be returned by + sd_bus_creds_get_owner_uid() if the process is not part of a systemd user unit + or logind session. It will also be returned by sd_bus_creds_get_exe() and + sd_bus_creds_get_cmdline() for kernel threads (since these are not started + from an executable binary, nor have a command line), and by + sd_bus_creds_get_audit_session_id() and + sd_bus_creds_get_audit_login_uid() when the process is not part of an audit + session, and sd_bus_creds_get_tty() if the process has no controlling + TTY. + - - -EINVAL + + -EINVAL - Specified pointer parameter is NULL. - - + Specified pointer parameter is NULL. + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 sd_bus_creds_unref3. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -ESRCH + + -ESRCH - Specified pid could not - be found. - + Specified pid could not be found. + - - -EINVAL + + -EINVAL - Specified parameter is invalid - (NULL in case of output - parameters). - + Specified parameter is invalid (NULL in case of output + parameters). + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - + Memory allocation failed. + - - -EOPNOTSUPP + + -EOPNOTSUPP - One of the requested fields is unknown to the local system. - - + One of the requested fields is unknown to the local system. + + + 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 @@ On success, these calls return 0 or a positive integer. On failure, these calls return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -EINVAL + + -EINVAL - The specified parameters are invalid. - + The specified parameters are invalid. + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - + Memory allocation failed. + - - -ESOCKTNOSUPPORT + + -ESOCKTNOSUPPORT - The protocol version required to connect to the selected bus is not supported. - - + The protocol version required to connect to the selected bus is not + supported. + + - In addition, any further connection-related errors may be - by returned. See sd_bus_send3. + In addition, any further connection-related errors may be by returned. See + sd_bus_send3. + 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'>free3 the memory held by the structure itself after freeing its contents with sd_bus_error_free(). - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -EINVAL + + -EINVAL - Error was already set in - sd_bus_error structure when one the - error-setting functions was called. - + Error was already set in sd_bus_error structure when one + the error-setting functions was called. + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 errno-style error code is returned. See below for known error codes. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -EINVAL + + -EINVAL - The specified mapping array is invalid. - + The specified mapping array is invalid. + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ sd_bus_get_timeout() returns zero or positive on success, or a negative errno-style error code on error. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - An invalid bus object was passed. - + An invalid bus object was passed. + - - -ECHILD + + -ECHILD - The bus connection was allocated in a parent process and is being reused in a child process - after fork(). - + The bus connection was allocated in a parent process and is being reused in a child + process after fork(). + - - -ENOTCONN + + -ENOTCONN - The bus connection has been terminated. - + The bus connection has been terminated. + - - -EPERM + + -EPERM - Two distinct file descriptors were passed for input and output using - sd_bus_set_fd(), which sd_bus_get_fd() cannot - return. - - + Two distinct file descriptors were passed for input and output using + sd_bus_set_fd(), which sd_bus_get_fd() cannot + return. + + + 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 @@ On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ECHILD + + + -ECHILD - The bus connection was created in a different process. - + The bus connection was created in a different process. + - + + 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 @@ On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ECHILD + + + -ECHILD - The bus connection has been created in a different process. - - + The bus connection has been created in a different process. + + + 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); Return Value - On success, these functions return 0 or a positive - integer. On failure, these functions return a negative + On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code. - - + + 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 @@ Return Value - On success, these calls return 0 or a positive integer. On - failure, they return a negative errno-style error code. - + On success, these calls return 0 or a positive integer. On failure, they return a negative + errno-style error code. - + + 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 @@ On success, this call returns 0 or a positive integer. On failure, it returns a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -EINVAL + + -EINVAL - Specified parameter is invalid. - - + Specified parameter is invalid. + + - - -EPERM + + -EPERM - Message has been sealed. - - + Message has been sealed. + + - - -ESTALE + + -ESTALE - Message is in invalid state. - - + Message is in invalid state. + + - - -ENXIO + + -ENXIO - Message cannot be appended to. - - + Message cannot be appended to. + + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ Return Value - On success, those calls return 0 or a positive integer. On - failure, they returns a negative errno-style error code. - + On success, those calls return 0 or a positive integer. On failure, they return a negative + errno-style error code. - + + 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 @@ Return Value - On success, this call returns 0 or a positive integer. On - failure, a negative errno-style error code is returned. - + On success, this call returns 0 or a positive integer. On failure, a negative errno-style error + code is returned. - + + 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 @@ 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. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -EINVAL + + -EINVAL - source or m are - NULL. - + source or m are + NULL. + - - -EPERM + + -EPERM - Message m has been sealed or - source has not been sealed. - - + Message m has been sealed or source + has not been sealed. + - - -ESTALE + + -ESTALE - Destination message is in invalid state. - - + Destination message is in invalid state. + + - - -ENXIO + + -ENXIO - Destination message cannot be appended to. - - + Destination message cannot be appended to. + + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ Return Value - On success, these calls return 0 or a positive integer. On - failure, these calls return a negative errno-style error - code. + On success, these calls return 0 or a positive integer. On failure, they return a negative + errno-style error code. - On success, the cookie/reply cookie is returned in the - specified 64-bit unsigned integer variable. - + On success, the cookie/reply cookie is returned in the specified 64-bit unsigned integer + variable. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - A specified parameter - is invalid. - + A specified parameter is invalid. + - - -ENODATA + + -ENODATA - 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. - - + 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. + + + 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 @@ On success, the timestamp or sequence number is returned in the specified 64-bit unsigned integer variable. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - A specified parameter is - invalid. - + A specified parameter is invalid. + - - -ENODATA + + -ENODATA - 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 - sd_bus_negotiate_timestamp3. - - + 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 + sd_bus_negotiate_timestamp3. + + + 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 @@ The other functions return 0 or a positive integer on success. On failure, they return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The message parameter is NULL. - - + The message parameter is NULL. + + - - NULL + + NULL - The message parameter is NULL. - - - + The message parameter is NULL. + + + + 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 @@ On success, those functions return 0 or a positive integer. On failure, it returns a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The message parameter or the output parameter are - NULL. - - + The message parameter or the output parameter are + NULL. + + + 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 @@ NULL. sd_bus_message_get_bus() always returns the bus object. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - Specified type is invalid. - + Specified type is invalid. + - - -ENOTCONN + + -ENOTCONN - The bus parameter bus is NULL or - the bus is not connected. - + The bus parameter bus is NULL or + the bus is not connected. + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ This function returns 0 if the message object was successfully created, and a negative errno-style error code otherwise. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The output parameter m is - NULL. + The output parameter m is + NULL. - The destination parameter is non-null and is not a valid D-Bus - service name (org.somewhere.Something), the path - parameter is not a valid D-Bus path (/an/object/path), the - interface parameter is non-null and is not a valid D-Bus interface - name (an.interface.name), or the member parameter - is not a valid D-Bus member (Name). + The destination parameter is non-null and is not a valid D-Bus + service name (org.somewhere.Something), the path + parameter is not a valid D-Bus path (/an/object/path), the + interface parameter is non-null and is not a valid D-Bus interface + name (an.interface.name), or the member parameter + is not a valid D-Bus member (Name). - The call parameter is not a method call object. - - + The call parameter is not a method call object. + + - - -ENOTCONN + + -ENOTCONN - The bus parameter bus is NULL or - the bus is not connected. - + The bus parameter bus is NULL or + the bus is not connected. + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - + Memory allocation failed. + - - -EPERM + + -EPERM - - The call parameter is not sealed. - - + + The call parameter is not sealed. + + - - -EOPNOTSUPP + + -EOPNOTSUPP - - The call message does not have a cookie. - - - + + The call message does not have a cookie. + + + + 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 @@ These functions return 0 if the error reply was successfully created, and a negative errno-style error code otherwise. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The call message call or the output - parameter m are NULL. + The call message call or the output + parameter m are NULL. - Message call is not a method call - message. + Message call is not a method call + message. - The error error parameter to - sd_bus_message_new_method_error is not set, see - sd_bus_error_is_set3. - - - + The error error parameter to + sd_bus_message_new_method_error is not set, see + sd_bus_error_is_set3. + + + - - -EPERM + + -EPERM - Message call has been sealed. - - + Message call has been sealed. + + - - -ENOTCONN + + -ENOTCONN - The bus to which message call is - attached is not connected. - + The bus to which message call is + attached is not connected. + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ This function returns 0 if the message object was successfully created, and a negative errno-style error code otherwise. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The output parameter m is - NULL. + The output parameter m is + NULL. - The path parameter is not a valid D-Bus path - (/an/object/path), the interface parameter is not - a valid D-Bus interface name (an.interface.name), or the - member parameter is not a valid D-Bus member - (Name). - + The path parameter is not a valid D-Bus path + (/an/object/path), the interface parameter is not + a valid D-Bus interface name (an.interface.name), or the + member parameter is not a valid D-Bus member + (Name). + - - -ENOTCONN + + -ENOTCONN - The bus parameter bus is NULL or - the bus is not connected. - + The bus parameter bus is NULL or + the bus is not connected. + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ Return Value - - On success, sd_bus_message_read() and - sd_bus_message_readv() return 0 or a positive integer. On - failure, they return a negative errno-style error code. - - + On success, sd_bus_message_read() and + sd_bus_message_readv() return 0 or a positive integer. On failure, they return a + negative errno-style error code. - + + 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. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - Specified type is invalid or the message parameter or one of the output - parameters are NULL. - + Specified type is invalid or the message parameter or one of the output + parameters are NULL. + - - -EOPNOTSUPP + + -EOPNOTSUPP - The byte order in the message is different than native byte - order. - + The byte order in the message is different than native byte + order. + - - -EPERM + + -EPERM - The message is not sealed. - + The message is not sealed. + - - -EBADMSG + + -EBADMSG - The message cannot be parsed. - + The message cannot be parsed. + - + + 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. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - Specified type string is invalid or the message parameter is - NULL. - + Specified type string is invalid or the message parameter is + NULL. + - - -ENXIO + + -ENXIO - The message does not contain the specified type at current - position. - + The message does not contain the specified type at current position. + + - - -EBADMSG + + -EBADMSG - The message cannot be parsed. - - + The message cannot be parsed. + + + 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. + + + Errors + + Returned errors may indicate the following problems: + + + + -EINVAL + + The m parameter is NULL. + + + + -EPERM + + The message m has not been sealed. + + + - - Errors - - Returned errors may indicate the following problems: - - - - -EINVAL - - The m parameter is NULL. - - - - -EPERM - - The message m has not been sealed. - - - - See Also 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 @@ On success, these calls return 0 or a positive integer. On failure, these calls return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The message parameter or the output parameter are - NULL. - + The message parameter or the output parameter are + NULL. + - - -EPERM + + -EPERM - For sd_bus_message_set_destination or - sd_bus_message_set_sender, the message is already - sealed. - + For sd_bus_message_set_destination or + sd_bus_message_set_sender, the message is already + sealed. + - - -EEXIST + + -EEXIST - The message already has a destination or sender field set. - - + The message already has a destination or sender field set. + + + 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 @@ On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The message parameter is - NULL. - + The message parameter is + NULL. + - - -EPERM + + -EPERM - The message message is sealed - when trying to set a flag. + The message message is sealed + when trying to set a flag. - The message message has wrong - type. - - - + The message message has wrong + type. + + + + 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 @@ On success, sd_bus_message_skip() returns 0 or a positive integer. On failure, it returns a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The m parameter is - NULL. - + The m parameter is + NULL. + - - -EBADMSG + + -EBADMSG - The message cannot be parsed. - + The message cannot be parsed. + - - -EPERM + + -EPERM - The message is not sealed. - + The message is not sealed. + - - -ENXIO + + -ENXIO - The message end has been reached and the requested elements cannot be read. - - + The message end has been reached and the requested elements cannot be read. + + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ On success, this call returns true if the type matches and zero if not (the message m contains different data or the end of the message has been reached). On failure, it returns a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -EINVAL + + -EINVAL - m or both type and - contents are NULL. + m or both type and + contents are NULL. - Arguments do not satisfy other contraints listed above. - - + Arguments do not satisfy other contraints listed above. + + - - -EPERM + + -EPERM - Message m is not sealed. - - - + Message m is not sealed. + + + + 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 @@ On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EPERM + + + -EPERM - The bus connection has already been started. - - + The bus connection has already been started. + + + 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 @@ sd_bus_unref() and sd_bus_flush_close_unref() always return NULL. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ENOMEM + + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ Return Value - If progress was made, a positive integer is returned. If no progress was made, 0 is returned. If an error - occurs, a negative errno-style error code is returned. - + If progress was made, a positive integer is returned. If no progress was made, 0 is returned. If an + error occurs, a negative errno-style error code is returned. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - An invalid bus object was passed. - + An invalid bus object was passed. + - - -ECHILD + + -ECHILD - The bus connection was allocated in a parent process and is being reused in a child process - after fork(). - + The bus connection was allocated in a parent process and is being reused in a child + process after fork(). + - - -ENOTCONN + + -ENOTCONN - The bus connection has been terminated already. - + The bus connection has been terminated already. + - - -ECONNRESET + + -ECONNRESET - The bus connection has been terminated just now. - + The bus connection has been terminated just now. + - - -EBUSY + + -EBUSY - This function is already being called, i.e. sd_bus_process() has been - called from a callback function that itself was called by - sd_bus_process(). - - + This function is already being called, i.e. sd_bus_process() + has been called from a callback function that itself was called by + sd_bus_process(). + + + 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 @@ These functions return 0 if the error reply was successfully sent or if none was expected, and a negative errno-style error code otherwise. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The call message call is - NULL. + The call message call is + NULL. - Message call is not a method call message. - + Message call is not a method call message. + - Message call is not attached to a bus. + Message call is not attached to a bus. - The error error parameter to - sd_bus_reply_method_error is not set, see - sd_bus_error_is_set3. - - - + The error error parameter to + sd_bus_reply_method_error is not set, see + sd_bus_error_is_set3. + + + - - -EPERM + + -EPERM - Message call has been sealed. - - + Message call has been sealed. + + - - -ENOTCONN + + -ENOTCONN - The bus to which message call is - attached is not connected. - + The bus to which message call is attached is not + connected. + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + - In addition, any error message returned by - sd_bus_send1 - may be returned. + In addition, any error message returned by + sd_bus_send1 + may be returned. + 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 NameOwnerChanged signals to be notified when the name is successfully acquired. sd_bus_request_name() returns > 0 when the name has immediately been acquired successfully. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EALREADY + + + -EALREADY - The caller already is the owner of the specified name. - + The caller already is the owner of the specified name. + - - -EEXIST + + -EEXIST - 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. - + 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. + - - -ESRCH + + -ESRCH - It was attempted to release a name that is currently not registered on the - bus. - + It was attempted to release a name that is currently not registered on the + bus. + - - -EADDRINUSE + + -EADDRINUSE - It was attempted to release a name that is owned by a different peer on the - bus. - + It was attempted to release a name that is owned by a different peer on the + bus. + - - -EINVAL + + -EINVAL - 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. - + 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. + - - -ENOTCONN + + -ENOTCONN - The bus connection has been disconnected. - + The bus connection has been disconnected. + - - -ECHILD + + -ECHILD - The bus connection has been created in a different process than the current - one. - - + The bus connection has been created in a different process than the current + one. + + + 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 @@ sd_bus_get_close_on_exit() 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. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ECHILD + + + -ECHILD - The bus connection has been created in a different process. - - + The bus connection has been created in a different process. + + + 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 @@ Return Value - On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style - error code. - + On success, these functions return 0 or a positive integer. On failure, they return a negative + errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ECHILD + + + -ECHILD - The bus connection has been created in a different process. - - + The bus connection has been created in a different process. + + + 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 @@ Return Value - On success, these functions return 0 or a positive integer. On failure, - they return a negative errno-style error code. - + On success, these functions return 0 or a positive integer. On failure, they return a negative + errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - An argument is invalid. - - + An argument is invalid. + + - - - -ENOPKG + + + -ENOPKG - The bus cannot be resolved. - - + The bus cannot be resolved. + + - - - -EPERM + + + -EPERM - The bus has already been started. - - + The bus has already been started. + + - - - -ECHILD + + + -ECHILD - The bus was created in a different process. - - + The bus was created in a different process. + + - - - -ENOMEM + + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ Return Value - On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style - error code. - + On success, these functions return 0 or a positive integer. On failure, they return a negative + errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ECHILD + + + -ECHILD - The bus connection has been created in a different process. - + The bus connection has been created in a different process. + - - -EPERM + + -EPERM - The specified bus connection object is a not a direct but a brokered connection. - - + The specified bus connection object is a not a direct but a brokered + connection. + + + 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 @@ Return Value - On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style - error code. - + On success, these functions return 0 or a positive integer. On failure, they return a negative + errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ECHILD + + + -ECHILD - The bus connection has been created in a different process. - - + The bus connection has been created in a different process. + + + 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 @@ On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - An required argument is NULL. - - + An required argument is NULL. + + - - - -ENXIO + + + -ENXIO - The bus slot object has no description. - - + The bus slot object has no description. + + - - - -ENOMEM + + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ Return Value On success, sd_bus_slot_set_destroy_callback() and - sd_bus_track_set_destroy_callback() return 0 or a positive integer. On failure, they return a - negative errno-style error code. + sd_bus_track_set_destroy_callback() return 0 or a positive integer. On failure, they + return a negative errno-style error code. sd_bus_slot_get_destroy_callback() and - sd_bus_track_get_destroy_callback() return positive if the destroy callback function is set, 0 - if not. On failure, they return a negative errno-style error code. - + sd_bus_track_get_destroy_callback() return positive if the destroy callback function + is set, 0 if not. On failure, they return a negative errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The slot or track parameter is - NULL. - - + The slot or track parameter is + NULL. + + + 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 @@ Return Value - On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style - error code. - + On success, these functions return 0 or a positive integer. On failure, they return a negative + errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The slot parameter is NULL. - + The slot parameter is NULL. + - - -ECHILD + + -ECHILD - The bus connection has been created in a different process. - + The bus connection has been created in a different process. + - - -ESTALE + + -ESTALE - 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. - - + 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. + + + 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 @@ sd_bus_track_first() and sd_bus_track_next() return the first/next name contained in the bus peer tracking object, and NULL if the end of the enumeration is reached and on error. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -EUNATCH + + -EUNATCH - sd_bus_track_remove_name() or - sd_bus_track_remove_sender() have been invoked for a name not previously added to the bus - peer object. - + sd_bus_track_remove_name() or + sd_bus_track_remove_sender() have been invoked for a name not previously added + to the bus peer object. + - - -EINVAL + + -EINVAL - Specified parameter is invalid. - + Specified parameter is invalid. + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - + Memory allocation failed. + - + + 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 sd_bus_track_unref(). - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -EBUSY + + -EBUSY - Bus peers have already been added to the bus peer tracking object and - sd_bus_track_set_recursive() was called to change tracking mode. - + Bus peers have already been added to the bus peer tracking object and + sd_bus_track_set_recursive() was called to change tracking mode. + + - - -EINVAL + + -EINVAL - Specified parameter is invalid - (NULL in case of output - parameters). - + Specified parameter is invalid + (NULL in case of output + parameters). + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - + Memory allocation failed. + - + + 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 @@ If any I/O was seen, a positive value is returned, zero otherwise. If an error occurs, a negative errno-style error code is returned. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - An invalid bus object was passed. - + An invalid bus object was passed. + - - -ECHILD + + -ECHILD - The bus connection was allocated in a parent process and is being reused in a child process - after fork(). - + The bus connection was allocated in a parent process and is being reused in a child + process after fork(). + - - -ENOTCONN + + -ENOTCONN - The bus connection has been terminated already. - - + The bus connection has been terminated already. + + + 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 @@ On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ENOMEM + + + -ENOMEM - Not enough memory to allocate an object. - + Not enough memory to allocate an object. + - - -EINVAL + + -EINVAL - An invalid argument has been passed. This includes - specifying an empty mask in options or a mask - which contains values different than a combination of - WEXITED, WSTOPPED, and - WCONTINUED. - + An invalid argument has been passed. This includes + specifying an empty mask in options or a mask + which contains values different than a combination of + WEXITED, WSTOPPED, and + WCONTINUED. + - + - - -EBUSY + + -EBUSY - A handler is already installed for this - child process. + A handler is already installed for this + child process. - + - - -ESTALE + + -ESTALE - The event loop is already terminated. + The event loop is already terminated. - + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. + The event loop has been created in a different process. - + - - -EDOM + + -EDOM - The passed event source is not a child process event source. - + The passed event source is not a child process event source. + - + + 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 @@ On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ENOMEM + + + -ENOMEM - Not enough memory to allocate an object. - + Not enough memory to allocate an object. + - - -EINVAL + + -EINVAL - An invalid argument has been passed. - + An invalid argument has been passed. + - - -ESTALE + + -ESTALE - The event loop is already terminated. - + The event loop is already terminated. + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. - + The event loop has been created in a different process. + - + + 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 @@ On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ENOMEM + + + -ENOMEM - Not enough memory to allocate an object. - + Not enough memory to allocate an object. + - - -EINVAL + + -EINVAL - An invalid argument has been passed. This includes specifying a mask with - IN_MASK_ADD set. - + An invalid argument has been passed. This includes specifying a mask with + IN_MASK_ADD set. + - - -ESTALE + + -ESTALE - The event loop is already terminated. + The event loop is already terminated. - + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. + The event loop has been created in a different process. - + - - -EDOM + + -EDOM - The passed event source is not an inotify process event source. - + The passed event source is not an inotify process event source. + - + + 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 @@ On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code. - - - Errors + + Errors - Returned values may indicate the following problems: + Returned values may indicate the following problems: - - - -ENOMEM + + + -ENOMEM - Not enough memory to allocate an object. - + Not enough memory to allocate an object. + - - -EINVAL + + -EINVAL - An invalid argument has been passed. + An invalid argument has been passed. - + - - -ESTALE + + -ESTALE - The event loop is already terminated. + The event loop is already terminated. - + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. - + The event loop has been created in a different process. + - - -EDOM + + -EDOM - The passed event source is not an I/O event source. - - + The passed event source is not an I/O event source. + + + 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 @@ On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ENOMEM + + + -ENOMEM - Not enough memory to allocate an object. - + Not enough memory to allocate an object. + - - -EINVAL + + -EINVAL - An invalid argument has been passed. - + An invalid argument has been passed. + - - -EBUSY + + -EBUSY - A handler is already installed for this - signal or the signal was not blocked previously. - + A handler is already installed for this + signal or the signal was not blocked previously. + - - -ESTALE + + -ESTALE - The event loop is already terminated. - + The event loop is already terminated. + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. - + The event loop has been created in a different process. + - - -EDOM + + -EDOM - The passed event source is not a signal event source. - + The passed event source is not a signal event source. + - + + 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 @@ On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code. - - - Errors + + Errors - Returned values may indicate the following problems: + Returned values may indicate the following problems: - - - -ENOMEM + + + -ENOMEM - Not enough memory to allocate an object. - + Not enough memory to allocate an object. + - - -EINVAL + + -EINVAL - An invalid argument has been passed. + An invalid argument has been passed. - + - - -ESTALE + + -ESTALE - The event loop is already terminated. + The event loop is already terminated. - + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. + The event loop has been created in a different process. - + - - -EOPNOTSUPP + + -EOPNOTSUPP - The selected clock is not supported by the event loop implementation. + The selected clock is not supported by the event loop implementation. - + - - -EDOM + + -EDOM - The passed event source is not a timer event source. - - + The passed event source is not a timer event source. + + + 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 @@ Return Value - On success, sd_event_exit() and - sd_event_get_exit_code() return 0 or a positive - integer. On failure, they return a negative errno-style error - code. - + On success, sd_event_exit() and sd_event_get_exit_code() + return 0 or a positive integer. On failure, they return a negative errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -EINVAL + + -EINVAL - The event loop object or error code pointer are invalid. + The event loop object or error code pointer are invalid. - + - - -ECHILD + + -ECHILD - The event loop was created in a different process. - + The event loop was created in a different process. + - - -ESTALE + + -ESTALE - The event loop has exited already and all exit handlers are already processed. - + The event loop has exited already and all exit handlers are already processed. + + - - -ENODATA + + -ENODATA - The event loop has not been requested to exit yet. - + The event loop has not been requested to exit yet. + - + + 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 @@ Return Value - On success, sd_event_get_fd() returns a - non-negative file descriptor. On failure, it returns a negative - errno-style error code. - + On success, sd_event_get_fd() returns a non-negative file descriptor. On + failure, it returns a negative errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - event is not a valid - pointer to an sd_event structure. - - + event is not a valid pointer to an + sd_event structure. + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. + The event loop has been created in a different process. - - + + + 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 @@ Return Value - On success, sd_event_new(), - sd_event_default() and - sd_event_get_tid() return 0 or a positive - integer. On failure, they return a negative errno-style error - code. sd_event_ref() always returns a pointer - to the event loop object passed - in. sd_event_unref() always returns + On success, sd_event_new(), sd_event_default() and + sd_event_get_tid() return 0 or a positive integer. On failure, they return a + negative errno-style error code. sd_event_ref() always returns a pointer to the + event loop object passed in. sd_event_unref() always returns NULL. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -ENOMEM + + + -ENOMEM - Not enough memory to allocate the object. - + Not enough memory to allocate the object. + - - -EMFILE + + -EMFILE - The maximum number of event loops has been allocated. + The maximum number of event loops has been allocated. - + - - -ENXIO + + -ENXIO - sd_event_get_tid() was - invoked on an event loop object that was not allocated with - sd_event_default(). - + sd_event_get_tid() was invoked on an event loop object that + was not allocated with sd_event_default(). + - + + 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 @@ Return Value - If the first event loop iteration has not run yet - sd_event_now() writes current time to - usec and returns a positive return value. - Otherwise, it will write the requested timestamp to usec - and return 0. On failure, the call returns a negative errno-style - error code. - + If the first event loop iteration has not run yet sd_event_now() writes + current time to usec and returns a positive return value. Otherwise, it will + write the requested timestamp to usec and return 0. On failure, the call returns a + negative errno-style error code. - - Errors + + Errors - Returned values may indicate the following problems: + Returned values may indicate the following problems: - - - -EINVAL + + + -EINVAL - An invalid parameter was - passed. + An invalid parameter was passed. - + - - -EOPNOTSUPP + + -EOPNOTSUPP - Unsupported clock type. - - + Unsupported clock type. + - - -ECHILD + + -ECHILD - The event loop object was created in a - different process. - - + The event loop object was created in a different process. + + + 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. sd_event_loop() returns the exit code specified when invoking sd_event_exit(). - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The event parameter is - invalid or NULL. - + The event parameter is invalid or + NULL. + - - -EBUSY + + -EBUSY - The event loop object is not in the right - state (see - sd_event_prepare3 - for an explanation of possible states). - + The event loop object is not in the right + state (see + sd_event_prepare3 + for an explanation of possible states). + - - -ESTALE + + -ESTALE - The event loop is already terminated. + The event loop is already terminated. - + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. + The event loop has been created in a different process. - + - + - Other errors are possible, too. + Other errors are possible, too. + 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 @@ Return Value On success, sd_event_set_watchdog() and - sd_event_get_watchdog() 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 - b parameter. On failure, they return a - negative errno-style error - code. - + sd_event_get_watchdog() 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 + b parameter. On failure, they return a negative errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. - + The event loop has been created in a different process. + - - -EINVAL + + -EINVAL - The passed event loop object was invalid. - + The passed event loop object was invalid. + - + + 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 @@ Return Value - On success, - sd_event_source_get_pending() 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. - + On success, sd_event_source_get_pending() 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. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - source is not a valid - pointer to an sd_event_source - object. - + source is not a valid pointer to an + sd_event_source object. + - - -EDOM + + -EDOM - source refers to an - event source object created with - sd_event_add_exit3. - + source refers to an event source object created with + sd_event_add_exit3. + - - -ENOMEM + + -ENOMEM - Not enough memory. - + Not enough memory. + - - -ESTALE + + -ESTALE - The event loop is already terminated. + The event loop is already terminated. - + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. + The event loop has been created in a different process. - + - + + 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 @@ Return Value On success, sd_event_source_set_description() and - sd_event_source_get_description() return a - non-negative integer. On failure, they return a negative - errno-style error code. - + sd_event_source_get_description() return a non-negative integer. On failure, they + return a negative errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - source is not a valid - pointer to an sd_event_source - object or the description argument for - sd_event_source_get_description() is - NULL. - + source is not a valid pointer to an + sd_event_source object or the description argument + for sd_event_source_get_description() is NULL. + + - - -ENOMEM + + -ENOMEM - Not enough memory to copy the - name. - + Not enough memory to copy the name. + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. + The event loop has been created in a different process. - + - - -ENXIO + + -ENXIO - No name was set for the event - source. - + No name was set for the event source. + - + + 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 @@ Return Value - On success, sd_event_source_set_destroy_callback() returns 0 or a positive integer. On - failure, it returns a negative errno-style error code. + On success, sd_event_source_set_destroy_callback() returns 0 or a positive + integer. On failure, it returns a negative errno-style error code. - sd_event_source_get_destroy_callback() returns positive if the destroy callback function - is set, 0 if not. On failure, returns a negative errno-style error code. - + sd_event_source_get_destroy_callback() returns positive if the destroy + callback function is set, 0 if not. On failure, returns a negative errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The source parameter is NULL. - - + The source parameter is NULL. + + + + 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 @@ Return Value On success, sd_event_source_set_enabled() returns a non-negative - integer. sd_event_source_get_enabled() returns zero if the source is - disabled (SD_EVENT_OFF) and a positive integer otherwise. On failure, they - return a negative errno-style error code. - + integer. sd_event_source_get_enabled() returns zero if the source is disabled + (SD_EVENT_OFF) and a positive integer otherwise. On failure, they return a negative + errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - source is not a valid - pointer to an sd_event_source - object. - + source is not a valid pointer to an + sd_event_source object. + - - -ENOMEM + + -ENOMEM - Not enough memory. - + Not enough memory. + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. + The event loop has been created in a different process. - + - + + 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 @@ Return Value - On success, - sd_event_source_set_prepare() returns a - non-negative integer. On failure, it returns a negative - errno-style error code. - + On success, sd_event_source_set_prepare() returns a non-negative integer. On + failure, it returns a negative errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - source is not a valid - pointer to an sd_event_source - object. - + source is not a valid pointer to an + sd_event_source object. + - - -ESTALE + + -ESTALE - The event loop is already terminated. + The event loop is already terminated. - - - -ENOMEM + + + -ENOMEM - Not enough memory. - + Not enough memory. + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. + The event loop has been created in a different process. - + - - -EDOM + + -EDOM - The specified event source has been created - with - sd_event_add_exit3. + The specified event source has been created with + sd_event_add_exit3. - + - + + 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 @@ Return Value - On success, - sd_event_source_set_priority() and - sd_event_source_get_priority() return a - non-negative integer. On failure, they return a negative - errno-style error code. - + On success, sd_event_source_set_priority() and + sd_event_source_get_priority() return a non-negative integer. On failure, they + return a negative errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - source is not a valid - pointer to an sd_event_source - object. - + source is not a valid pointer to an + sd_event_source object. + - - -ENOMEM + + -ENOMEM - Not enough memory. - + Not enough memory. + - - -ESTALE + + -ESTALE - The event loop is already terminated. + The event loop is already terminated. - + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. + The event loop has been created in a different process. - + - + + 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 @@ Return Value - On success, these functions return 0 or a positive integer. - On failure, they return a negative errno-style error code. In case - of sd_event_prepare() and - sd_event_wait(), 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 - sd_event_dispatch(), a positive, non-zero - return code indicates that the event loop returned to its initial - state and zero indicates the event loop has - exited. sd_event_get_state() returns a - positive or zero state on success. - + On success, these functions return 0 or a positive integer. On failure, they return a negative + errno-style error code. In case of sd_event_prepare() and + sd_event_wait(), 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 + sd_event_dispatch(), a positive, non-zero return code indicates that the event loop + returned to its initial state and zero indicates the event loop has + exited. sd_event_get_state() returns a positive or zero state on success. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - - - -EINVAL + + + -EINVAL - The event parameter is - invalid or NULL. - + The event parameter is invalid or NULL. + + - - -EBUSY + + -EBUSY - The event loop object is not in the right - state. - + The event loop object is not in the right state. + - - -ESTALE + + -ESTALE - The event loop is already terminated. + The event loop is already terminated. - + - - -ECHILD + + -ECHILD - The event loop has been created in a different process. + The event loop has been created in a different process. - + - + - Other errors are possible, too. + Other errors are possible, too. + 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 @@ Return Value - On success, sd_get_seats(), - sd_get_sessions(), - sd_get_uids() and - sd_get_machine_names() return the number of - entries in the arrays. On failure, these calls return a negative - errno-style error code. - + On success, sd_get_seats(), sd_get_sessions(), + sd_get_uids() and sd_get_machine_names() return the number of + entries in the arrays. On failure, these calls return a negative errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 { sd_login_monitor_unref() always returns NULL. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -EINVAL + + -EINVAL - An input parameter was invalid (out of range, - or NULL, where that is not accepted). The specified category to - watch is not known. - + An input parameter was invalid (out of range, or NULL, where + that is not accepted). The specified category to watch is not known. + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ Return Value - On success, these calls return 0 or a positive integer. On - failure, these calls return a negative errno-style error - code. - + On success, these calls return 0 or a positive integer. On failure, these calls return a negative + errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -ENXIO + + -ENXIO - The specified machine does not exist or is currently not running. - - + The specified machine does not exist or is currently not running. + + - - -EINVAL + + -EINVAL - An input parameter was invalid (out of range, - or NULL, where that is not accepted). - + An input parameter was invalid (out of range, or NULL, where + that is not accepted). + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ Return Value - On success, these calls return 0 or a positive integer. On - failure, these calls return a negative errno-style error - code. - + On success, these calls return 0 or a positive integer. On failure, these calls return a negative + errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -ESRCH + + -ESRCH - The specified PID does not refer to a running - process. - - + The specified PID does not refer to a running process. + + - - -EBADF + + -EBADF - The specified socket file descriptor was - invalid. - + The specified socket file descriptor was invalid. + - - -ENODATA + + -ENODATA - The given field is not specified for the described - process or peer. - - + The given field is not specified for the described process or peer. + + - - -EINVAL + + -EINVAL - An input parameter was invalid (out of range, - or NULL, where that is not accepted). - + An input parameter was invalid (out of range, or NULL, where + that is not accepted). + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ Return Value - On success, sd_seat_get_active() - returns 0 or a positive integer. On success, - sd_seat_get_sessions() returns the number of - entries in the session identifier array. If the test succeeds, - sd_seat_can_multi_session, - sd_seat_can_tty and - sd_seat_can_graphical return a positive - integer, if it fails 0. On failure, these calls return a negative - errno-style error code. - + On success, sd_seat_get_active() returns 0 or a positive integer. On success, + sd_seat_get_sessions() returns the number of entries in the session identifier + array. If the test succeeds, sd_seat_can_multi_session, + sd_seat_can_tty and sd_seat_can_graphical return a positive + integer, if it fails 0. On failure, these calls return a negative errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -ENODATA + + -ENODATA - The given field is not specified for the described - seat. - - + The given field is not specified for the described seat. + + - - -ENXIO + + -ENXIO - The specified seat is unknown. - - + The specified seat is unknown. + + - - -EINVAL + + -EINVAL - An input parameter was invalid (out of range, - or NULL, where that is not accepted). - + An input parameter was invalid (out of range, or NULL, where + that is not accepted). + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ sd_session_get_tty() return 0 or a positive integer. On failure, these calls return a negative errno-style error code. - - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -ENXIO + + -ENXIO - The specified session does not exist. - - + The specified session does not exist. + + - - -ENODATA + + -ENODATA - The given field is not specified for the described - session. - - + The given field is not specified for the described session. + + - - -EINVAL + + -EINVAL - An input parameter was invalid (out of range, - or NULL, where that is not accepted). - + An input parameter was invalid (out of range, or NULL, where + that is not accepted). + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + + 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 @@ Return Value - On success, sd_uid_get_state() returns - 0 or a positive integer. If the test succeeds, - sd_uid_is_on_seat() returns a positive - integer; if it fails, 0. - sd_uid_get_sessions() and - sd_uid_get_seats() return the number of - entries in the returned arrays. - sd_uid_get_display() returns a non-negative - code on success. On failure, these calls return a negative - errno-style error code. - + On success, sd_uid_get_state() returns 0 or a positive integer. If the test + succeeds, sd_uid_is_on_seat() returns a positive integer; if it fails, 0. + sd_uid_get_sessions() and sd_uid_get_seats() return the number + of entries in the returned arrays. sd_uid_get_display() returns a non-negative code + on success. On failure, these calls return a negative errno-style error code. - - Errors + + Errors - Returned errors may indicate the following problems: + Returned errors may indicate the following problems: - + - - -ENODATA + + -ENODATA - The given field is not specified for the described - user. - - + The given field is not specified for the described user. + + - - -ENXIO + + -ENXIO - The specified seat is unknown. - - + The specified seat is unknown. + + - - -EINVAL + + -EINVAL - 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. - + 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. + - - -ENOMEM + + -ENOMEM - Memory allocation failed. - - + Memory allocation failed. + + +