X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_bus_creds_get_pid.xml;h=d61ec19cb84ff7f5d8ace5dc7e5d02cb0f0916dd;hp=f84fbae35c4bd175da681d7ac0443a2617742353;hb=5a8bcb674f71a20e95df55319b34c556638378ce;hpb=7c071fda945a8f9e3b11d37dc04c8bdfa615d44a

diff --git a/man/sd_bus_creds_get_pid.xml b/man/sd_bus_creds_get_pid.xml
index f84fbae35..d61ec19cb 100644
--- a/man/sd_bus_creds_get_pid.xml
+++ b/man/sd_bus_creds_get_pid.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">
 
@@ -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,77 +230,73 @@ 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>
 
-    <para><function>sd_bus_creds_get_pid</function> will retrieve the
+    <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
+    <para><function>sd_bus_creds_get_tid()</function> will retrieve the
     TID (thread identifier).</para>
 
-    <para><function>sd_bus_creds_get_uid</function> will retrieve the
+    <para><function>sd_bus_creds_get_uid()</function> will retrieve the
     numeric UID (user identifier).</para>
 
-    <para><function>sd_bus_creds_get_gid</function> will retrieve the
+    <para><function>sd_bus_creds_get_gid()</function> will retrieve the
     numeric GID (group identifier).</para>
 
-    <para><function>sd_bus_creds_get_comm</function> will retrieve the
+    <para><function>sd_bus_creds_get_comm()</function> will retrieve the
     comm field (truncated name of the executable, as stored in
     <filename>/proc/<replaceable>pid</replaceable>/comm</filename>).
     </para>
 
-    <para><function>sd_bus_creds_get_tid_comm</function> will retrieve
+    <para><function>sd_bus_creds_get_tid_comm()</function> will retrieve
     the comm field of the thread (as stored in
     <filename>/proc/<replaceable>pid</replaceable>/task/<replaceable>tid</replaceable>/comm</filename>).
     </para>
 
-    <para><function>sd_bus_creds_get_exe</function> will retrieve the
+    <para><function>sd_bus_creds_get_exe()</function> will retrieve the
     path to the program (as stored in the
     <filename>/proc/<replaceable>pid</replaceable>/exe</filename>
     link, but with <literal> (deleted)</literal> suffix removed).
     </para>
 
