]> code.delx.au - gnu-emacs/blobdiff - doc/emacs/help.texi
* streams.texi (Output Functions): Document `pp'.
[gnu-emacs] / doc / emacs / help.texi
index ee170e0c7da814d6af90552dcf55a1d4c5f57a80..e00f8b9115a52a1ac85b2a006e2ca88dd8119ed3 100644 (file)
@@ -1,6 +1,6 @@
 @c This is part of the Emacs manual.
-@c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2000, 2001,
-@c   2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
+@c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2011
+@c   Free Software Foundation, Inc.
 @c See file emacs.texi for copying conditions.
 @node Help, Mark, M-x, Top
 @chapter Help
@@ -14,7 +14,7 @@
   Emacs provides extensive help features, all accessible through the
 @dfn{help character}, @kbd{C-h}.  This is a prefix key that is used
 for commands that display documentation; the next character you type
-should be a @dfn{help options}, to ask for a particular kind of help.
+should be a @dfn{help option}, to ask for a particular kind of help.
 You can cancel the @kbd{C-h} command with @kbd{C-g}.  The function key
 @key{F1} is equivalent to @kbd{C-h}.
 
@@ -28,7 +28,7 @@ a list of help options, with a brief description of each one
 
   @kbd{C-h} or @key{F1} means ``help'' in various other contexts as
 well.  For instance, you can type them after a prefix key to display
-list of the keys that can follow the prefix key.  (A few prefix keys
+list of the keys that can follow the prefix key.  (A few prefix keys
 don't support @kbd{C-h} in this way, because they define other
 meanings for it, but they all support @key{F1} for help.)
 
@@ -48,8 +48,7 @@ FAQ and the package keywords.
 @item C-h a @var{topics} @key{RET}
 This searches for commands whose names match the argument
 @var{topics}.  The argument can be a keyword, a list of keywords, or a
-regular expression (@pxref{Regexps}).  This command displays all the
-matches in a new buffer.  @xref{Apropos}.
+regular expression (@pxref{Regexps}).  @xref{Apropos}.
 
 @item C-h i d m emacs @key{RET} i @var{topic} @key{RET}
 This searches for @var{topic} in the indices of the on-line Emacs
@@ -70,16 +69,16 @@ This displays the available Emacs packages based on keywords.
 @end table
 
 @menu
-* Help Summary::       Brief list of all Help commands.
-* Key Help::           Asking what a key does in Emacs.
-* Name Help::          Asking about a command, variable or function name.
-* Apropos::            Asking what pertains to a given topic.
+* Help Summary::        Brief list of all Help commands.
+* Key Help::            Asking what a key does in Emacs.
+* Name Help::           Asking about a command, variable or function name.
+* Apropos::             Asking what pertains to a given topic.
 * Help Mode::           Special features of Help mode and Help buffers.
-* Library Keywords::   Finding Lisp libraries by keywords (topics).
+* Library Keywords::    Finding Lisp libraries by keywords (topics).
 * Language Help::       Help relating to international language support.
-* Misc Help::          Other help commands.
+* Misc Help::           Other help commands.
 * Help Files::          Commands to display pre-written help files.
-* Help Echo::           Help on active text and tooltips (`balloon help')
+* Help Echo::           Help on active text and tooltips (`balloon help').
 @end menu
 
 @iftex
@@ -91,9 +90,9 @@ This displays the available Emacs packages based on keywords.
 @end ifnottex
 
   Here is a summary of the Emacs interactive help commands.  (The
-character that follows @kbd{C-h} is the ``help option.'')  @xref{Help
-Files}, for other help commands that display fixed files of
-information.
+character that follows @kbd{C-h} is the ``help option.'')  See
+@ref{Help Files}, for other help commands that display fixed files
+of information.
 
 @table @kbd
 @item C-h a @var{topics} @key{RET}
@@ -127,12 +126,18 @@ The complete Emacs manual is available on-line in Info.
 Display the name and documentation of the command that @var{key} runs
 (@code{describe-key}).
 @item C-h l
-Display a description of the last 100 characters you typed
+Display a description of your last 300 keystrokes 
 (@code{view-lossage}).
 @item C-h m
 Display documentation of the current major mode (@code{describe-mode}).
+@item C-h n
+Display news of recent Emacs changes (@code{view-emacs-news}).
 @item C-h p
-Find packages by topic keyword (@code{finder-by-keyword}).
+Find packages by topic keyword (@code{finder-by-keyword}).  For an
+alternative interface to the same information, try the @code{info-finder}
+command.
+@item C-h r
+Display the Emacs manual in Info (@code{info-emacs-manual}).
 @item C-h s
 Display the current contents of the syntax table, with an explanation of
 what they mean (@code{describe-syntax}).  @xref{Syntax}.
@@ -148,18 +153,18 @@ Describe the coding system @var{coding}
 (@code{describe-coding-system}).
 @item C-h C @key{RET}
 Describe the coding systems currently in use.
+@item C-h F @var{command} @key{RET}
+Enter Info and go to the node that documents the Emacs command
+@var{command} (@code{Info-goto-emacs-command-node}).
 @item C-h I @var{method} @key{RET}
 Describe the input method @var{method} (@code{describe-input-method}).
+@item C-h K @var{key}
+Enter Info and go to the node that documents the key sequence
+@var{key} (@code{Info-goto-emacs-key-command-node}).
 @item C-h L @var{language-env} @key{RET}
 Display information on the character sets, coding systems, and input
 methods used in language environment @var{language-env}
 (@code{describe-language-environment}).
-@item C-h F @var{function} @key{RET}
-Enter Info and go to the node that documents the Emacs function
-@var{function} (@code{Info-goto-emacs-command-node}).
-@item C-h K @var{key}
-Enter Info and go to the node that documents the key sequence
-@var{key} (@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}).
@@ -270,7 +275,7 @@ read the Emacs source code.
 
 @kindex C-h F
 @findex Info-goto-emacs-command-node
-  To find a function's documentation in a manual, use @kbd{C-h F}
+  To find a command's documentation in a manual, use @kbd{C-h F}
 (@code{Info-goto-emacs-command-node}).  This knows about various
 manuals, not just the Emacs manual, and finds the right one.
 
@@ -551,10 +556,10 @@ command works depend on the major mode.
 
 @kindex C-h l
 @findex view-lossage
-  If something surprising happens, and you are not sure what you
-typed, use @kbd{C-h l} (@code{view-lossage}).  @kbd{C-h l} displays
-the last 100 characters you typed in Emacs.  If you see commands that
-you don't know, you can use @kbd{C-h c} to find out what they do.
+  If something surprising happens, and you are not sure what you typed,
+use @kbd{C-h l} (@code{view-lossage}).  @kbd{C-h l} displays your last
+300 input keystrokes.  If you see commands that you don't know, you can
+use @kbd{C-h c} to find out what they do.
 
 @kindex C-h e
 @findex view-echo-area-messages
@@ -591,22 +596,29 @@ is actually @kbd{C-M-h}, which marks a defun.)
 
   The Emacs help commands described above display dynamic help based
 on the current state within Emacs, or refer to manuals.  Other help
-commands display pre-written, static help files.  These commands all
-have the form @kbd{C-h C-@var{char}}; that is, @kbd{C-h} followed by a
-control character.
+commands display pre-written, static help files.
+
+  Except for @kbd{C-h g}, these commands all have the form @kbd{C-h
+C-@var{char}}; that is, @kbd{C-h} followed by a control character.
 
 @kindex C-h C-c
 @findex describe-copying
 @kindex C-h C-d
-@findex describe-distribution
+@findex view-emacs-debugging
 @kindex C-h C-e
-@findex view-emacs-problems
+@findex view-external-packages
 @kindex C-h C-f
 @findex view-emacs-FAQ
+@kindex C-h g
+@findex describe-gnu-project
+@kindex C-h C-m
+@findex view-order-manuals
 @kindex C-h C-n
 @findex view-emacs-news
+@kindex C-h C-o
+@findex describe-distribution
 @kindex C-h C-p
-@findex describe-project
+@findex view-emacs-problems
 @kindex C-h C-t
 @findex view-emacs-todo
 @kindex C-h C-w
@@ -617,21 +629,29 @@ control character.
 Display the Emacs copying conditions (@code{describe-copying}).
 These are the rules under which you can copy and redistribute Emacs.
 @item C-h C-d
-Display how to download or order the latest version of
-Emacs and other GNU software (@code{describe-distribution}).
+Display help for debugging Emacs (@code{view-emacs-debugging}).
 @item C-h C-e
-Display the list of known Emacs problems, sometimes with suggested
-workarounds (@code{view-emacs-problems}).
+Display external packages and information about Emacs
+(@code{view-external-packages}).
 @item C-h C-f
 Display the Emacs frequently-answered-questions list (@code{view-emacs-FAQ}).
+@item C-h g
+Display general information about the GNU Project
+(@code{describe-gnu-project}).
+@item C-h C-m
+Display how to order printed copies of Emacs manuals
+(@code{view-order-manuals}).
 @item C-h C-n
 Display the Emacs ``news'' file, which lists new features in the most
 recent version of Emacs (@code{view-emacs-news}).
+@item C-h C-o
+Display how to order or download the latest version of
+Emacs and other GNU software (@code{describe-distribution}).
 @item C-h C-p
-Display general information about the GNU Project
-(@code{describe-project}).
+Display the list of known Emacs problems, sometimes with suggested
+workarounds (@code{view-emacs-problems}).
 @item C-h C-t
-Display the Emacs to-do list (@code{view-todo}).
+Display the Emacs to-do list (@code{view-emacs-todo}).
 @item C-h C-w
 Display the full details on the complete absence of warranty for GNU
 Emacs (@code{describe-no-warranty}).
@@ -659,7 +679,3 @@ help text for active buffer text using the keyboard.  @kbd{C-h .}
 character after point, using the echo area.  To display help text
 automatically whenever it is available on the character after point, set
 the variable @code{help-at-pt-display-when-idle} to @code{t}.
-
-@ignore
-   arch-tag: 6f33ab62-bc75-4367-8057-fd67cc15c3a1
-@end ignore