home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 6 / FreshFish_September1994.bin / gnu / info / makeinfo.info (.txt) < prev    next >
GNU Info File  |  1994-09-02  |  8KB  |  165 lines
  1. This is Info file makeinfo.info, produced by Makeinfo-1.55 from the
  2. input file makeinfo.texi.
  3. This file is an extract from the `Texinfo' manual.
  4. It documents `makeinfo', a program that converts Texinfo files into
  5. Info files.
  6. Copyright (C) 1992, 1993 Free Software Foundation, Inc.
  7. Permission is granted to make and distribute verbatim copies of this
  8. manual provided the copyright notice and this permission notice are
  9. preserved on all copies.
  10. Permission is granted to copy and distribute modified versions of this
  11. manual under the conditions for verbatim copying, provided that the
  12. entire resulting derived work is distributed under the terms of a
  13. permission notice identical to this one.
  14. Permission is granted to copy and distribute translations of this manual
  15. into another language, under the above conditions for modified versions,
  16. except that this permission notice may be stated in a translation
  17. approved by the Free Software Foundation.
  18. File: makeinfo.info,  Node: Top,  Next: What is makeinfo,  Prev: (dir),  Up: (dir)
  19. `makeinfo'
  20. **********
  21. This file documents the use of the `makeinfo' program, versions 1.51
  22. and later.  It is an extract from the `Texinfo' manual.
  23. * Menu:
  24. * What is makeinfo::
  25. File: makeinfo.info,  Node: What is makeinfo,  Prev: Top,  Up: Top
  26. What is `makeinfo'?
  27. *******************
  28. `makeinfo' is a program for converting "Texinfo" files into "Info"
  29. files.  Texinfo is a documentation system that uses a single source
  30. file to produce both on-line information and printed output.
  31. You can read the on-line information using Info; type `info' to learn
  32. about Info.  *Note Texinfo: (texinfo.texi)Top, to learn about the
  33. Texinfo documentation system.
  34. * Menu:
  35. * Formatting Control::
  36. * Options::
  37. * Pointer Validation::
  38. File: makeinfo.info,  Node: Formatting Control,  Next: Options,  Up: What is makeinfo
  39. Controlling Paragraph Formats
  40. =============================
  41. In general, `makeinfo' "fills" the paragraphs that it outputs to an
  42. Info file.  Filling is the process of breaking and connecting lines so
  43. that lines are the same length as or shorter than the number specified
  44. as the fill column.  Lines are broken between words.  With `makeinfo',
  45. you can control:
  46.    * The width of each paragraph (the "fill-column").
  47.    * The amount of indentation that the first line of each paragraph
  48.      receives (the "paragraph-indentation").
  49. File: makeinfo.info,  Node: Options,  Next: Pointer Validation,  Prev: Formatting Control,  Up: What is makeinfo
  50. Command Line Options
  51. ====================
  52. The following command line options are available for `makeinfo'.
  53. `-D VAR'
  54.      Cause VAR to be defined.  This is equivalent to `@set VAR' in the
  55.      Texinfo file.
  56. `--error-limit LIMIT'
  57.      Set the maximum number of errors that `makeinfo' will report
  58.      before exiting (on the assumption that continuing would be
  59.      useless).  The default number of errors that can be reported before
  60.      `makeinfo' gives up is 100.
  61. `--fill-column WIDTH'
  62.      Specify the maximum number of columns in a line; this is the
  63.      right-hand edge of a line.  Paragraphs that are filled will be
  64.      filled to this width.  The default value for `fill-column' is 72.
  65. `--footnote-style STYLE'
  66.      Set the footnote style to STYLE, either `end' for the end node
  67.      style or `separate' for the separate node style.  The value set by
  68.      this option overrides the value set in a Texinfo file by an
  69.      `@footnotestyle' command.  When the footnote style is `separate',
  70.      `makeinfo' makes a new node containing the footnotes found in the
  71.      current node.  When the footnote style is `end', `makeinfo' places
  72.      the footnote references at the end of the current node.
  73. `-I DIR'
  74.      Add `dir' to the directory search list for finding files that are
  75.      included using the `@include' command.  By default, `makeinfo'
  76.      searches only the current directory.
  77. `--no-headers'
  78.      Do not include menus or node lines in the output.  This results in
  79.      an ASCII file that you cannot read in Info since it does not
  80.      contain the requisite nodes or menus; but you can print such a
  81.      file in a single, typewriter-like font and produce acceptable
  82.      output.
  83. `--no-split'
  84.      Suppress the splitting stage of `makeinfo'.  Normally, large
  85.      output files (where the size is greater than 70k bytes) are split
  86.      into smaller subfiles, each one approximately 50k bytes.  If you
  87.      specify `--no-split', `makeinfo' will not split up the output file.
  88. `--no-pointer-validate'
  89. `--no-validate'
  90.      Suppress the pointer-validation phase of `makeinfo'.  Normally,
  91.      after a Texinfo file is processed, some consistency checks are
  92.      made to ensure that cross references can be resolved, etc.  *Note
  93.      Pointer Validation::.
  94. `--no-warn'
  95.      Suppress the output of warning messages.  This does *not* suppress
  96.      the output of error messages, only warnings.  You might want this
  97.      if the file you are creating has examples of Texinfo cross
  98.      references within it, and the nodes that are referenced do not
  99.      actually exist.
  100. `--no-number-footnotes'
  101.      Supress automatic footnote numbering.  By default, `makeinfo'
  102.      numbers each footnote sequentially in a single node, resetting the
  103.      current footnote number to 1 at the start of each node.
  104. `--output FILE'
  105. `-o FILE'
  106.      Specify that the output should be directed to FILE and not to the
  107.      file name specified in the `@setfilename' command found in the
  108.      Texinfo source.  FILE can be the special token `-', which specifies
  109.      standard output.
  110. `--paragraph-indent INDENT'
  111.      Set the paragraph indentation style to INDENT.  The value set by
  112.      this option overrides the value set in a Texinfo file by an
  113.      `@paragraphindent' command.  The value of INDENT is interpreted as
  114.      follows:
  115.         * If the value of INDENT is `asis', do not change the existing
  116.           indentation at the starts of paragraphs.
  117.         * If the value of INDENT is zero, delete any existing
  118.           indentation.
  119.         * If the value of INDENT is greater than zero, indent each
  120.           paragraph by that number of spaces.
  121. `--reference-limit LIMIT'
  122.      Set the value of the number of references to a node that
  123.      `makeinfo' will make without reporting a warning.  If a node has
  124.      more than this number of references in it, `makeinfo' will make the
  125.      references but also report a warning.
  126. `-U VAR'
  127.      Cause VAR to be undefined.  This is equivalent to `@clear VAR' in
  128.      the Texinfo file.
  129. `--verbose'
  130.      Cause `makeinfo' to display messages saying what it is doing.
  131.      Normally, `makeinfo' only outputs messages if there are errors or
  132.      warnings.
  133. `--version'
  134.      Report the version number of this copy of `makeinfo'.
  135. File: makeinfo.info,  Node: Pointer Validation,  Prev: Options,  Up: What is makeinfo
  136. Pointer Validation
  137. ==================
  138. If you do not suppress pointer-validation (by using the
  139. `--no-pointer-validation' option), `makeinfo' will check the validity
  140. of the final Info file.  Mostly, this means ensuring that nodes you
  141. have referenced really exist.  Here is a complete list of what is
  142. checked:
  143.   1. If a `Next', `Previous', or `Up' node reference is a reference to a
  144.      node in the current file and is not an external reference such as
  145.      to `(dir)', then the referenced node must exist.
  146.   2. In every node, if the `Previous' node is different from the `Up'
  147.      node, then the `Previous' node must also be pointed to by a `Next'
  148.      node.
  149.   3. Every node except the `Top' node must have an `Up' pointer.
  150.   4. The node referenced by an `Up' pointer must contain a reference to
  151.      the current node in some manner other than through a `Next'
  152.      reference.  This includes menu entries and cross references.
  153.   5. If the `Next' reference of a node is not the same as the `Next'
  154.      reference of the `Up' reference, then the node referenced by the
  155.      `Next' pointer must have a `Previous' pointer that points back to
  156.      the current node.  This rule allows the last node in a section to
  157.      point to the first node of the next chapter.
  158. Tag Table:
  159. Node: Top
  160. Node: What is makeinfo
  161. Node: Formatting Control
  162. Node: Options
  163. Node: Pointer Validation
  164. End Tag Table
  165.