(Standard Keymaps): Rename function-key-map to local-function-key-map.

[gnu-emacs] / doc / lispref / help.texi

diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi
index c23d6808488994b9194724aeb8a9444ae7de4ab9..12dedd6bd1ce0fa929ab4c65c5fc16da6f1d7494 100644 (file)
--- a/doc/lispref/help.texi
+++ b/doc/lispref/help.texi
@@ -1,7 +1,7 @@
 @c -*-texinfo-*-
 @c This is part of the GNU Emacs Lisp Reference Manual.
 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
-@c   2002, 2003, 2004, 2005, 2006, 2007  Free Software Foundation, Inc.
+@c   2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009  Free Software Foundation, Inc.
 @c See the file elisp.texi for copying conditions.
 @setfilename ../../info/help
 @node Documentation, Files, Modes, Top
@@ -247,7 +247,7 @@ but provides more information.
 
 ---------- Buffer: *Help* ----------
 goal-column     Option
-*Semipermanent goal column for vertical motion, as set by @dots{}
+Semipermanent goal column for vertical motion, as set by @dots{}
 @end group
 @c Do not blithely break or fill these lines.
 @c That makes them incorrect.
@@ -275,11 +275,6 @@ When the `track-eol' feature is doing its job, the value is 9999.
 @end group
 @end smallexample
 
-The asterisk @samp{*} as the first character of a variable's doc string,
-as shown above for the @code{goal-column} variable, means that it is a
-user option; see the description of @code{defvar} in @ref{Defining
-Variables}.
-
 @defun Snarf-documentation filename
 @anchor{Definition of Snarf-documentation}
 This function is used only during Emacs initialization, just before
@@ -688,14 +683,15 @@ binding of @kbd{C-h C-h}.
 @end defmac
 
 @defmac with-help-window buffer-name body@dots{}
-This macro evaluates the @var{body} forms inserting any output they
-produce into a buffer named @var{buffer-name}.  @code{with-help-window}
-behaves like @code{with-output-to-temp-buffer} (@pxref{Temporary
-Displays}) but does more accurately restore the previous window
-configuration when quitting Help.  It also generates the message
-informing the user how to quit and scroll the help window by itself.
-Hence you will regret it if you use @code{print-help-return-message} in
-the body of this macro.
+This macro evaluates the @var{body} forms, inserting any output they
+produce into a buffer named @var{buffer-name} like
+@code{with-output-to-temp-buffer} (@pxref{Temporary Displays}).  It
+also puts that buffer in Help mode, displays a message telling the
+user how to quit and scroll the help window, and does various other
+things that make a help window work better.
+
+Don't use @code{print-help-return-message} in the body of this macro;
+it would cause bad results.
 @end defmac
 
 @defopt three-step-help