glib-docs.sgml 6.54 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1 2 3 4 5 6
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!entity glib-Basic-Types SYSTEM "sgml/types.sgml">
<!entity glib-Limits-of-Basic-Types SYSTEM "sgml/limits.sgml">
<!entity glib-Standard-Macros SYSTEM "sgml/macros.sgml">
<!entity glib-Type-Conversion-Macros SYSTEM "sgml/type_conversion.sgml">
<!entity glib-Byte-Order-Macros SYSTEM "sgml/byte_order.sgml">
7
<!entity glib-Numerical-Definitions SYSTEM "sgml/numerical.sgml">
Owen Taylor's avatar
Owen Taylor committed
8 9
<!entity glib-Miscellaneous-Macros SYSTEM "sgml/macros_misc.sgml">
<!entity glib-Memory-Allocation SYSTEM "sgml/memory.sgml">
10
<!entity glib-Error-Reporting SYSTEM "sgml/error_reporting.sgml">
Owen Taylor's avatar
Owen Taylor committed
11 12
<!entity glib-Warnings-and-Assertions SYSTEM "sgml/warnings.sgml">
<!entity glib-Message-Logging SYSTEM "sgml/messages.sgml">
13
<!entity glib-Pattern-Matching SYSTEM "sgml/patterns.sgml">
Owen Taylor's avatar
Owen Taylor committed
14 15
<!entity glib-Timers SYSTEM "sgml/timers.sgml">
<!entity glib-String-Utility-Functions SYSTEM "sgml/string_utils.sgml">
16
<!entity glib-Character-Set-Conversion SYSTEM "sgml/conversions.sgml">
17 18
<!entity glib-Unicode-Manipulation SYSTEM "sgml/unicode.sgml">
<!entity glib-Random-Numbers SYSTEM "sgml/random_numbers.sgml">
Owen Taylor's avatar
Owen Taylor committed
19 20 21 22
<!entity glib-Miscellaneous-Utility-Functions SYSTEM "sgml/misc_utils.sgml">
<!entity glib-Date-and-Time-Functions SYSTEM "sgml/date.sgml">
<!entity glib-The-Main-Event-Loop SYSTEM "sgml/main.sgml">
<!entity glib-Threads SYSTEM "sgml/threads.sgml">
23 24
<!entity glib-Thread-Pools SYSTEM "sgml/thread_pools.sgml">
<!entity glib-Async-Queues SYSTEM "sgml/async_queues.sgml">
Owen Taylor's avatar
Owen Taylor committed
25 26 27 28 29 30 31 32 33
<!entity glib-IO-Channels SYSTEM "sgml/iochannels.sgml">
<!entity glib-Hook-Functions SYSTEM "sgml/hooks.sgml">
<!entity glib-Lexical-Scanner SYSTEM "sgml/scanner.sgml">
<!entity glib-Dynamic-Loading-of-Modules SYSTEM "sgml/modules.sgml">
<!entity glib-Automatic-String-Completion SYSTEM "sgml/completion.sgml">
<!entity glib-Windows-Compatability-Functions SYSTEM "sgml/windows.sgml">
<!entity glib-Memory-Chunks SYSTEM "sgml/memory_chunks.sgml">
<!entity glib-Doubly-Linked-Lists SYSTEM "sgml/linked_lists_double.sgml">
<!entity glib-Singly-Linked-Lists SYSTEM "sgml/linked_lists_single.sgml">
34 35
<!entity glib-Double-ended-Queues SYSTEM "sgml/queue.sgml">
<!entity glib-Trash-Stacks SYSTEM "sgml/trash_stack.sgml">
Owen Taylor's avatar
Owen Taylor committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49
<!entity glib-Hash-Tables SYSTEM "sgml/hash_tables.sgml">
<!entity glib-Strings SYSTEM "sgml/strings.sgml">
<!entity glib-String-Chunks SYSTEM "sgml/string_chunks.sgml">
<!entity glib-Arrays SYSTEM "sgml/arrays.sgml">
<!entity glib-Pointer-Arrays SYSTEM "sgml/arrays_pointer.sgml">
<!entity glib-Byte-Arrays SYSTEM "sgml/arrays_byte.sgml">
<!entity glib-Balanced-Binary-Trees SYSTEM "sgml/trees-binary.sgml">
<!entity glib-N-ary-Trees SYSTEM "sgml/trees-nary.sgml">
<!entity glib-Quarks SYSTEM "sgml/quarks.sgml">
<!entity glib-Keyed-Data-Lists SYSTEM "sgml/datalist.sgml">
<!entity glib-Datasets SYSTEM "sgml/datasets.sgml">
<!entity glib-Relations-and-Tuples SYSTEM "sgml/relations.sgml">
<!entity glib-Caches SYSTEM "sgml/caches.sgml">
<!entity glib-Memory-Allocators SYSTEM "sgml/allocators.sgml">
50 51 52 53 54
<!entity glib-Spawn SYSTEM "sgml/spawn.sgml">
<!entity glib-Fileutils SYSTEM "sgml/fileutils.sgml">
<!entity glib-Shell SYSTEM "sgml/shell.sgml">
<!entity glib-Markup SYSTEM "sgml/markup.sgml">

