summaryrefslogtreecommitdiff
path: root/doc/gupnp-docs.xml
blob: c81eea14a839c40acdf0b956fa58eca4bb3cf861 (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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>GUPnP Reference Manual</title>

    <releaseinfo>Version <xi:include href="version.xml" parse="text"/></releaseinfo>

    <copyright>
      <year>2007</year>
      <year>2008</year>
      <year>2009</year>
      <holder>OpenedHand Ltd</holder>
      <holder>Nokia Corporation</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.
      </para>
      <para>
        A copy of the license is included in the section entitled "GNU
        Free Documentation License".
      </para>
    </legalnotice>
  </bookinfo>

  <part id="tutorial">
    <title>Tutorial</title>
    <xi:include href="overview.xml"/>
    <xi:include href="xml/client-tutorial.xml"/>
    <xi:include href="xml/server-tutorial.xml"/>
  </part>
  
  <part id="api">
    <title>Reference</title>
    
    <chapter id="api-device-info">
      <title>Device Information</title>
      
      <xi:include href="xml/gupnp-device-info.xml"/>
      <xi:include href="xml/gupnp-service-info.xml"/>
      <xi:include href="xml/gupnp-service-introspection.xml"/>
    </chapter>
    
    <chapter id="api-device-control">
      <title>Device Control</title>
      
      <xi:include href="xml/gupnp-control-point.xml"/>
      <xi:include href="xml/gupnp-device-proxy.xml"/>
      <xi:include href="xml/gupnp-service-proxy.xml"/>
    </chapter>
    
    <chapter id="api-device-impl">
      <title>Device Implementation</title>
      
      <xi:include href="xml/gupnp-device.xml"/>
      <xi:include href="xml/gupnp-root-device.xml"/>
      <xi:include href="xml/gupnp-service.xml"/>
    </chapter>

    <chapter id="api-context">
      <title>Network context handling</title>

      <xi:include href="xml/gupnp-context.xml"/>
      <xi:include href="xml/gupnp-context-manager.xml"/>
    </chapter>
    
    <chapter id="api-utility">
      <title>Utility Functions</title>
      
      <xi:include href="xml/gupnp-acl.xml"/>
      <xi:include href="xml/gupnp-context-filter.xml"/>
      <xi:include href="xml/gupnp-resource-factory.xml"/>
      <xi:include href="xml/gupnp-xml-doc.xml"/>
      <xi:include href="xml/gupnp-error.xml"/>
      <xi:include href="xml/gupnp-types.xml"/>
      <xi:include href="xml/gupnp-misc.xml"/>
      <xi:include href="xml/gupnp-white-list.xml"/>
    </chapter>

    <chapter id="api-tools">
      <title>Tools</title>
      <xi:include href="gupnp-binding-tool.xml"/>
    </chapter>
  </part>

  <part id="schemas">
    <title>XML Schemas</title>
    <chapter id="schemas-device">
      <title>Device Description</title>
      <para>
        This is the schema for the UPnP Device Description document, in the
        RELAX NG Compact syntax.
      </para>
      <programlisting><xi:include href="device-description.rnc" parse="text"/></programlisting>
    </chapter>
    <chapter id="schemas-service">
      <title>Service Description</title>
      <para>
        This is the schema for the UPnP Service Description document, in the
        RELAX NG Compact syntax.
      </para>
      <programlisting><xi:include href="service-description.rnc" parse="text"/></programlisting>
    </chapter>
  </part>

  <xi:include href="glossary.xml"/>

  <index id="api-index-full">
    <title>Index of all symbols</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-deprecated" role="deprecated">
    <title>Index of deprecated symbols</title>
    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-12-3" role="0.12.3">
    <title>Index of new symbols in 0.12.3</title>
    <xi:include href="xml/api-index-0.12.3.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-14-0" role="0.14.0">
    <title>Index of new symbols in 0.14.0</title>
    <xi:include href="xml/api-index-0.14.0.xml"><xi:fallback /></xi:include>
  </index>


  <index id="api-index-0-18-0" role="0.18.9">
    <title>Index of new symbols in 0.18.0</title>
    <xi:include href="xml/api-index-0.18.0.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-20-0" role="0.20.0">
    <title>Index of new symbols in 0.20.0</title>
    <xi:include href="xml/api-index-0.20.0.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-20-3" role="0.20.3">
    <title>Index of new symbols in 0.20.3</title>
    <xi:include href="xml/api-index-0.20.3.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-20-4" role="0.20.4">
    <title>Index of new symbols in 0.20.4</title>
    <xi:include href="xml/api-index-0.20.4.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-20-5" role="0.20.5">
    <title>Index of new symbols in 0.20.5</title>
    <xi:include href="xml/api-index-0.20.5.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-20-8" role="0.20.8">
    <title>Index of new symbols in 0.20.8</title>
    <xi:include href="xml/api-index-0.20.8.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-20-9" role="0.20.9">
    <title>Index of new symbols in 0.20.9</title>
    <xi:include href="xml/api-index-0.20.9.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-20-11" role="0.20.11">
    <title>Index of new symbols in 0.20.11</title>
    <xi:include href="xml/api-index-0.20.11.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-20-12" role="0.20.12">
    <title>Index of new symbols in 0.20.12</title>
    <xi:include href="xml/api-index-0.20.12.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-1-2-0" role="1.2.0">
    <title>Index of new symbols in 1.2.0</title>
    <xi:include href="xml/api-index-1.2.0.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-1-4-0" role="1.4.0">
    <title>Index of new symbols in 1.4.0</title>
    <xi:include href="xml/api-index-1.4.0.xml"><xi:fallback /></xi:include>
  </index>

 
  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>

  <xi:include href="fdl-1.1.xml"><xi:fallback /></xi:include>

</book>