INSTALL

   1 Simple install procedure
   2 ========================
   3
   4   % gzip -cd glib-2.0.1.tar.gz | tar xvf -  # unpack the sources
   5   % cd glib-2.0.1                           # change to the toplevel directory
   6   % ./configure                             # run the `configure' script
   7   % make                                    # build GLIB
   8
   9   [ Become root if necessary ]
  10   % rm -rf /install-prefix/include/glib.h /install-prefix/include/gmodule.h
  11   % make install                            # install GLIB
  12
  13 Requirements
  14 ============
  15
  16 GLib-2.0 requires pkg-config, which is tool for tracking the
  17 compilation flags needed for libraries. (For each library, a small .pc
  18 text file is installed in a standard location that contains the
  19 compilation flags needed for that library along with version number
  20 information.) Information about pkg-config can be found at:
  21
  22   http://www.freedesktop.org/software/pkgconfig/
  23
  24 GNU make (http://www.gnu.org/software/make) is also recommended.
  25
  26 In order to implement conversions between character sets,
  27 GLib requires an implementation of the standard iconv() routine.
  28 Most modern systems will have a suitable implementation, however
  29 many older systems lack an iconv() implementation. On such systems,
  30 you must install the libiconv library. This can be found at:
  31
  32  http://www.gnu.org/software/libiconv/
  33
  34 If your system has an iconv implementation but you want to use
  35 libiconv instead, you can pass the --with-libiconv option to
  36 configure. This forces libiconv to be used.
  37
  38 Note that if you have libiconv installed in your default include
  39 search path (for instance, in /usr/local/), but don't enable
  40 it, you will get an error while compiling GTK+ because the
  41 iconv.h that libiconv installs hides the system iconv.
  42
  43 The native iconv on Compaq Tru64 doesn't contain support for
  44 UTF-8, so you'll need to use GNU libiconv instead. (When
  45 using GNU libiconv for GTK+, you'll need to use GNU libiconv
  46 for GNU gettext as well.) This probably applies to related
  47 operating systems as well.
  48
  49 Finally, for message catalog handling, GTK+ requires an implementation
  50 of gettext(). If your system doesn't provide this functionality,
  51 you should use the libintl library from the GNU gettext package,
  52 available from:
  53
  54  http://www.gnu.org/software/gettext/
  55
  56 The Nitty-Gritty
  57 ================
  58
  59 The 'configure' script can be given a number of options to enable
  60 and disable various features. For a complete list, type:
  61
  62   ./configure --help
  63
  64 A few of the more important ones:
  65
  66 *  --prefix=PREFIX         install architecture-independent files in PREFIX
  67                            [ Defaults to /usr/local ]
  68
  69 *  --exec-prefix=EPREFIX   install architecture-dependent files in EPREFIX
  70                            [ Defaults to the value given to --prefix ]
  71
  72 *  --enable-gc-friendly    When enabled all memory freed by the application,
  73                            but retained by GLib for performance reasons
  74                            is set to zero, thus making deployed garbage
  75                            collection or memory profiling tools detect
  76                            unlinked memory correctly. This will make GLib
  77                            slightly slower.
  78                            [ Disabled by default ]
  79
  80 * --disable-threads        Do not compile GLib to be multi thread safe. GLib
  81                            will be slightly faster then. This is however not
  82                            recommended, as many programs rely on GLib being
  83                            multi thread safe.
  84                            [ Enabled by default ]
  85
  86 * --with-threads=[none/posix/dce/solaris/win32] Specify a thread
  87                            implementation to use.
  88                            * 'posix' and 'dce' can be used interchangeable
  89                              to mean the different versions of posix
  90                              threads. configure tries to find out, which
  91                              one is installed.
  92                            * 'solaris' uses the native Solaris thread
  93                              implementation.
  94                            * 'none' means that GLib will be thread safe,
  95                              but does not have a default thread
  96                              implementation. This has to be supplied to
  97                              g_thread_init() by the programmer.
  98                            [ Determined by configure by default ]
  99
 100 Options can be given to the compiler and linker by setting
 101 environment variables before running configure. A few of the more
 102 important ones:
 103
 104  CC       : The C compiler to use
 105  CPPFLAGS : Flags for the C preprocesser such as -I and -D
 106  CFLAGS   : C compiler flags
 107
 108 The most important use of this is to set the
 109 optimization/debugging flags. For instance, to compile with no
 110 debugging information at all, run configure as:
 111
 112  CFLAGS=-O2 ./configure           # Bourne compatible shells (sh/bash/zsh)
 113
 114 or,
 115
 116  setenv CFLAGS -O2 ; ./configure  # csh and variants
 117
 118
 119 Installation directories
 120 ========================
 121
 122 The location of the installed files is determined by the --prefix
 123 and --exec-prefix options given to configure. There are also more
 124 detailed flags to control individual directories. However, the
 125 use of these flags is not tested.
 126
 127 One particular detail to note, is that the architecture-dependent
 128 include file glibconfig.h is installed in:
 129
 130   $exec_prefix/lib/glib/include/
 131
 132 if you have a version in $prefix/include, this is out of date
 133 and should be deleted.
 134
 135 .pc files for the various libraries are installed in
 136 $exec_prefix/lib/pkgconfig to provide information when compiling
 137 other packages that depend on GTK+. If you set PKG_CONFIG_PATH
 138 so that it points to this directory, then you can get the
 139 correct include flags and library flags for compiling a GLib
 140 application with:
 141
 142  pkg-config --cflags glib-2.0
 143  pkg-config --libs glib-2.0
 144