home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / gnu / txnf214b / makeinfo.man < prev    next >
Encoding:
Text File  |  1993-07-29  |  3.2 KB  |  94 lines
  1.  
  2.  
  3.  
  4. MAKEINFO(1)         ST Programmer's Manual           MAKEINFO(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      makeinfo - format texinfo files into files suitable for
  10.      reading with GNU info.
  11.  
  12. SYNOPSIS
  13.      makeinfo [ +no-validate ] [ +no-warn ] [ +no-split ]
  14.      [+only-split ] [ +no-headers ] [ +verbose ] [ +version ]
  15.      [+paragraph-indent <val> ] [ +fill-column <val> ]
  16.      [ +error-limit <val> ] [ +reference-limit <val> ]
  17.      [ +footnote-style <val> ]
  18.      [ -o <name> ] [ -f <val> ] [ -p <val> ] [ -e <val> ]
  19.      [ -s <val> ] [ -f <val> ] [ -l ] [ -V ] file ...
  20.  
  21. DESCRIPTION
  22.      Makefinfo reads texinfo file file and creates an output file
  23.      suitable for reading with GNU info.  Default name for output
  24.      is created from a basename by appending `.info' to it.  When
  25.      output file is big enough and +no-split option was not
  26.      specified then output is divided in smaller chunks and addi-
  27.      tional names will have suffixes like `.info-1', `.info-2'
  28.      and so on.  For systems where such long suffixes are not
  29.      supported `info' string is dropped and extra suffixes are
  30.      created as `.-1', `.-2', ..., and so on.
  31.  
  32. OPTIONS
  33.      Some options may have both long and short forms.  Here is a
  34.      summary.
  35.  
  36.      +no-validate
  37.           suppres node cross reference validation.
  38.  
  39.      +no-warn
  40.           do not show warning messages (errors are still output).
  41.  
  42.      +no-split
  43.           do not split resulting info file
  44.  
  45.      +only-split,  -l
  46.           skip formatting and only split already formatted info
  47.           file.  Input file has to have tags table in it.
  48.  
  49.      +no-headers
  50.           do not write node headers, like `Node: Foo' to output
  51.           file.
  52.  
  53.      +verbose
  54.           be slightly more informative what you are doing
  55.  
  56.      +version,  -V
  57.           print the version number of makeinfo
  58.  
  59.      +paragraph-indent <val>,  -p <val>
  60.           set paragraph indent to <val>.  Accepted values are
  61.           `none', `asis' or a number of spaces to indent.  Nega-
  62.           tive values are treated as zero.  Default paragraph
  63.           indent is 3 spaces.
  64.  
  65.      +fill-column <val>, -f <val>
  66.           set fill column to <val>. Default column is 72.
  67.  
  68.      +error-limit <val>, -e <val>
  69.           stop processing when <val> errors is reached.  Default
  70.           is 100.
  71.  
  72.      +reference-limit <val>, -r <val>
  73.           warn when some node was referenced too many times.
  74.           Default is 1000.
  75.  
  76.      +footnote-style <style>, -s <style>
  77.           set style either to `separate' where footnotes are
  78.           placed in their own node or to `end' (default) where
  79.           footnotes are output at the bottom of a node in which
  80.           they were defined.
  81.  
  82. SEE ALSO
  83.      info(l), texindex(l)
  84.  
  85. BUGS
  86.      All processing is done in memory so makeinfo may fail with
  87.      bigger files when memory is limited.  If you got a failure
  88.      after the first stage  you still can use +only-split option
  89.      to split info file in a separate step.  This can be a pre-
  90.      ferred course of action when a disk space may be not ample
  91.      enough.  During an execution of both stages together make-
  92.      info needs an extra disk space of roughly double size of an
  93.      original input.
  94.