X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_pid_get_session.xml;h=fd1ce4b87e1a1946f18a73a144cc4a5369a3d138;hp=94f533022263c1dd018a37370a2df690fca1cf06;hb=8e7076caae32a560a11c1643b53fc4f12db4a6b1;hpb=50b1678aaba9d3c2be5115db34a822911d791b8c

diff --git a/man/sd_pid_get_session.xml b/man/sd_pid_get_session.xml
index 94f533022..fd1ce4b87 100644
--- a/man/sd_pid_get_session.xml
+++ b/man/sd_pid_get_session.xml
@@ -8,20 +8,20 @@
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
   (at your option) any later version.
 
   systemd is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-  General Public License for more details.
+  Lesser General Public License for more details.
 
-  You should have received a copy of the GNU General Public License
+  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_pid_get_session">
+<refentry id="sd_pid_get_session" conditional='HAVE_PAM'>
 
         <refentryinfo>
                 <title>sd_pid_get_session</title>
@@ -45,8 +45,10 @@
         <refnamediv>
                 <refname>sd_pid_get_session</refname>
                 <refname>sd_pid_get_unit</refname>
+                <refname>sd_pid_get_user_unit</refname>
                 <refname>sd_pid_get_owner_uid</refname>
-                <refpurpose>Determine session, service or owner of a session of a specific PID</refpurpose>
+                <refname>sd_pid_get_machine_name</refname>
+                <refpurpose>Determine session, service, owner of a session or container/VM of a specific PID</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -65,11 +67,23 @@
                                 <paramdef>char** <parameter>unit</parameter></paramdef>
                         </funcprototype>
 
+                        <funcprototype>
+                                <funcdef>int <function>sd_pid_get_user_unit</function></funcdef>
+                                <paramdef>pid_t <parameter>pid</parameter></paramdef>
+                                <paramdef>char** <parameter>unit</parameter></paramdef>
+                        </funcprototype>
+
                         <funcprototype>
                                 <funcdef>int <function>sd_pid_get_owner_uid</function></funcdef>
                                 <paramdef>pid_t <parameter>pid</parameter></paramdef>
                                 <paramdef>uid_t* <parameter>uid</parameter></paramdef>
                         </funcprototype>
+
+                        <funcprototype>
+                                <funcdef>int <function>sd_pid_get_machine_name</function></funcdef>
+                                <paramdef>pid_t <parameter>pid</parameter></paramdef>
+                                <paramdef>char** <parameter>name</parameter></paramdef>
+                        </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
 
@@ -91,18 +105,28 @@
                 call after use.</para>
 
                 <para><function>sd_pid_get_unit()</function> may be
-                used to determine the systemd unit (i.e. system
+                used to determine the systemd system unit (i.e. system
                 service) identifier of a process identified by the
-                specified process identifier. The unit name is a short
-                string, suitable for usage in file system paths. Note
-                that not all processes are part of a unit/service
+                specified PID. The unit name is a short string,
+                suitable for usage in file system paths. Note that not
+                all processes are part of a system unit/service
                 (e.g. user processes, or kernel threads). For
-                processes not being part of a systemd unit/system
-                service this function will fail. The returned string
-                needs to be freed with the libc
+                processes not being part of a systemd system unit this
+                function will fail. (More specifically: this call will
+                not work for processes that are part of user units,
+                use <function>sd_pid_get_user_unit()</function> for
+                that.) The returned string needs to be freed with the
+                libc
                 <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call after use.</para>
 
+                <para><function>sd_pid_get_user_unit()</function> may
+                be used to determine the systemd user unit (i.e. user
+                service) identifier of a process identified by the
+                specified PID. This is similar to
+                <function>sd_pid_get_unit()</function> but applies to
+                user units instead of system units.</para>
+
                 <para><function>sd_pid_get_owner_uid()</function> may
                 be used to determine the Unix user identifier of the
                 owner of the session of a process identified the
@@ -114,7 +138,15 @@
                 and not being a shared process of a user this function
                 will fail.</para>
 
-                <para>If the <literal>pid</literal> paramater of any
+                <para><function>sd_pid_machine_name()</function> may
+                be used to determine the name of the VM or container
+                is a member of. The machine name is a short string,
+                suitable for usage in file system paths. The returned
+                string needs to be freed with the libc
+                <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                call after use.</para>
+
+                <para>If the <varname>pid</varname> parameter of any
                 of these functions is passed as 0 the operation is
                 executed for the calling process.</para>
         </refsect1>
@@ -131,12 +163,13 @@
                 <title>Notes</title>
 
                 <para>The <function>sd_pid_get_session()</function>,
-                <function>sd_pid_get_pid()</function>, and
-                <function>sd_pid_get_owner_uid()</function> interfaces
-                are available as shared library, which can be compiled
-                and linked to with the
-                <literal>libsystemd-login</literal>
-                <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <function>sd_pid_get_unit()</function>,
+                <function>sd_pid_get_user_unit()</function>,
+                <function>sd_pid_get_owner_uid()</function> and
+                <function>sd_pid_get_machine_name()</function>
+                interfaces are available as shared library, which can
+                be compiled and linked to with the
+                <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
 
                 <para>Note that the login session identifier as
@@ -151,7 +184,7 @@
 
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>sd_session_is_active</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>getsid</refentrytitle><manvolnum>2</manvolnum></citerefentry>
                 </para>