@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, 2008 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
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}.
@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
+a 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.)
@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
@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
@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}
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}). This lists
+packages using a package menu buffer (@pxref{Package Menu}); for an
+alternative interface to the same information, try the
+@code{info-finder} command.
+@item C-h P @var{package} @key{RET}
+Display documentation about the package named @var{package}
+(@code{describe-package}; @pxref{Packages}).
+@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}.
+Display the current contents of the @dfn{syntax table}, with an
+explanation of what they mean (@code{describe-syntax}). The syntax
+table says which characters are opening delimiters, which are parts of
+words, which are string quotes, and so on. @xref{Syntax Tables,,
+Syntax Tables, elisp, The Emacs Lisp Reference Manual}, for details.
@item C-h t
Enter the Emacs interactive tutorial (@code{help-with-tutorial}).
@item C-h v @var{var} @key{RET}
(@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}).
@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.
@node Help Mode
@section Help Mode Commands
- Help buffers provide the same commands as View mode (@pxref{Misc File
-Ops}), plus a few special commands of their own.
+ Help buffers provide the same commands as View mode (@pxref{View
+Mode}), plus a few special commands of their own.
@table @kbd
@item @key{SPC}
@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
modes, then the local bindings defined by the current major mode, and
finally the global bindings (@pxref{Key Bindings}). @kbd{C-h s}
displays the contents of the syntax table, with explanations of each
-character's syntax (@pxref{Syntax}).
+character's syntax (@pxref{Syntax Tables,, Syntax Tables, elisp, The
+Emacs Lisp Reference Manual}).
+@findex describe-prefix-bindings
You can get a list of subcommands for a particular prefix key by
-typing @kbd{C-h} after the prefix key. (There are a few prefix keys
-for which this does not work---those that provide their own bindings
-for @kbd{C-h}. One of these is @key{ESC}, because @kbd{@key{ESC} C-h}
-is actually @kbd{C-M-h}, which marks a defun.)
+typing @kbd{C-h} (@code{describe-prefix-bindings}) after the prefix
+key. (There are a few prefix keys for which this does not
+work---those that provide their own bindings for @kbd{C-h}. One of
+these is @key{ESC}, because @kbd{@key{ESC} C-h} is actually
+@kbd{C-M-h}, which marks a defun.)
@node Help Files
@section Help Files
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 debug Emacs problems (@code{view-emacs-debugging}).
+Display help for debugging Emacs (@code{view-emacs-debugging}).
+@item C-h C-e
+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
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
HCoop / bpt / emacs.git / blobdiff