chapter06/glib.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4   <!ENTITY % general-entities SYSTEM "../general.ent">
   5   %general-entities;
   6 ]>
   7
   8 <sect1 id="ch-system-glib" role="wrap">
   9   <?dbhtml filename="glib.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>glib</productname>
  13     <productnumber>&glib-version;</productnumber>
  14     <address>&glib-url;</address>
  15   </sect1info>
  16
  17   <title>Glib-&glib-version;</title>
  18
  19   <indexterm zone="ch-system-glib">
  20     <primary sortas="a-Glib">Glib</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The GLib package contains a low-level core library. This is useful
  27     for providing data structure handling for C, portability wrappers and
  28     interfaces for such runtime functionality as an event loop, threads,
  29     dynamic loading, and an object system.</para>
  30
  31     <segmentedlist>
  32       <segtitle>&buildtime;</segtitle>
  33       <segtitle>&diskspace;</segtitle>
  34
  35       <seglistitem>
  36         <seg>&glib-ch6-sbu;</seg>
  37         <seg>&glib-ch6-du;</seg>
  38       </seglistitem>
  39     </segmentedlist>
  40
  41   </sect2>
  42
  43   <sect2 role="installation">
  44     <title>Installation of Glib</title>
  45
  46     <para>Prepare Glib for compilation:</para>
  47
  48 <screen><userinput remap="configure">PCRE_LIBS="-L/usr/lib -lpcre" PCRE_CFLAGS="-I/usr/include" \
  49 ./configure --prefix=/usr --sysconfdir=/etc --with-pcre=system</userinput></screen>
  50
  51     <variablelist>
  52       <title>The meaning of the configure options:</title>
  53
  54       <varlistentry>
  55         <term><parameter>--with-pcre=system</parameter></term>
  56         <listitem>
  57           <para>This parameter causes the build to use a system-provided
  58           version of the PCRE library instead of an internal version.</para>
  59         </listitem>
  60       </varlistentry>
  61     </variablelist>
  62
  63     <para>Compile the package:</para>
  64
  65 <screen><userinput remap="make">make</userinput></screen>
  66
  67     <para>Due to dependencies on additional Perl modules and other packages not yet present
  68     (e.g. desktop-file-utils and DBus), it is not possible to run Glib's test suite.</para>
  69
  70     <para>Install the package:</para>
  71
  72 <screen><userinput remap="install">make install</userinput></screen>
  73
  74   </sect2>
  75
  76   <sect2 id="contents-glib" role="content">
  77     <title>Contents of Glib</title>
  78
  79     <segmentedlist>
  80       <segtitle>Installed programs</segtitle>
  81       <segtitle>Installed libraries</segtitle>
  82       <segtitle>Installed directories</segtitle>
  83
  84       <seglistitem>
  85         <seg>gio-querymodules, glib-genmarshal, glib-gettextize,
  86         glib-mkenums, gobject-query, gtester and gtester-report</seg>
  87         <seg>libgio-2.0.so, libglib-2.0.so, libgmodule-2.0.so,
  88         libgobject-2.0.so, and libgthread-2.0.so</seg>
  89         <seg>/usr/include/{gio-unix-2.0/gio,glib-2.0/{gio,glib,gobject}},
  90              /usr/lib/{gio/modules,glib-2.0/include},
  91              /usr/share/{gdb/auto-load,glib-2.0/{gdb, gettext/po},gtk-doc/html/{gio,glib,gobject}}</seg>
  92       </seglistitem>
  93     </segmentedlist>
  94
  95     <variablelist>
  96       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  97       <?dbfo list-presentation="list"?>
  98       <?dbhtml list-presentation="table"?>
  99
 100       <varlistentry id="gio-querymodules">
 101         <term><command>gio-querymodules</command></term>
 102         <listitem>
 103           <para>is a C code marshaller generation utility for GLib
 104           closures.</para>
 105           <indexterm zone="ch-system-glib gio-querymodules">
 106             <primary sortas="b-glib">gio-querymodules</primary>
 107           </indexterm>
 108         </listitem>
 109       </varlistentry>
 110
 111       <varlistentry id="glib-gettextize">
 112         <term><command>glib-gettextize</command></term>
 113         <listitem>
 114           <para>is a variant of the gettext internationalization
 115           utility.</para>
 116           <indexterm zone="ch-system-glib glib-gettextize">
 117             <primary sortas="b-glib-gettextize">glib-gettextize</primary>
 118           </indexterm>
 119         </listitem>
 120       </varlistentry>
 121
 122       <varlistentry id="glib-mkenums">
 123         <term><command>glib-mkenums</command></term>
 124         <listitem>
 125           <para>is a C language enum description generation utility.</para>
 126           <indexterm zone="ch-system-glib glib-mkenums">
 127             <primary sortas="b-glib-mkenums">glib-mkenums</primary>
 128           </indexterm>
 129         </listitem>
 130       </varlistentry>
 131
 132       <varlistentry id="gobject-query">
 133         <term><command>gobject-query</command></term>
 134         <listitem>
 135           <para>Is a small utility that draws a tree of types.</para>
 136           <indexterm zone="ch-system-glib gobject-query">
 137             <primary sortas="b-gobject-query">gobject-query</primary>
 138           </indexterm>
 139         </listitem>
 140       </varlistentry>
 141
 142       <varlistentry id="gtester">
 143         <term><command>gtester</command></term>
 144         <listitem>
 145           <para>Is a test running utility.</para>
 146           <indexterm zone="ch-system-glib gtester">
 147             <primary sortas="b-gtester">gtester</primary>
 148           </indexterm>
 149         </listitem>
 150       </varlistentry>
 151
 152       <varlistentry id="gtester-report">
 153         <term><command>gtester-report</command></term>
 154         <listitem>
 155           <para>Is a test report formatting utility.</para>
 156           <indexterm zone="ch-system-glib gtester-report">
 157             <primary sortas="b-gtester-report">gtester-report</primary>
 158           </indexterm>
 159         </listitem>
 160       </varlistentry>
 161
 162       <varlistentry id="glib">
 163         <term><filename class="libraryfile">Glib libraries</filename></term>
 164         <listitem>
 165           <para>contain a general purpose low-level core library.</para>
 166         </listitem>
 167       </varlistentry>
 168
 169     </variablelist>
 170
 171   </sect2>
 172
 173 </sect1>