| 1 |
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1. |
| 2 |
.TH TEXI2ANY "1" "September 2024" "GNU texinfo 7.1.1" "User Commands" |
| 3 |
.SH NAME |
| 4 |
texi2any \- translate Texinfo documents |
| 5 |
.SH SYNOPSIS |
| 6 |
.B makeinfo |
| 7 |
[\fI\,OPTION\/\fR]... \fI\,TEXINFO-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 |
.PP |
| 12 |
This program is commonly installed as both `makeinfo' and `texi2any'; |
| 13 |
the behavior is identical, and does not depend on the installed name. |
| 14 |
.SS "General options:" |
| 15 |
.TP |
| 16 |
\fB\-\-document\-language\fR=\fI\,STR\/\fR locale to use in translating Texinfo keywords |
| 17 |
for the output document (default C). |
| 18 |
.TP |
| 19 |
\fB\-\-error\-limit\fR=\fI\,NUM\/\fR |
| 20 |
quit after NUM errors (default 100). |
| 21 |
.TP |
| 22 |
\fB\-\-force\fR |
| 23 |
preserve output even if errors. |
| 24 |
.TP |
| 25 |
\fB\-\-help\fR |
| 26 |
display this help and exit. |
| 27 |
.TP |
| 28 |
\fB\-\-no\-validate\fR |
| 29 |
suppress node cross\-reference validation. |
| 30 |
.TP |
| 31 |
\fB\-\-no\-warn\fR |
| 32 |
suppress warnings (but not errors). |
| 33 |
.TP |
| 34 |
\fB\-\-conf\-dir\fR=\fI\,DIR\/\fR |
| 35 |
search also for initialization files in DIR. |
| 36 |
.TP |
| 37 |
\fB\-\-init\-file\fR=\fI\,FILE\/\fR |
| 38 |
load FILE to modify the default behavior. |
| 39 |
.TP |
| 40 |
\fB\-c\fR, \fB\-\-set\-customization\-variable\fR VAR=VAL |
| 41 |
set customization variable VAR |
| 42 |
to value VAL. |
| 43 |
.TP |
| 44 |
\fB\-v\fR, \fB\-\-verbose\fR |
| 45 |
explain what is being done. |
| 46 |
.TP |
| 47 |
\fB\-\-version\fR |
| 48 |
display version information and exit. |
| 49 |
.SS "Output format selection (default is to produce Info):" |
| 50 |
.TP |
| 51 |
\fB\-\-docbook\fR |
| 52 |
output Docbook XML. |
| 53 |
.TP |
| 54 |
\fB\-\-html\fR |
| 55 |
output HTML. |
| 56 |
.TP |
| 57 |
\fB\-\-epub3\fR |
| 58 |
output EPUB 3. |
| 59 |
.TP |
| 60 |
\fB\-\-latex\fR |
| 61 |
output LaTeX. |
| 62 |
.TP |
| 63 |
\fB\-\-plaintext\fR |
| 64 |
output plain text rather than Info. |
| 65 |
.TP |
| 66 |
\fB\-\-xml\fR |
| 67 |
output Texinfo XML. |
| 68 |
.TP |
| 69 |
\fB\-\-dvi\fR, \fB\-\-dvipdf\fR, \fB\-\-ps\fR, \fB\-\-pdf\fR |
| 70 |
call texi2dvi to generate given output, |
| 71 |
after checking validity of TEXINFO\-FILE. |
| 72 |
.SS "General output options:" |
| 73 |
.TP |
| 74 |
\fB\-E\fR, \fB\-\-macro\-expand\fR=\fI\,FILE\/\fR |
| 75 |
output macro\-expanded source to FILE, |
| 76 |
ignoring any @setfilename. |
| 77 |
.TP |
| 78 |
\fB\-\-no\-headers\fR |
| 79 |
suppress node separators, Node: lines, and menus |
| 80 |
from Info output (thus producing plain text) |
| 81 |
or from HTML (thus producing shorter output). |
| 82 |
Also, if producing Info, write to |
| 83 |
standard output by default. |
| 84 |
.TP |
| 85 |
\fB\-\-no\-split\fR |
| 86 |
suppress any splitting of the output; |
| 87 |
generate only one output file. |
| 88 |
.TP |
| 89 |
\fB\-\-[no\-]number\-sections\fR |
| 90 |
output chapter and sectioning numbers; |
| 91 |
default is on. |
| 92 |
.TP |
| 93 |
\fB\-o\fR, \fB\-\-output\fR=\fI\,DEST\/\fR |
| 94 |
output to DEST. |
| 95 |
With split output, create DEST as a directory |
| 96 |
and put the output files there. |
| 97 |
With non\-split output, if DEST is already |
| 98 |
a directory or ends with a /, |
| 99 |
put the output file there. |
| 100 |
Otherwise, DEST names the output file. |
| 101 |
.TP |
| 102 |
\fB\-\-disable\-encoding\fR |
| 103 |
do not output accented and special characters |
| 104 |
in Info and plain text output based on document |
| 105 |
encoding. |
| 106 |
.TP |
| 107 |
\fB\-\-enable\-encoding\fR |
| 108 |
override \fB\-\-disable\-encoding\fR (default). |
| 109 |
.SS "Options for Info and plain text:" |
| 110 |
.TP |
| 111 |
\fB\-\-fill\-column\fR=\fI\,NUM\/\fR |
| 112 |
break Info lines at NUM columns (default 72). |
| 113 |
.TP |
| 114 |
\fB\-\-footnote\-style\fR=\fI\,STYLE\/\fR |
| 115 |
output footnotes in Info according to STYLE: |
| 116 |
`separate' to put them in their own node; |
| 117 |
`end' to put them at the end of the node, in |
| 118 |
which they are defined (this is the default). |
| 119 |
.TP |
| 120 |
\fB\-\-paragraph\-indent\fR=\fI\,VAL\/\fR |
| 121 |
indent Info paragraphs by VAL spaces (default 3). |
| 122 |
If VAL is `none', do not indent; if VAL is |
| 123 |
`asis', preserve existing indentation. |
| 124 |
.TP |
| 125 |
\fB\-\-split\-size\fR=\fI\,NUM\/\fR |
| 126 |
split Info files at size NUM (default 300000). |
| 127 |
.SS "Options for HTML:" |
| 128 |
.TP |
| 129 |
\fB\-\-css\-include\fR=\fI\,FILE\/\fR |
| 130 |
include FILE in HTML <style> output; |
| 131 |
read stdin if FILE is \-. |
| 132 |
.TP |
| 133 |
\fB\-\-css\-ref\fR=\fI\,URL\/\fR |
| 134 |
generate CSS reference to URL. |
| 135 |
.TP |
| 136 |
\fB\-\-internal\-links\fR=\fI\,FILE\/\fR |
| 137 |
produce list of internal links in FILE. |
| 138 |
.TP |
| 139 |
\fB\-\-split\fR=\fI\,SPLIT\/\fR |
| 140 |
split at SPLIT, where SPLIT may be `chapter', |
| 141 |
`section' or `node'. |
| 142 |
.TP |
| 143 |
\fB\-\-transliterate\-file\-names\fR |
| 144 |
use file names in ASCII transliteration. |
| 145 |
.TP |
| 146 |
\fB\-\-node\-files\fR |
| 147 |
produce redirection files for nodes and |
| 148 |
anchors; default is set only if split. |
| 149 |
.SS "Options for DVI/PS/PDF:" |
| 150 |
.TP |
| 151 |
\fB\-\-Xopt\fR=\fI\,OPT\/\fR |
| 152 |
pass OPT to texi2dvi; can be repeated. |
| 153 |
.SS "Input file options:" |
| 154 |
.TP |
| 155 |
\fB\-D\fR VAR |
| 156 |
define the variable VAR, as with @set. |
| 157 |
.TP |
| 158 |
\fB\-D\fR 'VAR VAL' |
| 159 |
define VAR to VAL (one shell argument). |
| 160 |
.TP |
| 161 |
\fB\-I\fR DIR |
| 162 |
append DIR to the @include search path. |
| 163 |
.TP |
| 164 |
\fB\-P\fR DIR |
| 165 |
prepend DIR to the @include search path. |
| 166 |
.TP |
| 167 |
\fB\-U\fR VAR |
| 168 |
undefine the variable VAR, as with @clear. |
| 169 |
.SS "Conditional processing in input:" |
| 170 |
.TP |
| 171 |
\fB\-\-ifdocbook\fR |
| 172 |
process @ifdocbook and @docbook even if |
| 173 |
not generating Docbook. |
| 174 |
.TP |
| 175 |
\fB\-\-ifhtml\fR |
| 176 |
process @ifhtml and @html even if not generating HTML. |
| 177 |
.TP |
| 178 |
\fB\-\-ifinfo\fR |
| 179 |
process @ifinfo even if not generating Info. |
| 180 |
.TP |
| 181 |
\fB\-\-iflatex\fR |
| 182 |
process @iflatex and @latex. |
| 183 |
.TP |
| 184 |
\fB\-\-ifplaintext\fR |
| 185 |
process @ifplaintext even if not generating plain text. |
| 186 |
.TP |
| 187 |
\fB\-\-iftex\fR |
| 188 |
process @iftex and @tex. |
| 189 |
.TP |
| 190 |
\fB\-\-ifxml\fR |
| 191 |
process @ifxml and @xml. |
| 192 |
.TP |
| 193 |
\fB\-\-no\-ifdocbook\fR |
| 194 |
do not process @ifdocbook and @docbook text. |
| 195 |
.TP |
| 196 |
\fB\-\-no\-ifhtml\fR |
| 197 |
do not process @ifhtml and @html text. |
| 198 |
.TP |
| 199 |
\fB\-\-no\-ifinfo\fR |
| 200 |
do not process @ifinfo text. |
| 201 |
.TP |
| 202 |
\fB\-\-no\-iflatex\fR |
| 203 |
do not process @iflatex and @latex text. |
| 204 |
.TP |
| 205 |
\fB\-\-no\-ifplaintext\fR |
| 206 |
do not process @ifplaintext text. |
| 207 |
.TP |
| 208 |
\fB\-\-no\-iftex\fR |
| 209 |
do not process @iftex and @tex text. |
| 210 |
.TP |
| 211 |
\fB\-\-no\-ifxml\fR |
| 212 |
do not process @ifxml and @xml text. |
| 213 |
.P |
| 214 |
Also, for the \fB\-\-no\-ifFORMAT\fR options, do process @ifnotFORMAT text. |
| 215 |
.P |
| 216 |
The defaults for the @if... conditionals depend on the output format: |
| 217 |
if generating Docbook, \fB\-\-ifdocbook\fR is on and the others are off; |
| 218 |
if generating HTML, \fB\-\-ifhtml\fR is on and the others are off; |
| 219 |
if generating Info, \fB\-\-ifinfo\fR is on and the others are off; |
| 220 |
if generating plain text, \fB\-\-ifplaintext\fR is on and the others are off; |
| 221 |
if generating LaTeX, \fB\-\-iflatex\fR is on and the others are off; |
| 222 |
if generating XML, \fB\-\-ifxml\fR is on and the others are off. |
| 223 |
.SH EXAMPLES |
| 224 |
.TP |
| 225 |
makeinfo foo.texi |
| 226 |
write Info to foo's @setfilename |
| 227 |
.TP |
| 228 |
makeinfo \-\-html foo.texi |
| 229 |
write HTML to @setfilename |
| 230 |
.TP |
| 231 |
makeinfo \-\-xml foo.texi |
| 232 |
write Texinfo XML to @setfilename |
| 233 |
.TP |
| 234 |
makeinfo \-\-docbook foo.texi |
| 235 |
write Docbook XML to @setfilename |
| 236 |
.TP |
| 237 |
makeinfo \-\-plaintext foo.texi |
| 238 |
write plain text to standard output |
| 239 |
.TP |
| 240 |
makeinfo \-\-pdf foo.texi |
| 241 |
write PDF using texi2dvi |
| 242 |
.TP |
| 243 |
makeinfo \-\-html \-\-no\-headers foo.texi |
| 244 |
write html without node lines, menus |
| 245 |
.TP |
| 246 |
makeinfo \-\-number\-sections foo.texi |
| 247 |
write Info with numbered sections |
| 248 |
.TP |
| 249 |
makeinfo \-\-no\-split foo.texi |
| 250 |
write one Info file however big |
| 251 |
.SH "REPORTING BUGS" |
| 252 |
Email bug reports to bug\[email protected], |
| 253 |
general questions and discussion to help\[email protected]. |
| 254 |
.br |
| 255 |
Texinfo home page: http://www.gnu.org/software/texinfo/ |
| 256 |
.SH COPYRIGHT |
| 257 |
Copyright \(co 2024 Free Software Foundation, Inc. |
| 258 |
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> |
| 259 |
.br |
| 260 |
This is free software: you are free to change and redistribute it. |
| 261 |
There is NO WARRANTY, to the extent permitted by law. |
| 262 |
.SH "SEE ALSO" |
| 263 |
The full documentation for |
| 264 |
.B texi2any |
| 265 |
is maintained as a Texinfo manual. If the |
| 266 |
.B info |
| 267 |
and |
| 268 |
.B texi2any |
| 269 |
programs are properly installed at your site, the command |
| 270 |
.IP |
| 271 |
.B info texi2any |
| 272 |
.PP |
| 273 |
should give you access to the complete manual. |