INSTALL.in

   1 Simple install procedure
   2 ========================
   3
   4   % gzip -cd glib-@GLIB_VERSION@.tar.gz | tar xvf -  # unpack the sources
   5   % cd glib-@GLIB_VERSION@                           # 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 If you are using the native iconv implementation on Solaris
  44 instead of libiconv, you'll need to make sure that you have
  45 the converters between locale encodings and UTF-8 installed.
  46 At a minimum you'll need the SUNWuiu8 package. You probably
  47 should also install the SUNWciu8, SUNWhiu8, SUNWjiu8, and
  48 SUNWkiu8 packages.
  49
  50 The native iconv on Compaq Tru64 doesn't contain support for
  51 UTF-8, so you'll need to use GNU libiconv instead. (When
  52 using GNU libiconv for GTK+, you'll need to use GNU libiconv
  53 for GNU gettext as well.) This probably applies to related
  54 operating systems as well.
  55
  56 Finally, for message catalog handling, GTK+ requires an implementation
  57 of gettext(). If your system doesn't provide this functionality,
  58 you should use the libintl library from the GNU gettext package,
  59 available from:
  60
  61  http://www.gnu.org/software/gettext/
  62
  63 The Nitty-Gritty
  64 ================
  65
  66 The 'configure' script can be given a number of options to enable
  67 and disable various features. For a complete list, type:
  68
  69   ./configure --help
  70
  71 A few of the more important ones:
  72
  73 *  --prefix=PREFIX         install architecture-independent files in PREFIX
  74                            [ Defaults to /usr/local ]
  75
  76 *  --exec-prefix=EPREFIX   install architecture-dependent files in EPREFIX
  77                            [ Defaults to the value given to --prefix ]
  78
  79 *  --enable-gc-friendly    When enabled all memory freed by the application,
  80                            but retained by GLib for performance reasons
  81                            is set to zero, thus making deployed garbage
  82                            collection or memory profiling tools detect
  83                            unlinked memory correctly. This will make GLib
  84                            slightly slower.
  85                            [ Disabled by default ]
  86
  87 * --disable-threads        Do not compile GLib to be multi thread safe. GLib
  88                            will be slightly faster then. This is however not
  89                            recommended, as many programs rely on GLib being
  90                            multi thread safe.
  91                            [ Enabled by default ]
  92
  93 * --with-threads=[none/posix/dce/solaris/win32] Specify a thread
  94                            implementation to use.
  95                            * 'posix' and 'dce' can be used interchangeable
  96                              to mean the different versions of posix
  97                              threads. configure tries to find out, which
  98                              one is installed.
  99                            * 'solaris' uses the native Solaris thread
 100                              implementation.
 101                            * 'none' means that GLib will be thread safe,
 102                              but does not have a default thread
 103                              implementation. This has to be supplied to
 104                              g_thread_init() by the programmer.
 105                            [ Determined by configure by default ]
 106
 107 Options can be given to the compiler and linker by setting
 108 environment variables before running configure. A few of the more
 109 important ones:
 110
 111  CC       : The C compiler to use
 112  CPPFLAGS : Flags for the C preprocesser such as -I and -D
 113  CFLAGS   : C compiler flags
 114
 115 The most important use of this is to set the
 116 optimization/debugging flags. For instance, to compile with no
 117 debugging information at all, run configure as:
 118
 119  CFLAGS=-O2 ./configure           # Bourne compatible shells (sh/bash/zsh)
 120
 121 or,
 122
 123  setenv CFLAGS -O2 ; ./configure  # csh and variants
 124
 125
 126 Installation directories
 127 ========================
 128
 129 The location of the installed files is determined by the --prefix
 130 and --exec-prefix options given to configure. There are also more
 131 detailed flags to control individual directories. However, the
 132 use of these flags is not tested.
 133
 134 One particular detail to note, is that the architecture-dependent
 135 include file glibconfig.h is installed in:
 136
 137   $exec_prefix/lib/glib/include/
 138
 139 if you have a version in $prefix/include, this is out of date
 140 and should be deleted.
 141
 142 .pc files for the various libraries are installed in
 143 $exec_prefix/lib/pkgconfig to provide information when compiling
 144 other packages that depend on GTK+. If you set PKG_CONFIG_PATH
 145 so that it points to this directory, then you can get the
 146 correct include flags and library flags for compiling a GLib
 147 application with:
 148
 149  pkg-config --cflags glib-2.0
 150  pkg-config --libs glib-2.0
 151