]> code.delx.au - gnu-emacs/blobdiff - man/help.texi
(org-special-keyword): New face.
[gnu-emacs] / man / help.texi
index d546440e1149a7791d72947f38b4d191b98b0f87..bcae911d55f4245124e1155f2f45dffed3ef490e 100644 (file)
@@ -1,6 +1,6 @@
 @c This is part of the Emacs manual.
-@c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 2000, 2001, 2004
-@c   Free Software Foundation, Inc.
+@c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2000, 2001,
+@c   2002, 2003, 2004, 2005 Free Software Foundation, Inc.
 @c See file emacs.texi for copying conditions.
 @node Help, Mark, M-x, Top
 @chapter Help
@@ -172,6 +172,9 @@ documented (@code{Info-goto-emacs-key-command-node}).
 @item C-h S @var{symbol} @key{RET}
 Display the Info documentation on symbol @var{symbol} according to the
 programming language you are editing (@code{info-lookup-symbol}).
+@item C-h .
+Display a help message associated with special text areas, such as
+links in @samp{*Help*} buffers (@code{display-local-help}).
 @end table
 
 @node Key Help
@@ -249,15 +252,15 @@ f} command, then go on editing.
   @kbd{C-h v} (@code{describe-variable}) is like @kbd{C-h f} but describes
 Lisp variables instead of Lisp functions.  Its default is the Lisp symbol
 around or before point, but only if that is the name of a known Lisp
-variable.  @xref{Variables}.@refill
+variable.  @xref{Variables}.
 
-  Help buffers describing variables or functions defined in Lisp
-normally have hyperlinks to the Lisp definition, if you have the Lisp
-source files installed.  If you know Lisp, this provides the ultimate
-documentation.  If you don't know Lisp, you should learn it.  If you
-are just @emph{using} Emacs, treating Emacs as an object (file), then
-you don't really love it.  For true intimacy with your editor, you
-need to read the source code.
+  Help buffers describing Emacs variables and functions normally have
+hyperlinks to the definition, if you have the source files installed.
+(@xref{Hyperlinking}.)  If you know Lisp (or C), this provides the
+ultimate documentation.  If you don't know Lisp, you should learn it.
+If you are just @emph{using} Emacs, treating Emacs as an object
+(file), then you don't really love it.  For true intimacy with your
+editor, you need to read the source code.
 
 @node Apropos
 @section Apropos
@@ -277,13 +280,14 @@ example, it would say that you can invoke @code{find-file} by typing
 normally checks only commands (interactive functions); if you specify a
 prefix argument, it checks noninteractive functions as well.
 
-  Because @kbd{C-h a} looks only for commands whose names contain the
-string you specify, you must use ingenuity in choosing the string.  If
-you are looking for commands for killing backwards and @kbd{C-h a
-kill-backwards @key{RET}} doesn't reveal any, don't give up.  Try just
-@kbd{kill}, or just @kbd{backwards}, or just @kbd{back}.  Be
-persistent.  Also note that you can use a regular expression as the
-argument, for more flexibility (@pxref{Regexps}).
+  Because @kbd{C-h a} looks only for commands matching the string you
+specify, you may not find what you want on the first try.  In that
+case, don't just give up.  You can give Apropos a list of words to
+search for.  When more than one word is specified, at least two of
+those words must be present for an item to match.  If you are looking
+for commands to kill a chunk of text before point, try @kbd{C-h a kill
+back behind before @key{RET}}.  For even greater flexibility, you can
+also supply a regular expression to Apropos (@pxref{Regexps}).
 
   Here is a set of arguments to give to @kbd{C-h a} that covers many
 classes of Emacs commands, since there are strong conventions for naming
@@ -327,6 +331,13 @@ check them.
   If the variable @code{apropos-do-all} is non-@code{nil}, the commands
 above all behave as if they had been given a prefix argument.
 
+@vindex apropos-sort-by-scores
+@cindex apropos search results, order by score
+  By default, Apropos lists the search results in alphabetical order.
+If the variable @code{apropos-sort-by-scores} is non-@code{nil},
+Apropos tries to guess the relevance of each result, and displays the
+most relevant ones first.
+
   If you want more information about a function definition, variable or
 symbol property listed in the Apropos buffer, you can click on it with
 @kbd{Mouse-1} or @kbd{Mouse-2}, or move there and type @key{RET}.
@@ -456,11 +467,15 @@ system will be available.  Type @kbd{h} after entering Info to run
 a tutorial on using Info.
 
 @cindex find Info manual by its file name
-  If you specify a numeric argument, @kbd{C-h i} prompts for the name of
-a documentation file.  This way, you can browse a file which doesn't
+  With a numeric argument, @kbd{C-h i} selects an Info buffer with the
+number appended to the default @samp{*info*} buffer name
+(e.g. @samp{*info*<2>}).  This is useful if you want to browse
+multiple Info manuals simultaneously.  If you specify just @kbd{C-u}
+as the prefix argument, @kbd{C-h i} prompts for the name of a
+documentation file.  This way, you can browse a file which doesn't
 have an entry in the top-level Info menu.  It is also handy when you
-need to get to the documentation quickly, and you know the exact name of
-the file.
+need to get to the documentation quickly, and you know the exact name
+of the file.
 
 @kindex C-h F
 @kindex C-h K
@@ -586,10 +601,20 @@ Emacs (@code{describe-no-warranty}).
 @cindex balloon help
   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
-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}.
+Areas of the mode line are examples.  On most window systems, the help
+text is displayed as a ``tooltip'' (sometimes known as ``balloon
+help'').  @xref{Tooltips}.  Otherwise, it is shown in the echo area
+when you move point into the active text.
+
+@kindex C-h .
+@findex display-local-help
+@vindex help-at-pt-display-when-idle
+  You can also access text region help info using the keyboard.  The
+command @kbd{C-h .} (@code{display-local-help}) displays any help text
+associated with the text at point, using the echo area.  If you want
+help text to be displayed automatically whenever it is available at
+point, set the variable @code{help-at-pt-display-when-idle} to
+@code{t}.
 
 @ignore
    arch-tag: 6f33ab62-bc75-4367-8057-fd67cc15c3a1