aboutsummaryrefslogtreecommitdiffstats
path: root/man/help.texi
diff options
context:
space:
mode:
Diffstat (limited to 'man/help.texi')
-rw-r--r--man/help.texi114
1 files changed, 57 insertions, 57 deletions
diff --git a/man/help.texi b/man/help.texi
index 6696b3440dd..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')
@@ -390,6 +390,62 @@ display the most relevant ones first.
390the variable @code{apropos-documentation-sort-by-scores} is 390the variable @code{apropos-documentation-sort-by-scores} is
391@code{nil}, apropos lists the symbols found in alphabetical order. 391@code{nil}, apropos lists the symbols found in alphabetical order.
392 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
393@node Library Keywords 449@node Library Keywords
394@section Keyword Search for Lisp Libraries 450@section Keyword Search for Lisp Libraries
395 451
@@ -460,62 +516,6 @@ input method currently in use. @xref{Input Methods}.
460coding systems---either a specified coding system, or the ones 516coding systems---either a specified coding system, or the ones
461currently in use. @xref{Coding Systems}. 517currently in use. @xref{Coding Systems}.
462 518
463@node Help Mode
464@section Help Mode Commands
465
466 Help buffers provide the same commands as View mode (@pxref{Misc File
467Ops}), plus a few special commands of their own.
468
469@table @kbd
470@item @key{SPC}
471Scroll forward.
472@item @key{DEL}
473Scroll backward.
474@item @key{RET}
475Follow a cross reference at point.
476@item @key{TAB}
477Move point forward to the next cross reference.
478@item S-@key{TAB}
479Move point back to the previous cross reference.
480@item Mouse-1
481@itemx Mouse-2
482Follow a cross reference that you click on.
483@item C-c C-c
484Show all documentation about the symbol at point.
485@end table
486
487 When a function name (@pxref{M-x,, Running Commands by Name}),
488variable name (@pxref{Variables}), or face name (@pxref{Faces})
489appears in the documentation, it normally appears inside paired
490single-quotes. To view the documentation of that command, variable or
491face, you can click on the name with @kbd{Mouse-1} or @kbd{Mouse-2},
492or move point there and type @key{RET}. Use @kbd{C-c C-b} to retrace
493your steps.
494
495@cindex URL, viewing in help
496@cindex help, viewing web pages
497@cindex viewing web pages in help
498@cindex web pages, viewing in help
499@findex browse-url
500 You can follow cross references to URLs (web pages) also. This uses
501the @code{browse-url} command to view the page in the browser you
502choose. @xref{Browse-URL}.
503
504@kindex @key{TAB} @r{(Help mode)}
505@findex help-next-ref
506@kindex S-@key{TAB} @r{(Help mode)}
507@findex help-previous-ref
508 There are convenient commands to move point to cross references in
509the help text. @key{TAB} (@code{help-next-ref}) moves point down to
510the next cross reference. @kbd{S-@key{TAB}} moves up to the previous
511cross reference (@code{help-previous-ref}).
512
513 To view all documentation about any symbol name that appears in the
514text, move point to the symbol name and type @kbd{C-c C-c}
515(@code{help-follow-symbol}). This shows all available documentation
516about the symbol as a variable, function and/or face. As above, use
517@kbd{C-c C-b} to retrace your steps.
518
519@node Misc Help 519@node Misc Help
520@section Other Help Commands 520@section Other Help Commands
521 521