diff options
| author | Eli Zaretskii | 2024-06-08 14:10:10 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2024-06-08 14:10:10 +0300 |
| commit | 53e9caa23ef0843337afcb5db4e16ef911d2e78d (patch) | |
| tree | ce4b81fdf490be9938fdff11f60d282f92101171 | |
| parent | 00360258caddc0d8cf29ba3d9971125a06f8959b (diff) | |
| download | emacs-53e9caa23ef0843337afcb5db4e16ef911d2e78d.tar.gz emacs-53e9caa23ef0843337afcb5db4e16ef911d2e78d.zip | |
; * doc/emacs/help.texi (Help, Apropos): Improve text and indexing.
| -rw-r--r-- | doc/emacs/help.texi | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index 1330717b758..e45f70af159 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi | |||
| @@ -45,22 +45,27 @@ window displaying the @samp{*Help*} buffer will be reused instead. | |||
| 45 | @cindex searching documentation efficiently | 45 | @cindex searching documentation efficiently |
| 46 | @cindex looking for a subject in documentation | 46 | @cindex looking for a subject in documentation |
| 47 | If you are looking for a certain feature, but don't know what it is | 47 | If you are looking for a certain feature, but don't know what it is |
| 48 | called or where to look, we recommend three methods. First, try an | 48 | called or where to look, we recommend three methods. First, try |
| 49 | apropos command, then try searching the manual index, then look in the | 49 | apropos commands, then try searching the manual index, then look in the |
| 50 | FAQ and the package keywords, and finally try listing external packages. | 50 | FAQ and the package keywords, and finally try listing external packages. |
| 51 | 51 | ||
| 52 | @table @kbd | 52 | @table @kbd |
| 53 | @item C-h a @var{topics} @key{RET} | 53 | @item C-h a @var{topics} @key{RET} |
| 54 | This searches for commands whose names match the argument | 54 | This searches for commands whose names match the argument |
| 55 | @var{topics}. The argument can be a keyword, a list of keywords, or a | 55 | @var{topics}. The argument can be a keyword, a list of keywords |
| 56 | regular expression (@pxref{Regexps}). @xref{Apropos}. | 56 | separated by whitespace, or a regular expression (@pxref{Regexps}). |
| 57 | @xref{Apropos}. | ||
| 57 | 58 | ||
| 58 | @item C-h i d m emacs @key{RET} i @var{topic} @key{RET} | 59 | @item C-h d @var{topics} @key{RET} |
| 60 | Similar, but searches the @emph{text} of the documentation strings | ||
| 61 | rather than the names of commands and functions. | ||
| 62 | |||
| 63 | @item C-h r i @var{topic} @key{RET} | ||
| 59 | This searches for @var{topic} in the indices of the Emacs Info manual, | 64 | This searches for @var{topic} in the indices of the Emacs Info manual, |
| 60 | displaying the first match found. Press @kbd{,} to see subsequent | 65 | displaying the first match found. Press @kbd{,} to see subsequent |
| 61 | matches. You can use a regular expression as @var{topic}. | 66 | matches. You can use a regular expression as @var{topic}. |
| 62 | 67 | ||
| 63 | @item C-h i d m emacs @key{RET} s @var{topic} @key{RET} | 68 | @item C-h r s @var{topic} @key{RET} |
| 64 | Similar, but searches the @emph{text} of the manual rather than the | 69 | Similar, but searches the @emph{text} of the manual rather than the |
| 65 | indices. | 70 | indices. |
| 66 | 71 | ||
| @@ -357,10 +362,12 @@ are included varies depending on the command used. | |||
| 357 | @section Apropos | 362 | @section Apropos |
| 358 | @cindex apropos | 363 | @cindex apropos |
| 359 | 364 | ||
| 365 | @cindex apropos pattern | ||
| 366 | @cindex apropos commands, list of keywords | ||
| 360 | The @dfn{apropos} commands answer questions like, ``What are the | 367 | The @dfn{apropos} commands answer questions like, ``What are the |
| 361 | commands for working with files?'' More precisely, you specify your | 368 | commands for working with files?'' More precisely, you specify your |
| 362 | query as an @dfn{apropos pattern}, which is either a word, a list of | 369 | query as an @dfn{apropos pattern}, which is either a word, a list of |
| 363 | words, or a regular expression. | 370 | words separated by whitespace, or a regular expression. |
| 364 | 371 | ||
| 365 | Each of the following apropos commands reads an apropos pattern in | 372 | Each of the following apropos commands reads an apropos pattern in |
| 366 | the minibuffer, searches for items that match the pattern, and | 373 | the minibuffer, searches for items that match the pattern, and |