(g2-UU+5B73): Add `=decomposition@hanyo-denshi'.
[chise/xemacs-chise.git.1] / INSTALL
diff --git a/INSTALL b/INSTALL
index cab2f7b..9314b06 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,8 +1,6 @@
 XEmacs Installation Guide
 Copyright (c) 1994, 1995, 1996 Board of Trustees, University of Illinois
-Copyright (c) 1994 Free Software Foundation, Inc.
-
-Synched up with: FSF 19.30.
+Copyright (c) 1994-1999 Free Software Foundation, Inc.
 
    Permission is granted to anyone to make or distribute verbatim copies
    of this document as received, in any medium, provided that the
@@ -18,38 +16,52 @@ Synched up with: FSF 19.30.
    of the Free Software Foundation are approved by the Foundation.
 
 
-BUILDING AND INSTALLATION (Unix and Cygwin, see the file nt/README
-for instructions on building under Microsoft Windows):
-
-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
-   insufficient, you will get an error in the command `temacs -batch
-   -l loadup dump', found in `./src/Makefile.in.in', or possibly when
-   running the final dumped XEmacs.
-
-Building XEmacs requires about 41 Mb of disk space (including the
-XEmacs sources).  Once installed, XEmacs occupies about 16 Mb in the
-file system where it is installed; this includes the executable files,
-Lisp libraries, miscellaneous data files, and on-line documentation.
-The amount of storage of the Lisp directories may be reduced by
-compressing the .el files. If the building and installation take place
-in different directories, then the installation procedure temporarily
-requires 41+16 Mb.  Adjust this value upwards depending upon what
-additional Lisp support is installed.
-
-XEmacs requires an ANSI C compiler, such as GCC.  If you wish to build
-the documentation yourself, you will need at least version 1.68 of
-makeinfo (GNU texinfo-3.11).
-
-
-2) Decide on what other software packages you would like to use with
-XEmacs, but are not yet available on your system.  On some systems,
-Motif and CDE are optional additions.  On Solaris, the SUNWaudmo
-package enables native sound support.  There are also a number of free
-software packages that XEmacs can use.  If these are not yet available
-on your system, obtain, build and install those external packages
-before building XEmacs.  The packages XEmacs can use are:
+BUILDING AND INSTALLATION FOR UNIX AND CYGWIN
+
+(for Microsoft Windows, see nt/README also.)
+
+PREREQUISITES
+=============
+
+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. Note that a typical XEmacs build is
+much bigger. If the swapping space is insufficient, you will get an
+error in the command `temacs -batch -l loadup dump', found in
+`./src/Makefile.in.in', or possibly when running the final dumped
+XEmacs.
+
+Verify that your users have a high enough stack limit. On some systems
+such as OpenBSD and OSF/Tru64 the default is 2MB which is too low.  On
+MacOS/X (Darwin), it's 512kB.  See 'PROBLEMS' for details.
+
+Building XEmacs requires about 100 Mb of disk space (including the
+XEmacs sources).  Once installed, XEmacs occupies between 20 and 100 Mb
+in the file system where it is installed; this includes the executable files,
+Lisp libraries, miscellaneous data files, and on-line documentation. The
+exact amount depends greatly on the number of extra lisp packages that are
+installed 
+
+XEmacs requires an ANSI C compiler, such as GCC.  If you wish to build the
+documentation yourself, you will need at least version 1.68 of makeinfo (GNU
+texinfo-3.11).  GNU Texinfo 4.2 is recommended; it is necessary for building
+Lisp packages, and we may move to it for the core.
+
+ADD-ON LIBRARIES
+================
+
+Decide which libraries you would like to use with XEmacs, but are not
+yet available on your system.  On some systems, X11, Motif and CDE are
+optional additions.  On MacOS/X systems, you may download X11R6 for
+Mac OS X from http://www.apple.com/macosx/x11/download/.  You need
+both the runtime libraries and the SDK (in a sidebar of that page at
+the time of writing).  There is also a 3rd-party implementation of
+X11R6 for the Mac at http://www.xdarwin.org/.  On Solaris, the
+SUNWaudmo package enables native sound support.  There are also a
+number of free software applications that XEmacs can use.  If these
+are not yet available on your system, obtain, build and install those
+external libraries before building XEmacs.  The libraries XEmacs can
+use are:
 
    Xaw3d, XPM, JPEG, compface, PNG, zlib, GNU DBM, Berkeley DB, socks,
    term, NAS, Canna, Kinput2, SJ3, Wnn.