Matthias Clasen's avatar
Matthias Clasen committed
55 56 57 58 59 60
<!entity glib-Compiling SYSTEM "compiling.sgml">
<!entity glib-Building SYSTEM "building.sgml">
<!entity glib-Running SYSTEM "running.sgml">
<!entity glib-Resources SYSTEM "resources.sgml">
<!entity glib-Changes-2-0 SYSTEM "changes-2.0.sgml">

Owen Taylor's avatar
Owen Taylor committed
61 62 63 64 65 66
]>
<book id="index">
  <bookinfo>
    <title>GLib Reference Manual</title>
  </bookinfo>

Matthias Clasen's avatar
Matthias Clasen committed
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
  <chapter id="glib">
    <title>GLib Overview</title>
    <para>
GLib is a general-purpose utility library, which provides many useful data 
types, macros, type conversions, string utilities, file utilities, a main 
loop abstraction, and so on. It works on many UNIX-like platforms, Windows,
OS/2 and BeOS. GLib is released under the GNU Library General Public License 
(GNU LGPL). 
    </para>
    <para>
GLib depends on the following: 
<variablelist>

<varlistentry>
<term><function>iconv()</function></term>
<listitem><para>
In order to implement conversions between character sets,
GLib requires an implementation of the standard <function>iconv()</function> 
routine. Most modern systems will have a suitable implementation, however
many older systems lack an <function>iconv()</function> implementation. On 
such systems, you must install the 
<ulink url="http://clisp.cons.org/~haible/packages-libiconv.html">libiconv</ulink> library.
</para></listitem>
</varlistentry>

<varlistentry>
<term>a thread implementation</term>
<listitem><para>
The thread support in GLib can be based upon several native thread 
implementations, e.g. POSIX threads, DCE threads or Solaris threads.
</para></listitem>
</varlistentry>

</variablelist>    
    </para>

    &glib-Building;
    &glib-Compiling;
    &glib-Running;
    &glib-Changes-2-0;
    &glib-Resources;
 
  </chapter> 

Owen Taylor's avatar
Owen Taylor committed
111 112 113 114 115 116 117
  <chapter id="glib-fundamentals">
    <title>GLib Fundamentals</title>
    &glib-Basic-Types;
    &glib-Limits-of-Basic-Types;
    &glib-Standard-Macros;
    &glib-Type-Conversion-Macros;
    &glib-Byte-Order-Macros;
118
    &glib-Numerical-Definitions;
Owen Taylor's avatar
Owen Taylor committed
119 120 121 122 123 124 125
    &glib-Miscellaneous-Macros;
  </chapter>

  <chapter id="glib-core">
    <title>GLib Core Application Support</title>
    &glib-The-Main-Event-Loop;
    &glib-Threads;
126 127
    &glib-Thread-Pools;
    &glib-Async-Queues;
Owen Taylor's avatar
Owen Taylor committed
128 129 130
    &glib-Dynamic-Loading-of-Modules;
    &glib-Memory-Allocation;
    &glib-IO-Channels;
131
    &glib-Error-Reporting;
Owen Taylor's avatar
Owen Taylor committed
132 133 134 135 136 137 138
    &glib-Warnings-and-Assertions;
    &glib-Message-Logging;
  </chapter>

  <chapter id="glib-utilities">
    <title>GLib Utilities</title>
    &glib-String-Utility-Functions;
139
    &glib-Character-Set-Conversion;
140
    &glib-Unicode-Manipulation;
Owen Taylor's avatar
Owen Taylor committed
141
    &glib-Date-and-Time-Functions;
142
    &glib-Random-Numbers;   
Owen Taylor's avatar
Owen Taylor committed
143 144 145 146 147
    &glib-Hook-Functions;
    &glib-Miscellaneous-Utility-Functions;
    &glib-Lexical-Scanner;
    &glib-Automatic-String-Completion;
    &glib-Timers;
148 149 150
    &glib-Spawn;
    &glib-Fileutils;
    &glib-Shell;
151
    &glib-Pattern-Matching;
152
    &glib-Markup;
Owen Taylor's avatar
Owen Taylor committed
153 154 155 156 157 158 159 160
    &glib-Windows-Compatability-Functions;
  </chapter>

  <chapter id="glib-data-types">
    <title>GLib Data Types</title>
    &glib-Memory-Chunks;
    &glib-Doubly-Linked-Lists;
    &glib-Singly-Linked-Lists;
161 162
    &glib-Double-ended-Queues;
    &glib-Trash-Stacks;
Owen Taylor's avatar
Owen Taylor committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
    &glib-Hash-Tables;
    &glib-Strings;
    &glib-String-Chunks;
    &glib-Arrays;
    &glib-Pointer-Arrays;
    &glib-Byte-Arrays;
    &glib-Balanced-Binary-Trees;
    &glib-N-ary-Trees;
    &glib-Quarks;
    &glib-Keyed-Data-Lists;
    &glib-Datasets;
    &glib-Relations-and-Tuples;
    &glib-Caches;
    &glib-Memory-Allocators;
  </chapter>
Matthias Clasen's avatar
Matthias Clasen committed
178
</book>