(Fstring_to_number, Fminus): Better English in doc strings.
[bpt/emacs.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index ae1c017..6b4278a 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,5 @@
 GNU Emacs Installation Guide
-Copyright (c) 1992, 1994, 1996, 1997, 2000 Free software Foundation, Inc.
+Copyright (c) 1992, 1994, 1996, 1997, 2000, 2001 Free software Foundation, Inc.
 See the end of the file for copying permissions.
 
 
@@ -21,21 +21,14 @@ maybe perform some of the steps manually.  The more detailed
 description in the rest of the sections of this guide will help you do
 that, so please refer to them if the simple procedure does not work.
 
-  1. If you want to be able to input international characters which
-     your keyboard doesn't support directly (i.e. you cannot type
-     them at the shell prompt), download the leim-M.N.tar.gz
-     distribution and unpack it into the same directory where you have
-     unpacked the main Emacs distribution.  See ADDITIONAL
-     DISTRIBUTION FILES, below, for more about this.
+  1. Make sure your system has at least 120 MB of free disk space.
 
-  2. Make sure your system has at least 120 MB of free disk space.
-
-  3a. `cd' to the directory where you unpacked Emacs and invoke the
+  2a. `cd' to the directory where you unpacked Emacs and invoke the
       `configure' script:
 
                 ./configure
 
-  3b. Alternatively, create a separate directory, outside the source
+  2b. Alternatively, create a separate directory, outside the source
       directory, where you want to build Emacs, and invoke `configure'
       from there:
 
@@ -44,7 +37,7 @@ that, so please refer to them if the simple procedure does not work.
       where SOURCE-DIR is the top-level Emacs source directory.  This
       may not work unless you use GNU make.
 
-  4. When `configure' finishes, it prints several lines of details
+  3. When `configure' finishes, it prints several lines of details
      about the system configuration.  Read those details carefully
      looking for anything suspicious, such as wrong CPU and operating
      system names, wrong places for headers or libraries, missing
@@ -62,24 +55,24 @@ that, so please refer to them if the simple procedure does not work.
      If the details printed by `configure' don't make any sense to
      you, assume that `configure' did its job and proceed.
 
