[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to emacs/man/help.texi
From: |
Kim F . Storm |
Subject: |
[Emacs-diffs] Changes to emacs/man/help.texi |
Date: |
Fri, 11 Nov 2005 19:58:46 -0500 |
Index: emacs/man/help.texi
diff -c emacs/man/help.texi:1.40 emacs/man/help.texi:1.41
*** emacs/man/help.texi:1.40 Mon Nov 7 23:09:59 2005
--- emacs/man/help.texi Sat Nov 12 00:58:46 2005
***************
*** 46,62 ****
@table @kbd
@item C-h a @var{topic} @key{RET}
This searches for commands whose names match @var{topic}, which should
! be a regular expression (@pxref{Regexps}). Browse the buffer that this
! command displays to find what you are looking for. @xref{Apropos}.
@item M-x apropos @key{RET} @var{topic} @key{RET}
This works like @kbd{C-h a}, but it also searches for noninteractive
functions and for variables. @xref{Apropos}.
! @item M-x apropos-documentation @key{RET} @var{topic} @key{RET}
This searches the @emph{documentation strings} (the built-in short
descriptions) of all variables and functions (not their names) for a
! match for @var{topic}, a regular expression. @xref{Apropos}.
@item C-h i d m emacs @key{RET} i @var{topic} @key{RET}
This looks up @var{topic} in the indices of the Emacs on-line manual.
--- 46,64 ----
@table @kbd
@item C-h a @var{topic} @key{RET}
This searches for commands whose names match @var{topic}, which should
! be a list of words or a regular expression (@pxref{Regexps}). Browse
! the buffer that this command displays to find what you are looking
! for. @xref{Apropos}.
@item M-x apropos @key{RET} @var{topic} @key{RET}
This works like @kbd{C-h a}, but it also searches for noninteractive
functions and for variables. @xref{Apropos}.
! @item C-h d @var{topic} @key{RET}
This searches the @emph{documentation strings} (the built-in short
descriptions) of all variables and functions (not their names) for a
! match for @var{topic}, a list or words or a regular expression.
! @xref{Apropos}.
@item C-h i d m emacs @key{RET} i @var{topic} @key{RET}
This looks up @var{topic} in the indices of the Emacs on-line manual.
***************
*** 111,118 ****
pre-written file of information.
@table @kbd
! @item C-h a @var{regexp} @key{RET}
! Display a list of commands whose names match @var{regexp}
(@code{apropos-command}).
@item C-h b
Display a table of all key bindings in effect now, in this order: minor
--- 113,120 ----
pre-written file of information.
@table @kbd
! @item C-h a @var{topic} @key{RET}
! Display a list of commands whose names match word list or regexp @var{topic}
(@code{apropos-command}).
@item C-h b
Display a table of all key bindings in effect now, in this order: minor
***************
*** 122,127 ****
--- 124,136 ----
Show the name of the command that @var{key} runs
(@code{describe-key-briefly}). Here @kbd{c} stands for ``character.''
For more extensive information on @var{key}, use @kbd{C-h k}.
+ @item C-h d @var{topic} @key{RET}
+ Display a list of commands and variables whose documentation match
+ word list or regexp @var{topic}
+ (@code{apropos-documentation}).
+ @item C-h e
+ Display the @code{*Messages*} buffer
+ (@code{view-echo-area-messages}).
@item C-h f @var{function} @key{RET}
Display documentation on the Lisp function named @var{function}
(@code{describe-function}). Since commands are Lisp functions,
***************
*** 304,328 ****
@end quotation
@findex apropos-variable
! To list all user variables that match a regexp, use the command
! @kbd{M-x apropos-variable}. By default, this command shows only
! variables meant for user customization; if you specify a prefix
argument, it checks all variables.
@findex apropos
! To list all Lisp symbols that contain a match for a regexp, not just
! the ones that are defined as commands, use the command @kbd{M-x apropos}
! instead of @kbd{C-h a}. This command does not check key bindings by
! default; specify a numeric argument if you want it to check them.
@findex apropos-documentation
The @code{apropos-documentation} command is like @code{apropos} except
that it searches documentation strings as well as symbol names for
! matches for the specified regular expression.
@findex apropos-value
The @code{apropos-value} command is like @code{apropos} except that it
! searches symbols' values for matches for the specified regular
expression. This command does not check function definitions or
property lists by default; specify a numeric argument if you want it to
check them.
--- 313,339 ----
@end quotation
@findex apropos-variable
! To list all user variables that match a word list or regexp, use the
! command @kbd{M-x apropos-variable}. By default, this command shows
! only variables meant for user customization; if you specify a prefix
argument, it checks all variables.
@findex apropos
! To list all Lisp symbols that contain a match for a word list or
! regexp, not just the ones that are defined as commands, use the
! command @kbd{M-x apropos} instead of @kbd{C-h a}. This command does
! not check key bindings by default; specify a numeric argument if you
! want it to check them.
+ @kindex C-h d
@findex apropos-documentation
The @code{apropos-documentation} command is like @code{apropos} except
that it searches documentation strings as well as symbol names for
! matches for the specified topic, a word list or regular expression.
@findex apropos-value
The @code{apropos-value} command is like @code{apropos} except that it
! searches symbols' values for matches for the specified word list or regular
expression. This command does not check function definitions or
property lists by default; specify a numeric argument if you want it to
check them.
***************
*** 337,342 ****
--- 348,359 ----
If the variable @code{apropos-sort-by-scores} is address@hidden,
Apropos tries to guess the relevance of each result, and displays the
most relevant ones first.
+
+ @vindex apropos-documentation-sort-by-scores
+ By default, Apropos lists the search results for
+ @code{apropos-documentation} in order of relevance.
+ If the variable @code{apropos-documentation-sort-by-scores} is @code{nil},
+ Apropos will list documentation in alphabetical order.
If you want more information about a function definition, variable or
symbol property listed in the Apropos buffer, you can click on it with