man: document sd_pid_get_slice() call of libsystemd-login

[elogind.git] / man / sd_pid_get_session.xml

diff --git a/man/sd_pid_get_session.xml b/man/sd_pid_get_session.xml
index fd1ce4b87e1a1946f18a73a144cc4a5369a3d138..ecd22f7bfefe742a5a9f1315e23f4caf1a36e57d 100644 (file)
--- a/man/sd_pid_get_session.xml
+++ b/man/sd_pid_get_session.xml
@@ -48,7 +48,10 @@
                 <refname>sd_pid_get_user_unit</refname>
                 <refname>sd_pid_get_owner_uid</refname>
                 <refname>sd_pid_get_machine_name</refname>
-                <refpurpose>Determine session, service, owner of a session or container/VM of a specific PID</refpurpose>
+                <refname>sd_pid_get_slice</refname>
+                <refpurpose>Determine session, service, owner of a
+                session, container/VM or slice of a specific
+                PID</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -84,6 +87,12 @@
                                 <paramdef>pid_t <parameter>pid</parameter></paramdef>
                                 <paramdef>char** <parameter>name</parameter></paramdef>
                         </funcprototype>
+
+                        <funcprototype>
+                                <funcdef>int <function>sd_pid_get_slice</function></funcdef>
+                                <paramdef>pid_t <parameter>pid</parameter></paramdef>
+                                <paramdef>char** <parameter>slice</parameter></paramdef>
+                        </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
 
@@ -138,11 +147,20 @@
                 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
+                <para><function>sd_pid_get_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><function>sd_pid_get_slice()</function> may be
+                used to determine the slice unit the process is a
+                member of. See
+                <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                for details about slices. The returned string needs to
+                be freed with the libc
                 <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call after use.</para>
 
@@ -165,10 +183,11 @@
                 <para>The <function>sd_pid_get_session()</function>,
                 <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
+                <function>sd_pid_get_owner_uid()</function>,
+                <function>sd_pid_get_machine_name()</function> and
+                <function>sd_pid_get_slice()</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>
 
@@ -186,7 +205,8 @@
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</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>
+                        <citerefentry><refentrytitle>getsid</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 </para>
         </refsect1>