Mercurial > emacs
comparison man/help.texi @ 46243:dfc7817ae834
Document the major rearrangement of help commands after 21.1.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sun, 07 Jul 2002 23:46:55 +0000 |
parents | eaeec47bf5fe |
children | 0a8de3bc39b5 d7ddb3e565de |
comparison
equal
deleted
inserted
replaced
46242:5681198aa760 | 46243:dfc7817ae834 |
---|---|
79 Finally, you can try looking up a suitable package using keywords | 79 Finally, you can try looking up a suitable package using keywords |
80 pertinent to the feature you need. @xref{Library Keywords}. | 80 pertinent to the feature you need. @xref{Library Keywords}. |
81 @end table | 81 @end table |
82 | 82 |
83 To find the documentation of a key sequence or a menu item, type | 83 To find the documentation of a key sequence or a menu item, type |
84 @kbd{C-h C-k} and then type that key sequence or select the menu | 84 @kbd{C-h K} and then type that key sequence or select the menu |
85 item. This looks up the description of the command invoked by the key | 85 item. This looks up the description of the command invoked by the key |
86 or the menu in the appropriate manual (not necessarily the Emacs | 86 or the menu in the appropriate manual (not necessarily the Emacs |
87 manual). Likewise, use @kbd{C-h C-f} for reading documentation of a | 87 manual). Likewise, use @kbd{C-h F} for reading documentation of a |
88 command. | 88 command. |
89 | 89 |
90 @menu | 90 @menu |
91 * Help Summary:: Brief list of all Help commands. | 91 * Help Summary:: Brief list of all Help commands. |
92 * Key Help:: Asking what a key does in Emacs. | 92 * Key Help:: Asking what a key does in Emacs. |
94 * Apropos:: Asking what pertains to a given topic. | 94 * Apropos:: Asking what pertains to a given topic. |
95 * Library Keywords:: Finding Lisp libraries by keywords (topics). | 95 * Library Keywords:: Finding Lisp libraries by keywords (topics). |
96 * Language Help:: Help relating to international language support. | 96 * Language Help:: Help relating to international language support. |
97 * Help Mode:: Special features of Help mode and Help buffers. | 97 * Help Mode:: Special features of Help mode and Help buffers. |
98 * Misc Help:: Other help commands. | 98 * Misc Help:: Other help commands. |
99 * Help Files:: Commands to display pre-written help files. | |
99 * Help Echo:: Help on active text and tooltips (`balloon help') | 100 * Help Echo:: Help on active text and tooltips (`balloon help') |
100 @end menu | 101 @end menu |
101 | 102 |
102 @iftex | 103 @iftex |
103 @node Help Summary | 104 @node Help Summary |
105 @ifinfo | 106 @ifinfo |
106 @node Help Summary | 107 @node Help Summary |
107 @section Help Summary | 108 @section Help Summary |
108 @end ifinfo | 109 @end ifinfo |
109 | 110 |
110 Here is a summary of the defined help commands. | 111 Here is a summary of the Emacs interactive help commands. |
112 @xref{Help Files}, for other help commands that just display a | |
113 pre-written file of information. | |
111 | 114 |
112 @table @kbd | 115 @table @kbd |
113 @item C-h a @var{regexp} @key{RET} | 116 @item C-h a @var{regexp} @key{RET} |
114 Display a list of commands whose names match @var{regexp} | 117 Display a list of commands whose names match @var{regexp} |
115 (@code{apropos-command}). | 118 (@code{apropos-command}). |
137 @item C-h l | 140 @item C-h l |
138 Display a description of the last 100 characters you typed | 141 Display a description of the last 100 characters you typed |
139 (@code{view-lossage}). | 142 (@code{view-lossage}). |
140 @item C-h m | 143 @item C-h m |
141 Display documentation of the current major mode (@code{describe-mode}). | 144 Display documentation of the current major mode (@code{describe-mode}). |
142 @item C-h n | |
143 Display documentation of Emacs changes, most recent first | |
144 (@code{view-emacs-news}). | |
145 @item C-h P | |
146 Display info on known problems with Emacs and possible workarounds | |
147 (@code{view-emacs-problems}). | |
148 @item C-h p | 145 @item C-h p |
149 Find packages by topic keyword (@code{finder-by-keyword}). | 146 Find packages by topic keyword (@code{finder-by-keyword}). |
150 @item C-h s | 147 @item C-h s |
151 Display the current contents of the syntax table, plus an explanation of | 148 Display the current contents of the syntax table, plus an explanation of |
152 what they mean (@code{describe-syntax}). @xref{Syntax}. | 149 what they mean (@code{describe-syntax}). @xref{Syntax}. |
166 Describe an input method (@code{describe-input-method}). | 163 Describe an input method (@code{describe-input-method}). |
167 @item C-h L @var{language-env} @key{RET} | 164 @item C-h L @var{language-env} @key{RET} |
168 Display information on the character sets, coding systems, and input | 165 Display information on the character sets, coding systems, and input |
169 methods used for language environment @var{language-env} | 166 methods used for language environment @var{language-env} |
170 (@code{describe-language-environment}). | 167 (@code{describe-language-environment}). |
171 @item C-h C-c | 168 @item C-h F @var{function} @key{RET} |
172 Display the copying conditions for GNU Emacs. | |
173 @item C-h C-d | |
174 Display information about getting new versions of GNU Emacs. | |
175 @item C-h C-f @var{function} @key{RET} | |
176 Enter Info and go to the node documenting the Emacs function @var{function} | 169 Enter Info and go to the node documenting the Emacs function @var{function} |
177 (@code{Info-goto-emacs-command-node}). | 170 (@code{Info-goto-emacs-command-node}). |
178 @item C-h C-k @var{key} | 171 @item C-h K @var{key} |
179 Enter Info and go to the node where the key sequence @var{key} is | 172 Enter Info and go to the node where the key sequence @var{key} is |
180 documented (@code{Info-goto-emacs-key-command-node}). | 173 documented (@code{Info-goto-emacs-key-command-node}). |
181 @item C-h C-p | 174 @item C-h S @var{symbol} @key{RET} |
182 Display information about the GNU Project. | |
183 @item C-h @key{TAB} @var{symbol} @key{RET} | |
184 Display the Info documentation on symbol @var{symbol} according to the | 175 Display the Info documentation on symbol @var{symbol} according to the |
185 programming language you are editing (@code{info-lookup-symbol}). | 176 programming language you are editing (@code{info-lookup-symbol}). |
186 @end table | 177 @end table |
187 | 178 |
188 @node Key Help | 179 @node Key Help |
466 a documentation file. This way, you can browse a file which doesn't | 457 a documentation file. This way, you can browse a file which doesn't |
467 have an entry in the top-level Info menu. It is also handy when you | 458 have an entry in the top-level Info menu. It is also handy when you |
468 need to get to the documentation quickly, and you know the exact name of | 459 need to get to the documentation quickly, and you know the exact name of |
469 the file. | 460 the file. |
470 | 461 |
471 @kindex C-h C-f | 462 @kindex C-h F |
472 @kindex C-h C-k | 463 @kindex C-h K |
473 @findex Info-goto-emacs-key-command-node | 464 @findex Info-goto-emacs-key-command-node |
474 @findex Info-goto-emacs-command-node | 465 @findex Info-goto-emacs-command-node |
475 There are two special help commands for accessing Emacs documentation | 466 There are two special help commands for accessing Emacs |
476 through Info. @kbd{C-h C-f @var{function} @key{RET}} enters Info and | 467 documentation through Info. @kbd{C-h F @var{function} @key{RET}} |
477 goes straight to the documentation of the Emacs function | 468 enters Info and goes straight to the documentation of the Emacs |
478 @var{function}. @kbd{C-h C-k @var{key}} enters Info and goes straight | 469 function @var{function}. @kbd{C-h K @var{key}} enters Info and goes |
479 to the documentation of the key @var{key}. These two keys run the | 470 straight to the documentation of the key @var{key}. These two keys |
480 commands @code{Info-goto-emacs-command-node} and | 471 run the commands @code{Info-goto-emacs-command-node} and |
481 @code{Info-goto-emacs-key-command-node}. You can use @kbd{C-h C-k} to | 472 @code{Info-goto-emacs-key-command-node}. You can use @kbd{C-h K} to |
482 find the documentation of a menu item: just select that menu item when | 473 find the documentation of a menu item: just select that menu item when |
483 @kbd{C-h C-k} prompts for a key. | 474 @kbd{C-h K} prompts for a key. |
484 | 475 |
485 @kbd{C-h C-f} and @kbd{C-h C-k} know about commands and keys | 476 @kbd{C-h F} and @kbd{C-h K} know about commands and keys described |
486 described in manuals other than the Emacs manual. Thus, they make it | 477 in manuals other than the Emacs manual. Thus, they make it easier to |
487 easier to find the documentation of commands and keys when you are not | 478 find the documentation of commands and keys when you are not sure |
488 sure which manual describes them, like when using some specialized | 479 which manual describes them, like when using some specialized mode. |
489 mode. | 480 |
490 | 481 @kindex C-h S |
491 When editing a program, if you have an Info version of the manual for | 482 @findex info-lookup-symbol |
492 the programming language, you can use the command @kbd{C-h C-i} to refer | 483 When editing a program, if you have an Info version of the manual |
493 to the manual documentation for a symbol (keyword, function or | 484 for the programming language, you can use the command @kbd{C-h S} |
494 variable). The details of how this command works depend on the major | 485 (@code{info-lookup-symbol}) to refer to the manual documentation for a |
495 mode. | 486 symbol (keyword, function or variable). The details of how this |
487 command works depend on the major mode. | |
496 | 488 |
497 @kindex C-h l | 489 @kindex C-h l |
498 @findex view-lossage | 490 @findex view-lossage |
499 If something surprising happens, and you are not sure what commands you | 491 If something surprising happens, and you are not sure what commands you |
500 typed, use @kbd{C-h l} (@code{view-lossage}). @kbd{C-h l} displays the last | 492 typed, use @kbd{C-h l} (@code{view-lossage}). @kbd{C-h l} displays the last |
501 100 command characters you typed in. If you see commands that you don't | 493 100 command characters you typed in. If you see commands that you don't |
502 know, you can use @kbd{C-h c} to find out what they do. | 494 know, you can use @kbd{C-h c} to find out what they do. |
495 | |
496 @kindex C-h e | |
497 @findex view-echo-area-messages | |
498 To review messages that recently appeared in the echo area, use | |
499 @kbd{C-h e} (@code{view-echo-area-messages}). This displays the | |
500 buffer @code{*Messages*}, where those messages are kept. | |
503 | 501 |
504 @kindex C-h m | 502 @kindex C-h m |
505 @findex describe-mode | 503 @findex describe-mode |
506 Emacs has numerous major modes, each of which redefines a few keys and | 504 Emacs has numerous major modes, each of which redefines a few keys and |
507 makes a few other changes in how editing works. @kbd{C-h m} | 505 makes a few other changes in how editing works. @kbd{C-h m} |
524 @kbd{C-h} after the prefix key. (There are a few prefix keys for which | 522 @kbd{C-h} after the prefix key. (There are a few prefix keys for which |
525 this does not work---those that provide their own bindings for | 523 this does not work---those that provide their own bindings for |
526 @kbd{C-h}. One of these is @key{ESC}, because @kbd{@key{ESC} C-h} is | 524 @kbd{C-h}. One of these is @key{ESC}, because @kbd{@key{ESC} C-h} is |
527 actually @kbd{C-M-h}, which marks a defun.) | 525 actually @kbd{C-M-h}, which marks a defun.) |
528 | 526 |
529 @kindex C-h F | 527 @node Help Files |
530 @findex view-emacs-FAQ | 528 @section Help Files |
531 @kindex C-h n | 529 |
532 @findex view-emacs-news | 530 The Emacs help commands described above display the state of data |
531 bases within Emacs. Emacs has a few other help commands that display | |
532 pre-written help files. These commands all have the form @kbd{C-h | |
533 C-@var{char}}; that is, @kbd{C-h} followed by a control character. | |
534 | |
533 @kindex C-h C-c | 535 @kindex C-h C-c |
534 @findex describe-copying | 536 @findex describe-copying |
535 @kindex C-h C-d | 537 @kindex C-h C-d |
536 @findex describe-distribution | 538 @findex describe-distribution |
539 @kindex C-h C-e | |
540 @findex view-emacs-problems | |
541 @kindex C-h C-f | |
542 @findex view-emacs-FAQ | |
543 @kindex C-h C-n | |
544 @findex view-emacs-news | |
545 @kindex C-h C-p | |
546 @findex describe-project | |
547 @kindex C-h C-t | |
548 @findex view-emacs-todo | |
537 @kindex C-h C-w | 549 @kindex C-h C-w |
538 @findex describe-no-warranty | 550 @findex describe-no-warranty |
539 @kindex C-h C-p | |
540 @findex describe-project | |
541 @kindex C-h P | |
542 @findex view-emacs-problems | |
543 The other @kbd{C-h} options display various files containing useful | 551 The other @kbd{C-h} options display various files containing useful |
544 information. @kbd{C-h C-w} displays the full details on the complete | 552 information. |
545 absence of warranty for GNU Emacs. @kbd{C-h n} (@code{view-emacs-news}) | 553 |
546 displays the file @file{emacs/etc/NEWS}, which contains documentation on | 554 @table @kbd |
547 Emacs changes arranged chronologically. @kbd{C-h F} | 555 @item C-h C-c |
548 (@code{view-emacs-FAQ}) displays the Emacs frequently-answered-questions | 556 Displays the Emacs copying conditions (@code{describe-copying}). |
549 list. @kbd{C-h t} (@code{help-with-tutorial}) displays the | 557 These are the rules under which you can copy and redistribute Emacs. |
550 learn-by-doing Emacs tutorial. @kbd{C-h C-c} (@code{describe-copying}) | 558 @item C-h C-d |
551 displays the file @file{emacs/etc/COPYING}, which tells you the | 559 Displays information on how to download or order the latest version of |
552 conditions you must obey in distributing copies of Emacs. @kbd{C-h C-d} | 560 Emacs and other GNU software (@code{describe-distribution}). |
553 (@code{describe-distribution}) displays the file | 561 @item C-h C-e |
554 @file{emacs/etc/DISTRIB}, which tells you how you can order a copy of | 562 Displays the list of known Emacs problems, sometimes with suggested |
555 the latest version of Emacs. @kbd{C-h C-p} (@code{describe-project}) | 563 workarounds (@code{view-emacs-problems}). |
556 displays general information about the GNU Project. @kbd{C-h P} | 564 @item C-h C-f |
557 (@code{view-emacs-problems}) displays the file | 565 Displays the Emacs frequently-answered-questions list (@code{view-emacs-FAQ}). |
558 @file{emacs/etc/PROBLEMS}, which lists known problems with Emacs in | 566 @item C-h C-n |
559 various situations with solutions or workarounds in many cases. | 567 Displays the Emacs ``news'' file, which lists new Emacs features, most |
568 recent first (@code{view-emacs-news}). | |
569 @item C-h C-p | |
570 Displays general information about the GNU Project | |
571 (@code{describe-project}). | |
572 @item C-h C-t | |
573 Displays the Emacs to-do list (@code{view-todo}). | |
574 @item C-h C-w | |
575 Displays the full details on the complete absence of warranty for GNU | |
576 Emacs (@code{describe-no-warranty}). | |
577 @end table | |
560 | 578 |
561 @node Help Echo | 579 @node Help Echo |
562 @section Help on Active Text and Tooltips | 580 @section Help on Active Text and Tooltips |
563 | 581 |
564 @cindex tooltips | 582 @cindex tooltips |