contrib/texinfo/doc/makeinfo.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.24.
   2 .TH MAKEINFO "1" "April 2002" "GNU texinfo 4.2" FSF
   3 .SH NAME
   4 makeinfo \- translate Texinfo documents
   5 .SH SYNOPSIS
   6 .B makeinfo
   7 [\fIOPTION\fR]... \fITEXINFO-FILE\fR...
   8 .SH DESCRIPTION
   9 Translate Texinfo source documentation to various other formats, by default
  10 Info files suitable for reading online with Emacs or standalone GNU Info.
  11 .SS "General options:"
  12 .TP
  13 \fB\-\-error\-limit\fR=\fINUM\fR
  14 quit after NUM errors (default 100).
  15 .TP
  16 \fB\-\-force\fR
  17 preserve output even if errors.
  18 .TP
  19 \fB\-\-help\fR
  20 display this help and exit.
  21 .TP
  22 \fB\-\-no\-validate\fR
  23 suppress node cross-reference validation.
  24 .TP
  25 \fB\-\-no\-warn\fR
  26 suppress warnings (but not errors).
  27 .TP
  28 \fB\-\-reference\-limit\fR=\fINUM\fR
  29 warn about at most NUM references (default 1000).
  30 .TP
  31 \fB\-v\fR, \fB\-\-verbose\fR
  32 explain what is being done.
  33 .TP
  34 \fB\-\-version\fR
  35 display version information and exit.
  36 .SS "Output format selection (default is to produce Info):"
  37 .TP
  38 \fB\-\-docbook\fR
  39 output DocBook rather than Info.
  40 .TP
  41 \fB\-\-html\fR
  42 output HTML rather than Info.
  43 .TP
  44 \fB\-\-xml\fR
  45 output XML (TexinfoML) rather than Info.
  46 .SS "General output options:"
  47 .TP
  48 \fB\-E\fR, \fB\-\-macro\-expand\fR FILE
  49 output macro-expanded source to FILE.
  50 ignoring any @setfilename.
  51 .TP
  52 \fB\-\-no\-headers\fR
  53 suppress node separators, Node: lines, and menus
  54 from Info output (thus producing plain text)
  55 or from HTML (thus producing shorter output);
  56 also, write to standard output by default.
  57 .TP
  58 \fB\-\-no\-split\fR
  59 suppress splitting of Info or HTML output,
  60 generate only one output file.
  61 .TP
  62 \fB\-\-number\-sections\fR
  63 output chapter and sectioning numbers.
  64 .TP
  65 \fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
  66 output to FILE (directory if split HTML),
  67 .SS "Options for Info and plain text:"
  68 .TP
  69 \fB\-\-enable\-encoding\fR
  70 output accented and special characters in
  71 Info output based on @documentencoding.
  72 .TP
  73 \fB\-\-fill\-column\fR=\fINUM\fR
  74 break Info lines at NUM characters (default 72).
  75 .TP
  76 \fB\-\-footnote\-style\fR=\fISTYLE\fR
  77 output footnotes in Info according to STYLE:
  78 `separate' to put them in their own node;
  79 `end' to put them at the end of the node
  80 .IP
  81 in which they are defined (default).
  82 .TP
  83 \fB\-\-paragraph\-indent\fR=\fIVAL\fR
  84 indent Info paragraphs by VAL spaces (default 3).
  85 If VAL is `none', do not indent; if VAL is
  86 `asis', preserve existing indentation.
  87 .TP
  88 \fB\-\-split\-size\fR=\fINUM\fR
  89 split Info files at size NUM (default 50000).
  90 .SS "Input file options:"
  91 .TP
  92 \fB\-\-commands\-in\-node\-names\fR
  93 allow @ commands in node names.
  94 .TP
  95 \fB\-D\fR VAR
  96 define the variable VAR, as with @set.
  97 .TP
  98 \fB\-I\fR DIR
  99 append DIR to the @include search path.
 100 .TP
 101 \fB\-P\fR DIR
 102 prepend DIR to the @include search path.
 103 .TP
 104 \fB\-U\fR VAR
 105 undefine the variable VAR, as with @clear.
 106 .SS "Conditional processing in input:"
 107 .TP
 108 \fB\-\-ifhtml\fR
 109 process @ifhtml and @html even if not generating HTML.
 110 .TP
 111 \fB\-\-ifinfo\fR
 112 process @ifinfo even if not generating Info.
 113 .TP
 114 \fB\-\-ifplaintext\fR
 115 process @ifplaintext even if not generating plain text.
 116 .TP
 117 \fB\-\-iftex\fR
 118 process @iftex and @tex; implies \fB\-\-no\-split\fR.
 119 .TP
 120 \fB\-\-no\-ifhtml\fR
 121 do not process @ifhtml and @html text.
 122 .TP
 123 \fB\-\-no\-ifinfo\fR
 124 do not process @ifinfo text.
 125 .TP
 126 \fB\-\-no\-ifplaintext\fR
 127 do not process @ifplaintext text.
 128 .TP
 129 \fB\-\-no\-iftex\fR
 130 do not process @iftex and @tex text.
 131 .IP
 132 The defaults for the @if... conditionals depend on the output format:
 133 if generating HTML, \fB\-\-ifhtml\fR is on and the others are off;
 134 if generating Info, \fB\-\-ifinfo\fR is on and the others are off;
 135 if generating plain text, \fB\-\-ifplaintext\fR is on and the others are off;
 136 .SH EXAMPLES
 137 .TP
 138 makeinfo foo.texi
 139 write Info to foo's @setfilename
 140 .TP
 141 makeinfo \fB\-\-html\fR foo.texi
 142 write HTML to @setfilename
 143 .TP
 144 makeinfo \fB\-\-xml\fR foo.texi
 145 write XML to @setfilename
 146 .TP
 147 makeinfo \fB\-\-docbook\fR foo.texi
 148 write DocBook XML to @setfilename
 149 .TP
 150 makeinfo \fB\-\-no\-headers\fR foo.texi
 151 write plain text to standard output
 152 .IP
 153 makeinfo \fB\-\-html\fR \fB\-\-no\-headers\fR foo.texi write html without node lines, menus
 154 makeinfo \fB\-\-number\-sections\fR foo.texi   write Info with numbered sections
 155 makeinfo \fB\-\-no\-split\fR foo.texi          write one Info file however big
 156 .SH "REPORTING BUGS"
 157 Email bug reports to bug-texinfo@gnu.org,
 158 general questions and discussion to help-texinfo@gnu.org.
 159 Texinfo home page: http://www.gnu.org/software/texinfo/
 160 .SH COPYRIGHT
 161 Copyright \(co 2002 Free Software Foundation, Inc.
 162 There is NO warranty.  You may redistribute this software
 163 under the terms of the GNU General Public License.
 164 For more information about these matters, see the files named COPYING.
 165 .SH "SEE ALSO"
 166 The full documentation for
 167 .B makeinfo
 168 is maintained as a Texinfo manual.  If the
 169 .B info
 170 and
 171 .B makeinfo
 172 programs are properly installed at your site, the command
 173 .IP
 174 .B info makeinfo
 175 .PP
 176 should give you access to the complete manual.