New function to check the version of GLib at runtime. (#149175, Michael
[platform/upstream/glib.git] / docs / reference / glib / glib-docs.sgml
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 glib-Basic-Types SYSTEM "xml/types.xml">
5 <!ENTITY glib-Limits-of-Basic-Types SYSTEM "xml/limits.xml">
6 <!ENTITY glib-Standard-Macros SYSTEM "xml/macros.xml">
7 <!ENTITY glib-Type-Conversion-Macros SYSTEM "xml/type_conversion.xml">
8 <!ENTITY glib-Byte-Order-Macros SYSTEM "xml/byte_order.xml">
9 <!ENTITY glib-Numerical-Definitions SYSTEM "xml/numerical.xml">
10 <!ENTITY glib-Miscellaneous-Macros SYSTEM "xml/macros_misc.xml">
11 <!ENTITY glib-Atomic-Operations SYSTEM "xml/atomic_operations.xml">
12 <!ENTITY glib-Memory-Allocation SYSTEM "xml/memory.xml">
13 <!ENTITY glib-Error-Reporting SYSTEM "xml/error_reporting.xml">
14 <!ENTITY glib-Warnings-and-Assertions SYSTEM "xml/warnings.xml">
15 <!ENTITY glib-Message-Logging SYSTEM "xml/messages.xml">
16 <!ENTITY glib-Pattern-Matching SYSTEM "xml/patterns.xml">
17 <!ENTITY glib-Timers SYSTEM "xml/timers.xml">
18 <!ENTITY glib-String-Utility-Functions SYSTEM "xml/string_utils.xml">
19 <!ENTITY glib-Character-Set-Conversion SYSTEM "xml/conversions.xml">
20 <!ENTITY glib-Unicode-Manipulation SYSTEM "xml/unicode.xml">
21 <!ENTITY glib-Random-Numbers SYSTEM "xml/random_numbers.xml">
22 <!ENTITY glib-Miscellaneous-Utility-Functions SYSTEM "xml/misc_utils.xml">
23 <!ENTITY glib-Date-and-Time-Functions SYSTEM "xml/date.xml">
24 <!ENTITY glib-The-Main-Event-Loop SYSTEM "xml/main.xml">
25 <!ENTITY glib-Threads SYSTEM "xml/threads.xml">
26 <!ENTITY glib-Thread-Pools SYSTEM "xml/thread_pools.xml">
27 <!ENTITY glib-Async-Queues SYSTEM "xml/async_queues.xml">
28 <!ENTITY glib-IO-Channels SYSTEM "xml/iochannels.xml">
29 <!ENTITY glib-Hook-Functions SYSTEM "xml/hooks.xml">
30 <!ENTITY glib-Lexical-Scanner SYSTEM "xml/scanner.xml">
31 <!ENTITY glib-Dynamic-Loading-of-Modules SYSTEM "xml/modules.xml">
32 <!ENTITY glib-Automatic-String-Completion SYSTEM "xml/completion.xml">
33 <!ENTITY glib-Windows-Compatability-Functions SYSTEM "xml/windows.xml">
34 <!ENTITY glib-Memory-Chunks SYSTEM "xml/memory_chunks.xml">
35 <!ENTITY glib-Doubly-Linked-Lists SYSTEM "xml/linked_lists_double.xml">
36 <!ENTITY glib-Singly-Linked-Lists SYSTEM "xml/linked_lists_single.xml">
37 <!ENTITY glib-Double-ended-Queues SYSTEM "xml/queue.xml">
38 <!ENTITY glib-Trash-Stacks SYSTEM "xml/trash_stack.xml">
39 <!ENTITY glib-Hash-Tables SYSTEM "xml/hash_tables.xml">
40 <!ENTITY glib-Strings SYSTEM "xml/strings.xml">
41 <!ENTITY glib-String-Chunks SYSTEM "xml/string_chunks.xml">
42 <!ENTITY glib-Arrays SYSTEM "xml/arrays.xml">
43 <!ENTITY glib-Pointer-Arrays SYSTEM "xml/arrays_pointer.xml">
44 <!ENTITY glib-Byte-Arrays SYSTEM "xml/arrays_byte.xml">
45 <!ENTITY glib-Balanced-Binary-Trees SYSTEM "xml/trees-binary.xml">
46 <!ENTITY glib-N-ary-Trees SYSTEM "xml/trees-nary.xml">
47 <!ENTITY glib-Quarks SYSTEM "xml/quarks.xml">
48 <!ENTITY glib-Keyed-Data-Lists SYSTEM "xml/datalist.xml">
49 <!ENTITY glib-Datasets SYSTEM "xml/datasets.xml">
50 <!ENTITY glib-Relations-and-Tuples SYSTEM "xml/relations.xml">
51 <!ENTITY glib-Caches SYSTEM "xml/caches.xml">
52 <!ENTITY glib-Memory-Allocators SYSTEM "xml/allocators.xml">
53 <!ENTITY glib-Spawn SYSTEM "xml/spawn.xml">
54 <!ENTITY glib-Fileutils SYSTEM "xml/fileutils.xml">
55 <!ENTITY glib-Shell SYSTEM "xml/shell.xml">
56 <!ENTITY glib-Markup SYSTEM "xml/markup.xml">
57 <!ENTITY glib-i18n SYSTEM "xml/i18n.xml">
58 <!ENTITY glib-Version SYSTEM "xml/version.xml">
59
60 <!ENTITY glib-Compiling SYSTEM "compiling.sgml">
61 <!ENTITY glib-Building SYSTEM "building.sgml">
62 <!ENTITY glib-Cross SYSTEM "cross.sgml">
63 <!ENTITY glib-Running SYSTEM "running.sgml">
64 <!ENTITY glib-Resources SYSTEM "resources.sgml">
65 <!ENTITY glib-Changes SYSTEM "changes.sgml">
66
67 <!ENTITY glib-gettextize SYSTEM "glib-gettextize.xml">
68
69 <!ENTITY version SYSTEM "version.xml">
70 ]>
71 <book id="index">
72   <bookinfo>
73     <title>GLib Reference Manual</title>
74     <releaseinfo>for GLib &version;</releaseinfo>
75   </bookinfo>
76
77   <chapter id="glib">
78     <title>GLib Overview</title>
79     <para>
80 GLib is a general-purpose utility library, which provides many useful data 
81 types, macros, type conversions, string utilities, file utilities, a main 
82 loop abstraction, and so on. It works on many UNIX-like platforms, Windows,
83 OS/2 and BeOS. GLib is released under the GNU Library General Public License 
84 (GNU LGPL). 
85     </para>
86     <para>
87 The general policy of GLib is that all functions are invisibly threadsafe with the 
88 exception of data structure manipulation functions, where, if you have two threads
89 manipulating the <emphasis>same</emphasis> data structure, they must use a lock to
90 synchronize their operation.
91     </para>
92
93     &glib-Building;
94     &glib-Cross;
95     &glib-Compiling;
96     &glib-Running;
97     &glib-Changes;
98     &glib-Resources;
99  
100   </chapter> 
101
102   <chapter id="glib-fundamentals">
103     <title>GLib Fundamentals</title>
104     &glib-Version;
105     &glib-Basic-Types;
106     &glib-Limits-of-Basic-Types;
107     &glib-Standard-Macros;
108     &glib-Type-Conversion-Macros;
109     &glib-Byte-Order-Macros;
110     &glib-Numerical-Definitions;
111     &glib-Miscellaneous-Macros;
112     &glib-Atomic-Operations;
113   </chapter>
114
115   <chapter id="glib-core">
116     <title>GLib Core Application Support</title>
117     &glib-The-Main-Event-Loop;
118     &glib-Threads;
119     &glib-Thread-Pools;
120     &glib-Async-Queues;
121     &glib-Dynamic-Loading-of-Modules;
122     &glib-Memory-Allocation;
123     &glib-IO-Channels;
124     &glib-Error-Reporting;
125     &glib-Warnings-and-Assertions;
126     &glib-Message-Logging;
127   </chapter>
128
129   <chapter id="glib-utilities">
130     <title>GLib Utilities</title>
131     &glib-String-Utility-Functions;
132     &glib-Character-Set-Conversion;
133     &glib-Unicode-Manipulation;
134     &glib-i18n;
135     &glib-Date-and-Time-Functions;
136     &glib-Random-Numbers;   
137     &glib-Hook-Functions;
138     &glib-Miscellaneous-Utility-Functions;
139     &glib-Lexical-Scanner;
140     &glib-Automatic-String-Completion;
141     &glib-Timers;
142     &glib-Spawn;
143     &glib-Fileutils;
144     &glib-Shell;
145     &glib-Pattern-Matching;
146     &glib-Markup;
147     &glib-Windows-Compatability-Functions;
148   </chapter>
149
150   <chapter id="glib-data-types">
151     <title>GLib Data Types</title>
152     &glib-Memory-Chunks;
153     &glib-Doubly-Linked-Lists;
154     &glib-Singly-Linked-Lists;
155     &glib-Double-ended-Queues;
156     &glib-Trash-Stacks;
157     &glib-Hash-Tables;
158     &glib-Strings;
159     &glib-String-Chunks;
160     &glib-Arrays;
161     &glib-Pointer-Arrays;
162     &glib-Byte-Arrays;
163     &glib-Balanced-Binary-Trees;
164     &glib-N-ary-Trees;
165     &glib-Quarks;
166     &glib-Keyed-Data-Lists;
167     &glib-Datasets;
168     &glib-Relations-and-Tuples;
169     &glib-Caches;
170     &glib-Memory-Allocators;
171   </chapter>
172
173   <chapter id="tools">
174     <title>GLib Tools</title>
175
176     &glib-gettextize;
177   </chapter>
178
179   <index>
180     <title>Index</title>
181   </index>
182   <index role="deprecated">
183     <title>Index of deprecated symbols</title>
184   </index>
185   <index role="2.2">
186     <title>Index of new symbols in 2.2</title>
187   </index>
188   <index role="2.4">
189     <title>Index of new symbols in 2.4</title>
190   </index>  
191
192 </book>