aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--lispref/help.texi36
1 files changed, 30 insertions, 6 deletions
diff --git a/lispref/help.texi b/lispref/help.texi
index c7c99fa8987..4821478a3ad 100644
--- a/lispref/help.texi
+++ b/lispref/help.texi
@@ -133,11 +133,17 @@ unless @var{verbatim} is non-@code{nil}.
133(symbol-plist 'command-line-processed) 133(symbol-plist 'command-line-processed)
134 @result{} (variable-documentation 188902) 134 @result{} (variable-documentation 188902)
135@end group 135@end group
136@group
137(documentation-property 'emacs 'group-documentation)
138 @result{} "Customization of the One True Editor."
139@end group
136@end smallexample 140@end smallexample
137@end defun 141@end defun
138 142
139@defun documentation function &optional verbatim 143@defun documentation function &optional verbatim
140This function returns the documentation string of @var{function}. 144This function returns the documentation string of @var{function}.
145@code{documentation} handles macros, named keyboard macros, and
146special forms, as well as ordinary functions.
141 147
142If @var{function} is a symbol, this function first looks for the 148If @var{function} is a symbol, this function first looks for the
143@code{function-documentation} property of that symbol; if that has a 149@code{function-documentation} property of that symbol; if that has a
@@ -157,6 +163,11 @@ the function definition has no documentation string. In that case,
157@code{documentation} returns @code{nil}. 163@code{documentation} returns @code{nil}.
158@end defun 164@end defun
159 165
166@defun face-documentation face
167This function returns the documentation string of @var{face} as a
168face.
169@end defun
170
160@c Wordy to prevent overfull hboxes. --rjc 15mar92 171@c Wordy to prevent overfull hboxes. --rjc 15mar92
161Here is an example of using the two functions, @code{documentation} and 172Here is an example of using the two functions, @code{documentation} and
162@code{documentation-property}, to display the documentation strings for 173@code{documentation-property}, to display the documentation strings for
@@ -498,15 +509,28 @@ the user as subcommands of the prefix @kbd{C-h}. For more information
498about them, see @ref{Help, , Help, emacs, The GNU Emacs Manual}. Here 509about them, see @ref{Help, , Help, emacs, The GNU Emacs Manual}. Here
499we describe some program-level interfaces to the same information. 510we describe some program-level interfaces to the same information.
500 511
501@deffn Command apropos regexp &optional do-all 512@deffn Command apropos pattern &optional do-all
502This function finds all ``meaningful'' symbols whose names contain a 513This function finds all ``meaningful'' symbols whose names contain a
503match for the regular expression @var{regexp}, and returns a list of 514match for the apropos pattern @var{pattern}. An apropos pattern is
504them, with associated documentation (@pxref{Regular Expressions}). It 515either a word to match, a space-separated list of words of which at
505also displays the symbols in a buffer named @samp{*Apropos*}, each 516least two must match, or a regular expression (if any special regular
506with a one-line description taken from the beginning of its 517expression characters occur). A symbol is ``meaningful'' if it has a
507documentation string. A symbol is ``meaningful'' if it has a
508definition as a function, variable, or face, or has properties. 518definition as a function, variable, or face, or has properties.
509 519
520The function returns a list of elements that look like this:
521
522@example
523(@var{symbol} @var{score} @var{fn-doc} @var{var-doc} @var{plist-doc} @var{widget-doc} @var{face-doc} @var{group-doc})
524@end example
525
526Here, @var{score} is an integer measure of how important the symbol
527seems to be as a match, and the remaining elements are documentation
528strings for @var{symbol}'s various roles (or @code{nil}).
529
530It also displays the symbols in a buffer named @samp{*Apropos*}, each
531with a one-line description taken from the beginning of its
532documentation string.
533
510@c Emacs 19 feature 534@c Emacs 19 feature
511If @var{do-all} is non-@code{nil}, or if the user option 535If @var{do-all} is non-@code{nil}, or if the user option
512@code{apropos-do-all} is non-@code{nil}, then @code{apropos} also 536@code{apropos-do-all} is non-@code{nil}, then @code{apropos} also