diff options
Diffstat (limited to 'man/sd_bus_default.xml')
| -rw-r--r-- | man/sd_bus_default.xml | 40 |
1 files changed, 38 insertions, 2 deletions
diff --git a/man/sd_bus_default.xml b/man/sd_bus_default.xml index 53cc9d7768..dfb32b9b4f 100644 --- a/man/sd_bus_default.xml +++ b/man/sd_bus_default.xml @@ -1,4 +1,4 @@ -<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> +<?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> @@ -24,8 +24,11 @@ <refname>sd_bus_default_system</refname> <refname>sd_bus_open</refname> + <refname>sd_bus_open_with_description</refname> <refname>sd_bus_open_user</refname> + <refname>sd_bus_open_user_with_description</refname> <refname>sd_bus_open_system</refname> + <refname>sd_bus_open_system_with_description</refname> <refname>sd_bus_open_system_remote</refname> <refname>sd_bus_open_system_machine</refname> @@ -57,16 +60,34 @@ </funcprototype> <funcprototype> + <funcdef>int <function>sd_bus_open_with_description</function></funcdef> + <paramdef>sd_bus **<parameter>bus</parameter></paramdef> + <paramdef>const char *<parameter>description</parameter></paramdef> + </funcprototype> + + <funcprototype> <funcdef>int <function>sd_bus_open_user</function></funcdef> <paramdef>sd_bus **<parameter>bus</parameter></paramdef> </funcprototype> <funcprototype> + <funcdef>int <function>sd_bus_open_user_with_description</function></funcdef> + <paramdef>sd_bus **<parameter>bus</parameter></paramdef> + <paramdef>const char *<parameter>description</parameter></paramdef> + </funcprototype> + + <funcprototype> <funcdef>int <function>sd_bus_open_system</function></funcdef> <paramdef>sd_bus **<parameter>bus</parameter></paramdef> </funcprototype> <funcprototype> + <funcdef>int <function>sd_bus_open_system_with_description</function></funcdef> + <paramdef>sd_bus **<parameter>bus</parameter></paramdef> + <paramdef>const char *<parameter>description</parameter></paramdef> + </funcprototype> + + <funcprototype> <funcdef>int <function>sd_bus_open_system_remote</function></funcdef> <paramdef>sd_bus **<parameter>bus</parameter></paramdef> <paramdef>const char *<parameter>host</parameter></paramdef> @@ -126,6 +147,20 @@ <function>sd_bus_default_system()</function> to connect to the user or system buses.</para> + <para><function>sd_bus_open_with_description()</function>, + <function>sd_bus_open_user_with_description()</function>, and + <function>sd_bus_open_system_with_description()</function> are similar to + <function>sd_bus_open()</function>, <function>sd_bus_open_user()</function>, and + <function>sd_bus_open_system()</function>, but allow a description string to be set, see + <citerefentry><refentrytitle>sd_bus_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + <parameter>description</parameter> may be <constant>NULL</constant>, in which case this function + is equivalent to <function>sd_bus_open()</function>. This description string is used in log + messages about the bus object, and including a "name" for the bus makes them easier to + understand. Some messages are emitted during bus initialization, hence using this function is + prefereable to setting the description later with + <function>sd_bus_open_with_description()</function>. The argument is copied internally and will + not be referenced after the function returns.</para> + <para>If the <varname>$DBUS_SESSION_BUS_ADDRESS</varname> environment variable is set (cf. <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>), @@ -146,7 +181,8 @@ <citerefentry project='die-net'><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry>. <parameter>host</parameter> consists of an optional user name followed by the <literal>@</literal> symbol, and the hostname, optionally followed by a - <literal>:</literal> and a machine name. If the machine name is given, a connection + <literal>:</literal> and a port, optionally followed by a + <literal>/</literal> and a machine name. If the machine name is given, a connection is created to the system bus in the specified container on the remote machine, and otherwise a connection to the system bus on the specified host is created.</para> |