chiark / gitweb /
Prep 229.9: Make all supportable API functions visible.
[elogind.git] / man / sd_bus_creds_get_pid.xml
index 29cb9bd32fed76b7ecbae14c0c8b24b433572357..ffc526ea6effc12dfe37e93d45d4cf776ba7dde7 100644 (file)
@@ -3,29 +3,29 @@
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
-  This file is part of systemd.
+  This file is part of elogind.
 
   Copyright 2014 Zbigniew JÄ™drzejewski-Szmek
 
-  systemd is free software; you can redistribute it and/or modify it
+  elogind is free software; you can redistribute it and/or modify it
   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
+  elogind 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
   Lesser General Public License for more details.
 
   You should have received a copy of the GNU Lesser General Public License
-  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+  along with elogind; If not, see <http://www.gnu.org/licenses/>.
 -->
 
 <refentry id="sd_bus_creds_get_pid">
 
   <refentryinfo>
     <title>sd_bus_creds_get_pid</title>
-    <productname>systemd</productname>
+    <productname>elogind</productname>
 
     <authorgroup>
       <author>
     <refname>sd_bus_creds_get_exe</refname>
     <refname>sd_bus_creds_get_cmdline</refname>
     <refname>sd_bus_creds_get_cgroup</refname>
-    <refname>sd_bus_creds_get_unit</refname>
-    <refname>sd_bus_creds_get_slice</refname>
-    <refname>sd_bus_creds_get_user_unit</refname>
-    <refname>sd_bus_creds_get_user_slice</refname>
     <refname>sd_bus_creds_get_session</refname>
     <refname>sd_bus_creds_get_owner_uid</refname>
     <refname>sd_bus_creds_has_effective_cap</refname>
@@ -83,7 +79,7 @@
 
   <refsynopsisdiv>
     <funcsynopsis>
-      <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
+      <funcsynopsisinfo>#include &lt;elogind/sd-bus.h&gt;</funcsynopsisinfo>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_pid</function></funcdef>
         <paramdef>const char **<parameter>cgroup</parameter></paramdef>
       </funcprototype>
 
-      <funcprototype>
-        <funcdef>int <function>sd_bus_creds_get_unit</function></funcdef>
-        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
-        <paramdef>const char **<parameter>unit</parameter></paramdef>
-      </funcprototype>
-
-      <funcprototype>
-        <funcdef>int <function>sd_bus_creds_get_slice</function></funcdef>
-        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
-        <paramdef>const char **<parameter>slice</parameter></paramdef>
-      </funcprototype>
-
-      <funcprototype>
-        <funcdef>int <function>sd_bus_creds_get_user_unit</function></funcdef>
-        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
-        <paramdef>const char **<parameter>unit</parameter></paramdef>
-      </funcprototype>
-
-      <funcprototype>
-        <funcdef>int <function>sd_bus_creds_get_user_slice</function></funcdef>
-        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
-        <paramdef>const char **<parameter>slice</parameter></paramdef>
-      </funcprototype>
-
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_session</function></funcdef>
         <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
     -ENXIO is returned.</para>
 
     <para><function>sd_bus_creds_get_cgroup()</function> will retrieve
-    the control group path. See <ulink
+    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 systemd unit name (in the system instance of systemd) that the
-    process is a part of. See
-    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For
-    processes that are not part of a unit, returns -ENXIO.
-    </para>
-
-    <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 a part of. See
-    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For
-    processes that are not part of a user unit, returns -ENXIO.
-    </para>
-
-    <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 a part of. See
-    <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Similarly,
-    <function>sd_bus_creds_get_user_slice()</function> retrieves the
-    systemd slice of the process, in the user instance of systemd.
-    </para>
-
     <para><function>sd_bus_creds_get_session()</function> will
     retrieve the identifier of the login session that the process is
     a part of. See
-    <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. For
+    <citerefentry><refentrytitle>elogind-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. For
     processes that are not part of a session, returns -ENXIO.
     </para>
 
     <para><function>sd_bus_creds_get_owner_uid()</function> will
     retrieve the numeric UID (user identifier) of the user who owns
     the login session that the process is a part of. See
-    <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
+    <citerefentry><refentrytitle>elogind-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
     For processes that are not part of a session, returns -ENXIO.
     </para>
 
-    <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 it
-    was set, zero means that it was not set, and a negative return value indicates an error. See <citerefentry
-    project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> and the
-    <varname>AmbientCapabilities=</varname> and <varname>CapabilityBoundingSet=</varname> settings in
-    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    <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 indicates an error. See
+    <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+    and <varname>Capabilities=</varname> and
+    <varname>CapabilityBoundingSet=</varname> settings in
+    <citerefentry><refentrytitle>elogind.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
     </para>
 
     <para><function>sd_bus_creds_has_permitted_cap()</function> is
 
         <listitem><para>The given field is not specified for the described
         process or peer. This will be returned by
-        <function>sd_bus_get_unit()</function>,
-        <function>sd_bus_get_slice()</function>,
-        <function>sd_bus_get_user_unit()</function>,
-        <function>sd_bus_get_user_slice()</function>,
         <function>sd_bus_get_session()</function>, and
         <function>sd_bus_get_owner_uid()</function> if the process is
-        not part of a systemd system unit, systemd user unit, systemd
+        not part of a elogind system unit, systemd user unit, systemd
         slice, or logind session. It will also be returned by
         <function>sd_bus_creds_get_exe()</function> and
         <function>sd_bus_creds_get_cmdline()</function> for kernel
     <title>See Also</title>
 
     <para>
-      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
       <citerefentry project='man-pages'><refentrytitle>fork</refentrytitle><manvolnum>2</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.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+      <citerefentry><refentrytitle>elogind.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
     </para>
   </refsect1>