summaryrefslogtreecommitdiff
path: root/INSTALL.in
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL.in')
-rw-r--r--INSTALL.in89
1 files changed, 89 insertions, 0 deletions
diff --git a/INSTALL.in b/INSTALL.in
new file mode 100644
index 000000000..9a535fd5b
--- /dev/null
+++ b/INSTALL.in
@@ -0,0 +1,89 @@
+Simple install procedure
+========================
+
+ % gzip -cd glib-@GLIB_VERSION@.tar.gz | tar xvf - # unpack the sources
+ % cd glib-@GLIB_VERSION@ # change to the toplevel directory
+ % ./configure # run the `configure' script
+ % make # build GLIB
+
+ [ Become root if necessary ]
+ % rm -rf /install-prefix/include/glib.h /install-prefix/include/gmodule.h
+ % make install # install GLIB
+
+Requirements
+============
+
+In order to implement conversions between character sets,
+GLib requires an implementation of the standard iconv() routine.
+Most modern systems will have a suitable implementation, however
+many older systems lack an iconv() implementation. On such systems,
+you must install the libiconv library. This can be found at:
+
+ http://clisp.cons.org/~haible/packages-libiconv.html
+
+If your system has an iconv implementation but you want to use
+libiconv instead, you can pass the --with-libiconv option to
+configure. This forces libiconv to be used.
+
+Note that if you have libiconv installed in your default include
+search path (for instance, in /usr/local/), but don't enable
+it, you will get an error while compiling GTK+ because the
+iconv.h that libiconv installs hides the system iconv.
+
+The Nitty-Gritty
+================
+
+The 'configure' script can be given a number of options to enable
+and disable various features. For a complete list, type:
+
+ ./configure --help
+
+A few of the more important ones:
+
+* --prefix=PREFIX install architecture-independent files in PREFIX
+ [ Defaults to /usr/local ]
+
+* --exec-prefix=EPREFIX install architecture-dependent files in EPREFIX
+ [ Defaults to the value given to --prefix ]
+
+Options can be given to the compiler and linker by setting
+environment variables before running configure. A few of the more
+important ones:
+
+ CC : The C compiler to use
+ CPPFLAGS : Flags for the C preprocesser such as -I and -D
+ CFLAGS : C compiler flags
+
+The most important use of this is to set the
+optimization/debugging flags. For instance, to compile with no
+debugging information at all, run configure as:
+
+ CFLAGS=-O2 ./configure # Bourne compatible shells (sh/bash/zsh)
+
+or,
+
+ setenv CFLAGS -O2 ; ./configure # csh and variants
+
+
+Installation directories
+========================
+
+The location of the installed files is determined by the --prefix
+and --exec-prefix options given to configure. There are also more
+detailed flags to control individual directories. However, the
+use of these flags is not tested.
+
+One particular detail to note, is that the architecture-dependent
+include file glibconfig.h is installed in:
+
+ $exec_pref/lib/glib/include/
+
+if you have a version in $prefix/include, this is out of date
+and should be deleted.
+
+A shell script glib-config is created during the configure
+process, and installed in the bin/ directory
+($exec_prefix/bin). This is used to determine the location of glib
+when building applications. If you move glib after installation,
+it will be necessary to edit this file.
+