docs/reference/glib/glib-docs.sgml

   1 <!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
   2 <!entity glib-Basic-Types SYSTEM "sgml/types.sgml">
   3 <!entity glib-Limits-of-Basic-Types SYSTEM "sgml/limits.sgml">
   4 <!entity glib-Standard-Macros SYSTEM "sgml/macros.sgml">
   5 <!entity glib-Type-Conversion-Macros SYSTEM "sgml/type_conversion.sgml">
   6 <!entity glib-Byte-Order-Macros SYSTEM "sgml/byte_order.sgml">
   7 <!entity glib-Numerical-Definitions SYSTEM "sgml/numerical.sgml">
   8 <!entity glib-Miscellaneous-Macros SYSTEM "sgml/macros_misc.sgml">
   9 <!entity glib-Memory-Allocation SYSTEM "sgml/memory.sgml">
  10 <!entity glib-Error-Reporting SYSTEM "sgml/error_reporting.sgml">
  11 <!entity glib-Warnings-and-Assertions SYSTEM "sgml/warnings.sgml">
  12 <!entity glib-Message-Logging SYSTEM "sgml/messages.sgml">
  13 <!entity glib-Pattern-Matching SYSTEM "sgml/patterns.sgml">
  14 <!entity glib-Timers SYSTEM "sgml/timers.sgml">
  15 <!entity glib-String-Utility-Functions SYSTEM "sgml/string_utils.sgml">
  16 <!entity glib-Character-Set-Conversion SYSTEM "sgml/conversions.sgml">
  17 <!entity glib-Unicode-Manipulation SYSTEM "sgml/unicode.sgml">
  18 <!entity glib-Random-Numbers SYSTEM "sgml/random_numbers.sgml">
  19 <!entity glib-Miscellaneous-Utility-Functions SYSTEM "sgml/misc_utils.sgml">
  20 <!entity glib-Date-and-Time-Functions SYSTEM "sgml/date.sgml">
  21 <!entity glib-The-Main-Event-Loop SYSTEM "sgml/main.sgml">
  22 <!entity glib-Threads SYSTEM "sgml/threads.sgml">
  23 <!entity glib-Thread-Pools SYSTEM "sgml/thread_pools.sgml">
  24 <!entity glib-Async-Queues SYSTEM "sgml/async_queues.sgml">
  25 <!entity glib-IO-Channels SYSTEM "sgml/iochannels.sgml">
  26 <!entity glib-Hook-Functions SYSTEM "sgml/hooks.sgml">
  27 <!entity glib-Lexical-Scanner SYSTEM "sgml/scanner.sgml">
  28 <!entity glib-Dynamic-Loading-of-Modules SYSTEM "sgml/modules.sgml">
  29 <!entity glib-Automatic-String-Completion SYSTEM "sgml/completion.sgml">
  30 <!entity glib-Windows-Compatability-Functions SYSTEM "sgml/windows.sgml">
  31 <!entity glib-Memory-Chunks SYSTEM "sgml/memory_chunks.sgml">
  32 <!entity glib-Doubly-Linked-Lists SYSTEM "sgml/linked_lists_double.sgml">
  33 <!entity glib-Singly-Linked-Lists SYSTEM "sgml/linked_lists_single.sgml">
  34 <!entity glib-Double-ended-Queues SYSTEM "sgml/queue.sgml">
  35 <!entity glib-Trash-Stacks SYSTEM "sgml/trash_stack.sgml">
  36 <!entity glib-Hash-Tables SYSTEM "sgml/hash_tables.sgml">
  37 <!entity glib-Strings SYSTEM "sgml/strings.sgml">
  38 <!entity glib-String-Chunks SYSTEM "sgml/string_chunks.sgml">
  39 <!entity glib-Arrays SYSTEM "sgml/arrays.sgml">
  40 <!entity glib-Pointer-Arrays SYSTEM "sgml/arrays_pointer.sgml">
  41 <!entity glib-Byte-Arrays SYSTEM "sgml/arrays_byte.sgml">
  42 <!entity glib-Balanced-Binary-Trees SYSTEM "sgml/trees-binary.sgml">
  43 <!entity glib-N-ary-Trees SYSTEM "sgml/trees-nary.sgml">
  44 <!entity glib-Quarks SYSTEM "sgml/quarks.sgml">
  45 <!entity glib-Keyed-Data-Lists SYSTEM "sgml/datalist.sgml">
  46 <!entity glib-Datasets SYSTEM "sgml/datasets.sgml">
  47 <!entity glib-Relations-and-Tuples SYSTEM "sgml/relations.sgml">
  48 <!entity glib-Caches SYSTEM "sgml/caches.sgml">
  49 <!entity glib-Memory-Allocators SYSTEM "sgml/allocators.sgml">
  50 <!entity glib-Spawn SYSTEM "sgml/spawn.sgml">
  51 <!entity glib-Fileutils SYSTEM "sgml/fileutils.sgml">
  52 <!entity glib-Shell SYSTEM "sgml/shell.sgml">
  53 <!entity glib-Markup SYSTEM "sgml/markup.sgml">
  54
  55 <!entity glib-Compiling SYSTEM "compiling.sgml">
  56 <!entity glib-Building SYSTEM "building.sgml">
  57 <!entity glib-Running SYSTEM "running.sgml">
  58 <!entity glib-Resources SYSTEM "resources.sgml">
  59 <!entity glib-Changes-2-0 SYSTEM "changes-2.0.sgml">
  60
  61 ]>
  62 <book id="index">
  63   <bookinfo>
  64     <title>GLib Reference Manual</title>
  65   </bookinfo>
  66
  67   <chapter id="glib">
  68     <title>GLib Overview</title>
  69     <para>
  70 GLib is a general-purpose utility library, which provides many useful data
  71 types, macros, type conversions, string utilities, file utilities, a main
  72 loop abstraction, and so on. It works on many UNIX-like platforms, Windows,
  73 OS/2 and BeOS. GLib is released under the GNU Library General Public License
  74 (GNU LGPL).
  75     </para>
  76     <para>
  77 GLib depends on the following:
  78 <variablelist>
  79
  80 <varlistentry>
  81 <term><function>iconv()</function></term>
  82 <listitem><para>
  83 In order to implement conversions between character sets,
  84 GLib requires an implementation of the standard <function>iconv()</function>
  85 routine. Most modern systems will have a suitable implementation, however
  86 many older systems lack an <function>iconv()</function> implementation. On
  87 such systems, you must install the
  88 <ulink url="http://clisp.cons.org/~haible/packages-libiconv.html">libiconv</ulink> library.
  89 </para></listitem>
  90 </varlistentry>
  91
  92 <varlistentry>
  93 <term>a thread implementation</term>
  94 <listitem><para>
  95 The thread support in GLib can be based upon several native thread
  96 implementations, e.g. POSIX threads, DCE threads or Solaris threads.
  97 </para></listitem>
  98 </varlistentry>
  99
 100 </variablelist>
 101     </para>
 102
 103     &glib-Building;
 104     &glib-Compiling;
 105     &glib-Running;
 106     &glib-Changes-2-0;
 107     &glib-Resources;
 108
 109   </chapter>
 110
 111   <chapter id="glib-fundamentals">
 112     <title>GLib Fundamentals</title>
 113     &glib-Basic-Types;
 114     &glib-Limits-of-Basic-Types;
 115     &glib-Standard-Macros;
 116     &glib-Type-Conversion-Macros;
 117     &glib-Byte-Order-Macros;
 118     &glib-Numerical-Definitions;
 119     &glib-Miscellaneous-Macros;
 120   </chapter>
 121
 122   <chapter id="glib-core">
 123     <title>GLib Core Application Support</title>
 124     &glib-The-Main-Event-Loop;
 125     &glib-Threads;
 126     &glib-Thread-Pools;
 127     &glib-Async-Queues;
 128     &glib-Dynamic-Loading-of-Modules;
 129     &glib-Memory-Allocation;
 130     &glib-IO-Channels;
 131     &glib-Error-Reporting;
 132     &glib-Warnings-and-Assertions;
 133     &glib-Message-Logging;
 134   </chapter>
 135
 136   <chapter id="glib-utilities">
 137     <title>GLib Utilities</title>
 138     &glib-String-Utility-Functions;
 139     &glib-Character-Set-Conversion;
 140     &glib-Unicode-Manipulation;
 141     &glib-Date-and-Time-Functions;
 142     &glib-Random-Numbers;
 143     &glib-Hook-Functions;
 144     &glib-Miscellaneous-Utility-Functions;
 145     &glib-Lexical-Scanner;
 146     &glib-Automatic-String-Completion;
 147     &glib-Timers;
 148     &glib-Spawn;
 149     &glib-Fileutils;
 150     &glib-Shell;
 151     &glib-Pattern-Matching;
 152     &glib-Markup;
 153     &glib-Windows-Compatability-Functions;
 154   </chapter>
 155
 156   <chapter id="glib-data-types">
 157     <title>GLib Data Types</title>
 158     &glib-Memory-Chunks;
 159     &glib-Doubly-Linked-Lists;
 160     &glib-Singly-Linked-Lists;
 161     &glib-Double-ended-Queues;
 162     &glib-Trash-Stacks;
 163     &glib-Hash-Tables;
 164     &glib-Strings;
 165     &glib-String-Chunks;
 166     &glib-Arrays;
 167     &glib-Pointer-Arrays;
 168     &glib-Byte-Arrays;
 169     &glib-Balanced-Binary-Trees;
 170     &glib-N-ary-Trees;
 171     &glib-Quarks;
 172     &glib-Keyed-Data-Lists;
 173     &glib-Datasets;
 174     &glib-Relations-and-Tuples;
 175     &glib-Caches;
 176     &glib-Memory-Allocators;
 177   </chapter>
 178 </book>