]> code.delx.au - gnu-emacs/blobdiff - INSTALL
Add all rgb.txt color names to x-colors.
[gnu-emacs] / INSTALL
diff --git a/INSTALL b/INSTALL
index 372e703e0b514492d3bfbe739e3778101beb1393..35238fc21a4dcfd933e710f86f2b5d3cfdad3756 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,12 +1,15 @@
 GNU Emacs Installation Guide
 Copyright (C) 1992, 1994, 1996, 1997, 2000, 2001, 2002, 2003, 2004,
-2005, 2006, 2007, 2008  Free Software Foundation, Inc.
+  2005, 2006, 2007, 2008, 2009, 2010
+  Free Software Foundation, Inc.
 See the end of the file for license conditions.
 
 
 This file contains general information.  For more specific information
 for the Windows, GNUstep/Mac OS X, and MS-DOS ports, also see the files
-nt/INSTALL nextstep/INSTALL, and msdos/INSTALL.
+nt/INSTALL nextstep/INSTALL, and msdos/INSTALL.  For information
+specific to building from a Bazaar checkout (rather than a release), see
+the file INSTALL.BZR.
 
 
 BASIC INSTALLATION
@@ -97,6 +100,30 @@ that, so please refer to them if the simple procedure does not work.
 
 ADDITIONAL DISTRIBUTION FILES
 
+* Complex Text Layout support libraries
+
+Emacs needs the optional libraries "m17n-db", "libm17n-flt", "libotf"
+to correctly display such complex scripts as Indic and Khmer.
+On some systems, particularly GNU/Linux, these libraries may be
+already present or available as additional packages.  Note that if
+there is a separate `dev' or `devel' package, for use at compilation
+time rather than run time, you will need that as well as the
+corresponding run time package; typically the dev package will contain
+header files and a library archive.  Otherwise, you can download and
+build libraries from sources.
+
+The sources of these libraries are available by anonymous CVS from
+cvs.m17n.org.
+
+    % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n login
+    % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n co m17n-db
+    % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n co m17n-lib
+    % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n co libotf
+
+For m17n-lib, if you have problems with making the whole package
+because you lack some other packages on which m17n-lib depends, try to
+configure it with the option "--without-gui".
+
 * intlfonts-VERSION.tar.gz
 
 The intlfonts distribution contains X11 fonts in various encodings
@@ -153,30 +180,6 @@ these libraries won't work because some routines are missing, and
 configure should avoid such old versions.  If that happens, use the
 --without-LIB options to `configure'.  See below for more details.
 
-* Complex Text Layout support libraries
-
-Emacs needs the optional libraries "m17n-db", "libm17n-flt", "libotf"
-to correctly display such complex scripts as Indic and Khmer.
-On some systems, particularly GNU/Linux, these libraries may be
-already present or available as additional packages.  Note that if
-there is a separate `dev' or `devel' package, for use at compilation
-time rather than run time, you will need that as well as the
-corresponding run time package; typically the dev package will contain
-header files and a library archive.  Otherwise, you can download and
-build libraries from sources.
-
-The sources of these libraries are available by anonymous CVS from
-cvs.m17n.org.
-
-    % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n login
-    % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n co m17n-db
-    % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n co m17n-lib
-    % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n co libotf
-
-For m17n-lib, if you have problems with making the whole package
-because you lack some other packages on which m17n-lib depends, try to
-configure it with the option "--without-gui".
-
 * Extra fonts
 
 The Emacs distribution does not include fonts and does not install
@@ -209,9 +212,8 @@ BDF Unicode fonts etl-unicode.tar.gz are available from
 fonts can also be used by ps-print and ps-mule to print Unicode
 characters.
 
-Finally, the Web pages <URL:http://www.nongnu.org/freefont/index.html>
-and <URL:http://www.nongnu.org/freefont/resources.html> list a large
-number of free Unicode fonts.
+Finally, the Web page <URL:http://www.gnu.org/software/freefont/>
+lists a large number of free Unicode fonts.
 
 * GNU/Linux development packages
 
