man: remove references to systemadm from systemctl man page

[elogind.git] / man / sd_bus_open_user.xml

diff --git a/man/sd_bus_open_user.xml b/man/sd_bus_open_user.xml
index 0effee461d2b2296c84ea5acf2004e7bd437cda5..e7a765962a782b6e3c522c36a3faa0aaba439270 100644 (file)
--- a/man/sd_bus_open_user.xml
+++ b/man/sd_bus_open_user.xml
@@ -1,4 +1,4 @@
-<?xml version='1.0'?> <!--*-nxml-*-->
+<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
@@ -21,7 +21,7 @@ You should have received a copy of the GNU Lesser General Public License
 along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="sd_bus_open_user">
+<refentry id="sd_bus_open_user" conditional="ENABLE_KDBUS">
 
   <refentryinfo>
     <title>sd_bus_open_user</title>
@@ -60,34 +60,34 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
       <funcprototype>
         <funcdef>int <function>sd_bus_open_user</function></funcdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_open_system</function></funcdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_open_system_remote</function></funcdef>
         <paramdef>const char *<parameter>host</parameter></paramdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_open_system_container</function></funcdef>
         <paramdef>const char *<parameter>machine</parameter></paramdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_default_user</function></funcdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_default_system</function></funcdef>
-        <paramdef>sd_bus** <parameter>bus</parameter></paramdef>
+        <paramdef>sd_bus **<parameter>bus</parameter></paramdef>
       </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>
@@ -96,19 +96,19 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <title>Description</title>
 
     <para><function>sd_bus_open_user()</function> creates a new bus
-    object and opens a connection to the the user bus.
+    object and opens a connection to the user bus.
     <function>sd_bus_open_system()</function> does the same, but
     connects to the system bus.</para>
 
-    <para>If <varname>$DBUS_SESSION_BUS_ADDRESS</varname> environment
+    <para>If the <varname>$DBUS_SESSION_BUS_ADDRESS</varname> environment
     variable is set
-    (c.f. <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
+    (cf. <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
     it will be used as the address of the user bus. This variable can
     contain multiple addresses separated by <literal>;</literal>. If
     this variable is not set, a suitable default for the default user
     D-Bus instance will be used.</para>
 
-    <para>If <varname>$DBUS_SYSTEM_BUS_ADDRESS</varname> environment
+    <para>If the <varname>$DBUS_SYSTEM_BUS_ADDRESS</varname> environment
     variable is set, it will be used as the address of the system
     bus. This variable uses the same syntax as
     <varname>$DBUS_SESSION_BUS_ADDRESS</varname>/. If this variable is
@@ -121,16 +121,16 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     followed by the <literal>@</literal> symbol, and the hostname.
     </para>
 
-    <para><function>sd_bus_open_system_remote()</function> connects to
-    the system bus in the specified <parameter>machine</parameter>,
+    <para><function>sd_bus_open_system_container()</function> connects
+    to the system bus in the specified <parameter>machine</parameter>,
     where <parameter>machine</parameter> is the name of a container.
     See
     <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
     for more information about "machines".</para>
 
     <para><function>sd_bus_default_user()</function> returns a bus
-    object connected to the user bus. This bus object is shared
-    per-thread. It is created on the first invocation of
+    object connected to the user bus. Each thread has its own object, but it
+    may be passed around. It is created on the first invocation of
     <function>sd_bus_default_user()</function>, and subsequent
     invocations returns a reference to the same object.</para>
 
@@ -158,7 +158,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <citerefentry><refentrytitle>sd_bus_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
     </para>
 
-    <para>Functions <function>sd_bus_default_user()</function> and
+    <para>The functions <function>sd_bus_default_user()</function> and
     <function>sd_bus_default_system()</function> do not create a new
     reference.</para>
   </refsect1>
@@ -171,7 +171,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <variablelist>
 
       <varlistentry>
-        <term><varname>-EINVAL</varname></term>
+        <term><constant>-EINVAL</constant></term>
 
         <listitem><para>Specified parameter is invalid
         (<constant>NULL</constant> in case of output
@@ -179,7 +179,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><varname>-ENOMEM</varname></term>
+        <term><constant>-ENOMEM</constant></term>
 
         <listitem><para>Memory allocation failed.</para></listitem>
       </varlistentry>
@@ -195,7 +195,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><function>sd_bus_open_user()</function> and other functions
     described here are available as a shared library, which can be
     compiled and linked to with the
-    <constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
     file.</para>
   </refsect1>