Define a public documented type for the struct stat used by g_stat()
[platform/upstream/glib.git] / 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 GLib 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 GLib, 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, GLib 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
64 Support for extended attributes and SELinux in GIO requires
65 libattr and libselinux.
66
67 Some of the mimetype-related functionality in GIO requires the
68 update-mime-database and update-desktop-database utilities, which
69 are part of shared-mime-info and desktop-file-utils, respectively.
70
71
72 The Nitty-Gritty
73 ================
74
75 Complete information about installing GLib can be found
76 in the file:
77
78  docs/reference/glib/html/glib-building.html
79
80 Or online at:
81
82  http://developer.gnome.org/doc/API/2.0/glib/glib-building.html
83
84
85 Installation directories
86 ========================
87
88 The location of the installed files is determined by the --prefix
89 and --exec-prefix options given to configure. There are also more
90 detailed flags to control individual directories. However, the
91 use of these flags is not tested.
92
93 One particular detail to note, is that the architecture-dependent
94 include file glibconfig.h is installed in:
95
96   $exec_prefix/lib/glib/include/
97
98 if you have a version in $prefix/include, this is out of date
99 and should be deleted.
100
101 .pc files for the various libraries are installed in
102 $exec_prefix/lib/pkgconfig to provide information when compiling
103 other packages that depend on GLib. If you set PKG_CONFIG_PATH
104 so that it points to this directory, then you can get the
105 correct include flags and library flags for compiling a GLib
106 application with:
107
108  pkg-config --cflags glib-2.0
109  pkg-config --libs glib-2.0
110
111
112 Cross-compiling GLib
113 ====================
114
115 Information about cross-compilation of GLib can be found
116 in the file:
117
118  docs/reference/glib/html/glib-cross-compiling.html
119
120 Or online at:
121
122  http://library.gnome.org/devel/glib/stable/glib-cross-compiling.html