mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-10-02 06:15:37 +00:00
174 lines
6.7 KiB
XML
174 lines
6.7 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
|
<!ENTITY version SYSTEM "version.xml">
|
|
]>
|
|
|
|
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
|
<bookinfo>
|
|
<title>libnm Reference Manual</title>
|
|
<releaseinfo>
|
|
for libnm &version;
|
|
The latest version of this documentation can be found on-line at
|
|
<ulink url="https://developer.gnome.org/libnm/stable/">https://developer.gnome.org/libnm/stable/</ulink>.
|
|
</releaseinfo>
|
|
|
|
<copyright>
|
|
<year>2012-2014</year>
|
|
<holder>The NetworkManager Authors</holder>
|
|
</copyright>
|
|
|
|
<legalnotice>
|
|
<para>
|
|
Permission is granted to copy, distribute and/or modify this
|
|
document under the terms of the <citetitle>GNU Free
|
|
Documentation License</citetitle>, Version 1.1 or any later
|
|
version published by the Free Software Foundation with no
|
|
Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
|
Texts. You may obtain a copy of the <citetitle>GNU Free
|
|
Documentation License</citetitle> from the Free Software
|
|
Foundation by visiting <ulink type="http"
|
|
url="http://www.fsf.org">their Web site</ulink> or by writing
|
|
to:
|
|
|
|
<address>
|
|
The Free Software Foundation, Inc.,
|
|
<street>51 Franklin Street</street> - Fifth Floor,
|
|
<city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
|
|
<country>USA</country>
|
|
</address>
|
|
</para>
|
|
</legalnotice>
|
|
</bookinfo>
|
|
|
|
<chapter id="ref-overview">
|
|
<title>Overview</title>
|
|
<para>
|
|
libnm maps fairly closely to the actual D-Bus API that NetworkManager
|
|
provides, wrapping the remote D-Bus objects as native GObjects,
|
|
mapping D-Bus signals and properties to GObject signals and properties,
|
|
and providing helpful accessor and utility functions. However, unlike
|
|
the old libnm-util/libnm-glib API, the mapping to the D-Bus API is not
|
|
exact, and various inconveniences and historical anomolies of the D-Bus
|
|
API are papered over.
|
|
</para>
|
|
<para>
|
|
The following is a rough overview of the libnm object structure and
|
|
how to use the various parts of it:
|
|
<mediaobject id="libnm-overview">
|
|
<imageobject>
|
|
<imagedata fileref="libnm.png" format="PNG"/>
|
|
</imageobject>
|
|
</mediaobject>
|
|
</para>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>Client Object API Reference</title>
|
|
<xi:include href="xml/nm-client.xml"/>
|
|
<xi:include href="xml/nm-secret-agent-old.xml"/>
|
|
<xi:include href="xml/nm-object.xml"/>
|
|
<xi:include href="xml/nm-errors.xml"/>
|
|
<xi:include href="xml/nm-dbus-interface.xml"/>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>Connection and Setting API Reference</title>
|
|
<xi:include href="xml/nm-connection.xml"/>
|
|
<xi:include href="xml/nm-simple-connection.xml"/>
|
|
<xi:include href="xml/nm-setting.xml"/>
|
|
<xi:include href="xml/nm-setting-connection.xml"/>
|
|
<!-- begin alphabetical -->
|
|
<xi:include href="xml/nm-setting-8021x.xml"/>
|
|
<xi:include href="xml/nm-setting-adsl.xml"/>
|
|
<xi:include href="xml/nm-setting-bluetooth.xml"/>
|
|
<xi:include href="xml/nm-setting-bond.xml"/>
|
|
<xi:include href="xml/nm-setting-bridge.xml"/>
|
|
<xi:include href="xml/nm-setting-bridge-port.xml"/>
|
|
<xi:include href="xml/nm-setting-cdma.xml"/>
|
|
<xi:include href="xml/nm-setting-dcb.xml"/>
|
|
<xi:include href="xml/nm-setting-dummy.xml"/>
|
|
<xi:include href="xml/nm-setting-generic.xml"/>
|
|
<xi:include href="xml/nm-setting-gsm.xml"/>
|
|
<xi:include href="xml/nm-setting-infiniband.xml"/>
|
|
<xi:include href="xml/nm-setting-ip4-config.xml"/>
|
|
<xi:include href="xml/nm-setting-ip6-config.xml"/>
|
|
<xi:include href="xml/nm-setting-ip-config.xml"/>
|
|
<xi:include href="xml/nm-setting-ip-tunnel.xml"/>
|
|
<xi:include href="xml/nm-setting-macsec.xml"/>
|
|
<xi:include href="xml/nm-setting-macvlan.xml"/>
|
|
<xi:include href="xml/nm-setting-olpc-mesh.xml"/>
|
|
<xi:include href="xml/nm-setting-ppp.xml"/>
|
|
<xi:include href="xml/nm-setting-pppoe.xml"/>
|
|
<xi:include href="xml/nm-setting-serial.xml"/>
|
|
<xi:include href="xml/nm-setting-team.xml"/>
|
|
<xi:include href="xml/nm-setting-team-port.xml"/>
|
|
<xi:include href="xml/nm-setting-tun.xml"/>
|
|
<xi:include href="xml/nm-setting-vlan.xml"/>
|
|
<xi:include href="xml/nm-setting-vpn.xml"/>
|
|
<xi:include href="xml/nm-setting-vxlan.xml"/>
|
|
<xi:include href="xml/nm-setting-wimax.xml"/>
|
|
<xi:include href="xml/nm-setting-wired.xml"/>
|
|
<xi:include href="xml/nm-setting-wireless.xml"/>
|
|
<xi:include href="xml/nm-setting-wireless-security.xml"/>
|
|
<!-- end alphabetical -->
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>Device and Runtime Configuration API Reference</title>
|
|
<xi:include href="xml/nm-device.xml"/>
|
|
<!-- begin alphabetical -->
|
|
<xi:include href="xml/nm-device-adsl.xml"/>
|
|
<xi:include href="xml/nm-device-bond.xml"/>
|
|
<xi:include href="xml/nm-device-bridge.xml"/>
|
|
<xi:include href="xml/nm-device-bt.xml"/>
|
|
<xi:include href="xml/nm-device-dummy.xml"/>
|
|
<xi:include href="xml/nm-device-ethernet.xml"/>
|
|
<xi:include href="xml/nm-device-generic.xml"/>
|
|
<xi:include href="xml/nm-device-infiniband.xml"/>
|
|
<xi:include href="xml/nm-device-ip-tunnel.xml"/>
|
|
<xi:include href="xml/nm-device-macsec.xml"/>
|
|
<xi:include href="xml/nm-device-macvlan.xml"/>
|
|
<xi:include href="xml/nm-device-modem.xml"/>
|
|
<xi:include href="xml/nm-device-olpc-mesh.xml"/>
|
|
<xi:include href="xml/nm-device-team.xml"/>
|
|
<xi:include href="xml/nm-device-tun.xml"/>
|
|
<xi:include href="xml/nm-device-vlan.xml"/>
|
|
<xi:include href="xml/nm-device-vxlan.xml"/>
|
|
<xi:include href="xml/nm-device-wifi.xml"/>
|
|
<xi:include href="xml/nm-device-wimax.xml"/>
|
|
<!-- end alphabetical -->
|
|
<xi:include href="xml/nm-active-connection.xml"/>
|
|
<xi:include href="xml/nm-vpn-connection.xml"/>
|
|
<xi:include href="xml/nm-remote-connection.xml"/>
|
|
<xi:include href="xml/nm-access-point.xml"/>
|
|
<xi:include href="xml/nm-wimax-nsp.xml"/>
|
|
<xi:include href="xml/nm-ip-config.xml"/>
|
|
<xi:include href="xml/nm-dhcp-config.xml"/>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>Utility API Reference</title>
|
|
<xi:include href="xml/nm-utils.xml"/>
|
|
<xi:include href="xml/nm-version.xml"/>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>VPN Plugin API Reference</title>
|
|
<xi:include href="xml/nm-vpn-dbus-interface.xml"/>
|
|
<xi:include href="xml/nm-vpn-editor-plugin.xml"/>
|
|
</chapter>
|
|
|
|
<chapter id="object-tree">
|
|
<title>Object Hierarchy</title>
|
|
<xi:include href="xml/tree_index.sgml"/>
|
|
</chapter>
|
|
<index id="api-index-full">
|
|
<title>API Index</title>
|
|
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
|
|
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
|
|
</book>
|
|
|