moved warning to error pragmas to their own file to not force 'good

[platform/upstream/glib.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 55b689f..72cfe96 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,13 +1,35 @@
 Simple install procedure
 ========================
 
-  % gzip -cd glib-1.1.12.tar.gz | tar xvf - # unpack the sources
-  % cd glib-1.1.12                          # change to the toplevel directory
+  % gzip -cd glib-1.3.12.tar.gz | tar xvf -  # unpack the sources
+  % cd glib-1.3.12                           # 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
 ================
 
@@ -24,6 +46,34 @@ A few of the more important ones:
 *  --exec-prefix=EPREFIX   install architecture-dependent files in EPREFIX
                            [ Defaults to the value given to --prefix ]
 
+*  --enable-gc-friendly    When enabled all memory freed by the application,
+                           but retained by GLib for performance reasons  
+                           is set to zero, thus making deployed garbage
+                           collection or memory profiling tools detect 
+                           unlinked memory correctly. This will make GLib 
+                           slightly slower.
+                           [ Disabled by default ]
+
+* --disable-threads        Do not compile GLib to be multi thread safe. GLib
+                           will be slightly faster then. This is however not
+                           recommended, as many programs rely on GLib being 
+                           multi thread safe.
+                           [ Enabled by default ]
+
+* --with-threads=[none/posix/dce/solaris/win32] Specify a thread 
+                           implementation to use. 
+                           * 'posix' and 'dce' can be used interchangeable 
+                             to mean the different versions of posix 
+                             threads. configure tries to find out, which 
+                             one is installed. 
+                           * 'solaris' uses the native Solaris thread
+                             implementation. 
+                           * 'none' means that GLib will be thread safe, 
+                             but does not have a default thread 
+                             implementation. This has to be supplied to 
+                             g_thread_init() by the programmer. 
+                           [ Determined by configure by default ]
+
 Options can be given to the compiler and linker by setting
 environment variables before running configure. A few of the more
 important ones: