contrib/texinfo/doc/makeinfo.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
   2 .TH MAKEINFO "1" "September 2008" "makeinfo 4.13" "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\-\-document\-language\fR=\fISTR\fR locale to use in translating Texinfo keywords
  17 for the output document (default C).
  18 .TP
  19 \fB\-\-force\fR
  20 preserve output even if errors.
  21 .TP
  22 \fB\-\-help\fR
  23 display this help and exit.
  24 .TP
  25 \fB\-\-no\-validate\fR
  26 suppress node cross\-reference validation.
  27 .TP
  28 \fB\-\-no\-warn\fR
  29 suppress warnings (but not errors).
  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=\fIFILE\fR
  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 the 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 (or directory if split HTML).
  70 .SS "Options for Info and plain text:"
  71 .TP
  72 \fB\-\-disable\-encoding\fR
  73 do not output accented and special characters
  74 in Info output based on @documentencoding.
  75 .TP
  76 \fB\-\-enable\-encoding\fR
  77 override \fB\-\-disable\-encoding\fR (default).
  78 .TP
  79 \fB\-\-fill\-column\fR=\fINUM\fR
  80 break Info lines at NUM characters (default 72).
  81 .TP
  82 \fB\-\-footnote\-style\fR=\fISTYLE\fR
  83 output footnotes in Info according to STYLE:
  84 `separate' to put them in their own node;
  85 `end' to put them at the end of the node, in
  86 which they are defined (this is the default).
  87 .TP
  88 \fB\-\-paragraph\-indent\fR=\fIVAL\fR
  89 indent Info paragraphs by VAL spaces (default 3).
  90 If VAL is `none', do not indent; if VAL is
  91 `asis', preserve existing indentation.
  92 .TP
  93 \fB\-\-split\-size\fR=\fINUM\fR
  94 split Info files at size NUM (default 300000).
  95 .SS "Options for HTML:"
  96 .TP
  97 \fB\-\-css\-include\fR=\fIFILE\fR
  98 include FILE in HTML <style> output;
  99 read stdin if FILE is \-.
 100 .TP
 101 \fB\-\-css\-ref\fR=\fIURL\fR
 102 generate reference to a CSS file.
 103 .TP
 104 \fB\-\-internal\-links\fR=\fIFILE\fR
 105 produce list of internal links in FILE.
 106 .TP
 107 \fB\-\-transliterate\-file\-names\fR
 108 produce file names in ASCII transliteration.
 109 .SS "Options for XML and Docbook:"
 110 .TP
 111 \fB\-\-output\-indent\fR=\fIVAL\fR
 112 indent XML elements by VAL spaces (default 2).
 113 If VAL is 0, ignorable whitespace is dropped.
 114 .SS "Input file options:"
 115 .TP
 116 \fB\-\-commands\-in\-node\-names\fR
 117 allow @ commands in node names.
 118 .TP
 119 \fB\-D\fR VAR
 120 define the variable VAR, as with @set.
 121 .TP
 122 \fB\-I\fR DIR
 123 append DIR to the @include search path.
 124 .TP
 125 \fB\-P\fR DIR
 126 prepend DIR to the @include search path.
 127 .TP
 128 \fB\-U\fR VAR
 129 undefine the variable VAR, as with @clear.
 130 .SS "Conditional processing in input:"
 131 .TP
 132 \fB\-\-ifdocbook\fR
 133 process @ifdocbook and @docbook even if
 134 not generating Docbook.
 135 .TP
 136 \fB\-\-ifhtml\fR
 137 process @ifhtml and @html even if not generating HTML.
 138 .TP
 139 \fB\-\-ifinfo\fR
 140 process @ifinfo even if not generating Info.
 141 .TP
 142 \fB\-\-ifplaintext\fR
 143 process @ifplaintext even if not generating plain text.
 144 .TP
 145 \fB\-\-iftex\fR
 146 process @iftex and @tex; implies \fB\-\-no\-split\fR.
 147 .TP
 148 \fB\-\-ifxml\fR
 149 process @ifxml and @xml.
 150 .TP
 151 \fB\-\-no\-ifdocbook\fR
 152 do not process @ifdocbook and @docbook text.
 153 .TP
 154 \fB\-\-no\-ifhtml\fR
 155 do not process @ifhtml and @html text.
 156 .TP
 157 \fB\-\-no\-ifinfo\fR
 158 do not process @ifinfo text.
 159 .TP
 160 \fB\-\-no\-ifplaintext\fR
 161 do not process @ifplaintext text.
 162 .TP
 163 \fB\-\-no\-iftex\fR
 164 do not process @iftex and @tex text.
 165 .TP
 166 \fB\-\-no\-ifxml\fR
 167 do not process @ifxml and @xml text.
 168 .P
 169 Also, for the \fB\-\-no\-ifFORMAT\fR options, do process @ifnotFORMAT text.
 170 .P
 171 The defaults for the @if... conditionals depend on the output format:
 172 if generating HTML, \fB\-\-ifhtml\fR is on and the others are off;
 173 if generating Info, \fB\-\-ifinfo\fR is on and the others are off;
 174 if generating plain text, \fB\-\-ifplaintext\fR is on and the others are off;
 175 if generating XML, \fB\-\-ifxml\fR is on and the others are off.
 176 .SH EXAMPLES
 177 .TP
 178 makeinfo foo.texi
 179 write Info to foo's @setfilename
 180 .TP
 181 makeinfo \fB\-\-html\fR foo.texi
 182 write HTML to @setfilename
 183 .TP
 184 makeinfo \fB\-\-xml\fR foo.texi
 185 write Texinfo XML to @setfilename
 186 .TP
 187 makeinfo \fB\-\-docbook\fR foo.texi
 188 write DocBook XML to @setfilename
 189 .TP
 190 makeinfo \fB\-\-no\-headers\fR foo.texi
 191 write plain text to standard output
 192 .TP
 193 makeinfo \fB\-\-html\fR \fB\-\-no\-headers\fR foo.texi
 194 write html without node lines, menus
 195 .TP
 196 makeinfo \fB\-\-number\-sections\fR foo.texi
 197 write Info with numbered sections
 198 .TP
 199 makeinfo \fB\-\-no\-split\fR foo.texi
 200 write one Info file however big
 201 .SH "REPORTING BUGS"
 202 Email bug reports to bug\-texinfo@gnu.org,
 203 general questions and discussion to help\-texinfo@gnu.org.
 204 Texinfo home page: http://www.gnu.org/software/texinfo/
 205 .SH COPYRIGHT
 206 Copyright \(co 2008 Free Software Foundation, Inc.
 207 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
 208 .br
 209 This is free software: you are free to change and redistribute it.
 210 There is NO WARRANTY, to the extent permitted by law.
 211 .SH "SEE ALSO"
 212 The full documentation for
 213 .B makeinfo
 214 is maintained as a Texinfo manual.  If the
 215 .B info
 216 and
 217 .B makeinfo
 218 programs are properly installed at your site, the command
 219 .IP
 220 .B info makeinfo
 221 .PP
 222 should give you access to the complete manual.