Cleaned up more unneeded types and functions.

[elogind.git] / man / sd_machine_get_class.xml

diff --git a/man/sd_machine_get_class.xml b/man/sd_machine_get_class.xml
index 5b881ccea1f63f1743acfc568d695f3a9b0e523b..a874249afe972a03d9d97c2dd101c74e514bd89f 100644 (file)
--- a/man/sd_machine_get_class.xml
+++ b/man/sd_machine_get_class.xml
@@ -3,29 +3,29 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
   "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 Lennart Poettering
 
 
   Copyright 2014 Lennart Poettering
 

-  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.
 
   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
   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_machine_get_class">
 
   <refentryinfo>
     <title>sd_machine_get_class</title>
 -->
 
 <refentry id="sd_machine_get_class">
 
   <refentryinfo>
     <title>sd_machine_get_class</title>

-    <productname>systemd</productname>
+    <productname>elogind</productname>

 
     <authorgroup>
       <author>
 
     <authorgroup>
       <author>


@@ -51,12 +51,12 @@
 
   <refsynopsisdiv>
     <funcsynopsis>
 
   <refsynopsisdiv>
     <funcsynopsis>

-      <funcsynopsisinfo>#include &lt;systemd/sd-login.h&gt;</funcsynopsisinfo>
+      <funcsynopsisinfo>#include &lt;elogind/sd-login.h&gt;</funcsynopsisinfo>

 
       <funcprototype>
         <funcdef>int <function>sd_machine_get_class</function></funcdef>
         <paramdef>const char* <parameter>machine</parameter></paramdef>
 
       <funcprototype>
         <funcdef>int <function>sd_machine_get_class</function></funcdef>
         <paramdef>const char* <parameter>machine</parameter></paramdef>

-        <paramdef>char *<parameter>class</parameter></paramdef>
+        <paramdef>char **<parameter>class</parameter></paramdef>

       </funcprototype>
 
       <funcprototype>
       </funcprototype>
 
       <funcprototype>


@@ -73,7 +73,7 @@
     <para><function>sd_machine_get_class()</function> may be used to
     determine the class of a locally running virtual machine or
     container that is registered with
     <para><function>sd_machine_get_class()</function> may be used to
     determine the class of a locally running virtual machine or
     container that is registered with

-    <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
+    <citerefentry><refentrytitle>elogind-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.

     The string returned is either <literal>vm</literal> or
     <literal>container</literal>. The returned string needs to be
     freed with the libc <citerefentry
     The string returned is either <literal>vm</literal> or
     <literal>container</literal>. The returned string needs to be
     freed with the libc <citerefentry


@@ -84,7 +84,7 @@
     to determine the numeric indices of the network interfaces on the
     host that are pointing towards the specified locally running
     virtual machine or container that is registered with
     to determine the numeric indices of the network interfaces on the
     host that are pointing towards the specified locally running
     virtual machine or container that is registered with

-    <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
+    <citerefentry><refentrytitle>elogind-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.

     The returned array needs to be freed with the libc <citerefentry
     project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     call after use.</para>
     The returned array needs to be freed with the libc <citerefentry
     project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     call after use.</para>


@@ -98,6 +98,35 @@
     code.</para>
   </refsect1>
 
     code.</para>
   </refsect1>
 

+  <refsect1>
+    <title>Errors</title>
+
+    <para>Returned errors may indicate the following problems:</para>
+
+    <variablelist>
+
+      <varlistentry>
+        <term><constant>-ENXIO</constant></term>
+
+        <listitem><para>The specified machine does not exist or is currently not running.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><constant>-EINVAL</constant></term>
+
+        <listitem><para>An input parameter was invalid (out of range,
+        or NULL, where that's not accepted).</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><constant>-ENOMEM</constant></term>
+
+        <listitem><para>Memory allocation failed.</para></listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+

   <refsect1>
     <title>Notes</title>
 
   <refsect1>
     <title>Notes</title>
 


@@ -105,7 +134,7 @@
     <function>sd_machine_get_ifindices()</function> interfaces are
     available as a shared library, which can be compiled and linked to
     with the
     <function>sd_machine_get_ifindices()</function> interfaces are
     available as a shared library, which can be compiled and linked to
     with the

-    <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    <constant>libelogind</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>

     file.</para>
   </refsect1>
 
     file.</para>
   </refsect1>
 


@@ -113,9 +142,9 @@
     <title>See Also</title>
 
     <para>
     <title>See Also</title>
 
     <para>

-      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

       <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

-      <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>elogind-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,

       <citerefentry><refentrytitle>sd_pid_get_machine_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     </para>
   </refsect1>
       <citerefentry><refentrytitle>sd_pid_get_machine_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     </para>
   </refsect1>