annotate lisp/help.el @ 1868:f84d4b4b53da

* s/usg5-4.h: #include "usg5-3.h", not "s-usg5-3.h".
author Jim Blandy <jimb@redhat.com>
date Sun, 14 Feb 1993 14:36:14 +0000
parents 04fb1d3d6992
children 1ed971f67bfd
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
846
20674ae6bf52 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 811
diff changeset
3 ;; Copyright (C) 1985, 1986 Free Software Foundation, Inc.
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
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; along with GNU Emacs; see the file COPYING. If not, write to
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 755
diff changeset
24 ;;; Code:
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 755
diff changeset
25
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 (defvar help-map (make-sparse-keymap)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 "Keymap for characters following the Help key.")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28
919
567b06901789 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 918
diff changeset
29 (define-key global-map (char-to-string help-char) 'help-command)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 (fset 'help-command help-map)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31
919
567b06901789 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 918
diff changeset
32 (define-key help-map (char-to-string help-char) 'help-for-help)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 (define-key help-map "?" 'help-for-help)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 (define-key help-map "\C-c" 'describe-copying)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 (define-key help-map "\C-d" 'describe-distribution)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 (define-key help-map "\C-w" 'describe-no-warranty)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 (define-key help-map "a" 'command-apropos)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 (define-key help-map "b" 'describe-bindings)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 (define-key help-map "c" 'describe-key-briefly)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 (define-key help-map "k" 'describe-key)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 (define-key help-map "d" 'describe-function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 (define-key help-map "f" 'describe-function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 (define-key help-map "i" 'info)
732
a8d94735277e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 660
diff changeset
49 (define-key help-map "\C-f" 'Info-goto-emacs-command-node)
a8d94735277e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 660
diff changeset
50 (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
51
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 (define-key help-map "l" 'view-lossage)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 (define-key help-map "m" 'describe-mode)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 (define-key help-map "\C-n" 'view-emacs-news)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 (define-key help-map "n" 'view-emacs-news)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 (define-key help-map "s" 'describe-syntax)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 (define-key help-map "t" 'help-with-tutorial)
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 "w" 'where-is)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 (define-key help-map "v" 'describe-variable)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 (defun help-with-tutorial ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 "Select the Emacs learn-by-doing tutorial."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 (let ((file (expand-file-name "~/TUTORIAL")))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 (delete-other-windows)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 (if (get-file-buffer file)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 (switch-to-buffer (get-file-buffer file))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 (switch-to-buffer (create-file-buffer file))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 (setq buffer-file-name file)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 (setq default-directory (expand-file-name "~/"))
755
e43123226372 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 732
diff changeset
77 (setq buffer-auto-save-file-name nil)
444
4cec2e6d4f9e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 409
diff changeset
78 (insert-file-contents (expand-file-name "TUTORIAL" data-directory))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79 (goto-char (point-min))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80 (search-forward "\n<<")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
81 (beginning-of-line)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
82 (delete-region (point) (progn (end-of-line) (point)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83 (newline (- (window-height (selected-window))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84 (count-lines (point-min) (point))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85 6))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86 (goto-char (point-min))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87 (set-buffer-modified-p nil))))
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 (defun describe-key-briefly (key)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
90 "Print the name of the function KEY invokes. KEY is a string."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91 (interactive "kDescribe key briefly: ")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92 (let ((defn (key-binding key)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
93 (if (or (null defn) (integerp defn))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94 (message "%s is undefined" (key-description key))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95 (message "%s runs the command %s"
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96 (key-description key)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97 (if (symbolp defn) defn (prin1-to-string defn))))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 (defun print-help-return-message (&optional function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100 "Display or return message saying how to restore windows after help command.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 Computes a message and applies the optional argument FUNCTION to it.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 If FUNCTION is nil, applies `message' to it, thus printing it."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 (and (not (get-buffer-window standard-output))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 (funcall (or function 'message)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105 (concat
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 (substitute-command-keys
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107 (if (one-window-p t)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108 (if pop-up-windows
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
109 "Type \\[delete-other-windows] to remove help window."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
110 "Type \\[switch-to-buffer] RET to remove help window.")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111 "Type \\[switch-to-buffer-other-window] RET to restore the other window."))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112 (substitute-command-keys
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113 " \\[scroll-other-window] to scroll the help.")))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
115 (defun describe-key (key)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
116 "Display documentation of the function invoked by KEY. KEY is a string."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
117 (interactive "kDescribe key: ")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118 (let ((defn (key-binding key)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 (if (or (null defn) (integerp defn))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120 (message "%s is undefined" (key-description key))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121 (with-output-to-temp-buffer "*Help*"
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 (prin1 defn)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123 (princ ":\n")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124 (if (documentation defn)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 (princ (documentation defn))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126 (princ "not documented"))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127 (print-help-return-message)))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
128
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129 (defun describe-mode (&optional minor)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130 "Display documentation of current major mode.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
131 If optional MINOR is non-nil (or prefix argument is given if interactive),
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
132 display documentation of active minor modes as well.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
133 For this to work correctly for a minor mode, the mode's indicator variable
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134 (listed in `minor-mode-alist') must also be a function whose documentation
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135 describes the minor mode."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
136 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137 (with-output-to-temp-buffer "*Help*"
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138 (princ mode-name)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139 (princ " Mode:\n")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140 (princ (documentation major-mode))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141 (let ((minor-modes minor-mode-alist)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142 (locals (buffer-local-variables)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143 (while minor-modes
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144 (let* ((minor-mode (car (car minor-modes)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145 (indicator (car (cdr (car minor-modes))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146 (local-binding (assq minor-mode locals)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
147 ;; Document a minor mode if it is listed in minor-mode-alist,
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
148 ;; bound locally in this buffer, non-nil, and has a function
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
149 ;; definition.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
150 (if (and local-binding
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
151 (cdr local-binding)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
152 (fboundp minor-mode))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
153 (progn
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
154 (princ (format "\n\n\n%s minor mode (indicator%s):\n"
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
155 minor-mode indicator))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
156 (princ (documentation minor-mode)))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
157 (setq minor-modes (cdr minor-modes))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
158 (print-help-return-message)))
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 ;; So keyboard macro definitions are documented correctly
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
161 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
162
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
163 (defun describe-distribution ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
164 "Display info on how to obtain the latest version of GNU Emacs."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
165 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
166 (find-file-read-only
444
4cec2e6d4f9e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 409
diff changeset
167 (expand-file-name "DISTRIB" data-directory)))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
168
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
169 (defun describe-copying ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
170 "Display info on how you may redistribute copies of GNU Emacs."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
171 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
172 (find-file-read-only
444
4cec2e6d4f9e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 409
diff changeset
173 (expand-file-name "COPYING" data-directory))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
174 (goto-char (point-min)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
175
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
176 (defun describe-no-warranty ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
177 "Display info on all the kinds of warranty Emacs does NOT have."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
178 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
179 (describe-copying)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
180 (let (case-fold-search)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
181 (search-forward "NO WARRANTY")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
182 (recenter 0)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
184 (defun view-emacs-news ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
185 "Display info on recent changes to Emacs."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
186 (interactive)
444
4cec2e6d4f9e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 409
diff changeset
187 (find-file-read-only (expand-file-name "NEWS" data-directory)))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
188
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
189 (defun view-lossage ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
190 "Display last 100 input keystrokes."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
191 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192 (with-output-to-temp-buffer "*Help*"
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193 (princ (key-description (recent-keys)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194 (save-excursion
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195 (set-buffer standard-output)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
196 (goto-char (point-min))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
197 (while (progn (move-to-column 50) (not (eobp)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
198 (search-forward " " nil t)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
199 (insert "\n")))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
200 (print-help-return-message)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
201
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202 (defun help-for-help ()
917
d09aafad0e95 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 878
diff changeset
203 "You have typed \\[help-for-help], the help character. Type a Help option:
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
205 A command-apropos. Give a substring, and see a list of commands
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
206 (functions interactively callable) that contain
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
207 that substring. See also the apropos command.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
208 B describe-bindings. Display table of all key bindings.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
209 C describe-key-briefly. Type a command key sequence;
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
210 it prints the function name that sequence runs.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
211 F describe-function. Type a function name and get documentation of it.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
212 I info. The info documentation reader.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
213 K describe-key. Type a command key sequence;
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
214 it displays the full documentation.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
215 L view-lossage. Shows last 100 characters you typed.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
216 M describe-mode. Print documentation of current major mode,
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
217 which describes the commands peculiar to it.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
218 N view-emacs-news. Shows emacs news file.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
219 S describe-syntax. Display contents of syntax table, plus explanations
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
220 T help-with-tutorial. Select the Emacs learn-by-doing tutorial.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
221 V describe-variable. Type name of a variable;
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
222 it displays the variable's documentation and value.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
223 W where-is. Type command name; it prints which keystrokes
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
224 invoke that command.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 C-c print Emacs copying permission (General Public License).
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
226 C-d print Emacs ordering information.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
227 C-n print news of recent Emacs changes.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
228 C-w print information on absence of warranty for GNU Emacs."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
229 (interactive)
918
94b50bbd43c3 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 917
diff changeset
230 (message (substitute-command-keys
94b50bbd43c3 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 917
diff changeset
231 "A B C F I K L M N S T V W C-c C-d C-n C-w. Type \\[help-for-help] again for more help: "))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
232 (let ((char (read-char)))
918
94b50bbd43c3 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 917
diff changeset
233 (if (or (= char help-char) (= char ??))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
234 (save-window-excursion
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
235 (switch-to-buffer "*Help*")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
236 (delete-other-windows)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
237 (erase-buffer)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
238 (insert (documentation 'help-for-help))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
239 (goto-char (point-min))
918
94b50bbd43c3 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 917
diff changeset
240 (while (memq char (cons help-char '(?? ?\C-v ?\ ?\177 ?\M-v)))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
241 (if (memq char '(?\C-v ?\ ))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
242 (scroll-up))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
243 (if (memq char '(?\177 ?\M-v))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
244 (scroll-down))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
245 (message "A B C F I K L M N S T V W C-c C-d C-n C-w%s: "
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
246 (if (pos-visible-in-window-p (point-max))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
247 "" " or Space to scroll"))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
248 (let ((cursor-in-echo-area t))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
249 (setq char (read-char))))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
250 (let ((defn (cdr (assq (downcase char) (cdr help-map)))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
251 (if defn (call-interactively defn) (ding)))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
252
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
253
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
254 ;; Return a function which is called by the list containing point.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
255 ;; 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
256 ;; If that doesn't give a function, return nil.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
257 (defun function-called-at-point ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
258 (or (condition-case ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
259 (save-excursion
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
260 (save-restriction
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
261 (narrow-to-region (max (point-min) (- (point) 1000)) (point-max))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
262 (backward-up-list 1)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
263 (forward-char 1)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
264 (let (obj)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
265 (setq obj (read (current-buffer)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
266 (and (symbolp obj) (fboundp obj) obj))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
267 (error nil))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
268 (condition-case ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
269 (save-excursion
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
270 (forward-sexp -1)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
271 (skip-chars-forward "'")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
272 (let ((obj (read (current-buffer))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
273 (and (symbolp obj) (fboundp obj) obj)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
274 (error nil))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
275
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
276 (defun describe-function (function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
277 "Display the full documentation of FUNCTION (a symbol)."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
278 (interactive
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
279 (let ((fn (function-called-at-point))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
280 (enable-recursive-minibuffers t)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
281 val)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
282 (setq val (completing-read (if fn
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
283 (format "Describe function (default %s): " fn)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
284 "Describe function: ")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
285 obarray 'fboundp t))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
286 (list (if (equal val "")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
287 fn (intern val)))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
288 (with-output-to-temp-buffer "*Help*"
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
289 (prin1 function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
290 (princ ": ")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
291 (let* ((def (symbol-function function))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
292 (beg (if (commandp def) "an interactive " "a ")))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
293 (princ (cond ((stringp def) "a keyboard macro.")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
294 ((subrp def)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
295 (concat beg "built-in function."))
1821
04fb1d3d6992 JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents: 1467
diff changeset
296 ((byte-code-function-p def)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
297 (concat beg "compiled Lisp function."))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
298 ((symbolp def)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
299 (format "alias for `%s'." def))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
300 ((eq (car-safe def) 'lambda)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
301 (concat beg "Lisp function."))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
302 ((eq (car-safe def) 'macro)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
303 "a Lisp macro.")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
304 ((eq (car-safe def) 'mocklisp)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
305 "a mocklisp function.")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
306 ((eq (car-safe def) 'autoload)
1467
8d8c91b563ee (describe-function): Print `an autoloaded', not `a ...'.
Richard M. Stallman <rms@gnu.org>
parents: 919
diff changeset
307 (format "%s autoloaded Lisp %s."
8d8c91b563ee (describe-function): Print `an autoloaded', not `a ...'.
Richard M. Stallman <rms@gnu.org>
parents: 919
diff changeset
308 (if (commandp def) "an interactive" "an")
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
309 (if (nth 4 def) "macro" "function")
878
5b1c5b4286e7 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 846
diff changeset
310 ;;; Including the file name made this line too long.
5b1c5b4286e7 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 846
diff changeset
311 ;;; (nth 1 def)
5b1c5b4286e7 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 846
diff changeset
312 ))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
313 (t "")))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
314 (terpri))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
315 (if (documentation function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
316 (princ (documentation function))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
317 (princ "not documented"))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
318 (print-help-return-message)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
319 ;; Return the text we displayed.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
320 (save-excursion (set-buffer standard-output) (buffer-string))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
321
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
322 (defun variable-at-point ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
323 (condition-case ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
324 (save-excursion
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
325 (forward-sexp -1)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
326 (skip-chars-forward "'")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
327 (let ((obj (read (current-buffer))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
328 (and (symbolp obj) (boundp obj) obj)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
329 (error nil)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
330
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
331 (defun describe-variable (variable)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
332 "Display the full documentation of VARIABLE (a symbol).
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
333 Returns the documentation as a string, also."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
334 (interactive
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
335 (let ((v (variable-at-point))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
336 (enable-recursive-minibuffers t)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
337 val)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
338 (setq val (completing-read (if v
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
339 (format "Describe variable (default %s): " v)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
340 "Describe variable: ")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
341 obarray 'boundp t))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
342 (list (if (equal val "")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
343 v (intern val)))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
344 (with-output-to-temp-buffer "*Help*"
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
345 (prin1 variable)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
346 (princ "'s value is ")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
347 (if (not (boundp variable))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
348 (princ "void.")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
349 (prin1 (symbol-value variable)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
350 (terpri) (terpri)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
351 (princ "Documentation:")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
352 (terpri)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
353 (let ((doc (documentation-property variable 'variable-documentation)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
354 (if doc
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
355 (princ (substitute-command-keys doc))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
356 (princ "not documented as a variable.")))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
357 (print-help-return-message)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
358 ;; Return the text we displayed.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
359 (save-excursion (set-buffer standard-output) (buffer-string))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
360
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
361 (defun command-apropos (string)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
362 "Like apropos but lists only symbols that are names of commands
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
363 \(interactively callable functions). Argument REGEXP is a regular expression
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
364 that is matched against command symbol names. Returns list of symbols and
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
365 documentation found."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
366 (interactive "sCommand apropos (regexp): ")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
367 (let ((message
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
368 (let ((standard-output (get-buffer-create "*Help*")))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
369 (print-help-return-message 'identity))))
878
5b1c5b4286e7 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 846
diff changeset
370 (apropos string t 'commandp)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
371 (and message (message message))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
372
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
373 (defun locate-library (library &optional nosuffix)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
374 "Show the full path name of Emacs library LIBRARY.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
375 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
376 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
377 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
378 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
379 (interactive "sLocate library: ")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
380 (catch 'answer
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
381 (mapcar
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382 '(lambda (dir)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
383 (mapcar
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
384 '(lambda (suf)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
385 (let ((try (expand-file-name (concat library suf) dir)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
386 (and (file-readable-p try)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
387 (null (file-directory-p try))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
388 (progn
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
389 (message "Library is file %s" try)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
390 (throw 'answer try)))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
391 (if nosuffix '("") '(".elc" ".el" ""))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
392 load-path)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
393 (message "No library %s in search path" library)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
394 nil))
660
08eb386dd0f3 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 444
diff changeset
395
08eb386dd0f3 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 444
diff changeset
396 ;;; help.el ends here