home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / gnu / info / info.info (.txt) < prev    next >
GNU Info File  |  1994-11-17  |  31KB  |  590 lines
  1. This is Info file info.info, produced by Makeinfo-1.55 from the input
  2. file info.texi.
  3.    This file describes how to use Info, the on-line, menu-driven GNU
  4. documentation system.
  5.    Copyright (C) 1989, 1992 Free Software Foundation, Inc.
  6.    Permission is granted to make and distribute verbatim copies of this
  7. manual provided the copyright notice and this permission notice are
  8. preserved on all copies.
  9.    Permission is granted to copy and distribute modified versions of
  10. this manual under the conditions for verbatim copying, provided that
  11. the entire resulting derived work is distributed under the terms of a
  12. permission notice identical to this one.
  13.    Permission is granted to copy and distribute translations of this
  14. manual into another language, under the above conditions for modified
  15. versions, except that this permission notice may be stated in a
  16. translation approved by the Free Software Foundation.
  17. File: info.info,  Node: Top,  Next: Getting Started,  Prev: (dir),  Up: (dir)
  18. Info: An Introduction
  19. *********************
  20.    Info is a program for reading documentation, which you are using now.
  21.    To learn how to use Info, type the command `h'.  It brings you to a
  22. programmed instruction sequence.
  23.    To learn advanced Info commands, type `n' twice.  This brings you to
  24. `Info for Experts', skipping over the .  `Getting Started' chapter.
  25. * Menu:
  26. * Getting Started::
  27. * Advanced Info::
  28. * Create an Info File::
  29. File: info.info,  Node: Getting Started,  Next: Advanced Info,  Prev: Top,  Up: Top
  30. Getting Started
  31. ***************
  32.    This first part of the Info manual describes how to get around inside
  33. of Info.  The second part of the manual describes various advanced Info
  34. commands, and how to write an Info as distinct from a Texinfo file.
  35. The third part is about how to generate Info files from Texinfo files.
  36. * Menu:
  37. * Help-Small-Screen::   Starting Info on a Small Screen
  38. * Help::                How to use Info
  39. * Help-P::              Returning to the Previous node
  40. * Help-^L::             The Space, Rubout, B and ^L commands.
  41. * Help-M::              Menus
  42. * Help-Adv::            Some advanced Info commands
  43. * Help-Q::              Quitting Info
  44. File: info.info,  Node: Help-Small-Screen,  Next: Help,  Up: Getting Started
  45. Starting Info on a Small Screen
  46. ===============================
  47.    Since your terminal has an unusually small number of lines on its
  48. screen, it is necessary to give you special advice at the beginning.
  49.    If you see the text `--All----' at near the bottom right corner of
  50. the screen, it means the entire text you are looking at fits on the
  51. screen.  If you see `--Top----' instead, it means that there is more
  52. text below that does not fit.  To move forward through the text and see
  53. another screen full, press the Space bar, SPC.  To move back up, press
  54. the key labeled `Rubout' or `Delete' or DEL.
  55.    Here are 40 lines of junk, so you can try SPC and DEL and see what
  56. they do.  At the end are instructions of what you should do next.
  57.    This is line 17
  58. This is line 18
  59. This is line 19
  60. This is line 20
  61. This is line 21
  62. This is line 22
  63. This is line 23
  64. This is line 24
  65. This is line 25
  66. This is line 26
  67. This is line 27
  68. This is line 28
  69. This is line 29
  70. This is line 30
  71. This is line 31
  72. This is line 32
  73. This is line 33
  74. This is line 34
  75. This is line 35
  76. This is line 36
  77. This is line 37
  78. This is line 38
  79. This is line 39
  80. This is line 40
  81. This is line 41
  82. This is line 42
  83. This is line 43
  84. This is line 44
  85. This is line 45
  86. This is line 46
  87. This is line 47
  88. This is line 48
  89. This is line 49
  90. This is line 50
  91. This is line 51
  92. This is line 52
  93. This is line 53
  94. This is line 54
  95. This is line 55
  96. This is line 56
  97. If you have managed to get here, go back to the beginning with DEL, and
  98. come back here again, then you understand SPC and DEL.  So now type an
  99. `n'--just one character; do not type the quotes and do not type the
  100. Return key, RET, afterward--to get to the normal start of the course.
  101. File: info.info,  Node: Help,  Next: Help-P,  Prev: Help-Small-Screen,  Up: Getting Started
  102. How to use Info
  103. ===============
  104.    You are talking to the program Info, for reading documentation.
  105.    Right now you are looking at one "Node" of Information.  A node
  106. contains text describing a specific topic at a specific level of
  107. detail.  This node's topic is "how to use Info".
  108.    The top line of a node is its "header".  This node's header (look at
  109. it now) says that it is the node named `Help' in the file `info'.  It
  110. says that the `Next' node after this one is the node called `Help-P'.
  111. An advanced Info command lets you go to any node whose name you know.
  112.    Besides a `Next', a node can have a `Previous' or an `Up'.  This
  113. node has a `Previous' but no `Up', as you can see.
  114.    Now it is time to move on to the `Next' node, named `Help-P'.
  115.    >> Type `n' to move there.  Type just one character;    do not type
  116. the quotes and do not type a RET afterward.
  117.    `>>' in the margin means it is really time to try a command.
  118. File: info.info,  Node: Help-P,  Next: Help-^L,  Prev: Help,  Up: Getting Started
  119. Returning to the Previous node
  120. ==============================
  121.    This node is called `Help-P'.  The `Previous' node, as you see, is
  122. `Help', which is the one you just came from using the `n' command.
  123. Another `n' command now would take you to the next node, `Help-^L'.
  124.    >> But do not do that yet.  First, try the `p' command, which takes
  125.  you to the `Previous' node.  When you get there, you can do an    `n'
  126. again to return here.
  127.    This all probably seems insultingly simple so far, but *do not* be
  128. led into skimming.  Things will get more complicated soon.  Also, do
  129. not try a new command until you are told it is time to.  Otherwise, you
  130. may make Info skip past an important warning that was coming up.
  131.    >> Now do an `n' to get to the node `Help-^L' and learn more.
  132. File: info.info,  Node: Help-^L,  Next: Help-M,  Prev: Help-P,  Up: Getting Started
  133. The Space, Rubout, B and ^L commands.
  134. =====================================
  135.    This node's header tells you that you are now at node `Help-^L', and
  136. that `p' would get you back to `Help-P'.  The node's title is
  137. underlined; it says what the node is about (most nodes have titles).
  138.    This is a big node and it does not all fit on your display screen.
  139. You can tell that there is more that is not visible because you can see
  140. the string `--Top-----' rather than `--All----' near the bottom right
  141. corner of the screen.
  142.    The SPC, DEL and `b' commands exist to allow you to "move around" in
  143. a node that does not all fit on the screen at once.  SPC moves forward,
  144. to show what was below the bottom of the screen.  DEL moves backward,
  145. to show what was above the top of the screen (there is not anything
  146. above the top until you have typed some spaces).
  147.    >> Now try typing a SPC (afterward, type a DEL to return here).
  148.    When you type the SPC, the two lines that were at the bottom of the
  149. screen appear at the top, followed by more lines.  DEL takes the two
  150. lines from the top and moves them to the bottom, *usually*, but if
  151. there are not a full screen's worth of lines above them they may not
  152. make it all the way to the bottom.
  153.    If you type a SPC when there is no more to see, it rings the bell
  154. and otherwise does nothing.  The same goes for a DEL when the header of
  155. the node is visible.
  156.    If your screen is ever garbaged, you can tell Info to print it out
  157. again by typing `C-l' (`Control-L', that is--hold down "Control" and
  158. type an L or `l').
  159.    >> Type `C-l' now.
  160.    To move back to the beginning of the node you are on, you can type a
  161. lot of DELs.  You can also type simply `b' for beginning.
  162.    >> Try that now.  (I have put in enough verbiage to make sure you are
  163.   not on the first screenful now).  Then come back, typing SPC
  164. several times.
  165.    You have just learned a considerable number of commands.  If you
  166. want to use one but have trouble remembering which, you should type a ?
  167. which prints out a brief list of commands.  When you are finished
  168. looking at the list, make it go away by typing a SPC.
  169.    >> Type a ? now.  After it finishes, type a SPC.
  170.    (If you are using the standalone Info reader, type `l' to return
  171. here.)
  172.    From now on, you will encounter large nodes without warning, and
  173. will be expected to know how to use SPC and DEL to move around in them
  174. without being told.  Since not all terminals have the same size screen,
  175. it would be impossible to warn you anyway.
  176.    >> Now type `n' to see the description of the `m' command.
  177. File: info.info,  Node: Help-M,  Next: Help-Adv,  Prev: Help-^L,  Up: Getting Started
  178. Menus
  179. =====
  180.    Menus and the `m' command
  181.    With only the `n' and `p' commands for moving between nodes, nodes
  182. are restricted to a linear sequence.  Menus allow a branching
  183. structure.  A menu is a list of other nodes you can move to.  It is
  184. actually just part of the text of the node formatted specially so that
  185. Info can interpret it.  The beginning of a menu is always identified by
  186. a line which starts with `* Menu:'.  A node contains a menu if and only
  187. if it has a line in it which starts that way.  The only menu you can
  188. use at any moment is the one in the node you are in.  To use a menu in
  189. any other node, you must move to that node first.
  190.    After the start of the menu, each line that starts with a `*'
  191. identifies one subtopic.  The line usually contains a brief name for
  192. the subtopic (followed by a `:'), the name of the node that talks about
  193. that subtopic, and optionally some further description of the subtopic.
  194. Lines in the menu that do not start with a `*' have no special
  195. meaning--they are only for the human reader's benefit and do not define
  196. additional subtopics.  Here is an example:
  197.      * Foo:  FOO's Node      This tells about FOO
  198.    The subtopic name is Foo, and the node describing it is `FOO's Node'.
  199. The rest of the line is just for the reader's Information.  [[ But this
  200. line is not a real menu item, simply because there is no line above it
  201. which starts with `* Menu:'.]]
  202.    When you use a menu to go to another node (in a way that will be
  203. described soon), what you specify is the subtopic name, the first thing
  204. in the menu line.  Info uses it to find the menu line, extracts the
  205. node name from it, and goes to that node.  The reason that there is
  206. both a subtopic name and a node name is that the node name must be
  207. meaningful to the computer and may therefore have to be ugly looking.
  208. The subtopic name can be chosen just to be convenient for the user to
  209. specify.  Often the node name is convenient for the user to specify and
  210. so both it and the subtopic name are the same.  There is an
  211. abbreviation for this:
  212.      * Foo::   This tells about FOO
  213. This means that the subtopic name and node name are the same; they are
  214. both `Foo'.
  215.    >> Now use SPCs to find the menu in this node, then come back to
  216. the front with a `b'.  As you see, a menu is actually visible in    its
  217. node.  If you cannot find a menu in a node by looking at it,    then
  218. the node does not have a menu and the `m' command is not    available.
  219.    The command to go to one of the subnodes is `m'--but *do not do it
  220. yet!*  Before you use `m', you must understand the difference between
  221. commands and arguments.  So far, you have learned several commands that
  222. do not need arguments.  When you type one, Info processes it and is
  223. instantly ready for another command.  The `m' command is different: it
  224. is incomplete without the "name of the subtopic".  Once you have typed
  225. `m', Info tries to read the subtopic name.
  226.    Now look for the line containing many dashes near the bottom of the
  227. screen.  There is one more line beneath that one, but usually it is
  228. blank If it is empty, Info is ready for a command, such as `n' or `b'
  229. or SPC or `m'.  If that line contains text ending in a colon, it mean
  230. Info is trying to read the "argument" to a command.  At such times,
  231. commands do not work, because Info tries to use them as the argument.
  232. You must either type the argument and finish the command you started,
  233. or type `Control-g' to cancel the command.  When you have done one of
  234. those things, the line becomes blank again.
  235.    The command to go to a subnode via a menu is `m'.  After you type
  236. the `m', the line at the bottom of the screen says `Menu item: '.  You
  237. must then type the name of the subtopic you want, and end it with a RET.
  238.    You can abbreviate the subtopic name.  If the abbreviation is not
  239. unique, the first matching subtopic is chosen.  Some menus put the
  240. shortest possible abbreviation for each subtopic name in capital
  241. letters, so you can see how much you need to type.  It does not matter
  242. whether you use upper case or lower case when you type the subtopic.
  243. You should not put any spaces at the end, or inside of the item name,
  244. except for one space where a space appears in the item in the menu.
  245.    Here is a menu to give you a chance to practice.
  246.    * Menu:       The menu starts here.
  247.    This menu givs you three ways of going to one place, Help-FOO.
  248.    * Foo:  Help-FOO.       A node you can visit for fun.
  249. * Bar:  Help-FOO.       Strange!  two ways to get to the same place.
  250. * Help-FOO::            And yet another!
  251. >>  Now type just an `m' and see what happens:
  252.    Now you are "inside" an `m' command.  Commands cannot be used now;
  253. the next thing you will type must be the name of a subtopic.
  254.    You can change your mind about doing the `m' by typing Control-g.
  255.    >> Try that now;  notice the bottom line clear.
  256.    >> Then type another `m'.
  257.    >> Now type `BAR' item name.  Do not type RET yet.
  258.    While you are typing the item name, you can use the DEL character to
  259. cancel one character at a time if you make a mistake.
  260.    >> Type one to cancel the `R'.  You could type another `R' to
  261. replace it.  You do not have to, since `BA' is a valid abbreviation.
  262.    >> Now you are ready to go.  Type a RET.
  263.    After visiting Help-FOO, you should return here.
  264.    >> Type `n' to see more commands.
  265.    Here is another way to get to  Help-FOO, a menu.  You can ignore this
  266. if you want, or else try it (but then please come back to here).
  267. * Menu:
  268. * Help-FOO::
  269. File: info.info,  Node: Help-FOO,  Up: Help-M
  270. The `u' command
  271. ---------------
  272.    Congratulations!  This is the node `Help-FOO'.  Unlike the other
  273. nodes you have seen, this one has an `Up': `Help-M', the node you just
  274. came from via the `m' command.  This is the usual convention--the nodes
  275. you reach from a menu have `Up' nodes that lead back to the menu.
  276. Menus move Down in the tree, and `Up' moves Up.  `Previous', on the
  277. other hand, is usually used to "stay on the same level but go backwards"
  278.    You can go back to the node `Help-M' by typing the command `u' for
  279. "Up".  That puts you at the *front* of the node--to get back to where
  280. you were reading you have to type some SPCs.
  281.    >> Now type `u' to move back up to `Help-M'.
  282. File: info.info,  Node: Help-Adv,  Next: Help-Q,  Prev: Help-M,  Up: Getting Started
  283. Some advanced Info commands
  284. ===========================
  285.    The course is almost over, so please stick with it to the end.
  286.    If you have been moving around to different nodes and wish to
  287. retrace your steps, the `l' command (`l' for "last") will do that, one
  288. node at a time.  If you have been following directions, an `l' command
  289. now will get you back to `Help-M'.  Another `l' command would undo the
  290. `u' and get you back to `Help-FOO'.  Another `l' would undo the `m' and
  291. get you back to `Help-M'.
  292.    >> Try typing three `l''s, pausing in between to see what each
  293. `l' does.
  294.    Then follow directions again and you will end up back here.
  295.    Note the difference between `l' and `p': `l' moves to where *you*
  296. last were, whereas `p' always moves to the node which the header says
  297. is the `Previous' node (from this node, to `Help-M').
  298.    The `d' command gets you instantly to the Directory node.  This
  299. node, which is the first one you saw when you entered Info, has a menu
  300. which leads (directly, or indirectly through other menus), to all the
  301. nodes that exist.
  302.    >> Try doing a `d', then do an `l' to return here (yes,    *do*
  303. return).
  304.    Sometimes, in Info documentation, you will see a cross reference.
  305. Cross references look like this: *Note Cross: Help-Cross.  That is a
  306. real, live cross reference which is named `Cross' and points at the
  307. node named `Help-Cross'.
  308.    If you wish to follow a cross reference, you must use the `f'
  309. command.  The `f' must be followed by the cross reference name (in this
  310. case, `Cross').  You can use DEL to edit the name, and if you change
  311. your mind about following any reference you can use `Control-g' to
  312. cancel the command.
  313.    Completion is available in the `f' command; you can complete among
  314. all the cross reference names in the current node.
  315.    >> Type `f', followed by `Cross', and a RET.
  316.    To get a list of all the cross references in the current node, you
  317. can type `?' after an `f'.  The `f' continues to await a cross
  318. reference name even after printing the list, so if you do not actually
  319. want to follow a reference you should type a `Control-g' to cancel the
  320.    >> Type "f?" to get a list of the footnotes in this node.  Then type
  321. a    `Control-g' and see how the `f' gives up.
  322.    >> Now type `n' to see the last node of the course.
  323. File: info.info,  Node: Help-Cross,  Up: Help-Adv
  324. The node reached by the cross reference in Info
  325. -----------------------------------------------
  326.    This is the node reached by the cross reference named `Cross'.
  327.    While this node is specifically intended to be reached by a cross
  328. reference, most cross references lead to nodes that "belong" someplace
  329. else far away in the structure of Info.  So you cannot expect the
  330. footnote to have a `Next', `Previous' or `Up' pointing back to where
  331. you came from.  In general, the `l' (el) command is the only way to get
  332. back there.
  333.    >> Type `l' to return to the node where the cross reference was.
  334. File: info.info,  Node: Help-Q,  Prev: Help-Adv,  Up: Getting Started
  335. Quitting Info
  336. =============
  337.    To get out of Info, back to what you were doing before, type `q' for
  338. "Quit".
  339.    This is the end of the course on using Info.  There are some other
  340. commands that are not essential or are meant for experienced users;
  341. they are useful, and you can find them by looking in the directory for
  342. documentation on Info.  Finding them will be a good exercise in using
  343. Info in the usual manner.
  344.    >> Type `d' to go to the Info directory node; then type    `mInfo'
  345. and RET, to get to the node about Info    and see what other help is
  346. available.
  347. File: info.info,  Node: Advanced Info,  Next: Create an Info File,  Prev: Getting Started,  Up: Top
  348. Info for Experts
  349. ****************
  350.    This chapter describes various advanced Info commands, and how to
  351. write an Info as distinct from a Texinfo file.  (However, in most
  352. cases, writing a Texinfo file is better, since you can use it *both* to
  353. generate an Info file and to make a printed manual.  *Note Overview of
  354. Texinfo: (texinfo)Top.)
  355. * Menu:
  356. * Expert::              Advanced Info commands: g, s, e, and 1 - 5.
  357. * Add::                 Describes how to add new nodes to the hierarchy.
  358.                           Also tells what nodes look like.
  359. * Menus::               How to add to or create menus in Info nodes.
  360. * Cross-refs::          How to add cross-references to Info nodes.
  361. * Tags::                How to make tag tables for Info files.
  362. * Checking::            Checking an Info File
  363. File: info.info,  Node: Expert,  Next: Add,  Up: Advanced Info
  364. Advanced Info Commands
  365. ======================
  366.    `g', `s', `1', - `5', and `e'
  367.    If you know a node's name, you can go there by typing `g', the name,
  368. and RET.  Thus, `gTopRET' would go to the node called `Top' in this
  369. file (its directory node).  `gExpertRET' would come back here.
  370.    Unlike `m', `g' does not allow the use of abbreviations.
  371.    To go to a node in another file, you can include the filename in the
  372. node name by putting it at the front, in parentheses.  Thus,
  373. `g(dir)TopRET' would go to the Info Directory node, which is node `Top'
  374. in the file `dir'.
  375.    The node name `*' specifies the whole file.  So you can look at all
  376. of the current file by typing `g*RET' or all of any other file with
  377. `g(FILENAME)RET'.
  378.    The `s' command allows you to search a whole file for a string.  It
  379. switches to the next node if and when that is necessary.  You type `s'
  380. followed by the string to search for, terminated by RET.  To search for
  381. the same string again, just `s' followed by RET will do.  The file's
  382. nodes are scanned in the order they are in in the file, which has no
  383. necessary relationship to the order that they may be in in the tree
  384. structure of menus and `next' pointers.  But normally the two orders
  385. are not very different.  In any case, you can always do a `b' to find
  386. out what node you have reached, if the header is not visible (this can
  387. happen, because `s' puts your cursor at the occurrence of the string,
  388. not at the beginning of the node).
  389.    If you grudge the system each character of type-in it requires, you
  390. might like to use the commands `1', `2', `3', `4', and `5'.  They are
  391. short for the `m' command together with an argument.  "1", "2", "3",
  392. "4", and "5".  `1' goes through the first item in the current node's
  393. menu; `2' goes through the second item, etc.  Note that numbers larger
  394. than 5 are not allowed.  If the item you want is that far down, you are
  395. better off using an abbreviation for its name than counting.
  396.    The Info command `e' changes from Info mode to an ordinary Emacs
  397. editing mode, so that you can edit the text of the current node.  Type
  398. `C-c C-c' to switch back to Info.  The `e' command is allowed only if
  399. the variable `Info-enable-edit' is non-`nil'.
  400. File: info.info,  Node: Add,  Next: Menus,  Prev: Expert,  Up: Advanced Info
  401. Adding a new node to Info
  402. =========================
  403.    To add a new topic to the list in the directory, you must:
  404.   1. Create a node, in some file, to document that topic.
  405.   2. Put that topic in the menu in the directory.  *Note Menu: Menus.
  406.    The new node can live in an existing documentation file, or in a new
  407. one.  It must have a ^_ character before it (invisible to the user;
  408. this node has one but you cannot see it), and it ends with either a ^_,
  409. a ^L, or the end of file.  Note: If you put in a ^L to end a new node,
  410. be sure that there is a ^_ after it to start the next one, since ^L
  411. cannot *start* a node.  Also, a nicer way to make a node boundary be a
  412. page boundary as well is to put a ^L *right after* the ^_.
  413.    The ^_ starting a node must be followed by a newline or a ^L
  414. newline, after which comes the node's header line.  The header line
  415. must give the node's name (by which Info finds it), and state the names
  416. of the `Next', `Previous', and `Up' nodes (if there are any).  As you
  417. can see, this node's `Up' node is the node `Top', which points at all
  418. the documentation for Info.  The `Next' node is `Menus'.
  419.    The keywords "Node", "Previous", "Up" and "Next", may appear in any
  420. order, anywhere in the header line, but the recommended order is the
  421. one in this sentence.  Each keyword must be followed by a colon, spaces
  422. and tabs, and then the appropriate name.  The name may be terminated
  423. with a tab, a comma, or a newline.  A space does not end it; node names
  424. may contain spaces.  The case of letters in the names is insignificant.
  425.    A node name has two forms.  A node in the current file is named by
  426. what appears after the `Node: ' in that node's first line.  For
  427. example, this node's name is `Add'.  A node in another file is named by
  428. `(FILENAME)NODE-WITHIN-FILE', as in `(info)Add' for this node.  If the
  429. file name is relative, it is taken starting from the standard Info file
  430. directory of your site.  The name `(FILENAME)Top' can be abbreviated to
  431. just `(FILENAME)'.  By convention, the name `Top' is used for the
  432. "highest" node in any single file--the node whose `Up' points out of
  433. the file.  The Directory node is `(dir)'.  The `Top' node of a document
  434. file listed in the Directory should have an `Up: (dir)' in it.
  435.    The node name `*' is special: it refers to the entire file.  Thus,
  436. `g*' shows you the whole current file.  The use of the node `*' is to
  437. make it possible to make old-fashioned, unstructured files into nodes
  438. of the tree.
  439.    The `Node:' name, in which a node states its own name, must not
  440. contain a filename, since Info when searching for a node does not
  441. expect one to be there.  The `Next', `Previous' and `Up' names may
  442. contain them.  In this node, since the `Up' node is in the same file,
  443. it was not necessary to use one.
  444.    Note that the nodes in this file have a file name in the header
  445. line.  The file names are ignored by Info, but they serve as comments
  446. to help identify the node for the user.
  447. File: info.info,  Node: Menus,  Next: Cross-refs,  Prev: Add,  Up: Advanced Info
  448. How to Create Menus
  449. ===================
  450.    Any node in the Info hierarchy may have a "menu"--a list of subnodes.
  451. The `m' command searches the current node's menu for the topic which it
  452. reads from the terminal.
  453.    A menu begins with a line starting with `* Menu:'.  The rest of the
  454. line is a comment.  After the starting line, every line that begins
  455. with a `* ' lists a single topic.  The name of the topic-the argument
  456. that the user must give to the `m' command to select this topic--comes
  457. right after the star and space, and is followed by a colon, spaces and
  458. tabs, and the name of the node which discusses that topic.  The node
  459. name, like node names following `Next', `Previous' and `Up', may be
  460. terminated with a tab, comma, or newline; it may also be terminated
  461. with a period.
  462.    If the node name and topic name are the same, than rather than
  463. giving the name twice, the abbreviation `* NAME::' may be used (and
  464. should be used, whenever possible, as it reduces the visual clutter in
  465. the menu).
  466.    It is considerate to choose the topic names so that they differ from
  467. each other very near the beginning--this allows the user to type short
  468. abbreviations.  In a long menu, it is a good idea to capitalize the
  469. beginning of each item name which is the minimum acceptable
  470. abbreviation for it (a long menu is more than 5 or so entries).
  471.    The nodes listed in a node's menu are called its "subnodes", and it
  472. is their "superior".  They should each have an `Up:' pointing at the
  473. superior.  It is often useful to arrange all or most of the subnodes in
  474. a sequence of `Next' and `Previous' pointers so that someone who wants
  475. to see them all need not keep revisiting the Menu.
  476.    The Info Directory is simply the menu of the node `(dir)Top'--that
  477. is, node `Top' in file `.../info/dir'.  You can put new entries in that
  478. menu just like any other menu.  The Info Directory is *not* the same as
  479. the file directory called `info'.  It happens that many of Info's files
  480. live on that file directory, but they do not have to; and files on that
  481. directory are not automatically listed in the Info Directory node.
  482.    Also, although the Info node graph is claimed to be a "hierarchy",
  483. in fact it can be *any* directed graph.  Shared structures and pointer
  484. cycles are perfectly possible, and can be used if they are appropriate
  485. to the meaning to be expressed.  There is no need for all the nodes in
  486. a file to form a connected structure.  In fact, this file has two
  487. connected components.  You are in one of them, which is under the node
  488. `Top'; the other contains the node `Help' which the `h' command goes
  489. to.  In fact, since there is no garbage collector, nothing terrible
  490. happens if a substructure is not pointed to, but such a substructure is
  491. rather useless since nobody can ever find out that it exists.
  492. File: info.info,  Node: Cross-refs,  Next: Tags,  Prev: Menus,  Up: Advanced Info
  493. Creating Cross References
  494. =========================
  495.    A cross reference can be placed anywhere in the text, unlike a menu
  496. item which must go at the front of a line.  A cross reference looks
  497. like a menu item except that it has `*note' instead of `*'.  It
  498. *cannot* be terminated by a `)', because `)''s are so often part of
  499. node names.  If you wish to enclose a cross reference in parentheses,
  500. terminate it with a period first.  Here are two examples of cross
  501. references pointers:
  502.      *Note details: commands.  (See *note 3: Full Proof.)
  503.    They are just examples.  The places they "lead to" do not really
  504. exist!
  505. File: info.info,  Node: Tags,  Next: Checking,  Prev: Cross-refs,  Up: Advanced Info
  506. Tag Tables for Info Files
  507. =========================
  508.    You can speed up the access to nodes of a large Info file by giving
  509. it a tag table.  Unlike the tag table for a program, the tag table for
  510. an Info file lives inside the file itself and is used automatically
  511. whenever Info reads in the file.
  512.    To make a tag table, go to a node in the file using Emacs Info mode
  513. and type `M-x Info-tagify'.  Then you must use `C-x C-s' to save the
  514. file.
  515.    Once the Info file has a tag table, you must make certain it is up
  516. to date.  If, as a result of deletion of text, any node moves back more
  517. than a thousand characters in the file from the position recorded in
  518. the tag table, Info will no longer be able to find that node.  To
  519. update the tag table, use the `Info-tagify' command again.
  520.    An Info file tag table appears at the end of the file and looks like
  521. this:
  522.      ^_
  523.      Tag Table:
  524.      File: info, Node: Cross-refs^?21419
  525.      File: info,  Node: Tags^?22145
  526.      ^_
  527.      End Tag Table
  528. Note that it contains one line per node, and this line contains the
  529. beginning of the node's header (ending just after the node name), a DEL
  530. character, and the character position in the file of the beginning of
  531. the node.
  532. File: info.info,  Node: Checking,  Prev: Tags,  Up: Advanced Info
  533. Checking an Info File
  534. =====================
  535.    When creating an Info file, it is easy to forget the name of a node
  536. when you are making a pointer to it from another node.  If you put in
  537. the wrong name for a node, this is not detected until someone tries to
  538. go through the pointer using Info.  Verification of the Info file is an
  539. automatic process which checks all pointers to nodes and reports any
  540. pointers which are invalid.  Every `Next', `Previous', and `Up' is
  541. checked, as is every menu item and every cross reference.  In addition,
  542. any `Next' which does not have a `Previous' pointing back is reported.
  543. Only pointers within the file are checked, because checking pointers to
  544. other files would be terribly slow.  But those are usually few.
  545.    To check an Info file, do `M-x Info-validate' while looking at any
  546. node of the file with Emacs Info mode.
  547. File: info.info,  Node: Create an Info File,  Prev: Advanced Info,  Up: Top
  548. Creating an Info File from a Makeinfo file
  549. ******************************************
  550.    `makeinfo' is a utility that converts a Texinfo file into an Info
  551. file; `texinfo-format-region' and `texinfo-format-buffer' are GNU Emacs
  552. functions that do the same.
  553.    *Note Creating an Info File: (texinfo)Create an Info File, to learn
  554. how to create an Info file from a Texinfo file.
  555.    *Note Overview of Texinfo: (texinfo)Top, to learn how to write a
  556. Texinfo file.
  557. Tag Table:
  558. Node: Top
  559. Node: Getting Started
  560. Node: Help-Small-Screen
  561. Node: Help
  562. Node: Help-P
  563. Node: Help-^L
  564. Node: Help-M
  565. Node: Help-FOO
  566. 14030
  567. Node: Help-Adv
  568. 14766
  569. Node: Help-Cross
  570. 17148
  571. Node: Help-Q
  572. 17794
  573. Node: Advanced Info
  574. 18434
  575. Node: Expert
  576. 19330
  577. Node: Add
  578. 21601
  579. Node: Menus
  580. 24635
  581. Node: Cross-refs
  582. 27509
  583. Node: Tags
  584. 28211
  585. Node: Checking
  586. 29510
  587. Node: Create an Info File
  588. 30434
  589. End Tag Table
  590.