diff options
| author | Richard M. Stallman | 2005-03-26 01:52:50 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2005-03-26 01:52:50 +0000 |
| commit | 8f4fc840983b751739c5604501c59d3c02fef5e4 (patch) | |
| tree | 3e081d5f786c57271d1a720a95b8f559652dcc7a | |
| parent | 360b756f3cf0d9d647d1cf773859eb5111afcee3 (diff) | |
| download | emacs-8f4fc840983b751739c5604501c59d3c02fef5e4.tar.gz emacs-8f4fc840983b751739c5604501c59d3c02fef5e4.zip | |
(Help Summary): Add `C-h .'.
(Apropos): Apropos accepts a list of search terms.
Document apropos-sort-by-scores.
(Help Echo): Document display-local-help.
| -rw-r--r-- | man/help.texi | 42 |
1 files changed, 31 insertions, 11 deletions
diff --git a/man/help.texi b/man/help.texi index 8f7eed4915c..d3e6f13262d 100644 --- a/man/help.texi +++ b/man/help.texi | |||
| @@ -172,6 +172,9 @@ documented (@code{Info-goto-emacs-key-command-node}). | |||
| 172 | @item C-h S @var{symbol} @key{RET} | 172 | @item C-h S @var{symbol} @key{RET} |
| 173 | Display the Info documentation on symbol @var{symbol} according to the | 173 | Display the Info documentation on symbol @var{symbol} according to the |
| 174 | programming language you are editing (@code{info-lookup-symbol}). | 174 | programming language you are editing (@code{info-lookup-symbol}). |
| 175 | @item C-h . | ||
| 176 | Display a help message associated with special text areas, such as | ||
| 177 | links (@code{display-local-help}). | ||
| 175 | @end table | 178 | @end table |
| 176 | 179 | ||
| 177 | @node Key Help | 180 | @node Key Help |
| @@ -277,13 +280,14 @@ example, it would say that you can invoke @code{find-file} by typing | |||
| 277 | normally checks only commands (interactive functions); if you specify a | 280 | normally checks only commands (interactive functions); if you specify a |
| 278 | prefix argument, it checks noninteractive functions as well. | 281 | prefix argument, it checks noninteractive functions as well. |
| 279 | 282 | ||
| 280 | Because @kbd{C-h a} looks only for commands whose names contain the | 283 | Because @kbd{C-h a} looks only for commands matching the string you |
| 281 | string you specify, you must use ingenuity in choosing the string. If | 284 | specify, you may not find what you want on the first try. In that |
| 282 | you are looking for commands for killing backwards and @kbd{C-h a | 285 | case, don't just give up. You can give Apropos a list of words to |
| 283 | kill-backwards @key{RET}} doesn't reveal any, don't give up. Try just | 286 | search for. When more than one word is specified, at least two of |
| 284 | @kbd{kill}, or just @kbd{backwards}, or just @kbd{back}. Be | 287 | those words must be present for an item to match. If you are looking |
| 285 | persistent. Also note that you can use a regular expression as the | 288 | for commands to kill a chunk of text before point, try @kbd{C-h a kill |
| 286 | argument, for more flexibility (@pxref{Regexps}). | 289 | back behind before @key{RET}}. For even greater flexibility, you can |
| 290 | also supply a regular expression to Apropos (@pxref{Regexps}). | ||
| 287 | 291 | ||
| 288 | Here is a set of arguments to give to @kbd{C-h a} that covers many | 292 | Here is a set of arguments to give to @kbd{C-h a} that covers many |
| 289 | classes of Emacs commands, since there are strong conventions for naming | 293 | classes of Emacs commands, since there are strong conventions for naming |
| @@ -327,6 +331,12 @@ check them. | |||
| 327 | If the variable @code{apropos-do-all} is non-@code{nil}, the commands | 331 | If the variable @code{apropos-do-all} is non-@code{nil}, the commands |
| 328 | above all behave as if they had been given a prefix argument. | 332 | above all behave as if they had been given a prefix argument. |
| 329 | 333 | ||
| 334 | @vindex apropos-sort-by-scores | ||
| 335 | By default, Apropos lists the search results in alphabetical order. | ||
| 336 | If the variable @code{apropos-sort-by-scores} is non-@code{nil}, | ||
| 337 | Apropos tries to guess the relevance of each result, and displays the | ||
| 338 | most relevant ones first. | ||
| 339 | |||
| 330 | If you want more information about a function definition, variable or | 340 | If you want more information about a function definition, variable or |
| 331 | symbol property listed in the Apropos buffer, you can click on it with | 341 | symbol property listed in the Apropos buffer, you can click on it with |
| 332 | @kbd{Mouse-1} or @kbd{Mouse-2}, or move there and type @key{RET}. | 342 | @kbd{Mouse-1} or @kbd{Mouse-2}, or move there and type @key{RET}. |
| @@ -590,10 +600,20 @@ Emacs (@code{describe-no-warranty}). | |||
| 590 | @cindex balloon help | 600 | @cindex balloon help |
| 591 | When a region of text is ``active,'' so that you can select it with | 601 | When a region of text is ``active,'' so that you can select it with |
| 592 | the mouse or a key like @kbd{RET}, it often has associated help text. | 602 | the mouse or a key like @kbd{RET}, it often has associated help text. |
| 593 | Areas of the mode line are examples. This help will normally be | 603 | Areas of the mode line are examples. On most window systems, the help |
| 594 | shown in the echo area when you move point into the active text. In | 604 | text is displayed as a ``tooltip'' (sometimes known as ``balloon |
| 595 | a window system you can display the help text as a ``tooltip'' | 605 | help''). @xref{Tooltips}. Otherwise, it is shown in the echo area |
| 596 | (sometimes known as ``balloon help''). @xref{Tooltips}. | 606 | when you move point into the active text. |
| 607 | |||
| 608 | @kindex C-h . | ||
| 609 | @findex display-local-help | ||
| 610 | @vindex help-at-pt-display-when-idle | ||
| 611 | You can also access text region help info using the keyboard. The | ||
| 612 | command @kbd{C-h .} (@code{display-local-help}) displays any help text | ||
| 613 | associated with the text at point, using the echo area. If you want | ||
| 614 | help text to be displayed automatically whenever it is available at | ||
| 615 | point, set the variable @code{help-at-pt-display-when-idle} to | ||
| 616 | @code{t}. | ||
| 597 | 617 | ||
| 598 | @ignore | 618 | @ignore |
| 599 | arch-tag: 6f33ab62-bc75-4367-8057-fd67cc15c3a1 | 619 | arch-tag: 6f33ab62-bc75-4367-8057-fd67cc15c3a1 |