@@ -407,7 +409,7 @@ to look in `/bar/mylib' for libraries, pass the -O3 optimization
 switch to the compiler, and link against libfoo.a and libbar.a
 libraries in addition to the standard ones.
 
-For some libraries, like Gtk+, fontconfig and ALSA, `configure' use
+For some libraries, like Gtk+, fontconfig and ALSA, `configure' uses
 pkg-config to find where those libraries are installed.
 If you want pkg-config to look in special directories, you have to set
 the environment variable PKG_CONFIG_PATH to point to the directories
@@ -465,7 +467,7 @@ site-load.el for additional libraries if you arrange for their
 documentation strings to be in the etc/DOC file (see
 src/Makefile.in if you wish to figure out how to do that).  For all
 else, use site-init.el.  Do not load byte-compiled code which
-was build with a non-nil value of `byte-compile-dynamic'.
+was built with a non-nil value of `byte-compile-dynamic'.
 
 If you set load-path to a different value in site-init.el or
 site-load.el, Emacs will use *precisely* that value when it starts up
@@ -490,7 +492,7 @@ named `src/emacs'.  You can execute this file "in place" without
 copying it, if you wish; then it automatically uses the sibling
 directories ../lisp, ../lib-src, ../info.
 
-Or you can "install" the executable and the other Emacs into their
+Or you can "install" the executable and the other files into their
 installed locations, with `make install'.  By default, Emacs's files
 are installed in the following directories:
 
@@ -685,8 +687,8 @@ when running make in the subdirectories.
 
 CONFIGURATION BY HAND
 
-Instead of running the `configure' program, you have to perform the
-following steps.
+This should not be necessary and is not recommended.  Instead of
+running the `configure' program, you have to perform the following steps.
 
 1) Copy `./src/config.in' to `./src/config.h'.
 
@@ -700,22 +702,15 @@ the appropriate system and architecture description files.
 2) Edit `./src/config.h' to set the right options for your system.  If
 you need to override any of the definitions in the s/*.h and m/*.h
 files for your system and machine, do so by editing config.h, not by
-changing the s/*.h and m/*.h files.  Occasionally you may need to
-redefine parameters used in `./lib-src/movemail.c'.
-
-3) Create src/Makefile and lib-src/Makefile from the corresponding
-`Makefile.in' files.  First copy `Makefile.in' to `Makefile.c',
-then edit in appropriate substitutions for the @...@ constructs,
-and then copy the shell commands near the end of `configure'
-that run cpp to construct `Makefile'.
+changing the s/*.h and m/*.h files.
 
-4) Create `Makefile' files in various other directories
-from the corresponding `Makefile.in' files.  This isn't so hard,
-just a matter of substitution.
+3) Create `Makefile' files in various directories from the
+corresponding `Makefile.in' files.  This isn't so hard, just a matter
+of editing in appropriate substitutions for the @...@ constructs.
 
 The `configure' script is built from `configure.in' by the `autoconf'
-program.  You need version 2.51 or newer of `autoconf' to rebuild
-`configure'.
+program.  You need at least the version of autoconf specified in the
+AC_PREREQ(...) command to rebuild `configure' from `configure.in'.
 
 BUILDING GNU EMACS BY HAND
 
@@ -755,9 +750,8 @@ directory of the Emacs distribution.
 in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
 
 Strictly speaking, not all of the executables in `./lib-src' need be copied.
-- The programs `cvtmail', `fakemail', `hexl',
-    `movemail', `profile', `rcs2log', and `vcdiff' are used by Emacs;
-    they do need to be copied.
+- The programs `fakemail', `hexl', `movemail', `profile', `rcs2log',
+    and `vcdiff' are used by Emacs; they do need to be copied.
 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
     are intended to be run by users; they are handled below.
 - The programs `make-docfile' and `test-distrib' were