man: document sd_machine_get_class() and sd_machine_get_ifindices()
This commit is contained in:
Lennart Poettering
parent
e6c253e363
commit
5c8da64734
|
|
@ -46,6 +46,7 @@ MANPAGES += \
|
|||
man/sd_journal_seek_head.3 \
|
||||
man/sd_journal_stream_fd.3 \
|
||||
man/sd_listen_fds.3 \
|
||||
man/sd_machine_get_class.3 \
|
||||
man/sd_notify.3 \
|
||||
man/sd_watchdog_enabled.3 \
|
||||
man/shutdown.8 \
|
||||
|
|
@ -192,6 +193,7 @@ MANPAGES_ALIAS += \
|
|||
man/sd_journal_set_data_threshold.3 \
|
||||
man/sd_journal_test_cursor.3 \
|
||||
man/sd_journal_wait.3 \
|
||||
man/sd_machine_get_ifindices.3 \
|
||||
man/sd_notifyf.3 \
|
||||
man/systemd-ask-password-console.path.8 \
|
||||
man/systemd-ask-password-wall.path.8 \
|
||||
|
|
@ -297,6 +299,7 @@ man/sd_journal_sendv.3: man/sd_journal_print.3
|
|||
man/sd_journal_set_data_threshold.3: man/sd_journal_get_data.3
|
||||
man/sd_journal_test_cursor.3: man/sd_journal_get_cursor.3
|
||||
man/sd_journal_wait.3: man/sd_journal_get_fd.3
|
||||
man/sd_machine_get_ifindices.3: man/sd_machine_get_class.3
|
||||
man/sd_notifyf.3: man/sd_notify.3
|
||||
man/systemd-ask-password-console.path.8: man/systemd-ask-password-console.service.8
|
||||
man/systemd-ask-password-wall.path.8: man/systemd-ask-password-console.service.8
|
||||
|
|
@ -544,6 +547,9 @@ man/sd_journal_test_cursor.html: man/sd_journal_get_cursor.html
|
|||
man/sd_journal_wait.html: man/sd_journal_get_fd.html
|
||||
$(html-alias)
|
||||
|
||||
man/sd_machine_get_ifindices.html: man/sd_machine_get_class.html
|
||||
$(html-alias)
|
||||
|
||||
man/sd_notifyf.html: man/sd_notify.html
|
||||
$(html-alias)
|
||||
|
||||
|
|
@ -1605,6 +1611,7 @@ EXTRA_DIST += \
|
|||
man/sd_journal_stream_fd.xml \
|
||||
man/sd_listen_fds.xml \
|
||||
man/sd_login_monitor_new.xml \
|
||||
man/sd_machine_get_class.xml \
|
||||
man/sd_notify.xml \
|
||||
man/sd_pid_get_session.xml \
|
||||
man/sd_seat_get_active.xml \
|
||||
|
|
|
|||
|
|
@ -0,0 +1,126 @@
|
|||
<?xml version='1.0'?> <!--*-nxml-*-->
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||
|
||||
<!--
|
||||
This file is part of systemd.
|
||||
|
||||
Copyright 2014 Lennart Poettering
|
||||
|
||||
systemd 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
|
||||
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/>.
|
||||
-->
|
||||
|
||||
<refentry id="sd_machine_get_class">
|
||||
|
||||
<refentryinfo>
|
||||
<title>sd_machine_get_class</title>
|
||||
<productname>systemd</productname>
|
||||
|
||||
<authorgroup>
|
||||
<author>
|
||||
<contrib>Developer</contrib>
|
||||
<firstname>Lennart</firstname>
|
||||
<surname>Poettering</surname>
|
||||
<email>lennart@poettering.net</email>
|
||||
</author>
|
||||
</authorgroup>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>sd_machine_get_class</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>sd_machine_get_class</refname>
|
||||
<refname>sd_machine_get_ifindices</refname>
|
||||
<refpurpose>Determine the class and network interface
|
||||
indices of a locally running virtual machine or
|
||||
container.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <systemd/sd-login.h></funcsynopsisinfo>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_machine_get_class</function></funcdef>
|
||||
<paramdef>const char* <parameter>machine</parameter></paramdef>
|
||||
<paramdef>char *<parameter>class</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_machine_get_ifindices</function></funcdef>
|
||||
<paramdef>const char* <parameter>machine</parameter></paramdef>
|
||||
<paramdef>int **<parameter>ifindices</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<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>. The
|
||||
string returned is either <literal>vm</literal> or
|
||||
<literal>container</literal>. The returned string
|
||||
needs to be freed with the libc <citerefentry
|
||||
project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
call after use.</para>
|
||||
|
||||
<para><function>sd_machine_get_ifindices()</function>
|
||||
may be used 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>. 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>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Return Value</title>
|
||||
|
||||
<para>On success, these calls return 0 or a positive
|
||||
integer. On failure, these calls return a negative
|
||||
errno-style error code.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Notes</title>
|
||||
|
||||
<para>The <function>sd_machine_get_class()</function> and
|
||||
<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>
|
||||
file.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
|
||||
<para>
|
||||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_pid_get_machine_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
|
@ -264,7 +264,8 @@
|
|||
<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>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
||||
<citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue