diff options
| author | Kim F. Storm | 2005-11-12 00:58:46 +0000 |
|---|---|---|
| committer | Kim F. Storm | 2005-11-12 00:58:46 +0000 |
| commit | b7bfc84036a0a78173c504c228cc27f648b2f4ab (patch) | |
| tree | e842b867ca861b5872c3faee1ef5c3ccece66722 | |
| parent | 9f49f577022ba51a156ab159ae6a3a2c3271e9d8 (diff) | |
| download | emacs-b7bfc84036a0a78173c504c228cc27f648b2f4ab.tar.gz emacs-b7bfc84036a0a78173c504c228cc27f648b2f4ab.zip | |
(Help): Fix C-h a entry. Add C-h d entry.
(Help Summary): Add C-h d and C-h e.
(Apropos): Clarify that all apropos commands may search for either
list of words or a regexp. Add C-h d for apropos-documentation.
Describe apropos-documentation-sort-by-scores user option.
| -rw-r--r-- | man/help.texi | 47 |
1 files changed, 32 insertions, 15 deletions
diff --git a/man/help.texi b/man/help.texi index 233d3c24b00..4da43fcb6ff 100644 --- a/man/help.texi +++ b/man/help.texi | |||
| @@ -46,17 +46,19 @@ manual index, then finally look in the FAQ and the package keywords. | |||
| 46 | @table @kbd | 46 | @table @kbd |
| 47 | @item C-h a @var{topic} @key{RET} | 47 | @item C-h a @var{topic} @key{RET} |
| 48 | This searches for commands whose names match @var{topic}, which should | 48 | This searches for commands whose names match @var{topic}, which should |
| 49 | be a regular expression (@pxref{Regexps}). Browse the buffer that this | 49 | be a list of words or a regular expression (@pxref{Regexps}). Browse |
| 50 | command displays to find what you are looking for. @xref{Apropos}. | 50 | the buffer that this command displays to find what you are looking |
| 51 | for. @xref{Apropos}. | ||
| 51 | 52 | ||
| 52 | @item M-x apropos @key{RET} @var{topic} @key{RET} | 53 | @item M-x apropos @key{RET} @var{topic} @key{RET} |
| 53 | This works like @kbd{C-h a}, but it also searches for noninteractive | 54 | This works like @kbd{C-h a}, but it also searches for noninteractive |
| 54 | functions and for variables. @xref{Apropos}. | 55 | functions and for variables. @xref{Apropos}. |
| 55 | 56 | ||
| 56 | @item M-x apropos-documentation @key{RET} @var{topic} @key{RET} | 57 | @item C-h d @var{topic} @key{RET} |
| 57 | This searches the @emph{documentation strings} (the built-in short | 58 | This searches the @emph{documentation strings} (the built-in short |
| 58 | descriptions) of all variables and functions (not their names) for a | 59 | descriptions) of all variables and functions (not their names) for a |
| 59 | match for @var{topic}, a regular expression. @xref{Apropos}. | 60 | match for @var{topic}, a list or words or a regular expression. |
| 61 | @xref{Apropos}. | ||
| 60 | 62 | ||
| 61 | @item C-h i d m emacs @key{RET} i @var{topic} @key{RET} | 63 | @item C-h i d m emacs @key{RET} i @var{topic} @key{RET} |
| 62 | This looks up @var{topic} in the indices of the Emacs on-line manual. | 64 | This looks up @var{topic} in the indices of the Emacs on-line manual. |
| @@ -111,8 +113,8 @@ command. | |||
| 111 | pre-written file of information. | 113 | pre-written file of information. |
| 112 | 114 | ||
| 113 | @table @kbd | 115 | @table @kbd |
| 114 | @item C-h a @var{regexp} @key{RET} | 116 | @item C-h a @var{topic} @key{RET} |
| 115 | Display a list of commands whose names match @var{regexp} | 117 | Display a list of commands whose names match word list or regexp @var{topic} |
| 116 | (@code{apropos-command}). | 118 | (@code{apropos-command}). |
| 117 | @item C-h b | 119 | @item C-h b |
| 118 | Display a table of all key bindings in effect now, in this order: minor | 120 | Display a table of all key bindings in effect now, in this order: minor |
| @@ -122,6 +124,13 @@ mode bindings, major mode bindings, and global bindings | |||
| 122 | Show the name of the command that @var{key} runs | 124 | Show the name of the command that @var{key} runs |
| 123 | (@code{describe-key-briefly}). Here @kbd{c} stands for ``character.'' | 125 | (@code{describe-key-briefly}). Here @kbd{c} stands for ``character.'' |
| 124 | For more extensive information on @var{key}, use @kbd{C-h k}. | 126 | For more extensive information on @var{key}, use @kbd{C-h k}. |
| 127 | @item C-h d @var{topic} @key{RET} | ||
| 128 | Display a list of commands and variables whose documentation match | ||
| 129 | word list or regexp @var{topic} | ||
| 130 | (@code{apropos-documentation}). | ||
| 131 | @item C-h e | ||
| 132 | Display the @code{*Messages*} buffer | ||
| 133 | (@code{view-echo-area-messages}). | ||
| 125 | @item C-h f @var{function} @key{RET} | 134 | @item C-h f @var{function} @key{RET} |
| 126 | Display documentation on the Lisp function named @var{function} | 135 | Display documentation on the Lisp function named @var{function} |
| 127 | (@code{describe-function}). Since commands are Lisp functions, | 136 | (@code{describe-function}). Since commands are Lisp functions, |
| @@ -304,25 +313,27 @@ view, describe, default. | |||
| 304 | @end quotation | 313 | @end quotation |
| 305 | 314 | ||
| 306 | @findex apropos-variable | 315 | @findex apropos-variable |
| 307 | To list all user variables that match a regexp, use the command | 316 | To list all user variables that match a word list or regexp, use the |
| 308 | @kbd{M-x apropos-variable}. By default, this command shows only | 317 | command @kbd{M-x apropos-variable}. By default, this command shows |
| 309 | variables meant for user customization; if you specify a prefix | 318 | only variables meant for user customization; if you specify a prefix |
| 310 | argument, it checks all variables. | 319 | argument, it checks all variables. |
| 311 | 320 | ||
| 312 | @findex apropos | 321 | @findex apropos |
| 313 | To list all Lisp symbols that contain a match for a regexp, not just | 322 | To list all Lisp symbols that contain a match for a word list or |
| 314 | the ones that are defined as commands, use the command @kbd{M-x apropos} | 323 | regexp, not just the ones that are defined as commands, use the |
| 315 | instead of @kbd{C-h a}. This command does not check key bindings by | 324 | command @kbd{M-x apropos} instead of @kbd{C-h a}. This command does |
| 316 | default; specify a numeric argument if you want it to check them. | 325 | not check key bindings by default; specify a numeric argument if you |
| 326 | want it to check them. | ||
| 317 | 327 | ||
| 328 | @kindex C-h d | ||
| 318 | @findex apropos-documentation | 329 | @findex apropos-documentation |
| 319 | The @code{apropos-documentation} command is like @code{apropos} except | 330 | The @code{apropos-documentation} command is like @code{apropos} except |
| 320 | that it searches documentation strings as well as symbol names for | 331 | that it searches documentation strings as well as symbol names for |
| 321 | matches for the specified regular expression. | 332 | matches for the specified topic, a word list or regular expression. |
| 322 | 333 | ||
| 323 | @findex apropos-value | 334 | @findex apropos-value |
| 324 | The @code{apropos-value} command is like @code{apropos} except that it | 335 | The @code{apropos-value} command is like @code{apropos} except that it |
| 325 | searches symbols' values for matches for the specified regular | 336 | searches symbols' values for matches for the specified word list or regular |
| 326 | expression. This command does not check function definitions or | 337 | expression. This command does not check function definitions or |
| 327 | property lists by default; specify a numeric argument if you want it to | 338 | property lists by default; specify a numeric argument if you want it to |
| 328 | check them. | 339 | check them. |
| @@ -338,6 +349,12 @@ If the variable @code{apropos-sort-by-scores} is non-@code{nil}, | |||
| 338 | Apropos tries to guess the relevance of each result, and displays the | 349 | Apropos tries to guess the relevance of each result, and displays the |
| 339 | most relevant ones first. | 350 | most relevant ones first. |
| 340 | 351 | ||
| 352 | @vindex apropos-documentation-sort-by-scores | ||
| 353 | By default, Apropos lists the search results for | ||
| 354 | @code{apropos-documentation} in order of relevance. | ||
| 355 | If the variable @code{apropos-documentation-sort-by-scores} is @code{nil}, | ||
| 356 | Apropos will list documentation in alphabetical order. | ||
| 357 | |||
| 341 | If you want more information about a function definition, variable or | 358 | If you want more information about a function definition, variable or |
| 342 | symbol property listed in the Apropos buffer, you can click on it with | 359 | symbol property listed in the Apropos buffer, you can click on it with |
| 343 | @kbd{Mouse-1} or @kbd{Mouse-2}, or move there and type @key{RET}. | 360 | @kbd{Mouse-1} or @kbd{Mouse-2}, or move there and type @key{RET}. |