Lines Matching +defs:help +defs:map
0 ;;; help.el --- help commands for Emacs
7 ;; Keywords: help, internal
28 ;; This code implements GNU Emacs' on-line help system, the one invoked by
29 ;; `M-x help-for-help'.
33 ;; Get the macro make-help-screen when this is compiled,
35 (eval-when-compile (require 'help-macro))
37 ;; This makes `with-output-to-temp-buffer' buffers use `help-mode'.
38 (add-hook 'temp-buffer-setup-hook 'help-mode-setup)
39 (add-hook 'temp-buffer-show-hook 'help-mode-finish)
41 (defvar help-map
42 (let ((map (make-sparse-keymap)))
43 (define-key map (char-to-string help-char) 'help-for-help)
44 (define-key map [help] 'help-for-help)
45 (define-key map [f1] 'help-for-help)
46 (define-key map "." 'display-local-help)
47 (define-key map "?" 'help-for-help)
49 (define-key map "\C-c" 'describe-copying)
50 (define-key map "\C-d" 'describe-distribution)
51 (define-key map "\C-e" 'view-emacs-problems)
52 (define-key map "\C-f" 'view-emacs-FAQ)
53 (define-key map "\C-m" 'view-order-manuals)
54 (define-key map "\C-n" 'view-emacs-news)
55 (define-key map "\C-p" 'describe-project)
56 (define-key map "\C-t" 'view-todo)
57 (define-key map "\C-w" 'describe-no-warranty)
60 (define-key map "\C-\\" 'describe-input-method)
62 (define-key map "C" 'describe-coding-system)
63 (define-key map "F" 'Info-goto-emacs-command-node)
64 (define-key map "I" 'describe-input-method)
65 (define-key map "K" 'Info-goto-emacs-key-command-node)
66 (define-key map "L" 'describe-language-environment)
67 (define-key map "S" 'info-lookup-symbol)
69 (define-key map "a" 'apropos-command)
70 (define-key map "b" 'describe-bindings)
71 (define-key map "c" 'describe-key-briefly)
72 (define-key map "d" 'apropos-documentation)
73 (define-key map "e" 'view-echo-area-messages)
74 (define-key map "f" 'describe-function)
75 (define-key map "h" 'view-hello-file)
77 (define-key map "i" 'info)
78 (define-key map "4i" 'info-other-window)
80 (define-key map "k" 'describe-key)
81 (define-key map "l" 'view-lossage)
82 (define-key map "m" 'describe-mode)
83 (define-key map "n" 'view-emacs-news)
84 (define-key map "p" 'finder-by-keyword)
85 (define-key map "r" 'info-emacs-manual)
86 (define-key map "s" 'describe-syntax)
87 (define-key map "t" 'help-with-tutorial)
88 (define-key map "w" 'where-is)
89 (define-key map "v" 'describe-variable)
90 (define-key map "q" 'help-quit)
91 map)
94 (define-key global-map (char-to-string help-char) 'help-command)
95 (define-key global-map [help] 'help-command)
96 (define-key global-map [f1] 'help-command)
97 (fset 'help-command help-map)
103 (defvar help-button-cache nil)
107 (defun help-quit ()
112 (defvar help-return-method nil
113 "What to do to \"exit\" the help buffer.
120 (defun print-help-return-message (&optional function)
121 "Display or return message saying how to restore windows after help command.
122 This function assumes that `standard-output' is the help buffer.
125 In addition, this function sets up `help-return-method', which see, that
126 specifies what to do when the user exits the help buffer."
132 (setq help-return-method (cons (selected-window) t))
133 ;; If the help output buffer is a special display buffer,
141 (setq help-return-method (cons (selected-window)
145 (setq help-return-method
149 (setq help-return-method (cons (selected-window) t))
150 "Type \\[delete-other-windows] to remove help window.")
152 (setq help-return-method
155 "Type \\[switch-to-buffer] RET to remove help window."))))
161 ;; If the help buffer will go in a separate frame,
169 "\\[scroll-up] to scroll the help.")
172 "\\[scroll-other-window] to scroll the help."))))))))
177 (defalias 'help 'help-for-help-internal)
179 (defalias 'help-for-help 'help-for-help-internal)
181 (make-help-screen help-for-help-internal
183 "You have typed %THIS-KEY%, the help character. Type a Help option:
184 \(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.)
221 t help-with-tutorial. Select the Emacs learn-by-doing tutorial.
226 . display-local-help. Display any available local help at point
238 help-map)
283 ;;; `User' help functions
327 (setq prefix-help-command 'describe-prefix-bindings)
434 (help-setup-xref (list #'view-lossage) (interactive-p))
435 (with-output-to-temp-buffer (help-buffer)
448 (print-help-return-message)))
465 (help-setup-xref (list #'describe-bindings prefix buffer) (interactive-p))
515 symbol overriding-local-map nil nil remapped))
543 (defun help-key-description (key untranslated)
561 temporarily enables it to allow getting help on disabled items and buttons."
616 (setq key-desc (help-key-description key untranslated))
633 temporarily enables it to allow getting help on disabled items and buttons."
693 (help-key-description key untranslated) mouse-msg)
694 (help-setup-xref (list #'describe-function defn) (interactive-p))
724 (with-output-to-temp-buffer (help-buffer)
725 (princ (help-key-description key untranslated))
761 (print-help-return-message)))))
775 (help-setup-xref (list #'describe-mode buffer)
777 ;; For the sake of help-do-xref and help-xref-go-back,
778 ;; don't switch buffers before calling `help-buffer'.
779 (with-output-to-temp-buffer (help-buffer)
810 (make-local-variable 'help-button-cache)
821 (push (point-marker) help-button-cache)
831 'action (car help-button-cache)
833 'help-echo "mouse-2, RET: show full information")
848 (print-help-return-message))))
949 :group 'help
958 This applies to `help', `apropos' and `completion' buffers, and some others."
959 :global t :group 'help
961 ;; `help-make-xrefs' may add a `back' button and thus increase the
983 (provide 'help)
986 ;;; help.el ends here