1TEXI2ANY(1) User Commands TEXI2ANY(1)
2
6 texi2any - translate Texinfo documents
7
9 makeinfo [OPTION]... TEXINFO-FILE...
10
12 Translate Texinfo source documentation to various other formats, by de‐
13 fault Info files suitable for reading online with Emacs or standalone
14 GNU Info.
15 This program is commonly installed as both `makeinfo' and `texi2any';
17 the behavior is identical, and does not depend on the installed name.
18 General options:
20 --document-language=STR locale to use in translating Texinfo keywords
21 for the output document (default C).
22 --error-limit=NUM
24 quit after NUM errors (default 100).
25 --force
27 preserve output even if errors.
28 --help display this help and exit.
30 --no-validate
32 suppress node cross-reference validation.
33 --no-warn
35 suppress warnings (but not errors).
36 --conf-dir=DIR
38 search also for initialization files in DIR.
39 --init-file=FILE
41 load FILE to modify the default behavior.
42 -c, --set-customization-variable VAR=VAL
44 set customization variable VAR to value VAL.
45 -v, --verbose
47 explain what is being done.
48 --version
50 display version information and exit.
51 Output format selection (default is to produce Info):
53 --docbook
54 output Docbook XML.
55 --html output HTML.
57 --epub3
59 output EPUB 3.
60 --latex
62 output LaTeX.
63 --plaintext
65 output plain text rather than Info.
66 --xml output Texinfo XML.
68 --dvi, --dvipdf, --ps, --pdf
70 call texi2dvi to generate given output, after checking validity
71 of TEXINFO-FILE.
72 General output options:
74 -E, --macro-expand=FILE
75 output macro-expanded source to FILE, ignoring any @setfilename.
76 --no-headers
78 suppress node separators, Node: lines, and menus from Info out‐
79 put (thus producing plain text) or from HTML (thus producing
80 shorter output). Also, if producing Info, write to standard
81 output by default.
82 --no-split
84 suppress any splitting of the output; generate only one output
85 file.
86 --[no-]number-sections
88 output chapter and sectioning numbers; default is on.
89 -o, --output=DEST
91 output to DEST. With split output, create DEST as a directory
92 and put the output files there. With non-split output, if DEST
93 is already a directory or ends with a /, put the output file
94 there. Otherwise, DEST names the output file.
95 --disable-encoding
97 do not output accented and special characters in Info output
98 based on document encoding.
99 --enable-encoding
101 based on document encoding, output accented characters in
102 XML-based output as well as special characters in HTML instead
103 of entities.
104 Options for Info and plain text:
106 --fill-column=NUM
107 break Info lines at NUM columns (default 72).
108 --footnote-style=STYLE
110 output footnotes in Info according to STYLE: `separate' to put
111 them in their own node; `end' to put them at the end of the
112 node, in which they are defined (this is the default).
113 --paragraph-indent=VAL
115 indent Info paragraphs by VAL spaces (default 3). If VAL is
116 `none', do not indent; if VAL is `asis', preserve existing in‐
117 dentation.
118 --split-size=NUM
120 split Info files at size NUM (default 300000).
121 Options for HTML:
123 --css-include=FILE
124 include FILE in HTML <style> output; read stdin if FILE is -.
125 --css-ref=URL
127 generate CSS reference to URL.
128 --internal-links=FILE
130 produce list of internal links in FILE.
131 --split=SPLIT
133 split at SPLIT, where SPLIT may be `chapter', `section' or
134 `node'.
135 --transliterate-file-names
137 use file names in ASCII transliteration.
138 --node-files
140 produce redirection files for nodes and anchors; default is set
141 only if split.
142 Options for DVI/PS/PDF:
144 --Xopt=OPT
145 pass OPT to texi2dvi; can be repeated.
146 Input file options:
148 -D VAR define the variable VAR, as with @set.
149 -D 'VAR VAL'
151 define VAR to VAL (one shell argument).
152 -I DIR append DIR to the @include search path.
154 -P DIR prepend DIR to the @include search path.
156 -U VAR undefine the variable VAR, as with @clear.
158 Conditional processing in input:
160 --ifdocbook
161 process @ifdocbook and @docbook even if not generating Docbook.
162 --ifhtml
164 process @ifhtml and @html even if not generating HTML.
165 --ifinfo
167 process @ifinfo even if not generating Info.
168 --iflatex
170 process @iflatex and @latex.
171 --ifplaintext
173 process @ifplaintext even if not generating plain text.
174 --iftex
176 process @iftex and @tex.
177 --ifxml
179 process @ifxml and @xml.
180 --no-ifdocbook
182 do not process @ifdocbook and @docbook text.
183 --no-ifhtml
185 do not process @ifhtml and @html text.
186 --no-ifinfo
188 do not process @ifinfo text.
189 --no-iflatex
191 do not process @iflatex and @latex text.
192 --no-ifplaintext
194 do not process @ifplaintext text.
195 --no-iftex
197 do not process @iftex and @tex text.
198 --no-ifxml
200 do not process @ifxml and @xml text.
201 Also, for the --no-ifFORMAT options, do process @ifnotFORMAT text.
203 The defaults for the @if... conditionals depend on the output format:
205 if generating Docbook, --ifdocbook is on and the others are off; if
206 generating HTML, --ifhtml is on and the others are off; if generating
207 Info, --ifinfo is on and the others are off; if generating plain text,
208 --ifplaintext is on and the others are off; if generating LaTeX,
209 --iflatex is on and the others are off; if generating XML, --ifxml is
210 on and the others are off.
211
213 makeinfo foo.texi
214 write Info to foo's @setfilename
215 makeinfo --html foo.texi
217 write HTML to @setfilename
218 makeinfo --xml foo.texi
220 write Texinfo XML to @setfilename
221 makeinfo --docbook foo.texi
223 write Docbook XML to @setfilename
224 makeinfo --plaintext foo.texi
226 write plain text to standard output
227 makeinfo --pdf foo.texi
229 write PDF using texi2dvi
230 makeinfo --html --no-headers foo.texi
232 write html without node lines, menus
233 makeinfo --number-sections foo.texi
235 write Info with numbered sections
236 makeinfo --no-split foo.texi
238 write one Info file however big
239
241 Email bug reports to bug-texinfo@gnu.org, general questions and discus‐
242 sion to help-texinfo@gnu.org.
243 Texinfo home page: http://www.gnu.org/software/texinfo/
244
246 Copyright © 2023 Free Software Foundation, Inc. License GPLv3+: GNU
247 GPL version 3 or later <http://gnu.org/licenses/gpl.html>
248 This is free software: you are free to change and redistribute it.
249 There is NO WARRANTY, to the extent permitted by law.
250
252 The full documentation for texi2any is maintained as a Texinfo manual.
253 If the info and texi2any programs are properly installed at your site,
254 the command
255 info texi2any
257 should give you access to the complete manual.
259GNU texinfo 7.0.3 March 2023 TEXI2ANY(1)