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