aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLuc Teirlinck2003-07-03 01:59:39 +0000
committerLuc Teirlinck2003-07-03 01:59:39 +0000
commitbac598bbf5d00efafe178061c849801babe79bf0 (patch)
treece68cbb4fc2617ddaafde9c7fbc02013e9e4f72a
parent9e2497ccaf916fc8f7cd36f8073af45f00d30ec9 (diff)
downloademacs-bac598bbf5d00efafe178061c849801babe79bf0.tar.gz
emacs-bac598bbf5d00efafe178061c849801babe79bf0.zip
(Help): Mention existence of Emacs and stand-alone Info at the very
beginning of the tutorial. (Help-Inv): New node. (Help-]): New node. (Help-M): Systematically point out the differences between default Emacs and stand-alone versions. Delete second menu. (Help-Xref): Systematically point out the differences between default Emacs and stand-alone versions. (Help-Int): Change `l' example. (Expert Info): Fix typos. (Emacs Info Variables): Mention `Info-hide-note-references' and new default for `Info-scroll-prefer-subnodes'.
-rw-r--r--man/info.texi246
1 files changed, 184 insertions, 62 deletions
diff --git a/man/info.texi b/man/info.texi
index 3d8c0f5224b..6a195113b5f 100644
--- a/man/info.texi
+++ b/man/info.texi
@@ -6,7 +6,7 @@
6@syncodeindex vr cp 6@syncodeindex vr cp
7@syncodeindex ky cp 7@syncodeindex ky cp
8@comment %**end of header 8@comment %**end of header
9@comment $Id: info.texi,v 1.26 2002/10/02 23:24:31 karl Exp $ 9@comment $Id: info.texi,v 1.27 2002/11/06 00:45:03 karl Exp $
10 10
11@copying 11@copying
12This file describes how to use Info, the on-line, menu-driven GNU 12This file describes how to use Info, the on-line, menu-driven GNU
@@ -51,7 +51,7 @@ license to the document, as described in section 6 of the license.
51@end titlepage 51@end titlepage
52 52
53@ifnottex 53@ifnottex
54@node Top 54@node Top, Getting Started, (dir), (dir)
55@top Info: An Introduction 55@top Info: An Introduction
56 56
57The GNU Project distributes most of its on-line manuals in the 57The GNU Project distributes most of its on-line manuals in the
@@ -125,13 +125,14 @@ the screen.
125* Help:: How to use Info 125* Help:: How to use Info
126* Help-P:: Returning to the Previous node 126* Help-P:: Returning to the Previous node
127* Help-^L:: The Space, DEL, B and ^L commands. 127* Help-^L:: The Space, DEL, B and ^L commands.
128* Help-Inv:: Invisible text in Emacs Info.
128* Help-M:: Menus 129* Help-M:: Menus
129* Help-Xref:: Following cross-references 130* Help-Xref:: Following cross-references
130* Help-Int:: Some intermediate Info commands 131* Help-Int:: Some intermediate Info commands
131* Help-Q:: Quitting Info 132* Help-Q:: Quitting Info
132@end menu 133@end menu
133 134
134@node Help-Small-Screen 135@node Help-Small-Screen, Help, Getting Started, Getting Started
135@section Starting Info on a Small Screen 136@section Starting Info on a Small Screen
136 137
137@ifnotinfo 138@ifnotinfo
@@ -213,6 +214,10 @@ the course.
213 214
214You are talking to the program Info, for reading documentation. 215You are talking to the program Info, for reading documentation.
215 216
217 There are two ways to use Info: from within Emacs or as a
218stand-alone reader that you can invoke from a shell using the command
219@command{info}.
220
216@cindex node, in Info documents 221@cindex node, in Info documents
217 Right now you are looking at one @dfn{Node} of Information. 222 Right now you are looking at one @dfn{Node} of Information.
218A node contains text describing a specific topic at a specific 223A node contains text describing a specific topic at a specific
@@ -283,9 +288,9 @@ coming up.
283 link, to get to the node @samp{Help-^L} and learn more. 288 link, to get to the node @samp{Help-^L} and learn more.
284@end format 289@end format
285 290
286@node Help-^L, Help-M, Help-P, Getting Started 291@node Help-^L, Help-Inv, Help-P, Getting Started
287@comment node-name, next, previous, up 292@comment node-name, next, previous, up
288@section The Space, DEL, B and ^L commands. 293@section The Space, DEL, B and ^L commands
289 294
290 This node's mode line tells you that you are now at node 295 This node's mode line tells you that you are now at node
291@samp{Help-^L}, and the header line tells you that @kbd{p} would get 296@samp{Help-^L}, and the header line tells you that @kbd{p} would get
@@ -409,30 +414,103 @@ the same size screen, it would be impossible to warn you anyway.
409 414
410@format 415@format
411>> Now type @kbd{n}, or click the middle mouse button on the @samp{Next} link, 416>> Now type @kbd{n}, or click the middle mouse button on the @samp{Next} link,
412 to see the description of the @kbd{m} command. 417 to visit the next node.
413@end format 418@end format
414 419
415@node Help-M, Help-Xref, Help-^L, Getting Started 420@node Help-Inv, Help-M, Help-^L, Getting Started
421@comment node-name, next, previous, up
422@section Invisible text in Emacs Info
423
424 Before discussing menus, we need to make some remarks that are only
425relevant to users reading Info using Emacs. Users of the stand-alone
426version can skip this node by typing @kbd{]} now.
427
428@cindex invisible text in Emacs
429 In Emacs, certain text that appears in the stand-alone version is
430normally hidden, technically because it has the @samp{invisibility}
431property. Invisible text is really a part of the text. It becomes
432visible (by default) after killing and yanking, it appears in printed
433output, it gets saved to file just like any other text, and so on.
434Thus it is useful to know it is there.
435
436@findex vis-mode
437You can make invisible text visible by using the command @kbd{M-x
438vis-mode}. @code{vis-mode} is a minor mode, so using it a second time
439will make the text invisible again. Use this command and watch its
440effect on the ``menu'' below and the top line of this node.
441
442If you prefer to @emph{always} see the invisible text, you can set
443@code{Info-hide-note-references} to @code{nil}. Enabling
444@code{vis-mode} permanently is not a real alternative, because Emacs
445Info also uses (although less extensively) another text property that
446can change the text being displayed, the @samp{display} property.
447Only the invisibility property is affected by @code{vis-mode}. When,
448in this tutorial, we refer to the @samp{Emacs} behavior, we mean the
449@emph{default} Emacs behavior.
450
451Now type @kbd{]}, to learn about the @kbd{]} and @kbd{[} commands.
452
453@menu
454* ]: Help-]. Node telling about ].
455* stuff: Help-]. Same node.
456* Help-]:: Yet again, same node.
457@end menu
458
459@node Help-], , , Help-Inv
460@subsection The @kbd{]} and @kbd{[} commands.
461
462If you type @kbd{n} now, you get an error message saying that this
463node has no next node. Similarly, if you type @kbd{p}, the error
464message tells you that there is no previous node. (The exact message
465depends on the Info reader you use.) This is because @kbd{n} and
466@kbd{p} carry you to the next and previous node @emph{at the same
467level}. The present node is contained in a menu (see next) of the
468node you came from, and hence is considered to be at a lower level.
469It is the only node in the previous node's menu (even though it was
470listed three times). Hence it has no next or previous node that
471@kbd{n} or @kbd{p} could move to.
472
473If you systematically move through a manual by typing @kbd{n}, you run
474the risk of skipping many nodes. You do not run this risk if you
475systematically use @kbd{@key{SPC}}, because, when you scroll to the
476bottom of a node and type another @kbd{@key{SPC}}, then this carries
477you to the following node in the manual @emph{regardless of level}.
478If you immediately want to go to that node, without having to scroll
479to the bottom of the screen first, you can type @kbd{]}.
480
481Similarly, @kbd{@key{BACKSPACE}} carries you to the preceding node
482regardless of level, after you scrolled to the beginning of the
483present node. If you want to go to the preceding node immediately,
484you can type @kbd{[}.
485
486For instance, typing this sequence will come back here in three steps:
487@kbd{[ n [}. To do the same backward, type @kbd{] p ]}.
488
489Now type @kbd{]} to go to the next node and learn about menus.
490
491@node Help-M, Help-Xref, Help-Inv, Getting Started
416@comment node-name, next, previous, up 492@comment node-name, next, previous, up
417@section Menus and the @kbd{m} command 493@section Menus and the @kbd{m} command
418 494
419@cindex menus in an Info document 495@cindex menus in an Info document
420@cindex Info menus 496@cindex Info menus
421 With only the @kbd{n} (next) and @kbd{p} (previous) commands for 497 With only the @kbd{n} (next), @kbd{p} (previous), @kbd{@key{SPC}},
422moving between nodes, nodes are restricted to a linear sequence. 498@kbd{@key{BACKSPACE}}, @kbd{]} and @kbd{[} commands for moving between
423Menus allow a branching structure. A menu is a list of other nodes 499nodes, nodes are restricted to a linear sequence. Menus allow a
424you can move to. It is actually just part of the text of the node 500branching structure. A menu is a list of other nodes you can move to.
425formatted specially so that Info can interpret it. The beginning of a 501It is actually just part of the text of the node formatted specially
426menu is always identified by a line which starts with @samp{* Menu:}. 502so that Info can interpret it. The beginning of a menu is always
427A node contains a menu if and only if it has a line in it which starts 503identified by a line which starts with @w{@samp{* Menu:}}. A node
428that way. The only menu you can use at any moment is the one in the 504contains a menu if and only if it has a line in it which starts that
429node you are in. To use a menu in any other node, you must move to 505way. The only menu you can use at any moment is the one in the node
430that node first. 506you are in. To use a menu in any other node, you must move to that
507node first.
431 508
432 After the start of the menu, each line that starts with a @samp{*} 509 After the start of the menu, each line that starts with a @samp{*}
433identifies one subtopic. The line usually contains a brief name 510identifies one subtopic. The line usually contains a brief name for
434for the subtopic (followed by a @samp{:}), the name of the node that talks 511the subtopic (followed by a @samp{:}, normally hidden in Emacs), the
435about that subtopic, and optionally some further description of the 512name of the node that talks about that subtopic (again, normally
513hidden in Emacs), and optionally some further description of the
436subtopic. Lines in the menu that do not start with a @samp{*} have no 514subtopic. Lines in the menu that do not start with a @samp{*} have no
437special meaning---they are only for the human reader's benefit and do 515special meaning---they are only for the human reader's benefit and do
438not define additional subtopics. Here is an example: 516not define additional subtopics. Here is an example:
@@ -444,7 +522,11 @@ not define additional subtopics. Here is an example:
444The subtopic name is Foo, and the node describing it is @samp{Node 522The subtopic name is Foo, and the node describing it is @samp{Node
445about FOO}. The rest of the line is just for the reader's 523about FOO}. The rest of the line is just for the reader's
446Information. [[ But this line is not a real menu item, simply because 524Information. [[ But this line is not a real menu item, simply because
447there is no line above it which starts with @samp{* Menu:}.]] 525there is no line above it which starts with @w{@samp{* Menu:}}. Also,
526in a real menu item, the @samp{*} would appear at the very start of
527the line. This is why the ``normally hidden'' text in Emacs, namely
528@samp{: Node about FOO.}, is actually visible in this example, even
529when @code{vis-mode} is off.]]
448 530
449 When you use a menu to go to another node (in a way that will be 531 When you use a menu to go to another node (in a way that will be
450described soon), what you specify is the subtopic name, the first 532described soon), what you specify is the subtopic name, the first
@@ -463,7 +545,7 @@ abbreviation for this:
463 545
464@noindent 546@noindent
465This means that the subtopic name and node name are the same; they are 547This means that the subtopic name and node name are the same; they are
466both @samp{Foo}. 548both @samp{Foo}. (The @samp{::} is normally hidden in Emacs.)
467 549
468@format 550@format
469>> Now use @key{SPC} to find the menu in this node, then come back to 551>> Now use @key{SPC} to find the menu in this node, then come back to
@@ -488,16 +570,18 @@ another command. The @kbd{m} command is different: it needs to know
488the @dfn{name of the subtopic}. Once you have typed @kbd{m}, Info 570the @dfn{name of the subtopic}. Once you have typed @kbd{m}, Info
489tries to read the subtopic name. 571tries to read the subtopic name.
490 572
491 Now look for the line containing many dashes near the bottom of the 573 Now, in the stand-alone Info, look for the line containing many
492screen. There is one more line beneath that one, but usually it is 574dashes near the bottom of the screen. (This is the stand-alone
493blank. When it is blank, Info is ready for a command, such as @kbd{n} 575equivalent for the mode line in Emacs.) There is one more line
494or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains text ending 576beneath that one, but usually it is blank. (In Emacs, this is the
495in a colon, it means Info is reading more input for the last command. 577echo area.) When it is blank, Info is ready for a command, such as
496You can't type an Info command then, because Info is trying to read 578@kbd{n} or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains
497input, not commands. You must either give the input and finish the 579text ending in a colon, it means Info is reading more input for the
498command you started, or type @kbd{Control-g} to cancel the command. 580last command. You can't type an Info command then, because Info is
499When you have done one of those things, the input entry line becomes 581trying to read input, not commands. You must either give the input
500blank again. Then you can type Info commands again. 582and finish the command you started, or type @kbd{Control-g} to cancel
583the command. When you have done one of those things, the input entry
584line becomes blank again. Then you can type Info commands again.
501 585
502@findex Info-menu 586@findex Info-menu
503 The command to go to a subnode via a menu is @kbd{m}. After you type 587 The command to go to a subnode via a menu is @kbd{m}. After you type
@@ -535,6 +619,8 @@ three ways of going to one place, Help-FOO:
535* Help-FOO:: And yet another! 619* Help-FOO:: And yet another!
536@end menu 620@end menu
537 621
622(Turn @code{vis-mode} on if you are using Emacs.)
623
538@format 624@format
539>> Now type just an @kbd{m} and see what happens: 625>> Now type just an @kbd{m} and see what happens:
540@end format 626@end format
@@ -610,14 +696,6 @@ node's header line it acts like @kbd{n}, @kbd{p}, or @kbd{u}, etc. At
610end of the node's text @kbd{Mouse-2} moves to the next node, or up if 696end of the node's text @kbd{Mouse-2} moves to the next node, or up if
611there's no next node. 697there's no next node.
612 698
613 Here is another way to get to Help-FOO, a menu. You can ignore this
614if you want, or else try it by typing @key{TAB} and then @key{RET}, or
615clicking @kbd{Mouse-2} on it (but then please come back to here).
616
617@menu
618* Help-FOO::
619@end menu
620
621@format 699@format
622>> Type @kbd{n} to see more commands. 700>> Type @kbd{n} to see more commands.
623@end format 701@end format
@@ -656,7 +734,8 @@ pointer shown in the header line (provided that you have a mouse).
656 In Info documentation, you will see many @dfn{cross references}. 734 In Info documentation, you will see many @dfn{cross references}.
657Cross references look like this: @xref{Help-Cross, Cross}. That text 735Cross references look like this: @xref{Help-Cross, Cross}. That text
658is a real, live cross reference, whose name is @samp{Cross} and which 736is a real, live cross reference, whose name is @samp{Cross} and which
659points to the node named @samp{Help-Cross}. 737points to the node named @samp{Help-Cross}. (The node name is hidden
738in Emacs. Do @kbd{M-x vis-mode} to show or hide it.)
660 739
661@kindex f @r{(Info mode)} 740@kindex f @r{(Info mode)}
662@findex Info-follow-reference 741@findex Info-follow-reference
@@ -699,6 +778,47 @@ to cancel the @kbd{f}.
699 The @key{TAB} and @kbd{M-@key{TAB}} key, which move between menu 778 The @key{TAB} and @kbd{M-@key{TAB}} key, which move between menu
700items in a menu, also move between cross references outside of menus. 779items in a menu, also move between cross references outside of menus.
701 780
781 Sometimes a cross reference (or a node) can lead to another file (in
782other words another ``manual''), or, on occasion, even a file on a
783remote machine (although Info files distributed with Emacs or the
784stand-alone Info avoid using remote links). Such a cross reference
785looks like this: @xref{Overview,,,texinfo}. (After following this
786link, type @kbd{l} to get back to this node.) Here the name
787@samp{texinfo} between parentheses (shown in the stand-alone version)
788refers to the file name. This file name appears in cross references
789and node names if it differs from the current file. In Emacs, the
790file name is hidden (along with other text). (Use @kbd{M-x vis-mode}
791to show or hide it.)
792
793 The remainder of this node applies only to the Emacs version. If
794you use the stand-alone version, you can type @kbd{n} immediately.
795
796 To some users, switching manuals is a much bigger switch than
797switching sections. These users like to know that they are going to
798be switching to another manual (and which one) before actually doing
799so, especially given that, if one does not notice, Info commands like
800@kbd{t} (see the next node) can have confusing results.
801
802 If you put your mouse over the cross reference and if the cross
803reference leads to a different manual, then the information appearing
804in a separate box (tool tip) or in the echo area, will mention the
805file the cross reference will carry you to (between parentheses).
806This is also true for menu subtopic names. If you have a mouse, just
807leave it over the @samp{Overview} cross reference above and watch what
808happens.
809
810 If you always like to have that information available without having
811to move your mouse over the cross reference, set
812@code{Info-hide-note-references} to a value other than t (@pxref{Emacs
813Info Variables}). You might also want to do that if you have a lot of
814cross references to files on remote machines and have non-permanent or
815slow access, since otherwise you might not be able to distinguish
816between local and remote links.
817
818@format
819>> Now type @kbd{n} to learn more commands.
820@end format
821
702@node Help-Int, Help-Q, Help-Xref, Getting Started 822@node Help-Int, Help-Q, Help-Xref, Getting Started
703@comment node-name, next, previous, up 823@comment node-name, next, previous, up
704@section Some intermediate Info commands 824@section Some intermediate Info commands
@@ -728,23 +848,17 @@ records the nodes where you have been in a special history list. The
728@kbd{l} command revisits nodes in the history list; each successive 848@kbd{l} command revisits nodes in the history list; each successive
729@kbd{l} command moves one step back through the history. 849@kbd{l} command moves one step back through the history.
730 850
731 If you have been following directions, an @kbd{l} command now will get
732you back to @samp{Help-M}. Another @kbd{l} command would undo the
733@kbd{u} and get you back to @samp{Help-FOO}. Another @kbd{l} would undo
734the @kbd{m} and get you back to @samp{Help-M}.
735
736 In Emacs, @kbd{l} runs the command @code{Info-last}. 851 In Emacs, @kbd{l} runs the command @code{Info-last}.
737 852
738@format 853@format
739>> Try typing three @kbd{l}'s, pausing in between to see what each 854>> Try typing @kbd{p p n} and then three @kbd{l}'s, pausing in between
740 @kbd{l} does. Then follow directions again and you will end up 855to see what each @kbd{l} does. You should wind up right back here.
741 back here.
742@end format 856@end format
743 857
744 Note the difference between @kbd{l} and @kbd{p}: @kbd{l} moves to 858 Note the difference between @kbd{l} and @kbd{p}: @kbd{l} moves to
745where @emph{you} last were, whereas @kbd{p} always moves to the node 859where @emph{you} last were, whereas @kbd{p} always moves to the node
746which the header says is the @samp{Previous} node (from this node, the 860which the header says is the @samp{Previous} node (from this node, the
747@samp{Prev} link leads to @samp{Help-M}). 861@samp{Prev} link leads to @samp{Help-Xref}).
748 862
749@kindex d @r{(Info mode)} 863@kindex d @r{(Info mode)}
750@findex Info-directory 864@findex Info-directory
@@ -796,10 +910,10 @@ Texinfo file. (However, in most cases, writing a Texinfo file is
796better, since you can use it to make a printed manual or produce other 910better, since you can use it to make a printed manual or produce other
797formats, such as HTML and DocBook, as well as for generating Info 911formats, such as HTML and DocBook, as well as for generating Info
798files.) @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU 912files.) @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU
799Documentation Format}.) 913Documentation Format}.
800 914
801@menu 915@menu
802* Advanced:: Advanced Info commands: g, s, e, and 1 - 5. 916* Advanced:: Advanced Info commands: g, e, and 1 - 9.
803* Info Search:: How to search Info documents for specific subjects. 917* Info Search:: How to search Info documents for specific subjects.
804* Add:: Describes how to add new nodes to the hierarchy. 918* Add:: Describes how to add new nodes to the hierarchy.
805 Also tells what nodes look like. 919 Also tells what nodes look like.
@@ -1049,15 +1163,15 @@ The @kbd{m} command searches the current node's menu for the topic which it
1049reads from the terminal. 1163reads from the terminal.
1050 1164
1051@cindex menu and menu entry format 1165@cindex menu and menu entry format
1052 A menu begins with a line starting with @samp{* Menu:}. The rest of the 1166 A menu begins with a line starting with @w{@samp{* Menu:}}. The
1053line is a comment. After the starting line, every line that begins 1167rest of the line is a comment. After the starting line, every line
1054with a @samp{* } lists a single topic. The name of the topic--what 1168that begins with a @samp{* } lists a single topic. The name of the
1055the user must type at the @kbd{m}'s command prompt to select this 1169topic--what the user must type at the @kbd{m}'s command prompt to
1056topic---comes right after the star and space, and is followed by a 1170select this topic---comes right after the star and space, and is
1057colon, spaces and tabs, and the name of the node which discusses that 1171followed by a colon, spaces and tabs, and the name of the node which
1058topic. The node name, like node names following @samp{Next}, @samp{Previous} 1172discusses that topic. The node name, like node names following
1059and @samp{Up}, may be terminated with a tab, comma, or newline; it may also 1173@samp{Next}, @samp{Previous} and @samp{Up}, may be terminated with a
1060be terminated with a period. 1174tab, comma, or newline; it may also be terminated with a period.
1061 1175
1062 If the node name and topic name are the same, then rather than 1176 If the node name and topic name are the same, then rather than
1063giving the name twice, the abbreviation @samp{* @var{name}::} may be 1177giving the name twice, the abbreviation @samp{* @var{name}::} may be
@@ -1278,6 +1392,14 @@ the @samp{Next}, @samp{Prev}, and @samp{Up} links. A header line does
1278not scroll with the rest of the buffer, making these links always 1392not scroll with the rest of the buffer, making these links always
1279visible. 1393visible.
1280 1394
1395@item Info-hide-note-references
1396As explained in earlier nodes, the Emacs version of Info normally
1397hides some text in menus and cross-references. You can completely
1398disable this feature, by setting this option to @code{nil}. Setting
1399it to a value that is neither @code{nil} nor @code{t} produces an
1400intermediate behavior, hiding a limited amount of text, but showing
1401all text that could potentially be useful.
1402
1281@item Info-scroll-prefer-subnodes 1403@item Info-scroll-prefer-subnodes
1282If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or 1404If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or
1283@key{DEL}) keys in a menu visit subnodes of the current node before 1405@key{DEL}) keys in a menu visit subnodes of the current node before
@@ -1286,7 +1408,7 @@ node's menu appears on the screen, the next @key{SPC} moves to a
1286subnode indicated by the following menu item. Setting this option to 1408subnode indicated by the following menu item. Setting this option to
1287@code{nil} results in behavior similar to the stand-alone Info reader 1409@code{nil} results in behavior similar to the stand-alone Info reader
1288program, which visits the first subnode from the menu only when you 1410program, which visits the first subnode from the menu only when you
1289hit the end of the current node. The default is @code{t}. 1411hit the end of the current node. The default is @code{nil}.
1290 1412
1291@item Info-enable-active-nodes 1413@item Info-enable-active-nodes
1292When set to a non-@code{nil} value, allows Info to execute Lisp code 1414When set to a non-@code{nil} value, allows Info to execute Lisp code