Debian Codegraph @

upstream/fedora-44/man1/makeinfo.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2 .TH TEXI2ANY "1" "December 2024" "GNU texinfo 7.2" "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\-o\fR, \fB\-\-output\fR=\fI\,DEST\/\fR
97 output to DEST.
98 With split output, create DEST as a directory
99 and put the output files there.
100 With non\-split output, if DEST is already
101 a directory or ends with a /,
102 put the output file there.
103 Otherwise, DEST names the output file.
104 .TP
105 \fB\-\-disable\-encoding\fR
106 do not output accented and special characters
107 in Info and plain text output based on document
108 encoding.
109 .TP
110 \fB\-\-enable\-encoding\fR
111 override \fB\-\-disable\-encoding\fR (default).
112 .SS "Options for Info and plain text:"
113 .TP
114 \fB\-\-fill\-column\fR=\fI\,NUM\/\fR
115 break Info lines at NUM columns (default 72).
116 .TP
117 \fB\-\-footnote\-style\fR=\fI\,STYLE\/\fR
118 output footnotes in Info according to STYLE:
119 `separate' to put them in their own node;
120 `end' to put them at the end of the node, in
121 which they are defined (this is the default).
122 .TP
123 \fB\-\-paragraph\-indent\fR=\fI\,VAL\/\fR
124 indent Info paragraphs by VAL spaces (default 3).
125 If VAL is `none', do not indent; if VAL is
126 `asis', preserve existing indentation.
127 .TP
128 \fB\-\-split\-size\fR=\fI\,NUM\/\fR
129 split Info files at size NUM (default 300000).
130 .SS "Options for HTML:"
131 .TP
132 \fB\-\-css\-include\fR=\fI\,FILE\/\fR
133 include FILE in HTML <style> output;
134 read stdin if FILE is \-.
135 .TP
136 \fB\-\-css\-ref\fR=\fI\,URL\/\fR
137 generate CSS reference to URL.
138 .TP
139 \fB\-\-internal\-links\fR=\fI\,FILE\/\fR
140 produce list of internal links in FILE.
141 .TP
142 \fB\-\-split\fR=\fI\,SPLIT\/\fR
143 split at SPLIT, where SPLIT may be `chapter',
144 `section' or `node'.
145 .TP
146 \fB\-\-transliterate\-file\-names\fR
147 use file names in ASCII transliteration.
148 .TP
149 \fB\-\-node\-files\fR
150 produce redirection files for nodes and
151 anchors; default is set only if split.
152 .SS "Options for DVI/PS/PDF:"
153 .TP
154 \fB\-\-Xopt\fR=\fI\,OPT\/\fR
155 pass OPT to texi2dvi; can be repeated.
156 .SS "Input file options:"
157 .TP
158 \fB\-D\fR VAR
159 define the variable VAR, as with @set.
160 .TP
161 \fB\-D\fR 'VAR VAL'
162 define VAR to VAL (one shell argument).
163 .TP
164 \fB\-I\fR DIR
165 append DIR to the @include search path.
166 .TP
167 \fB\-P\fR DIR
168 prepend DIR to the @include search path.
169 .TP
170 \fB\-U\fR VAR
171 undefine the variable VAR, as with @clear.
172 .SS "Conditional processing in input:"
173 .TP
174 \fB\-\-ifdocbook\fR
175 process @ifdocbook and @docbook even if
176 not generating Docbook.
177 .TP
178 \fB\-\-ifhtml\fR
179 process @ifhtml and @html even if not generating HTML.
180 .TP
181 \fB\-\-ifinfo\fR
182 process @ifinfo even if not generating Info.
183 .TP
184 \fB\-\-iflatex\fR
185 process @iflatex and @latex.
186 .TP
187 \fB\-\-ifplaintext\fR
188 process @ifplaintext even if not generating plain text.
189 .TP
190 \fB\-\-iftex\fR
191 process @iftex and @tex.
192 .TP
193 \fB\-\-ifxml\fR
194 process @ifxml and @xml.
195 .TP
196 \fB\-\-no\-ifdocbook\fR
197 do not process @ifdocbook and @docbook text.
198 .TP
199 \fB\-\-no\-ifhtml\fR
200 do not process @ifhtml and @html text.
201 .TP
202 \fB\-\-no\-ifinfo\fR
203 do not process @ifinfo text.
204 .TP
205 \fB\-\-no\-iflatex\fR
206 do not process @iflatex and @latex text.
207 .TP
208 \fB\-\-no\-ifplaintext\fR
209 do not process @ifplaintext text.
210 .TP
211 \fB\-\-no\-iftex\fR
212 do not process @iftex and @tex text.
213 .TP
214 \fB\-\-no\-ifxml\fR
215 do not process @ifxml and @xml text.
216 .P
217 Also, for the \fB\-\-no\-ifFORMAT\fR options, do process @ifnotFORMAT text.
218 .P
219 The defaults for the @if... conditionals depend on the output format:
220 if generating Docbook, \fB\-\-ifdocbook\fR is on and the others are off;
221 if generating HTML, \fB\-\-ifhtml\fR is on and the others are off;
222 if generating Info, \fB\-\-ifinfo\fR is on and the others are off;
223 if generating plain text, \fB\-\-ifplaintext\fR is on and the others are off;
224 if generating LaTeX, \fB\-\-iflatex\fR is on and the others are off;
225 if generating XML, \fB\-\-ifxml\fR is on and the others are off.
226 .SH EXAMPLES
227 .TP
228 makeinfo foo.texi
229 write Info to foo's @setfilename
230 .TP
231 makeinfo \-\-html foo.texi
232 write HTML to @setfilename
233 .TP
234 makeinfo \-\-xml foo.texi
235 write Texinfo XML to @setfilename
236 .TP
237 makeinfo \-\-docbook foo.texi
238 write Docbook XML to @setfilename
239 .TP
240 makeinfo \-\-plaintext foo.texi
241 write plain text to standard output
242 .TP
243 makeinfo \-\-pdf foo.texi
244 write PDF using texi2dvi
245 .TP
246 makeinfo \-\-html \-\-no\-headers foo.texi
247 write html without node lines, menus
248 .TP
249 makeinfo \-\-number\-sections foo.texi
250 write Info with numbered sections
251 .TP
252 makeinfo \-\-no\-split foo.texi
253 write one Info file however big
254 .SH "REPORTING BUGS"
255 Email bug reports to bug\[email protected],
256 general questions and discussion to help\[email protected].
257 .br
258 Texinfo home page: https://www.gnu.org/software/texinfo/
259 .SH COPYRIGHT
260 Copyright \(co 2024 Free Software Foundation, Inc.
261 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
262 .br
263 This is free software: you are free to change and redistribute it.
264 There is NO WARRANTY, to the extent permitted by law.
265 .SH "SEE ALSO"
266 The full documentation for
267 .B texi2any
268 is maintained as a Texinfo manual. If the
269 .B info
270 and
271 .B texi2any
272 programs are properly installed at your site, the command
273 .IP
274 .B info texi2any
275 .PP
276 should give you access to the complete manual.