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