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 % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
   5 <!ENTITY version SYSTEM "version.xml">
   6 ]>
   7 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   8   <bookinfo>
   9     <title>GLib Reference Manual</title>
  10     <releaseinfo>
  11       for GLib &version;
  12       The latest version of this documentation can be found on-line at
  13       <ulink role="online-location" url="http://library.gnome.org/devel/glib/unstable/">http://library.gnome.org/devel/glib/unstable/</ulink>.
  14     </releaseinfo>
  15   </bookinfo>
  16
  17   <chapter id="glib">
  18     <title>GLib Overview</title>
  19     <para>
  20 GLib is a general-purpose utility library, which provides many useful data
  21 types, macros, type conversions, string utilities, file utilities, a main
  22 loop abstraction, and so on. It works on many UNIX-like platforms, Windows,
  23 OS/2 and BeOS. GLib is released under the GNU Library General Public License
  24 (GNU LGPL).
  25     </para>
  26     <para>
  27 The general policy of GLib is that all functions are invisibly threadsafe with the
  28 exception of data structure manipulation functions, where, if you have two threads
  29 manipulating the <emphasis>same</emphasis> data structure, they must use a lock to
  30 synchronize their operation.
  31     </para>
  32
  33     <xi:include href="building.sgml" />
  34     <xi:include href="cross.sgml" />
  35     <xi:include href="compiling.sgml" />
  36     <xi:include href="running.sgml" />
  37     <xi:include href="changes.sgml" />
  38     <xi:include href="regex-syntax.sgml" />
  39     <xi:include href="resources.sgml" />
  40
  41   </chapter>
  42
  43   <chapter id="glib-fundamentals">
  44     <title>GLib Fundamentals</title>
  45     <xi:include href="xml/version.xml" />
  46     <xi:include href="xml/types.xml" />
  47     <xi:include href="xml/limits.xml" />
  48     <xi:include href="xml/macros.xml" />
  49     <xi:include href="xml/type_conversion.xml" />
  50     <xi:include href="xml/byte_order.xml" />
  51     <xi:include href="xml/numerical.xml" />
  52     <xi:include href="xml/macros_misc.xml" />
  53     <xi:include href="xml/atomic_operations.xml" />
  54   </chapter>
  55
  56   <chapter id="glib-core">
  57     <title>GLib Core Application Support</title>
  58     <xi:include href="xml/main.xml" />
  59     <xi:include href="xml/threads.xml" />
  60     <xi:include href="xml/thread_pools.xml" />
  61     <xi:include href="xml/async_queues.xml" />
  62     <xi:include href="xml/modules.xml" />
  63     <xi:include href="xml/memory.xml" />
  64     <xi:include href="xml/iochannels.xml" />
  65     <xi:include href="xml/error_reporting.xml" />
  66     <xi:include href="xml/warnings.xml" />
  67     <xi:include href="xml/messages.xml" />
  68   </chapter>
  69
  70   <chapter id="glib-utilities">
  71     <title>GLib Utilities</title>
  72       <xi:include href="xml/string_utils.xml" />
  73       <xi:include href="xml/conversions.xml" />
  74       <xi:include href="xml/unicode.xml" />
  75       <xi:include href="xml/base64.xml" />
  76       <xi:include href="xml/checksum.xml" />
  77       <xi:include href="xml/i18n.xml" />
  78       <xi:include href="xml/date.xml" />
  79       <xi:include href="xml/random_numbers.xml" />
  80       <xi:include href="xml/hooks.xml" />
  81       <xi:include href="xml/misc_utils.xml" />
  82       <xi:include href="xml/scanner.xml" />
  83       <xi:include href="xml/completion.xml" />
  84       <xi:include href="xml/timers.xml" />
  85       <xi:include href="xml/spawn.xml" />
  86       <xi:include href="xml/fileutils.xml" />
  87       <xi:include href="xml/gurifuncs.xml" />
  88       <xi:include href="xml/ghostutils.xml" />
  89       <xi:include href="xml/shell.xml" />
  90       <xi:include href="xml/option.xml" />
  91       <xi:include href="xml/patterns.xml" />
  92       <xi:include href="xml/gregex.xml" />
  93       <xi:include href="xml/markup.xml" />
  94       <xi:include href="xml/keyfile.xml" />
  95       <xi:include href="xml/bookmarkfile.xml" />
  96       <xi:include href="xml/testing.xml" />
  97       <xi:include href="xml/windows.xml" />
  98   </chapter>
  99
 100   <chapter id="glib-data-types">
 101     <title>GLib Data Types</title>
 102       <xi:include href="xml/memory_slices.xml" />
 103       <xi:include href="xml/memory_chunks.xml" />
 104       <xi:include href="xml/linked_lists_double.xml" />
 105       <xi:include href="xml/linked_lists_single.xml" />
 106       <xi:include href="xml/queue.xml" />
 107       <xi:include href="xml/sequence.xml" />
 108       <xi:include href="xml/trash_stack.xml" />
 109       <xi:include href="xml/hash_tables.xml" />
 110       <xi:include href="xml/strings.xml" />
 111       <xi:include href="xml/string_chunks.xml" />
 112       <xi:include href="xml/arrays.xml" />
 113       <xi:include href="xml/arrays_pointer.xml" />
 114       <xi:include href="xml/arrays_byte.xml" />
 115       <xi:include href="xml/trees-binary.xml" />
 116       <xi:include href="xml/trees-nary.xml" />
 117       <xi:include href="xml/quarks.xml" />
 118       <xi:include href="xml/datalist.xml" />
 119       <xi:include href="xml/datasets.xml" />
 120       <xi:include href="xml/relations.xml" />
 121       <xi:include href="xml/caches.xml" />
 122       <xi:include href="xml/allocators.xml" />
 123       <xi:include href="xml/gvarianttype.xml"/>
 124       <xi:include href="xml/gvariant.xml"/>
 125       <xi:include href="gvariant-varargs.xml"/>
 126   </chapter>
 127
 128   <chapter id="tools">
 129     <title>GLib Tools</title>
 130     <xi:include href="glib-gettextize.xml" />
 131     <xi:include href="gtester.xml" />
 132     <xi:include href="gtester-report.xml" />
 133   </chapter>
 134
 135   <index id="api-index-full">
 136     <title>Index</title>
 137     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 138   </index>
 139   <index id="api-index-deprecated" role="deprecated">
 140     <title>Index of deprecated symbols</title>
 141     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 142   </index>
 143   <index id="api-index-2-2" role="2.2">
 144     <title>Index of new symbols in 2.2</title>
 145     <xi:include href="xml/api-index-2.2.xml"><xi:fallback /></xi:include>
 146   </index>
 147   <index id="api-index-2-4" role="2.4">
 148     <title>Index of new symbols in 2.4</title>
 149     <xi:include href="xml/api-index-2.4.xml"><xi:fallback /></xi:include>
 150   </index>
 151   <index id="api-index-2-6" role="2.6">
 152     <title>Index of new symbols in 2.6</title>
 153     <xi:include href="xml/api-index-2.6.xml"><xi:fallback /></xi:include>
 154   </index>
 155   <index id="api-index-2-8" role="2.8">
 156     <title>Index of new symbols in 2.8</title>
 157     <xi:include href="xml/api-index-2.8.xml"><xi:fallback /></xi:include>
 158   </index>
 159   <index id="api-index-2-10" role="2.10">
 160     <title>Index of new symbols in 2.10</title>
 161     <xi:include href="xml/api-index-2.10.xml"><xi:fallback /></xi:include>
 162   </index>
 163   <index id="api-index-2-12" role="2.12">
 164     <title>Index of new symbols in 2.12</title>
 165     <xi:include href="xml/api-index-2.12.xml"><xi:fallback /></xi:include>
 166   </index>
 167   <index id="api-index-2-14" role="2.14">
 168     <title>Index of new symbols in 2.14</title>
 169     <xi:include href="xml/api-index-2.14.xml"><xi:fallback /></xi:include>
 170   </index>
 171   <index id="api-index-2-16" role="2.16">
 172     <title>Index of new symbols in 2.16</title>
 173     <xi:include href="xml/api-index-2.16.xml"><xi:fallback /></xi:include>
 174   </index>
 175   <index id="api-index-2-18" role="2.18">
 176     <title>Index of new symbols in 2.18</title>
 177     <xi:include href="xml/api-index-2.18.xml"><xi:fallback /></xi:include>
 178   </index>
 179   <index id="api-index-2-20" role="2.20">
 180     <title>Index of new symbols in 2.20</title>
 181     <xi:include href="xml/api-index-2.20.xml"><xi:fallback /></xi:include>
 182   </index>
 183   <index id="api-index-2-22" role="2.22">
 184     <title>Index of new symbols in 2.22</title>
 185     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
 186   </index>
 187   <index id="api-index-2-24" role="2.24">
 188     <title>Index of new symbols in 2.24</title>
 189     <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
 190   </index>
 191
 192 </book>