home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / msdos / winemacs / lisp / readme.lsp next >
Encoding:
Text File  |  1993-06-08  |  3.0 KB  |  87 lines
  1.  
  2. The subdirectories of this directory contain source code for the Emacs
  3. facilities written in Emacs Lisp.  *.el files are Elisp source, and *.elc
  4. files are byte-compiled versions of the corresponding *.el files.
  5. Byte-compiled files are architecture-independent.
  6.  
  7. When emacs starts up, it adds all subdirectories of this directory to the
  8. load-path (the list of directories to be searched when loading files.)  To
  9. speed up this process, this directory has been rearranged to have very few
  10. files at the top-level, so that emacs doesn't have to stat() several hundred
  11. files to find the dozen or so which are actually subdirectories.
  12.  
  13. Directories whose names begin with "-" or "." are not added to the default
  14. load-path.
  15.  
  16. The only files which remain at top-level are those which you might reasonably
  17. want to alter when installing or customizing emacs at your site.  The files
  18. at top level are:
  19.  
  20.     paths.el    You may need to change the default pathnames here.
  21.  
  22.     site-init.el    To pre-load additional libraries into emacs, load them
  23.             from this file.
  24.  
  25.     site-load.el    This is like site-init.el, but if you want the 
  26.             docstrings of your preloaded libraries to be kept in
  27.             the DOC file instead of in the executable, you should
  28.             load them from this file instead.  To do this, you must
  29.             also cause them to be scanned when the DOC file is
  30.             generated by editing ../src/ymakefile.
  31.  
  32.     version.el    This file is automatically altered when emacs is built.
  33.  
  34.  
  35. These are the main subdirectories:
  36.  
  37.     prim        Fundamental emacs functionality.  Some of this is
  38.             pre-dumped with emacs, some is autoloaded.
  39.  
  40.     utils        Various utility functions that some other emacs
  41.             packages build on.  These are not user commands.
  42.  
  43.     modes        Text-editing and programming-language-sensitive modes.
  44.  
  45.     emulators    Emacs can emulate a few different editors.  These are
  46.             a bit more than what `modes' generally are.
  47.  
  48.     term        Terminal-specific customization files.  When Emacs
  49.             starts, it checks the $TERM environment variable to
  50.             see what type of terminal the user is running on, and
  51.             loads a file named $TERM.el from this directory, if
  52.             that file exists.
  53.  
  54.     sunview        SunView-specific code.
  55.  
  56.     vms        VMS-specific code.
  57.  
  58.     x11        X Window System-specific code.
  59.  
  60.     packages    Random other utilities that are not primarily about
  61.             editing text.  For example, code for automatically
  62.             uncompressing .Z files would be here.  This is an
  63.             `everything else' sort of directory.
  64.  
  65. Some packages are fairly large; those have been given their own    directories:
  66.  
  67.     bytecomp    The emacs-lisp compiler.
  68.  
  69.     calendar    A calendar and appointment manager.
  70.  
  71.     comint        General code for interacting with inferior processes,
  72.             like shell buffers and lisp interpreters.
  73.  
  74.     dired        The directory editor.
  75.  
  76.     electric    The "electric" commands; these implement temporary
  77.             windows for help, list-buffers, etc.
  78.  
  79.     gnus        An NNTP-based newsreader; version 3.13.
  80.  
  81.     ilisp        A comint-based package for interacting with inferior
  82.             lisp processes.
  83.  
  84.     rmail        A BABYL-format mail reader.
  85.  
  86.     vm        View Mail, an UNIX-format alternative to RMAIL.
  87.