aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuri Linkov2005-08-09 08:44:41 +0000
committerJuri Linkov2005-08-09 08:44:41 +0000
commitab7cd850aa160ffd633070840a56e28408069823 (patch)
tree475e164faf477c9c87067f128f4b88895ce66545
parent185cff95450bac41a0e590d558c7be152e732790 (diff)
downloademacs-ab7cd850aa160ffd633070840a56e28408069823.tar.gz
emacs-ab7cd850aa160ffd633070840a56e28408069823.zip
(Help-P): Replace `Prev' with `Previous'.
(Help-M, Help-Xref): Add S-TAB. (Help-FOO): Update `u' command. (Help-Xref): Move info about Mouse-2 from `Help-Int'. Update info about visibility of xref parts. (Help-Int): Fix `m' command. Rename `Info-last' to `Info-history-back'. Add `Info-history-forward'. (Advanced): Fix `g*' and `M-n' commands. (Info Search): Add `index-apropos' in stand-alone browser. Add isearch commands. (Emacs Info Variables): Remove `Info-fontify'. Add `Info-mode-hook'. Update face names. Add `Info-fontify-maximum-menu-size', `Info-fontify-visited-nodes', `Info-isearch-search'.
-rw-r--r--man/info.texi171
1 files changed, 98 insertions, 73 deletions
diff --git a/man/info.texi b/man/info.texi
index e6c508b4b49..8ff66f1ee37 100644
--- a/man/info.texi
+++ b/man/info.texi
@@ -14,8 +14,8 @@
14This file describes how to use Info, the on-line, menu-driven GNU 14This file describes how to use Info, the on-line, menu-driven GNU
15documentation system. 15documentation system.
16 16
17Copyright (C) 1989, 1992, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 17Copyright (C) 1989, 1992, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
18Free Software Foundation, Inc. 182003, 2004, 2005 Free Software Foundation, Inc.
19 19
20@quotation 20@quotation
21Permission is granted to copy, distribute and/or modify this document 21Permission is granted to copy, distribute and/or modify this document
@@ -238,7 +238,7 @@ line says that this is node @samp{Help} in the file @file{info}.
238(look at it now) says that the @samp{Next} node after this one is the 238(look at it now) says that the @samp{Next} node after this one is the
239node called @samp{Help-P}. An advanced Info command lets you go to 239node called @samp{Help-P}. An advanced Info command lets you go to
240any node whose name you know. In the stand-alone Info reader program, 240any node whose name you know. In the stand-alone Info reader program,
241the header line shows the names of this node and the info file as 241the header line shows the names of this node and the Info file as
242well. In Emacs, the header line is duplicated in a special typeface, 242well. In Emacs, the header line is duplicated in a special typeface,
243and the duplicate remains at the top of the window all the time even 243and the duplicate remains at the top of the window all the time even
244if you scroll through the node. 244if you scroll through the node.
@@ -284,7 +284,7 @@ node, @samp{Help-^L}.
284 If you read this in Emacs, you will see an @samp{Info} item in the 284 If you read this in Emacs, you will see an @samp{Info} item in the
285menu bar, close to its right edge. Clicking the mouse on the 285menu bar, close to its right edge. Clicking the mouse on the
286@samp{Info} menu-bar item opens a menu of commands which include 286@samp{Info} menu-bar item opens a menu of commands which include
287@samp{Next} and @samp{Prev} (and also some others which you didn't yet 287@samp{Next} and @samp{Previous} (and also some others which you didn't yet
288learn about). 288learn about).
289 289
290 This all probably seems insultingly simple so far, but @emph{please 290 This all probably seems insultingly simple so far, but @emph{please
@@ -671,10 +671,12 @@ mistake.
671 671
672 Another way to move to the menu subtopic lines and between them is 672 Another way to move to the menu subtopic lines and between them is
673to type @key{TAB}. Each time you type a @key{TAB}, you move to the 673to type @key{TAB}. Each time you type a @key{TAB}, you move to the
674next subtopic line. To move to a previous subtopic line, type 674next subtopic line. To move to a previous subtopic line in the
675@kbd{M-@key{TAB}}---that is, press and hold the @key{META} key and then 675stand-alone reader, type @kbd{M-@key{TAB}}---that is, press and hold
676press @key{TAB}. (On some keyboards, the @key{META} key might be labeled 676the @key{META} key and then press @key{TAB}. (On some keyboards, the
677@samp{Alt}.) 677@key{META} key might be labeled @samp{Alt}.) In Emacs Info, type
678@kbd{S-@key{TAB}} to move to a previous subtopic line (press and hold
679the @key{Shift} key and then press @key{TAB}).
678 680
679 Once you move cursor to a subtopic line, press @key{RET} to go to 681 Once you move cursor to a subtopic line, press @key{RET} to go to
680that subtopic's node. 682that subtopic's node.
@@ -727,7 +729,8 @@ usually used to ``stay on the same level but go backwards''.
727@code{Info-up}). That puts you at the @emph{front} of the node---to 729@code{Info-up}). That puts you at the @emph{front} of the node---to
728get back to where you were reading you have to type some @key{SPC}s. 730get back to where you were reading you have to type some @key{SPC}s.
729(Some Info readers, such as the one built into Emacs, put you at the 731(Some Info readers, such as the one built into Emacs, put you at the
730same place where you were reading in @samp{Help-M}.) 732menu subtopic line which points to the subnode that the @kbd{u} command
733brought you from.)
731 734
732 Another way to go Up is to click @kbd{Mouse-2} on the @samp{Up} 735 Another way to go Up is to click @kbd{Mouse-2} on the @samp{Up}
733pointer shown in the header line (provided that you have a mouse). 736pointer shown in the header line (provided that you have a mouse).
@@ -785,8 +788,14 @@ to cancel the @kbd{f}.
785 type a @kbd{Control-g} and see how the @samp{f} gives up. 788 type a @kbd{Control-g} and see how the @samp{f} gives up.
786@end format 789@end format
787 790
788 The @key{TAB} and @kbd{M-@key{TAB}} key, which move between menu 791 The @key{TAB}, @kbd{M-@key{TAB}} and @kbd{S-@key{TAB}} keys,
789items in a menu, also move between cross references outside of menus. 792which move between menu items in a menu, also move between cross
793references outside of menus.
794
795 Clicking @kbd{Mouse-2} on or near a cross reference also follows the
796reference. You can see that the cross reference is mouse-sensitive by
797moving the mouse pointer to the reference and watching how the
798underlying text and the mouse pointer change in response.
790 799
791 Sometimes a cross reference (or a node) can lead to another file (in 800 Sometimes a cross reference (or a node) can lead to another file (in
792other words another ``manual''), or, on occasion, even a file on a 801other words another ``manual''), or, on occasion, even a file on a
@@ -795,36 +804,22 @@ stand-alone Info avoid using remote links). Such a cross reference
795looks like this: @xref{Top,, Overview of Texinfo, texinfo, Texinfo: 804looks like this: @xref{Top,, Overview of Texinfo, texinfo, Texinfo:
796The GNU Documentation Format}. (After following this link, type 805The GNU Documentation Format}. (After following this link, type
797@kbd{l} to get back to this node.) Here the name @samp{texinfo} 806@kbd{l} to get back to this node.) Here the name @samp{texinfo}
798between parentheses (shown in the stand-alone version) refers to the 807between parentheses refers to the file name. This file name appears
799file name. This file name appears in cross references and node names 808in cross references and node names if it differs from the current
800if it differs from the current file. In Emacs, the file name is 809file, so you can always know that you are going to be switching to
801hidden (along with other text). (Use @kbd{M-x visible-mode} to show 810another manual and which one.
802or hide it.) 811
803 812However, Emacs normally hides some other text in cross-references.
804 The remainder of this node applies only to the Emacs version. If 813If you put your mouse over the cross reference, then the information
805you use the stand-alone version, you can type @kbd{n} immediately. 814appearing in a separate box (tool tip) or in the echo area will show
806 815the full cross-reference including the file name and the node name of
807 To some users, switching manuals is a much bigger switch than 816the cross reference. If you have a mouse, just leave it over the
808switching sections. These users like to know that they are going to 817cross reference @xref{Top,, Overview of Texinfo, texinfo, Texinfo:
809be switching to another manual (and which one) before actually doing 818The GNU Documentation Format}, and watch what happens. If you
810so, especially given that, if one does not notice, Info commands like 819always like to have that information visible without having to move
811@kbd{t} (see the next node) can have confusing results. 820your mouse over the cross reference, use @kbd{M-x visible-mode}, or
812 821set @code{Info-hide-note-references} to a value other than @code{t}
813 If you put your mouse over the cross reference and if the cross 822(@pxref{Emacs Info Variables}).
814reference leads to a different manual, then the information appearing
815in a separate box (tool tip) or in the echo area, will mention the
816file the cross reference will carry you to (between parentheses).
817This is also true for menu subtopic names. If you have a mouse, just
818leave it over the @samp{Overview} cross reference above and watch what
819happens.
820
821 If you always like to have that information available without having
822to move your mouse over the cross reference, set
823@code{Info-hide-note-references} to a value other than @code{t}
824(@pxref{Emacs Info Variables}). You might also want to do that if you
825have a lot of cross references to files on remote machines and have
826non-permanent or slow access, since otherwise you might not be able to
827distinguish between local and remote links.
828 823
829@format 824@format
830>> Now type @kbd{n} to learn more commands. 825>> Now type @kbd{n} to learn more commands.
@@ -845,8 +840,9 @@ This allows Info readers to go to the exact line of an entry, not just
845the start of the containing node.) 840the start of the containing node.)
846 841
847 You can get to the index from the main menu of the file with the 842 You can get to the index from the main menu of the file with the
848@kbd{m} command; then you can use the @kbd{m} command again in the 843@kbd{m} command and the name of the index node; then you can use the
849index node to go to the node that describes the topic you want. 844@kbd{m} command again in the index node to go to the node that
845describes the topic you want.
850 846
851 There is also a short-cut Info command, @kbd{i}, which does all of 847 There is also a short-cut Info command, @kbd{i}, which does all of
852that for you. It searches the index for a given topic (a string) and 848that for you. It searches the index for a given topic (a string) and
@@ -854,8 +850,8 @@ goes to the node which is listed in the index for that topic.
854@xref{Info Search}, for a full explanation. 850@xref{Info Search}, for a full explanation.
855 851
856@kindex l @r{(Info mode)} 852@kindex l @r{(Info mode)}
857@findex Info-last 853@findex Info-history-back
858@cindex going back in Info mode 854@cindex going back in Info history
859 If you have been moving around to different nodes and wish to 855 If you have been moving around to different nodes and wish to
860retrace your steps, the @kbd{l} command (@kbd{l} for @dfn{last}) will 856retrace your steps, the @kbd{l} command (@kbd{l} for @dfn{last}) will
861do that, one node-step at a time. As you move from node to node, Info 857do that, one node-step at a time. As you move from node to node, Info
@@ -863,7 +859,7 @@ records the nodes where you have been in a special history list. The
863@kbd{l} command revisits nodes in the history list; each successive 859@kbd{l} command revisits nodes in the history list; each successive
864@kbd{l} command moves one step back through the history. 860@kbd{l} command moves one step back through the history.
865 861
866 In Emacs, @kbd{l} runs the command @code{Info-last}. 862 In Emacs, @kbd{l} runs the command @code{Info-history-back}.
867 863
868@format 864@format
869>> Try typing @kbd{p p n} and then three @kbd{l}'s, pausing in between 865>> Try typing @kbd{p p n} and then three @kbd{l}'s, pausing in between
@@ -875,6 +871,13 @@ where @emph{you} last were, whereas @kbd{p} always moves to the node
875which the header says is the @samp{Previous} node (from this node, the 871which the header says is the @samp{Previous} node (from this node, the
876@samp{Prev} link leads to @samp{Help-Xref}). 872@samp{Prev} link leads to @samp{Help-Xref}).
877 873
874@kindex r @r{(Info mode)}
875@findex Info-history-forward
876@cindex going forward in Info history
877 You can use the @kbd{r} command (@code{Info-history-forward} in Emacs)
878to revisit nodes in the history list in the forward direction, so that
879@kbd{r} will return you to the node you came from by typing @kbd{l}.
880
878@kindex d @r{(Info mode)} 881@kindex d @r{(Info mode)}
879@findex Info-directory 882@findex Info-directory
880@cindex go to Directory node 883@cindex go to Directory node
@@ -898,11 +901,6 @@ This is useful if you want to browse the manual's main menu, or select
898some specific top-level menu item. The Emacs command run by @kbd{t} 901some specific top-level menu item. The Emacs command run by @kbd{t}
899is @code{Info-top-node}. 902is @code{Info-top-node}.
900 903
901 Clicking @kbd{Mouse-2} on or near a cross reference also follows the
902reference. You can see that the cross reference is mouse-sensitive by
903moving the mouse pointer to the reference and watching how the
904underlying text and the mouse pointer change in response.
905
906@format 904@format
907>> Now type @kbd{n} to see the last node of the course. 905>> Now type @kbd{n} to see the last node of the course.
908@end format 906@end format
@@ -935,7 +933,7 @@ Documentation Format}.
935* Menus:: How to add to or create menus in Info nodes. 933* Menus:: How to add to or create menus in Info nodes.
936* Cross-refs:: How to add cross-references to Info nodes. 934* Cross-refs:: How to add cross-references to Info nodes.
937* Tags:: How to make tags tables for Info files. 935* Tags:: How to make tags tables for Info files.
938* Checking:: Checking an Info File 936* Checking:: Checking an Info File.
939* Emacs Info Variables:: Variables modifying the behavior of Emacs Info. 937* Emacs Info Variables:: Variables modifying the behavior of Emacs Info.
940@end menu 938@end menu
941 939
@@ -969,7 +967,7 @@ the node @samp{Top} in the Info file @file{dir}. Likewise,
969 967
970 The node name @samp{*} specifies the whole file. So you can look at 968 The node name @samp{*} specifies the whole file. So you can look at
971all of the current file by typing @kbd{g*@key{RET}} or all of any 969all of the current file by typing @kbd{g*@key{RET}} or all of any
972other file with @kbd{g(@var{filename})@key{RET}}. 970other file with @kbd{g(@var{filename})*@key{RET}}.
973 971
974@subheading @kbd{1}--@kbd{9} choose a menu subtopic by its number 972@subheading @kbd{1}--@kbd{9} choose a menu subtopic by its number
975 973
@@ -1017,7 +1015,7 @@ current node.
1017@findex clone-buffer 1015@findex clone-buffer
1018@cindex multiple Info buffers 1016@cindex multiple Info buffers
1019 If you are reading Info in Emacs, you can select a new independent 1017 If you are reading Info in Emacs, you can select a new independent
1020Info buffer in another window by typing @kbd{M-n}. The new buffer 1018Info buffer in the same window by typing @kbd{M-n}. The new buffer
1021starts out as an exact copy of the old one, but you will be able to 1019starts out as an exact copy of the old one, but you will be able to
1022move independently between nodes in the two buffers. (In Info mode, 1020move independently between nodes in the two buffers. (In Info mode,
1023@kbd{M-n} runs the Emacs command @code{clone-buffer}.) 1021@kbd{M-n} runs the Emacs command @code{clone-buffer}.)
@@ -1028,6 +1026,11 @@ m} and @kbd{C-u g} go to a new node in exactly the same way that
1028@kbd{m} and @kbd{g} do, but they do so in a new Info buffer which they 1026@kbd{m} and @kbd{g} do, but they do so in a new Info buffer which they
1029select in another window. 1027select in another window.
1030 1028
1029 Another way to produce new Info buffers in Emacs is to use a numeric
1030prefix argument for the @kbd{C-h i} command (@code{info}) which
1031switches to the Info buffer with that number. Thus, @kbd{C-u 2 C-h i}
1032switches to the buffer @samp{*info*<2>}, creating it if necessary.
1033
1031@node Info Search, Add, Advanced, Expert Info 1034@node Info Search, Add, Advanced, Expert Info
1032@comment node-name, next, previous, up 1035@comment node-name, next, previous, up
1033@section How to search Info documents for specific subjects 1036@section How to search Info documents for specific subjects
@@ -1083,10 +1086,12 @@ you type inside Emacs to run the command bound to @kbd{C-f}.
1083 In Emacs, @kbd{i} runs the command @code{Info-index}. 1086 In Emacs, @kbd{i} runs the command @code{Info-index}.
1084 1087
1085@findex info-apropos 1088@findex info-apropos
1089@findex index-apropos
1086If you don't know what manual documents something, try the @kbd{M-x 1090If you don't know what manual documents something, try the @kbd{M-x
1087info-apropos} command. It prompts for a string and then looks up that 1091info-apropos} command in Emacs, or the @kbd{M-x index-apropos} command
1088string in all the indices of all the Info documents installed on your 1092in the stand-alone reader. It prompts for a string and then looks up
1089system. 1093that string in all the indices of all the Info documents installed on
1094your system.
1090 1095
1091@kindex s @r{(Info mode)} 1096@kindex s @r{(Info mode)}
1092@findex Info-search 1097@findex Info-search
@@ -1095,10 +1100,10 @@ It switches to the next node if and when that is necessary. You
1095type @kbd{s} followed by the string to search for, terminated by 1100type @kbd{s} followed by the string to search for, terminated by
1096@key{RET}. To search for the same string again, just @kbd{s} followed 1101@key{RET}. To search for the same string again, just @kbd{s} followed
1097by @key{RET} will do. The file's nodes are scanned in the order 1102by @key{RET} will do. The file's nodes are scanned in the order
1098they are in in the file, which has no necessary relationship to the 1103they are in the file, which has no necessary relationship to the
1099order that they may be in the tree structure of menus and @samp{next} 1104order that they may be in the tree structure of menus and @samp{next}
1100pointers. But normally the two orders are not very different. In any 1105pointers. But normally the two orders are not very different. In any
1101case, you can always do a @kbd{b} to find out what node you have 1106case, you can always look at the echo area to find out what node you have
1102reached, if the header is not visible (this can happen, because @kbd{s} 1107reached, if the header is not visible (this can happen, because @kbd{s}
1103puts your cursor at the occurrence of the string, not at the beginning 1108puts your cursor at the occurrence of the string, not at the beginning
1104of the node). 1109of the node).
@@ -1109,6 +1114,15 @@ compatibility with other GNU packages that use @kbd{M-s} for a similar
1109kind of search command. Both @kbd{s} and @kbd{M-s} run in Emacs the 1114kind of search command. Both @kbd{s} and @kbd{M-s} run in Emacs the
1110command @code{Info-search}. 1115command @code{Info-search}.
1111 1116
1117@kindex C-s @r{(Info mode)}
1118@kindex C-r @r{(Info mode)}
1119@findex isearch
1120 Instead of using @kbd{s} in Emacs Info and in the stand-alone Info,
1121you can use an incremental search started with @kbd{C-s} or @kbd{C-r}.
1122It can search through multiple Info nodes. @xref{Incremental Search,,,
1123emacs, The GNU Emacs Manual}. In Emacs, this behavior is enabled only
1124if the variable @code{Info-isearch-search} is non-@code{nil}
1125(@pxref{Emacs Info Variables}).
1112 1126
1113@node Add, Menus, Info Search, Expert Info 1127@node Add, Menus, Info Search, Expert Info
1114@comment node-name, next, previous, up 1128@comment node-name, next, previous, up
@@ -1245,9 +1259,9 @@ the nodes in a file to form a connected structure. In fact, this file
1245has two connected components. You are in one of them, which is under 1259has two connected components. You are in one of them, which is under
1246the node @samp{Top}; the other contains the node @samp{Help} which the 1260the node @samp{Top}; the other contains the node @samp{Help} which the
1247@kbd{h} command goes to. In fact, since there is no garbage 1261@kbd{h} command goes to. In fact, since there is no garbage
1248collector, nothing terrible happens if a substructure is not pointed 1262collector on the node graph, nothing terrible happens if a substructure
1249to, but such a substructure is rather useless since nobody can 1263is not pointed to, but such a substructure is rather useless since nobody
1250ever find out that it exists. 1264can ever find out that it exists.
1251 1265
1252@node Cross-refs, Tags, Menus, Expert Info 1266@node Cross-refs, Tags, Menus, Expert Info
1253@comment node-name, next, previous, up 1267@comment node-name, next, previous, up
@@ -1328,7 +1342,7 @@ manner.
1328@comment node-name, next, previous, up 1342@comment node-name, next, previous, up
1329@section Tags Tables for Info Files 1343@section Tags Tables for Info Files
1330 1344
1331@cindex tags tables in info files 1345@cindex tags tables in Info files
1332 You can speed up the access to nodes of a large Info file by giving 1346 You can speed up the access to nodes of a large Info file by giving
1333it a tags table. Unlike the tags table for a program, the tags table for 1347it a tags table. Unlike the tags table for a program, the tags table for
1334an Info file lives inside the file itself and is used 1348an Info file lives inside the file itself and is used
@@ -1408,22 +1422,30 @@ initialize it, or @code{Info-default-directory-list} if there is no
1408@env{INFOPATH} variable in the environment. 1422@env{INFOPATH} variable in the environment.
1409 1423
1410If you wish to customize the Info directory search list for both Emacs 1424If you wish to customize the Info directory search list for both Emacs
1411info and stand-alone Info, it is best to set the @env{INFOPATH} 1425Info and stand-alone Info, it is best to set the @env{INFOPATH}
1412environment variable, since that applies to both programs. 1426environment variable, since that applies to both programs.
1413 1427
1414@item Info-additional-directory-list 1428@item Info-additional-directory-list
1415A list of additional directories to search for Info documentation files. 1429A list of additional directories to search for Info documentation files.
1416These directories are not searched for merging the @file{dir} file. 1430These directories are not searched for merging the @file{dir} file.
1417 1431
1418@item Info-fontify 1432@item Info-mode-hook
1419When set to a non-@code{nil} value, enables highlighting of Info 1433Hooks run when @code{Info-mode} is called. By default, it contains
1420files. The default is @code{t}. You can change how the highlighting 1434the hook @code{turn-on-font-lock} which enables highlighting of Info
1421looks by customizing the faces @code{info-node}, @code{info-xref}, 1435files. You can change how the highlighting looks by customizing the
1422@code{info-header-xref}, @code{info-header-node}, @code{info-menu-5}, 1436faces @code{info-node}, @code{info-xref}, @code{info-xref-visited},
1423@code{info-menu-header}, and @code{info-title-@var{n}-face} (where 1437@code{info-header-xref}, @code{info-header-node}, @code{info-menu-header},
1424@var{n} is the level of the section, a number between 1 and 4). To 1438@code{info-menu-star}, and @code{info-title-@var{n}} (where @var{n}
1425customize a face, type @kbd{M-x customize-face @key{RET} @var{face} 1439is the level of the section, a number between 1 and 4). To customize
1426@key{RET}}, where @var{face} is one of the face names listed here. 1440a face, type @kbd{M-x customize-face @key{RET} @var{face} @key{RET}},
1441where @var{face} is one of the face names listed here.
1442
1443@item Info-fontify-maximum-menu-size
1444Maximum size of menu to fontify if @code{font-lock-mode} is non-@code{nil}.
1445
1446@item Info-fontify-visited-nodes
1447If non-@code{nil}, menu items and cross-references pointing to visited
1448nodes are displayed in the @code{info-xref-visited} face.
1427 1449
1428@item Info-use-header-line 1450@item Info-use-header-line
1429If non-@code{nil}, Emacs puts in the Info buffer a header line showing 1451If non-@code{nil}, Emacs puts in the Info buffer a header line showing
@@ -1449,6 +1471,9 @@ subnode indicated by the following menu item. Setting this option to
1449program, which visits the first subnode from the menu only when you 1471program, which visits the first subnode from the menu only when you
1450hit the end of the current node. The default is @code{nil}. 1472hit the end of the current node. The default is @code{nil}.
1451 1473
1474@item Info-isearch-search
1475If non-@code{nil}, isearch in Info searches through multiple nodes.
1476
1452@item Info-enable-active-nodes 1477@item Info-enable-active-nodes
1453When set to a non-@code{nil} value, allows Info to execute Lisp code 1478When set to a non-@code{nil} value, allows Info to execute Lisp code
1454associated with nodes. The Lisp code is executed when the node is 1479associated with nodes. The Lisp code is executed when the node is