aboutsummaryrefslogtreecommitdiffstats
path: root/man/help.texi
diff options
context:
space:
mode:
authorKaroly Lorentey2006-10-14 16:56:21 +0000
committerKaroly Lorentey2006-10-14 16:56:21 +0000
commit3f87f67ee215ffeecbd2f53bd7f342cdf03f47df (patch)
tree16f2af9111af08a94d608d96a957f5c3ec5effcc /man/help.texi
parent350e4fb815d7413ef6d339dd664014706f742927 (diff)
parent7a210b69c7f92650c524766d1b9d3f3eefdd67c7 (diff)
downloademacs-3f87f67ee215ffeecbd2f53bd7f342cdf03f47df.tar.gz
emacs-3f87f67ee215ffeecbd2f53bd7f342cdf03f47df.zip
Merged from emacs@sv.gnu.org
Patches applied: * emacs@sv.gnu.org/emacs--devo--0--patch-371 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-372 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-373 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-374 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-375 Merge from gnus--rel--5.10 * emacs@sv.gnu.org/emacs--devo--0--patch-376 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-377 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-378 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-379 Merge from erc--emacs--21 * emacs@sv.gnu.org/emacs--devo--0--patch-380 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-381 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-382 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-383 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-384 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-385 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-386 Update from erc--emacs--22 * emacs@sv.gnu.org/emacs--devo--0--patch-387 Fix ERC bug introduced in last patch * emacs@sv.gnu.org/emacs--devo--0--patch-388 Update from erc--emacs--22 * emacs@sv.gnu.org/emacs--devo--0--patch-389 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-390 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-391 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-392 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-393 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-394 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-395 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-396 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-397 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-398 Merge from gnus--rel--5.10 * emacs@sv.gnu.org/emacs--devo--0--patch-399 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-400 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-401 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-402 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-403 Rcirc update from Ryan Yeske * emacs@sv.gnu.org/emacs--devo--0--patch-404 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-405 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-406 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-407 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-408 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-409 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-410 Merge from gnus--rel--5.10 * emacs@sv.gnu.org/emacs--devo--0--patch-411 Miscellaneous tq-related fixes. * emacs@sv.gnu.org/emacs--devo--0--patch-412 Update from CVS * emacs@sv.gnu.org/gnus--rel--5.10--patch-121 Update from CVS * emacs@sv.gnu.org/gnus--rel--5.10--patch-122 Update from CVS * emacs@sv.gnu.org/gnus--rel--5.10--patch-123 Update from CVS * emacs@sv.gnu.org/gnus--rel--5.10--patch-124 Update from CVS * emacs@sv.gnu.org/gnus--rel--5.10--patch-125 Update from CVS * emacs@sv.gnu.org/gnus--rel--5.10--patch-126 Merge from emacs--devo--0 * emacs@sv.gnu.org/gnus--rel--5.10--patch-127 Update from CVS git-archimport-id: lorentey@elte.hu--2004/emacs--multi-tty--0--patch-581
Diffstat (limited to 'man/help.texi')
-rw-r--r--man/help.texi116
1 files changed, 59 insertions, 57 deletions
diff --git a/man/help.texi b/man/help.texi
index 47600b711fa..08f528f5151 100644
--- a/man/help.texi
+++ b/man/help.texi
@@ -74,9 +74,9 @@ This displays the available Emacs packages based on keywords.
74* Key Help:: Asking what a key does in Emacs. 74* Key Help:: Asking what a key does in Emacs.
75* Name Help:: Asking about a command, variable or function name. 75* Name Help:: Asking about a command, variable or function name.
76* Apropos:: Asking what pertains to a given topic. 76* Apropos:: Asking what pertains to a given topic.
77* Help Mode:: Special features of Help mode and Help buffers.
77* Library Keywords:: Finding Lisp libraries by keywords (topics). 78* Library Keywords:: Finding Lisp libraries by keywords (topics).
78* Language Help:: Help relating to international language support. 79* Language Help:: Help relating to international language support.
79* Help Mode:: Special features of Help mode and Help buffers.
80* Misc Help:: Other help commands. 80* Misc Help:: Other help commands.
81* Help Files:: Commands to display pre-written help files. 81* Help Files:: Commands to display pre-written help files.
82* Help Echo:: Help on active text and tooltips (`balloon help') 82* Help Echo:: Help on active text and tooltips (`balloon help')
@@ -251,6 +251,8 @@ name is defined as a Lisp function. Type @kbd{C-g} to cancel the
251@kbd{C-h f} command if you don't really want to view the 251@kbd{C-h f} command if you don't really want to view the
252documentation. 252documentation.
253 253
254@kindex C-h v
255@findex describe-variable
254 @kbd{C-h v} (@code{describe-variable}) is like @kbd{C-h f} but 256 @kbd{C-h v} (@code{describe-variable}) is like @kbd{C-h f} but
255describes Lisp variables instead of Lisp functions. Its default is 257describes Lisp variables instead of Lisp functions. Its default is
256the Lisp symbol around or before point, if that is the name of a 258the Lisp symbol around or before point, if that is the name of a
@@ -388,6 +390,62 @@ display the most relevant ones first.
388the variable @code{apropos-documentation-sort-by-scores} is 390the variable @code{apropos-documentation-sort-by-scores} is
389@code{nil}, apropos lists the symbols found in alphabetical order. 391@code{nil}, apropos lists the symbols found in alphabetical order.
390 392
393@node Help Mode
394@section Help Mode Commands
395
396 Help buffers provide the same commands as View mode (@pxref{Misc File
397Ops}), plus a few special commands of their own.
398
399@table @kbd
400@item @key{SPC}
401Scroll forward.
402@item @key{DEL}
403Scroll backward.
404@item @key{RET}
405Follow a cross reference at point.
406@item @key{TAB}
407Move point forward to the next cross reference.
408@item S-@key{TAB}
409Move point back to the previous cross reference.
410@item Mouse-1
411@itemx Mouse-2
412Follow a cross reference that you click on.
413@item C-c C-c
414Show all documentation about the symbol at point.
415@end table
416
417 When a function name (@pxref{M-x,, Running Commands by Name}),
418variable name (@pxref{Variables}), or face name (@pxref{Faces})
419appears in the documentation, it normally appears inside paired
420single-quotes. To view the documentation of that command, variable or
421face, you can click on the name with @kbd{Mouse-1} or @kbd{Mouse-2},
422or move point there and type @key{RET}. Use @kbd{C-c C-b} to retrace
423your steps.
424
425@cindex URL, viewing in help
426@cindex help, viewing web pages
427@cindex viewing web pages in help
428@cindex web pages, viewing in help
429@findex browse-url
430 You can follow cross references to URLs (web pages) also. This uses
431the @code{browse-url} command to view the page in the browser you
432choose. @xref{Browse-URL}.
433
434@kindex @key{TAB} @r{(Help mode)}
435@findex help-next-ref
436@kindex S-@key{TAB} @r{(Help mode)}
437@findex help-previous-ref
438 There are convenient commands to move point to cross references in
439the help text. @key{TAB} (@code{help-next-ref}) moves point down to
440the next cross reference. @kbd{S-@key{TAB}} moves up to the previous
441cross reference (@code{help-previous-ref}).
442
443 To view all documentation about any symbol name that appears in the
444text, move point to the symbol name and type @kbd{C-c C-c}
445(@code{help-follow-symbol}). This shows all available documentation
446about the symbol as a variable, function and/or face. As above, use
447@kbd{C-c C-b} to retrace your steps.
448
391@node Library Keywords 449@node Library Keywords
392@section Keyword Search for Lisp Libraries 450@section Keyword Search for Lisp Libraries
393 451
@@ -458,62 +516,6 @@ input method currently in use. @xref{Input Methods}.
458coding systems---either a specified coding system, or the ones 516coding systems---either a specified coding system, or the ones
459currently in use. @xref{Coding Systems}. 517currently in use. @xref{Coding Systems}.
460 518
461@node Help Mode
462@section Help Mode Commands
463
464 Help buffers provide the same commands as View mode (@pxref{Misc File
465Ops}), plus a few special commands of their own.
466
467@table @kbd
468@item @key{SPC}
469Scroll forward.
470@item @key{DEL}
471Scroll backward.
472@item @key{RET}
473Follow a cross reference at point.
474@item @key{TAB}
475Move point forward to the next cross reference.
476@item S-@key{TAB}
477Move point back to the previous cross reference.
478@item Mouse-1
479@itemx Mouse-2
480Follow a cross reference that you click on.
481@item C-c C-c
482Show all documentation about the symbol at point.
483@end table
484
485 When a function name (@pxref{M-x,, Running Commands by Name}),
486variable name (@pxref{Variables}), or face name (@pxref{Faces})
487appears in the documentation, it normally appears inside paired
488single-quotes. To view the documentation of that command, variable or
489face, you can click on the name with @kbd{Mouse-1} or @kbd{Mouse-2},
490or move point there and type @key{RET}. Use @kbd{C-c C-b} to retrace
491your steps.
492
493@cindex URL, viewing in help
494@cindex help, viewing web pages
495@cindex viewing web pages in help
496@cindex web pages, viewing in help
497@findex browse-url
498 You can follow cross references to URLs (web pages) also. This uses
499the @code{browse-url} command to view the page in the browser you
500choose. @xref{Browse-URL}.
501
502@kindex @key{TAB} @r{(Help mode)}
503@findex help-next-ref
504@kindex S-@key{TAB} @r{(Help mode)}
505@findex help-previous-ref
506 There are convenient commands to move point to cross references in
507the help text. @key{TAB} (@code{help-next-ref}) moves point down to
508the next cross reference. @kbd{S-@key{TAB}} moves up to the previous
509cross reference (@code{help-previous-ref}).
510
511 To view all documentation about any symbol name that appears in the
512text, move point to the symbol name and type @kbd{C-c C-c}
513(@code{help-follow-symbol}). This shows all available documentation
514about the symbol as a variable, function and/or face. As above, use
515@kbd{C-c C-b} to retrace your steps.
516
517@node Misc Help 519@node Misc Help
518@section Other Help Commands 520@section Other Help Commands
519 521