annotate lisp/help.el @ 15714:58e638890a20

Test HAVE_TERMIOS rather than the automatically-generated HAVE_TERMIOS_H, in case <termios.h> is present but unusable.
author Karl Heuer <kwzh@gnu.org>
date Tue, 16 Jul 1996 09:03:24 +0000
parents 4d511dd9bfce
children e0524a01fc91
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
7298
4fd40bd394fe Update copyright.
Karl Heuer <kwzh@gnu.org>
parents: 6903
diff changeset
3 ;; Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
846
20674ae6bf52 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 811
diff changeset
4
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 755
diff changeset
5 ;; Maintainer: FSF
811
e694e0879463 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 807
diff changeset
6 ;; Keywords: help, internal
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 755
diff changeset
7
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 ;; This file is part of GNU Emacs.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; 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
12 ;; the Free Software Foundation; either version 2, or (at your option)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 ;; any later version.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 ;; GNU Emacs is distributed in the hope that it will be useful,
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; GNU General Public License for more details.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 13358
diff changeset
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 13358
diff changeset
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 13358
diff changeset
23 ;; Boston, MA 02111-1307, USA.
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24
2315
9e7ec92a4fdf Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2312
diff changeset
25 ;;; Commentary:
9e7ec92a4fdf Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2312
diff changeset
26
9e7ec92a4fdf Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2312
diff changeset
27 ;; This code implements GNU Emac's on-line help system, the one invoked by
9e7ec92a4fdf Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2312
diff changeset
28 ;;`M-x help-for-help'.
9e7ec92a4fdf Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2312
diff changeset
29
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 755
diff changeset
30 ;;; Code:
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 755
diff changeset
31
2312
ad7b89a430df Don't load help-screen at run time if compiled.
Richard M. Stallman <rms@gnu.org>
parents: 2237
diff changeset
32 ;; 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
33 ;; 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
34 (eval-when-compile (require 'help-macro))
2237
2670a8f6a42e Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2134
diff changeset
35
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 (defvar help-map (make-sparse-keymap)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 "Keymap for characters following the Help key.")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38
9833
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
39 (defvar help-mode-map (make-sparse-keymap)
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
40 "Keymap for help mode.")
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
41
919
567b06901789 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 918
diff changeset
42 (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
43 (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
44 (define-key global-map [f1] 'help-command)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 (fset 'help-command help-map)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46
919
567b06901789 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 918
diff changeset
47 (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
48 (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
49 (define-key help-map [f1] 'help-for-help)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 (define-key help-map "?" 'help-for-help)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 (define-key help-map "\C-c" 'describe-copying)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 (define-key help-map "\C-d" 'describe-distribution)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 (define-key help-map "\C-w" 'describe-no-warranty)
5025
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
55 (define-key help-map "\C-p" 'describe-project)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 (define-key help-map "a" 'command-apropos)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 (define-key help-map "b" 'describe-bindings)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 (define-key help-map "c" 'describe-key-briefly)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 (define-key help-map "k" 'describe-key)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 (define-key help-map "d" 'describe-function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 (define-key help-map "f" 'describe-function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65
10923
fe008aef4cf1 (view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents: 10622
diff changeset
66 (define-key help-map "F" 'view-emacs-FAQ)
fe008aef4cf1 (view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents: 10622
diff changeset
67
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 (define-key help-map "i" 'info)
732
a8d94735277e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 660
diff changeset
69 (define-key help-map "\C-f" 'Info-goto-emacs-command-node)
a8d94735277e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 660
diff changeset
70 (define-key help-map "\C-k" 'Info-goto-emacs-key-command-node)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 (define-key help-map "l" 'view-lossage)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 (define-key help-map "m" 'describe-mode)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 (define-key help-map "\C-n" 'view-emacs-news)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 (define-key help-map "n" 'view-emacs-news)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78
2134
b275e1b50542 Added autoload, binding and menu line for new finder feature (P).
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2079
diff changeset
79 (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
80 (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
81 "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
82
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83 (define-key help-map "s" 'describe-syntax)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85 (define-key help-map "t" 'help-with-tutorial)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87 (define-key help-map "w" 'where-is)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
89 (define-key help-map "v" 'describe-variable)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
90
6580
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
91 (define-key help-map "q" 'help-quit)
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
92
12816
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
93 (defvar help-font-lock-keywords
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
94 (let ((name-char "[-+a-zA-Z0-9_*]") (sym-char "[-+a-zA-Z0-9_:*]"))
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
95 (list
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
96 ;;
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
97 ;; The symbol itself.
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
98 (list (concat "\\`\\(" name-char "+\\)\\(:\\)?")
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
99 '(1 (if (match-beginning 2)
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
100 font-lock-function-name-face
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
101 font-lock-variable-name-face)
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
102 nil t))
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
103 ;;
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
104 ;; Words inside `' which tend to be symbol names.
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
105 (list (concat "`\\(" sym-char sym-char "+\\)'")
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
106 1 'font-lock-reference-face t)
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
107 ;;
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
108 ;; CLisp `:' keywords as references.
12834
40ed89c082fd Insert missing quote in help-font-lock-keywords.
Simon Marshall <simon@gnu.org>
parents: 12816
diff changeset
109 (list (concat "\\<:" sym-char "+\\>") 0 'font-lock-reference-face t)))
12816
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
110 "Default expressions to highlight in Help mode.")
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
111
9833
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
112 (defun help-mode ()
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
113 "Major mode for viewing help text.
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
114 Entry to this mode runs the normal hook `help-mode-hook'.
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
115 Commands:
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
116 \\{help-mode-map}"
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
117 (interactive)
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
118 (kill-all-local-variables)
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
119 (use-local-map help-mode-map)
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
120 (setq mode-name "Help")
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
121 (setq major-mode 'help-mode)
12816
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
122 (make-local-variable 'font-lock-defaults)
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
123 (setq font-lock-defaults '(help-font-lock-keywords))
13079
6a91723f2a8c (help-mode): Call view-mode.
Richard M. Stallman <rms@gnu.org>
parents: 12941
diff changeset
124 (view-mode)
9833
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
125 (run-hooks 'help-mode-hook))
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
126
6580
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
127 (defun help-quit ()
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
128 (interactive)
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
129 nil)
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
130
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
131 (defun help-with-tutorial ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
132 "Select the Emacs learn-by-doing tutorial."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
133 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134 (let ((file (expand-file-name "~/TUTORIAL")))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135 (delete-other-windows)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
136 (if (get-file-buffer file)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137 (switch-to-buffer (get-file-buffer file))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138 (switch-to-buffer (create-file-buffer file))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139 (setq buffer-file-name file)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140 (setq default-directory (expand-file-name "~/"))
755
e43123226372 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 732
diff changeset
141 (setq buffer-auto-save-file-name nil)
444
4cec2e6d4f9e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 409
diff changeset
142 (insert-file-contents (expand-file-name "TUTORIAL" data-directory))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143 (goto-char (point-min))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144 (search-forward "\n<<")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145 (beginning-of-line)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146 (delete-region (point) (progn (end-of-line) (point)))
6419
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
147 (let ((n (- (window-height (selected-window))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
148 (count-lines (point-min) (point))
6419
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
149 6)))
6433
e50519261181 (help-with-tutorial): Change previous change;
Richard M. Stallman <rms@gnu.org>
parents: 6419
diff changeset
150 (if (< n 12)
6419
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
151 (newline n)
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
152 ;; Some people get confused by the large gap.
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
153 (newline (/ n 2))
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
154 (insert "[Middle of page left blank for didactic purposes. "
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
155 "Text continues below]")
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
156 (newline (- n (/ n 2)))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
157 (goto-char (point-min))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
158 (set-buffer-modified-p nil))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
159
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
160 (defun describe-key-briefly (key)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
161 "Print the name of the function KEY invokes. KEY is a string."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
162 (interactive "kDescribe key briefly: ")
2955
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
163 ;; If this key seq ends with a down event, discard the
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
164 ;; following click or drag event. Otherwise that would
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
165 ;; erase the message.
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
166 (let ((type (aref key (1- (length key)))))
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
167 (if (listp type) (setq type (car type)))
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
168 (and (symbolp type)
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
169 (memq 'down (event-modifiers type))
3986
0e5fa7a1ac36 (describe-key-briefly): Don't set `foo'.
Richard M. Stallman <rms@gnu.org>
parents: 3982
diff changeset
170 (read-event)))
13293
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
171 (save-excursion
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
172 (let ((modifiers (event-modifiers (aref key 0)))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
173 window position)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
174 ;; For a mouse button event, go to the button it applies to
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
175 ;; to get the right key bindings. And go to the right place
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
176 ;; in case the keymap depends on where you clicked.
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
177 (if (or (memq 'click modifiers) (memq 'down modifiers)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
178 (memq 'drag modifiers))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
179 (setq window (posn-window (event-start (aref key 0)))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
180 position (posn-point (event-start (aref key 0)))))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
181 (if (windowp window)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
182 (progn
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
183 (set-buffer (window-buffer window))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
184 (goto-char position)))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
185 ;; Ok, now look up the key and name the command.
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
186 (let ((defn (key-binding key)))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
187 (if (or (null defn) (integerp defn))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
188 (message "%s is undefined" (key-description key))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
189 (message (if (windowp window)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
190 "%s at that spot runs the command %s"
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
191 "%s runs the command %s")
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
192 (key-description key)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
193 (if (symbolp defn) defn (prin1-to-string defn))))))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195 (defun print-help-return-message (&optional function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
196 "Display or return message saying how to restore windows after help command.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
197 Computes a message and applies the optional argument FUNCTION to it.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
198 If FUNCTION is nil, applies `message' to it, thus printing it."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
199 (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
200 (let ((first-message
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
201 (cond ((or (member (buffer-name standard-output)
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
202 special-display-buffer-names)
8992
245187067d35 (print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents: 8858
diff changeset
203 (assoc (buffer-name standard-output)
245187067d35 (print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents: 8858
diff changeset
204 special-display-buffer-names)
8259
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
205 (let (found
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
206 (tail special-display-regexps)
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
207 (name (buffer-name standard-output)))
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
208 (while (and tail (not found))
9833
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
209 (if (or (and (consp (car tail))
8992
245187067d35 (print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents: 8858
diff changeset
210 (string-match (car (car tail)) name))
245187067d35 (print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents: 8858
diff changeset
211 (and (stringp (car tail))
245187067d35 (print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents: 8858
diff changeset
212 (string-match (car tail) name)))
8259
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
213 (setq found t))
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
214 (setq tail (cdr tail)))
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
215 found))
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
216 ;; 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
217 ;; 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
218 ;; 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
219 ;; manager, not with Emacs.
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
220 ;; 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
221 ;; 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
222 ;; Even the message about scrolling the help
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
223 ;; might be wrong, but it seems worth showing it anyway.
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
224 nil)
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
225 ((not (one-window-p t))
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
226 "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
227 (pop-up-windows
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
228 "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
229 (t
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
230 "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
231 (funcall (or function 'message)
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
232 (concat
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
233 (if first-message
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
234 (substitute-command-keys first-message)
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
235 "")
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
236 (if first-message " " "")
11524
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
237 ;; 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
238 ;; it's no use mentioning a command to scroll, so don't.
11428
d39d8e8b6d20 (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 10923
diff changeset
239 (if (or (member (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
240 special-display-buffer-names)
13099
5ab611596c38 (print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents: 13079
diff changeset
241 (assoc (buffer-name standard-output)
5ab611596c38 (print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents: 13079
diff changeset
242 special-display-buffer-names)
11428
d39d8e8b6d20 (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 10923
diff changeset
243 (memq t (mapcar '(lambda (elt)
13099
5ab611596c38 (print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents: 13079
diff changeset
244 (if (consp elt)
5ab611596c38 (print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents: 13079
diff changeset
245 (setq elt (car elt)))
11428
d39d8e8b6d20 (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 10923
diff changeset
246 (string-match elt (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
247 special-display-regexps)))
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
248 nil
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
249 (if (or (member (buffer-name standard-output)
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
250 same-window-buffer-names)
13099
5ab611596c38 (print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents: 13079
diff changeset
251 (assoc (buffer-name standard-output)
5ab611596c38 (print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents: 13079
diff changeset
252 same-window-buffer-names)
11524
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
253 (memq t (mapcar '(lambda (elt)
13099
5ab611596c38 (print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents: 13079
diff changeset
254 (if (consp elt)
5ab611596c38 (print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents: 13079
diff changeset
255 (setq elt (car elt)))
11524
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
256 (string-match elt (buffer-name standard-output)))
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
257 same-window-regexps)))
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
258 ;; 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
259 (substitute-command-keys
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
260 "\\[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
261 ;; 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
262 (substitute-command-keys
11524
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
263 "\\[scroll-other-window] to scroll the help."))))))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
264
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
265 (defun describe-key (key)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
266 "Display documentation of the function invoked by KEY. KEY is a string."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
267 (interactive "kDescribe key: ")
2955
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
268 ;; If this key seq ends with a down event, discard the
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
269 ;; following click or drag event. Otherwise that would
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
270 ;; erase the message.
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
271 (let ((type (aref key (1- (length key)))))
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
272 (if (listp type) (setq type (car type)))
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
273 (and (symbolp type)
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
274 (memq 'down (event-modifiers type))
f34f9e634b81 (describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents: 2697
diff changeset
275 (read-event)))
13293
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
276 (save-excursion
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
277 (let ((modifiers (event-modifiers (aref key 0)))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
278 window position)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
279 ;; For a mouse button event, go to the button it applies to
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
280 ;; to get the right key bindings. And go to the right place
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
281 ;; in case the keymap depends on where you clicked.
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
282 (if (or (memq 'click modifiers) (memq 'down modifiers)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
283 (memq 'drag modifiers))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
284 (setq window (posn-window (event-start (aref key 0)))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
285 position (posn-point (event-start (aref key 0)))))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
286 (if (windowp window)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
287 (progn
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
288 (set-buffer (window-buffer window))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
289 (goto-char position)))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
290 (let ((defn (key-binding key)))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
291 (if (or (null defn) (integerp defn))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
292 (message "%s is undefined" (key-description key))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
293 (with-output-to-temp-buffer "*Help*"
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
294 (princ (key-description key))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
295 (if (windowp window)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
296 (princ " at that spot"))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
297 (princ " runs the command ")
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
298 (prin1 defn)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
299 (princ ":\n")
13358
febf5ce4532c (describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents: 13348
diff changeset
300 (let ((doc (documentation defn)))
febf5ce4532c (describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents: 13348
diff changeset
301 (if doc
febf5ce4532c (describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents: 13348
diff changeset
302 (progn (terpri)
febf5ce4532c (describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents: 13348
diff changeset
303 (princ doc))
febf5ce4532c (describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents: 13348
diff changeset
304 (princ "not documented")))
13293
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
305 (save-excursion
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
306 (set-buffer standard-output)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
307 (help-mode))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
308 (print-help-return-message)))))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
309
6902
962a6ffb7b97 (describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents: 6580
diff changeset
310 (defun describe-mode ()
962a6ffb7b97 (describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents: 6580
diff changeset
311 "Display documentation of current major mode and minor modes.
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
312 For this to work correctly for a minor mode, the mode's indicator variable
3980
bf2d4294a1dd (describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents: 3145
diff changeset
313 \(listed in `minor-mode-alist') must also be a function whose documentation
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
314 describes the minor mode."
6903
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
315 (interactive)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
316 (with-output-to-temp-buffer "*Help*"
6903
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
317 (let ((minor-modes minor-mode-alist)
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
318 (locals (buffer-local-variables)))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
319 (while minor-modes
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
320 (let* ((minor-mode (car (car minor-modes)))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
321 (indicator (car (cdr (car minor-modes))))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
322 (local-binding (assq minor-mode locals)))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
323 ;; Document a minor mode if it is listed in minor-mode-alist,
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
324 ;; bound locally in this buffer, non-nil, and has a function
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
325 ;; definition.
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
326 (if (and local-binding
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
327 (cdr local-binding)
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
328 (fboundp minor-mode))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
329 (let ((pretty-minor-mode minor-mode))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
330 (if (string-match "-mode$" (symbol-name minor-mode))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
331 (setq pretty-minor-mode
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
332 (capitalize
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
333 (substring (symbol-name minor-mode)
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
334 0 (match-beginning 0)))))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
335 (while (and indicator (symbolp indicator))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
336 (setq indicator (symbol-value indicator)))
14832
4d511dd9bfce (describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
337 (princ (format "%s minor mode (%s):\n"
4d511dd9bfce (describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
338 pretty-minor-mode
4d511dd9bfce (describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
339 (if indicator
4d511dd9bfce (describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
340 (format "indicator%s" indicator)
4d511dd9bfce (describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
341 "no indicator")))
6903
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
342 (princ (documentation minor-mode))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
343 (princ "\n\n"))))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
344 (setq minor-modes (cdr minor-modes))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
345 (princ mode-name)
6902
962a6ffb7b97 (describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents: 6580
diff changeset
346 (princ " mode:\n")
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
347 (princ (documentation major-mode))
9854
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
348 (save-excursion
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
349 (set-buffer standard-output)
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
350 (help-mode))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
351 (print-help-return-message)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
352
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
353 ;; So keyboard macro definitions are documented correctly
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
354 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
355
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
356 (defun describe-distribution ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
357 "Display info on how to obtain the latest version of GNU Emacs."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
358 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
359 (find-file-read-only
444
4cec2e6d4f9e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 409
diff changeset
360 (expand-file-name "DISTRIB" data-directory)))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
361
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
362 (defun describe-copying ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
363 "Display info on how you may redistribute copies of GNU Emacs."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
364 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
365 (find-file-read-only
444
4cec2e6d4f9e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 409
diff changeset
366 (expand-file-name "COPYING" data-directory))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
367 (goto-char (point-min)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
368
5025
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
369 (defun describe-project ()
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
370 "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
371 (interactive)
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
372 (find-file-read-only
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
373 (expand-file-name "GNU" data-directory))
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
374 (goto-char (point-min)))
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
375
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
376 (defun describe-no-warranty ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
377 "Display info on all the kinds of warranty Emacs does NOT have."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
378 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
379 (describe-copying)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
380 (let (case-fold-search)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
381 (search-forward "NO WARRANTY")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382 (recenter 0)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
383
3980
bf2d4294a1dd (describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents: 3145
diff changeset
384 (defun describe-prefix-bindings ()
3982
e50f7b531c7f (describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 3980
diff changeset
385 "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
386 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
387 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
388 (interactive)
11890
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
389 (let* ((key (this-command-keys)))
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
390 (describe-bindings
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
391 (if (stringp key)
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
392 (substring key 0 (1- (length key)))
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
393 (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
394 (i 0))
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
395 (while (< i (length prefix))
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
396 (aset prefix i (aref key i))
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
397 (setq i (1+ i)))
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
398 prefix)))))
3982
e50f7b531c7f (describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 3980
diff changeset
399 ;; Make C-h after a prefix, when not specifically bound,
e50f7b531c7f (describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 3980
diff changeset
400 ;; run describe-prefix-bindings.
3980
bf2d4294a1dd (describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents: 3145
diff changeset
401 (setq prefix-help-command 'describe-prefix-bindings)
bf2d4294a1dd (describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents: 3145
diff changeset
402
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403 (defun view-emacs-news ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
404 "Display info on recent changes to Emacs."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405 (interactive)
444
4cec2e6d4f9e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 409
diff changeset
406 (find-file-read-only (expand-file-name "NEWS" data-directory)))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
407
10923
fe008aef4cf1 (view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents: 10622
diff changeset
408 (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
409 "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
410 (interactive)
fe008aef4cf1 (view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents: 10622
diff changeset
411 (find-file-read-only (expand-file-name "FAQ" data-directory)))
fe008aef4cf1 (view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents: 10622
diff changeset
412
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413 (defun view-lossage ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
414 "Display last 100 input keystrokes."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
415 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
416 (with-output-to-temp-buffer "*Help*"
8504
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
417 (princ (mapconcat (function (lambda (key)
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
418 (if (or (integerp key)
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
419 (symbolp key)
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
420 (listp key))
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
421 (single-key-description key)
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
422 (prin1-to-string key nil))))
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
423 (recent-keys)
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
424 " "))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
425 (save-excursion
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
426 (set-buffer standard-output)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
427 (goto-char (point-min))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
428 (while (progn (move-to-column 50) (not (eobp)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
429 (search-forward " " nil t)
9854
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
430 (insert "\n"))
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
431 (help-mode))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
432 (print-help-return-message)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
433
6580
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
434 (defalias 'help 'help-for-help)
2237
2670a8f6a42e Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2134
diff changeset
435 (make-help-screen help-for-help
5680
4428fd0336f3 (help-for-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 5380
diff changeset
436 "a b c f C-f i k C-k l m n p s t v w C-c C-d C-n C-w, or ? for more help:"
5025
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
437 "You have typed \\[help-command], the help character. Type a Help option:
10479
f2f290b13413 (help-for-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 10196
diff changeset
438 \(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
439
4467
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
440 a command-apropos. Give a substring, and see a list of commands
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
441 (functions interactively callable) that contain
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
442 that substring. See also the apropos command.
2638
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
443 b describe-bindings. Display table of all key bindings.
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
444 c describe-key-briefly. Type a command key sequence;
4467
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
445 it prints the function name that sequence runs.
2638
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
446 f describe-function. Type a function name and get documentation of it.
4467
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
447 C-f Info-goto-emacs-command-node. Type a function name;
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
448 it takes you to the Info node for that command.
10923
fe008aef4cf1 (view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents: 10622
diff changeset
449 F view-emacs-FAQ. Shows emacs frequently asked questions file.
2638
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
450 i info. The info documentation reader.
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
451 k describe-key. Type a command key sequence;
4467
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
452 it displays the full documentation.
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
453 C-k Info-goto-emacs-key-command-node. Type a command key sequence;
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
454 it takes you to the Info node for the command bound to that key.
2638
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
455 l view-lossage. Shows last 100 characters you typed.
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
456 m describe-mode. Print documentation of current major mode,
4467
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
457 which describes the commands peculiar to it.
2638
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
458 n view-emacs-news. Shows emacs news file.
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
459 p finder-by-keyword. Find packages matching a given topic keyword.
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
460 s describe-syntax. Display contents of syntax table, plus explanations
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
461 t help-with-tutorial. Select the Emacs learn-by-doing tutorial.
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
462 v describe-variable. Type name of a variable;
4467
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
463 it displays the variable's documentation and value.
2638
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
464 w where-is. Type command name; it prints which keystrokes
4467
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
465 invoke that command.
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
466 C-c print Emacs copying permission (General Public License).
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
467 C-d print Emacs ordering information.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
468 C-n print news of recent Emacs changes.
5025
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
469 C-p print information about the GNU project.
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
470 C-w print information on absence of warranty for GNU Emacs."
2237
2670a8f6a42e Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2134
diff changeset
471 help-map)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
472
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
473 ;; Return a function which is called by the list containing point.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
474 ;; If that gives no function, return a function whose name is around point.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
475 ;; If that doesn't give a function, return nil.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
476 (defun function-called-at-point ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
477 (or (condition-case ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
478 (save-excursion
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
479 (save-restriction
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
480 (narrow-to-region (max (point-min) (- (point) 1000)) (point-max))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
481 (backward-up-list 1)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
482 (forward-char 1)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
483 (let (obj)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
484 (setq obj (read (current-buffer)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
485 (and (symbolp obj) (fboundp obj) obj))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
486 (error nil))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
487 (condition-case ()
13209
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
488 (let ((stab (syntax-table)))
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
489 (unwind-protect
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
490 (save-excursion
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
491 (set-syntax-table emacs-lisp-mode-syntax-table)
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
492 (or (not (zerop (skip-syntax-backward "_w")))
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
493 (eq (char-syntax (following-char)) ?w)
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
494 (eq (char-syntax (following-char)) ?_)
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
495 (forward-sexp -1))
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
496 (skip-chars-forward "'")
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
497 (let ((obj (read (current-buffer))))
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
498 (and (symbolp obj) (fboundp obj) obj)))
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
499 (set-syntax-table stab)))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
500 (error nil))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
501
9639
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
502 (defun describe-function-find-file (function)
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
503 (let ((files load-history)
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
504 file functions)
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
505 (while files
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
506 (if (memq function (cdr (car files)))
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
507 (setq file (car (car files)) files nil))
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
508 (setq files (cdr files)))
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
509 file))
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
510
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
511 (defun describe-function (function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
512 "Display the full documentation of FUNCTION (a symbol)."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513 (interactive
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
514 (let ((fn (function-called-at-point))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
515 (enable-recursive-minibuffers t)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
516 val)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
517 (setq val (completing-read (if fn
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
518 (format "Describe function (default %s): " fn)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
519 "Describe function: ")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
520 obarray 'fboundp t))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
521 (list (if (equal val "")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
522 fn (intern val)))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
523 (with-output-to-temp-buffer "*Help*"
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
524 (prin1 function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
525 (princ ": ")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
526 (let* ((def (symbol-function function))
12941
0c332255735f (describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents: 12834
diff changeset
527 file-name
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
528 (beg (if (commandp def) "an interactive " "a ")))
2440
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
529 (princ (cond ((or (stringp def)
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
530 (vectorp def))
9638
e77a0d87d792 (describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents: 9161
diff changeset
531 "a keyboard macro")
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
532 ((subrp def)
9638
e77a0d87d792 (describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents: 9161
diff changeset
533 (concat beg "built-in function"))
1821
04fb1d3d6992 JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents: 1467
diff changeset
534 ((byte-code-function-p def)
9638
e77a0d87d792 (describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents: 9161
diff changeset
535 (concat beg "compiled Lisp function"))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536 ((symbolp def)
9638
e77a0d87d792 (describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents: 9161
diff changeset
537 (format "alias for `%s'" def))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
538 ((eq (car-safe def) 'lambda)
9638
e77a0d87d792 (describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents: 9161
diff changeset
539 (concat beg "Lisp function"))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540 ((eq (car-safe def) 'macro)
9638
e77a0d87d792 (describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents: 9161
diff changeset
541 "a Lisp macro")
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542 ((eq (car-safe def) 'mocklisp)
9638
e77a0d87d792 (describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents: 9161
diff changeset
543 "a mocklisp function")
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544 ((eq (car-safe def) 'autoload)
12941
0c332255735f (describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents: 12834
diff changeset
545 (setq file-name (nth 1 def))
9638
e77a0d87d792 (describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents: 9161
diff changeset
546 (format "%s autoloaded Lisp %s"
1467
8d8c91b563ee (describe-function): Print `an autoloaded', not `a ...'.
Richard M. Stallman <rms@gnu.org>
parents: 919
diff changeset
547 (if (commandp def) "an interactive" "an")
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548 (if (nth 4 def) "macro" "function")
878
5b1c5b4286e7 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 846
diff changeset
549 ))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550 (t "")))
12941
0c332255735f (describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents: 12834
diff changeset
551 (or file-name
0c332255735f (describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents: 12834
diff changeset
552 (setq file-name (describe-function-find-file function)))
0c332255735f (describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents: 12834
diff changeset
553 (if file-name
0c332255735f (describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents: 12834
diff changeset
554 (progn
0c332255735f (describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents: 12834
diff changeset
555 (princ " in `")
0c332255735f (describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents: 12834
diff changeset
556 ;; We used to add .el to the file name,
0c332255735f (describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents: 12834
diff changeset
557 ;; but that's completely wrong when the user used load-file.
0c332255735f (describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents: 12834
diff changeset
558 (princ file-name)
0c332255735f (describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents: 12834
diff changeset
559 (princ "'")))
9638
e77a0d87d792 (describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents: 9161
diff changeset
560 (princ ".")
1889
1ed971f67bfd (describe-function): Print the arglist if the function is bytecode or a list.
Richard M. Stallman <rms@gnu.org>
parents: 1821
diff changeset
561 (terpri)
2440
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
562 (let ((arglist (cond ((byte-code-function-p def)
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
563 (car (append def nil)))
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
564 ((eq (car-safe def) 'lambda)
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
565 (nth 1 def))
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
566 (t t))))
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
567 (if (listp arglist)
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
568 (progn
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
569 (princ (cons function
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
570 (mapcar (lambda (arg)
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
571 (if (memq arg '(&optional &rest))
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
572 arg
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
573 (intern (upcase (symbol-name arg)))))
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
574 arglist)))
46fcbdb6cc3a (describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents: 2360
diff changeset
575 (terpri))))
13358
febf5ce4532c (describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents: 13348
diff changeset
576 (let ((doc (documentation function)))
febf5ce4532c (describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents: 13348
diff changeset
577 (if doc
febf5ce4532c (describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents: 13348
diff changeset
578 (progn (terpri)
febf5ce4532c (describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents: 13348
diff changeset
579 (princ doc))
febf5ce4532c (describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents: 13348
diff changeset
580 (princ "not documented"))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
581 (print-help-return-message)
9854
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
582 (save-excursion
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
583 (set-buffer standard-output)
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
584 (help-mode)
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
585 ;; Return the text we displayed.
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
586 (buffer-string))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
587
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
588 (defun variable-at-point ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
589 (condition-case ()
13209
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
590 (let ((stab (syntax-table)))
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
591 (unwind-protect
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
592 (save-excursion
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
593 (set-syntax-table emacs-lisp-mode-syntax-table)
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
594 (or (not (zerop (skip-syntax-backward "_w")))
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
595 (eq (char-syntax (following-char)) ?w)
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
596 (eq (char-syntax (following-char)) ?_)
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
597 (forward-sexp -1))
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
598 (skip-chars-forward "'")
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
599 (let ((obj (read (current-buffer))))
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
600 (and (symbolp obj) (boundp obj) obj)))
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
601 (set-syntax-table stab)))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
602 (error nil)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
603
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
604 (defun describe-variable (variable)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
605 "Display the full documentation of VARIABLE (a symbol).
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
606 Returns the documentation as a string, also."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
607 (interactive
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608 (let ((v (variable-at-point))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
609 (enable-recursive-minibuffers t)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
610 val)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
611 (setq val (completing-read (if v
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
612 (format "Describe variable (default %s): " v)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
613 "Describe variable: ")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
614 obarray 'boundp t))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
615 (list (if (equal val "")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
616 v (intern val)))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
617 (with-output-to-temp-buffer "*Help*"
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
618 (prin1 variable)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
619 (if (not (boundp variable))
10622
97213941b5e8 (describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents: 10573
diff changeset
620 (princ " is void")
97213941b5e8 (describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents: 10573
diff changeset
621 (princ "'s value is ")
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
622 (prin1 (symbol-value variable)))
8858
dff46e860b51 (describe-variable): Report whether var is local in this buf.
Richard M. Stallman <rms@gnu.org>
parents: 8504
diff changeset
623 (terpri)
10573
ab52927eddad (describe-variable): Use local-variable-p.
Richard M. Stallman <rms@gnu.org>
parents: 10479
diff changeset
624 (if (local-variable-p variable)
10622
97213941b5e8 (describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents: 10573
diff changeset
625 (progn
97213941b5e8 (describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents: 10573
diff changeset
626 (princ (format "Local in buffer %s; " (buffer-name)))
97213941b5e8 (describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents: 10573
diff changeset
627 (if (not (default-boundp variable))
97213941b5e8 (describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents: 10573
diff changeset
628 (princ "globally void")
97213941b5e8 (describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents: 10573
diff changeset
629 (princ "global value is ")
97213941b5e8 (describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents: 10573
diff changeset
630 (prin1 (default-value variable)))
97213941b5e8 (describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents: 10573
diff changeset
631 (terpri)))
8858
dff46e860b51 (describe-variable): Report whether var is local in this buf.
Richard M. Stallman <rms@gnu.org>
parents: 8504
diff changeset
632 (terpri)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
633 (princ "Documentation:")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
634 (terpri)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
635 (let ((doc (documentation-property variable 'variable-documentation)))
13348
1569ab66932d (describe-variable): Don't call substitute-command-keys.
Richard M. Stallman <rms@gnu.org>
parents: 13293
diff changeset
636 (princ (or doc "not documented as a variable.")))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
637 (print-help-return-message)
9854
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
638 (save-excursion
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
639 (set-buffer standard-output)
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
640 (help-mode)
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
641 ;; Return the text we displayed.
f810a558acf6 (describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents: 9833
diff changeset
642 (buffer-string))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
643
6476
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
644 (defun where-is (definition)
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
645 "Print message listing key sequences that invoke specified command.
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
646 Argument is a command definition, usually a symbol with a function definition."
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
647 (interactive
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
648 (let ((fn (function-called-at-point))
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
649 (enable-recursive-minibuffers t)
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
650 val)
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
651 (setq val (completing-read (if fn
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
652 (format "Where is command (default %s): " fn)
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
653 "Where is command: ")
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
654 obarray 'fboundp t))
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
655 (list (if (equal val "")
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
656 fn (intern val)))))
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
657 (let* ((keys (where-is-internal definition overriding-local-map nil nil))
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
658 (keys1 (mapconcat 'key-description keys ", ")))
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
659 (if (> (length keys1) 0)
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
660 (message "%s is on %s" definition keys1)
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
661 (message "%s is not on any key" definition)))
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
662 nil)
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
663
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
664 (defun locate-library (library &optional nosuffix)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
665 "Show the full path name of Emacs library LIBRARY.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
666 This command searches the directories in `load-path' like `M-x load-library'
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
667 to find the file that `M-x load-library RET LIBRARY RET' would load.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
668 Optional second arg NOSUFFIX non-nil means don't add suffixes `.elc' or `.el'
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
669 to the specified name LIBRARY (a la calling `load' instead of `load-library')."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
670 (interactive "sLocate library: ")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
671 (catch 'answer
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
672 (mapcar
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
673 '(lambda (dir)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
674 (mapcar
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
675 '(lambda (suf)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
676 (let ((try (expand-file-name (concat library suf) dir)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
677 (and (file-readable-p try)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
678 (null (file-directory-p try))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
679 (progn
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
680 (message "Library is file %s" try)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
681 (throw 'answer try)))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
682 (if nosuffix '("") '(".elc" ".el" ""))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
683 load-path)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
684 (message "No library %s in search path" library)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
685 nil))
660
08eb386dd0f3 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 444
diff changeset
686
08eb386dd0f3 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 444
diff changeset
687 ;;; help.el ends here