Update of /project/climacs/cvsroot/esa In directory clnet:/tmp/cvs-serv26407

Modified Files: esa.lisp Log Message: Added some docstrings for commands.

--- /project/climacs/cvsroot/esa/esa.lisp 2006/05/04 08:08:36 1.11 +++ /project/climacs/cvsroot/esa/esa.lisp 2006/05/04 18:32:38 1.12 @@ -471,6 +471,8 @@ (define-command-table global-esa-table)

(define-command (com-quit :name t :command-table global-esa-table) () + "Exit Climacs. +First ask if modified buffers should be saved. If you decide not to save a modified buffer, you will be asked to confirm your decision to exit." (frame-exit *application-frame*))

(set-key 'com-quit 'global-esa-table '((#\x :control) (#\c :control))) @@ -479,6 +481,7 @@ :name t :command-table global-esa-table) () + "Prompt for a command name and arguments, then run it." (let ((item (handler-case (accept `(command :command-table ,(find-applicable-command-table *application-frame*)) @@ -720,6 +723,7 @@ (define-command-table help-table)

(define-command (com-describe-key-briefly :name t :command-table help-table) () + "Prompt for a key and show the command it invokes." (display-message "Describe key briefly:") (redisplay-frame-panes *application-frame*) (describe-key-briefly (car (windows *application-frame*)))) @@ -727,6 +731,7 @@ (set-key 'com-describe-key-briefly 'help-table '((#\h :control) (#\c)))

(define-command (com-where-is :name t :command-table help-table) () + "Prompt for a command name and show the key that invokes it." (let* ((command-table (command-table (car (windows *application-frame*)))) (command (handler-case @@ -749,6 +754,8 @@

(define-command (com-describe-bindings :name t :command-table help-table) ((sort-by-keystrokes 'boolean :prompt "Sort by keystrokes?")) + "Pop up a help window showing which keys invoke which commands. +Without a numeric prefix, sorts the list by command name. With a numeric prefix, sorts by key." (let* ((window (car (windows *application-frame*))) (stream (open-window-stream :label (format nil "Help: Describe Bindings") @@ -774,6 +781,8 @@ :name t :command-table keyboard-macro-table) () + "Start recording keys to define a keyboard macro. +Use C-x ) to finish recording the macro, and C-x e to run it." (setf (recordingp *application-frame*) t) (setf (recorded-keys *application-frame*) '()))

@@ -783,6 +792,8 @@ :name t :command-table keyboard-macro-table) () + "Finish recording keys that define a keyboard macro. +Use C-x ( to start recording a macro, and C-x e to run it." (setf (recordingp *application-frame*) nil) (setf (recorded-keys *application-frame*) ;; this won't work if the command was invoked in any old way @@ -794,6 +805,8 @@ :name t :command-table keyboard-macro-table) () + "Run the last keyboard macro that was defined. +Use C-x ( to start and C-x ) to finish recording a keyboard macro." (setf (remaining-keys *application-frame*) (recorded-keys *application-frame*)) (setf (executingp *application-frame*) t))