chiark / gitweb /
hwdb: update
[elogind.git] / man / sd_pid_get_session.xml
index 9176433c3dee737edb1ed3924eeccda81fb719b6..9517795f78eb3c11fea00aaf1b84e44b315f3566 100644 (file)
@@ -8,16 +8,16 @@
   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/>.
 -->
 
@@ -44,8 +44,9 @@
 
         <refnamediv>
                 <refname>sd_pid_get_session</refname>
+                <refname>sd_pid_get_unit</refname>
                 <refname>sd_pid_get_owner_uid</refname>
-                <refpurpose>Determine session or owner of a session of a specific PID</refpurpose>
+                <refpurpose>Determine session, service or owner of a session of a specific PID</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
                                 <paramdef>char** <parameter>session</parameter></paramdef>
                         </funcprototype>
 
+                        <funcprototype>
+                                <funcdef>int <function>sd_pid_get_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>
 
                 <para><function>sd_pid_get_session()</function> may be
                 used to determine the login session identifier of a
-                process identified by the specified process identifier. The session
-                identifier is a short string (up to 64 characters),
-                consisting only of the characters a-zA-Z0-9 as well as
-                '-' and '_'. It is suitable for usage in file system
-                paths. Note that not all processes are part of a login
-                session (e.g. system service processes and user
-                processes that are shared between multiple sessions of
-                the same user). For processes not being part of a
-                login session this function will fail. The returned
-                string needs to be freed with the libc
+                process identified by the specified process
+                identifier. The session identifier is a short string,
+                suitable for usage in file system paths. Note that not
+                all processes are part of a login session (e.g. system
+                service processes, user processes that are shared
+                between multiple sessions of the same user, or kernel
+                threads). For processes not being part of a login
+                session this function will fail. 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_unit()</function> may be
+                used to determine the systemd 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
+                (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
                 <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call after use.</para>
 
                 fail. For processes not being part of a login session
                 and not being a shared process of a user this function
                 will fail.</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>
         </refsect1>
 
         <refsect1>
         <refsect1>
                 <title>Notes</title>
 
-                <para>The <function>sd_pid_get_session()</function>
-                and <function>sd_pid_get_owner_uid()</function>
-                interfaces are available as shared library, which can
-                be compiled and linked to with the
+                <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>
                 file.</para>
 
                 <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>