-  5. If you need to run the `configure' script more than once (e.g.,
+  4. If you need to run the `configure' script more than once (e.g.,
      with some non-default options), always clean the source
      directories before running `configure' again:
 
                make distclean 
                ./configure
 
-  6. Invoke the `make' program:
+  5. Invoke the `make' program:
 
                 make
 
-  7. If `make' succeeds, it will build an executable program `emacs'
+  6. If `make' succeeds, it will build an executable program `emacs'
      in the `src' directory.  You can try this program, to make sure
      it works:
 
                 src/emacs -q
 
-  8. Assuming that the program `src/emacs' starts and displays its
+  7. Assuming that the program `src/emacs' starts and displays its
      opening screen, you can install the program and its auxiliary
      files into their installation directories:
 
@@ -98,26 +91,6 @@ that, so please refer to them if the simple procedure does not work.
 
 ADDITIONAL DISTRIBUTION FILES
 
-* leim-M.N.tar.gz
-
-The Emacs Lisp code for input methods for various international
-character scripts allows you to input characters in scripts which are
-not directly supported by your keyboard. It is distributed in a
-separate tar file because it amounts to a significant fraction of the
-size of the distribution.  This tar file is called leim-M.N.tar.gz,
-with the same version number as Emacs, and it unpacks into the
-directory emacs-M.N/leim.
-
-You should unpack leim-M.N.tar.gz into the same directory where you
-have previously unpacked the main Emacs distribution.  It fills in the
-contents of one subdirectory, which is present in the main Emacs
-distribution only in dummy form.
-
-Once you have unpacked the Leim tar file into the Emacs source tree,
-building and installing Emacs automatically installs the input method
-support as well.  If you have built Emacs without unpacking Leim
-first, just unpack Leim, build Emacs again, and install it again.
-
 * intlfonts-VERSION.tar.gz
 
 The intlfonts distribution contains X11 fonts that Emacs needs in
@@ -136,41 +109,20 @@ each character set.
 The intlfonts distribution contains its own installation instructions,
 in the intlfonts/README file.
 
-* elisp-manual-M.N.tar.gz
-
-This distribution contains the Emacs Lisp Reference Manual which
-complements the Emacs Manual.  (The Emacs Manual is accessible from
-within the editor by typing "C-h i", then selecting the "Emacs" item
-from the menu, or by clicking "Help" in the menu bar and selecting
-"Read Emacs Manual".)  It is a good idea to install the Emacs Lisp
-Reference Manual after installing Emacs, to complete the on-line
-documentation of Emacs in Info.
-
-If you have installed Texinfo, you can install the Emacs Lisp
-Reference Manual this way (after unpacking the elisp-manual-M.N.tar.gz
-file):
-
-     cd elisp-manual-M.N
-     ./configure --prefix=PREFIXDIR
-     make install
-
-Otherwise, you can install it manually.  Just copy the files elisp and
-elisp-* from the elisp-manual-M.N directory to your site's info
-directory (see the description of `infodir', below), and make sure
-that file `dir' in this directory contains an entry like this:
-
-    * Elisp: (elisp).  The Emacs Lisp Reference Manual.
-
 * Image support libraries
 
 Emacs needs optional libraries to be able to display images (with the
 exception of PBM and XBM images whose support is built-in).
 
 On some systems, particularly on GNU/Linux, these libraries may
-already be present or available as additional packages.  If not, you
-can download and build them from sources.  None of them are vital for
-running Emacs; however, note that Emacs will not be able to use color
-icons in the toolbar if the XPM support is not available.
+already be 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.  None of them are vital for
+running Emacs; however, note that Emacs will not be able to use
+colored icons in the toolbar if XPM support is not compiled in.
 
 Here's the list of these optional libraries, and the URLs where they
 can be found:
@@ -178,6 +130,8 @@ can be found:
   . libXaw3d for fancy 3D-style 
       scroll bars:    ftp://ftp.x.org/contrib/widgets/Xaw3d/
   . libxpm for XPM:   ftp://ftp.x.org/contrib/libraries/
+                     Get version 3.4k or later, which lets Emacs 
+                     use its own color allocation functions.
   . libpng for PNG:   ftp://www.libpng.org/pub/png/
   . libz (for PNG):   http://www.info-zip.org/pub/infozip/zlib/
   . libjpeg for JPEG: ftp://ftp.uu.net/graphics/jpeg/
@@ -200,7 +154,8 @@ configure should avoid such old versions.  If that happens, use the
 
 To take proper advantage of Emacs 21's mule-unicode charsets, you need
 a Unicode font.  For information on Unicode fonts for X, see
-<URL:http://czyborra.com/unifont/> and
+<URL:http://czyborra.com/unifont/>,
+<URL:http://openlab.ring.gr.jp/efont/> and
 <URL:http://www.cl.cam.ac.uk/%7Emgk25/ucs-fonts.html>.
 <URL:http://czyborra.com/charsets/> has basic fonts for Emacs's
 ISO-8859 charsets.
@@ -210,6 +165,53 @@ contains font support for most, if not all, of the charsets that Emacs
 supports.  The font files should be usable separately with older X
 releases.
 
+BDF fonts etl-unicode.tar.gz used by ps-print and ps-mule to print
+Unicode characters are available from <URL:ftp://ftp.x.org/contrib/fonts/>
+and <URL:ftp://ftp.xfree86.org/pub/X.Org/contrib/fonts/>.
+
+
+The new Indian implementation uses the ISFOC standard fonts.  We use
+CDAC ISFOC fonts to display the Devanagari script in Emacs.  They are
+copyrighted, but we received permission to use them in Emacs from the
+font developers.  These fonts can be obtained from the internet, or
+may be found in C-DAC products (including downloadable ones).  For
+examle, you can search the CDAC Devanagari font `dvsr0ntt.ttf' by
+using some search engines and they will guide you to appropriate URLs
+to obtain them.
+
+After you've downloaded the fonts, then run the following Makefile
+to create the appropriate BDF/PCF fonts.  (You will need `ttf2bdf',
+equipped with freetype 1, to create BDF file.)
+
+TTFS=  asdr0ntt.ttf:Assamese\
+       bndr0ntt.ttf:Bengali\
+       dvsr0ntt.ttf:Devanagari\
+       gjav0ntt.ttf:Gujarati\
+       knum0ntt.ttf:Kannada\
+       mlkr0ntt.ttf:Malayalam\
+       orsr0ntt.ttf:Oriya\
+       pnam0ntt.ttf:Punjabi\
+       sdsr0ntt.ttf:Sanskrit\
+       tlhm0ntt.ttf:Telugu\
+       tmvl0ntt.ttf:Tamil
+
+all:
+       for f in ${TTFS}; do \
+         ttf=`echo $$f | sed 's/:.*$$//'`; \
+         reg=`echo $$f | sed 's/[^:]*://'`; \
+         base=`basename $$ttf .ttf`; \
+         echo Converting "$$ttf to $$base-XX.bdf/pcf with registry $$reg"; \
+         for i in 16 24; do \
+           ttf2bdf -p $${i} -r 100 -l 0_255 $$ttf > temp; \
+           sed "/^FONT /s/ISO10646-1/$$reg-CDAC/" <temp >$$base-$$i.bdf; \
+           bdftopcf $$base-$$i.bdf > $$base-$$i.pcf; \
+         done; \
+       done
+       rm -f temp
+
+clean:
+       rm -f *.pcf *.bdf
+
 
 DETAILED BUILDING AND INSTALLATION:
 
@@ -220,18 +222,17 @@ mac/INSTALL.)
 
 1) Make sure your system has enough swapping space allocated to handle
 a program whose pure code is 1.5 MB and whose data area is at
-least 2.5 MB and can reach 80 MB or more.  If the swapping space is
+least 2.8 MB and can reach 100 MB or more.  If the swapping space is
 insufficient, you will get an error in the command `temacs -batch -l
 loadup dump', found in `./src/Makefile.in', or possibly when
 running the final dumped Emacs.
  
-Building Emacs requires about 95 MB of disk space (including the Emacs
-sources), or 130 MB if Leim is used.  Once installed, Emacs occupies
-about 60 MB (70 MB with Leim) in the file system where it is
-installed; this includes the executable files, Lisp libraries,
-miscellaneous data files, and on-line documentation.  If the building
-and installation take place in different directories, then the
-installation procedure momentarily requires 95+60 MB (130+70 MB).
+Building Emacs requires about 140 MB of disk space (including the
+Emacs sources) Once installed, Emacs occupies about 77 MB in the file
+system where it is installed; this includes the executable files, Lisp
+libraries, miscellaneous data files, and on-line documentation.  If
+the building and installation take place in different directories,
+then the installation procedure momentarily requires 140+77 MB.
 
 2) Consult `./etc/MACHINES' to see what configuration name you should
 give to the `configure' program.  That file offers hints for
