81 |
@end table |
@end table |
82 |
|
|
83 |
To find the documentation of a key sequence or a menu item, type |
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 |
@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 |
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 |
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 |
manual). Likewise, use @kbd{C-h F} for reading documentation of a |
88 |
command. |
command. |
89 |
|
|
90 |
@menu |
@menu |
96 |
* Language Help:: Help relating to international language support. |
* Language Help:: Help relating to international language support. |
97 |
* Help Mode:: Special features of Help mode and Help buffers. |
* Help Mode:: Special features of Help mode and Help buffers. |
98 |
* Misc Help:: Other help commands. |
* Misc Help:: Other help commands. |
99 |
|
* Help Files:: Commands to display pre-written help files. |
100 |
* Help Echo:: Help on active text and tooltips (`balloon help') |
* Help Echo:: Help on active text and tooltips (`balloon help') |
101 |
@end menu |
@end menu |
102 |
|
|
108 |
@section Help Summary |
@section Help Summary |
109 |
@end ifinfo |
@end ifinfo |
110 |
|
|
111 |
Here is a summary of the defined help commands. |
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. |
114 |
|
|
115 |
@table @kbd |
@table @kbd |
116 |
@item C-h a @var{regexp} @key{RET} |
@item C-h a @var{regexp} @key{RET} |
142 |
(@code{view-lossage}). |
(@code{view-lossage}). |
143 |
@item C-h m |
@item C-h m |
144 |
Display documentation of the current major mode (@code{describe-mode}). |
Display documentation of the current major mode (@code{describe-mode}). |
|
@item C-h n |
|
|
Display documentation of Emacs changes, most recent first |
|
|
(@code{view-emacs-news}). |
|
|
@item C-h P |
|
|
Display info on known problems with Emacs and possible workarounds |
|
|
(@code{view-emacs-problems}). |
|
145 |
@item C-h p |
@item C-h p |
146 |
Find packages by topic keyword (@code{finder-by-keyword}). |
Find packages by topic keyword (@code{finder-by-keyword}). |
147 |
@item C-h s |
@item C-h s |
165 |
Display information on the character sets, coding systems, and input |
Display information on the character sets, coding systems, and input |
166 |
methods used for language environment @var{language-env} |
methods used for language environment @var{language-env} |
167 |
(@code{describe-language-environment}). |
(@code{describe-language-environment}). |
168 |
@item C-h C-c |
@item C-h F @var{function} @key{RET} |
|
Display the copying conditions for GNU Emacs. |
|
|
@item C-h C-d |
|
|
Display information about getting new versions of GNU Emacs. |
|
|
@item C-h C-f @var{function} @key{RET} |
|
169 |
Enter Info and go to the node documenting the Emacs function @var{function} |
Enter Info and go to the node documenting the Emacs function @var{function} |
170 |
(@code{Info-goto-emacs-command-node}). |
(@code{Info-goto-emacs-command-node}). |
171 |
@item C-h C-k @var{key} |
@item C-h K @var{key} |
172 |
Enter Info and go to the node where the key sequence @var{key} is |
Enter Info and go to the node where the key sequence @var{key} is |
173 |
documented (@code{Info-goto-emacs-key-command-node}). |
documented (@code{Info-goto-emacs-key-command-node}). |
174 |
@item C-h C-p |
@item C-h S @var{symbol} @key{RET} |
|
Display information about the GNU Project. |
|
|
@item C-h @key{TAB} @var{symbol} @key{RET} |
|
175 |
Display the Info documentation on symbol @var{symbol} according to the |
Display the Info documentation on symbol @var{symbol} according to the |
176 |
programming language you are editing (@code{info-lookup-symbol}). |
programming language you are editing (@code{info-lookup-symbol}). |
177 |
@end table |
@end table |
459 |
need to get to the documentation quickly, and you know the exact name of |
need to get to the documentation quickly, and you know the exact name of |
460 |
the file. |
the file. |
461 |
|
|
462 |
@kindex C-h C-f |
@kindex C-h F |
463 |
@kindex C-h C-k |
@kindex C-h K |
464 |
@findex Info-goto-emacs-key-command-node |
@findex Info-goto-emacs-key-command-node |
465 |
@findex Info-goto-emacs-command-node |
@findex Info-goto-emacs-command-node |
466 |
There are two special help commands for accessing Emacs documentation |
There are two special help commands for accessing Emacs |
467 |
through Info. @kbd{C-h C-f @var{function} @key{RET}} enters Info and |
documentation through Info. @kbd{C-h F @var{function} @key{RET}} |
468 |
goes straight to the documentation of the Emacs function |
enters Info and goes straight to the documentation of the Emacs |
469 |
@var{function}. @kbd{C-h C-k @var{key}} enters Info and goes straight |
function @var{function}. @kbd{C-h K @var{key}} enters Info and goes |
470 |
to the documentation of the key @var{key}. These two keys run the |
straight to the documentation of the key @var{key}. These two keys |
471 |
commands @code{Info-goto-emacs-command-node} and |
run the commands @code{Info-goto-emacs-command-node} and |
472 |
@code{Info-goto-emacs-key-command-node}. You can use @kbd{C-h C-k} to |
@code{Info-goto-emacs-key-command-node}. You can use @kbd{C-h K} to |
473 |
find the documentation of a menu item: just select that menu item when |
find the documentation of a menu item: just select that menu item when |
474 |
@kbd{C-h C-k} prompts for a key. |
@kbd{C-h K} prompts for a key. |
|
|
|
|
@kbd{C-h C-f} and @kbd{C-h C-k} know about commands and keys |
|
|
described in manuals other than the Emacs manual. Thus, they make it |
|
|
easier to find the documentation of commands and keys when you are not |
|
|
sure which manual describes them, like when using some specialized |
|
|
mode. |
|
475 |
|
|
476 |
When editing a program, if you have an Info version of the manual for |
@kbd{C-h F} and @kbd{C-h K} know about commands and keys described |
477 |
the programming language, you can use the command @kbd{C-h C-i} to refer |
in manuals other than the Emacs manual. Thus, they make it easier to |
478 |
to the manual documentation for a symbol (keyword, function or |
find the documentation of commands and keys when you are not sure |
479 |
variable). The details of how this command works depend on the major |
which manual describes them, like when using some specialized mode. |
480 |
mode. |
|
481 |
|
@kindex C-h S |
482 |
|
@findex info-lookup-symbol |
483 |
|
When editing a program, if you have an Info version of the manual |
484 |
|
for the programming language, you can use the command @kbd{C-h S} |
485 |
|
(@code{info-lookup-symbol}) to refer to the manual documentation for a |
486 |
|
symbol (keyword, function or variable). The details of how this |
487 |
|
command works depend on the major mode. |
488 |
|
|
489 |
@kindex C-h l |
@kindex C-h l |
490 |
@findex view-lossage |
@findex view-lossage |
493 |
100 command characters you typed in. If you see commands that you don't |
100 command characters you typed in. If you see commands that you don't |
494 |
know, you can use @kbd{C-h c} to find out what they do. |
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. |
501 |
|
|
502 |
@kindex C-h m |
@kindex C-h m |
503 |
@findex describe-mode |
@findex describe-mode |
504 |
Emacs has numerous major modes, each of which redefines a few keys and |
Emacs has numerous major modes, each of which redefines a few keys and |
524 |
@kbd{C-h}. One of these is @key{ESC}, because @kbd{@key{ESC} C-h} is |
@kbd{C-h}. One of these is @key{ESC}, because @kbd{@key{ESC} C-h} is |
525 |
actually @kbd{C-M-h}, which marks a defun.) |
actually @kbd{C-M-h}, which marks a defun.) |
526 |
|
|
527 |
@kindex C-h F |
@node Help Files |
528 |
@findex view-emacs-FAQ |
@section Help Files |
529 |
@kindex C-h n |
|
530 |
@findex view-emacs-news |
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 |
|
|
535 |
@kindex C-h C-c |
@kindex C-h C-c |
536 |
@findex describe-copying |
@findex describe-copying |
537 |
@kindex C-h C-d |
@kindex C-h C-d |
538 |
@findex describe-distribution |
@findex describe-distribution |
539 |
@kindex C-h C-w |
@kindex C-h C-e |
540 |
@findex describe-no-warranty |
@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 |
@kindex C-h C-p |
546 |
@findex describe-project |
@findex describe-project |
547 |
@kindex C-h P |
@kindex C-h C-t |
548 |
@findex view-emacs-problems |
@findex view-emacs-todo |
549 |
|
@kindex C-h C-w |
550 |
|
@findex describe-no-warranty |
551 |
The other @kbd{C-h} options display various files containing useful |
The other @kbd{C-h} options display various files containing useful |
552 |
information. @kbd{C-h C-w} displays the full details on the complete |
information. |
553 |
absence of warranty for GNU Emacs. @kbd{C-h n} (@code{view-emacs-news}) |
|
554 |
displays the file @file{emacs/etc/NEWS}, which contains documentation on |
@table @kbd |
555 |
Emacs changes arranged chronologically. @kbd{C-h F} |
@item C-h C-c |
556 |
(@code{view-emacs-FAQ}) displays the Emacs frequently-answered-questions |
Displays the Emacs copying conditions (@code{describe-copying}). |
557 |
list. @kbd{C-h t} (@code{help-with-tutorial}) displays the |
These are the rules under which you can copy and redistribute Emacs. |
558 |
learn-by-doing Emacs tutorial. @kbd{C-h C-c} (@code{describe-copying}) |
@item C-h C-d |
559 |
displays the file @file{emacs/etc/COPYING}, which tells you the |
Displays information on how to download or order the latest version of |
560 |
conditions you must obey in distributing copies of Emacs. @kbd{C-h C-d} |
Emacs and other GNU software (@code{describe-distribution}). |
561 |
(@code{describe-distribution}) displays the file |
@item C-h C-e |
562 |
@file{emacs/etc/DISTRIB}, which tells you how you can order a copy of |
Displays the list of known Emacs problems, sometimes with suggested |
563 |
the latest version of Emacs. @kbd{C-h C-p} (@code{describe-project}) |
workarounds (@code{view-emacs-problems}). |
564 |
displays general information about the GNU Project. @kbd{C-h P} |
@item C-h C-f |
565 |
(@code{view-emacs-problems}) displays the file |
Displays the Emacs frequently-answered-questions list (@code{view-emacs-FAQ}). |
566 |
@file{emacs/etc/PROBLEMS}, which lists known problems with Emacs in |
@item C-h C-n |
567 |
various situations with solutions or workarounds in many cases. |
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 |
578 |
|
|
579 |
@node Help Echo |
@node Help Echo |
580 |
@section Help on Active Text and Tooltips |
@section Help on Active Text and Tooltips |