diff options
author | Daan De Meyer <daan.j.demeyer@gmail.com> | 2020-04-20 21:39:07 +0200 |
---|---|---|
committer | Daan De Meyer <daan.j.demeyer@gmail.com> | 2020-04-20 21:39:07 +0200 |
commit | b778146b94c927e26e289d0f2cd3514f5438a5a3 (patch) | |
tree | 8a9d175feaca765a3812e4d46ade66c0489c4bdd | |
parent | 75358555a5d2eb5bdc574808a39c33e34ccf5d22 (diff) | |
download | systemd-b778146b94c927e26e289d0f2cd3514f5438a5a3.tar.gz |
sd-bus: Rewrap sd_bus_set_description docs
-rw-r--r-- | man/sd_bus_set_description.xml | 74 |
1 files changed, 35 insertions, 39 deletions
diff --git a/man/sd_bus_set_description.xml b/man/sd_bus_set_description.xml index b855008eb8..05764bc471 100644 --- a/man/sd_bus_set_description.xml +++ b/man/sd_bus_set_description.xml @@ -82,53 +82,49 @@ <refsect1> <title>Description</title> - <para><function>sd_bus_set_description()</function> sets the description string - that is used in logging to the specified string. The string is copied internally - and freed when the bus object is deallocated. The - <parameter>description</parameter> argument may be <constant>NULL</constant>, in - which case the description is unset. This function must be called before the bus - is started.</para> - - <para><function>sd_bus_get_description()</function> returns a description string - in <parameter>description</parameter>. This string may have been previously set - with <function>sd_bus_set_description()</function> or + <para><function>sd_bus_set_description()</function> sets the description string that is used in + logging to the specified string. The string is copied internally and freed when the bus object + is deallocated. The <parameter>description</parameter> argument may be + <constant>NULL</constant>, in which case the description is unset. This function must be called + before the bus is started.</para> + + <para><function>sd_bus_get_description()</function> returns a description string in + <parameter>description</parameter>. This string may have been previously set with + <function>sd_bus_set_description()</function> or <citerefentry><refentrytitle>sd_bus_open_with_description</refentrytitle><manvolnum>3</manvolnum></citerefentry> - or similar. If not set this way, a default string like <literal>system</literal> - or <literal>user</literal> will be returned for the system or user buses, - and <constant>NULL</constant> otherwise.</para> + or similar. If not set this way, a default string like <literal>system</literal> or + <literal>user</literal> will be returned for the system or user buses, and + <constant>NULL</constant> otherwise.</para> - <para><function>sd_bus_set_anonymous()</function> enables or disables "anonymous - authentication", i.e. lack of authentication, of the bus peer. This function must - be called before the bus is started. See the <ulink - url="view-source:https://dbus.freedesktop.org/doc/dbus-specification.html#auth-mechanisms">Authentication - Mechanisms</ulink> section of the D-Bus specification for details.</para> + <para><function>sd_bus_set_anonymous()</function> enables or disables "anonymous authentication", + i.e. lack of authentication, of the bus peer. This function must be called before the bus is + started. See the + <ulink url="view-source:https://dbus.freedesktop.org/doc/dbus-specification.html#auth-mechanisms"> + Authentication Mechanisms</ulink> section of the D-Bus specification for details.</para> - <para><function>sd_bus_is_anonymous()</function> returns true if the bus connection allows anonymous - authentication (in the sense described in previous paragraph).</para> + <para><function>sd_bus_is_anonymous()</function> returns true if the bus connection allows + anonymous authentication (in the sense described in previous paragraph).</para> <para><function>sd_bus_set_trusted()</function> sets the "trusted" state on the - <parameter>bus</parameter> object. If true, all connections on the bus are - trusted and access to all privileged and unprivileged methods is granted. This - function must be called before the bus is started.</para> + <parameter>bus</parameter> object. If true, all connections on the bus are trusted and access to + all privileged and unprivileged methods is granted. This function must be called before the bus + is started.</para> - <para><function>sd_bus_is_trusted()</function> returns true if the bus connection is trusted (in the - sense described in previous paragraph).</para> + <para><function>sd_bus_is_trusted()</function> returns true if the bus connection is trusted (in + the sense described in previous paragraph).</para> - <para><function>sd_bus_set_allow_interactive_authorization()</function> - enables or disables interactive authorization for method calls. If true, - messages are marked with the + <para><function>sd_bus_set_allow_interactive_authorization()</function> enables or disables + interactive authorization for method calls. If true, messages are marked with the <constant>ALLOW_INTERACTIVE_AUTHORIZATION</constant> flag specified by the - <ulink - url="view-source:https://dbus.freedesktop.org/doc/dbus-specification.html">D-Bus</ulink> - specification, informing the receiving side that the caller is prepared to - wait for interactive authorization, which might take a considerable time to - complete. If this flag is set, the user may be queried for passwords or - confirmation via <ulink - url="http://www.freedesktop.org/wiki/Software/polkit">polkit</ulink> or a - similar framework.</para> - - <para><function>sd_bus_get_allow_interactive_authorization()</function> returns - true if interactive authorization is allowed and false if not.</para> + <ulink url="view-source:https://dbus.freedesktop.org/doc/dbus-specification.html">D-Bus</ulink> + specification, informing the receiving side that the caller is prepared to wait for interactive + authorization, which might take a considerable time to complete. If this flag is set, the user + may be queried for passwords or confirmation via + <ulink url="http://www.freedesktop.org/wiki/Software/polkit">polkit</ulink> or a similar + framework.</para> + + <para><function>sd_bus_get_allow_interactive_authorization()</function> returns true if + interactive authorization is allowed and false if not.</para> </refsect1> <refsect1> |