@@ -63,30 +75,33 @@ libraries are statically linked.
 
 Use the --site-includes and --site-libraries options when building
 XEmacs to allow configure to find the external software packages.
-If you link with dynamic (``.so'') external package libraries, which
-is not recommended, you will also need to add the library directories
-to the --site-runtime-libraries option.
-
-
-3) Decide what Initial Lisp you need with XEmacs.  XEmacs is
-distributed separately from most of its runtime environment.  This is
-done to make it easier for administrators to tune an installation for
-what the local users need.  See the file etc/PACKAGES for an overview
-of what is available and which packages need to be installed prior to
-building XEmacs.  At this point you only need a minimum to get started
-at which point you may install what you wish without further changes
-to the XEmacs binary.  A sample minimum configuration for a Linux
-system using Mule and Wnn6 from OMRON corporation would be the
-packages `mule-base' and `egg-its'.  By default, packages will be
-searched for in the path
-
-~/.xemacs::$prefix/lib/xemacs-${version}/mule-packages:$prefix/lib/xemacs/mule-packages:$prefix/lib/xemacs-${version}/xemacs-packages:$prefix/lib/xemacs/xemacs-packages
-
-This may be changed by specifying a different value with the
---package-path configuration option.
-
-4) In the top level directory of the XEmacs distribution, run the
-   program `configure' as follows:
+Note that for X11 includes, you should put the files in the X11
+subdirectory of the --site-includes directory.  Eg, XEmacs sources
+#include <X11/xpm.h>.  In that case, you should omit the trailing
+"/X11" from --site-includes, or the trailing "/includes/X11" from
+--site-prefixes.  The latter is convenient if your libraries are
+installed under "includes/../lib".  The directories specified with
+--site-includes or --site-libraries take precedence over those
+specified with --site-prefixes, and those take precedence over the
+standard search paths.
+
+If you link with dynamic (``.so'') external package libraries, you
+will also need to add the runtime library directories to the
+--site-runtime-libraries option.
+
+PACKAGE SYSTEM
+==============
+
+The file README.packages contain information vital to have a fully
+working XEmacs. This information was not included in this file only
+because it is too large for this terse INSTALL.  Please read
+README.packages now!
+
+CONFIGURATION OPTIONS
+=====================
+
+In the top level directory of the XEmacs distribution, run the
+program `configure' as follows:
 
     ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...
 
@@ -160,13 +175,9 @@ defaults to "-g -O" for gcc and "-g" for all other compilers.
 The `--dynamic' option specifies that configure should try to link
 emacs dynamically rather than statically.
 
-The `--const-is-losing' option is for use if you have trouble
-compiling due to the `const' storage class in C.  This is defined by
-default.  Most users should have no need to change this.
-
 You can build XEmacs for several different machine types from a single
 source directory.  To do this, you must use a version of `make' that
-supports the `VPATH' variable, such as GNU `make'.  Make separate
+supports the `VPATH' variable, such as GNU `make'.  Create separate
 build directories for the different configuration types, and in each
 one, run the XEmacs `configure' script.  `configure' looks for the
 Emacs source code in the directory that `configure' is in.
@@ -190,12 +201,17 @@ files, like executables and utility programs.  If specified,
   EXECDIR/lib/xemacs-VERSION/CONFIGURATION-NAME.
 EXECDIR/bin should be a directory that is normally in users' PATHs.
 
-For example, the command
-
-    ./configure mips-dec-ultrix --with-x11=yes
-
-configures XEmacs to build for a DECstation running Ultrix, with
-support for the X11 window system.
+If you specify --prefix (or any of the other installation directory
+options), they will get compiled into the xemacs executable so it will
+be able to find its various associated file.  However, XEmacs has
+quite elaborate logic to find out the locations of these directories
+dynamically.  Sometimes, it is desirable *not* to compile these
+directories into the executable so you can move the XEmacs
+installation around (as whole) at will.  This is true for binary kits,
+for instance.  Therefore, you can specify --without-prefix on the
+configure command line to prevent the installation prefix to become
+part of the generated executable; everything else will continue to
+work as usual.
 
 The `--with-menubars=TYPE' option allows you to specify which X
 toolkit you wish to use for the menubar.  The valid options are
