Mercurial > emacs
comparison man/info.texi @ 44785:a59fec4b6783
Rename Advanced Info to Expert Info.
Rename Expert to Advanced.
Fix many small errors.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 23 Apr 2002 18:36:05 +0000 |
parents | 82c3e065a9c4 |
children | b986daa6d686 |
comparison
equal
deleted
inserted
replaced
44784:8180d4f92b70 | 44785:a59fec4b6783 |
---|---|
4 @settitle Info | 4 @settitle Info |
5 @syncodeindex fn cp | 5 @syncodeindex fn cp |
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.19 2002/03/16 19:32:15 eliz Exp $ | 9 @comment $Id: info.texi,v 1.20 2002/03/18 06:45:49 eliz Exp $ |
10 | 10 |
11 @dircategory Texinfo documentation system | 11 @dircategory Texinfo documentation system |
12 @direntry | 12 @direntry |
13 * Info: (info). How to use the documentation browsing system. | 13 * Info: (info). How to use the documentation browsing system. |
14 @end direntry | 14 @end direntry |
83 @ifinfo | 83 @ifinfo |
84 If you are new to Info and want to learn how to use it, type the | 84 If you are new to Info and want to learn how to use it, type the |
85 command @kbd{h} now. It brings you to a programmed instruction | 85 command @kbd{h} now. It brings you to a programmed instruction |
86 sequence. | 86 sequence. |
87 | 87 |
88 To learn advanced Info commands, type @kbd{n} twice. This brings you to | 88 To learn expert-level Info commands, type @kbd{n} twice. This brings you to |
89 @cite{Info for Experts}, skipping over the `Getting Started' chapter. | 89 @cite{Info for Experts}, skipping over the `Getting Started' chapter. |
90 @end ifinfo | 90 @end ifinfo |
91 @end ifnottex | 91 @end ifnottex |
92 | 92 |
93 @menu | 93 @menu |
94 * Getting Started:: Getting started using an Info reader. | 94 * Getting Started:: Getting started using an Info reader. |
95 * Advanced Info:: Advanced commands within Info. | 95 * Expert Info:: Info commands for experts. |
96 * Creating an Info File:: How to make your own Info file. | 96 * Creating an Info File:: How to make your own Info file. |
97 * Index:: An index of topics, commands, and variables. | 97 * Index:: An index of topics, commands, and variables. |
98 @end menu | 98 @end menu |
99 | 99 |
100 @node Getting Started, Advanced Info, Top, Top | 100 @node Getting Started, Expert Info, Top, Top |
101 @comment node-name, next, previous, up | 101 @comment node-name, next, previous, up |
102 @chapter Getting Started | 102 @chapter Getting Started |
103 | 103 |
104 This first part of the Info manual describes how to get around inside | 104 This first part of the Info manual describes how to get around inside |
105 of Info. The second part of the manual describes various advanced | 105 of Info. The second part of the manual describes various advanced |
308 | 308 |
309 @node Help-^L, Help-M, Help-P, Getting Started | 309 @node Help-^L, Help-M, Help-P, Getting Started |
310 @comment node-name, next, previous, up | 310 @comment node-name, next, previous, up |
311 @section The Space, DEL, B and ^L commands. | 311 @section The Space, DEL, B and ^L commands. |
312 | 312 |
313 This node's mode line tells you that you are now at node @samp{Help-^L}, | 313 This node's mode line tells you that you are now at node |
314 and the header line tells you that @kbd{p} would get you back to | 314 @samp{Help-^L}, and the header line tells you that @kbd{p} would get |
315 @samp{Help-P}. The node's title is underlined; it says what the node | 315 you back to @samp{Help-P}. The node's title is highlighted and may be |
316 is about (most nodes have titles). | 316 underlined as well; it says what the node is about. |
317 | 317 |
318 This is a big node and it does not all fit on your display screen. | 318 This is a big node and it does not all fit on your display screen. |
319 You can tell that there is more that is not visible because you | 319 You can tell that there is more that is not visible because you |
320 can see the string @samp{--Top-----} rather than @samp{--All----} near | 320 can see the string @samp{--Top-----} rather than @samp{--All----} near |
321 the bottom right corner of the screen. | 321 the bottom right corner of the screen. |
396 | 396 |
397 @format | 397 @format |
398 >> Try that now. (We have put in enough verbiage to push this past | 398 >> Try that now. (We have put in enough verbiage to push this past |
399 the first screenful, but screens are so big nowadays that perhaps it | 399 the first screenful, but screens are so big nowadays that perhaps it |
400 isn't enough. You may need to shrink your Emacs or Info window.) | 400 isn't enough. You may need to shrink your Emacs or Info window.) |
401 Then come back, with @key{SPS}s. | 401 Then come back, by typing @key{SPC} one or more times. |
402 @end format | 402 @end format |
403 | 403 |
404 If your screen is very tall, all of this node might fit at once. | 404 If your screen is very tall, all of this node might fit at once. |
405 In that case, @kbd{b} won't do anything. Sorry; what can we do? | 405 In that case, @kbd{b} won't do anything. Sorry; what can we do? |
406 | 406 |
457 subtopic. Lines in the menu that do not start with a @samp{*} have no | 457 subtopic. Lines in the menu that do not start with a @samp{*} have no |
458 special meaning---they are only for the human reader's benefit and do | 458 special meaning---they are only for the human reader's benefit and do |
459 not define additional subtopics. Here is an example: | 459 not define additional subtopics. Here is an example: |
460 | 460 |
461 @example | 461 @example |
462 * Foo: Node about FOO This tells about FOO | 462 * Foo: Node about FOO. This tells about FOO. |
463 @end example | 463 @end example |
464 | 464 |
465 The subtopic name is Foo, and the node describing it is @samp{Node | 465 The subtopic name is Foo, and the node describing it is @samp{Node |
466 about FOO}. The rest of the line is just for the reader's | 466 about FOO}. The rest of the line is just for the reader's |
467 Information. [[ But this line is not a real menu item, simply because | 467 Information. [[ But this line is not a real menu item, simply because |
477 specify. Often the node name is convenient for the user to specify | 477 specify. Often the node name is convenient for the user to specify |
478 and so both it and the subtopic name are the same. There is an | 478 and so both it and the subtopic name are the same. There is an |
479 abbreviation for this: | 479 abbreviation for this: |
480 | 480 |
481 @example | 481 @example |
482 * Foo:: This tells about FOO | 482 * Foo:: This tells about FOO. |
483 @end example | 483 @end example |
484 | 484 |
485 @noindent | 485 @noindent |
486 This means that the subtopic name and node name are the same; they are | 486 This means that the subtopic name and node name are the same; they are |
487 both @samp{Foo}. | 487 both @samp{Foo}. |
740 do that, one node-step at a time. As you move from node to node, Info | 740 do that, one node-step at a time. As you move from node to node, Info |
741 records the nodes where you have been in a special history list. The | 741 records the nodes where you have been in a special history list. The |
742 @kbd{l} command revisits nodes in the history list; each successive | 742 @kbd{l} command revisits nodes in the history list; each successive |
743 @kbd{l} command moves one step back through the history. | 743 @kbd{l} command moves one step back through the history. |
744 | 744 |
745 If you have been following directions, ad @kbd{l} command now will get | 745 If you have been following directions, an @kbd{l} command now will get |
746 you back to @samp{Help-M}. Another @kbd{l} command would undo the | 746 you back to @samp{Help-M}. Another @kbd{l} command would undo the |
747 @kbd{u} and get you back to @samp{Help-FOO}. Another @kbd{l} would undo | 747 @kbd{u} and get you back to @samp{Help-FOO}. Another @kbd{l} would undo |
748 the @kbd{m} and get you back to @samp{Help-M}. | 748 the @kbd{m} and get you back to @samp{Help-M}. |
749 | 749 |
750 In Emacs, @kbd{l} runs the command @code{Info-last}. | 750 In Emacs, @kbd{l} runs the command @code{Info-last}. |
790 | 790 |
791 @format | 791 @format |
792 >> Now type @kbd{n} to see the last node of the course. | 792 >> Now type @kbd{n} to see the last node of the course. |
793 @end format | 793 @end format |
794 | 794 |
795 @xref{Advanced Info}, for more advanced Info features. | 795 @xref{Expert Info}, for more advanced Info features. |
796 | 796 |
797 @c If a menu appears at the end of this node, remove it. | 797 @c If a menu appears at the end of this node, remove it. |
798 @c It is an accident of the menu updating command. | 798 @c It is an accident of the menu updating command. |
799 | 799 |
800 @node Advanced Info | 800 @node Expert Info |
801 @chapter Info for Experts | 801 @chapter Info for Experts |
802 | 802 |
803 This chapter describes various advanced Info commands. (If you are | 803 This chapter describes various Info commands for experts. (If you |
804 using a stand-alone Info reader, there are additional commands | 804 are using a stand-alone Info reader, there are additional commands |
805 specific to it, which are documented in several chapters of @ref{Top,, | 805 specific to it, which are documented in several chapters of @ref{Top,, |
806 GNU Info, info-stnd, GNU Info}.) | 806 GNU Info, info-stnd, GNU Info}.) |
807 | 807 |
808 This chapter also explains how to write an Info as distinct from a | 808 This chapter also explains how to write an Info as distinct from a |
809 Texinfo file. (However, in most cases, writing a Texinfo file is | 809 Texinfo file. (However, in most cases, writing a Texinfo file is |
810 better, since you can use it @emph{both} to generate an Info file and | 810 better, since you can use it to make a printed manual or an HTML file |
811 to make a printed manual. @xref{Top,, Overview of Texinfo, texinfo, | 811 as well as for generating Info files.) @xref{Top,, Overview of |
812 Texinfo: The GNU Documentation Format}.) | 812 Texinfo, texinfo, Texinfo: The GNU Documentation Format}.) |
813 | 813 |
814 @menu | 814 @menu |
815 * Expert:: Advanced Info commands: g, s, e, and 1 - 5. | 815 * Advanced:: Advanced Info commands: g, s, e, and 1 - 5. |
816 * Info Search:: How to search Info documents for specific subjects. | 816 * Info Search:: How to search Info documents for specific subjects. |
817 * Add:: Describes how to add new nodes to the hierarchy. | 817 * Add:: Describes how to add new nodes to the hierarchy. |
818 Also tells what nodes look like. | 818 Also tells what nodes look like. |
819 * Menus:: How to add to or create menus in Info nodes. | 819 * Menus:: How to add to or create menus in Info nodes. |
820 * Cross-refs:: How to add cross-references to Info nodes. | 820 * Cross-refs:: How to add cross-references to Info nodes. |
821 * Tags:: How to make tags tables for Info files. | 821 * Tags:: How to make tags tables for Info files. |
822 * Checking:: Checking an Info File | 822 * Checking:: Checking an Info File |
823 * Emacs Info Variables:: Variables modifying the behavior of Emacs Info. | 823 * Emacs Info Variables:: Variables modifying the behavior of Emacs Info. |
824 @end menu | 824 @end menu |
825 | 825 |
826 @node Expert, Info Search, , Advanced Info | 826 @node Advanced, Info Search, , Expert Info |
827 @comment node-name, next, previous, up | 827 @comment node-name, next, previous, up |
828 @section Advanced Info Commands | 828 @section Advanced Info Commands |
829 | 829 |
830 Here are some more Info commands that make it easier to move around. | 830 Here are some more Info commands that make it easier to move around. |
831 | 831 |
835 @findex Info-goto-node | 835 @findex Info-goto-node |
836 @cindex go to a node by name | 836 @cindex go to a node by name |
837 If you know a node's name, you can go there by typing @kbd{g}, the | 837 If you know a node's name, you can go there by typing @kbd{g}, the |
838 name, and @key{RET}. Thus, @kbd{gTop@key{RET}} would go to the node | 838 name, and @key{RET}. Thus, @kbd{gTop@key{RET}} would go to the node |
839 called @samp{Top} in this file. (This is equivalent to @kbd{t}, see | 839 called @samp{Top} in this file. (This is equivalent to @kbd{t}, see |
840 @ref{Help-Int}.) @kbd{gExpert@key{RET}} would come back here. | 840 @ref{Help-Int}.) @kbd{gAdvanced{RET}} would come back here. |
841 @kbd{g} in Emacs runs the command @code{Info-goto-node}. | 841 @kbd{g} in Emacs runs the command @code{Info-goto-node}. |
842 | 842 |
843 Unlike @kbd{m}, @kbd{g} does not allow the use of abbreviations. | 843 Unlike @kbd{m}, @kbd{g} does not allow the use of abbreviations. |
844 But it does allow completion, so you can type @key{TAB} to complete a | 844 But it does allow completion, so you can type @key{TAB} to complete a |
845 partial node name. | 845 partial node name. |
892 The @kbd{e} command only works in Emacs, where it runs the command | 892 The @kbd{e} command only works in Emacs, where it runs the command |
893 @code{Info-edit}. The stand-alone Info reader doesn't allow you to | 893 @code{Info-edit}. The stand-alone Info reader doesn't allow you to |
894 edit the Info file, so typing @kbd{e} there goes to the end of the | 894 edit the Info file, so typing @kbd{e} there goes to the end of the |
895 current node. | 895 current node. |
896 | 896 |
897 @node Info Search, Add, Expert, Advanced Info | 897 @node Info Search, Add, Advanced, Expert Info |
898 @comment node-name, next, previous, up | 898 @comment node-name, next, previous, up |
899 @section How to search Info documents for specific subjects | 899 @section How to search Info documents for specific subjects |
900 | 900 |
901 @cindex searching Info documents | 901 @cindex searching Info documents |
902 @cindex Info document as a reference | 902 @cindex Info document as a reference |
968 compatibility with other GNU packages that use @kbd{M-s} for a similar | 968 compatibility with other GNU packages that use @kbd{M-s} for a similar |
969 kind of search command. Both @kbd{s} and @kbd{M-s} run in Emacs the | 969 kind of search command. Both @kbd{s} and @kbd{M-s} run in Emacs the |
970 command @code{Info-search}. | 970 command @code{Info-search}. |
971 | 971 |
972 | 972 |
973 @node Add, Menus, Info Search, Advanced Info | 973 @node Add, Menus, Info Search, Expert Info |
974 @comment node-name, next, previous, up | 974 @comment node-name, next, previous, up |
975 @section Adding a new node to Info | 975 @section Adding a new node to Info |
976 | 976 |
977 To add a new topic to the list in the Info directory, you must: | 977 To add a new topic to the list in the Info directory, you must: |
978 | 978 |
983 Put that topic in the menu in the directory. @xref{Menus, Menu}. | 983 Put that topic in the menu in the directory. @xref{Menus, Menu}. |
984 @end enumerate | 984 @end enumerate |
985 | 985 |
986 Usually, the way to create the nodes is with Texinfo (@pxref{Top,, | 986 Usually, the way to create the nodes is with Texinfo (@pxref{Top,, |
987 Overview of Texinfo, texinfo, Texinfo: The GNU Documentation Format}); | 987 Overview of Texinfo, texinfo, Texinfo: The GNU Documentation Format}); |
988 this has the advantage that you can also make a printed manual from | 988 this has the advantage that you can also make a printed manual or HTML |
989 them. However, if you want to edit an Info file, here is how. | 989 from them. You would use the @samp{@@dircategory} and |
990 @samp{@@direntry} commands to put the manual into the Info directory. | |
991 However, if you want to edit an Info file manually and install it | |
992 manually, here is how. | |
990 | 993 |
991 @cindex node delimiters | 994 @cindex node delimiters |
992 The new node can live in an existing documentation file, or in a new | 995 The new node can live in an existing documentation file, or in a new |
993 one. It must have a @samp{^_} character before it (invisible to the | 996 one. It must have a @samp{^_} character before it (invisible to the |
994 user; this node has one but you cannot see it), and it ends with either | 997 user; this node has one but you cannot see it), and it ends with either |
998 @emph{start} a node. Also, a nicer way to make a node boundary be a | 1001 @emph{start} a node. Also, a nicer way to make a node boundary be a |
999 page boundary as well is to put a @samp{^L} @emph{right after} the | 1002 page boundary as well is to put a @samp{^L} @emph{right after} the |
1000 @samp{^_}.} | 1003 @samp{^_}.} |
1001 | 1004 |
1002 The @samp{^_} starting a node must be followed by a newline or a | 1005 The @samp{^_} starting a node must be followed by a newline or a |
1003 @samp{^L} newline, after which comes the node's header line. The header | 1006 @samp{^L} newline, after which comes the node's header line. The |
1004 line must give the node's name (by which Info finds it), and state the | 1007 header line must give the node's name (by which Info finds it), and |
1005 names of the @samp{Next}, @samp{Previous}, and @samp{Up} nodes (if there | 1008 state the names of the @samp{Next}, @samp{Previous}, and @samp{Up} |
1006 are any). As you can see, this node's @samp{Up} node is the node | 1009 nodes (if there are any). As you can see, this node's @samp{Up} node |
1007 @samp{Top}, which points at all the documentation for Info. The | 1010 is the node @samp{Expert Info}. The @samp{Next} node is @samp{Menus}. |
1008 @samp{Next} node is @samp{Menus}. | |
1009 | 1011 |
1010 @cindex node header line format | 1012 @cindex node header line format |
1011 @cindex format of node headers | 1013 @cindex format of node headers |
1012 The keywords @dfn{Node}, @dfn{Next}, @dfn{Previous}, and @dfn{Up} | 1014 The keywords @dfn{Node}, @dfn{Next}, @dfn{Previous}, and @dfn{Up} |
1013 may appear in any order, anywhere in the header line, but the | 1015 may appear in any order, anywhere in the header line, but the |
1049 | 1051 |
1050 Note that the nodes in this file have a file name in the header | 1052 Note that the nodes in this file have a file name in the header |
1051 line. The file names are ignored by Info, but they serve as comments | 1053 line. The file names are ignored by Info, but they serve as comments |
1052 to help identify the node for the user. | 1054 to help identify the node for the user. |
1053 | 1055 |
1054 @node Menus, Cross-refs, Add, Advanced Info | 1056 @node Menus, Cross-refs, Add, Expert Info |
1055 @comment node-name, next, previous, up | 1057 @comment node-name, next, previous, up |
1056 @section How to Create Menus | 1058 @section How to Create Menus |
1057 | 1059 |
1058 Any node in the Info hierarchy may have a @dfn{menu}---a list of subnodes. | 1060 Any node in the Info hierarchy may have a @dfn{menu}---a list of subnodes. |
1059 The @kbd{m} command searches the current node's menu for the topic which it | 1061 The @kbd{m} command searches the current node's menu for the topic which it |
1105 @kbd{h} command goes to. In fact, since there is no garbage | 1107 @kbd{h} command goes to. In fact, since there is no garbage |
1106 collector, nothing terrible happens if a substructure is not pointed | 1108 collector, nothing terrible happens if a substructure is not pointed |
1107 to, but such a substructure is rather useless since nobody can | 1109 to, but such a substructure is rather useless since nobody can |
1108 ever find out that it exists. | 1110 ever find out that it exists. |
1109 | 1111 |
1110 @node Cross-refs, Tags, Menus, Advanced Info | 1112 @node Cross-refs, Tags, Menus, Expert Info |
1111 @comment node-name, next, previous, up | 1113 @comment node-name, next, previous, up |
1112 @section Creating Cross References | 1114 @section Creating Cross References |
1113 | 1115 |
1114 @cindex cross reference format | 1116 @cindex cross reference format |
1115 A cross reference can be placed anywhere in the text, unlike a menu | 1117 A cross reference can be placed anywhere in the text, unlike a menu |
1164 references. This makes you ready for reading manuals top to bottom, | 1166 references. This makes you ready for reading manuals top to bottom, |
1165 as new users should do when they learn a new package. | 1167 as new users should do when they learn a new package. |
1166 | 1168 |
1167 Another set of Info commands is useful when you need to find | 1169 Another set of Info commands is useful when you need to find |
1168 something quickly in a manual---that is, when you need to use a manual | 1170 something quickly in a manual---that is, when you need to use a manual |
1169 as a reference rather than as a tutorial. We urge you to make learn | 1171 as a reference rather than as a tutorial. We urge you to learn |
1170 these search commands as well. If you want to do that now, follow this | 1172 these search commands as well. If you want to do that now, follow this |
1171 cross reference to @ref{Info Search}. | 1173 cross reference to @ref{Info Search}. |
1172 | 1174 |
1173 Yet another set of commands are meant for experienced users; you can | 1175 Yet another set of commands are meant for experienced users; you can |
1174 find them by looking in the Directory node for documentation on Info. | 1176 find them by looking in the Directory node for documentation on Info. |
1180 @kbd{mInfo} and Return, to get to the node about Info and | 1182 @kbd{mInfo} and Return, to get to the node about Info and |
1181 see what other help is available. | 1183 see what other help is available. |
1182 @end format | 1184 @end format |
1183 | 1185 |
1184 | 1186 |
1185 @node Tags, Checking, Cross-refs, Advanced Info | 1187 @node Tags, Checking, Cross-refs, Expert Info |
1186 @comment node-name, next, previous, up | 1188 @comment node-name, next, previous, up |
1187 @section Tags Tables for Info Files | 1189 @section Tags Tables for Info Files |
1188 | 1190 |
1189 @cindex tags tables in info files | 1191 @cindex tags tables in info files |
1190 You can speed up the access to nodes of a large Info file by giving | 1192 You can speed up the access to nodes of a large Info file by giving |
1225 the beginning of the node's header (ending just after the node name), | 1227 the beginning of the node's header (ending just after the node name), |
1226 a @samp{DEL} character, and the character position in the file of the | 1228 a @samp{DEL} character, and the character position in the file of the |
1227 beginning of the node. | 1229 beginning of the node. |
1228 | 1230 |
1229 | 1231 |
1230 @node Checking, Emacs Info Variables, Tags, Advanced Info | 1232 @node Checking, Emacs Info Variables, Tags, Expert Info |
1231 @section Checking an Info File | 1233 @section Checking an Info File |
1232 | 1234 |
1233 When creating an Info file, it is easy to forget the name of a node when | 1235 When creating an Info file, it is easy to forget the name of a node when |
1234 you are making a pointer to it from another node. If you put in the | 1236 you are making a pointer to it from another node. If you put in the |
1235 wrong name for a node, this is not detected until someone tries to go | 1237 wrong name for a node, this is not detected until someone tries to go |
1244 | 1246 |
1245 @findex Info-validate | 1247 @findex Info-validate |
1246 To check an Info file, do @kbd{M-x Info-validate} while looking at any | 1248 To check an Info file, do @kbd{M-x Info-validate} while looking at any |
1247 node of the file with Emacs Info mode. | 1249 node of the file with Emacs Info mode. |
1248 | 1250 |
1249 @node Emacs Info Variables, , Checking, Advanced Info | 1251 @node Emacs Info Variables, , Checking, Expert Info |
1250 @section Emacs Info-mode Variables | 1252 @section Emacs Info-mode Variables |
1251 | 1253 |
1252 The following variables may modify the behavior of Info-mode in Emacs; | 1254 The following variables may modify the behavior of Info-mode in Emacs; |
1253 you may wish to set one or several of these variables interactively, or | 1255 you may wish to set one or several of these variables interactively, or |
1254 in your @file{~/.emacs} init file. @xref{Examining, Examining and Setting | 1256 in your @file{~/.emacs} init file. @xref{Examining, Examining and Setting |