1 |
@c -*-texinfo-*- |
@c -*-texinfo-*- |
2 |
@c This is part of the GNU Emacs Lisp Reference Manual. |
@c This is part of the GNU Emacs Lisp Reference Manual. |
3 |
@c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
@c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
4 |
@c Free Software Foundation, Inc. |
@c Free Software Foundation, Inc. |
5 |
@c See the file elisp.texi for copying conditions. |
@c See the file elisp.texi for copying conditions. |
6 |
@setfilename ../info/help |
@setfilename ../info/help |
7 |
@node Documentation, Files, Modes, Top |
@node Documentation, Files, Modes, Top |
164 |
in the `*Help*' buffer." |
in the `*Help*' buffer." |
165 |
(interactive "sDescribe symbols matching: ") |
(interactive "sDescribe symbols matching: ") |
166 |
(let ((describe-func |
(let ((describe-func |
167 |
(function |
(function |
168 |
(lambda (s) |
(lambda (s) |
169 |
@end group |
@end group |
170 |
@group |
@group |
172 |
(if (fboundp s) ; @r{It is a function.} |
(if (fboundp s) ; @r{It is a function.} |
173 |
(princ |
(princ |
174 |
(format "%s\t%s\n%s\n\n" s |
(format "%s\t%s\n%s\n\n" s |
175 |
(if (commandp s) |
(if (commandp s) |
176 |
(let ((keys (where-is-internal s))) |
(let ((keys (where-is-internal s))) |
177 |
(if keys |
(if keys |
178 |
(concat |
(concat |
179 |
"Keys: " |
"Keys: " |
180 |
(mapconcat 'key-description |
(mapconcat 'key-description |
181 |
keys " ")) |
keys " ")) |
182 |
"Keys: none")) |
"Keys: none")) |
183 |
"Function") |
"Function") |
184 |
@end group |
@end group |
185 |
@group |
@group |
186 |
(or (documentation s) |
(or (documentation s) |
187 |
"not documented")))) |
"not documented")))) |
188 |
|
|
189 |
(if (boundp s) ; @r{It is a variable.} |
(if (boundp s) ; @r{It is a variable.} |
190 |
@end group |
@end group |
191 |
@group |
@group |
192 |
(princ |
(princ |
193 |
(format "%s\t%s\n%s\n\n" s |
(format "%s\t%s\n%s\n\n" s |
194 |
(if (user-variable-p s) |
(if (user-variable-p s) |
195 |
"Option " "Variable") |
"Option " "Variable") |
196 |
@end group |
@end group |
197 |
@group |
@group |
198 |
(or (documentation-property |
(or (documentation-property |
199 |
s 'variable-documentation) |
s 'variable-documentation) |
200 |
"not documented"))))))) |
"not documented"))))))) |
201 |
sym-list) |
sym-list) |
203 |
|
|
204 |
@group |
@group |
205 |
;; @r{Build a list of symbols that match pattern.} |
;; @r{Build a list of symbols that match pattern.} |
206 |
(mapatoms (function |
(mapatoms (function |
207 |
(lambda (sym) |
(lambda (sym) |
208 |
(if (string-match pattern (symbol-name sym)) |
(if (string-match pattern (symbol-name sym)) |
209 |
(setq sym-list (cons sym sym-list)))))) |
(setq sym-list (cons sym sym-list)))))) |
225 |
(describe-symbols "goal") |
(describe-symbols "goal") |
226 |
|
|
227 |
---------- Buffer: *Help* ---------- |
---------- Buffer: *Help* ---------- |
228 |
goal-column Option |
goal-column Option |
229 |
*Semipermanent goal column for vertical motion, as set by @dots{} |
*Semipermanent goal column for vertical motion, as set by @dots{} |
230 |
@end group |
@end group |
231 |
@c Do not blithely break or fill these lines. |
@c Do not blithely break or fill these lines. |
306 |
stands for a key sequence that will invoke @var{command}, or @samp{M-x |
stands for a key sequence that will invoke @var{command}, or @samp{M-x |
307 |
@var{command}} if @var{command} has no key bindings. |
@var{command}} if @var{command} has no key bindings. |
308 |
|
|
309 |
@item \@{@var{mapvar}@} |
@item \@{@var{mapvar}@} |
310 |
stands for a summary of the keymap which is the value of the variable |
stands for a summary of the keymap which is the value of the variable |
311 |
@var{mapvar}. The summary is made using @code{describe-bindings}. |
@var{mapvar}. The summary is made using @code{describe-bindings}. |
312 |
|
|
313 |
@item \<@var{mapvar}> |
@item \<@var{mapvar}> |
314 |
stands for no text itself. It is used only for a side effect: it |
stands for no text itself. It is used only for a side effect: it |
315 |
specifies @var{mapvar}'s value as the keymap for any following |
specifies @var{mapvar}'s value as the keymap for any following |
316 |
@samp{\[@var{command}]} sequences in this documentation string. |
@samp{\[@var{command}]} sequences in this documentation string. |
335 |
|
|
336 |
@smallexample |
@smallexample |
337 |
@group |
@group |
338 |
(substitute-command-keys |
(substitute-command-keys |
339 |
"To abort recursive edit, type: \\[abort-recursive-edit]") |
"To abort recursive edit, type: \\[abort-recursive-edit]") |
340 |
@result{} "To abort recursive edit, type: C-]" |
@result{} "To abort recursive edit, type: C-]" |
341 |
@end group |
@end group |
342 |
|
|
343 |
@group |
@group |
344 |
(substitute-command-keys |
(substitute-command-keys |
345 |
"The keys that are defined for the minibuffer here are: |
"The keys that are defined for the minibuffer here are: |
346 |
\\@{minibuffer-local-must-match-map@}") |
\\@{minibuffer-local-must-match-map@}") |
347 |
@result{} "The keys that are defined for the minibuffer here are: |
@result{} "The keys that are defined for the minibuffer here are: |
605 |
|
|
606 |
@c Emacs 19 feature |
@c Emacs 19 feature |
607 |
@defmac make-help-screen fname help-line help-text help-map |
@defmac make-help-screen fname help-line help-text help-map |
608 |
This macro defines a help command named @var{fname} that acts like a |
This macro defines a help command named @var{fname} that acts like a |
609 |
prefix key that shows a list of the subcommands it offers. |
prefix key that shows a list of the subcommands it offers. |
610 |
|
|
611 |
When invoked, @var{fname} displays @var{help-text} in a window, then |
When invoked, @var{fname} displays @var{help-text} in a window, then |