@@ -205,18 +221,39 @@ Motif menubar. (In fact, the Motif menubar is currently broken.)  If
 `no' is specified then support for menubars will not be compiled in.
 
 The `--with-scrollbars=TYPE' option allows you to specify which X
-toolkit you wish to use for the scrollbars.  The valid options are
-`lucid', `motif', `athena', `athena3d', and `no'.  The default is
-`lucid' which is a Motif-lookalike scrollbar.  If `no' is specified
-then support for scrollbars will not be compiled in.
+toolkit you wish to use for the scrollbars.
 
 The `--with-dialogs=TYPE' option allows you to specify which X toolkit
-you wish to use for the dialog boxes.  The valid options are `athena',
-`athena3d', `motif, and `no.  The `lucid' option is accepted and will
-result in the `athena' toolkit being used.  If the Motif toolkit can be
-found the default is `motif'.  Otherwise, the default is `athena'.  If
-`no' is specified then support for dialog boxes will not be compiled
-in.
+you wish to use for the dialog boxes.
+
+The `--with-widgets=TYPE' option allows you to specify which X toolkit
+you wish to use for native widgets.
+
+    The valid options for TYPE in the `--with-scrollbars',
+    `--with-dialogs', and `--with-widgets' options are `lucid',
+    `motif', `athena', `msw', `gtk', and `no'.  The `gtk' and `msw'
+    options are only available on the GTK and MS Windows platforms,
+    respectively.  When available, `gtk' or `msw' and `no' are the
+    only options.  Otherwise, for dialogs and widgets, if the Motif
+    toolkit can be found the default is `motif'.  If not, the default
+    is `athena'.  `lucid' is an alias for `athena'.  If `no' is
+    specified then support for these GUI components will not be
+    compiled in.
+
+    For scrollbars, the default is `lucid' which is a Motif-lookalike
+    scrollbar.  Otherwise, if the Motif toolkit can be found the
+    default is `motif'.  If not, the default is `athena'.  If `no' is
+    specified then support for scrollbars will not be compiled in.
+
+    If `athena' (or `lucid', for dialogs and widgets) is specified for
+    any component (even by default), the type of Athena library must
+    be specified using the following option if more than one is
+    available.  It is not always possible to distinguish them, and
+    mixing and matching Athena libraries will result in crashes.
+
+The `--with-athena=TYPE' option specifies the kind of Athena library
+being used.  Valid values include `xaw', `3d', `xpm', `95', and `next'.
+There is no default.
 
 The `--with-toolbars' option allows you to enable or disable toolbar
 support.  The default is `yes' as long as support for a windowing
@@ -289,25 +326,26 @@ The `--rel-alloc' option can be used to either enable or disable use
 of the relocating allocator.  Turning on --rel-alloc will allow XEmacs
 to return unused memory to the operating system, thereby reducing its
 memory footprint.  However, it may make XEmacs runs more slowly,
-especially if your system's `mmap' implemntation is missing or
+especially if your system's `mmap' implementation is missing or
 inefficient.  Generally, it's best to go with the default
 configuration for your system.  You can tweak this based on how you
 use XEmacs, and the memory and cpu resources available on your system.
 
-The `--use-system-malloc' option can be use to either enable or
+The `--with-system-malloc' option can be use to either enable or
 disable use of the system malloc.  Generally, it's best to go with the
 default configuration for your system.  Note that on many systems
 using the system malloc disables the use of the relocating allocator.
 
