X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/0ec1f11554a528e81e9fc7eb2164154bedd532a3..4d8ae757b2662eca9e0d49c3fb27e69fb85cab85:/man/help.texi diff --git a/man/help.texi b/man/help.texi index ca9e824e06..0ee1adda21 100644 --- a/man/help.texi +++ b/man/help.texi @@ -80,6 +80,13 @@ Finally, you can try looking up a suitable package using keywords pertinent to the feature you need. @xref{Library Keywords}. @end table + To find the documentation of a key sequence or a menu item, type +@kbd{C-h C-k} and then type that key sequence or select the menu +item. This looks up the description of the command invoked by the key +or the menu in the appropriate manual (not necessarily the Emacs +manual). Likewise, use @kbd{C-h C-f} for reading documentation of a +command. + @menu * Help Summary:: Brief list of all Help commands. * Key Help:: Asking what a key does in Emacs. @@ -185,8 +192,8 @@ programming language you are editing (@code{info-lookup-symbol}). @findex describe-key-briefly The most basic @kbd{C-h} options are @kbd{C-h c} (@code{describe-key-briefly}) and @w{@kbd{C-h k}} (@code{describe-key}). -@kbd{C-h c @var{key}} prints in the echo area the name of the command -that @var{key} is bound to. For example, @kbd{C-h c C-f} prints +@kbd{C-h c @var{key}} displays in the echo area the name of the command +that @var{key} is bound to. For example, @kbd{C-h c C-f} displays @samp{forward-char}. Since command names are chosen to describe what the commands do, this is a good way to get a very brief description of what @var{key} does. @@ -246,7 +253,7 @@ f} command, then go on editing. @kindex C-h w @findex where-is @kbd{C-h w @var{command} @key{RET}} tells you what keys are bound to -@var{command}. It prints a list of the keys in the echo area. If it +@var{command}. It displays a list of the keys in the echo area. If it says the command is not on any key, you must use @kbd{M-x} to run it. @kbd{C-h w} runs the command @code{where-is}. @@ -375,7 +382,7 @@ processes --- process, subshell, compilation, and job control support. terminals --- support for terminal types. tex --- support for the @TeX{} formatter. tools --- programming tools. -unix --- front-ends/assistants for, or emulators of, Unix features. +unix --- front-ends/assistants for, or emulators of, system features. vms --- support code for VMS. wp --- word processing. @end display @@ -471,7 +478,15 @@ goes straight to the documentation of the Emacs function @var{function}. @kbd{C-h C-k @var{key}} enters Info and goes straight to the documentation of the key @var{key}. These two keys run the commands @code{Info-goto-emacs-command-node} and -@code{Info-goto-emacs-key-command-node}. +@code{Info-goto-emacs-key-command-node}. You can use @kbd{C-h C-k} to +find the documentation of a menu item: just select that menu item when +@kbd{C-h C-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. When editing a program, if you have an Info version of the manual for the programming language, you can use the command @kbd{C-h C-i} to refer @@ -482,7 +497,7 @@ mode. @kindex C-h l @findex view-lossage If something surprising happens, and you are not sure what commands you -typed, use @kbd{C-h l} (@code{view-lossage}). @kbd{C-h l} prints the last +typed, use @kbd{C-h l} (@code{view-lossage}). @kbd{C-h l} displays the last 100 command characters you typed in. If you see commands that you don't know, you can use @kbd{C-h c} to find out what they do. @@ -490,7 +505,7 @@ know, you can use @kbd{C-h c} to find out what they do. @findex describe-mode Emacs has numerous major modes, each of which redefines a few keys and makes a few other changes in how editing works. @kbd{C-h m} -(@code{describe-mode}) prints documentation on the current major mode, +(@code{describe-mode}) displays documentation on the current major mode, which normally describes all the commands that are changed in this mode. @@ -551,6 +566,6 @@ various situations with solutions or workarounds in many cases. When a region of text is ``active,'' so that you can select it with the mouse or a key like @kbd{RET}, it often has associated help text. Areas of the mode line are examples. This help will normally be -printed in the echo area when you move point into the active text. In +shown in the echo area when you move point into the active text. In a window system you can display the help text as a ``tooltip'' (sometimes known as ``balloon help''). @xref{Tooltips}.