diff options
| author | Richard M. Stallman | 2005-02-16 10:04:34 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2005-02-16 10:04:34 +0000 |
| commit | 0bbb35f9b3347883be33006f7044e46e79324142 (patch) | |
| tree | f9c6878c164cb0e1eca2dadde44b1c690adf37bc | |
| parent | 8ebc23a8df034905d7850c350b7142856e320f24 (diff) | |
| download | emacs-0bbb35f9b3347883be33006f7044e46e79324142.tar.gz emacs-0bbb35f9b3347883be33006f7044e46e79324142.zip | |
(Help): Correct error about C-h in query-replace.
Clarify apropos vs C-h a. Fix how to search in FAQ.
(Key Help): Describe C-h w here.
(Name Help): Minor cleanup. C-h w moved to Key Help.
Clarify the "object" joke.
(Apropos): Clarify. Mouse-1 like Mouse-2.
(Help Mode): Mouse-1 like Mouse-2.
| -rw-r--r-- | man/help.texi | 80 |
1 files changed, 40 insertions, 40 deletions
diff --git a/man/help.texi b/man/help.texi index fb14eb150a2..d546440e114 100644 --- a/man/help.texi +++ b/man/help.texi | |||
| @@ -25,11 +25,10 @@ help options, each with a brief description. Before you type a help | |||
| 25 | option, you can use @key{SPC} or @key{DEL} to scroll through the list. | 25 | option, you can use @key{SPC} or @key{DEL} to scroll through the list. |
| 26 | 26 | ||
| 27 | @kbd{C-h} or @key{F1} means ``help'' in various other contexts as | 27 | @kbd{C-h} or @key{F1} means ``help'' in various other contexts as |
| 28 | well. For example, in the middle of @code{query-replace}, it describes | 28 | well. After a prefix key, it displays a list of the alternatives that |
| 29 | the options available for how to operate on the current match. After a | 29 | can follow the prefix key. (A few prefix keys don't support |
| 30 | prefix key, it displays a list of the alternatives that can follow the | 30 | @kbd{C-h}, because they define other meanings for it, but they all |
| 31 | prefix key. (A few prefix keys don't support @kbd{C-h}, because they | 31 | support @key{F1}.) |
| 32 | define other meanings for it, but they all support @key{F1}.) | ||
| 33 | 32 | ||
| 34 | Most help buffers use a special major mode, Help mode, which lets you | 33 | 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 | 34 | scroll conveniently with @key{SPC} and @key{DEL}. It also offers |
| @@ -51,9 +50,8 @@ be a regular expression (@pxref{Regexps}). Browse the buffer that this | |||
| 51 | command displays to find what you are looking for. @xref{Apropos}. | 50 | command displays to find what you are looking for. @xref{Apropos}. |
| 52 | 51 | ||
| 53 | @item M-x apropos @key{RET} @var{topic} @key{RET} | 52 | @item M-x apropos @key{RET} @var{topic} @key{RET} |
| 54 | This works like @kbd{C-h a}, but it also searches for variables, | 53 | This works like @kbd{C-h a}, but it also searches for noninteractive |
| 55 | in case the feature you are looking for is controlled by a variable | 54 | functions and for variables. @xref{Apropos}. |
| 56 | rather than a command. @xref{Apropos}. | ||
| 57 | 55 | ||
| 58 | @item M-x apropos-documentation @key{RET} @var{topic} @key{RET} | 56 | @item M-x apropos-documentation @key{RET} @var{topic} @key{RET} |
| 59 | This searches the @emph{documentation strings} (the built-in short | 57 | This searches the @emph{documentation strings} (the built-in short |
| @@ -72,8 +70,8 @@ expression) in the @emph{text} of the manual rather than in its | |||
| 72 | indices. | 70 | indices. |
| 73 | 71 | ||
| 74 | @item C-h C-f | 72 | @item C-h C-f |
| 75 | This brings up the Emacs FAQ, where you can use the usual search | 73 | This brings up the Emacs FAQ. You can use the Info commands |
| 76 | commands (@pxref{Search}) to find the information. | 74 | to browse it. |
| 77 | 75 | ||
| 78 | @item C-h p | 76 | @item C-h p |
| 79 | Finally, you can try looking up a suitable package using keywords | 77 | Finally, you can try looking up a suitable package using keywords |
| @@ -198,6 +196,13 @@ This is too big for the echo area, so a window is used for the display. | |||
| 198 | @kbd{C-h c} and @kbd{C-h k} work for any sort of key sequences, | 196 | @kbd{C-h c} and @kbd{C-h k} work for any sort of key sequences, |
| 199 | including function keys and mouse events. | 197 | including function keys and mouse events. |
| 200 | 198 | ||
| 199 | @kindex C-h w | ||
| 200 | @findex where-is | ||
| 201 | @kbd{C-h w @var{command} @key{RET}} tells you what keys are bound to | ||
| 202 | @var{command}. It displays a list of the keys in the echo area. If it | ||
| 203 | says the command is not on any key, you must use @kbd{M-x} to run it. | ||
| 204 | @kbd{C-h w} runs the command @code{where-is}. | ||
| 205 | |||
| 201 | @node Name Help | 206 | @node Name Help |
| 202 | @section Help by Command or Variable Name | 207 | @section Help by Command or Variable Name |
| 203 | 208 | ||
| @@ -217,15 +222,15 @@ displays the documentation of @code{auto-fill-mode}. This is the only | |||
| 217 | way to get the documentation of a command that is not bound to any key | 222 | way to get the documentation of a command that is not bound to any key |
| 218 | (one which you would normally run using @kbd{M-x}). | 223 | (one which you would normally run using @kbd{M-x}). |
| 219 | 224 | ||
| 220 | @kbd{C-h f} is also useful for Lisp functions that you are planning to | 225 | @kbd{C-h f} is also useful for Lisp functions that you are planning |
| 221 | use in a Lisp program. For example, if you have just written the | 226 | to use in a Lisp program. For example, if you have just written the |
| 222 | expression @code{(make-vector len)} and want to check that you are using | 227 | expression @code{(make-vector len)} and want to check that you are |
| 223 | @code{make-vector} properly, type @kbd{C-h f make-vector @key{RET}}. | 228 | using @code{make-vector} properly, type @kbd{C-h f make-vector |
| 224 | Because @kbd{C-h f} allows all function names, not just command names, | 229 | @key{RET}}. Because @kbd{C-h f} allows all function names, not just |
| 225 | you may find that some of your favorite abbreviations that work in | 230 | command names, you may find that some of your favorite completion |
| 226 | @kbd{M-x} don't work in @kbd{C-h f}. An abbreviation may be unique | 231 | abbreviations that work in @kbd{M-x} don't work in @kbd{C-h f}. An |
| 227 | among command names yet fail to be unique when other function names are | 232 | abbreviation may be unique among command names, yet fail to be unique |
| 228 | allowed. | 233 | when other function names are allowed. |
| 229 | 234 | ||
| 230 | The default function name for @kbd{C-h f} to describe, if you type | 235 | The default function name for @kbd{C-h f} to describe, if you type |
| 231 | just @key{RET}, is the name of the function called by the innermost Lisp | 236 | just @key{RET}, is the name of the function called by the innermost Lisp |
| @@ -241,13 +246,6 @@ buffer as the default, that name must be defined as a Lisp function. If | |||
| 241 | that is all you want to know, just type @kbd{C-g} to cancel the @kbd{C-h | 246 | that is all you want to know, just type @kbd{C-g} to cancel the @kbd{C-h |
| 242 | f} command, then go on editing. | 247 | f} command, then go on editing. |
| 243 | 248 | ||
| 244 | @kindex C-h w | ||
| 245 | @findex where-is | ||
| 246 | @kbd{C-h w @var{command} @key{RET}} tells you what keys are bound to | ||
| 247 | @var{command}. It displays a list of the keys in the echo area. If it | ||
| 248 | says the command is not on any key, you must use @kbd{M-x} to run it. | ||
| 249 | @kbd{C-h w} runs the command @code{where-is}. | ||
| 250 | |||
| 251 | @kbd{C-h v} (@code{describe-variable}) is like @kbd{C-h f} but describes | 249 | @kbd{C-h v} (@code{describe-variable}) is like @kbd{C-h f} but describes |
| 252 | Lisp variables instead of Lisp functions. Its default is the Lisp symbol | 250 | Lisp variables instead of Lisp functions. Its default is the Lisp symbol |
| 253 | around or before point, but only if that is the name of a known Lisp | 251 | around or before point, but only if that is the name of a known Lisp |
| @@ -257,8 +255,9 @@ variable. @xref{Variables}.@refill | |||
| 257 | normally have hyperlinks to the Lisp definition, if you have the Lisp | 255 | normally have hyperlinks to the Lisp definition, if you have the Lisp |
| 258 | source files installed. If you know Lisp, this provides the ultimate | 256 | source files installed. If you know Lisp, this provides the ultimate |
| 259 | documentation. If you don't know Lisp, you should learn it. If you | 257 | documentation. If you don't know Lisp, you should learn it. If you |
| 260 | are treating Emacs as an object file, then you are just @emph{using} | 258 | are just @emph{using} Emacs, treating Emacs as an object (file), then |
| 261 | Emacs. For real intimacy with Emacs, you must read the source code. | 259 | you don't really love it. For true intimacy with your editor, you |
| 260 | need to read the source code. | ||
| 262 | 261 | ||
| 263 | @node Apropos | 262 | @node Apropos |
| 264 | @section Apropos | 263 | @section Apropos |
| @@ -278,11 +277,11 @@ example, it would say that you can invoke @code{find-file} by typing | |||
| 278 | normally checks only commands (interactive functions); if you specify a | 277 | normally checks only commands (interactive functions); if you specify a |
| 279 | prefix argument, it checks noninteractive functions as well. | 278 | prefix argument, it checks noninteractive functions as well. |
| 280 | 279 | ||
| 281 | Because @kbd{C-h a} looks only for functions whose names contain the | 280 | Because @kbd{C-h a} looks only for commands whose names contain the |
| 282 | string you specify, you must use ingenuity in choosing the | 281 | string you specify, you must use ingenuity in choosing the string. If |
| 283 | string. If you are looking for commands for killing backwards and | 282 | you are looking for commands for killing backwards and @kbd{C-h a |
| 284 | @kbd{C-h a kill-backwards @key{RET}} doesn't reveal any, don't give up. | 283 | kill-backwards @key{RET}} doesn't reveal any, don't give up. Try just |
| 285 | Try just @kbd{kill}, or just @kbd{backwards}, or just @kbd{back}. Be | 284 | @kbd{kill}, or just @kbd{backwards}, or just @kbd{back}. Be |
| 286 | persistent. Also note that you can use a regular expression as the | 285 | persistent. Also note that you can use a regular expression as the |
| 287 | argument, for more flexibility (@pxref{Regexps}). | 286 | argument, for more flexibility (@pxref{Regexps}). |
| 288 | 287 | ||
| @@ -330,7 +329,7 @@ above all behave as if they had been given a prefix argument. | |||
| 330 | 329 | ||
| 331 | If you want more information about a function definition, variable or | 330 | If you want more information about a function definition, variable or |
| 332 | symbol property listed in the Apropos buffer, you can click on it with | 331 | symbol property listed in the Apropos buffer, you can click on it with |
| 333 | @kbd{Mouse-2} or move there and type @key{RET}. | 332 | @kbd{Mouse-1} or @kbd{Mouse-2}, or move there and type @key{RET}. |
| 334 | 333 | ||
| 335 | @node Library Keywords | 334 | @node Library Keywords |
| 336 | @section Keyword Search for Lisp Libraries | 335 | @section Keyword Search for Lisp Libraries |
| @@ -421,16 +420,17 @@ Follow a cross reference at point. | |||
| 421 | Move point forward to the next cross reference. | 420 | Move point forward to the next cross reference. |
| 422 | @item S-@key{TAB} | 421 | @item S-@key{TAB} |
| 423 | Move point back to the previous cross reference. | 422 | Move point back to the previous cross reference. |
| 424 | @item Mouse-2 | 423 | @item Mouse-1 |
| 424 | @itemx Mouse-2 | ||
| 425 | Follow a cross reference that you click on. | 425 | Follow a cross reference that you click on. |
| 426 | @end table | 426 | @end table |
| 427 | 427 | ||
| 428 | When a command name (@pxref{M-x,, Running Commands by Name}) or | 428 | When a function name (@pxref{M-x,, Running Commands by Name}) or |
| 429 | variable name (@pxref{Variables}) appears in the documentation, it | 429 | variable name (@pxref{Variables}) appears in the documentation, it |
| 430 | normally appears inside paired single-quotes. You can click on the name | 430 | normally appears inside paired single-quotes. You can click on the |
| 431 | with @kbd{Mouse-2}, or move point there and type @key{RET}, to view the | 431 | name with @kbd{Mouse-1} or @kbd{Mouse-2}, or move point there and type |
| 432 | documentation of that command or variable. Use @kbd{C-c C-b} to retrace | 432 | @key{RET}, to view the documentation of that command or variable. Use |
| 433 | your steps. | 433 | @kbd{C-c C-b} to retrace your steps. |
| 434 | 434 | ||
| 435 | @kindex @key{TAB} @r{(Help mode)} | 435 | @kindex @key{TAB} @r{(Help mode)} |
| 436 | @findex help-next-ref | 436 | @findex help-next-ref |