Mercurial > emacs
comparison man/help.texi @ 38488:2a70c922f6ad
Fix last change.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Thu, 19 Jul 2001 13:10:50 +0000 |
parents | 23f63206a867 |
children | 5464ee1ba8e2 |
comparison
equal
deleted
inserted
replaced
38487:b6d397fa9acb | 38488:2a70c922f6ad |
---|---|
10 @findex help-command | 10 @findex help-command |
11 @kindex C-h | 11 @kindex C-h |
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 only for | 15 character, @kbd{C-h}. @kbd{C-h} is a prefix key that is used for |
16 commands that display documentation. The characters that you can type after | 16 commands that display documentation. The characters that you can type after |
17 @kbd{C-h} are called @dfn{help options}. One help option is @kbd{C-h}; | 17 @kbd{C-h} are called @dfn{help options}. One help option is @kbd{C-h}; |
18 that is how you ask for help about using @kbd{C-h}. To cancel, type | 18 that is how you ask for help about using @kbd{C-h}. To cancel, type |
19 @kbd{C-g}. The function key @key{F1} is equivalent to @kbd{C-h}. | 19 @kbd{C-g}. The function key @key{F1} is equivalent to @kbd{C-h}. |
20 | 20 |
109 @item C-h b | 109 @item C-h b |
110 Display a table of all key bindings in effect now, in this order: minor | 110 Display a table of all key bindings in effect now, in this order: minor |
111 mode bindings, major mode bindings, and global bindings | 111 mode bindings, major mode bindings, and global bindings |
112 (@code{describe-bindings}). | 112 (@code{describe-bindings}). |
113 @item C-h c @var{key} | 113 @item C-h c @var{key} |
114 Show the name of the command that will be run if @var{key} is typed | 114 Show the name of the command that @var{key} runs |
115 (@code{describe-key-briefly}). Here @kbd{c} stands for ``character.'' | 115 (@code{describe-key-briefly}). Here @kbd{c} stands for ``character.'' |
116 For more extensive information on @var{key}, use @kbd{C-h k}. | 116 For more extensive information on @var{key}, use @kbd{C-h k}. |
117 @item C-h f @var{function} @key{RET} | 117 @item C-h f @var{function} @key{RET} |
118 Display documentation on the Lisp function named @var{function} | 118 Display documentation on the Lisp function named @var{function} |
119 (@code{describe-function}). Since commands are Lisp functions, | 119 (@code{describe-function}). Since commands are Lisp functions, |
131 Display a description of the last 100 characters you typed | 131 Display a description of the last 100 characters you typed |
132 (@code{view-lossage}). | 132 (@code{view-lossage}). |
133 @item C-h m | 133 @item C-h m |
134 Display documentation of the current major mode (@code{describe-mode}). | 134 Display documentation of the current major mode (@code{describe-mode}). |
135 @item C-h n | 135 @item C-h n |
136 Display documentation of changes to Emacs and its packages, most | 136 Display documentation of Emacs changes, most recent first |
137 recent first (@code{view-emacs-news}). | 137 (@code{view-emacs-news}). |
138 @item C-h P | 138 @item C-h P |
139 Display info on known problems with Emacs and possible workarounds | 139 Display info on known problems with Emacs and possible workarounds |
140 (@code{view-emacs-problems}). | 140 (@code{view-emacs-problems}). |
141 @item C-h p | 141 @item C-h p |
142 Find packages by topic keyword (@code{finder-by-keyword}). | 142 Find packages by topic keyword (@code{finder-by-keyword}). |
144 Display the current contents of the syntax table, plus an explanation of | 144 Display the current contents of the syntax table, plus an explanation of |
145 what they mean (@code{describe-syntax}). @xref{Syntax}. | 145 what they mean (@code{describe-syntax}). @xref{Syntax}. |
146 @item C-h t | 146 @item C-h t |
147 Enter the Emacs interactive tutorial (@code{help-with-tutorial}). | 147 Enter the Emacs interactive tutorial (@code{help-with-tutorial}). |
148 @item C-h v @var{var} @key{RET} | 148 @item C-h v @var{var} @key{RET} |
149 Display the documentation for the Lisp variable @var{var} | 149 Display the documentation of the Lisp variable @var{var} |
150 (@code{describe-variable}). | 150 (@code{describe-variable}). |
151 @item C-h w @var{command} @key{RET} | 151 @item C-h w @var{command} @key{RET} |
152 Display the list of keys that will run the command named @var{command} | 152 Show which keys run the command named @var{command} (@code{where-is}). |
153 (@code{where-is}). | |
154 @item C-h C @var{coding} @key{RET} | 153 @item C-h C @var{coding} @key{RET} |
155 Describe a coding system @var{coding} | 154 Describe coding system @var{coding} |
156 (@code{describe-coding-system}). | 155 (@code{describe-coding-system}). |
157 @item C-h C @key{RET} | 156 @item C-h C @key{RET} |
158 Describe the coding systems currently in use. | 157 Describe the coding systems currently in use. |
159 @item C-h I @var{method} @key{RET} | 158 @item C-h I @var{method} @key{RET} |
160 Describe an input method (@code{describe-input-method}). | 159 Describe an input method (@code{describe-input-method}). |
161 @item C-h L @var{language-env} @key{RET} | 160 @item C-h L @var{language-env} @key{RET} |
162 Display information on the character sets, coding systems and input | 161 Display information on the character sets, coding systems and input |
163 methods used for a language environment @var{language-env} | 162 methods used for language environment @var{language-env} |
164 (@code{describe-language-environment}). | 163 (@code{describe-language-environment}). |
165 @item C-h C-c | 164 @item C-h C-c |
166 Display the copying conditions for GNU Emacs. | 165 Display the copying conditions for GNU Emacs. |
167 @item C-h C-d | 166 @item C-h C-d |
168 Display information about getting new versions of GNU Emacs. | 167 Display information about getting new versions of GNU Emacs. |
228 you may find that some of your favorite abbreviations that work in | 227 you may find that some of your favorite abbreviations that work in |
229 @kbd{M-x} don't work in @kbd{C-h f}. An abbreviation may be unique | 228 @kbd{M-x} don't work in @kbd{C-h f}. An abbreviation may be unique |
230 among command names yet fail to be unique when other function names are | 229 among command names yet fail to be unique when other function names are |
231 allowed. | 230 allowed. |
232 | 231 |
233 The name of the function that @kbd{C-h f} describes has a default which is | 232 The default function name for @kbd{C-h f} to describe, if you type |
234 used if you type @key{RET} leaving the minibuffer empty. The default is | 233 just @key{RET}, is the name of the function called by the innermost Lisp |
235 the function called by the innermost Lisp expression in the buffer around | 234 expression in the buffer around point, @emph{provided} that is a valid, |
236 point, @emph{provided} that is a valid, defined Lisp function name. For | 235 defined Lisp function name. For example, if point is located following |
237 example, if point is located following the text @samp{(make-vector (car | 236 the text @samp{(make-vector (car x)}, the innermost list containing |
238 x)}, the innermost list containing point is the one that starts with | 237 point is the one that starts with @samp{(make-vector}, so the default is |
239 @samp{(make-vector}, so the default is to describe the function | 238 to describe the function @code{make-vector}. |
240 @code{make-vector}. | |
241 | 239 |
242 @kbd{C-h f} is often useful just to verify that you have the right | 240 @kbd{C-h f} is often useful just to verify that you have the right |
243 spelling for the function name. If @kbd{C-h f} mentions a name from the | 241 spelling for the function name. If @kbd{C-h f} mentions a name from the |
244 buffer as the default, that name must be defined as a Lisp function. If | 242 buffer as the default, that name must be defined as a Lisp function. If |
245 that is all you want to know, just type @kbd{C-g} to cancel the @kbd{C-h | 243 that is all you want to know, just type @kbd{C-g} to cancel the @kbd{C-h |
405 the ones currently in use. @xref{Coding Systems}. | 403 the ones currently in use. @xref{Coding Systems}. |
406 | 404 |
407 @node Help Mode | 405 @node Help Mode |
408 @section Help Mode Commands | 406 @section Help Mode Commands |
409 | 407 |
410 Help buffers provide the same commands commands as the View mode | 408 Help buffers provide the same commands as View mode (@pxref{Misc File |
411 (@pxref{Misc File Ops}), plus a few special commands of their own. | 409 Ops}), plus a few special commands of their own. |
412 | 410 |
413 @table @kbd | 411 @table @kbd |
414 @item @key{SPC} | 412 @item @key{SPC} |
415 Scroll forward. | 413 Scroll forward. |
416 @item @key{DEL} | 414 @item @key{DEL} |
451 @cindex Info | 449 @cindex Info |
452 @cindex manuals, on-line | 450 @cindex manuals, on-line |
453 @cindex on-line manuals | 451 @cindex on-line manuals |
454 @kbd{C-h i} (@code{info}) runs the Info program, which is used for | 452 @kbd{C-h i} (@code{info}) runs the Info program, which is used for |
455 browsing through structured documentation files. The entire Emacs manual | 453 browsing through structured documentation files. The entire Emacs manual |
456 is available within Info. Eventually all of the documentation of the GNU | 454 is available within Info. Eventually all the documentation of the GNU |
457 system will be available. Type @kbd{h} after entering Info to run | 455 system will be available. Type @kbd{h} after entering Info to run |
458 a tutorial on using Info. | 456 a tutorial on using Info. |
459 | 457 |
460 If you specify a numeric argument, @kbd{C-h i} prompts for the name of | 458 If you specify a numeric argument, @kbd{C-h i} prompts for the name of |
461 a documentation file. This way, you can browse a file which doesn't | 459 a documentation file. This way, you can browse a file which doesn't |