@@ -309,7 +310,7 @@ or more of these options:
 Use --without-toolkit-scroll-bars to disable LessTif/Motif or Xaw3d
 scroll bars.  --without-xim disables the use of X Input Methods, and
 --disable-largefile omits support for files larger than 2GB on systems
-which support that.
+which support that.  Use --without-sound to disable sound support.
 
 The `--prefix=PREFIXDIR' option specifies where the installation process
 should put emacs and its data files.  This defaults to `/usr/local'.
@@ -535,9 +536,8 @@ the build directory by typing `make clean'.  To also remove the files
 that `configure' created (so you can compile Emacs for a different
 configuration), type `make distclean'.  If you don't need some, or all
 of the input methods from the Leim package, you can remove the
-unneeded files in the leim/quail, leim/skk, and leim/skk-dic
-subdirectories of your site's lisp directory (usually
-/usr/local/share/emacs/VERSION/).
+unneeded files in the leim subdirectories of your site's lisp
+directory (usually /usr/local/share/emacs/VERSION/).
 
 
 
@@ -680,7 +680,8 @@ from the corresponding `Makefile.in' files.  This isn't so hard,
 just a matter of substitution.
 
 The `configure' script is built from `configure.in' by the `autoconf'
-program.  You need version 2.0 or newer of `autoconf' to rebuild `configure'.
+program.  You need version 2.51 or newer of `autoconf' to rebuild
+`configure'.
 
 BUILDING GNU EMACS BY HAND
 
