Debian Codegraph @

upstream/debian-unstable/man1/makeinfo.1

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