diff options
| -rw-r--r-- | man/help.texi | 87 |
1 files changed, 43 insertions, 44 deletions
diff --git a/man/help.texi b/man/help.texi index 747f51aaaa7..f523b015cb7 100644 --- a/man/help.texi +++ b/man/help.texi | |||
| @@ -12,17 +12,19 @@ | |||
| 12 | @kindex F1 | 12 | @kindex F1 |
| 13 | 13 | ||
| 14 | Emacs provides extensive help features accessible through a single | 14 | Emacs provides extensive help features accessible through a single |
| 15 | character, @kbd{C-h}. @kbd{C-h} is a prefix key that is used for | 15 | character, @kbd{C-h} (or @key{F1}). @kbd{C-h} is a prefix key that is |
| 16 | commands that display documentation. The characters that you can type after | 16 | used for commands that display documentation. The characters that you |
| 17 | @kbd{C-h} are called @dfn{help options}. One help option is @kbd{C-h}; | 17 | can type after @kbd{C-h} are called @dfn{help options}. One help |
| 18 | that is how you ask for help about using @kbd{C-h}. To cancel, type | 18 | option is @kbd{C-h}; that is how you ask for help about using |
| 19 | @kbd{C-g}. The function key @key{F1} is equivalent to @kbd{C-h}. | 19 | @kbd{C-h}. To cancel, type @kbd{C-g}. The function key @key{F1} is |
| 20 | equivalent to @kbd{C-h}. | ||
| 20 | 21 | ||
| 21 | @kindex C-h C-h | 22 | @kindex C-h C-h |
| 22 | @findex help-for-help | 23 | @findex help-for-help |
| 23 | @kbd{C-h C-h} (@code{help-for-help}) displays a list of the possible | 24 | @kbd{C-h C-h} (@code{help-for-help}) displays a list of the possible |
| 24 | help options, each with a brief description. Before you type a help | 25 | help options, each with a brief description. You can look at the |
| 25 | option, you can use @key{SPC} or @key{DEL} to scroll through the list. | 26 | list, using @key{SPC} and @key{DEL} to scroll through it, then type |
| 27 | the help option you want. To cancel, type @kbd{C-g}. | ||
| 26 | 28 | ||
| 27 | @kbd{C-h} or @key{F1} means ``help'' in various other contexts as | 29 | @kbd{C-h} or @key{F1} means ``help'' in various other contexts as |
| 28 | well. After a prefix key, it displays a list of the alternatives that | 30 | well. After a prefix key, it displays a list of the alternatives that |
| @@ -70,13 +72,6 @@ Finally, you can try looking up a suitable package using keywords | |||
| 70 | pertinent to the feature you need. @xref{Library Keywords}. | 72 | pertinent to the feature you need. @xref{Library Keywords}. |
| 71 | @end table | 73 | @end table |
| 72 | 74 | ||
| 73 | To find the documentation of a key sequence or a menu item, type | ||
| 74 | @kbd{C-h K} and then type that key sequence or select the menu | ||
| 75 | item. This looks up the description of the command invoked by the key | ||
| 76 | or the menu in the appropriate manual (not necessarily the Emacs | ||
| 77 | manual). Likewise, use @kbd{C-h F} for reading documentation of a | ||
| 78 | command. | ||
| 79 | |||
| 80 | @menu | 75 | @menu |
| 81 | * Help Summary:: Brief list of all Help commands. | 76 | * Help Summary:: Brief list of all Help commands. |
| 82 | * Key Help:: Asking what a key does in Emacs. | 77 | * Key Help:: Asking what a key does in Emacs. |
| @@ -100,7 +95,8 @@ command. | |||
| 100 | 95 | ||
| 101 | Here is a summary of the Emacs interactive help commands. | 96 | Here is a summary of the Emacs interactive help commands. |
| 102 | @xref{Help Files}, for other help commands that just display a | 97 | @xref{Help Files}, for other help commands that just display a |
| 103 | pre-written file of information. | 98 | pre-written file of information. The character that follows |
| 99 | @kbd{C-h} is a ``help option.'' | ||
| 104 | 100 | ||
| 105 | @table @kbd | 101 | @table @kbd |
| 106 | @item C-h a @var{topics} @key{RET} | 102 | @item C-h a @var{topics} @key{RET} |
| @@ -180,7 +176,7 @@ links in @samp{*Help*} buffers (@code{display-local-help}). | |||
| 180 | 176 | ||
| 181 | @kindex C-h c | 177 | @kindex C-h c |
| 182 | @findex describe-key-briefly | 178 | @findex describe-key-briefly |
| 183 | The most basic @kbd{C-h} options are @kbd{C-h c} | 179 | The most basic @kbd{C-h} commands are @kbd{C-h c} |
| 184 | (@code{describe-key-briefly}) and @w{@kbd{C-h k}} (@code{describe-key}). | 180 | (@code{describe-key-briefly}) and @w{@kbd{C-h k}} (@code{describe-key}). |
| 185 | @kbd{C-h c @var{key}} displays in the echo area the name of the command | 181 | @kbd{C-h c @var{key}} displays in the echo area the name of the command |
| 186 | that @var{key} is bound to. For example, @kbd{C-h c C-f} displays | 182 | that @var{key} is bound to. For example, @kbd{C-h c C-f} displays |
| @@ -194,8 +190,19 @@ what @var{key} does. | |||
| 194 | displays the documentation string of the command as well as its name. | 190 | displays the documentation string of the command as well as its name. |
| 195 | This is too big for the echo area, so a window is used for the display. | 191 | This is too big for the echo area, so a window is used for the display. |
| 196 | 192 | ||
| 197 | @kbd{C-h c} and @kbd{C-h k} work for any sort of key sequences, | 193 | @kindex C-h K |
| 198 | including function keys and mouse events. | 194 | @findex Info-goto-emacs-key-command-node |
| 195 | To find the documentation of a key sequence, type @kbd{C-h K} and | ||
| 196 | then enter that key sequence. This looks up the description of the | ||
| 197 | command invoked by the key in whichever manual describes it (this need | ||
| 198 | not be the Emacs manual). @kbd{C-h K} runs the command | ||
| 199 | @code{Info-goto-emacs-key-command-node}. | ||
| 200 | |||
| 201 | @kbd{C-h c}, @kbd{C-h k} and @kbd{C-h K} work for any sort of key | ||
| 202 | sequences, including function keys, menus, and mouse events. For | ||
| 203 | instance, you can type @kbd{C-h k} and then select a menu item from | ||
| 204 | the menu bar, to show the documentation string of the command that | ||
| 205 | menu item runs. | ||
| 199 | 206 | ||
| 200 | @kindex C-h w | 207 | @kindex C-h w |
| 201 | @findex where-is | 208 | @findex where-is |
| @@ -256,9 +263,18 @@ variable. @xref{Variables}. | |||
| 256 | hyperlinks to the definition, if you have the source files installed. | 263 | hyperlinks to the definition, if you have the source files installed. |
| 257 | (@xref{Hyperlinking}.) If you know Lisp (or C), this provides the | 264 | (@xref{Hyperlinking}.) If you know Lisp (or C), this provides the |
| 258 | ultimate documentation. If you don't know Lisp, you should learn it. | 265 | ultimate documentation. If you don't know Lisp, you should learn it. |
| 259 | If you are just @emph{using} Emacs, treating Emacs as an object | 266 | (The Introduction to Emacs Lisp Programming, available from the FSF |
| 260 | (file), then you don't really love it. For true intimacy with your | 267 | through fsf.org, is a good way to get started.) Emacs won't be happy |
| 261 | editor, you need to read the source code. | 268 | if it feels you are just @emph{using} Emacs, treating it as an object |
| 269 | program. If you really love Emacs, show that you care by reading the | ||
| 270 | source code. | ||
| 271 | |||
| 272 | @kindex C-h F | ||
| 273 | @findex Info-goto-emacs-command-node | ||
| 274 | To find a specific function's documentation in a manual, use | ||
| 275 | @kbd{C-h F} (@code{Info-goto-emacs-command-node}). This knows | ||
| 276 | about various manuals, not just the Emacs manual, and finds the | ||
| 277 | right one. | ||
| 262 | 278 | ||
| 263 | @node Apropos | 279 | @node Apropos |
| 264 | @section Apropos | 280 | @section Apropos |
| @@ -432,8 +448,8 @@ use: | |||
| 432 | the support for a specific language environment. @xref{Language | 448 | the support for a specific language environment. @xref{Language |
| 433 | Environments}. This tells you which languages this language | 449 | Environments}. This tells you which languages this language |
| 434 | environment is useful for, and lists the character sets, coding | 450 | environment is useful for, and lists the character sets, coding |
| 435 | systems, and input methods that go with it. It also shows some sample | 451 | systems, and input methods that it operates on. It also shows some |
| 436 | text to illustrate scripts. | 452 | sample text to illustrate scripts. |
| 437 | 453 | ||
| 438 | The command @kbd{C-h h} (@code{view-hello-file}) displays the file | 454 | The command @kbd{C-h h} (@code{view-hello-file}) displays the file |
| 439 | @file{etc/HELLO}, which shows how to say ``hello'' in many languages. | 455 | @file{etc/HELLO}, which shows how to say ``hello'' in many languages. |
| @@ -456,9 +472,7 @@ Ops}), plus a few special commands of their own. | |||
| 456 | @item @key{SPC} | 472 | @item @key{SPC} |
| 457 | Scroll forward. | 473 | Scroll forward. |
| 458 | @item @key{DEL} | 474 | @item @key{DEL} |
| 459 | @itemx @key{BS} | 475 | Scroll backward. |
| 460 | Scroll backward. On some keyboards, this key is known as @key{BS} or | ||
| 461 | @key{backspace}. | ||
| 462 | @item @key{RET} | 476 | @item @key{RET} |
| 463 | Follow a cross reference at point. | 477 | Follow a cross reference at point. |
| 464 | @item @key{TAB} | 478 | @item @key{TAB} |
| @@ -521,24 +535,9 @@ have an entry in the top-level Info menu. It is also handy when you | |||
| 521 | need to get to the documentation quickly, and you know the exact name | 535 | need to get to the documentation quickly, and you know the exact name |
| 522 | of the file. | 536 | of the file. |
| 523 | 537 | ||
| 524 | @kindex C-h F | 538 | The help commands @kbd{C-h F @var{function} @key{RET}} and @kbd{C-h |
| 525 | @kindex C-h K | 539 | K @var{key}}, described above, enter Info and go straight to the |
| 526 | @findex Info-goto-emacs-key-command-node | 540 | documentation of @var{function} or @var{key}. |
| 527 | @findex Info-goto-emacs-command-node | ||
| 528 | There are two special help commands for accessing Emacs | ||
| 529 | documentation through Info. @kbd{C-h F @var{function} @key{RET}} | ||
| 530 | enters Info and goes straight to the documentation of the Emacs | ||
| 531 | function @var{function}. @kbd{C-h K @var{key}} enters Info and goes | ||
| 532 | straight to the documentation of the key @var{key}. These two keys | ||
| 533 | run the commands @code{Info-goto-emacs-command-node} and | ||
| 534 | @code{Info-goto-emacs-key-command-node}. You can use @kbd{C-h K} to | ||
| 535 | find the documentation of a menu item: just select that menu item when | ||
| 536 | @kbd{C-h K} prompts for a key. | ||
| 537 | |||
| 538 | @kbd{C-h F} and @kbd{C-h K} know about commands and keys described | ||
| 539 | in manuals other than the Emacs manual. Thus, they make it easier to | ||
| 540 | find the documentation of commands and keys when you are not sure | ||
| 541 | which manual describes them, like when using some specialized mode. | ||
| 542 | 541 | ||
| 543 | @kindex C-h S | 542 | @kindex C-h S |
| 544 | @findex info-lookup-symbol | 543 | @findex info-lookup-symbol |