git.maemo.org Git - connman/blob - doc/connman-docs.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY version SYSTEM "version.xml">
   5 ]>
   6 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   7   <bookinfo>
   8     <title>Connection Manager Reference Manual</title>
   9     <releaseinfo>Version &version;</releaseinfo>
  10     <authorgroup>
  11       <author>
  12         <firstname>Marcel</firstname>
  13         <surname>Holtmann</surname>
  14         <affiliation>
  15           <address>
  16             <email>marcel@holtmann.org</email>
  17           </address>
  18         </affiliation>
  19       </author>
  20     </authorgroup>
  21
  22     <copyright>
  23       <year>2007-2008</year>
  24       <holder>Intel Corporation. All rights reserved.</holder>
  25     </copyright>
  26
  27     <legalnotice>
  28       <para>
  29         Permission is granted to copy, distribute and/or modify this
  30         document under the terms of the <citetitle>GNU Free
  31         Documentation License</citetitle>, Version 1.1 or any later
  32         version published by the Free Software Foundation with no
  33         Invariant Sections, no Front-Cover Texts, and no Back-Cover
  34         Texts. You may obtain a copy of the <citetitle>GNU Free
  35         Documentation License</citetitle> from the Free Software
  36         Foundation by visiting <ulink type="http"
  37         url="http://www.fsf.org">their Web site</ulink> or by writing
  38         to:
  39
  40         <address>
  41           The Free Software Foundation, Inc.,
  42           <street>59 Temple Place</street> - Suite 330,
  43           <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
  44           <country>USA</country>
  45         </address>
  46       </para>
  47     </legalnotice>
  48   </bookinfo>
  49
  50   <reference id="design">
  51     <title>Design Overview</title>
  52     <partintro>
  53       <para>
  54         This part presents the design documentation for Connection Manager.
  55       </para>
  56     </partintro>
  57     <xi:include href="connman-introduction.xml" />
  58   </reference>
  59
  60   <reference id="manager">
  61     <title>Manager interface</title>
  62     <para>
  63 <programlisting><xi:include href="manager-api.txt" parse="text" /></programlisting>
  64     </para>
  65   </reference>
  66
  67   <reference id="device">
  68     <title>Device interface</title>
  69     <para>
  70 <programlisting><xi:include href="device-api.txt" parse="text" /></programlisting>
  71     </para>
  72   </reference>
  73
  74   <reference id="network">
  75     <title>Network interface</title>
  76     <para>
  77 <programlisting><xi:include href="network-api.txt" parse="text" /></programlisting>
  78     </para>
  79   </reference>
  80
  81   <reference id="service">
  82     <title>Service interface</title>
  83     <para>
  84 <programlisting><xi:include href="service-api.txt" parse="text" /></programlisting>
  85     </para>
  86   </reference>
  87
  88   <reference id="connection">
  89     <title>Connection interface</title>
  90     <para>
  91 <programlisting><xi:include href="connection-api.txt" parse="text" /></programlisting>
  92     </para>
  93   </reference>
  94
  95   <reference id="reference">
  96     <title>Plugin API Reference</title>
  97     <partintro>
  98       <para>
  99         This part presents the function reference for Connection Manager.
 100       </para>
 101     </partintro>
 102     <xi:include href="xml/log.xml" />
 103     <xi:include href="xml/plugin.xml" />
 104     <xi:include href="xml/storage.xml" />
 105     <xi:include href="xml/security.xml" />
 106     <xi:include href="xml/resolver.xml" />
 107     <!-- <xi:include href="xml/device.xml" /> -->
 108     <!-- <xi:include href="xml/network.xml" /> -->
 109   </reference>
 110
 111   <appendix id="license">
 112     <title>License</title>
 113     <para>
 114 <programlisting><xi:include href="../COPYING" parse="text" /></programlisting>
 115     </para>
 116   </appendix>
 117
 118   <index>
 119     <title>Index</title>
 120   </index>
 121 </book>