-The `--use-debug-malloc' option can be used to link a special debugging
+The `--with-debug-malloc' option can be used to link a special debugging
 version of malloc.  Debug Malloc is not included with XEmacs, is
 intended for use only by the developers and may be obtained from
 <URL:http://www.letters.com/dmalloc/>.
 
-The `--debug' and `--error-checking' options are intended for use only
-by the developers.  `--debug' adds code to be compiled in for
-performing various tests.  `--error-checking' adds additional tests to
-many of the commonly used macros.
+The `--debug' and `--error-checking' options are primarily useful to the
+developers.  `--debug' incorporates code for performing various tests,
+but does not impose a speed penalty.  `--error-checking' adds additional
+tests to many of the commonly used macros, and imposes a speed penalty.
+Neither is especially useful in most common debugging situations.
 
 The `--verbose' and `--extra-verbose' options are intended for use
 only by the developers.  `--verbose' causes the results of all
@@ -317,10 +355,15 @@ determining configure failures is the file `config.log', which
 contains the results of the compile and link tests used by configure.
 
 The `--with-mule' option enables (MUlti-Lingual Emacs) support, needed
-to suport non-Latin-1 (including Asian) languages.  The Mule support
-is not yet as stable or efficient as the `Latin1' support.   Enabling
-Mule support requires the mule-base package installed prior to
-building XEmacs.  The following options require Mule support:
+to support non-Latin-1 (including Asian) languages.  Mule support is
+required for Asian language and Unicode (multibyte and wide character)
+support.  With the advent of the Euro and European Community
+expansion, Mule support is also recommended for Western Europeans.
+Enabling Mule support requires the mule-base package installed prior
+to building XEmacs.  The mule-ucs package is required for Unicode
+support (but may be added at any time).  For Europeans using Latin
+alphabets, and for support for the Euro symbol, the latin-unity
+package is recommended.  The following options require Mule support:
 
 The `--with-xim' option enables use of the X11 XIM mechanism to allow
 an input method to input text into XEmacs.  The input method is shared
@@ -367,24 +410,40 @@ Please note that it is safe to build with as many of the options
 `--with-xim', `--with-canna' and `--with-wnn' as your system
 supports.
 
+MAIL LOCKING
+============
+
+For most platforms, configure or the src/s file have the preferred
+method for locking mail spool files preconfigured.  Otherwise you must
+find out for youself.  Do not choose a locking protocol "on the
+objective merits."  XEmacs must use the same method as other mail
+utilities on your system, or you will lose mail.
+
+Presently, XEmacs supports lockf, flock, and dot locking.  Specify the
+locking method via the --mail-locking=METHOD option to configure.
+Valid values for METHOD are --mail-locking are `lockf', `flock', and
+`dot'.
+
+RUNNING CONFIGURE
+=================
+
 `configure' doesn't do any compilation or installation itself.  It
 just creates the files that influence those things: `./src/config.h',
 and all the Makefile's in the build tree.
 
-The `--with-pop', `--with-hesiod', and `--with-kerberos' options are used
-in conjunction with movemail.  As of XEmacs 20.1, movemail is identical
-to the one used in Emacs.
-
 When it is done, `configure' prints a description of what it did and
 creates a shell script `config.status' which, when run, recreates the
 same configuration.  If `configure' exits with an error after
 disturbing the status quo, it removes `config.status'.
 
-4) Look at `./lisp/paths.el'; if some of those values are not right
-for your system, set up the file `./lisp/site-init.el' with XEmacs
-Lisp code to override them; it is not a good idea to edit paths.el
-itself.  YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
-rather than `defvar', as used by `./lisp/paths.el'.  For example,
+AUXILIARY PATHS
+===============
+
+Look at `./lisp/paths.el'; if some of those values are not right for
+your system, set up the file `./lisp/site-init.el' with XEmacs Lisp
+code to override them; it is not a good idea to edit paths.el itself.
+YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES, rather than
+`defvar', as used by `./lisp/paths.el'.  For example,
 
      (setq news-inews-program "/usr/bin/inews")
 
