Mercurial > emacs
annotate lisp/help.el @ 51798:04564d8f3be9
(browse-url-browser-function): Add alternative for Epiphany.
(browse-url-epiphany-program, browse-url-epiphany-arguments)
(browse-url-epiphany-startup-arguments)
(browse-url-epiphany-new-window-is-tab): New variables.
(browse-url-epiphany, browse-url-epiphany-sentinel): New functions.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Mon, 07 Jul 2003 20:54:56 +0000 |
parents | cd863af50ea1 |
children | 695cf19ef79e |
rev | line source |
---|---|
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
1 ;;; help.el --- help commands for Emacs |
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
2 |
44537
a80baec69a4e
(string-key-binding): Deal with margin events.
Gerd Moellmann <gerd@gnu.org>
parents:
44332
diff
changeset
|
3 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002 |
36277
ab9c82e64020
(view-order-manuals): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
36249
diff
changeset
|
4 ;; Free Software Foundation, Inc. |
846
20674ae6bf52
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
811
diff
changeset
|
5 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
6 ;; Maintainer: FSF |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
807
diff
changeset
|
7 ;; Keywords: help, internal |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
8 |
409 | 9 ;; This file is part of GNU Emacs. |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
13 ;; the Free Software Foundation; either version 2, or (at your option) |
409 | 14 ;; any later version. |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
14169 | 22 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 ;; Boston, MA 02111-1307, USA. | |
409 | 25 |
2315
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
26 ;;; Commentary: |
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
27 |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
28 ;; This code implements GNU Emacs' on-line help system, the one invoked by |
25473
1ad8606c8cc7
(help-make-xrefs): Don't lose on non-empty blank line after key table.
Dave Love <fx@gnu.org>
parents:
25047
diff
changeset
|
29 ;; `M-x help-for-help'. |
2315
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
30 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
31 ;;; Code: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
32 |
2312
ad7b89a430df
Don't load help-screen at run time if compiled.
Richard M. Stallman <rms@gnu.org>
parents:
2237
diff
changeset
|
33 ;; Get the macro make-help-screen when this is compiled, |
ad7b89a430df
Don't load help-screen at run time if compiled.
Richard M. Stallman <rms@gnu.org>
parents:
2237
diff
changeset
|
34 ;; or run interpreted, but not when the compiled code is loaded. |
2697
05ff97695d32
Require help-macro, not help-screen.
Richard M. Stallman <rms@gnu.org>
parents:
2638
diff
changeset
|
35 (eval-when-compile (require 'help-macro)) |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
36 |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
37 ;; This makes `with-output-to-temp-buffer' buffers use `help-mode'. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
38 (add-hook 'temp-buffer-setup-hook 'help-mode-setup) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
39 (add-hook 'temp-buffer-show-hook 'help-mode-finish) |
2237
2670a8f6a42e
Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2134
diff
changeset
|
40 |
409 | 41 (defvar help-map (make-sparse-keymap) |
42 "Keymap for characters following the Help key.") | |
43 | |
919 | 44 (define-key global-map (char-to-string help-char) 'help-command) |
12424
aa25c9b2e043
Bind f1 and help like C-h.
Richard M. Stallman <rms@gnu.org>
parents:
11890
diff
changeset
|
45 (define-key global-map [help] 'help-command) |
aa25c9b2e043
Bind f1 and help like C-h.
Richard M. Stallman <rms@gnu.org>
parents:
11890
diff
changeset
|
46 (define-key global-map [f1] 'help-command) |
409 | 47 (fset 'help-command help-map) |
48 | |
919 | 49 (define-key help-map (char-to-string help-char) 'help-for-help) |
12424
aa25c9b2e043
Bind f1 and help like C-h.
Richard M. Stallman <rms@gnu.org>
parents:
11890
diff
changeset
|
50 (define-key help-map [help] 'help-for-help) |
aa25c9b2e043
Bind f1 and help like C-h.
Richard M. Stallman <rms@gnu.org>
parents:
11890
diff
changeset
|
51 (define-key help-map [f1] 'help-for-help) |
409 | 52 (define-key help-map "?" 'help-for-help) |
53 | |
54 (define-key help-map "\C-c" 'describe-copying) | |
55 (define-key help-map "\C-d" 'describe-distribution) | |
42735
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
56 (define-key help-map "\C-e" 'view-emacs-problems) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
57 (define-key help-map "\C-f" 'view-emacs-FAQ) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
58 (define-key help-map "\C-m" 'view-order-manuals) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
59 (define-key help-map "\C-n" 'view-emacs-news) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
60 (define-key help-map "\C-p" 'describe-project) |
45070
fbd816e9e27d
(view-todo): New function.
Richard M. Stallman <rms@gnu.org>
parents:
44537
diff
changeset
|
61 (define-key help-map "\C-t" 'view-todo) |
409 | 62 (define-key help-map "\C-w" 'describe-no-warranty) |
42735
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
63 |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
64 ;; This does not fit the pattern, but it is natural given the C-\ command. |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
65 (define-key help-map "\C-\\" 'describe-input-method) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
66 |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
67 (define-key help-map "C" 'describe-coding-system) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
68 (define-key help-map "F" 'Info-goto-emacs-command-node) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
69 (define-key help-map "I" 'describe-input-method) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
70 (define-key help-map "K" 'Info-goto-emacs-key-command-node) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
71 (define-key help-map "L" 'describe-language-environment) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
72 (define-key help-map "S" 'info-lookup-symbol) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
73 |
17200
9438563a5151
(help-map): Use apropos-command, not command-apropos.
Richard M. Stallman <rms@gnu.org>
parents:
17005
diff
changeset
|
74 (define-key help-map "a" 'apropos-command) |
409 | 75 |
76 (define-key help-map "b" 'describe-bindings) | |
77 | |
78 (define-key help-map "c" 'describe-key-briefly) | |
79 | |
42735
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
80 (define-key help-map "e" 'view-echo-area-messages) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
81 |
409 | 82 (define-key help-map "f" 'describe-function) |
83 | |
42735
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
84 (define-key help-map "h" 'view-hello-file) |
10923
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
85 |
409 | 86 (define-key help-map "i" 'info) |
22470
eec1f722bded
(help-map): C-h 4 i runs info-other-window.
Richard M. Stallman <rms@gnu.org>
parents:
22417
diff
changeset
|
87 (define-key help-map "4i" 'info-other-window) |
42735
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
88 |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
89 (define-key help-map "k" 'describe-key) |
409 | 90 |
91 (define-key help-map "l" 'view-lossage) | |
92 | |
93 (define-key help-map "m" 'describe-mode) | |
94 | |
95 (define-key help-map "n" 'view-emacs-news) | |
96 | |
2134
b275e1b50542
Added autoload, binding and menu line for new finder feature (P).
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2079
diff
changeset
|
97 (define-key help-map "p" 'finder-by-keyword) |
7978
8356e992ddb6
(finder-by-keyword): Add doc string and t for interactive.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
98 (autoload 'finder-by-keyword "finder" |
8356e992ddb6
(finder-by-keyword): Add doc string and t for interactive.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
99 "Find packages matching a given keyword." t) |
2134
b275e1b50542
Added autoload, binding and menu line for new finder feature (P).
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2079
diff
changeset
|
100 |
46329
081502d6dd98
(help-map): Add binding for info-emacs-manual.
Richard M. Stallman <rms@gnu.org>
parents:
45070
diff
changeset
|
101 (define-key help-map "r" 'info-emacs-manual) |
081502d6dd98
(help-map): Add binding for info-emacs-manual.
Richard M. Stallman <rms@gnu.org>
parents:
45070
diff
changeset
|
102 |
409 | 103 (define-key help-map "s" 'describe-syntax) |
104 | |
105 (define-key help-map "t" 'help-with-tutorial) | |
106 | |
107 (define-key help-map "w" 'where-is) | |
108 | |
109 (define-key help-map "v" 'describe-variable) | |
110 | |
6580 | 111 (define-key help-map "q" 'help-quit) |
112 | |
39651
444f50200adc
(help-mode-map): Make button-buffer-map our parent.
Miles Bader <miles@gnu.org>
parents:
39512
diff
changeset
|
113 |
6580 | 114 (defun help-quit () |
23333 | 115 "Just exit from the Help command's command loop." |
6580 | 116 (interactive) |
117 nil) | |
118 | |
21188
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
119 (defvar help-return-method nil |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
120 "What to do to \"exit\" the help buffer. |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
121 This is a list |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
122 (WINDOW . t) delete the selected window, go to WINDOW. |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
123 (WINDOW . quit-window) do quit-window, then select WINDOW. |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
124 (WINDOW BUF START POINT) display BUF at START, POINT, then select WINDOW.") |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
125 |
409 | 126 (defun print-help-return-message (&optional function) |
127 "Display or return message saying how to restore windows after help command. | |
46329
081502d6dd98
(help-map): Add binding for info-emacs-manual.
Richard M. Stallman <rms@gnu.org>
parents:
45070
diff
changeset
|
128 This function assumes that `standard-output' is the help buffer. |
081502d6dd98
(help-map): Add binding for info-emacs-manual.
Richard M. Stallman <rms@gnu.org>
parents:
45070
diff
changeset
|
129 It computes a message, and applies the optional argument FUNCTION to it. |
081502d6dd98
(help-map): Add binding for info-emacs-manual.
Richard M. Stallman <rms@gnu.org>
parents:
45070
diff
changeset
|
130 If FUNCTION is nil, it applies `message', thus displaying the message." |
409 | 131 (and (not (get-buffer-window standard-output)) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
132 (let ((first-message |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
133 (cond ((special-display-p (buffer-name standard-output)) |
21188
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
134 (setq help-return-method (cons (selected-window) t)) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
135 ;; If the help output buffer is a special display buffer, |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
136 ;; don't say anything about how to get rid of it. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
137 ;; First of all, the user will do that with the window |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
138 ;; manager, not with Emacs. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
139 ;; Secondly, the buffer has not been displayed yet, |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
140 ;; so we don't know whether its frame will be selected. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
141 nil) |
30667
2bd60ea8076f
(print-help-return-message): When
Gerd Moellmann <gerd@gnu.org>
parents:
30621
diff
changeset
|
142 (display-buffer-reuse-frames |
2bd60ea8076f
(print-help-return-message): When
Gerd Moellmann <gerd@gnu.org>
parents:
30621
diff
changeset
|
143 (setq help-return-method (cons (selected-window) |
2bd60ea8076f
(print-help-return-message): When
Gerd Moellmann <gerd@gnu.org>
parents:
30621
diff
changeset
|
144 'quit-window)) |
2bd60ea8076f
(print-help-return-message): When
Gerd Moellmann <gerd@gnu.org>
parents:
30621
diff
changeset
|
145 nil) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
146 ((not (one-window-p t)) |
21188
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
147 (setq help-return-method |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
148 (cons (selected-window) 'quit-window)) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
149 "Type \\[switch-to-buffer-other-window] RET to restore the other window.") |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
150 (pop-up-windows |
21188
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
151 (setq help-return-method (cons (selected-window) t)) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
152 "Type \\[delete-other-windows] to remove help window.") |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
153 (t |
21188
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
154 (setq help-return-method |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
155 (list (selected-window) (window-buffer) |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
156 (window-start) (window-point))) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
157 "Type \\[switch-to-buffer] RET to remove help window.")))) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
158 (funcall (or function 'message) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
159 (concat |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
160 (if first-message |
28909 | 161 (substitute-command-keys first-message)) |
162 (if first-message " ") | |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
163 ;; If the help buffer will go in a separate frame, |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
164 ;; it's no use mentioning a command to scroll, so don't. |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
165 (if (special-display-p (buffer-name standard-output)) |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
166 nil |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
167 (if (same-window-p (buffer-name standard-output)) |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
168 ;; Say how to scroll this window. |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
169 (substitute-command-keys |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
170 "\\[scroll-up] to scroll the help.") |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
171 ;; Say how to scroll some other window. |
11428
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
172 (substitute-command-keys |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
173 "\\[scroll-other-window] to scroll the help.")))))))) |
409 | 174 |
175 ;; So keyboard macro definitions are documented correctly | |
176 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro)) | |
177 | |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
178 (defalias 'help 'help-for-help) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
179 (make-help-screen help-for-help |
45070
fbd816e9e27d
(view-todo): New function.
Richard M. Stallman <rms@gnu.org>
parents:
44537
diff
changeset
|
180 "a b c C e f F i I k C-k l L m p s t v w C-c C-d C-f C-n C-p C-t C-w or ? :" |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
181 "You have typed %THIS-KEY%, the help character. Type a Help option: |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
182 \(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
183 |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
184 a command-apropos. Give a substring, and see a list of commands |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
185 (functions interactively callable) that contain |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
186 that substring. See also the apropos command. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
187 b describe-bindings. Display table of all key bindings. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
188 c describe-key-briefly. Type a command key sequence; |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
189 it prints the function name that sequence runs. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
190 C describe-coding-system. This describes either a specific coding system |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
191 (if you type its name) or the coding systems currently in use |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
192 (if you type just RET). |
42735
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
193 e view-echo-area-messages. Show the `*Messages*' buffer. |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
194 f describe-function. Type a function name and get documentation of it. |
42735
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
195 F Info-goto-emacs-command-node. Type a function name; |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
196 it takes you to the Info node for that command. |
42738 | 197 h Display the HELLO file which illustrates various scripts. |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
198 i info. The info documentation reader. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
199 I describe-input-method. Describe a specific input method (if you type |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
200 its name) or the current input method (if you type just RET). |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
201 k describe-key. Type a command key sequence; |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
202 it displays the full documentation. |
42735
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
203 K Info-goto-emacs-key-command-node. Type a command key sequence; |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
204 it takes you to the Info node for the command bound to that key. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
205 l view-lossage. Show last 100 characters you typed. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
206 L describe-language-environment. This describes either a |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
207 specific language environment (if you type its name) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
208 or the current language environment (if you type just RET). |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
209 m describe-mode. Print documentation of current minor modes, |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
210 and the current major mode, including their special commands. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
211 p finder-by-keyword. Find packages matching a given topic keyword. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
212 s describe-syntax. Display contents of syntax table, plus explanations. |
42735
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
213 S info-lookup-symbol. Display the definition of a specific symbol |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
214 as found in the manual for the language this buffer is written in. |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
215 t help-with-tutorial. Select the Emacs learn-by-doing tutorial. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
216 v describe-variable. Type name of a variable; |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
217 it displays the variable's documentation and value. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
218 w where-is. Type command name; it prints which keystrokes |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
219 invoke that command. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
220 |
42735
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
221 C-c Display Emacs copying permission (GNU General Public License). |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
222 C-d Display Emacs ordering information. |
42735
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
223 C-e Display info about Emacs problems. |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
224 C-f Display the Emacs FAQ. |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
225 C-m Display how to order printed Emacs manuals. |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
226 C-n Display news of recent Emacs changes. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
227 C-p Display information about the GNU project. |
45070
fbd816e9e27d
(view-todo): New function.
Richard M. Stallman <rms@gnu.org>
parents:
44537
diff
changeset
|
228 C-t Display the Emacs TODO list. |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
229 C-w Display information on absence of warranty for GNU Emacs." |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
230 help-map) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
231 |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
232 |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
233 |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
234 (defun function-called-at-point () |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
235 "Return a function around point or else called by the list containing point. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
236 If that doesn't give a function, return nil." |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
237 (with-syntax-table emacs-lisp-mode-syntax-table |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
238 (or (condition-case () |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
239 (save-excursion |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
240 (or (not (zerop (skip-syntax-backward "_w"))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
241 (eq (char-syntax (following-char)) ?w) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
242 (eq (char-syntax (following-char)) ?_) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
243 (forward-sexp -1)) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
244 (skip-chars-forward "'") |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
245 (let ((obj (read (current-buffer)))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
246 (and (symbolp obj) (fboundp obj) obj))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
247 (error nil)) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
248 (condition-case () |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
249 (save-excursion |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
250 (save-restriction |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
251 (narrow-to-region (max (point-min) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
252 (- (point) 1000)) (point-max)) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
253 ;; Move up to surrounding paren, then after the open. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
254 (backward-up-list 1) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
255 (forward-char 1) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
256 ;; If there is space here, this is probably something |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
257 ;; other than a real Lisp function call, so ignore it. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
258 (if (looking-at "[ \t]") |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
259 (error "Probably not a Lisp function call")) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
260 (let ((obj (read (current-buffer)))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
261 (and (symbolp obj) (fboundp obj) obj)))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
262 (error nil))))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
263 |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
264 |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
265 ;;; `User' help functions |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
266 |
409 | 267 (defun describe-distribution () |
268 "Display info on how to obtain the latest version of GNU Emacs." | |
269 (interactive) | |
42802
d72ace523825
(describe-distribution): Really call view-file.
Richard M. Stallman <rms@gnu.org>
parents:
42738
diff
changeset
|
270 (view-file (expand-file-name "DISTRIB" data-directory))) |
409 | 271 |
272 (defun describe-copying () | |
273 "Display info on how you may redistribute copies of GNU Emacs." | |
274 (interactive) | |
42254
ffef7ba0b65d
(view-order-manuals, view-emacs-news, describe-copying)
Richard M. Stallman <rms@gnu.org>
parents:
39789
diff
changeset
|
275 (view-file (expand-file-name "COPYING" data-directory)) |
409 | 276 (goto-char (point-min))) |
277 | |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
278 (defun describe-project () |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
279 "Display info on the GNU project." |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
280 (interactive) |
42254
ffef7ba0b65d
(view-order-manuals, view-emacs-news, describe-copying)
Richard M. Stallman <rms@gnu.org>
parents:
39789
diff
changeset
|
281 (view-file (expand-file-name "THE-GNU-PROJECT" data-directory)) |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
282 (goto-char (point-min))) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
283 |
409 | 284 (defun describe-no-warranty () |
285 "Display info on all the kinds of warranty Emacs does NOT have." | |
286 (interactive) | |
287 (describe-copying) | |
288 (let (case-fold-search) | |
289 (search-forward "NO WARRANTY") | |
290 (recenter 0))) | |
291 | |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
292 (defun describe-prefix-bindings () |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
293 "Describe the bindings of the prefix used to reach this command. |
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
294 The prefix described consists of all but the last event |
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
295 of the key sequence that ran this command." |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
296 (interactive) |
11890
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
297 (let* ((key (this-command-keys))) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
298 (describe-bindings |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
299 (if (stringp key) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
300 (substring key 0 (1- (length key))) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
301 (let ((prefix (make-vector (1- (length key)) nil)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
302 (i 0)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
303 (while (< i (length prefix)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
304 (aset prefix i (aref key i)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
305 (setq i (1+ i))) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
306 prefix))))) |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
307 ;; Make C-h after a prefix, when not specifically bound, |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
308 ;; run describe-prefix-bindings. |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
309 (setq prefix-help-command 'describe-prefix-bindings) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
310 |
21210
2a51a4912199
(view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents:
21188
diff
changeset
|
311 (defun view-emacs-news (&optional arg) |
2a51a4912199
(view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents:
21188
diff
changeset
|
312 "Display info on recent changes to Emacs. |
30920
67bba5cea7bf
(view-emacs-news): Rewritten for new naming scheme
Gerd Moellmann <gerd@gnu.org>
parents:
30819
diff
changeset
|
313 With numeric argument, display information on correspondingly older changes." |
21210
2a51a4912199
(view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents:
21188
diff
changeset
|
314 (interactive "P") |
30920
67bba5cea7bf
(view-emacs-news): Rewritten for new naming scheme
Gerd Moellmann <gerd@gnu.org>
parents:
30819
diff
changeset
|
315 (let* ((arg (if arg (prefix-numeric-value arg) 0)) |
67bba5cea7bf
(view-emacs-news): Rewritten for new naming scheme
Gerd Moellmann <gerd@gnu.org>
parents:
30819
diff
changeset
|
316 (file (cond ((eq arg 0) "NEWS") |
67bba5cea7bf
(view-emacs-news): Rewritten for new naming scheme
Gerd Moellmann <gerd@gnu.org>
parents:
30819
diff
changeset
|
317 ((eq arg 1) "ONEWS") |
67bba5cea7bf
(view-emacs-news): Rewritten for new naming scheme
Gerd Moellmann <gerd@gnu.org>
parents:
30819
diff
changeset
|
318 (t |
67bba5cea7bf
(view-emacs-news): Rewritten for new naming scheme
Gerd Moellmann <gerd@gnu.org>
parents:
30819
diff
changeset
|
319 (nth (- arg 2) |
67bba5cea7bf
(view-emacs-news): Rewritten for new naming scheme
Gerd Moellmann <gerd@gnu.org>
parents:
30819
diff
changeset
|
320 (nreverse (directory-files data-directory |
33147
826a062813f4
(view-emacs-news): Use ONEWS.* instead of NEWS.* files.
Gerd Moellmann <gerd@gnu.org>
parents:
32706
diff
changeset
|
321 nil "^ONEWS\\.[0-9]+$" |
30920
67bba5cea7bf
(view-emacs-news): Rewritten for new naming scheme
Gerd Moellmann <gerd@gnu.org>
parents:
30819
diff
changeset
|
322 nil))))))) |
67bba5cea7bf
(view-emacs-news): Rewritten for new naming scheme
Gerd Moellmann <gerd@gnu.org>
parents:
30819
diff
changeset
|
323 (if file |
42254
ffef7ba0b65d
(view-order-manuals, view-emacs-news, describe-copying)
Richard M. Stallman <rms@gnu.org>
parents:
39789
diff
changeset
|
324 (view-file (expand-file-name file data-directory)) |
30920
67bba5cea7bf
(view-emacs-news): Rewritten for new naming scheme
Gerd Moellmann <gerd@gnu.org>
parents:
30819
diff
changeset
|
325 (error "No such old news")))) |
409 | 326 |
45070
fbd816e9e27d
(view-todo): New function.
Richard M. Stallman <rms@gnu.org>
parents:
44537
diff
changeset
|
327 (defun view-todo (&optional arg) |
fbd816e9e27d
(view-todo): New function.
Richard M. Stallman <rms@gnu.org>
parents:
44537
diff
changeset
|
328 "Display the Emacs TODO list." |
fbd816e9e27d
(view-todo): New function.
Richard M. Stallman <rms@gnu.org>
parents:
44537
diff
changeset
|
329 (interactive "P") |
fbd816e9e27d
(view-todo): New function.
Richard M. Stallman <rms@gnu.org>
parents:
44537
diff
changeset
|
330 (view-file (expand-file-name "TODO" data-directory))) |
fbd816e9e27d
(view-todo): New function.
Richard M. Stallman <rms@gnu.org>
parents:
44537
diff
changeset
|
331 |
42735
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
332 (defun view-echo-area-messages () |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
333 "View the log of recent echo-area messages: the `*Messages*' buffer. |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
334 The number of messages retained in that buffer |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
335 is specified by the variable `message-log-max'." |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
336 (interactive) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
337 (switch-to-buffer (get-buffer-create "*Messages*"))) |
86919cd01cdd
(view-echo-area-messages): New function.
Richard M. Stallman <rms@gnu.org>
parents:
42679
diff
changeset
|
338 |
36277
ab9c82e64020
(view-order-manuals): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
36249
diff
changeset
|
339 (defun view-order-manuals () |
ab9c82e64020
(view-order-manuals): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
36249
diff
changeset
|
340 "Display the Emacs ORDERS file." |
ab9c82e64020
(view-order-manuals): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
36249
diff
changeset
|
341 (interactive) |
42254
ffef7ba0b65d
(view-order-manuals, view-emacs-news, describe-copying)
Richard M. Stallman <rms@gnu.org>
parents:
39789
diff
changeset
|
342 (view-file (expand-file-name "ORDERS" data-directory)) |
36398
f20c9b522f1d
(view-order-manuals): Use goto-address.
Gerd Moellmann <gerd@gnu.org>
parents:
36277
diff
changeset
|
343 (goto-address)) |
36277
ab9c82e64020
(view-order-manuals): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
36249
diff
changeset
|
344 |
10923
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
345 (defun view-emacs-FAQ () |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
346 "Display the Emacs Frequently Asked Questions (FAQ) file." |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
347 (interactive) |
39786
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
348 ;; (find-file-read-only (expand-file-name "FAQ" data-directory)) |
28935
0a2323529cff
(view-emacs-FAQ): Change `emacs-faq' to `efaq'.
Gerd Moellmann <gerd@gnu.org>
parents:
28909
diff
changeset
|
349 (info "(efaq)")) |
10923
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
350 |
26757
6af9f1dc59c4
(view-emacs-problems): New command, bound to C-h P.
Dave Love <fx@gnu.org>
parents:
26650
diff
changeset
|
351 (defun view-emacs-problems () |
6af9f1dc59c4
(view-emacs-problems): New command, bound to C-h P.
Dave Love <fx@gnu.org>
parents:
26650
diff
changeset
|
352 "Display info on known problems with Emacs and possible workarounds." |
6af9f1dc59c4
(view-emacs-problems): New command, bound to C-h P.
Dave Love <fx@gnu.org>
parents:
26650
diff
changeset
|
353 (interactive) |
6af9f1dc59c4
(view-emacs-problems): New command, bound to C-h P.
Dave Love <fx@gnu.org>
parents:
26650
diff
changeset
|
354 (view-file (expand-file-name "PROBLEMS" data-directory))) |
6af9f1dc59c4
(view-emacs-problems): New command, bound to C-h P.
Dave Love <fx@gnu.org>
parents:
26650
diff
changeset
|
355 |
409 | 356 (defun view-lossage () |
36975
d0fab2f2af5a
(view-lossage): Mention open-dribble-file in the doc
Eli Zaretskii <eliz@gnu.org>
parents:
36777
diff
changeset
|
357 "Display last 100 input keystrokes. |
d0fab2f2af5a
(view-lossage): Mention open-dribble-file in the doc
Eli Zaretskii <eliz@gnu.org>
parents:
36777
diff
changeset
|
358 |
d0fab2f2af5a
(view-lossage): Mention open-dribble-file in the doc
Eli Zaretskii <eliz@gnu.org>
parents:
36777
diff
changeset
|
359 To record all your input on a file, use `open-dribble-file'." |
409 | 360 (interactive) |
39789
e511f555920c
(view-lossage): Call help-setup-xref correctly and earlier.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39786
diff
changeset
|
361 (help-setup-xref (list #'view-lossage) (interactive-p)) |
e511f555920c
(view-lossage): Call help-setup-xref correctly and earlier.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39786
diff
changeset
|
362 (with-output-to-temp-buffer (help-buffer) |
44332
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
363 (princ (mapconcat (lambda (key) |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
364 (if (or (integerp key) (symbolp key) (listp key)) |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
365 (single-key-description key) |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
366 (prin1-to-string key nil))) |
8504
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
367 (recent-keys) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
368 " ")) |
39659
4bd383bb2137
(help-mode): Use define-derived-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39651
diff
changeset
|
369 (with-current-buffer standard-output |
409 | 370 (goto-char (point-min)) |
371 (while (progn (move-to-column 50) (not (eobp))) | |
372 (search-forward " " nil t) | |
39789
e511f555920c
(view-lossage): Call help-setup-xref correctly and earlier.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39786
diff
changeset
|
373 (insert "\n"))) |
409 | 374 (print-help-return-message))) |
375 | |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
376 |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
377 ;; Key bindings |
409 | 378 |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
379 (defun describe-bindings (&optional prefix buffer) |
20848
4c3e62fe8898
(describe-bindings): New command (formerly in keymap.c).
Richard M. Stallman <rms@gnu.org>
parents:
20290
diff
changeset
|
380 "Show a list of all defined keys, and their definitions. |
4c3e62fe8898
(describe-bindings): New command (formerly in keymap.c).
Richard M. Stallman <rms@gnu.org>
parents:
20290
diff
changeset
|
381 We put that list in a buffer, and display the buffer. |
4c3e62fe8898
(describe-bindings): New command (formerly in keymap.c).
Richard M. Stallman <rms@gnu.org>
parents:
20290
diff
changeset
|
382 |
4c3e62fe8898
(describe-bindings): New command (formerly in keymap.c).
Richard M. Stallman <rms@gnu.org>
parents:
20290
diff
changeset
|
383 The optional argument PREFIX, if non-nil, should be a key sequence; |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
384 then we display only bindings that start with that prefix. |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
385 The optional argument BUFFER specifies which buffer's bindings |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
386 to display (default, the current buffer)." |
39789
e511f555920c
(view-lossage): Call help-setup-xref correctly and earlier.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39786
diff
changeset
|
387 (interactive) |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
388 (or buffer (setq buffer (current-buffer))) |
39789
e511f555920c
(view-lossage): Call help-setup-xref correctly and earlier.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39786
diff
changeset
|
389 (help-setup-xref (list #'describe-bindings prefix buffer) (interactive-p)) |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
390 (with-current-buffer buffer |
39789
e511f555920c
(view-lossage): Call help-setup-xref correctly and earlier.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39786
diff
changeset
|
391 (describe-bindings-internal nil prefix))) |
20848
4c3e62fe8898
(describe-bindings): New command (formerly in keymap.c).
Richard M. Stallman <rms@gnu.org>
parents:
20290
diff
changeset
|
392 |
39786
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
393 ;; This function used to be in keymap.c. |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
394 (defun describe-bindings-internal (&optional menus prefix) |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
395 "Show a list of all defined keys, and their definitions. |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
396 We put that list in a buffer, and display the buffer. |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
397 |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
398 The optional argument MENUS, if non-nil, says to mention menu bindings. |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
399 \(Ordinarily these are omitted from the output.) |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
400 The optional argument PREFIX, if non-nil, should be a key sequence; |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
401 then we display only bindings that start with that prefix." |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
402 (interactive) |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
403 (let ((buf (current-buffer))) |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
404 (with-output-to-temp-buffer "*Help*" |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
405 (with-current-buffer standard-output |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
406 (describe-buffer-bindings buf prefix menus))))) |
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
407 |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
408 (defun where-is (definition &optional insert) |
24079
11e777f59a1f
(help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents:
24055
diff
changeset
|
409 "Print message listing key sequences that invoke the command DEFINITION. |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
410 Argument is a command definition, usually a symbol with a function definition. |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
411 If INSERT (the prefix arg) is non-nil, insert the message in the buffer." |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
412 (interactive |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
413 (let ((fn (function-called-at-point)) |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
414 (enable-recursive-minibuffers t) |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
415 val) |
48202
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
416 (setq val (completing-read |
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
417 (if fn |
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
418 (format "Where is command (default %s): " fn) |
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
419 "Where is command: ") |
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
420 obarray 'commandp t)) |
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
421 (list (if (equal val "") fn (intern val)) current-prefix-arg))) |
48193
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
422 (let ((func (indirect-function definition)) |
48202
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
423 (defs nil) |
48193
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
424 (standard-output (if insert (current-buffer) t))) |
48202
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
425 (mapatoms (lambda (symbol) |
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
426 (and (fboundp symbol) |
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
427 (not (eq symbol definition)) |
49188
4e3e9d5a3332
(where-is): Catch errors in indirect-function.
Richard M. Stallman <rms@gnu.org>
parents:
48202
diff
changeset
|
428 (eq func (condition-case () |
4e3e9d5a3332
(where-is): Catch errors in indirect-function.
Richard M. Stallman <rms@gnu.org>
parents:
48202
diff
changeset
|
429 (indirect-function symbol) |
4e3e9d5a3332
(where-is): Catch errors in indirect-function.
Richard M. Stallman <rms@gnu.org>
parents:
48202
diff
changeset
|
430 (error symbol))) |
48202
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
431 (push symbol defs)))) |
48193
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
432 (princ (mapconcat |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
433 #'(lambda (symbol) |
49757
9fe119b14379
Renamed remap-command to command-remapping. All uses changed.
Kim F. Storm <storm@cua.dk>
parents:
49588
diff
changeset
|
434 (let* ((remapped (command-remapping symbol)) |
48202
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
435 (keys (where-is-internal |
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
436 symbol overriding-local-map nil nil remapped)) |
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
437 (keys (mapconcat 'key-description keys ", "))) |
48193
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
438 (if insert |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
439 (if (> (length keys) 0) |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
440 (if remapped |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
441 (format "%s (%s) (remapped from %s)" |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
442 keys remapped symbol) |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
443 (format "%s (%s)" keys symbol)) |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
444 (format "M-x %s RET" symbol)) |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
445 (if (> (length keys) 0) |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
446 (if remapped |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
447 (format "%s is remapped to %s which is on %s" |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
448 definition symbol keys) |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
449 (format "%s is on %s" symbol keys)) |
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
450 (format "%s is not on any key" symbol))))) |
48202
50c0685806fb
(where-is): Rename map to defs (a list of syms is not a map).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48193
diff
changeset
|
451 (cons definition defs) |
48193
0afe1465ac57
(where-is): Repport also aliases of the passed command.
Juanma Barranquero <lekktu@gmail.com>
parents:
46438
diff
changeset
|
452 ";\nand "))) |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
453 nil) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
454 |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
455 (defun string-key-binding (key) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
456 "Value is the binding of KEY in a string. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
457 If KEY is an event on a string, and that string has a `local-map' |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
458 or `keymap' property, return the binding of KEY in the string's keymap." |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
459 (let* ((defn nil) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
460 (start (when (vectorp key) |
44537
a80baec69a4e
(string-key-binding): Deal with margin events.
Gerd Moellmann <gerd@gnu.org>
parents:
44332
diff
changeset
|
461 (if (memq (aref key 0) |
a80baec69a4e
(string-key-binding): Deal with margin events.
Gerd Moellmann <gerd@gnu.org>
parents:
44332
diff
changeset
|
462 '(mode-line header-line left-margin right-margin)) |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
463 (event-start (aref key 1)) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
464 (and (consp (aref key 0)) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
465 (event-start (aref key 0)))))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
466 (string-info (and (consp start) (nth 4 start)))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
467 (when string-info |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
468 (let* ((string (car string-info)) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
469 (pos (cdr string-info)) |
44537
a80baec69a4e
(string-key-binding): Deal with margin events.
Gerd Moellmann <gerd@gnu.org>
parents:
44332
diff
changeset
|
470 (local-map (and (>= pos 0) |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
471 (< pos (length string)) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
472 (or (get-text-property pos 'local-map string) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
473 (get-text-property pos 'keymap string))))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
474 (setq defn (and local-map (lookup-key local-map key))))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
475 defn)) |
24079
11e777f59a1f
(help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents:
24055
diff
changeset
|
476 |
44332
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
477 (defun help-key-description (key untranslated) |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
478 (let ((string (key-description key))) |
46438
fd2419f6c4d9
(help-key-description): Show the untranslated keys
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46329
diff
changeset
|
479 (if (or (not untranslated) |
fd2419f6c4d9
(help-key-description): Show the untranslated keys
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46329
diff
changeset
|
480 (and (eq (aref untranslated 0) ?\e) (not (eq (aref key 0) ?\e)))) |
44332
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
481 string |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
482 (let ((otherstring (key-description untranslated))) |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
483 (if (equal string otherstring) |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
484 string |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
485 (format "%s (translated from %s)" string otherstring)))))) |
49588
37645a051842
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49188
diff
changeset
|
486 |
44332
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
487 (defun describe-key-briefly (key &optional insert untranslated) |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
488 "Print the name of the function KEY invokes. KEY is a string. |
44332
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
489 If INSERT (the prefix arg) is non-nil, insert the message in the buffer. |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
490 If non-nil UNTRANSLATED is a vector of the untranslated events. |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
491 It can also be a number in which case the untranslated events from |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
492 the last key hit are used." |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
493 (interactive "kDescribe key briefly: \nP\np") |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
494 (if (numberp untranslated) |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
495 (setq untranslated (this-single-command-raw-keys))) |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
496 (save-excursion |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
497 (let ((modifiers (event-modifiers (aref key 0))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
498 (standard-output (if insert (current-buffer) t)) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
499 window position) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
500 ;; For a mouse button event, go to the button it applies to |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
501 ;; to get the right key bindings. And go to the right place |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
502 ;; in case the keymap depends on where you clicked. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
503 (if (or (memq 'click modifiers) (memq 'down modifiers) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
504 (memq 'drag modifiers)) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
505 (setq window (posn-window (event-start (aref key 0))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
506 position (posn-point (event-start (aref key 0))))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
507 (if (windowp window) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
508 (progn |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
509 (set-buffer (window-buffer window)) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
510 (goto-char position))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
511 ;; Ok, now look up the key and name the command. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
512 (let ((defn (or (string-key-binding key) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
513 (key-binding key))) |
44332
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
514 (key-desc (help-key-description key untranslated))) |
43697
8dc5abd4533a
(describe-key-briefly, describe-key): Interpret `undefined' like not
Pavel Janík <Pavel@Janik.cz>
parents:
43500
diff
changeset
|
515 (if (or (null defn) (integerp defn) (equal defn 'undefined)) |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
516 (princ (format "%s is undefined" key-desc)) |
43309
63607f9209a0
(describe-key-briefly): Make output in INSERT case
Richard M. Stallman <rms@gnu.org>
parents:
43156
diff
changeset
|
517 (princ (format (if (windowp window) |
63607f9209a0
(describe-key-briefly): Make output in INSERT case
Richard M. Stallman <rms@gnu.org>
parents:
43156
diff
changeset
|
518 "%s at that spot runs the command %s" |
63607f9209a0
(describe-key-briefly): Make output in INSERT case
Richard M. Stallman <rms@gnu.org>
parents:
43156
diff
changeset
|
519 "%s runs the command %s") |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
520 key-desc |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
521 (if (symbolp defn) defn (prin1-to-string defn))))))))) |
31243
30007aab98df
(help-xref-mule-regexp): New variable
Kenichi Handa <handa@m17n.org>
parents:
30920
diff
changeset
|
522 |
30007aab98df
(help-xref-mule-regexp): New variable
Kenichi Handa <handa@m17n.org>
parents:
30920
diff
changeset
|
523 |
44332
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
524 (defun describe-key (key &optional untranslated) |
42357
253eec84f7d3
(describe-key): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
42254
diff
changeset
|
525 "Display documentation of the function invoked by KEY. |
253eec84f7d3
(describe-key): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
42254
diff
changeset
|
526 KEY should be a key sequence--when calling from a program, |
44332
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
527 pass a string or a vector. |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
528 If non-nil UNTRANSLATED is a vector of the untranslated events. |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
529 It can also be a number in which case the untranslated events from |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
530 the last key hit are used." |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
531 (interactive "kDescribe key: \np") |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
532 (if (numberp untranslated) |
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
533 (setq untranslated (this-single-command-raw-keys))) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
534 (save-excursion |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
535 (let ((modifiers (event-modifiers (aref key 0))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
536 window position) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
537 ;; For a mouse button event, go to the button it applies to |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
538 ;; to get the right key bindings. And go to the right place |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
539 ;; in case the keymap depends on where you clicked. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
540 (if (or (memq 'click modifiers) (memq 'down modifiers) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
541 (memq 'drag modifiers)) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
542 (setq window (posn-window (event-start (aref key 0))) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
543 position (posn-point (event-start (aref key 0))))) |
39786
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
544 (when (windowp window) |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
545 (set-buffer (window-buffer window)) |
39786
f50214c096af
(describe-bindings-internal): New fun moved from keymap.c.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39728
diff
changeset
|
546 (goto-char position)) |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
547 (let ((defn (or (string-key-binding key) (key-binding key)))) |
43697
8dc5abd4533a
(describe-key-briefly, describe-key): Interpret `undefined' like not
Pavel Janík <Pavel@Janik.cz>
parents:
43500
diff
changeset
|
548 (if (or (null defn) (integerp defn) (equal defn 'undefined)) |
44332
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
549 (message "%s is undefined" (help-key-description key untranslated)) |
39789
e511f555920c
(view-lossage): Call help-setup-xref correctly and earlier.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39786
diff
changeset
|
550 (help-setup-xref (list #'describe-function defn) (interactive-p)) |
e511f555920c
(view-lossage): Call help-setup-xref correctly and earlier.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39786
diff
changeset
|
551 (with-output-to-temp-buffer (help-buffer) |
44332
bdf6c2baa447
(help-key-description): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43697
diff
changeset
|
552 (princ (help-key-description key untranslated)) |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
553 (if (windowp window) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
554 (princ " at that spot")) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
555 (princ " runs the command ") |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
556 (prin1 defn) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
557 (princ "\n which is ") |
39789
e511f555920c
(view-lossage): Call help-setup-xref correctly and earlier.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39786
diff
changeset
|
558 (describe-function-1 defn) |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
559 (print-help-return-message))))))) |
31422
2a7aafb126fb
(help-make-xrefs): Adjusted for the change of
Kenichi Handa <handa@m17n.org>
parents:
31397
diff
changeset
|
560 |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
561 |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
562 (defun describe-mode (&optional buffer) |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
563 "Display documentation of current major mode and minor modes. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
564 The major mode description comes first, followed by the minor modes, |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
565 each on a separate page. |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
566 For this to work correctly for a minor mode, the mode's indicator variable |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
567 \(listed in `minor-mode-alist') must also be a function whose documentation |
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
568 describes the minor mode." |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
569 (interactive) |
42679
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
570 (help-setup-xref (list #'describe-mode (or buffer (current-buffer))) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
571 (interactive-p)) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
572 ;; For the sake of help-do-xref and help-xref-go-back, |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
573 ;; don't switch buffers before calling `help-buffer'. |
39789
e511f555920c
(view-lossage): Call help-setup-xref correctly and earlier.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39786
diff
changeset
|
574 (with-output-to-temp-buffer (help-buffer) |
42679
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
575 (save-excursion |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
576 (when buffer (set-buffer buffer)) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
577 (when minor-mode-alist |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
578 (princ "The major mode is described first. |
39728
570d86d34c32
Don't require `view' when compiling.
Miles Bader <miles@gnu.org>
parents:
39659
diff
changeset
|
579 For minor modes, see following pages.\n\n")) |
42679
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
580 (princ mode-name) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
581 (princ " mode:\n") |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
582 (princ (documentation major-mode)) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
583 (let ((minor-modes minor-mode-alist)) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
584 (while minor-modes |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
585 (let* ((minor-mode (car (car minor-modes))) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
586 (indicator (car (cdr (car minor-modes))))) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
587 ;; Document a minor mode if it is listed in minor-mode-alist, |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
588 ;; bound locally in this buffer, non-nil, and has a function |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
589 ;; definition. |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
590 (if (and (boundp minor-mode) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
591 (symbol-value minor-mode) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
592 (fboundp minor-mode)) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
593 (let ((pretty-minor-mode minor-mode)) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
594 (if (string-match "\\(-minor\\)?-mode\\'" |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
595 (symbol-name minor-mode)) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
596 (setq pretty-minor-mode |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
597 (capitalize |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
598 (substring (symbol-name minor-mode) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
599 0 (match-beginning 0))))) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
600 (while (and indicator (symbolp indicator) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
601 (boundp indicator) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
602 (not (eq indicator (symbol-value indicator)))) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
603 (setq indicator (symbol-value indicator))) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
604 (princ "\n\f\n") |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
605 (princ (format "%s minor mode (%s):\n" |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
606 pretty-minor-mode |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
607 (if indicator |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
608 (format "indicator%s" indicator) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
609 "no indicator"))) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
610 (princ (documentation minor-mode))))) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
611 (setq minor-modes (cdr minor-modes)))) |
8e00fb340b95
(describe-mode): Call help-setup-xref in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
42357
diff
changeset
|
612 (print-help-return-message)))) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
613 |
50353
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
614 (defun describe-minor-mode (minor-mode) |
50565
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
615 "Display documentation of a minor mode given as MINOR-MODE. |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
616 MINOR-MODE can be a minor mode symbol or a minor mode indicator string |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
617 appeared on the mode-line." |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
618 (interactive (list (completing-read |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
619 "Minor mode: " |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
620 (nconc |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
621 (describe-minor-mode-completion-table-for-symbol) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
622 (describe-minor-mode-completion-table-for-indicator) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
623 )))) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
624 (if (symbolp minor-mode) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
625 (setq minor-mode (symbol-name minor-mode))) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
626 (let ((symbols (describe-minor-mode-completion-table-for-symbol)) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
627 (indicators (describe-minor-mode-completion-table-for-indicator))) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
628 (cond |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
629 ((member minor-mode symbols) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
630 (describe-minor-mode-from-symbol (intern minor-mode))) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
631 ((member minor-mode indicators) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
632 (describe-minor-mode-from-indicator minor-mode)) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
633 (t |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
634 (error "No such minor mode: %s" minor-mode))))) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
635 |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
636 ;; symbol |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
637 (defun describe-minor-mode-completion-table-for-symbol () |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
638 ;; In order to list up all minor modes, minor-mode-list |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
639 ;; is used here instead of minor-mode-alist. |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
640 (delq nil (mapcar 'symbol-name minor-mode-list))) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
641 (defun describe-minor-mode-from-symbol (symbol) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
642 "Display documentation of a minor mode given as a symbol, SYMBOL" |
50353
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
643 (interactive (list (intern (completing-read |
50565
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
644 "Minor mode symbol: " |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
645 (describe-minor-mode-completion-table-for-symbol))))) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
646 (if (fboundp symbol) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
647 (describe-function symbol) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
648 (describe-variable symbol))) |
50353
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
649 |
50565
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
650 ;; indicator |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
651 (defun describe-minor-mode-completion-table-for-indicator () |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
652 (delq nil |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
653 (mapcar (lambda (x) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
654 (let ((i (format-mode-line x))) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
655 ;; remove first space if existed |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
656 (cond |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
657 ((= 0 (length i)) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
658 nil) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
659 ((eq (aref i 0) ?\ ) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
660 (substring i 1)) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
661 (t |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
662 i)))) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
663 minor-mode-alist))) |
50353
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
664 (defun describe-minor-mode-from-indicator (indicator) |
50565
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
665 "Display documentation of a minor mode specified by INDICATOR. |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
666 If you call this function interactively, you can give indicator which |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
667 is currently activated with completion." |
50353
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
668 (interactive (list |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
669 (completing-read |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
670 "Minor mode indicator: " |
50565
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
671 (describe-minor-mode-completion-table-for-indicator)))) |
50353
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
672 (let ((minor-mode (lookup-minor-mode-from-indicator indicator))) |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
673 (if minor-mode |
50565
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
674 (describe-minor-mode-from-symbol minor-mode) |
50353
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
675 (error "Cannot find minor mode for `%s'" indicator)))) |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
676 |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
677 (defun lookup-minor-mode-from-indicator (indicator) |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
678 "Return a minor mode symbol from its indicator on the modeline." |
50565
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
679 ;; remove first space if existed |
50353
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
680 (if (and (< 0 (length indicator)) |
50565
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
681 (eq (aref indicator 0) ?\ )) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
682 (setq indicator (substring indicator 1))) |
50353
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
683 (let ((minor-modes minor-mode-alist) |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
684 result) |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
685 (while minor-modes |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
686 (let* ((minor-mode (car (car minor-modes))) |
50565
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
687 (anindicator (format-mode-line |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
688 (car (cdr (car minor-modes)))))) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
689 ;; remove first space if existed |
50353
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
690 (if (and (stringp anindicator) |
50565
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
691 (> (length anindicator) 0) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
692 (eq (aref anindicator 0) ?\ )) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
693 (setq anindicator (substring anindicator 1))) |
cd863af50ea1
* help.el (describe-minor-mode): New function implementation.
Masatake YAMATO <jet@gyve.org>
parents:
50353
diff
changeset
|
694 (if (equal indicator anindicator) |
50353
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
695 (setq result minor-mode |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
696 minor-modes nil) |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
697 (setq minor-modes (cdr minor-modes))))) |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
698 result)) |
e5761fbf195f
(describe-minor-mode, describe-minor-mode-from-indicator,
Juanma Barranquero <lekktu@gmail.com>
parents:
49757
diff
changeset
|
699 |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
700 |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
701 ;;; Automatic resizing of temporary buffers. |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
702 |
23749
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
703 (defcustom temp-buffer-max-height (lambda (buffer) (/ (- (frame-height) 2) 2)) |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
704 "*Maximum height of a window displaying a temporary buffer. |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
705 This is the maximum height (in text lines) which `resize-temp-buffer-window' |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
706 will give to a window displaying a temporary buffer. |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
707 It can also be a function which will be called with the object corresponding |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
708 to the buffer to be displayed as argument and should return an integer |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
709 positive number." |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
710 :type '(choice integer function) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
711 :group 'help |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
712 :version "20.4") |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
713 |
32183
3e4bdf7c90c4
(help-xref-on-pp): Use match-string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31491
diff
changeset
|
714 (define-minor-mode temp-buffer-resize-mode |
3e4bdf7c90c4
(help-xref-on-pp): Use match-string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31491
diff
changeset
|
715 "Toggle the mode which makes windows smaller for temporary buffers. |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
716 With prefix argument ARG, turn the resizing of windows displaying temporary |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
717 buffers on if ARG is positive or off otherwise. |
32183
3e4bdf7c90c4
(help-xref-on-pp): Use match-string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31491
diff
changeset
|
718 This makes the window the right height for its contents, but never |
3e4bdf7c90c4
(help-xref-on-pp): Use match-string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31491
diff
changeset
|
719 more than `temp-buffer-max-height' nor less than `window-min-height'. |
3e4bdf7c90c4
(help-xref-on-pp): Use match-string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31491
diff
changeset
|
720 This applies to `help', `apropos' and `completion' buffers, and some others." |
39659
4bd383bb2137
(help-mode): Use define-derived-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39651
diff
changeset
|
721 :global t :group 'help |
32183
3e4bdf7c90c4
(help-xref-on-pp): Use match-string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31491
diff
changeset
|
722 (if temp-buffer-resize-mode |
36249 | 723 ;; `help-make-xrefs' may add a `back' button and thus increase the |
32183
3e4bdf7c90c4
(help-xref-on-pp): Use match-string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31491
diff
changeset
|
724 ;; text size, so `resize-temp-buffer-window' must be run *after* it. |
3e4bdf7c90c4
(help-xref-on-pp): Use match-string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31491
diff
changeset
|
725 (add-hook 'temp-buffer-show-hook 'resize-temp-buffer-window 'append) |
32184 | 726 (remove-hook 'temp-buffer-show-hook 'resize-temp-buffer-window))) |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
727 |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
728 (defun resize-temp-buffer-window () |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
729 "Resize the current window to fit its contents. |
23749
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
730 Will not make it higher than `temp-buffer-max-height' nor smaller than |
24079
11e777f59a1f
(help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents:
24055
diff
changeset
|
731 `window-min-height'. Do nothing if it is the only window on its frame, if it |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
732 is not as wide as the frame or if some of the window's contents are scrolled |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
733 out of view." |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
734 (unless (or (one-window-p 'nomini) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
735 (not (pos-visible-in-window-p (point-min))) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
736 (/= (frame-width) (window-width))) |
32706
605eabd04a57
(resize-temp-buffer-window): Use `fit-window-to-buffer'.
Miles Bader <miles@gnu.org>
parents:
32690
diff
changeset
|
737 (fit-window-to-buffer |
605eabd04a57
(resize-temp-buffer-window): Use `fit-window-to-buffer'.
Miles Bader <miles@gnu.org>
parents:
32690
diff
changeset
|
738 (selected-window) |
605eabd04a57
(resize-temp-buffer-window): Use `fit-window-to-buffer'.
Miles Bader <miles@gnu.org>
parents:
32690
diff
changeset
|
739 (if (functionp temp-buffer-max-height) |
605eabd04a57
(resize-temp-buffer-window): Use `fit-window-to-buffer'.
Miles Bader <miles@gnu.org>
parents:
32690
diff
changeset
|
740 (funcall temp-buffer-max-height (current-buffer)) |
605eabd04a57
(resize-temp-buffer-window): Use `fit-window-to-buffer'.
Miles Bader <miles@gnu.org>
parents:
32690
diff
changeset
|
741 temp-buffer-max-height)))) |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
742 |
32540
4150b1424eb9
Provide `help' for the sake of define-minor-mode
Gerd Moellmann <gerd@gnu.org>
parents:
32184
diff
changeset
|
743 ;; Provide this for the sake of define-minor-mode which generates |
4150b1424eb9
Provide `help' for the sake of define-minor-mode
Gerd Moellmann <gerd@gnu.org>
parents:
32184
diff
changeset
|
744 ;; defcustoms which require 'help'. |
4150b1424eb9
Provide `help' for the sake of define-minor-mode
Gerd Moellmann <gerd@gnu.org>
parents:
32184
diff
changeset
|
745 (provide 'help) |
4150b1424eb9
Provide `help' for the sake of define-minor-mode
Gerd Moellmann <gerd@gnu.org>
parents:
32184
diff
changeset
|
746 |
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
747 ;;; help.el ends here |