home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / emacs-19.28-src.tgz / tar.out / fsf / emacs / README < prev    next >
Text File  |  1996-09-28  |  4KB  |  82 lines
  1. This directory tree holds version 19.28 of GNU Emacs, the extensible,
  2. customizable, self-documenting real-time display editor.
  3.  
  4. Version 19.28 is quite stable; most users do not encounter any bugs.
  5. But if you do encounter bugs in this version, we encourage you to
  6. report them; your bug reports are valuable contributions to the FSF,
  7. since they allow us to notice and fix problems on machines we don't
  8. have, or in code we don't use often.  See the "Bugs" node of the info
  9. tree for more information on how to report bugs.
  10.  
  11. See the files `etc/NEWS' and `etc/news.texi' for information on new
  12. features and other user-visible changes since the last version of
  13. Emacs.
  14.  
  15. The file INSTALL in this directory says how to bring up GNU Emacs on
  16. Unix, once you have loaded the entire subtree of this directory.
  17.  
  18. Note that the Emacs installation procedure has changed since version
  19. 18; you will probably want to read the file INSTALL even if you have
  20. installed Emacs before.  The new procedure is intended to simplify
  21. Emacs installation, and make it easier to have several versions of
  22. Emacs for several architectures installed simultaneously.
  23.  
  24. The file PROBLEMS contains information on many common problems that
  25. occur in building, installing and running Emacs.
  26.  
  27. Reports of bugs in Emacs should be sent to the mailing list
  28. bug-gnu-emacs@prep.ai.mit.edu.  See the "Bugs" section of the Emacs
  29. manual for more information on how to report bugs.  (The file `BUGS'
  30. in this directory explains how you can find and read that section
  31. using the Info files that come with Emacs.)  See `etc/MAILINGLISTS'
  32. for more information on mailing lists relating to GNU products.
  33.  
  34. The `etc' subdirectory contains several other files, named in
  35. capital letters, which you should look at when installing GNU Emacs.
  36.  
  37. The file `configure' is a shell script to acclimate Emacs to the
  38. oddities of your processor and operating system.  It will create two
  39. files named `build-install' (a shell script) and `Makefile' (a script
  40. for the `make' program), which help automate the process of building
  41. and installing emacs.  See INSTALL for more detailed information.
  42.  
  43. The file `configure.in' is the input used by the autoconf program to
  44. construct the `configure' script.  Since Emacs has configuration
  45. requirements that autoconf can't meet, `configure.in' uses an unholy
  46. marriage of custom-baked configuration code and autoconf macros; it
  47. may be wise to avoid rebuilding `configure' from `configure.in' when
  48. possible.
  49.  
  50. The file `Makefile.in' is a template used by `configure' to create
  51. `Makefile'.
  52.  
  53. The file `make-dist' is a shell script to build a distribution tar
  54. file from the current Emacs tree, containing only those files
  55. appropriate for distribution.  If you make extensive changes to Emacs,
  56. this script will help you distribute your version to others.
  57.  
  58. There are several subdirectories:
  59.  
  60. `src' holds the C code for Emacs (the Emacs Lisp interpreter and its
  61.     primitives, the redisplay code, and some basic editing functions).
  62. `lisp' holds the Emacs Lisp code for Emacs (most everything else).
  63. `lib-src' holds the source code for some utility programs for use by
  64.     or with Emacs, like movemail and etags.
  65. `etc' holds miscellaneous architecture-independent data files
  66.     Emacs uses, like the tutorial text and the Zippy the Pinhead quote
  67.     database.  The contents of the `lisp', `info' and `man'
  68.     subdirectories are architecture-independent too.
  69.  
  70. `info' holds the Info documentation tree for Emacs.
  71. `man' holds the source code for the Emacs manual.
  72.  
  73. `msdos' holds configuration files for compiling Emacs under MSDOG.
  74.     See the file etc/MSDOS for more information.
  75. `cpp' holds a C preprocessor for use instead of the installed one when
  76.     the installed one fails to distinguish more than 8 characters in a
  77.     symbol name.
  78. `shortnames' holds programs and data files for creating files of
  79.     #define's used to convert long symbol names to distinct sort ones
  80.     for C compiles that cannot distinguish more than 8 characters.
  81. `vms' holds instructions and useful files for running Emacs under VMS.
  82.