@@ -396,28 +455,23 @@ variable gets by default!  Make sure you know what kind of value the
 variable should have.  If you don't pay attention to what you are
 doing, you'll make a mistake.
 
-Things may malfunction if the variable `directory-abbrev-alist' is not set
-up to translate "temporary" automounter mount points into the canonical
-form.  The default value of this variable contains the translation
+Things may malfunction if the variable `directory-abbrev-alist' is not
+set up to translate "temporary" automounter mount points into the
+canonical form.  XEmacs tries to detect how your automounter is
+configured.  If you have an unusual automounter configuration that
+XEmacs cannot detect, you may need to change the value of
+`directory-abbrev-alist'.
 
-       ("^/tmp_mnt/" . "/")
+SITE-SPECIFIC STARTUP CODE
+==========================
 
-meaning translate "/tmp_mnt/net/FOO" into "/net/FOO", which is appropriate
-for the default configuration of the Sun automounter, but which may be
-inappropriate for different vendor's automounters, or if you have customized
-your mount-point names.
-
-5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
-Lisp code you want XEmacs to load before it is dumped out.  Use
+Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs Lisp
+code you want XEmacs to load before it is dumped out.  Use
 site-load.el for additional libraries if you arrange for their
 documentation strings to be in the lib-src/DOC file (see
 src/Makefile.in.in if you wish to figure out how to do that).  For all
 else, use site-init.el.
 
-If you set load-path to a different value in site-init.el or
-site-load.el, XEmacs will use *precisely* that value when it starts up
-again.  If you do this, you are on your own!
-
 Note that, on some systems, the code you place in site-init.el must
 not use expand-file-name or any other function which may look
 something up in the system's password and user information database.
@@ -426,12 +480,18 @@ See `./PROBLEMS' for more details on which systems this affects.
 The `site-*.el' files are nonexistent in the distribution.  You do not
 need to create them if you have nothing to put in them.
 
-6) Refer to the file `./etc/TERMS' for information on fields you may
+TERMCAP CONFIGURATION
+=====================
+
+Refer to the file `./etc/TERMS' for information on fields you may
 wish to add to various termcap entries.  The files `./etc/termcap.ucb'
 and `./etc/termcap.dat' may already contain appropriately-modified
 entries.
 
-7) Run `make' in the top directory of the XEmacs distribution to finish
+RUNNING MAKE
+============
+
+Run `make' in the top directory of the XEmacs distribution to finish
 building XEmacs in the standard way.  The final executable file is
 named `src/emacs'.  You can execute this file "in place" without
 copying it, if you wish; then it automatically uses the sibling
@@ -444,7 +504,7 @@ are installed in the following directories:
 By default, XEmacs installs its files in the following directories:
 
 `/usr/local/bin' holds the executable programs users normally run -
-               `xemacs', `etags', `ctags', `b2m', `emacsclient',
+               `xemacs', `etags', `ctags', `b2m', `emacsclient', `ellcc',
                `gnuclient', `gnudoit', `gnuattach', and `rcs-checkin'.
 
 `/usr/local/lib/xemacs-VERSION/lisp' holds the Emacs Lisp libraries;
@@ -483,6 +543,17 @@ By default, XEmacs installs its files in the following directories:
                kinds of machines share the file system XEmacs is
                installed on.
 