@@ -720,7 +721,7 @@ 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', `emacsserver', `fakemail', `hexl',
+- The programs `cvtmail', `fakemail', `hexl',
     `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
     and `yow' are used by Emacs; they do need to be copied.
 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
@@ -773,6 +774,14 @@ the necessary utilities; search for "MS-DOS".  The configuration step
 (see below) will test for these utilities and will refuse to continue
 if any of them isn't found.
 
+Recompiling Lisp files in the `lisp' subdirectory using the various
+targets in the lisp/Makefile file requires additional utilities:
+`find' and `xargs' (from Findutils), `touch' (from Fileutils) GNU
+`echo' and `test' (from Sh-utils), `tr, `sort', and `uniq' (from
+Textutils), and a port of Bash.  However, you should not normally need
+to run lisp/Makefile, as all the Lisp files are distributed in
+byte-compiled form as well.
+
 If you are building the MSDOG version of Emacs on an MSDOG-like system
 which supports long file names (e.g. Windows 95), you need to make
 sure that long file names are handled consistently both when you
@@ -814,14 +823,6 @@ To unpack Emacs with djtar, type this command:
 (This assumes that the Emacs distribution is called `emacs.tgz' on
 your system.)
 
-If you need to type international characters, you will need to unpack
-the Leim distribution (see the description near the beginning of this
-file).  You unpack it from the same directory where you unpacked
-Emacs.  To unpack Leim with djtar, assuming the Leim distribution is
-called `leim.tgz', type this command:
-
-    djtar -x leim.tgz
-
 If you want to print international characters, install the intlfonts
 distribution.  For this, create a directory called `fonts' under the
 Emacs top-level directory (usually called `emacs-XX.YY') created by
@@ -847,6 +848,13 @@ rerun CONFIG.BAT.  If you have neither ECHO.EXE nor DJECHO.EXE, you
 should be able to find them in your djdevNNN.zip archive (where NNN is
 the DJGPP version number).
 
+On Windows NT or Windows 2000, running "config msdos" might print an
+error message like "VDM has been already loaded".  This is because
+those systems have a program called `redir.exe' which is incompatible
+with a program by the same name supplied with DJGPP, which is used by
+config.bat.  To resolve this, move the DJGPP's `bin' subdirectory to
+the front of your PATH environment variable.
+
 To install the international fonts, chdir to the intlfonts-X.Y
 directory created when you unpacked the intlfonts distribution (X.Y is
 the version number of the fonts' distribution), and type the following
@@ -866,11 +874,10 @@ sibling directory called bin.  For example, if you build in directory
 /emacs/lib-src to the directory /emacs/bin, so you can then delete the
 subdirectories /emacs/src and /emacs/lib-src if you wish.  The only
 subdirectories you need to keep are bin, lisp, etc and info.  (If you
-installed Leim, keep the leim subdirectory, and if you installed
-intlfonts, keep the fonts directory and all its subdirectories as well.)
-The bin subdirectory should be added to your PATH.  The msdos
-subdirectory includes a PIF and an icon file for Emacs which you might
-find useful if you run Emacs under MS Windows.
+installed intlfonts, keep the fonts directory and all its
+subdirectories as well.)  The bin subdirectory should be added to your
+PATH.  The msdos subdirectory includes a PIF and an icon file for
+Emacs which you might find useful if you run Emacs under MS Windows.
 
 Emacs on MSDOS finds the lisp, etc and info directories by looking in
 ../lisp, ../etc and ../info, starting from the directory where the