Add docs for gresource
[platform/upstream/glib.git] / docs / reference / gio / gio-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 % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
5 <!ENTITY version SYSTEM "version.xml">
6 ]>
7 <book lang="en" id="gio" xmlns:xi="http://www.w3.org/2003/XInclude">
8 <title>GIO Reference Manual</title>
9   <bookinfo>
10     <title>GIO Reference Manual</title>
11     <releaseinfo>
12       for GIO &version;
13       The latest version of this documentation can be found on-line at
14       <ulink role="online-location" url="http://library.gnome.org/devel/gio/unstable/">http://library.gnome.org/devel/gio/unstable/</ulink>.
15     </releaseinfo>
16   </bookinfo>
17
18   <xi:include href="xml/overview.xml"/>
19
20   <part>
21   <title>API Reference</title>
22     <chapter id="file_ops">
23         <title>File Operations</title>
24         <xi:include href="xml/gfile.xml"/>
25         <xi:include href="xml/gfileattribute.xml"/>
26         <xi:include href="xml/gfileinfo.xml"/>
27         <xi:include href="xml/gfileenumerator.xml"/>
28         <xi:include href="xml/gioerror.xml"/>
29         <xi:include href="xml/gmountoperation.xml"/>
30     </chapter>
31     <chapter id="file_mon">
32         <title>File System Monitoring</title>
33         <xi:include href="xml/gfilemonitor.xml"/>
34     </chapter>
35     <chapter id="utils">
36         <title>File-related Utilities</title>
37         <xi:include href="xml/gfilenamecompleter.xml"/>
38     </chapter>
39     <chapter id="async">
40         <title>Asynchronous I/O</title>
41         <xi:include href="xml/gcancellable.xml"/>
42         <xi:include href="xml/gasyncresult.xml"/>
43         <xi:include href="xml/gioscheduler.xml"/>
44         <xi:include href="xml/gsimpleasyncresult.xml"/>
45     </chapter>
46     <chapter id="conversion">
47         <title>Data conversion</title>
48         <xi:include href="xml/gconverter.xml"/>
49         <xi:include href="xml/gcharsetconverter.xml"/>
50         <xi:include href="xml/gzcompressor.xml"/>
51         <xi:include href="xml/gzdecompressor.xml"/>
52     </chapter>
53     <chapter id="streaming">
54         <title>Streaming I/O</title>
55         <xi:include href="xml/gseekable.xml"/>
56         <xi:include href="xml/ginputstream.xml"/>
57         <xi:include href="xml/goutputstream.xml"/>
58         <xi:include href="xml/giostream.xml"/>
59         <xi:include href="xml/gfileinputstream.xml"/>
60         <xi:include href="xml/gfileoutputstream.xml"/>
61         <xi:include href="xml/gfileiostream.xml"/>
62         <xi:include href="xml/gfiledescriptorbased.xml"/>
63         <xi:include href="xml/gfilterinputstream.xml"/>
64         <xi:include href="xml/gfilteroutputstream.xml"/>
65         <xi:include href="xml/gmemoryinputstream.xml"/>
66         <xi:include href="xml/gmemoryoutputstream.xml"/>
67         <xi:include href="xml/gbufferedinputstream.xml"/>
68         <xi:include href="xml/gbufferedoutputstream.xml"/>
69         <xi:include href="xml/gdatainputstream.xml"/>
70         <xi:include href="xml/gdataoutputstream.xml"/>
71         <xi:include href="xml/gunixinputstream.xml"/>
72         <xi:include href="xml/gunixoutputstream.xml"/>
73         <xi:include href="xml/gconverterinputstream.xml"/>
74         <xi:include href="xml/gconverteroutputstream.xml"/>
75         <xi:include href="xml/gpollableinputstream.xml"/>
76         <xi:include href="xml/gpollableoutputstream.xml"/>
77     </chapter>
78     <chapter id="types">
79         <title>File types and applications</title>
80         <xi:include href="xml/gcontenttype.xml"/>
81         <xi:include href="xml/gappinfo.xml"/>
82         <xi:include href="xml/gdesktopappinfo.xml"/>
83     </chapter>
84     <chapter id="volume_mon">
85         <title>Volumes and Drives</title>
86         <xi:include href="xml/gvolumemonitor.xml"/>
87         <xi:include href="xml/gvolume.xml"/>
88         <xi:include href="xml/gmount.xml"/>
89         <xi:include href="xml/gdrive.xml"/>
90         <xi:include href="xml/gunixmounts.xml"/>
91     </chapter>
92     <chapter id="icons">
93         <title>Icons</title>
94         <xi:include href="xml/gicon.xml"/>
95         <xi:include href="xml/gfileicon.xml"/>
96         <xi:include href="xml/gloadableicon.xml"/>
97         <xi:include href="xml/gthemedicon.xml"/>
98         <xi:include href="xml/gemblemedicon.xml"/>
99         <xi:include href="xml/gemblem.xml"/>
100     </chapter>
101     <chapter id="failable_initialization">
102         <title>Failable Initialization</title>
103         <xi:include href="xml/ginitable.xml"/>
104         <xi:include href="xml/gasyncinitable.xml"/>
105     </chapter>
106     <chapter id="networking">
107       <title>Low-level network support</title>
108       <xi:include href="xml/gsocket.xml"/>
109       <xi:include href="xml/ginetaddress.xml"/>
110       <xi:include href="xml/ginetaddressmask.xml"/>
111       <xi:include href="xml/gsocketaddress.xml"/>
112       <xi:include href="xml/ginetsocketaddress.xml"/>
113       <xi:include href="xml/gunixsocketaddress.xml"/>
114       <xi:include href="xml/gsocketcontrolmessage.xml"/>
115       <xi:include href="xml/gunixfdlist.xml"/>
116       <xi:include href="xml/gunixfdmessage.xml"/>
117       <xi:include href="xml/gcredentials.xml"/>
118       <xi:include href="xml/gunixcredentialsmessage.xml"/>
119       <xi:include href="xml/gproxy.xml"/>
120       <xi:include href="xml/gproxyaddress.xml"/>
121     </chapter>
122     <chapter id="highlevel-socket">
123       <title>High-level network functionallity</title>
124       <xi:include href="xml/gsocketclient.xml"/>
125       <xi:include href="xml/gsocketconnection.xml"/>
126       <xi:include href="xml/gunixconnection.xml"/>
127       <xi:include href="xml/gtcpconnection.xml"/>
128       <xi:include href="xml/gtcpwrapperconnection.xml"/>
129       <xi:include href="xml/gsocketlistener.xml"/>
130       <xi:include href="xml/gsocketservice.xml"/>
131       <xi:include href="xml/gthreadedsocketservice.xml"/>
132       <xi:include href="xml/gnetworkmonitor.xml"/>
133     </chapter>
134     <chapter id="tls">
135       <title>TLS (SSL) support</title>
136       <xi:include href="xml/gtls.xml"/>
137       <xi:include href="xml/gtlscertificate.xml"/>
138       <xi:include href="xml/gtlsconnection.xml"/>
139       <xi:include href="xml/gtlsclientconnection.xml"/>
140       <xi:include href="xml/gtlsserverconnection.xml"/>
141       <xi:include href="xml/gtlsbackend.xml"/>
142       <xi:include href="xml/gtlsdatabase.xml"/>
143       <xi:include href="xml/gtlsfiledatabase.xml"/>
144       <xi:include href="xml/gtlsinteraction.xml"/>
145       <xi:include href="xml/gtlspassword.xml"/>
146     </chapter>
147     <chapter id="resolver">
148       <title>DNS resolution</title>
149       <xi:include href="xml/gresolver.xml"/>
150       <xi:include href="xml/gproxyresolver.xml"/>
151       <xi:include href="xml/gsocketconnectable.xml"/>
152       <xi:include href="xml/gnetworkaddress.xml"/>
153       <xi:include href="xml/gnetworkservice.xml"/>
154       <xi:include href="xml/gsrvtarget.xml"/>
155     </chapter>
156     <chapter id="gdbus-lowlevel">
157       <title>Lowlevel D-Bus Support</title>
158       <xi:include href="xml/gdbusutils.xml"/>
159       <xi:include href="xml/gdbusaddress.xml"/>
160       <xi:include href="xml/gdbusintrospection.xml"/>
161       <xi:include href="xml/gdbuserror.xml"/>
162       <xi:include href="xml/gdbusmessage.xml"/>
163       <xi:include href="xml/gdbusconnection.xml"/>
164       <xi:include href="xml/gdbusmethodinvocation.xml"/>
165       <xi:include href="xml/gdbusserver.xml"/>
166       <xi:include href="xml/gdbusauthobserver.xml"/>
167     </chapter>
168     <chapter id="gdbus-convenience">
169       <title>Highlevel D-Bus Support</title>
170       <xi:include href="xml/gdbusnameowning.xml"/>
171       <xi:include href="xml/gdbusnamewatching.xml"/>
172       <xi:include href="xml/gdbusinterface.xml"/>
173       <xi:include href="xml/gdbusinterfaceskeleton.xml"/>
174       <xi:include href="xml/gdbusproxy.xml"/>
175       <xi:include href="xml/gdbusobject.xml"/>
176       <xi:include href="xml/gdbusobjectskeleton.xml"/>
177       <xi:include href="xml/gdbusobjectproxy.xml"/>
178       <xi:include href="xml/gdbusobjectmanager.xml"/>
179       <xi:include href="xml/gdbusobjectmanagerserver.xml"/>
180       <xi:include href="xml/gdbusobjectmanagerclient.xml"/>
181     </chapter>
182     <chapter id="settings">
183         <title>Settings</title>
184         <xi:include href="xml/gsettings.xml"/>
185         <xi:include href="xml/gsettingsbackend.xml"/>
186         <xi:include href="xml/gsettingsschema.xml"/>
187     </chapter>
188     <chapter id="resources">
189         <title>Resources</title>
190         <xi:include href="xml/gresource.xml"/>
191     </chapter>
192     <chapter id='permissions'>
193         <title>Permissions</title>
194         <xi:include href="xml/gpermission.xml"/>
195         <xi:include href="xml/gsimplepermission.xml"/>
196     </chapter>
197     <chapter id="application">
198         <title>Application support</title>
199         <xi:include href="xml/gapplication.xml"/>
200         <xi:include href="xml/gapplicationcommandline.xml"/>
201         <xi:include href="xml/gactiongroup.xml"/>
202         <xi:include href="xml/gactionmap.xml"/>
203         <xi:include href="xml/gsimpleactiongroup.xml"/>
204         <xi:include href="xml/gaction.xml"/>
205         <xi:include href="xml/gsimpleaction.xml"/>
206         <xi:include href="xml/gremoteactiongroup.xml"/>
207         <xi:include href="xml/gactiongroupexporter.xml"/>
208         <xi:include href="xml/gdbusactiongroup.xml"/>
209         <xi:include href="xml/gmenumodel.xml"/>
210         <xi:include href="xml/gmenu.xml"/>
211         <xi:include href="xml/gmenumarkup.xml"/>
212         <xi:include href="xml/gmenuexporter.xml"/>
213         <xi:include href="xml/gdbusmenumodel.xml"/>
214     </chapter>
215     <chapter id="extending">
216         <title>Extending GIO</title>
217         <xi:include href="xml/gvfs.xml"/>
218         <xi:include href="xml/giomodule.xml"/>
219         <xi:include href="xml/extensionpoints.xml"/>
220     </chapter>
221     <chapter id="tools">
222         <title>GIO Tools</title>
223         <xi:include href="gio-querymodules.xml"/>
224         <xi:include href="gsettings.xml"/>
225         <xi:include href="glib-compile-schemas.xml"/>
226         <xi:include href="glib-compile-resources.xml"/>
227         <xi:include href="gdbus.xml"/>
228         <xi:include href="xml/gdbus-codegen.xml"/>
229         <xi:include href="gresource.xml"/>
230     </chapter>
231   </part>
232
233   <part id="migrating">
234     <title>Migrating to GIO</title>
235     <xi:include href="xml/migrating-posix.xml"/>
236     <xi:include href="xml/migrating-gnome-vfs.xml"/>
237     <xi:include href="xml/migrating-gconf.xml"/>
238     <xi:include href="xml/migrating-gdbus.xml"/>
239   </part>
240
241   <chapter id="gio-hierarchy">
242     <title>Object Hierarchy</title>
243       <xi:include href="xml/tree_index.sgml"/>
244   </chapter>
245   
246   <index id="api-index-full">
247     <title id="index-all">Index</title>
248     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
249   </index>
250   <index id="api-index-deprecated" role="deprecated">
251     <title>Index of deprecated symbols</title>
252     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
253   </index>
254   <index id="api-index-2-18" role="2.18">
255     <title>Index of new symbols in 2.18</title>
256     <xi:include href="xml/api-index-2.18.xml"><xi:fallback /></xi:include>
257   </index>
258   <index id="api-index-2-20" role="2.20">
259     <title>Index of new symbols in 2.20</title>
260     <xi:include href="xml/api-index-2.20.xml"><xi:fallback /></xi:include>
261   </index>
262   <index id="api-index-2-22" role="2.22">
263     <title>Index of new symbols in 2.22</title>
264     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
265   </index>
266   <index id="api-index-2-24" role="2.24">
267     <title>Index of new symbols in 2.24</title>
268     <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
269   </index>
270   <index id="api-index-2-26" role="2.26">
271     <title>Index of new symbols in 2.26</title>
272     <xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
273   </index>
274   <index id="api-index-2-28" role="2.28">
275     <title>Index of new symbols in 2.28</title>
276     <xi:include href="xml/api-index-2.28.xml"><xi:fallback /></xi:include>
277   </index>
278   <index id="api-index-2-30" role="2.30">
279     <title>Index of new symbols in 2.30</title>
280     <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
281   </index>
282   <index id="api-index-2-32" role="2.32">
283     <title>Index of new symbols in 2.32</title>
284     <xi:include href="xml/api-index-2.32.xml"><xi:fallback /></xi:include>
285   </index>
286
287   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
288
289 </book>