Fix mispelling in help output. (#53952, Skip Montanaro)
[platform/upstream/glib.git] / INSTALL
1 Simple install procedure
2 ========================
3
4   % gzip -cd glib-1.3.5.tar.gz | tar xvf -  # unpack the sources
5   % cd glib-1.3.5                           # 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 In order to implement conversions between character sets,
17 GLib requires an implementation of the standard iconv() routine.
18 Most modern systems will have a suitable implementation, however
19 many older systems lack an iconv() implementation. On such systems, 
20 you must install the libiconv library. This can be found at:
21
22  http://clisp.cons.org/~haible/packages-libiconv.html
23
24 If your system has an iconv implementation but you want to use
25 libiconv instead, you can pass the --with-libiconv option to
26 configure. This forces libiconv to be used. 
27
28 Note that if you have libiconv installed in your default include
29 search path (for instance, in /usr/local/), but don't enable
30 it, you will get an error while compiling GTK+ because the
31 iconv.h that libiconv installs hides the system iconv.
32
33 The Nitty-Gritty
34 ================
35
36 The 'configure' script can be given a number of options to enable
37 and disable various features. For a complete list, type:
38
39   ./configure --help
40
41 A few of the more important ones:
42
43 *  --prefix=PREFIX         install architecture-independent files in PREFIX
44                            [ Defaults to /usr/local ]
45
46 *  --exec-prefix=EPREFIX   install architecture-dependent files in EPREFIX
47                            [ Defaults to the value given to --prefix ]
48
49 Options can be given to the compiler and linker by setting
50 environment variables before running configure. A few of the more
51 important ones:
52
53  CC       : The C compiler to use
54  CPPFLAGS : Flags for the C preprocesser such as -I and -D
55  CFLAGS   : C compiler flags
56
57 The most important use of this is to set the
58 optimization/debugging flags. For instance, to compile with no
59 debugging information at all, run configure as:
60
61  CFLAGS=-O2 ./configure           # Bourne compatible shells (sh/bash/zsh)
62
63 or,
64
65  setenv CFLAGS -O2 ; ./configure  # csh and variants
66
67
68 Installation directories
69 ========================
70
71 The location of the installed files is determined by the --prefix
72 and --exec-prefix options given to configure. There are also more
73 detailed flags to control individual directories. However, the
74 use of these flags is not tested.
75
76 One particular detail to note, is that the architecture-dependent
77 include file glibconfig.h is installed in:
78
79   $exec_pref/lib/glib/include/
80
81 if you have a version in $prefix/include, this is out of date
82 and should be deleted.
83
84 A shell script glib-config is created during the configure
85 process, and installed in the bin/ directory
86 ($exec_prefix/bin). This is used to determine the location of glib
87 when building applications.  If you move glib after installation,
88 it will be necessary to edit this file.
89