home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / elisp / interfaces / Emacs-cl-shell / README < prev    next >
Encoding:
Text File  |  1991-04-04  |  4.4 KB  |  85 lines
  1. Below is a brief description of the files in this distribution.  See
  2. the file example.emacs to use this code.
  3.  
  4. cl-shell.el - provides a major mode (cl-shell-mode) for running Common
  5.   Lisp (CL) as an Emacs subprocess.  Features include direct (ie not
  6.   through a temp file) evaluation and in-package compilation of forms
  7.   from lisp-mode buffers, type-ahead and a history mechanism for the
  8.   cl-shell buffer, and pop-up help facilities for the CL functions
  9.   documentation, macroexpand and describe.  The extensions for Lucid
  10.   Common Lisp in the file cl-lucid.el provide pop-up arglists and
  11.   source file editing.  Other extensions are provided in cl-pcl.el and
  12.   cl-flavors.el which allow editing source files of methods.  The code
  13.   in cl-shell.el, however, is stand-alone and does not require any of
  14.   these.  Provides a general mechanism for communication between CL and
  15.   Emacs which does not rely on extra processes.
  16.      A more detailed description may be found in the file
  17.   cl-shell.doc and at the top of the file cl-shell.el.  To use the
  18.   code, you should either copy cl-shell, shell-history, cl-lucid,
  19.   cl-pcl, cl-clos and cl-flavors into your emacs/lisp source
  20.   directory, or add the directory containing these files to the Emacs 
  21.   variable load-path.  Then put these lines into your .emacs file:
  22.       (setq *cl-program* <pathname-of-your-lisp-program>)
  23.       (autoload 'run-cl "cl-shell" "" t)
  24.   and type the command "M-x run-cl".  You can then get a list of key 
  25.   bindings using "M-x describe-function cl-shell-mode".  To get proper
  26.   Common Lisp indentations, you should also put the following line
  27.   in your .emacs file:
  28.       (setq lisp-indent-hook 'common-lisp-indent-hook)
  29.  
  30. cl-lucid.el, cl-clos.el, cl-pcl.el, cl-flavors.el - these provide
  31.   extensions to the code in cl-shell.el.  They are all loaded
  32.   automatically when you type "M-x run-cl" if the corresponding
  33.   features are present in the CL world.  They allow the user to compile
  34.   methods directly (i.e. not through a temp file) and to find
  35.   source files of symbols with multiple definitions.
  36.  
  37. shell-history.el - a general command history mechanism for shell buffers.
  38.   This is loaded by cl-shell.el.  You can also use it for other shells.
  39.  
  40. source-file-extensions.lisp - This file is an extensions to Lucid CL
  41.   which records source-files for defvar, defparameter, defconstant,
  42.   deftype, and the definition constructs in FLAVORS or PCL.  It is
  43.   independent of the Emacs Lisp code described above, although it
  44.   enhances its usefulness.
  45.  
  46. cl-obvius.el - This is an extension for running OBVIUS (Object-Based
  47.   Vision and Image Understanding System), a Common Lisp program which
  48.   is also available via anonymous ftp from whitechapel.media.mit.edu
  49.  
  50. completion.el, always-complete.el, advise.el - completion.el was
  51.   written at Thinking Machines Corporation, and provides a very useful
  52.   typing completion system for Emacs.  Advise.el is an advice system
  53.   for Emacs Lisp, also written at Thinking Machines Corp.
  54.   Always-complete.el, which requires advise.el and loads completion.el, 
  55.   is an extension to completion.el written by Alan Ruttenberg at the MIT 
  56.   Media Lab.  It prints the completions in the minibuffer as you type, 
  57.   reminding you of their availability.  You can either load completion.el 
  58.   by itself, or load always-complete.el (which loads completion.el).
  59.  
  60. misc-extensions.el - A few useful miscellaneous extensions to emacs.  
  61.   Most useful are a mouse-click function which copies the s-expression
  62.   at the mouse to the point, and code to fill comments correctly in
  63.   lisp-mode.  This file does not set any key bindings -- it only defines
  64.   a set of functions, and gives a list of (commented out) recommended
  65.   key bindings.  This allows users to choose which of the extensions
  66.   to use, by putting the appropriate key bindings in their .emacs files.
  67.  
  68. The source code is available, subject to the usual Emacs disclaimers,
  69. as a compressed tar file via anonymous ftp:
  70.  
  71. whitechapel.media.mit.edu : pub/Emacs-cl-shell.tar.Z
  72.  
  73. Whitechapel's net address is 18.85.0.125.  After uncompressing the
  74. file, you can list its contents with "tar tvf Emacs-cl-shell.tar" and
  75. extract the files with "tar xvf Emacs-cl-shell.tar".
  76.  
  77. Send my your E-mail address if you want me to notify you of future 
  78. releases/bug fixes.  Comments and suggestions should be sent via
  79. E-mail to eero@media-lab.media.mit.edu.
  80.  
  81. Eero Simoncelli
  82. Vision Science Group
  83. MIT Media Laboratory, E15-385
  84. Cambridge, MA  02139
  85.