diff options
| author | Martin Rudalics | 2008-12-24 18:01:06 +0000 |
|---|---|---|
| committer | Martin Rudalics | 2008-12-24 18:01:06 +0000 |
| commit | 9de159632268f280f0993d9f671027fefc486b46 (patch) | |
| tree | e7967640c6ef986d58effc09349f065b20b2f2e8 | |
| parent | 747d9d142f491daeec55df386d626915ddb3b5dc (diff) | |
| download | emacs-9de159632268f280f0993d9f671027fefc486b46.tar.gz emacs-9de159632268f280f0993d9f671027fefc486b46.zip | |
(Help): Fix typos and reword.
(Help Summary): Add entries for C-h n and C-h r, reorder
entries, and do some minor fixes.
(Name Help): Say that C-h F works for commands only.
(Misc Help): Say that view-lossage displays 300 keystrokes.
| -rw-r--r-- | doc/emacs/ChangeLog | 8 | ||||
| -rw-r--r-- | doc/emacs/help.texi | 41 |
2 files changed, 30 insertions, 19 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 2155eb9ef2a..771161c0e01 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,11 @@ | |||
| 1 | 2008-12-24 Martin Rudalics <rudalics@gmx.at> | ||
| 2 | |||
| 3 | * help.texi (Help): Fix typos and reword. | ||
| 4 | (Help Summary): Add entries for C-h n and C-h r, reorder | ||
| 5 | entries, and do some minor fixes. | ||
| 6 | (Name Help): Say that C-h F works for commands only. | ||
| 7 | (Misc Help): Say that view-lossage displays 300 keystrokes. | ||
| 8 | |||
| 1 | 2008-12-20 Glenn Morris <rgm@gnu.org> | 9 | 2008-12-20 Glenn Morris <rgm@gnu.org> |
| 2 | 10 | ||
| 3 | * ack.texi (Acknowledgments): General update based on AUTHORS, | 11 | * ack.texi (Acknowledgments): General update based on AUTHORS, |
diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index 9f2008e060d..6fb62cf7827 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi | |||
| @@ -14,7 +14,7 @@ | |||
| 14 | Emacs provides extensive help features, all accessible through the | 14 | Emacs provides extensive help features, all accessible through the |
| 15 | @dfn{help character}, @kbd{C-h}. This is a prefix key that is used | 15 | @dfn{help character}, @kbd{C-h}. This is a prefix key that is used |
| 16 | for commands that display documentation; the next character you type | 16 | for commands that display documentation; the next character you type |
| 17 | should be a @dfn{help options}, to ask for a particular kind of help. | 17 | should be a @dfn{help option}, to ask for a particular kind of help. |
| 18 | You can cancel the @kbd{C-h} command with @kbd{C-g}. The function key | 18 | You can cancel the @kbd{C-h} command with @kbd{C-g}. The function key |
| 19 | @key{F1} is equivalent to @kbd{C-h}. | 19 | @key{F1} is equivalent to @kbd{C-h}. |
| 20 | 20 | ||
| @@ -28,7 +28,7 @@ a list of help options, with a brief description of each one | |||
| 28 | 28 | ||
| 29 | @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 |
| 30 | well. For instance, you can type them after a prefix key to display | 30 | well. For instance, you can type them after a prefix key to display |
| 31 | list of the keys that can follow the prefix key. (A few prefix keys | 31 | a list of the keys that can follow the prefix key. (A few prefix keys |
| 32 | don't support @kbd{C-h} in this way, because they define other | 32 | don't support @kbd{C-h} in this way, because they define other |
| 33 | meanings for it, but they all support @key{F1} for help.) | 33 | meanings for it, but they all support @key{F1} for help.) |
| 34 | 34 | ||
| @@ -48,8 +48,7 @@ FAQ and the package keywords. | |||
| 48 | @item C-h a @var{topics} @key{RET} | 48 | @item C-h a @var{topics} @key{RET} |
| 49 | This searches for commands whose names match the argument | 49 | This searches for commands whose names match the argument |
| 50 | @var{topics}. The argument can be a keyword, a list of keywords, or a | 50 | @var{topics}. The argument can be a keyword, a list of keywords, or a |
| 51 | regular expression (@pxref{Regexps}). This command displays all the | 51 | regular expression (@pxref{Regexps}). @xref{Apropos}. |
| 52 | matches in a new buffer. @xref{Apropos}. | ||
| 53 | 52 | ||
| 54 | @item C-h i d m emacs @key{RET} i @var{topic} @key{RET} | 53 | @item C-h i d m emacs @key{RET} i @var{topic} @key{RET} |
| 55 | This searches for @var{topic} in the indices of the on-line Emacs | 54 | This searches for @var{topic} in the indices of the on-line Emacs |
| @@ -91,9 +90,9 @@ This displays the available Emacs packages based on keywords. | |||
| 91 | @end ifnottex | 90 | @end ifnottex |
| 92 | 91 | ||
| 93 | Here is a summary of the Emacs interactive help commands. (The | 92 | Here is a summary of the Emacs interactive help commands. (The |
| 94 | character that follows @kbd{C-h} is the ``help option.'') @xref{Help | 93 | character that follows @kbd{C-h} is the ``help option.'') See |
| 95 | Files}, for other help commands that display fixed files of | 94 | @ref{Help Files}, for other help commands that display fixed files |
| 96 | information. | 95 | of information. |
| 97 | 96 | ||
| 98 | @table @kbd | 97 | @table @kbd |
| 99 | @item C-h a @var{topics} @key{RET} | 98 | @item C-h a @var{topics} @key{RET} |
| @@ -127,12 +126,16 @@ The complete Emacs manual is available on-line in Info. | |||
| 127 | Display the name and documentation of the command that @var{key} runs | 126 | Display the name and documentation of the command that @var{key} runs |
| 128 | (@code{describe-key}). | 127 | (@code{describe-key}). |
| 129 | @item C-h l | 128 | @item C-h l |
| 130 | Display a description of the last 100 characters you typed | 129 | Display a description of your last 300 keystrokes |
| 131 | (@code{view-lossage}). | 130 | (@code{view-lossage}). |
| 132 | @item C-h m | 131 | @item C-h m |
| 133 | Display documentation of the current major mode (@code{describe-mode}). | 132 | Display documentation of the current major mode (@code{describe-mode}). |
| 133 | @item C-h n | ||
| 134 | Display news of recent Emacs changes (@code{view-emacs-news}). | ||
| 134 | @item C-h p | 135 | @item C-h p |
| 135 | Find packages by topic keyword (@code{finder-by-keyword}). | 136 | Find packages by topic keyword (@code{finder-by-keyword}). |
| 137 | @item C-h r | ||
| 138 | Display the Emacs manual in Info (@code{info-emacs-manual}). | ||
| 136 | @item C-h s | 139 | @item C-h s |
| 137 | Display the current contents of the syntax table, with an explanation of | 140 | Display the current contents of the syntax table, with an explanation of |
| 138 | what they mean (@code{describe-syntax}). @xref{Syntax}. | 141 | what they mean (@code{describe-syntax}). @xref{Syntax}. |
| @@ -148,18 +151,18 @@ Describe the coding system @var{coding} | |||
| 148 | (@code{describe-coding-system}). | 151 | (@code{describe-coding-system}). |
| 149 | @item C-h C @key{RET} | 152 | @item C-h C @key{RET} |
| 150 | Describe the coding systems currently in use. | 153 | Describe the coding systems currently in use. |
| 154 | @item C-h F @var{command} @key{RET} | ||
| 155 | Enter Info and go to the node that documents the Emacs command | ||
| 156 | @var{command} (@code{Info-goto-emacs-command-node}). | ||
| 151 | @item C-h I @var{method} @key{RET} | 157 | @item C-h I @var{method} @key{RET} |
| 152 | Describe the input method @var{method} (@code{describe-input-method}). | 158 | Describe the input method @var{method} (@code{describe-input-method}). |
| 159 | @item C-h K @var{key} | ||
| 160 | Enter Info and go to the node that documents the key sequence | ||
| 161 | @var{key} (@code{Info-goto-emacs-key-command-node}). | ||
| 153 | @item C-h L @var{language-env} @key{RET} | 162 | @item C-h L @var{language-env} @key{RET} |
| 154 | Display information on the character sets, coding systems, and input | 163 | Display information on the character sets, coding systems, and input |
| 155 | methods used in language environment @var{language-env} | 164 | methods used in language environment @var{language-env} |
| 156 | (@code{describe-language-environment}). | 165 | (@code{describe-language-environment}). |
| 157 | @item C-h F @var{function} @key{RET} | ||
| 158 | Enter Info and go to the node that documents the Emacs function | ||
| 159 | @var{function} (@code{Info-goto-emacs-command-node}). | ||
| 160 | @item C-h K @var{key} | ||
| 161 | Enter Info and go to the node that documents the key sequence | ||
| 162 | @var{key} (@code{Info-goto-emacs-key-command-node}). | ||
| 163 | @item C-h S @var{symbol} @key{RET} | 166 | @item C-h S @var{symbol} @key{RET} |
| 164 | Display the Info documentation on symbol @var{symbol} according to the | 167 | Display the Info documentation on symbol @var{symbol} according to the |
| 165 | programming language you are editing (@code{info-lookup-symbol}). | 168 | programming language you are editing (@code{info-lookup-symbol}). |
| @@ -270,7 +273,7 @@ read the Emacs source code. | |||
| 270 | 273 | ||
| 271 | @kindex C-h F | 274 | @kindex C-h F |
| 272 | @findex Info-goto-emacs-command-node | 275 | @findex Info-goto-emacs-command-node |
| 273 | To find a function's documentation in a manual, use @kbd{C-h F} | 276 | To find a command's documentation in a manual, use @kbd{C-h F} |
| 274 | (@code{Info-goto-emacs-command-node}). This knows about various | 277 | (@code{Info-goto-emacs-command-node}). This knows about various |
| 275 | manuals, not just the Emacs manual, and finds the right one. | 278 | manuals, not just the Emacs manual, and finds the right one. |
| 276 | 279 | ||
| @@ -551,10 +554,10 @@ command works depend on the major mode. | |||
| 551 | 554 | ||
| 552 | @kindex C-h l | 555 | @kindex C-h l |
| 553 | @findex view-lossage | 556 | @findex view-lossage |
| 554 | If something surprising happens, and you are not sure what you | 557 | If something surprising happens, and you are not sure what you typed, |
| 555 | typed, use @kbd{C-h l} (@code{view-lossage}). @kbd{C-h l} displays | 558 | use @kbd{C-h l} (@code{view-lossage}). @kbd{C-h l} displays your last |
| 556 | the last 100 characters you typed in Emacs. If you see commands that | 559 | 300 input keystrokes. If you see commands that you don't know, you can |
| 557 | you don't know, you can use @kbd{C-h c} to find out what they do. | 560 | use @kbd{C-h c} to find out what they do. |
| 558 | 561 | ||
| 559 | @kindex C-h e | 562 | @kindex C-h e |
| 560 | @findex view-echo-area-messages | 563 | @findex view-echo-area-messages |