Mercurial > emacs
comparison man/help.texi @ 60953:ec2b6eebb74a
(Help Summary): Add `C-h .'.
(Apropos): Apropos accepts a list of search terms.
Document apropos-sort-by-scores.
(Help Echo): Document display-local-help.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sat, 26 Mar 2005 01:52:50 +0000 |
parents | b88d819aa8d5 |
children | 1978175440c1 |
comparison
equal
deleted
inserted
replaced
60952:7dd13cb23e14 | 60953:ec2b6eebb74a |
---|---|
170 Enter Info and go to the node where the key sequence @var{key} is | 170 Enter Info and go to the node where the key sequence @var{key} is |
171 documented (@code{Info-goto-emacs-key-command-node}). | 171 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 |
178 @section Documentation for a Key | 181 @section Documentation for a Key |
179 | 182 |
275 @kbd{C-x C-f}. The @kbd{a} in @kbd{C-h a} stands for ``Apropos''; | 278 @kbd{C-x C-f}. The @kbd{a} in @kbd{C-h a} stands for ``Apropos''; |
276 @kbd{C-h a} runs the command @code{apropos-command}. This command | 279 @kbd{C-h a} runs the command @code{apropos-command}. This command |
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 |
290 the standard Emacs commands. By giving you a feel for the naming | 294 the standard Emacs commands. By giving you a feel for the naming |
291 conventions, this set should also serve to aid you in developing a | 295 conventions, this set should also serve to aid you in developing a |
324 check them. | 328 check them. |
325 | 329 |
326 @vindex apropos-do-all | 330 @vindex apropos-do-all |
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. |
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. | |
329 | 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}. |
333 | 343 |
588 | 598 |
589 @cindex tooltips | 599 @cindex tooltips |
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 |
600 @end ignore | 620 @end ignore |