<?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-glib Reference Manual</title>
    <releaseinfo>
      for libnm-glib &version;
      The latest version of this documentation can be found on-line at
      <ulink url="https://developer.gnome.org/libnm-glib/stable/">https://developer.gnome.org/libnm-glib/stable/</ulink>.
    </releaseinfo>

    <copyright>
      <year>2012</year>
      <year>2013</year>
      <year>2014</year>
      <year>2015</year>
      <year>2016</year>
      <year>2017</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>Object Overview</title>
    <para>
      libnm-glib maps closely to the actual D-Bus API that NetworkManager
      provides, simply 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.  As such, objects
      in the libnm-glib API have the same properties, behavior, signals, and
      semantics as the NM D-Bus API.
    </para>
    <para>
      The following is a rough overview of the libnm-glib object structure and
      how to use the various parts of it:
      <mediaobject  id="libnm-glib-overview">
        <imageobject>
          <imagedata fileref="libnm-glib.png" format="PNG"/>
        </imageobject>
      </mediaobject>
    </para>
  </chapter>

  <chapter>
    <title>libnm-glib API Reference</title>
    <xi:include href="xml/nm-client.xml"/>
    <xi:include href="xml/nm-active-connection.xml"/>
    <xi:include href="xml/nm-device.xml"/>
    <xi:include href="xml/nm-device-ethernet.xml"/>
    <xi:include href="xml/nm-device-wifi.xml"/>
    <xi:include href="xml/nm-device-modem.xml"/>
    <xi:include href="xml/nm-device-bt.xml"/>
    <xi:include href="xml/nm-device-wimax.xml"/>
    <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-team.xml"/>
    <xi:include href="xml/nm-device-generic.xml"/>
    <xi:include href="xml/nm-device-infiniband.xml"/>
    <xi:include href="xml/nm-device-vlan.xml"/>
    <xi:include href="xml/nm-device-olpc-mesh.xml"/>
    <xi:include href="xml/nm-wimax-nsp.xml"/>
    <xi:include href="xml/nm-access-point.xml"/>
    <xi:include href="xml/nm-ip4-config.xml"/>
    <xi:include href="xml/nm-ip6-config.xml"/>
    <xi:include href="xml/nm-dhcp4-config.xml"/>
    <xi:include href="xml/nm-dhcp6-config.xml"/>
    <xi:include href="xml/nm-object.xml"/>
    <xi:include href="xml/nm-remote-connection.xml"/>
    <xi:include href="xml/nm-remote-settings.xml"/>
    <xi:include href="xml/nm-types.xml"/>
    <xi:include href="xml/nm-secret-agent.xml"/>
    <xi:include href="xml/nm-vpn-connection.xml"/>
    <xi:include href="xml/nm-vpn-plugin.xml"/>
    <xi:include href="xml/nm-vpn-plugin-ui-interface.xml"/>
    <xi:include href="xml/nm-vpn-plugin-utils.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>

