diff options
Diffstat (limited to 'man/sd_pid_get_session.xml')
| -rw-r--r-- | man/sd_pid_get_session.xml | 60 |
1 files changed, 47 insertions, 13 deletions
diff --git a/man/sd_pid_get_session.xml b/man/sd_pid_get_session.xml index 9517795f78..543a5c0c72 100644 --- a/man/sd_pid_get_session.xml +++ b/man/sd_pid_get_session.xml @@ -21,7 +21,7 @@ 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> @@ -66,10 +68,22 @@ </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,6 +138,14 @@ and not being a shared process of a user this function will fail.</para> + <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 <literal>pid</literal> parameter of any of these functions is passed as 0 the operation is executed for the calling process.</para> @@ -131,10 +163,12 @@ <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 + <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 <literal>libsystemd-login</literal> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> |