diff options
| author | Eli Zaretskii | 2000-10-08 09:14:38 +0000 |
|---|---|---|
| committer | Eli Zaretskii | 2000-10-08 09:14:38 +0000 |
| commit | 576c1dcbf4e3196de94fb863b0e5a7203ea271b0 (patch) | |
| tree | c92c629f33ae0e95e10adf57f474f3beea73ce53 | |
| parent | 9aeaea42540daa2ef748d9a5e7989fb31f29822e (diff) | |
| download | emacs-576c1dcbf4e3196de94fb863b0e5a7203ea271b0.tar.gz emacs-576c1dcbf4e3196de94fb863b0e5a7203ea271b0.zip | |
(Help): Describe an orderly procedure to find features in the docs.
| -rw-r--r-- | man/help.texi | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/man/help.texi b/man/help.texi index c2514230334..75128092084 100644 --- a/man/help.texi +++ b/man/help.texi | |||
| @@ -36,6 +36,42 @@ scroll conveniently with @key{SPC} and @key{DEL}. It also offers | |||
| 36 | hyperlinks to more help on cross-referenced names, Info nodes, | 36 | hyperlinks to more help on cross-referenced names, Info nodes, |
| 37 | customization buffers and the like. @xref{Help Mode}. | 37 | customization buffers and the like. @xref{Help Mode}. |
| 38 | 38 | ||
| 39 | @cindex searching documentation efficiently | ||
| 40 | @cindex looking for a subject in documentation | ||
| 41 | If you are looking for a certain feature, but don't know where exactly | ||
| 42 | it is documented, and aren't even sure what is the name of the related | ||
| 43 | command or option, we recommend the following procedure: | ||
| 44 | |||
| 45 | @table @kbd | ||
| 46 | @item C-h a @var{topic} @key{RET} | ||
| 47 | This searches the built-in short documentation of each command for | ||
| 48 | strings which match @var{topic}. @var{topic} can be a regular | ||
| 49 | expression (@pxref{Regexps}). Browse the buffer popped up by Emacs, to | ||
| 50 | find what you are looking for. | ||
| 51 | |||
| 52 | @item M-x apropos @var{topic} @key{RET} | ||
| 53 | This works like @kbd{C-h a}, but it also searches the documentation of | ||
| 54 | user options and other variables, in case the feature you are looking | ||
| 55 | for is controlled by an option, not a command. | ||
| 56 | |||
| 57 | @item C-h i emacs @key{RET} i @var{topic} @key{RET} | ||
| 58 | This looks up @var{topic} in the indices of the Emacs on-line manual. | ||
| 59 | Press @key{,} repetitively until you find what you are looking for. | ||
| 60 | |||
| 61 | @item C-h i emacs @key{RET} s @var{topic} @key{RET} | ||
| 62 | This works like the previous command, but it searches for @var{topic} | ||
| 63 | (which can be a regular expression) in the @emph{text} of the manual | ||
| 64 | rather than in its indices. | ||
| 65 | |||
| 66 | @item C-h F | ||
| 67 | This brings up the Emacs FAQ, where you can use the usual search | ||
| 68 | commands (@pxref{Search}) to find the information. | ||
| 69 | |||
| 70 | @item M-x finder-by-keyword | ||
| 71 | Finally, you can try looking up a suitable package using keywords | ||
| 72 | pertinent to the feature you need. | ||
| 73 | @end table | ||
| 74 | |||
| 39 | @menu | 75 | @menu |
| 40 | * Help Summary:: Brief list of all Help commands. | 76 | * Help Summary:: Brief list of all Help commands. |
| 41 | * Key Help:: Asking what a key does in Emacs. | 77 | * Key Help:: Asking what a key does in Emacs. |