esh-module doc fixes.

[gnu-emacs] / lisp / eshell / em-smart.el

diff --git a/lisp/eshell/em-smart.el b/lisp/eshell/em-smart.el
index a9f2cb70ef23041c24ba638c64559bdb7ba79095..2c54930e4395f9de7152fd1e9142e33432bdd23d 100644 (file)
--- a/lisp/eshell/em-smart.el
+++ b/lisp/eshell/em-smart.el
@@ -1,16 +1,15 @@
 ;;; em-smart.el --- smart display of output
 
 ;;; em-smart.el --- smart display of output
 

-;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
-;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; Copyright (C) 1999-2011  Free Software Foundation, Inc.

 
 ;; Author: John Wiegley <johnw@gnu.org>
 
 ;; This file is part of GNU Emacs.
 
 
 ;; Author: John Wiegley <johnw@gnu.org>
 
 ;; This file is part of GNU Emacs.
 

-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify

 ;; it under the terms of the GNU General Public License as published by
 ;; it under the terms of the GNU General Public License as published by

-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.

 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of


@@ -18,9 +17,7 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License

-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

 
 ;;; Commentary:
 
 
 ;;; Commentary:
 


@@ -73,7 +70,8 @@
 
 (eval-when-compile (require 'eshell))
 
 
 (eval-when-compile (require 'eshell))
 

-(defgroup eshell-smart nil
+;;;###autoload
+(eshell-defgroup eshell-smart nil

   "This module combines the facility of normal, modern shells with
 some of the edit/review concepts inherent in the design of Plan 9's
 9term.  See the docs for more details.
   "This module combines the facility of normal, modern shells with
 some of the edit/review concepts inherent in the design of Plan 9's
 9term.  See the docs for more details.


@@ -87,7 +85,7 @@ it to get a real sense of how it works."
 ;;; User Variables:
 
 (defcustom eshell-smart-load-hook '(eshell-smart-initialize)
 ;;; User Variables:
 
 (defcustom eshell-smart-load-hook '(eshell-smart-initialize)

-  "*A list of functions to call when loading `eshell-smart'."
+  "A list of functions to call when loading `eshell-smart'."

   :type 'hook
   :group 'eshell-smart)
 
   :type 'hook
   :group 'eshell-smart)
 


@@ -97,12 +95,12 @@ it to get a real sense of how it works."
     (lambda ()
       (remove-hook 'window-configuration-change-hook
                   'eshell-refresh-windows))))
     (lambda ()
       (remove-hook 'window-configuration-change-hook
                   'eshell-refresh-windows))))

-  "*A hook that gets run when `eshell-smart' is unloaded."
+  "A hook that gets run when `eshell-smart' is unloaded."

   :type 'hook
   :group 'eshell-smart)
 
 (defcustom eshell-review-quick-commands nil
   :type 'hook
   :group 'eshell-smart)
 
 (defcustom eshell-review-quick-commands nil

-  "*If t, always review commands.
+  "If t, always review commands.

 Reviewing means keeping point on the text of the command that was just
 invoked, to allow corrections to be made easily.
 
 Reviewing means keeping point on the text of the command that was just
 invoked, to allow corrections to be made easily.
 


@@ -110,8 +108,8 @@ If set to nil, quick commands won't be reviewed.  A quick command is a
 command that produces no output, and exits successfully.
 
 If set to `not-even-short-output', then the definition of \"quick
 command that produces no output, and exits successfully.
 
 If set to `not-even-short-output', then the definition of \"quick

-command\" is extended to include commands that produce output, iff
-that output can be presented in its entirely in the Eshell window."
+command\" is extended to include commands that produce output, if and
+only if that output can be presented in its entirely in the Eshell window."

   :type '(choice (const :tag "No" nil)
                 (const :tag "Yes" t)
                 (const :tag "Not even short output"
   :type '(choice (const :tag "No" nil)
                 (const :tag "Yes" t)
                 (const :tag "Not even short output"


@@ -125,12 +123,12 @@ that output can be presented in its entirely in the Eshell window."
     yank-pop
     yank-rectangle
     yank)
     yank-pop
     yank-rectangle
     yank)

-  "*A list of commands which cause Eshell to jump to the end of buffer."
+  "A list of commands which cause Eshell to jump to the end of buffer."

   :type '(repeat function)
   :group 'eshell-smart)
 
 (defcustom eshell-smart-space-goes-to-end t
   :type '(repeat function)
   :group 'eshell-smart)
 
 (defcustom eshell-smart-space-goes-to-end t

-  "*If non-nil, space will go to end of buffer when point-max is visible.
+  "If non-nil, space will go to end of buffer when point-max is visible.

 That is, if a command is running and the user presses SPACE at a time
 when the end of the buffer is visible, point will go to the end of the
 buffer and smart-display will be turned off (that is, subsequently
 That is, if a command is running and the user presses SPACE at a time
 when the end of the buffer is visible, point will go to the end of the
 buffer and smart-display will be turned off (that is, subsequently


@@ -149,7 +147,7 @@ buffer using \\[end-of-buffer]."
   :group 'eshell-smart)
 
 (defcustom eshell-where-to-jump 'begin
   :group 'eshell-smart)
 
 (defcustom eshell-where-to-jump 'begin

-  "*This variable indicates where point should jump to after a command.
+  "This variable indicates where point should jump to after a command.

 The options are `begin', `after' or `end'."
   :type '(radio (const :tag "Beginning of command" begin)
                (const :tag "After command word" after)
 The options are `begin', `after' or `end'."
   :type '(radio (const :tag "Beginning of command" begin)
                (const :tag "After command word" after)


@@ -292,7 +290,7 @@ and the end of the buffer are still visible."
        (setq clear t)
       (cond
        ((eq this-command 'self-insert-command)
        (setq clear t)
       (cond
        ((eq this-command 'self-insert-command)

-       (if (eq last-command-char ? )
+       (if (eq last-command-event ? )

            (if (and eshell-smart-space-goes-to-end
                     eshell-current-command)
                (if (not (pos-visible-in-window-p (point-max)))
            (if (and eshell-smart-space-goes-to-end
                     eshell-current-command)
                (if (not (pos-visible-in-window-p (point-max)))


@@ -324,5 +322,8 @@ and the end of the buffer are still visible."
 
 (provide 'em-smart)
 
 
 (provide 'em-smart)
 

-;;; arch-tag: 8c0112c7-379c-4d54-9a1c-204d68786a4b
+;; Local Variables:
+;; generated-autoload-file: "esh-groups.el"
+;; End:
+

 ;;; em-smart.el ends here
 ;;; em-smart.el ends here