+`/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME/modules' holds the Emacs
+               dynamically loadable modules.  These are special programs
+               typically written in C that can be loaded in much the same
+               way that Lisp packages are.  Not all systems support
+               dynamic modules, so do not be alarmed if this directory
+               does not exist or is empty.
+
+               XEmacs searches for modules in this directory, or any
+               sub-directory of it, and then in
+               `/usr/local/lib/xemacs/site-modules/*'.
+
 `/usr/local/lib/xemacs-VERSION/info' holds the on-line documentation
                for XEmacs, known as "info files".
 
@@ -492,27 +563,7 @@ By default, XEmacs installs its files in the following directories:
 If these directories are not what you want, you can specify where to
 install XEmacs's libraries and data files or where XEmacs should search
 for its lisp files by giving values for `make' variables as part of
-the command.  See the section below called `MAKE VARIABLES' for more
-information on this.
-
-Using GNU Make allows for simultaneous builds with and without the
---srcdir option.
-
-8) If your system uses lock files to interlock access to mailer inbox files,
-then you might need to make the movemail program setuid or setgid
-to enable it to write the lock files.  We believe this is safe.
-The setuid/setgid bits need not be set on any other XEmacs-related
-executables.
-
-9) You are done with the hard part!  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 XEmacs
-for a different configuration), type `make distclean'.
-
-10) You should now go to the XEmacs web page at http://www.xemacs.org/
-and decide what additional Lisp support you wish to have.
-
-MAKE VARIABLES
+the command.
 
 You can change where the build process installs XEmacs and its data
 files by specifying values for `make' variables as part of the `make'
@@ -623,6 +674,19 @@ GNU software; here are some variables specific to XEmacs.
        above), is `/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME'
        (where VERSION and CONFIGURATION-NAME are as described above).
 
+`docdir' indicates where to put Lisp documentation strings that XEmacs
+        refers to as it runs.  It defaults to the value of `archlibdir'
+        (see above).
+
+`moduledir' indicates where XEmacs installs and expects to find
+       any dynamic modules.  Its default value, based on
+       `archlibdir' (see above) is
+       `/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME/modules'
+       (where VERSION and CONFIGURATION-NAME are as described above).
+       By their very nature, dynamic loadable modules are architecture-
+       dependent, and care should be taken not to set this directory
+       to a system- or architecture-independent directory.
+
 Remember that you must specify any variable values you need each time
 you run `make' in the top directory.  If you run `make' once to build
 xemacs, test it, and then run `make' again to install the files, you
@@ -635,130 +699,47 @@ The top-level Makefile stores the variable settings it used in the
 Makefiles for the subdirectories, so you don't have to specify them
 when running make in the subdirectories.
 
+Using GNU Make allows for simultaneous builds with and without the
+--srcdir option.
 
-CONFIGURATION BY HAND
-
-Instead of running the `configure' program, you have to perform the
-following steps.
-
-1) Copy `./src/config.h.in' to `./src/config.h'.
-
-2) Consult `./etc/MACHINES' to see what configuration name you should
-use for your system.  Look at the code of the `configure' script to
-see which operating system and architecture description files from
-`src/s' and `src/m' should be used for that configuration name.  Edit
-`src/config.h', and change the two `#include' directives to include
-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) If you're going to use the make utility to build XEmacs, you will
-still need to run `configure' first, giving the appropriate values for
-the variables in the sections entitled "Things `configure' Might Edit"
-and "Where To Install Things."  Note that you may only need to change
-the variables `prefix' and `exec_prefix', since the rest of the
-variables have reasonable defaults based on them.  For each Makefile
-variable of this type, there is a corresponding configure option; for
-example, to change the location of the lock directory, you might use
-
-        ./configure --lockdir=/nfs/xemacslock
-
-The `configure' script is built from `configure.in' by the `autoconf'
-program.  However, since XEmacs has configuration requirements that
-autoconf can't meet, `configure.in' uses a marriage of custom-baked
-configuration code and autoconf macros.  New versions of autoconf
-could very well break this arrangement, so it may be wise to avoid
-rebuilding `configure' from `configure.in' when possible.
-
-
-BUILDING XEMACS BY HAND
-
-Once XEmacs is configured, running `make' in the top directory performs
-the following steps.
-
-1) Run `make src/paths.h' in the top directory.  This produces
-`./src/paths.h' from the template file `./src/paths.h.in', changing
-the paths to the values specified in `./Makefile'.
-
-2) Cd to `./lib-src' and run `make'.  This creates executables named
-`ctags' and `etags' and `wakeup' and `make-docfile' and `digest-doc'
-and `test-distrib'.  And others.
-
-3) Cd to `./src' and Run `make'.  This refers to files in the `./lisp'
-and `./lib-src' subdirectories using names `../lisp' and
-`../lib-src'.
-
-This creates a file `./src/xemacs' which is the runnable XEmacs,
-assigning it a new build version number by incrementing the build
-version stored in `./lisp/version.el'.
-
-It also creates a file in `./lib-src' whose name is `DOC' followed by
-the current XEmacs version.  This file contains documentation strings
-for all the functions in XEmacs.  Each time you run make to make a new
-xemacs, a new DOC file with a new name is made.  You must keep the DOC
-file for an XEmacs version as long as you keep using that XEmacs
-version.
-
-
-INSTALLATION BY HAND
-
-The steps below are done by running `make install' in the main
-directory of the XEmacs distribution.
-
-1) Copy `./lisp' and its subdirectories, `./etc', and the executables
-in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
+STRIPPING BINARIES
+==================
 
-Strictly speaking, not all of the executables in `./lib-src' need be copied.
-- The programs `cvtmail', `emacsserver', `env', `fakemail', `hexl',
-    `movemail', `timer', `vcdiff', `wakeup', and `yow' are used by
-    XEmacs; they do need to be copied.
-- The programs `etags', `ctags', `emacsclient', `b2m', `rcs2log',
-    `gnuclient', `gnudoit', and `gnuattach' are intended to be run
-    by users; they are handled below.
-- The programs `make-docfile' and `test-distrib' were
-    used in building XEmacs, and are not needed any more.
-- The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
-    a file for users to read.  There is no important reason to move them.
+This saves nothing but a small (by modern standards) amount of disk
+space; the symbol table is not loaded into memory at execution time.
+If you do encounter a crash or other serious bug, the first thing the
+developers will do is ask you to build an XEmacs with a full symbol
+table, anyway.  Don't strip the XEmacs binary.
 
-2) Copy the files in `./info' to the place specified in
-`./lisp/site-init.el' or `./lisp/paths.el'.  Note that if the
-destination directory already contains a file named `dir', you
-probably don't want to replace it with the `dir' file in the XEmacs
-distribution.  Instead, you should make sure that the existing `dir'
-file contains an appropriate menu entry for the XEmacs info.
+MAIL-LOCKING POST-INSTALLATION
+==============================
 
-3) Create a directory for XEmacs to use for clash detection, named as
-indicated by the PATH_LOCK macro in `./src/paths.h'.
+If your system uses dot-locking to interlock access to mailer inbox
+files, then you might need to make the movemail program setuid or
+setgid to enable it to write the lock files.  We believe this is safe.
+The setuid/setgid bits need not be set on any other XEmacs-related
+executables.
 
-4) Copy `./src/xemacs' to `/usr/local/bin', or to some other directory
-in users' search paths.  `./src/xemacs' has an alternate name
-`./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
-`/usr/local/bin/xemacs' pointing to that alternate name, as an easy way
-of installing different versions.
+CLEANING UP
+==========
 
-You can delete `./src/temacs'.
-
-5) Copy the programs `b2m', `emacsclient', `ctags', `etags', `rcs2log',
-`gnuclient', `gnudoit', and `gnuattach' from `./lib-src' to
-`/usr/local/bin'.  These programs are intended for users to run.
-
-6) Copy the man pages in `./etc' for xemacs, ctags, etags, and gnuserv
-into the appropriate man directories.
+You are done with the hard part!  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 XEmacs
+for a different configuration), type `make distclean'.
 
-7) The files in the `./src' subdirectory, except for `xemacs', are not
-used by XEmacs once it is built.  The source would be handy for
-debugging.
+READ README.packages
+====================
 
+Do it!
 
 PROBLEMS
+========
 
-See the file PROBLEMS in this directory for a list of various
-problems sometimes encountered, and what to do about them.
-
+The most likely problem is that you forgot to read and follow the
+directions in README.packages.  You can not have a working XEmacs
+without downloading some additional packages.
 
-If all else fails, please see etc/InstallGuide courtesy
-of Jonathan Seth Hayward.
+See the file PROBLEMS in this directory for a list of various problems
+sometimes encountered, and what to do about them.  PROBLEMS is also
+the place where platform-specific build notes can be found.