-    <para><function>sd_bus_creds_get_cmdline</function> will retrieve
-    an array of command-line arguments (as stored in
+    <para><function>sd_bus_creds_get_cmdline()</function> will retrieve
+    an array of command line arguments (as stored in
     <filename>/proc/<replaceable>pid</replaceable>/cmdline</filename>).
     </para>
 
-    <para><function>sd_bus_creds_get_cgroup</function> will retrieve
+    <para><function>sd_bus_creds_get_cgroup()</function> will retrieve
     the cgroup path. See <ulink
     url="https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>.
     </para>
 
-    <para><function>sd_bus_creds_get_unit</function> will retrieve the
+    <para><function>sd_bus_creds_get_unit()</function> will retrieve the
     systemd unit name (in the system instance of systemd) that the
     process is part of. See
     <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
     </para>
 
-    <para><function>sd_bus_creds_get_user_unit</function> will
+    <para><function>sd_bus_creds_get_user_unit()</function> will
     retrieve the systemd unit name (in the user instance of systemd)
     that the process is part of. See
     <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
     </para>
 
-    <para><function>sd_bus_creds_get_slice</function> will retrieve
+    <para><function>sd_bus_creds_get_slice()</function> will retrieve
     the systemd slice (a unit in the system instance of systemd) that
     the process is part of. See
     <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
     </para>
 
-    <para><function>sd_bus_creds_get_session</function> will retrieve
+    <para><function>sd_bus_creds_get_session()</function> will retrieve
     the logind session that the process is part of. See
     <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
     </para>
 
-    <para><function>sd_bus_creds_get_owner_uid</function> will retrieve
+    <para><function>sd_bus_creds_get_owner_uid()</function> will retrieve
     the numeric UID (user identifier) of the user who owns the slice
     that the process is part of. See
     <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>
@@ -308,50 +304,57 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <citerefentry><refentrytitle>systemd-user-sessions.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> -->.
     </para>
 
-    <para><function>sd_bus_creds_has_effective_cap</function> will
+    <para><function>sd_bus_creds_has_effective_cap()</function> will
     check whether the capability specified by
     <parameter>capability</parameter> was set in the effective
     capabilities mask. A positive return value means that is was
     set, zero means that it was not set, and a negative return
     value signifies an error. See
-    <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+    <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
     and <varname>Capabilities=</varname> and
     <varname>CapabilityBoundingSet=</varname> settings in
     <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
     </para>
 
-    <para><function>sd_bus_creds_has_permitted_cap</function> is
-    similar to <function>sd_bus_creds_has_effective_cap</function>,
+    <para><function>sd_bus_creds_has_permitted_cap()</function> is
+    similar to <function>sd_bus_creds_has_effective_cap()</function>,
     but will check the permitted capabilities mask.</para>
 
-    <para><function>sd_bus_creds_has_inheritable_cap</function> is
-    similar to <function>sd_bus_creds_has_effective_cap</function>,
+    <para><function>sd_bus_creds_has_inheritable_cap()</function> is
+    similar to <function>sd_bus_creds_has_effective_cap()</function>,
     but will check the inheritable capabilities mask.</para>
 
-    <para><function>sd_bus_creds_has_bounding_cap</function> is
-    similar to <function>sd_bus_creds_has_effective_cap</function>,
+    <para><function>sd_bus_creds_has_bounding_cap()</function> is
+    similar to <function>sd_bus_creds_has_effective_cap()</function>,
     but will check the bounding capabilities mask.</para>
 
-    <para><function>sd_bus_creds_get_selinux_context</function> will
+    <para><function>sd_bus_creds_get_selinux_context()</function> will
     retrieve the SELinux security context (label) of the process.</para>
 
-    <para><function>sd_bus_creds_get_audit_session_id</function> will
+    <para><function>sd_bus_creds_get_audit_session_id()</function> will
     retrieve the audit session identifier of the process.</para>
 
-    <para><function>sd_bus_creds_get_audit_login_uid</function> will
+    <para><function>sd_bus_creds_get_audit_login_uid()</function> will
     retrieve the audit user login identifier (the identifier of the
     user who is "responsible" for the session).</para>
 
-    <para><function>sd_bus_creds_get_unique_name</function> will
+    <para><function>sd_bus_creds_get_unique_name()</function> will
     retrieve the D-Bus unique name. See <ulink
     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_well_known_names</function> will
+    <para><function>sd_bus_creds_get_well_known_names()</function> will
     retrieve the set of D-Bus well-known names. See <ulink
     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
@@ -381,7 +384,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <variablelist>
       <varlistentry>
-        <term><varname>-ENODATA</varname></term>
+        <term><constant>-ENODATA</constant></term>
 
         <listitem><para>Given field is not available in
         <parameter>c</parameter>.</para>
@@ -389,36 +392,36 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><varname>-ENOENT</varname></term>
+        <term><constant>-ENOENT</constant></term>
 
         <listitem><para>Given field is not specified for the sender.
-        This will be returned by <function>sd_bus_get_unit</function>,
-        <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
+        This will be returned by <function>sd_bus_get_unit()</function>,
+        <function>sd_bus_get_user_unit()</function>,
+        <function>sd_bus_get_slice()</function>,
+        <function>sd_bus_get_session()</function>, and
+        <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>
       </varlistentry>
 
       <varlistentry>
-        <term><varname>-ENXIO</varname></term>
+        <term><constant>-ENXIO</constant></term>
 
-        <listitem><para>An error occured in parsing cgroup paths.
+        <listitem><para>An error occurred in parsing cgroup paths.
         <filename>libsystemd</filename> might be out of sync with
         the running systemd version.</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><varname>-EINVAL</varname></term>
+        <term><constant>-EINVAL</constant></term>
 
         <listitem><para>Specified pointer parameter is <constant>NULL</constant>.
         </para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><varname>-ENOMEM</varname></term>
+        <term><constant>-ENOMEM</constant></term>
 
         <listitem><para>Memory allocation failed.</para></listitem>
       </varlistentry>
@@ -431,7 +434,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>
 
@@ -441,11 +444,11 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para>
       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.journald-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
     </para>
   </refsect1>