help.texi 27 KB
Newer Older
Dave Love's avatar
#  
Dave Love committed
1
@c This is part of the Emacs manual.
2
@c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2000, 2001,
Glenn Morris's avatar
Glenn Morris committed
3
@c   2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Dave Love's avatar
#  
Dave Love committed
4 5 6 7 8 9 10 11 12 13
@c See file emacs.texi for copying conditions.
@node Help, Mark, M-x, Top
@chapter Help
@kindex Help
@cindex help
@cindex self-documentation
@findex help-command
@kindex C-h
@kindex F1

Richard M. Stallman's avatar
Richard M. Stallman committed
14 15 16 17 18 19
  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.
You can cancel the @kbd{C-h} command with @kbd{C-g}.  The function key
@key{F1} is equivalent to @kbd{C-h}.
Dave Love's avatar
#  
Dave Love committed
20 21 22

@kindex C-h C-h
@findex help-for-help
Richard M. Stallman's avatar
Richard M. Stallman committed
23 24 25 26 27
  @kbd{C-h} itself is one of the help options; @kbd{C-h C-h} displays
a list of help options, with a brief description of each one
(@code{help-for-help}).  You can scroll the list with @key{SPC} and
@key{DEL}, then type the help option you want.  To cancel, type
@kbd{C-g}.
Dave Love's avatar
#  
Dave Love committed
28 29

  @kbd{C-h} or @key{F1} means ``help'' in various other contexts as
Richard M. Stallman's avatar
Richard M. Stallman committed
30 31 32 33
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
don't support @kbd{C-h} in this way, because they define other
meanings for it, but they all support @key{F1} for help.)
Dave Love's avatar
#  
Dave Love committed
34

Richard M. Stallman's avatar
Richard M. Stallman committed
35 36 37 38
  Most help buffers use a special major mode, Help mode, which lets
you scroll conveniently with @key{SPC} and @key{DEL}.  You can also
follow hyperlinks to URLs, and to other facilities including Info
nodes and customization buffers.  @xref{Help Mode}.
Dave Love's avatar
#  
Dave Love committed
39

40 41
@cindex searching documentation efficiently
@cindex looking for a subject in documentation
Richard M. Stallman's avatar
Richard M. Stallman committed
42 43 44 45
  If you are looking for a certain feature, but don't know what it is
called or where to look, we recommend three methods.  First, try an
apropos command, then try searching the manual index, then look in the
FAQ and the package keywords.
46 47

@table @kbd
48
@item C-h a @var{topics} @key{RET}
Richard M. Stallman's avatar
Richard M. Stallman committed
49 50 51 52
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}.
Dave Love's avatar
Dave Love committed
53

54
@item C-h i d m emacs @key{RET} i @var{topic} @key{RET}
Richard M. Stallman's avatar
Richard M. Stallman committed
55 56 57
This searches for @var{topic} in the indices of the on-line Emacs
manual, and displays the first match found.  Press @kbd{,} to see
subsequent matches.  You can use a regular expression as @var{topic}.
58

59
@item C-h i d m emacs @key{RET} s @var{topic} @key{RET}
Richard M. Stallman's avatar
Richard M. Stallman committed
60
Similar, but searches the @emph{text} of the manual rather than the
61 62
indices.

Juri Linkov's avatar
Juri Linkov committed
63
@item C-h C-f
Richard M. Stallman's avatar
Richard M. Stallman committed
64
This displays the Emacs FAQ.  You can use the Info commands
65
to browse it.
66

67
@item C-h p
Richard M. Stallman's avatar
Richard M. Stallman committed
68 69
This displays the available Emacs packages based on keywords.
@xref{Library Keywords}.
70 71
@end table

