Doc fix.
[bpt/emacs.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 75d7d32..bec3af5 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -52,34 +52,76 @@ each character set.
 The intlfonts distribution contains its own installation instructions,
 in the intlfonts/README file.
 
-* elisp-manual-EMACSVERSION-MANVERSION.tar.gz
+* elisp-manual-M.N.tar.gz
 
-This is the Emacs Lisp Reference for programmers, containing an
-in-depth discussion of Emacs Lisp and Emacs internals.  The
-distribution contains the Texinfo source files for the Reference
-Manual.  The Emacs Lisp Reference Manual is quite large.  It contains
-around 900 pages in smallbook format; the info files total almost two
-megabytes.  The package contains installation instructions of its own.
+This distribution contains the Emacs Lisp Reference Manual which
+complements the Emacs Lisp 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:
+
+     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 these may already be present or available as additional
+packages, particularly on GNU/Linux.  (In some cases older versions
+won't work because some routines are missing, and configure should
+avoid such old versions.)
+
+If necessary, you can build them from source.  None are vital for
+running Emacs.  Here's the list of these optional libraries, and the
+URLs where they can be found:
+
+  . libxpm for XPM:   ftp://ftp.x.org/contrib/libraries/
+  . 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/
+  . libtiff for TIFF: http://www.libtiff.org/
+  . libungif for GIF: 
+      http://prtr-13.ucsc.edu/~badger/software/libungif/index.shtml
+
+[libungif-4.1.0 can crash Emacs with uncompressed GIFs -- use
+libungif-4.1.0b1.]
+
+Emacs will configure itself to build with these libraries if configure
+finds them on your system unless you supply the appropriate
+--without-LIB option.  See below for more details.
 
 
 BUILDING AND INSTALLATION:
 
 (This is for a Unix or Unix-like system.  For MSDOS, see below; search
-for MSDOG.  For Windows NT or Windows 95, see the file nt/INSTALL.)
+for MSDOG.  For Windows NT or Windows 95, see the file nt/INSTALL.
+For the Mac, see the file mac/INSTALL.)
 
 1) Make sure your system has enough swapping space allocated to handle
-a program whose pure code is 900k bytes and whose data area is at
-least 400k and can reach 8Mb or more.  If the swapping space is
+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
 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 70 Mb of disk space (including the Emacs
-sources).  Once installed, Emacs occupies about 35 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 70+35 Mb.
+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+170 MB).
 
 2) Consult `./etc/MACHINES' to see what configuration name you should
 give to the `configure' program.  That file offers hints for
@@ -116,20 +158,35 @@ To get more attractive menus, you can specify an X toolkit when you
 configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
 TOOLKIT is `athena' or `motif' (`yes' and `lucid' are synonyms for
 `athena').  On some systems, it does not work to use a toolkit with
-shared libraries.
+shared libraries.  A free implementation of Motif, called LessTif, is
+available ftom <http://www.lesstif.org>.
 
 The `--with-gcc' option specifies that the build process should
 compile Emacs using GCC.  If you don't want to use GCC, specify
 `--with-gcc=no'.  If you omit this option, `configure' will search
 for GCC in your path, and use it if present.
 
-If you want the Emacs mail reader RMAIL to read mail from a POP
-server, you must specify `--with-pop'.  This provides support for the
-POP3 protocol; older versions are not supported.  For
-Kerberos-authenticated POP add `--with-kerberos', for Hesiod support
-add `--with-hesiod'.  These options enable Emacs to use POP; whether
-Emacs uses POP is controlled by individual users--see the Rmail
-chapter of the Emacs manual.
+The Emacs mail reader RMAIL is configured to be able to read mail from
+a POP3 server by default.  Versions of the POP protocol older than
+POP3 are not supported.  For Kerberos-authenticated POP add
+`--with-kerberos', for Hesiod support add `--with-hesiod'.  While POP3
+is always enabled, whether Emacs actually uses POP is controlled by
+individual users--see the Rmail chapter of the Emacs manual.
+
+For image support you may have to download, build, and install the
+appropriate image support libraries for image types other than XBM and
+PBM, see the list of URLs in "ADDITIONAL DISTRIBUTION FILES" above.
+(Note that PNG support requires libz in addition to libpng.)
+
+To disable individual types of image support in Emacs for some reason,
+even though configure finds the libraries, you can configure with one
+or more of these options:
+
+  --without-xpm        for XPM image support
+  --without-jpeg       for JPEG image support
+  --without-tiff       for TIFF image support
+  --without-gif        for GIF image support
+  --without-png        for PNG image support
 
 The `--prefix=PREFIXDIR' option specifies where the installation process
 should put emacs and its data files.  This defaults to `/usr/local'.
@@ -322,7 +379,11 @@ to enable it to write the lock files.  We believe this is safe.
 10) You are done!  You can remove executables and object files from
 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'.
+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/).
 
 
 
@@ -583,7 +644,7 @@ into problems during the build process.)
 It is important to understand that the runtime support of long file
 names by the Emacs binary is NOT affected by the LFN setting during
 compilation; Emacs compiled with DJGPP v2.0 or later will always
-support long file names on Windows 95 no matter what was the setting
+support long file names on Windows 9X no matter what was the setting
 of LFN at compile time.  However, if you compiled with LFN disabled
 and want to enable LFN support after Emacs was already built, you need
 to make sure that the support files in the lisp, etc and info
@@ -622,6 +683,16 @@ Emacs, chdir to that directory and type these commands:
     config msdos
     make install
 
+Running "config msdos" checks for several programs that are required
+to configure and build Emacs; if one of those programs is not found,
+CONFIG.BAT stops and prints an error message.  If you have DJGPP
+version 2.0 or 2.01, it will complain about a program called
+DJECHO.EXE.  These old versions of DJGPP shipped that program under
+the name ECHO.EXE, so you can simply copy ECHO.EXE to DJECHO.EXE and
+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).
+
 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
@@ -661,5 +732,5 @@ work.  Synchronous subprocesses do work.
 Version 2.0 of djgpp has two bugs that affect Emacs.  We've included
 corrected versions of two files from djgpp in the msdos subdirectory:
 is_exec.c and sigaction.c.  To work around the bugs, compile these
-files and link them into temacs.  Djgpp version 2.01 have these bugs
-fixed, so upgrade if you can before building Emacs.
+files and link them into temacs.  Djgpp versions 2.01 and later have
+these bugs fixed, so upgrade if you can before building Emacs.