chiark / gitweb /
man: bring machinectl man page up-to-date
[elogind.git] / man / sd_bus_creds_get_pid.xml
index fcc5557163ab2a36b9bb3edd071a6469ae07f561..d61ec19cb84ff7f5d8ace5dc7e5d02cb0f0916dd 100644 (file)
@@ -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">
 
@@ -44,7 +44,6 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
   <refnamediv>
     <refname>sd_bus_creds_get_pid</refname>
-    <refname>sd_bus_creds_get_pid_starttime</refname>
     <refname>sd_bus_creds_get_tid</refname>
     <refname>sd_bus_creds_get_uid</refname>
     <refname>sd_bus_creds_get_gid</refname>
@@ -67,6 +66,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <refname>sd_bus_creds_get_audit_login_uid</refname>
     <refname>sd_bus_creds_get_unique_name</refname>
     <refname>sd_bus_creds_get_well_known_names</refname>
+    <refname>sd_bus_creds_get_connection_name</refname>
 
     <refpurpose>Retrieve fields from a credentials object</refpurpose>
   </refnamediv>
@@ -81,12 +81,6 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <paramdef>pid_t *<parameter>pid</parameter></paramdef>
       </funcprototype>
 
-      <funcprototype>
-        <funcdef>int <function>sd_bus_creds_get_pid_starttime</function></funcdef>
-        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
-        <paramdef>uint64_t *<parameter>usec</parameter></paramdef>
-      </funcprototype>
-
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_tid</function></funcdef>
         <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
@@ -219,6 +213,12 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <paramdef>char ***<parameter>name</parameter></paramdef>
       </funcprototype>
 
+      <funcprototype>
+        <funcdef>int <function>sd_bus_creds_get_connection_name</function></funcdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
+        <paramdef>const char **<parameter>name</parameter></paramdef>
+      </funcprototype>
+
     </funcsynopsis>
   </refsynopsisdiv>
 
@@ -230,7 +230,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
     in which case it will describe the specified process, or it may be
     created by
-    <citerefentry><refentrytitle>sd_bus_get_peer_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>sd_bus_get_owner_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
     in which case it will describe the process at the other endpoint
     of a connection.
     </para>
@@ -238,10 +238,6 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><function>sd_bus_creds_get_pid()</function> will retrieve the
     PID (process identifier).</para>
 
-    <para><function>sd_bus_creds_get_pid_starttime()</function> will
-    retrieve the time since the start of the epoch in microseconds
-    since the process was started.</para>
-
     <para><function>sd_bus_creds_get_tid()</function> will retrieve the
     TID (thread identifier).</para>
 
@@ -268,7 +264,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     </para>
 
     <para><function>sd_bus_creds_get_cmdline()</function> will retrieve
-    an array of command-line arguments (as stored in
+    an array of command line arguments (as stored in
     <filename>/proc/<replaceable>pid</replaceable>/cmdline</filename>).
     </para>
 
@@ -352,6 +348,13 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus">The
     D-Bus specification</ulink>.</para>
 
+    <para><function>sd_bus_creds_get_connection_name()</function> will
+    retrieve a descriptive name of the bus connection of the
+    peer. This name is useful to discern multiple bus connections by
+    the same peer, and may be altered by the peer with the
+    <citerefentry><refentrytitle>sd_bus_set_name()</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    call.</para>
+
     <para>All functions that take a <parameter>const
     char**</parameter> parameter will store the answer there as an
     address of a NUL-terminated string. It will be valid as long as
@@ -396,7 +399,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <function>sd_bus_get_user_unit()</function>,
         <function>sd_bus_get_slice()</function>,
         <function>sd_bus_get_session()</function>, and
-        <function>sd_bus_get_owner_uid()</function> if the sender is not
+        <function>sd_bus_get_name_creds_uid()</function> if the sender is not
         part of a systemd system unit, systemd user unit, systemd
         slice, logind session, or a systemd user session.</para>
         </listitem>