Dave Love's avatar
#  
Dave Love committed
72 73 74 75 76
@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.
77
* Help Mode::           Special features of Help mode and Help buffers.
Dave Love's avatar
#  
Dave Love committed
78 79 80
* Library Keywords::	Finding Lisp libraries by keywords (topics).
* Language Help::       Help relating to international language support.
* Misc Help::		Other help commands.
81
* Help Files::          Commands to display pre-written help files.
Dave Love's avatar
Dave Love committed
82
* Help Echo::           Help on active text and tooltips (`balloon help')
Dave Love's avatar
#  
Dave Love committed
83 84 85 86 87
@end menu

@iftex
@node Help Summary
@end iftex
Karl Berry's avatar
Karl Berry committed
88
@ifnottex
Dave Love's avatar
#  
Dave Love committed
89 90
@node Help Summary
@section Help Summary
Karl Berry's avatar
Karl Berry committed
91
@end ifnottex
Dave Love's avatar
#  
Dave Love committed
92

Richard M. Stallman's avatar
Richard M. Stallman committed
93 94 95 96
  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.
Dave Love's avatar
#  
Dave Love committed
97 98

@table @kbd
99 100 101
@item C-h a @var{topics} @key{RET}
Display a list of commands whose names match @var{topics}
(@code{apropos-command}; @pxref{Apropos}).
Dave Love's avatar
#  
Dave Love committed
102
@item C-h b
Richard M. Stallman's avatar
Richard M. Stallman committed
103 104
Display all active key bindings; minor mode bindings first, then those
of the major mode, then global bindings (@code{describe-bindings}).
Dave Love's avatar
#  
Dave Love committed
105
@item C-h c @var{key}
Richard M. Stallman's avatar
Richard M. Stallman committed
106 107 108 109
Given a key sequence @var{key}, show the name of the command that it
runs (@code{describe-key-briefly}).  Here @kbd{c} stands for
``character.''  For more extensive information on @var{key}, use
@kbd{C-h k}.
110
@item C-h d @var{topics} @key{RET}
Richard M. Stallman's avatar
Richard M. Stallman committed
111
Display the commands and variables whose documentation matches
112
@var{topics} (@code{apropos-documentation}).
113 114 115
@item C-h e
Display the @code{*Messages*} buffer
(@code{view-echo-area-messages}).
Dave Love's avatar
#  
Dave Love committed
116 117 118
@item C-h f @var{function} @key{RET}
Display documentation on the Lisp function named @var{function}
(@code{describe-function}).  Since commands are Lisp functions,
Richard M. Stallman's avatar
Richard M. Stallman committed
119
this works for commands too.
Dave Love's avatar
#  
Dave Love committed
120
@item C-h h
121
Display the @file{HELLO} file, which shows examples of various character
Dave Love's avatar
#  
Dave Love committed
122 123
sets.
@item C-h i
Richard M. Stallman's avatar
Richard M. Stallman committed
124
Run Info, the GNU documentation browser (@code{info}).
Dave Love's avatar
#  
Dave Love committed
125 126 127 128 129 130 131 132 133 134 135 136
The complete Emacs manual is available on-line in Info.
@item C-h k @var{key}
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
(@code{view-lossage}).
@item C-h m
Display documentation of the current major mode (@code{describe-mode}).
@item C-h p
Find packages by topic keyword (@code{finder-by-keyword}).
@item C-h s
Richard M. Stallman's avatar
Richard M. Stallman committed
137
Display the current contents of the syntax table, with an explanation of
Dave Love's avatar
#  
Dave Love committed
138 139 140 141
what they mean (@code{describe-syntax}).  @xref{Syntax}.
@item C-h t
Enter the Emacs interactive tutorial (@code{help-with-tutorial}).
@item C-h v @var{var} @key{RET}
Eli Zaretskii's avatar
Eli Zaretskii committed
142
Display the documentation of the Lisp variable @var{var}
Dave Love's avatar
#  
Dave Love committed
143 144
(@code{describe-variable}).
@item C-h w @var{command} @key{RET}
Eli Zaretskii's avatar
Eli Zaretskii committed
145
Show which keys run the command named @var{command} (@code{where-is}).
Dave Love's avatar
#  
Dave Love committed
146
@item C-h C @var{coding} @key{RET}
Richard M. Stallman's avatar
Richard M. Stallman committed
147
Describe the coding system @var{coding}
Dave Love's avatar
#  
Dave Love committed
148 149 150 151
(@code{describe-coding-system}).
@item C-h C @key{RET}
Describe the coding systems currently in use.
@item C-h I @var{method} @key{RET}
Richard M. Stallman's avatar
Richard M. Stallman committed
152
Describe the input method @var{method} (@code{describe-input-method}).
Dave Love's avatar
#  
Dave Love committed
153
@item C-h L @var{language-env} @key{RET}
Richard M. Stallman's avatar
Richard M. Stallman committed
154
Display information on the character sets, coding systems, and input
Richard M. Stallman's avatar
Richard M. Stallman committed
155
methods used in language environment @var{language-env}
Dave Love's avatar
#  
Dave Love committed
156
(@code{describe-language-environment}).
157
@item C-h F @var{function} @key{RET}
Richard M. Stallman's avatar
Richard M. Stallman committed
158 159
Enter Info and goes to the node that documents the Emacs function
@var{function} (@code{Info-goto-emacs-command-node}).
160
@item C-h K @var{key}
Richard M. Stallman's avatar
Richard M. Stallman committed
161 162
Enter Info and goes to the node that documents the key sequence
@var{key} (@code{Info-goto-emacs-key-command-node}).
163
@item C-h S @var{symbol} @key{RET}
Dave Love's avatar
#  
Dave Love committed
164 165
Display the Info documentation on symbol @var{symbol} according to the
programming language you are editing (@code{info-lookup-symbol}).
166
@item C-h .
Richard M. Stallman's avatar
Richard M. Stallman committed
167 168 169
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.)
Dave Love's avatar
#  
Dave Love committed
170 171 172 173 174 175 176
@end table

@node Key Help
@section Documentation for a Key

@kindex C-h c
@findex describe-key-briefly
Richard M. Stallman's avatar
Richard M. Stallman committed
177 178 179 180 181 182
  The help commands to get information about a key sequence are
@kbd{C-h c} and @w{@kbd{C-h k}}.  @kbd{C-h c @var{key}} displays in
the echo area the name of the command that @var{key} is bound to.  For
example, @kbd{C-h c C-f} displays @samp{forward-char}.  Since command
names are chosen to describe what the commands do, this gives you a
very brief description of what @var{key} does.
Dave Love's avatar
#  
Dave Love committed
183 184 185 186 187

@kindex C-h k
@findex describe-key
  @kbd{C-h k @var{key}} is similar but gives more information: it
displays the documentation string of the command as well as its name.
Richard M. Stallman's avatar
Richard M. Stallman committed
188 189
It displays this information in a window, since it may not fit in the
echo area.
Dave Love's avatar
#  
Dave Love committed
190

Richard M. Stallman's avatar
Richard M. Stallman committed
191 192
@kindex C-h K
@findex Info-goto-emacs-key-command-node
Richard M. Stallman's avatar
Richard M. Stallman committed
193 194 195
  To find the documentation of a key sequence @var{key}, type @kbd{C-h
K @var{key}}.  This displays the appropriate manual section which
contains the documentation of @var{key}.
Richard M. Stallman's avatar
Richard M. Stallman committed
196 197 198

  @kbd{C-h c}, @kbd{C-h k} and @kbd{C-h K} work for any sort of key
sequences, including function keys, menus, and mouse events.  For
Richard M. Stallman's avatar
Richard M. Stallman committed
199 200
instance, after @kbd{C-h k} you can select a menu item from the menu
bar, to view the documentation string of the command it runs.
Dave Love's avatar
#  
Dave Love committed
201

202 203
@kindex C-h w
@findex where-is
Richard M. Stallman's avatar
Richard M. Stallman committed
204 205 206 207
  @kbd{C-h w @var{command} @key{RET}} lists the keys that are bound to
@var{command}.  It displays the list in the echo area.  If it says the
command is not on any key, that means you must use @kbd{M-x} to run
it.  @kbd{C-h w} runs the command @code{where-is}.
208

Dave Love's avatar
#  
Dave Love committed
209 210 211 212 213
@node Name Help
@section Help by Command or Variable Name

@kindex C-h f
@findex describe-function
Richard M. Stallman's avatar
Richard M. Stallman committed
214 215 216 217 218
  @kbd{C-h f @var{function} @key{RET}} (@code{describe-function})
displays the documentation of Lisp function @var{function}, in a
window.  Since commands are Lisp functions, you can use this method to
view the documentation of any command whose name you know.  For
example,
Dave Love's avatar
#  
Dave Love committed
219 220 221 222 223 224 225 226 227 228

@example
C-h f auto-fill-mode @key{RET}
@end example

@noindent
displays the documentation of @code{auto-fill-mode}.  This is the only
way to get the documentation of a command that is not bound to any key
(one which you would normally run using @kbd{M-x}).

Richard M. Stallman's avatar
Richard M. Stallman committed
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
  @kbd{C-h f} is also useful for Lisp functions that you use in a Lisp
program.  For example, if you have just written the expression
@code{(make-vector len)} and want to check that you are using
@code{make-vector} properly, type @kbd{C-h f make-vector @key{RET}}.
Because @kbd{C-h f} allows all function names, not just command names,
you may find that some of your favorite completion abbreviations that
work in @kbd{M-x} don't work in @kbd{C-h f}.  An abbreviation that is
unique among command names may not be unique among all function names.

  If you type @kbd{C-h f @key{RET}}, it describes the function called
by the innermost Lisp expression in the buffer around point,
@emph{provided} that function name is a valid, defined Lisp function.
(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
function @code{make-vector}.

  @kbd{C-h f} is also useful just to verify that you spelled a
function name correctly.  If the minibuffer prompt for @kbd{C-h f}
shows the function name from the buffer as the default, it means that
name is defined as a Lisp function.  Type @kbd{C-g} to cancel the
@kbd{C-h f} command if you don't really want to view the
documentation.

254 255
@kindex C-h v
@findex describe-variable
Richard M. Stallman's avatar
Richard M. Stallman committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269
  @kbd{C-h v} (@code{describe-variable}) is like @kbd{C-h f} but
describes Lisp variables instead of Lisp functions.  Its default is
the Lisp symbol around or before point, if that is the name of a
defined Lisp variable.  @xref{Variables}.

  Help buffers that describe Emacs variables and functions normally
have hyperlinks to the corresponding source definition, if you have
the source files installed.  (@xref{Hyperlinking}.)  If you know Lisp
(or C), this provides the ultimate documentation.  If you don't know
Lisp, you should learn it.  (The Introduction to Emacs Lisp
Programming, available from the FSF through fsf.org, is a good way to
get started.)  If Emacs feels you are just @emph{using} it, treating
it as an object program, its feelings may be hurt.  For real intimacy,
read the Emacs source code.
Richard M. Stallman's avatar
Richard M. Stallman committed
270 271 272

@kindex C-h F
@findex Info-goto-emacs-command-node
Richard M. Stallman's avatar
Richard M. Stallman committed
273 274 275
  To find a function'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.
276

Dave Love's avatar
#  
Dave Love committed
277 278 279
@node Apropos
@section Apropos

Richard M. Stallman's avatar
Richard M. Stallman committed
280 281
  The @dfn{apropos} commands answer questions like, ``What are the
commands for working with files?''  More precisely, you specify an
282
@dfn{apropos pattern}, which means either a word, a list of words, or
Richard M. Stallman's avatar
Richard M. Stallman committed
283 284
a regular expression.  Each apropos command displays a list of items
that match the pattern, in a separate buffer.
285 286 287 288 289 290

@table @kbd
@item C-h a @var{pattern} @key{RET}
Search for commands whose names match @var{pattern}.

@item M-x apropos @key{RET} @var{pattern} @key{RET}
Richard M. Stallman's avatar
Richard M. Stallman committed
291 292 293
Search for functions and variables whose names match @var{pattern}.
Both interactive functions (commands) and noninteractive functions can
be found by this command.
294 295

@item M-x apropos-variable @key{RET} @var{pattern} @key{RET}
Richard M. Stallman's avatar
Richard M. Stallman committed
296
Search for user-option variables whose names match @var{pattern}.
297 298

@item M-x apropos-value @key{RET} @var{pattern} @key{RET}
Richard M. Stallman's avatar
Richard M. Stallman committed
299 300
Search for functions whose definitions @var{pattern}, and variables
whose values match @var{pattern}.
301 302

@item C-h d @var{pattern} @key{RET}
Richard M. Stallman's avatar
Richard M. Stallman committed
303 304
Search for functions and variables whose @strong{documentation
strings} match @var{pattern}.
305 306
@end table

Dave Love's avatar
#  
Dave Love committed
307 308 309
@kindex C-h a
@findex apropos-command
@cindex apropos
Richard M. Stallman's avatar
Richard M. Stallman committed
310 311 312 313 314 315 316 317 318 319
  The simplest kind of apropos pattern is one word.  Anything which
contains that word matches the pattern.  Thus, to find the commands
that work on files, type @kbd{C-h a file @key{RET}}.  This displays a
list of all command names that contain @samp{file}, including
@code{copy-file}, @code{find-file}, and so on.  Each command name
comes with a brief description and a list of keys you can currently
invoke it with.  In our example, it would say that you can invoke
@code{find-file} by typing @kbd{C-x C-f}.

  The @kbd{a} in @kbd{C-h a} stands for ``Apropos''; @kbd{C-h a}
320 321 322 323
runs the command @code{apropos-command}.  This command normally checks
only commands (interactive functions); if you specify a prefix
argument, it checks noninteractive functions as well.

Richard M. Stallman's avatar
Richard M. Stallman committed
324 325
  For more information about a function definition, variable or symbol
property listed in the apropos buffer, you can click on it with
326 327
@kbd{Mouse-1} or @kbd{Mouse-2}, or move there and type @key{RET}.

Richard M. Stallman's avatar
Richard M. Stallman committed
328
  When you specify more than one word in the apropos pattern, a name
329 330
must contain at least two of the words in order to match.  Thus, if
you are looking for commands to kill a chunk of text before point, you
Richard M. Stallman's avatar
Richard M. Stallman committed
331 332 333 334
could try @kbd{C-h a kill back backward behind before @key{RET}}.  The
real command name @code{kill-backward} will match that; if there were
a command @code{kill-text-before}, it would also match, since it
contains two of the specified words.
335 336 337 338 339

  For even greater flexibility, you can specify a regular expression
(@pxref{Regexps}).  An apropos pattern is interpreted as a regular
expression if it contains any of the regular expression special
characters, @samp{^$*+?.\[}.
Dave Love's avatar
#  
Dave Love committed
340

Richard M. Stallman's avatar
Richard M. Stallman committed
341 342 343
  Following the conventions for naming Emacs commands, here are some
words that you'll find useful in apropos patterns.  By using them in
@kbd{C-h a}, you will also get a feel for the naming conventions.
Dave Love's avatar
#  
Dave Love committed
344 345 346 347 348 349 350 351 352

@quotation
char, line, word, sentence, paragraph, region, page, sexp, list, defun,
rect, buffer, frame, window, face, file, dir, register, mode, beginning, end,
forward, backward, next, previous, up, down, search, goto, kill, delete,
mark, insert, yank, fill, indent, case, change, set, what, list, find,
view, describe, default.
@end quotation

353
@findex apropos
Richard M. Stallman's avatar
Richard M. Stallman committed
354 355 356 357
  Use @kbd{M-x apropos} instead of @kbd{C-h a} to list all the Lisp
symbols that match an apropos pattern, not just the symbols that are
commands.  This command does not list key bindings by default; specify
a numeric argument if you want it to list them.
358

Dave Love's avatar
#  
Dave Love committed
359
@findex apropos-variable
Richard M. Stallman's avatar
Richard M. Stallman committed
360 361 362
  Use @kbd{M-x apropos-variable} to list user-customizable variables
that match an apropos pattern.  If you specify a prefix argument, it
lists all matching variables.
Dave Love's avatar
#  
Dave Love committed
363

364
@kindex C-h d
Dave Love's avatar
#  
Dave Love committed
365
@findex apropos-documentation
366 367
  The @code{apropos-documentation} command is like @code{apropos}
except that it searches documentation strings instead of symbol names
Richard M. Stallman's avatar
Richard M. Stallman committed
368
for matches.
Dave Love's avatar
#  
Dave Love committed
369 370

@findex apropos-value
371
  The @code{apropos-value} command is like @code{apropos} except that
Richard M. Stallman's avatar
Richard M. Stallman committed
372 373 374
it searches variables' values for matches for the apropos pattern.
With a prefix argument, it also checks symbols' function definitions
and property lists.
Dave Love's avatar
#  
Dave Love committed
375 376

@vindex apropos-do-all
Richard M. Stallman's avatar
Richard M. Stallman committed
377 378
  If the variable @code{apropos-do-all} is non-@code{nil}, the apropos
commands always behave as if they had been given a prefix argument.
Dave Love's avatar
#  
Dave Love committed
379

380
@vindex apropos-sort-by-scores
381
@cindex apropos search results, order by score
Richard M. Stallman's avatar
Richard M. Stallman committed
382 383 384 385
  By default, apropos lists the search results in alphabetical order.
If the variable @code{apropos-sort-by-scores} is non-@code{nil}, the
apropos commands try to guess the relevance of each result, and
display the most relevant ones first.
386

387
@vindex apropos-documentation-sort-by-scores
Richard M. Stallman's avatar
Richard M. Stallman committed
388
  By default, apropos lists the search results for
389 390
@code{apropos-documentation} in order of relevance of the match.  If
the variable @code{apropos-documentation-sort-by-scores} is
Richard M. Stallman's avatar
Richard M. Stallman committed
391
@code{nil}, apropos lists the symbols found in alphabetical order.
Dave Love's avatar
#  
Dave Love committed
392

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
@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.

@table @kbd
@item @key{SPC}
Scroll forward.
@item @key{DEL}
Scroll backward.
@item @key{RET}
Follow a cross reference at point.
@item @key{TAB}
Move point forward to the next cross reference.
@item S-@key{TAB}
Move point back to the previous cross reference.
@item Mouse-1
@itemx Mouse-2
Follow a cross reference that you click on.
@item C-c C-c
Show all documentation about the symbol at point.
@end table

  When a function name (@pxref{M-x,, Running Commands by Name}),
variable name (@pxref{Variables}), or face name (@pxref{Faces})
appears in the documentation, it normally appears inside paired
single-quotes.  To view the documentation of that command, variable or
face, you can click on the name with @kbd{Mouse-1} or @kbd{Mouse-2},
or move point there and type @key{RET}.  Use @kbd{C-c C-b} to retrace
your steps.

@cindex URL, viewing in help
@cindex help, viewing web pages
@cindex viewing web pages in help
@cindex web pages, viewing in help
@findex browse-url
  You can follow cross references to URLs (web pages) also.  This uses
the @code{browse-url} command to view the page in the browser you
choose.  @xref{Browse-URL}.

@kindex @key{TAB} @r{(Help mode)}
@findex help-next-ref
@kindex S-@key{TAB} @r{(Help mode)}
@findex help-previous-ref
  There are convenient commands to move point to cross references in
the help text.  @key{TAB} (@code{help-next-ref}) moves point down to
the next cross reference.  @kbd{S-@key{TAB}} moves up to the previous
cross reference (@code{help-previous-ref}).

  To view all documentation about any symbol name that appears in the
text, move point to the symbol name and type @kbd{C-c C-c}
(@code{help-follow-symbol}).  This shows all available documentation
about the symbol as a variable, function and/or face.  As above, use
@kbd{C-c C-b} to retrace your steps.

Dave Love's avatar
#  
Dave Love committed
449 450 451 452 453 454 455 456 457
@node Library Keywords
@section Keyword Search for Lisp Libraries

@kindex C-h p
@findex finder-by-keyword
The @kbd{C-h p} command lets you search the standard Emacs Lisp
libraries by topic keywords.  Here is a partial list of keywords you can
use:

458
@multitable {convenience} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
459
@item abbrev@tab abbreviation handling, typing shortcuts, macros.
Juri Linkov's avatar
Juri Linkov committed
460 461
@item bib@tab code related to the @code{bib} bibliography processor.
@item c@tab support for the C language and related languages.
462 463
@item calendar@tab calendar and time management support.
@item comm@tab communications, networking, remote access to files.
Juri Linkov's avatar
Juri Linkov committed
464
@item convenience@tab convenience features for faster editing.
465 466 467 468
@item data@tab support for editing files of data.
@item docs@tab support for Emacs documentation.
@item emulations@tab emulations of other editors.
@item extensions@tab Emacs Lisp language extensions.
Juri Linkov's avatar
Juri Linkov committed
469 470
@item faces@tab support for multiple fonts.
@item files@tab support for editing and manipulating files.
471 472 473 474
@item frames@tab support for Emacs frames and window systems.
@item games@tab games, jokes and amusements.
@item hardware@tab support for interfacing with exotic hardware.
@item help@tab support for on-line help systems.
Juri Linkov's avatar
Juri Linkov committed
475
@item hypermedia@tab support for links between text or other media types.
476 477 478
@item i18n@tab internationalization and alternate character-set support.
@item internal@tab code for Emacs internals, build process, defaults.
@item languages@tab specialized modes for editing programming languages.
Juri Linkov's avatar
Juri Linkov committed
479 480
@item lisp@tab Lisp support, including Emacs Lisp.
@item local@tab code local to your site.
481 482
@item maint@tab maintenance aids for the Emacs development group.
@item mail@tab modes for electronic-mail handling.
Juri Linkov's avatar
Juri Linkov committed
483 484 485
@item matching@tab various sorts of searching and matching.
@item mouse@tab mouse support.
@item multimedia@tab images and sound support.
486 487
@item news@tab support for netnews reading and posting.
@item oop@tab support for object-oriented programming.
Juri Linkov's avatar
Juri Linkov committed
488
@item outlines@tab support for hierarchical outlining.
489 490
@item processes@tab process, subshell, compilation, and job control support.
@item terminals@tab support for terminal types.
Juri Linkov's avatar
Juri Linkov committed
491
@item tex@tab supporting code for the @TeX{} formatter.
492
@item tools@tab programming tools.
Juri Linkov's avatar
Juri Linkov committed
493
@item unix@tab front-ends/assistants for, or emulators of, UNIX-like features.
494 495
@item wp@tab word processing.
@end multitable
Dave Love's avatar
#  
Dave Love committed
496 497 498 499 500

@node Language Help
@section Help for International Language Support

  You can use the command @kbd{C-h L}
Richard M. Stallman's avatar
Richard M. Stallman committed
501 502 503 504 505 506
(@code{describe-language-environment}) to get information about a
specific language environment.  @xref{Language Environments}.  This
tells you which languages this language environment supports.  It also
lists the character sets, coding systems, and input methods that work
with this language environment, and finally shows some sample text to
illustrate scripts.
Dave Love's avatar
#  
Dave Love committed
507 508 509 510

  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.

Richard M. Stallman's avatar
Richard M. Stallman committed
511 512 513
  The command @kbd{C-h I} (@code{describe-input-method}) describes an
input method---either a specified input method, or by default the
input method currently in use.  @xref{Input Methods}.
Dave Love's avatar
#  
Dave Love committed
514 515

  The command @kbd{C-h C} (@code{describe-coding-system}) describes
Richard M. Stallman's avatar
Richard M. Stallman committed
516 517
coding systems---either a specified coding system, or the ones
currently in use.  @xref{Coding Systems}.
Dave Love's avatar
#  
Dave Love committed
518 519 520 521 522 523 524 525 526

@node Misc Help
@section Other Help Commands

@kindex C-h i
@findex info
@cindex Info
@cindex manuals, on-line
@cindex on-line manuals
Richard M. Stallman's avatar
Richard M. Stallman committed
527 528 529 530
  @kbd{C-h i} (@code{info}) runs the Info program, which browses
structured documentation files.  The entire Emacs manual is available
within Info, along with many other manuals for the GNU system.  Type
@kbd{h} after entering Info to run a tutorial on using Info.
Dave Love's avatar
#  
Dave Love committed
531

532
@cindex find Info manual by its file name
Richard M. Stallman's avatar
Richard M. Stallman committed
533 534 535 536 537 538
  With a numeric argument @var{n}, @kbd{C-h i} selects the Info buffer
@samp{*info*<@var{n}>}.  This is useful if you want to browse multiple
Info manuals simultaneously.  If you specify just @kbd{C-u} as the
prefix argument, @kbd{C-h i} prompts for the name of a documentation
file, so you can browse a file which doesn't have an entry in the
top-level Info menu.
Dave Love's avatar
#  
Dave Love committed
539

Richard M. Stallman's avatar
Richard M. Stallman committed
540 541 542
  The help commands @kbd{C-h F @var{function} @key{RET}} and @kbd{C-h
K @var{key}}, described above, enter Info and go straight to the
documentation of @var{function} or @var{key}.
Dave Love's avatar
#  
Dave Love committed
543

544 545 546
@kindex C-h S
@findex info-lookup-symbol
  When editing a program, if you have an Info version of the manual
Richard M. Stallman's avatar
Richard M. Stallman committed
547 548 549 550
for the programming language, you can use @kbd{C-h S}
(@code{info-lookup-symbol}) to find symbol (keyword, function or
variable) in the proper manual.  The details of how this command works
depend on the major mode.
Dave Love's avatar
#  
Dave Love committed
551 552 553

@kindex C-h l
@findex view-lossage
Richard M. Stallman's avatar
Richard M. Stallman committed
554 555 556 557
  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.
Dave Love's avatar
#  
Dave Love committed
558

559 560
@kindex C-h e
@findex view-echo-area-messages
Richard M. Stallman's avatar
Richard M. Stallman committed
561 562 563
  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.
564

Dave Love's avatar
#  
Dave Love committed
565 566
@kindex C-h m
@findex describe-mode
Richard M. Stallman's avatar
Richard M. Stallman committed
567 568 569 570
  Each Emacs major mode typically redefines a few keys and makes other
changes in how editing works.  @kbd{C-h m} (@code{describe-mode})
displays documentation on the current major mode, which normally
describes the commands and features that are changed in this mode.
Dave Love's avatar
#  
Dave Love committed
571 572 573 574

@kindex C-h b
@findex describe-bindings
  @kbd{C-h b} (@code{describe-bindings}) and @kbd{C-h s}
Richard M. Stallman's avatar
Richard M. Stallman committed
575 576 577 578 579 580 581 582 583 584 585 586 587
(@code{describe-syntax}) show other information about the current
environment within Emacs.  @kbd{C-h b} displays a list of all the key
bindings now in effect: first the local bindings of the current minor
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}).

  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.)
Dave Love's avatar
#  
Dave Love committed
588

589 590 591
@node Help Files
@section Help Files

Richard M. Stallman's avatar
Richard M. Stallman committed
592 593 594 595 596
  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.
597

Dave Love's avatar
#  
Dave Love committed
598 599 600 601
@kindex C-h C-c
@findex describe-copying
@kindex C-h C-d
@findex describe-distribution
602 603 604 605 606 607
@kindex C-h C-e
@findex view-emacs-problems
@kindex C-h C-f
@findex view-emacs-FAQ
@kindex C-h C-n
@findex view-emacs-news
Dave Love's avatar
#  
Dave Love committed
608 609
@kindex C-h C-p
@findex describe-project
610 611 612 613 614 615 616
@kindex C-h C-t
@findex view-emacs-todo
@kindex C-h C-w
@findex describe-no-warranty

@table @kbd
@item C-h C-c
Richard M. Stallman's avatar
Richard M. Stallman committed
617
Display the Emacs copying conditions (@code{describe-copying}).
618 619
These are the rules under which you can copy and redistribute Emacs.
@item C-h C-d
Richard M. Stallman's avatar
Richard M. Stallman committed
620
Display how to download or order the latest version of
621 622
Emacs and other GNU software (@code{describe-distribution}).
@item C-h C-e
Richard M. Stallman's avatar
Richard M. Stallman committed
623
Display the list of known Emacs problems, sometimes with suggested
624 625
workarounds (@code{view-emacs-problems}).
@item C-h C-f
Richard M. Stallman's avatar
Richard M. Stallman committed
626
Display the Emacs frequently-answered-questions list (@code{view-emacs-FAQ}).
627
@item C-h C-n
Richard M. Stallman's avatar
Richard M. Stallman committed
628 629
Display the Emacs ``news'' file, which lists new features in the most
recent version of Emacs (@code{view-emacs-news}).
630
@item C-h C-p
Richard M. Stallman's avatar
Richard M. Stallman committed
631
Display general information about the GNU Project
632 633
(@code{describe-project}).
@item C-h C-t
Richard M. Stallman's avatar
Richard M. Stallman committed
634
Display the Emacs to-do list (@code{view-todo}).
635
@item C-h C-w
Richard M. Stallman's avatar
Richard M. Stallman committed
636
Display the full details on the complete absence of warranty for GNU
637 638
Emacs (@code{describe-no-warranty}).
@end table
Dave Love's avatar
Dave Love committed
639 640 641 642 643

@node Help Echo
@section Help on Active Text and Tooltips

@cindex tooltips
644
@cindex balloon help
Richard M. Stallman's avatar
Richard M. Stallman committed
645
  When a region of text is ``active,'' so that you can select it with
Richard M. Stallman's avatar
Richard M. Stallman committed
646
the mouse or a key like @kbd{RET}, it often has associated help text.
Richard M. Stallman's avatar
Richard M. Stallman committed
647 648 649 650 651 652
For instance, most parts of the mode line have help text.  On
graphical displays, the help text is displayed as a ``tooltip''
(sometimes known as ``balloon help''), when you move the mouse over
the active text.  @xref{Tooltips}.  On some systems, it is shown in
the echo area.  On text-only terminals, if Emacs cannot follow the
mouse, it cannot show the help text on mouse-over.
653 654 655 656 657 658 659 660 661 662

@kindex C-h .
@findex display-local-help
@vindex help-at-pt-display-when-idle
  You can also access text region help info using the keyboard.  The
command @kbd{C-h .} (@code{display-local-help}) displays any help text
associated with the text at point, using the echo area.  If you want
help text to be displayed automatically whenever it is available at
point, set the variable @code{help-at-pt-display-when-idle} to
@code{t}.
Miles Bader's avatar
Miles Bader committed
663 664 665 666

@ignore
   arch-tag: 6f33ab62-bc75-4367-8057-fd67cc15c3a1
@end ignore