Doc fixes

[~andy/gtk] / INSTALL

diff --git a/INSTALL b/INSTALL
index 28f37859a5b04f6603559b30f51dae25b629dd89..de23ce7a76084fd03fc81400c80b3c8878f4b4b1 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,18 +1,35 @@
 Prerequisites
 =============
 
-GTK+ requires the GLIB library, available at the same location as
-you got this package.
+GTK+ requires the following packages:
+
+ - The GLIB library, available at the same location as GTK+
+
+ - The Pango library, available from:
+
+      http://www.pango.org/download.shtml
+
+ - The TIFF, PNG, and JPEG image loading libraries. You most
+   likely have these installed on your system already. If not
+   these libraries are available from:
+
+    http://www.libtiff.org/
+    http://www.libpng.org/
+    ftp://ftp.uu.net/graphics/jpeg/
+
+   If these libraries are not available, the corresponding 
+   image loaders will simply not be built. However, this
+   may cause applications using GTK+ not to function properly.
 
 Simple install procedure
 ========================
 
-  % gzip -cd gtk+-1.1.9.tar.gz | tar xvf - # unpack the sources
-  % cd gtk+-1.1.9                          # change to the toplevel directory
-  % ./configure                            # run the `configure' script
-  % make                                   # build GTK
+  % gzip -cd gtk+-1.3.2.tar.gz | tar xvf - # unpack the sources
+  % cd gtk+-1.3.2                         # change to the toplevel directory
+  % ./configure                                   # run the `configure' script
+  % make                                  # build GTK
   [ Become root if necessary ]
-  % make install                           # install GTK
+  % make install                          # install GTK
 
 The Nitty-Gritty
 ================
@@ -43,6 +60,13 @@ which form of support to use:
 
 For more information, follow the link from http://www.gtk.org
 
+*  --disable-nls           do not use Native Language Support
+
+If this flag is not specified, GTK+ will try to find
+and use the gettext() set of functions to provide translations
+of the strings in the standard dialogs into the
+user's native language.
+
 *  --enable-xim            support XIM [default=yes]
 
 Specifying --disable-xim will disable support for entering
@@ -50,7 +74,7 @@ internationalized text using X Input Methods. This will give some
 slight savings in speed and memory use and might be necessary
 with older versions of X.
 
-*  --with-locale=LOCALE   locale name you want to use
+*  --with-locale=LOCALE    locale name you want to use
 
 The --with-locale options is used to determine if your operating
 system has support for the locale you will be using. If not, X's
@@ -84,19 +108,43 @@ or,
 
  setenv CFLAGS -O2 ; ./configure  # csh and variants
 
+Native-Language Support and gettext()
+=====================================
+
+To provide native-language support (NLS) GTK+ uses the
+gettext() set of functions. These functions are found
+in the C library on many systems, such as the Solaris
+C library and the GNU C Library, version 2.
+
+If your C library does not provide the necessary functionality,
+you may wish to install the GNU gettext package. You'll
+need version 0.10.35 or better. Version 0.10.35 is
+available from ftp://alpha.gnu.org/pub/gnu
+
+Generally, GTK+ will properly detect what is installed
+on your system and enable or disable NLS as appropriate.
+However, in rare cases, it may be necessary to disable
+NLS manually to get GTK+ to compile. You can do this
+by specifying the --disable-nls flag when configuring
+GTK+.
 
-Using an uninstalled copy of GLIB
-=================================
+Using an uninstalled copy of GLIB [ Unsupported ]
+=================================================
 
 You can compile GTK+ against a copy of GLIB that you have not
 yet installed. To do this, give the --with-glib=DIR options
 to ./configure. For instance:
 
- ./configure --with-glib=../glib-1.1.9
+ ./configure --with-glib=../glib-1.3.2
 
 This, however, will not work if you built GLIB with different
 source and build directories.
 
+It is recommended that you install GLIB before compiling
+GTK+. The --with-glib option is not regularly tested
+and may not function correctly. In addition, 
+inter-library dependencies won't be generated when
+using --with-glib=.
 
 Installation directories
 ========================
@@ -126,7 +174,7 @@ For complete details, see the file docs/gtk-config.txt
 Notes for using XIM support for Japanese input
 ==============================================
 
-* There is a bug in older versions of kinput2 that will cause GTK
+* There is a bug in older versions of kinput2 that will cause GTK+
 to hang when destroying a text entry. The latest versions of
 kinput is available from:
 
@@ -138,7 +186,7 @@ C library multibyte functions. Unless your C library has support
 for Japanese locales, this is incorrect, and will cause problems
 for GTK's internationalization.
 
-(In particular, this occurs with GNU libc 2.0 and 2.1, in which
+(In particular, this occurs with GNU libc 2.0 in which
 the multibyte functions always translate to and from UTF-8; but
 the problem may occur for other C libraries, and other operating
 systems as well.)