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
13 default 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 rather than Info.
55 --html output HTML rather than Info.
57 --plaintext
59 output plain text rather than Info.
60 --xml output Texinfo XML rather than Info.
62 --dvi, --dvipdf, --ps, --pdf
64 call texi2dvi to generate given output, after checking validity
65 of TEXINFO-FILE.
66 General output options:
68 -E, --macro-expand=FILE
69 output macro-expanded source to FILE, ignoring any @setfilename.
70 --no-headers
72 suppress node separators, Node: lines, and menus from Info out‐
73 put (thus producing plain text) or from HTML (thus producing
74 shorter output). Also, if producing Info, write to standard
75 output by default.
76 --no-split
78 suppress any splitting of the output; generate only one output
79 file.
80 --[no-]number-sections
82 output chapter and sectioning numbers; default is on.
83 -o, --output=DEST
85 output to DEST. With split output, create DEST as a directory
86 and put the output files there.
88 With non-split output, if DEST is already
89 a directory or ends with a /,
91 put the output file there.
92 Otherwise, DEST names the output file.
94 Options for Info and plain text:
96 --disable-encoding
97 do not output accented and special characters in Info output
98 based on @documentencoding.
99 --enable-encoding
101 override --disable-encoding (default).
102 --fill-column=NUM
104 break Info lines at NUM characters (default 72).
105 --footnote-style=STYLE
107 output footnotes in Info according to STYLE: `separate' to put
108 them in their own node; `end' to put them at the end of the
109 node, in which they are defined (this is the default).
110 --paragraph-indent=VAL
112 indent Info paragraphs by VAL spaces (default 3). If VAL is
113 `none', do not indent; if VAL is `asis', preserve existing
114 indentation.
115 --split-size=NUM
117 split Info files at size NUM (default 300000).
118 Options for HTML:
120 --css-include=FILE
121 include FILE in HTML <style> output; read stdin if FILE is -.
122 --css-ref=URL
124 generate CSS reference to URL.
125 --internal-links=FILE
127 produce list of internal links in FILE.
128 --split=SPLIT
130 split at SPLIT, where SPLIT may be `chapter', `section' or
131 `node'.
132 --transliterate-file-names
134 use file names in ASCII transliteration.
135 --node-files
137 produce redirection files for nodes and anchors; default is set
138 only if split.
139 Options for XML and Docbook:
141 --output-indent=VAL
142 does nothing, retained for compatibility.
143 Options for DVI/PS/PDF:
145 --Xopt=OPT
146 pass OPT to texi2dvi; can be repeated.
147 Input file options:
149 --commands-in-node-names
150 does nothing, retained for compatibility.
151 -D VAR define the variable VAR, as with @set.
153 -D 'VAR VAL'
155 define VAR to VAL (one shell argument).
156 -I DIR append DIR to the @include search path.
158 -P DIR prepend DIR to the @include search path.
160 -U VAR undefine the variable VAR, as with @clear.
162 Conditional processing in input:
164 --ifdocbook
165 process @ifdocbook and @docbook even if not generating Docbook.
166 --ifhtml
168 process @ifhtml and @html even if not generating HTML.
169 --ifinfo
171 process @ifinfo even if not generating Info.
172 --ifplaintext
174 process @ifplaintext even if not generating plain text.
175 --iftex
177 process @iftex and @tex.
178 --ifxml
180 process @ifxml and @xml.
181 --no-ifdocbook
183 do not process @ifdocbook and @docbook text.
184 --no-ifhtml
186 do not process @ifhtml and @html text.
187 --no-ifinfo
189 do not process @ifinfo text.
190 --no-ifplaintext
192 do not process @ifplaintext text.
193 --no-iftex
195 do not process @iftex and @tex text.
196 --no-ifxml
198 do not process @ifxml and @xml text.
199 Also, for the --no-ifFORMAT options, do process @ifnotFORMAT text.
201 The defaults for the @if... conditionals depend on the output format:
203 if generating Docbook, --ifdocbook is on and the others are off; if
204 generating HTML, --ifhtml is on and the others are off; if generating
205 Info, --ifinfo is on and the others are off; if generating plain text,
206 --ifplaintext is on and the others are off; if generating XML, --ifxml
207 is on and the others are off.
208
210 makeinfo foo.texi
211 write Info to foo's @setfilename
212 makeinfo --html foo.texi
214 write HTML to @setfilename
215 makeinfo --xml foo.texi
217 write Texinfo XML to @setfilename
218 makeinfo --docbook foo.texi
220 write Docbook XML to @setfilename
221 makeinfo --plaintext foo.texi
223 write plain text to standard output
224 makeinfo --pdf foo.texi
226 write PDF using texi2dvi
227 makeinfo --html --no-headers foo.texi
229 write html without node lines, menus
230 makeinfo --number-sections foo.texi
232 write Info with numbered sections
233 makeinfo --no-split foo.texi
235 write one Info file however big
236
238 Email bug reports to bug-texinfo@gnu.org, general questions and discus‐
239 sion to help-texinfo@gnu.org.
240 Texinfo home page: http://www.gnu.org/software/texinfo/
241
243 Copyright © 2017 Free Software Foundation, Inc. License GPLv3+: GNU
244 GPL version 3 or later <http://gnu.org/licenses/gpl.html>
245 This is free software: you are free to change and redistribute it.
246 There is NO WARRANTY, to the extent permitted by law.
247
249 The full documentation for texi2any is maintained as a Texinfo manual.
250 If the info and texi2any programs are properly installed at your site,
251 the command
252 info texi2any
254 should give you access to the complete manual.
256texi2any 6.7 September 2019 TEXI2ANY(1)