@c This is part of the Emacs manual.
-@c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2012
-@c Free Software Foundation, Inc.
+@c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2014 Free Software
+@c Foundation, Inc.
@c See file emacs.texi for copying conditions.
-@node Help, Mark, M-x, Top
+@node Help
@chapter Help
@kindex Help
@cindex help
@xref{Package Keywords}.
@end table
- @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 view 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.)
+ @kbd{C-h}, @key{F1}, or @kbd{?} means ``help'' in various other
+contexts as well. For instance, you can type them after a prefix key
+to view a list of the keys that can follow the prefix key. (A few
+prefix keys don't support @kbd{C-h} or @kbd{?} in this way, because
+they define other meanings for it, but they all support @key{F1} for
+help.)
@menu
* Help Summary:: Brief list of all Help commands.
@item C-h c @var{key}
Show the name of the command that the key sequence @var{key} is bound
to (@code{describe-key-briefly}). Here @kbd{c} stands for
-``character.'' For more extensive information on @var{key}, use
+``character''. For more extensive information on @var{key}, use
@kbd{C-h k}.
@item C-h d @var{topics} @key{RET}
Display the commands and variables whose documentation matches
@var{topics} (@code{apropos-documentation}).
@item C-h e
-Display the @code{*Messages*} buffer
+Display the @file{*Messages*} buffer
(@code{view-echo-area-messages}).
@item C-h f @var{function} @key{RET}
Display documentation on the Lisp function named @var{function}
@item C-h .
Display the help message for a special text area, if point is in one
(@code{display-local-help}). (These include, for example, links in
-@samp{*Help*} buffers.)
+@file{*Help*} buffers.)
@end table
@node Key Help
(That name appears as the default while you enter the argument.) For
example, if point is located following the text @samp{(make-vector
(car x)}, the innermost list containing point is the one that starts
-with @samp{(make-vector}, so @kbd{C-h f @key{RET}} will describe the
+with @samp{(make-vector}, so @kbd{C-h f @key{RET}} describes the
function @code{make-vector}.
@kbd{C-h f} is also useful just to verify that you spelled a
Search for functions and variables. Both interactive functions
(commands) and noninteractive functions can be found by this.
-@item M-x apropos-variable
-@findex apropos-variable
+@item M-x apropos-user-option
+@findex apropos-user-option
Search for user-customizable variables. With a prefix argument,
search for non-customizable variables too.
+@item M-x apropos-variable
+@findex apropos-variable
+Search for variables. With a prefix argument, search for
+customizable variables only.
+
@item M-x apropos-value
@findex apropos-value
Search for variables whose values match the specified pattern. With a
@section Help Mode Commands
Help buffers provide the same commands as View mode (@pxref{View
-Mode}); for instance, @key{SPC} scrolls forward, and @key{DEL} scrolls
-backward. A few special commands are also provided:
+Mode}); for instance, @key{SPC} scrolls forward, and @key{DEL} or
+@kbd{S-@key{SPC}} scrolls backward. A few special commands are also
+provided:
@table @kbd
@item @key{RET}
@kindex C-h P
@kbd{C-h P} (@code{describe-package}) prompts for the name of a
package, and displays a help buffer describing the attributes of the
-package and the features that it implements.
+package and the features that it implements. The buffer lists the
+keywords that relate to the package in the form of buttons. Click on
+a button to see other packages related to that keyword.
@node Language Help
@section Help for International Language Support
methods, as well as some sample text for that language environment.
The command @kbd{C-h h} (@code{view-hello-file}) displays the file
-@file{etc/HELLO}, which shows how to say ``hello'' in many languages.
+@file{etc/HELLO}, which demonstrates various character sets by showing
+how to say ``hello'' in many languages.
The command @kbd{C-h I} (@code{describe-input-method}) describes an
input method---either a specified input method, or by default the
@findex view-echo-area-messages
To review recent echo area messages, use @kbd{C-h e}
(@code{view-echo-area-messages}). This displays the buffer
-@code{*Messages*}, where those messages are kept.
+@file{*Messages*}, where those messages are kept.
@kindex C-h m
@findex describe-mode
@kindex C-h b
@findex describe-bindings
+@kindex C-h s
+@findex describe-syntax
@kbd{C-h b} (@code{describe-bindings}) and @kbd{C-h s}
(@code{describe-syntax}) show other information about the current
environment within Emacs. @kbd{C-h b} displays a list of all the key
@findex describe-prefix-bindings
You can get a list of subcommands for a particular prefix key by
-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.)
+typing @kbd{C-h}, @kbd{?}, or @key{F1}
+(@code{describe-prefix-bindings}) after the prefix key. (There are a
+few prefix keys for which not all of these keys work---those that
+provide their own bindings for one of them. One of these prefix keys
+is @key{ESC} in combination with @kbd{C-h}, because @kbd{@key{ESC} C-h} is
+actually @kbd{C-M-h}, which marks a defun. However, @kbd{@key{ESC} @key{F1}}
+and @kbd{@key{ESC} ?} work fine.)
@node Help Files
@section Help Files
HCoop / bpt / emacs.git / blobdiff