building: Document C90 and POSIX requirements
[platform/upstream/glib.git] / INSTALL.in
1 Simple install procedure
2 ========================
3
4   % tar xf glib-@GLIB_VERSION@.tar.gz       # 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 requires a C90-compliant (but not necessarily C99-compliant) C
17 compiler and libc. On UNIX-like systems, it also assumes compliance
18 with at least the original 1990 version of POSIX.
19
20 GLib-2.0 requires pkg-config, which is tool for tracking the
21 compilation flags needed for libraries. (For each library, a small .pc
22 text file is installed in a standard location that contains the
23 compilation flags needed for that library along with version number
24 information.) Information about pkg-config can be found at:
25
26   http://www.freedesktop.org/software/pkgconfig/
27
28 GNU make (http://www.gnu.org/software/make) is also required.
29
30 In order to implement conversions between character sets,
31 GLib requires an implementation of the standard iconv() routine.
32 Most modern systems will have a suitable implementation, however
33 many older systems lack an iconv() implementation. On such systems,
34 you must install the libiconv library. This can be found at:
35
36  http://www.gnu.org/software/libiconv/
37
38 If your system has an iconv implementation but you want to use
39 libiconv instead, you can pass the --with-libiconv option to
40 configure. This forces libiconv to be used.
41
42 Note that if you have libiconv installed in your default include
43 search path (for instance, in /usr/local/), but don't enable
44 it, you will get an error while compiling GLib because the
45 iconv.h that libiconv installs hides the system iconv.
46
47 If you are using the native iconv implementation on Solaris
48 instead of libiconv, you'll need to make sure that you have
49 the converters between locale encodings and UTF-8 installed.
50 At a minimum you'll need the SUNWuiu8 package. You probably
51 should also install the SUNWciu8, SUNWhiu8, SUNWjiu8, and
52 SUNWkiu8 packages.
53
54 The native iconv on Compaq Tru64 doesn't contain support for
55 UTF-8, so you'll need to use GNU libiconv instead. (When
56 using GNU libiconv for GLib, you'll need to use GNU libiconv
57 for GNU gettext as well.) This probably applies to related
58 operating systems as well.
59
60 Finally, for message catalog handling, GLib requires an implementation
61 of gettext(). If your system doesn't provide this functionality,
62 you should use the libintl library from the GNU gettext package,
63 available from:
64
65  http://www.gnu.org/software/gettext/
66
67 Support for extended attributes and SELinux in GIO requires
68 libattr and libselinux.
69
70 Some of the mimetype-related functionality in GIO requires the
71 update-mime-database and update-desktop-database utilities, which
72 are part of shared-mime-info and desktop-file-utils, respectively.
73
74 GObject uses libffi to implement generic marshalling functionality.
75
76 The Nitty-Gritty
77 ================
78
79 Complete information about installing GLib can be found
80 in the file:
81
82  docs/reference/glib/html/glib-building.html
83
84 Or online at:
85
86  http://library.gnome.org/devel/glib/stable/glib-building.html
87
88
89 Installation directories
90 ========================
91
92 The location of the installed files is determined by the --prefix
93 and --exec-prefix options given to configure. There are also more
94 detailed flags to control individual directories. However, the
95 use of these flags is not tested.
96
97 One particular detail to note, is that the architecture-dependent
98 include file glibconfig.h is installed in:
99
100   $exec_prefix/lib/glib/include/
101
102 if you have a version in $prefix/include, this is out of date
103 and should be deleted.
104
105 .pc files for the various libraries are installed in
106 $exec_prefix/lib/pkgconfig to provide information when compiling
107 other packages that depend on GLib. If you set PKG_CONFIG_PATH
108 so that it points to this directory, then you can get the
109 correct include flags and library flags for compiling a GLib
110 application with:
111
112  pkg-config --cflags glib-2.0
113  pkg-config --libs glib-2.0
114
115
116 Cross-compiling GLib
117 ====================
118
119 Information about cross-compilation of GLib can be found
120 in the file:
121
122  docs/reference/glib/html/glib-cross-compiling.html
123
124 Or online at:
125
126  http://library.gnome.org/devel/glib/stable/glib-cross-compiling.html