(compilation-minor-mode-map, compilation-mode-map):

[bpt/emacs.git] / lisp / help-macro.el

diff --git a/lisp/help-macro.el b/lisp/help-macro.el
index 3a04fa6..6ad9a81 100644 (file)
--- a/lisp/help-macro.el
+++ b/lisp/help-macro.el
@@ -1,18 +1,19 @@
-;;; help-macro.el --- Makes command line help such as help-for-help
+;;; help-macro.el --- makes command line help such as help-for-help
 
-;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1993, 1994, 2001, 2002, 2003, 2004,
+;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
 
 ;; Author: Lynn Slater <lrs@indetech.com>
 ;; Maintainer: FSF
-;; Created: : Mon Oct  1 11:42:39 1990
+;; Created: Mon Oct  1 11:42:39 1990
 ;; Adapted-By: ESR
 
 ;; 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
-;; the Free Software Foundation; either version 2, 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
@@ -20,16 +21,14 @@
 ;; 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., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
 ;; This file supplies the macro make-help-screen which constructs
 ;; single character dispatching with browsable help such as that provided
 ;; by help-for-help. This can be used to make many modes easier to use; for
-;; example, the Gnu Emacs Empire Tool uses this for every "nested" mode map
+;; example, the GNU Emacs Empire Tool uses this for every "nested" mode map
 ;; called from the main mode map.
 
 ;;       The name of this package was changed from help-screen.el to
@@ -44,7 +43,7 @@
 ;;->
 ;;->c  Redistribute civs from overfull sectors into connected underfull ones
 ;;->     The functions typically named by empire-ideal-civ-fcn control
-;;->          based in part on empire-sector-civ-threshold  
+;;->          based in part on empire-sector-civ-threshold
 ;;->m  Redistribute military using levels given by empire-ideal-mil-fcn
 ;;->p  Redistribute excess population to highways for max pop growth
 ;;->     Excess is any sector so full babies will not be born.
@@ -62,22 +61,23 @@
 
 ;;; Change Log:
 ;;
-;; 22-Jan-1991         Lynn Slater x2048       
+;; 22-Jan-1991         Lynn Slater x2048
 ;;    Last Modified: Mon Oct  1 11:43:52 1990 #3 (Lynn Slater)
 ;;    documented better
 
 ;;; Code:
 
-(provide 'help-macro)
 (require 'backquote)
 
 ;;;###autoload
-(defvar three-step-help nil
+(defcustom three-step-help nil
   "*Non-nil means give more info about Help command in three steps.
 The three steps are simple prompt, prompt with all options,
 and window listing and describing the options.
 A value of nil means skip the middle step, so that
-\\[help-command] \\[help-command] gives the window that lists the options.")
+\\[help-command] \\[help-command] gives the window that lists the options."
+  :type 'boolean
+  :group 'help)
 
 (defmacro make-help-screen (fname help-line help-text helped-map)
   "Construct help-menu function name FNAME.
@@ -120,7 +120,7 @@ and then returns."
                     (if three-step-help
                         (progn
                           (setq key (let ((overriding-local-map local-map))
-                                    (read-key-sequence nil)))
+                                      (read-key-sequence nil)))
                           ;; Make the HELP key translate to C-h.
                           (if (lookup-key function-key-map key)
                               (setq key (lookup-key function-key-map key)))
@@ -137,19 +137,20 @@ and then returns."
                                (setq new-frame (window-frame (selected-window))
                                      config nil))
                           (setq buffer-read-only nil)
-                          (erase-buffer)
-                          (insert help-screen)
+                          (let ((inhibit-read-only t))
+                            (erase-buffer)
+                            (insert help-screen))
                           (help-mode)
                           (goto-char (point-min))
                           (while (or (memq char (append help-event-list
-                                                        (cons help-char '(?? ?\C-v ?\ ?\177 delete backspace vertical-scroll-bar ?\M-v))))
+                                                        (cons help-char '(?? ?\C-v ?\s ?\177 delete backspace vertical-scroll-bar ?\M-v))))
                                      (eq (car-safe char) 'switch-frame)
                                      (equal key "\M-v"))
                             (condition-case nil
                                 (progn
                                   (if (eq (car-safe char) 'switch-frame)
                                       (handle-switch-frame char))
-                                  (if (memq char '(?\C-v ?\ ))
+                                  (if (memq char '(?\C-v ?\s))
                                       (scroll-up))
                                   (if (or (memq char '(?\177 ?\M-v
                                                        delete backspace))
@@ -193,5 +194,7 @@ and then returns."
                     (set-window-configuration config))))))
      )))
 
-;;; help-macro.el
+(provide 'help-macro)
 
+;; arch-tag: 59fee949-1686-485a-8a05-83418073e257
+;;; help-macro.el ends here