diff options
| author | Richard M. Stallman | 2001-02-17 17:28:52 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2001-02-17 17:28:52 +0000 |
| commit | a83e87655f0db5e9c3b3633204b70f2fcdbdba34 (patch) | |
| tree | 05ce94ca17ac0201d39af9325da4df57042c03f0 | |
| parent | 08d376e3198636d95ca241b03b7052ce77a8e900 (diff) | |
| download | emacs-a83e87655f0db5e9c3b3633204b70f2fcdbdba34.tar.gz emacs-a83e87655f0db5e9c3b3633204b70f2fcdbdba34.zip | |
Clean up and move index-searching recommendation.
Other minor changes.
| -rw-r--r-- | man/help.texi | 42 |
1 files changed, 23 insertions, 19 deletions
diff --git a/man/help.texi b/man/help.texi index 146e7ce36cb..2c4a0b24ac5 100644 --- a/man/help.texi +++ b/man/help.texi | |||
| @@ -33,40 +33,42 @@ define other meanings for it, but they all support @key{F1}.) | |||
| 33 | 33 | ||
| 34 | Most help buffers use a special major mode, Help mode, which lets you | 34 | Most help buffers use a special major mode, Help mode, which lets you |
| 35 | scroll conveniently with @key{SPC} and @key{DEL}. It also offers | 35 | 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 further help regarding 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 | 39 | @cindex searching documentation efficiently |
| 40 | @cindex looking for a subject in documentation | 40 | @cindex looking for a subject in documentation |
| 41 | If you are looking for a certain feature, but don't know where exactly | 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 | 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: | 43 | command or option, we recommend these commands: |
| 44 | 44 | ||
| 45 | @table @kbd | 45 | @table @kbd |
| 46 | @item C-h a @var{topic} @key{RET} | 46 | @item C-h a @var{topic} @key{RET} |
| 47 | This searches for commands whose names match @var{topic}. @var{topic} | 47 | This searches for commands whose names match @var{topic}, which should |
| 48 | is a regular expression (@pxref{Regexps}). Browse the buffer popped up | 48 | be a regular expression (@pxref{Regexps}). Browse the buffer popped |
| 49 | by Emacs, to find what you are looking for. @xref{Apropos}. | 49 | up by Emacs, to find what you are looking for. @xref{Apropos}. |
| 50 | 50 | ||
| 51 | @item M-x apropos @var{topic} @key{RET} | 51 | @item M-x apropos @var{topic} @key{RET} |
| 52 | This works like @kbd{C-h a}, but it also searches for user options and | 52 | This works like @kbd{C-h a}, but it also searches for user options and |
| 53 | other variables, in case the feature you are looking for is controlled | 53 | other variables, in case the feature you are looking for is controlled |
| 54 | by an option, not a command. @xref{Apropos}. | 54 | by an option, not a command. @xref{Apropos}. |
| 55 | 55 | ||
| 56 | @item C-h i m emacs @key{RET} i @var{topic} @key{RET} | ||
| 57 | This looks up @var{topic} in the indices of the Emacs on-line manual. | ||
| 58 | Press @key{,} repetitively until you find what you are looking for. | ||
| 59 | |||
| 60 | @item C-h i m emacs @key{RET} s @var{topic} @key{RET} | ||
| 61 | This works like the previous command, but it searches for @var{topic} | ||
| 62 | (which can be a regular expression) in the @emph{text} of the manual | ||
| 63 | rather than in its indices. | ||
| 64 | |||
| 65 | @item M-x apropos-documentation @var{topic} @key{RET} | 56 | @item M-x apropos-documentation @var{topic} @key{RET} |
| 66 | This searches the @emph{documentation strings} (the built-in short | 57 | This searches the @emph{documentation strings} (the built-in short |
| 67 | descriptions) of all variables and functions (not their names) for a | 58 | descriptions) of all variables and functions (not their names) for a |
| 68 | match for @var{topic}, a regular expression. @xref{Apropos}. | 59 | match for @var{topic}, a regular expression. @xref{Apropos}. |
| 69 | 60 | ||
| 61 | @item C-h i m emacs @key{RET} i @var{topic} @key{RET} | ||
| 62 | This looks up @var{topic} in the indices of the Emacs on-line manual. | ||
| 63 | There may be several matches, so displays the first one. You can then | ||
| 64 | press @key{,} to move to other matches, until you find what you are | ||
| 65 | looking for. | ||
| 66 | |||
| 67 | @item C-h i m emacs @key{RET} s @var{topic} @key{RET} | ||
| 68 | Similar, but searches for @var{topic} (which can be a regular | ||
| 69 | expression) in the @emph{text} of the manual rather than in its | ||
| 70 | indices. | ||
| 71 | |||
| 70 | @item C-h F | 72 | @item C-h F |
| 71 | This brings up the Emacs FAQ, where you can use the usual search | 73 | This brings up the Emacs FAQ, where you can use the usual search |
| 72 | commands (@pxref{Search}) to find the information. | 74 | commands (@pxref{Search}) to find the information. |
| @@ -252,11 +254,13 @@ Lisp variables instead of Lisp functions. Its default is the Lisp symbol | |||
| 252 | around or before point, but only if that is the name of a known Lisp | 254 | around or before point, but only if that is the name of a known Lisp |
| 253 | variable. @xref{Variables}.@refill | 255 | variable. @xref{Variables}.@refill |
| 254 | 256 | ||
| 255 | Help buffers describing variables or functions defined in Lisp normally | 257 | Help buffers describing variables or functions defined in Lisp |
| 256 | have hyperlinks to their definitions if you have the Lisp source files | 258 | normally have hyperlinks to the Lisp definition, if you have the Lisp |
| 257 | installed. If you can read Lisp, this provides the ultimate | 259 | source files installed. If you know Lisp, this provides the ultimate |
| 258 | documentation. | 260 | documentation. If you don't know Lisp, you should learn it. If you |
| 259 | 261 | are treating Emacs as an object file, then you are just @emph{using} | |
| 262 | Emacs. For real intimacy with Emacs, you must read the source code. | ||
| 263 | |||
| 260 | @node Apropos | 264 | @node Apropos |
| 261 | @section Apropos | 265 | @section Apropos |
| 262 | 266 | ||