summaryrefslogtreecommitdiff
path: root/doc/connman-docs.xml
blob: d4059a4137c9d0d7b4160bf6628ae0cc0720bc01 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<?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>Connection Manager Reference Manual</title>
    <releaseinfo>Version &version;</releaseinfo>
    <authorgroup>
      <author>
	<firstname>Marcel</firstname>
	<surname>Holtmann</surname>
	<affiliation>
	  <address>
	    <email>marcel@holtmann.org</email>
	  </address>
	</affiliation>
      </author>
    </authorgroup>

    <copyright>
      <year>2007-2008</year>
      <holder>Intel Corporation. All rights reserved.</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>59 Temple Place</street> - Suite 330,
	  <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
	  <country>USA</country>
	</address>
      </para>
    </legalnotice>
  </bookinfo>

  <reference id="design">
    <title>Design Overview</title>
    <partintro>
      <para>
	This part presents the design documentation for Connection Manager.
      </para>
    </partintro>
    <xi:include href="connman-introduction.xml" />
  </reference>

  <reference id="manager">
    <title>Manager interface</title>
    <para>
<programlisting><xi:include href="manager-api.txt" parse="text" /></programlisting>
    </para>
  </reference>

  <reference id="device">
    <title>Device interface</title>
    <para>
<programlisting><xi:include href="device-api.txt" parse="text" /></programlisting>
    </para>
  </reference>

  <reference id="network">
    <title>Network interface</title>
    <para>
<programlisting><xi:include href="network-api.txt" parse="text" /></programlisting>
    </para>
  </reference>

  <reference id="service">
    <title>Service interface</title>
    <para>
<programlisting><xi:include href="service-api.txt" parse="text" /></programlisting>
    </para>
  </reference>

  <reference id="connection">
    <title>Connection interface</title>
    <para>
<programlisting><xi:include href="connection-api.txt" parse="text" /></programlisting>
    </para>
  </reference>

  <reference id="reference">
    <title>Plugin API Reference</title>
    <partintro>
      <para>
	This part presents the function reference for Connection Manager.
      </para>
    </partintro>
    <xi:include href="xml/log.xml" />
    <xi:include href="xml/plugin.xml" />
    <xi:include href="xml/storage.xml" />
    <xi:include href="xml/security.xml" />
    <xi:include href="xml/resolver.xml" />
    <!-- <xi:include href="xml/device.xml" /> -->
    <!-- <xi:include href="xml/network.xml" /> -->
  </reference>

  <appendix id="license">
    <title>License</title>
    <para>
<programlisting><xi:include href="../COPYING" parse="text" /></programlisting>
    </para>
  </appendix>

  <index>
    <title>Index</title>
  </index>
</book>