README

   1 This directory tree holds version 21.4 of XEmacs, the extensible,
   2 customizable, self-documenting real-time display editor.  This version
   3 of XEmacs also runs on various Microsoft Windows platforms including
   4 MS Windows '95 and MS Windows NT and Cygwin.
   5
   6 See the file `etc/NEWS' for information on new features and other
   7 user-visible changes since the last version of XEmacs.
   8
   9 The file `INSTALL' in this directory says how to bring up XEmacs on
  10 Unix and Cygwin, once you have loaded the entire subtree of this
  11 directory.
  12
  13 The file `PROBLEMS' contains information on many common problems that
  14 occur in building, installing and running XEmacs.
  15
  16 See the file `nt/README' for instructions on building XEmacs for
  17 Microsoft Windows.
  18
  19 The file 'README.packages' will guide you in the installation of
  20 (essential) add on packages.
  21
  22 Reports of bugs in XEmacs should be posted to the newsgroup
  23 comp.emacs.xemacs or sent to the mailing list xemacs@xemacs.org.  See
  24 the "Bugs" section of the XEmacs manual for more information on how to
  25 report bugs.  (The file `BUGS' in this directory explains how you can
  26 find and read that section using the Info files that come with
  27 XEmacs.)  See `etc/MAILINGLISTS' for more information on mailing lists
  28 relating to XEmacs and other GNU products.
  29
  30 The file `configure' is a shell script to acclimate XEmacs to the
  31 oddities of your processor and operating system.  It will create a
  32 file named `Makefile' (a script for the `make' program), which helps
  33 automate the process of building and installing emacs.  See INSTALL
  34 for more detailed information.
  35
  36 The file `configure.in' is the input used by the autoconf program to
  37 construct the `configure' script.  Since XEmacs has configuration
  38 requirements that autoconf can't meet, `configure.in' uses an unholy
  39 marriage of custom-baked configuration code and autoconf macros; it
  40 may be wise to avoid rebuilding `configure' from `configure.in' when
  41 possible.
  42
  43 The file `Makefile.in' is a template used by `configure' to create
  44 `Makefile'.
  45
  46 There are several subdirectories:
  47
  48 `src' holds the C code for Emacs (the XEmacs Lisp interpreter and its
  49     primitives, the redisplay code, and some basic editing functions).
  50 `lisp' holds the Emacs Lisp code for XEmacs (most everything else).
  51 `lib-src' holds the source code for some utility programs for use by
  52     or with XEmacs, like movemail and etags.
  53 `etc' holds miscellaneous architecture-independent data files
  54     XEmacs uses, like the tutorial text and the Zippy the Pinhead quote
  55     database.  The contents of the `lisp', `info' and `man'
  56     subdirectories are architecture-independent too.
  57 `lwlib' holds the C code for the toolkit objects used by XEmacs.
  58
  59 `info' holds the Info documentation tree for XEmacs.
  60 `man' holds the source code for the XEmacs info documentation tree.
  61
  62 `nt' holds configuration files for compiling XEmacs under Microsoft Windows
  63     NT.  The support for NT is very tentative right now.