home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / elisp / interfaces / Emacs-cl-shell / cl-shell.doc < prev    next >
Encoding:
Text File  |  1991-03-19  |  3.2 KB  |  79 lines
  1. --------------------------------------------------------------------------
  2. The following is the documentation string for cl-shell-mode (view by
  3. typing "C-hf cl-shell-mode").  To start up a Common Lisp process in
  4. emacs, load the file cl-shell.el, and then execute "M-x run-cl".  See
  5. the file example.emacs for examples of how to set this up in your
  6. .emacs file.
  7. --------------------------------------------------------------------------
  8.  
  9. cl-shell-mode:
  10. Major mode for interacting with a Common Lisp process.  This mode
  11. should be entered using the command run-cl, which runs a Lisp 
  12. interpreter as a subprocess of Emacs, with Lisp I/O through a buffer
  13. named *lisp*.  Run-cl takes an optional argument which defaults to the
  14. value of the variable *cl-program*.  
  15. Variable *cl-pop-up* determines whether the *lisp* buffer pops up on
  16. output from the CL process.
  17. Variable *cl-echo-commands* determines whether commands being sent to
  18. Common Lisp are echoed in the *lisp* buffer. 
  19. Variable *cl-replacement-prompt* determines whether the CL prompts
  20. should be replaced. 
  21. Variables *cl-prompt* and *cl-error-prompt* should be customized for
  22. the specific implementation of Common Lisp.  The defaults are correct
  23. for Lucid.
  24.  
  25. Commands:
  26. Return at end of the *lisp* buffer sends line as input.
  27. Return not at end sends the top-level sexp starting at or before the
  28. cursor.  
  29. C-M-a goes to previous top-level form (as in lisp-mode buffers),
  30. and C-a respects the listener prompt. 
  31. The following commands are provided from within the *lisp* buffer:
  32. In general, the C-c C-<char> commands do not change the state of the 
  33. CL environment, and the C-c <char> do.
  34.  
  35. RET             cl-shell-send-input
  36. C-a             cl-beginning-of-line
  37. C-c             Prefix Command
  38. TAB             lisp-indent-line
  39. DEL             backward-delete-char-untabify
  40. ESC             Prefix Command
  41.  
  42. C-c .           cl-edit-definition
  43. C-c ,           cl-edit-next-definition (done in buffer package)
  44. C-c C-a         cl-arglist        (done in buffer package)
  45. C-c C-h         cl-describe        (done in buffer package)
  46. C-c C-m         cl-macroexpand-1    (done in buffer package)
  47. C-c C-d         cl-documentation    (done in buffer package)
  48. C-c C-q         cl-bury-help
  49.  
  50. C-c C-p         cl-set-buffer-package
  51. C-c C-c         cl-interrupt-process
  52.  
  53. C-c a           cl-abort
  54. C-c b           cl-backtrace
  55. C-c <num>       cl-send-digit (useful for debugging)
  56.  
  57. ESC n           shell-yank-matching-history-forward
  58. ESC p           shell-yank-matching-history
  59. ESC C-y         shell-yank-history
  60. ESC C-z         shell-yank-history-forward
  61. ESC C-q         indent-sexp
  62.  
  63. Most of the C-c commands are also provided in lisp-mode buffers.  In
  64. addition, the following bindings are added to lisp-mode buffers for
  65. sending things to the CL process:
  66.  
  67. C-c e           cl-eval-form
  68. C-c r           cl-eval-region
  69. C-c c           cl-compile-form  (done in buffer package)
  70. C-c l           cl-load-file
  71. C-c x           cl-compile-file
  72.  
  73. NOTE: Compilations are performed in the package of the lisp-mode buffer!
  74.  
  75. Entry to cl-shell-mode calls the functions shell-mode-hook, lisp-mode-hook
  76. and cl-shell-mode-hook with no arguments, if any of these are non-nil.
  77.  
  78. --------------------------------------------------------------------------
  79.