contrib/texinfo/doc/makeinfo.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.34.
   2 .TH MAKEINFO "1" "December 2004" "makeinfo 4.8" "User Commands"
   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 XML rather than Info.
  40 .TP
  41 \fB\-\-html\fR
  42 output HTML rather than Info.
  43 .TP
  44 \fB\-\-xml\fR
  45 output Texinfo XML rather than Info.
  46 .TP
  47 \fB\-\-plaintext\fR
  48 output plain text rather than Info.
  49 .SS "General output options:"
  50 .TP
  51 \fB\-E\fR, \fB\-\-macro\-expand\fR FILE
  52 output macro\-expanded source to FILE.
  53 ignoring any @setfilename.
  54 .TP
  55 \fB\-\-no\-headers\fR
  56 suppress node separators, Node: lines, and menus
  57 from Info output (thus producing plain text)
  58 or from HTML (thus producing shorter output);
  59 also, write to standard output by default.
  60 .TP
  61 \fB\-\-no\-split\fR
  62 suppress splitting of Info or HTML output,
  63 generate only one output file.
  64 .TP
  65 \fB\-\-number\-sections\fR
  66 output chapter and sectioning numbers.
  67 .TP
  68 \fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
  69 output to FILE (directory if split HTML),
  70 .SS "Options for Info and plain text:"
  71 .TP
  72 \fB\-\-enable\-encoding\fR
  73 output accented and special characters in
  74 Info output based on @documentencoding.
  75 .TP
  76 \fB\-\-fill\-column\fR=\fINUM\fR
  77 break Info lines at NUM characters (default 72).
  78 .TP
  79 \fB\-\-footnote\-style\fR=\fISTYLE\fR
  80 output footnotes in Info according to STYLE:
  81 `separate' to put them in their own node;
  82 `end' to put them at the end of the node
  83 .IP
  84 in which they are defined (default).
  85 .TP
  86 \fB\-\-paragraph\-indent\fR=\fIVAL\fR
  87 indent Info paragraphs by VAL spaces (default 3).
  88 If VAL is `none', do not indent; if VAL is
  89 `asis', preserve existing indentation.
  90 .TP
  91 \fB\-\-split\-size\fR=\fINUM\fR
  92 split Info files at size NUM (default 300000).
  93 .SS "Options for HTML:"
  94 .TP
  95 \fB\-\-css\-include\fR=\fIFILE\fR
  96 include FILE in HTML <style> output;
  97 read stdin if FILE is \-.
  98 .SS "Options for XML and Docbook:"
  99 .TP
 100 \fB\-\-output\-indent\fR=\fIVAL\fR
 101 indent XML elements by VAL spaces (default 2).
 102 If VAL is 0, ignorable whitespace is dropped.
 103 .SS "Input file options:"
 104 .TP
 105 \fB\-\-commands\-in\-node\-names\fR
 106 allow @ commands in node names.
 107 .TP
 108 \fB\-D\fR VAR
 109 define the variable VAR, as with @set.
 110 .TP
 111 \fB\-I\fR DIR
 112 append DIR to the @include search path.
 113 .TP
 114 \fB\-P\fR DIR
 115 prepend DIR to the @include search path.
 116 .TP
 117 \fB\-U\fR VAR
 118 undefine the variable VAR, as with @clear.
 119 .SS "Conditional processing in input:"
 120 .TP
 121 \fB\-\-ifdocbook\fR
 122 process @ifdocbook and @docbook even if
 123 not generating Docbook.
 124 .TP
 125 \fB\-\-ifhtml\fR
 126 process @ifhtml and @html even if not generating HTML.
 127 .TP
 128 \fB\-\-ifinfo\fR
 129 process @ifinfo even if not generating Info.
 130 .TP
 131 \fB\-\-ifplaintext\fR
 132 process @ifplaintext even if not generating plain text.
 133 .TP
 134 \fB\-\-iftex\fR
 135 process @iftex and @tex; implies \fB\-\-no\-split\fR.
 136 .TP
 137 \fB\-\-ifxml\fR
 138 process @ifxml and @xml.
 139 .TP
 140 \fB\-\-no\-ifdocbook\fR
 141 do not process @ifdocbook and @docbook text.
 142 .TP
 143 \fB\-\-no\-ifhtml\fR
 144 do not process @ifhtml and @html text.
 145 .TP
 146 \fB\-\-no\-ifinfo\fR
 147 do not process @ifinfo text.
 148 .TP
 149 \fB\-\-no\-ifplaintext\fR
 150 do not process @ifplaintext text.
 151 .TP
 152 \fB\-\-no\-iftex\fR
 153 do not process @iftex and @tex text.
 154 .TP
 155 \fB\-\-no\-ifxml\fR
 156 do not process @ifxml and @xml text.
 157 .IP
 158 Also, for the \fB\-\-no\-ifFORMAT\fR options, do process @ifnotFORMAT text.
 159 .IP
 160 The defaults for the @if... conditionals depend on the output format:
 161 if generating HTML, \fB\-\-ifhtml\fR is on and the others are off;
 162 if generating Info, \fB\-\-ifinfo\fR is on and the others are off;
 163 if generating plain text, \fB\-\-ifplaintext\fR is on and the others are off;
 164 if generating XML, \fB\-\-ifxml\fR is on and the others are off.
 165 .SH EXAMPLES
 166 .TP
 167 makeinfo foo.texi
 168 write Info to foo's @setfilename
 169 .TP
 170 makeinfo \fB\-\-html\fR foo.texi
 171 write HTML to @setfilename
 172 .TP
 173 makeinfo \fB\-\-xml\fR foo.texi
 174 write Texinfo XML to @setfilename
 175 .TP
 176 makeinfo \fB\-\-docbook\fR foo.texi
 177 write DocBook XML to @setfilename
 178 .TP
 179 makeinfo \fB\-\-no\-headers\fR foo.texi
 180 write plain text to standard output
 181 .IP
 182 makeinfo \fB\-\-html\fR \fB\-\-no\-headers\fR foo.texi write html without node lines, menus
 183 makeinfo \fB\-\-number\-sections\fR foo.texi   write Info with numbered sections
 184 makeinfo \fB\-\-no\-split\fR foo.texi          write one Info file however big
 185 .SH "REPORTING BUGS"
 186 Email bug reports to bug\-texinfo@gnu.org,
 187 general questions and discussion to help\-texinfo@gnu.org.
 188 Texinfo home page: http://www.gnu.org/software/texinfo/
 189 .SH COPYRIGHT
 190 Copyright \(co 2004 Free Software Foundation, Inc.
 191 There is NO warranty.  You may redistribute this software
 192 under the terms of the GNU General Public License.
 193 For more information about these matters, see the files named COPYING.
 194 .SH "SEE ALSO"
 195 The full documentation for
 196 .B makeinfo
 197 is maintained as a Texinfo manual.  If the
 198 .B info
 199 and
 200 .B makeinfo
 201 programs are properly installed at your site, the command
 202 .IP
 203 .B info makeinfo
 204 .PP
 205 should give you access to the complete manual.