Refill some copyright headers.
[bpt/emacs.git] / doc / lispref / help.texi
index b6210da..f010e61 100644 (file)
@@ -1,7 +1,8 @@
 @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, 2008, 2009  Free Software Foundation, Inc.
+@c   2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
+@c   Free Software Foundation, Inc.
 @c See the file elisp.texi for copying conditions.
 @setfilename ../../info/help
 @node Documentation, Files, Modes, Top
@@ -106,12 +107,6 @@ documentation string.  The functions @code{documentation} and
 documentation string from the appropriate file; this is transparent to
 the user.
 
-@c Wordy to prevent overfull hbox.  --rjc 15mar92
-  The @file{emacs/lib-src} directory contains two utilities that you can
-use to print nice-looking hardcopy for the file
-@file{emacs/etc/DOC-@var{version}}.  These are @file{sorted-doc} and
-@file{digest-doc}.
-
 @node Accessing Documentation
 @section Access to Documentation Strings
 
@@ -551,13 +546,13 @@ follows:
 
 @smallexample
 @group
-(define-key global-map (char-to-string help-char) 'help-command)
+(define-key global-map (string help-char) 'help-command)
 (fset 'help-command help-map)
 @end group
 @end smallexample
 @end deffn
 
-@defvar help-char
+@defopt help-char
 The value of this variable is the help character---the character that
 Emacs recognizes as meaning Help.  By default, its value is 8, which
 stands for @kbd{C-h}.  When Emacs reads this character, if
@@ -574,13 +569,13 @@ The help character is special after prefix keys, too.  If it has no
 binding as a subcommand of the prefix key, it runs
 @code{describe-prefix-bindings}, which displays a list of all the
 subcommands of the prefix key.
-@end defvar
+@end defopt
 
-@defvar help-event-list
+@defopt help-event-list
 The value of this variable is a list of event types that serve as
 alternative ``help characters.''  These events are handled just like the
 event specified by @code{help-char}.
-@end defvar
+@end defopt
 
 @defvar help-form
 If this variable is non-@code{nil}, its value is a form to evaluate
@@ -637,10 +632,10 @@ This variable holds the name of the directory in which Emacs finds
 certain documentation and text files that come with Emacs.
 @end defvar
 
-@deffn help-buffer
+@defun help-buffer
 This function returns the name of the help buffer, which is normally
 @samp{*Help*}; if such a buffer does not exist, it is first created.
-@end deffn
+@end defun
 
 @defmac with-help-window buffer-name body@dots{}
 This macro evaluates the @var{body} forms, inserting any output they
@@ -652,7 +647,7 @@ Help mode and displays a message telling the user how to quit and
 scroll the help window.
 @end defmac
 
-@deffn help-setup-xref item interactive-p
+@defun help-setup-xref item interactive-p
 This function updates the cross reference data in the @samp{*Help*}
 buffer, which is used to regenerate the help information when the user
 clicks on the @samp{Back} or @samp{Forward} buttons.  Most commands
@@ -663,7 +658,7 @@ to call, with argument list @var{args}, to regenerate the help buffer.
 The @var{interactive-p} argument is non-@code{nil} if the calling
 command was invoked interactively; in that case, the stack of items
 for the @samp{*Help*} buffer's @samp{Back} buttons is cleared.
-@end deffn
+@end defun
 
 @xref{describe-symbols example}, for an example of using
 @code{help-buffer}, @code{with-help-window}, and
@@ -701,6 +696,3 @@ echo area at first, and display the longer @var{help-text} strings only
 if the user types the help character again.
 @end defopt
 
-@ignore
-   arch-tag: ba36b4c2-e60f-49e2-bc25-61158fdcd815
-@end ignore