chiark / gitweb /
man: add sd_event_add_child(3)
[elogind.git] / man / sd_bus_creds_get_pid.xml
index d33533170f282295e05c225f02065a4d3ea82309..40ed81ecb0b8404875a641fcfee34441f9076d2e 100644 (file)
@@ -21,7 +21,7 @@ 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_bus_creds_get_pid">
+<refentry id="sd_bus_creds_get_pid" conditional="ENABLE_KDBUS">
 
   <refentryinfo>
     <title>sd_bus_creds_get_pid</title>
@@ -77,145 +77,145 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_pid</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>pid_t *<parameter>pid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_pid_starttime</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>uint64_t *<parameter>usec</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_tid</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>pid_t *<parameter>tid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_pid</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>uid_t *<parameter>uid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_gid</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>gid_t *<parameter>gid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_comm</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>comm</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_tid_comm</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>comm</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_exe</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>exe</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_cmdline</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>char ***<parameter>cmdline</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_cgroup</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <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>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>unit</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_user_unit</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <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>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>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>slice</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_owner_uid</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>uid_t *<parameter>uid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_has_effective_cap</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>int <parameter>capability</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_has_permitted_cap</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>int <parameter>capability</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_has_inheritable_cap</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>int <parameter>capability</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_has_bounding_cap</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>int <parameter>capability</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_selinux_context</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>context</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_audit_session_id</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>uint32_t *<parameter>sessionid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_audit_login_uid</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>uid_t *<parameter>loginuid</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_unique_name</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>const char **<parameter>name</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_creds_get_well_known_names</function></funcdef>
-        <paramdef>sd_bus_creds<parameter>c</parameter></paramdef>
+        <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
         <paramdef>char ***<parameter>name</parameter></paramdef>
       </funcprototype>
 
@@ -225,7 +225,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
   <refsect1>
     <title>Description</title>
 
-    <para>Those functions return information from an
+    <para>These functions return information from an
     <parameter>sd_bus_creds</parameter> object. It may be created with
     <citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
     in which case it will describe the specified process, or it may be
@@ -246,13 +246,13 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     TID (thread identifier).</para>
 
     <para><function>sd_bus_creds_get_uid</function> will retrieve the
-    UID (user identifier).</para>
+    numeric UID (user identifier).</para>
 
     <para><function>sd_bus_creds_get_gid</function> will retrieve the
-    GID (group identifier).</para>
+    numeric GID (group identifier).</para>
 
     <para><function>sd_bus_creds_get_comm</function> will retrieve the
-    comm field (name of the executable, as stored in
+    comm field (truncated name of the executable, as stored in
     <filename>/proc/<replaceable>pid</replaceable>/comm</filename>).
     </para>
 
@@ -301,7 +301,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     </para>
 
     <para><function>sd_bus_creds_get_owner_uid</function> will retrieve
-    the UID (user identifier) of the user who owns the slice
+    the numeric UID (user identifier) of the user who owns the slice
     that the process is part of. See
     <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>
     <!-- and
@@ -311,10 +311,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <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 were
+    capabilities mask. A positive return value means that is was
     set, zero means that it was not set, and a negative return
     value signifies an error. See
-    <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+    <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
     and <varname>Capabilities=</varname> and
     <varname>CapabilityBoundingSet=</varname> settings in
     <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
@@ -385,7 +385,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
         <listitem><para>Given field is not available in
         <parameter>c</parameter>.</para>
-       </listitem>
+        </listitem>
       </varlistentry>
 
       <varlistentry>
@@ -399,13 +399,13 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <function>sd_bus_get_owner_uid</function> if the sender is not
         part of a systemd system unit, systemd user unit, systemd
         slice, logind session, or a systemd user session.</para>
-       </listitem>
+        </listitem>
       </varlistentry>
 
       <varlistentry>
         <term><varname>-ENXIO</varname></term>
 
-        <listitem><para>An error occured in parsing cgroup paths.
+        <listitem><para>An error occurred in parsing cgroup paths.
         <filename>libsystemd</filename> might be out of sync with
         the running systemd version.</para></listitem>
       </varlistentry>
@@ -431,7 +431,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><function>sd_bus_open_user()</function> and other functions
     described here are available as a shared library, which can be
     compiled and linked to with the
-    <constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
     file.</para>
   </refsect1>
 
@@ -441,11 +441,11 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para>
       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>proc</refentrytitle><manvolnum>5</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.journald-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
     </para>
   </refsect1>