; * doc/emacs/help.texi (Help, Apropos): Improve text and indexing.

This commit is contained in:
Eli Zaretskii 2024-06-08 14:10:10 +03:00
parent 00360258ca
commit 53e9caa23e

View file

@ -45,22 +45,27 @@ window displaying the @samp{*Help*} buffer will be reused instead.
@cindex searching documentation efficiently @cindex searching documentation efficiently
@cindex looking for a subject in documentation @cindex looking for a subject in documentation
If you are looking for a certain feature, but don't know what it is If you are looking for a certain feature, but don't know what it is
called or where to look, we recommend three methods. First, try an called or where to look, we recommend three methods. First, try
apropos command, then try searching the manual index, then look in the apropos commands, then try searching the manual index, then look in the
FAQ and the package keywords, and finally try listing external packages. FAQ and the package keywords, and finally try listing external packages.
@table @kbd @table @kbd
@item C-h a @var{topics} @key{RET} @item C-h a @var{topics} @key{RET}
This searches for commands whose names match the argument This searches for commands whose names match the argument
@var{topics}. The argument can be a keyword, a list of keywords, or a @var{topics}. The argument can be a keyword, a list of keywords
regular expression (@pxref{Regexps}). @xref{Apropos}. separated by whitespace, or a regular expression (@pxref{Regexps}).
@xref{Apropos}.
@item C-h i d m emacs @key{RET} i @var{topic} @key{RET} @item C-h d @var{topics} @key{RET}
Similar, but searches the @emph{text} of the documentation strings
rather than the names of commands and functions.
@item C-h r i @var{topic} @key{RET}
This searches for @var{topic} in the indices of the Emacs Info manual, This searches for @var{topic} in the indices of the Emacs Info manual,
displaying the first match found. Press @kbd{,} to see subsequent displaying the first match found. Press @kbd{,} to see subsequent
matches. You can use a regular expression as @var{topic}. matches. You can use a regular expression as @var{topic}.
@item C-h i d m emacs @key{RET} s @var{topic} @key{RET} @item C-h r s @var{topic} @key{RET}
Similar, but searches the @emph{text} of the manual rather than the Similar, but searches the @emph{text} of the manual rather than the
indices. indices.
@ -357,10 +362,12 @@ are included varies depending on the command used.
@section Apropos @section Apropos
@cindex apropos @cindex apropos
@cindex apropos pattern
@cindex apropos commands, list of keywords
The @dfn{apropos} commands answer questions like, ``What are the The @dfn{apropos} commands answer questions like, ``What are the
commands for working with files?'' More precisely, you specify your commands for working with files?'' More precisely, you specify your
query as an @dfn{apropos pattern}, which is either a word, a list of query as an @dfn{apropos pattern}, which is either a word, a list of
words, or a regular expression. words separated by whitespace, or a regular expression.
Each of the following apropos commands reads an apropos pattern in Each of the following apropos commands reads an apropos pattern in
the minibuffer, searches for items that match the pattern, and the minibuffer, searches for items that match the pattern, and