1MAKEINFO(1) User Commands MAKEINFO(1)
2
6 makeinfo - 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 General options:
17 --error-limit=NUM
18 quit after NUM errors (default 100).
19 --document-language=STR locale to use in translating Texinfo keywords
21 for the output document (default C).
22 --force
24 preserve output even if errors.
25 --help display this help and exit.
27 --no-validate
29 suppress node cross-reference validation.
30 --no-warn
32 suppress warnings (but not errors).
33 -v, --verbose
35 explain what is being done.
36 --version
38 display version information and exit.
39 Output format selection (default is to produce Info):
41 --docbook
42 output Docbook XML rather than Info.
43 --html output HTML rather than Info.
45 --xml output Texinfo XML rather than Info.
47 --plaintext
49 output plain text rather than Info.
50 General output options:
52 -E, --macro-expand FILE
53 output macro-expanded source to FILE. ignoring any @setfile‐
54 name.
55 --no-headers
57 suppress node separators, Node: lines, and menus from Info out‐
58 put (thus producing plain text) or from HTML (thus producing
59 shorter output); also, write to standard output by default.
60 --no-split
62 suppress splitting of Info or HTML output, generate only one
63 output file.
64 --number-sections
66 output chapter and sectioning numbers.
67 -o, --output=FILE
69 output to FILE (directory if split HTML),
70 Options for Info and plain text:
72 --disable-encoding
73 do not output accented and special characters in Info output
74 based on @documentencoding.
75 --enable-encoding
77 override --disable-encoding (default).
78 --fill-column=NUM
80 break Info lines at NUM characters (default 72).
81 --footnote-style=STYLE
83 output footnotes in Info according to STYLE: `separate' to put
84 them in their own node; `end' to put them at the end of the
85 node, in which they are defined (this is the default).
86 --paragraph-indent=VAL
88 indent Info paragraphs by VAL spaces (default 3). If VAL is
89 `none', do not indent; if VAL is `asis', preserve existing
90 indentation.
91 --split-size=NUM
93 split Info files at size NUM (default 300000).
94 Options for HTML:
96 --css-include=FILE
97 include FILE in HTML <style> output; read stdin if FILE is -.
98 --css-ref=URL
100 generate reference to a CSS file.
101 --transliterate-file-names
103 produce file names in ASCII transliteration.
104 Options for XML and Docbook:
106 --output-indent=VAL
107 indent XML elements by VAL spaces (default 2). If VAL is 0,
108 ignorable whitespace is dropped.
109 Input file options:
111 --commands-in-node-names
112 allow @ commands in node names.
113 -D VAR define the variable VAR, as with @set.
115 -I DIR append DIR to the @include search path.
117 -P DIR prepend DIR to the @include search path.
119 -U VAR undefine the variable VAR, as with @clear.
121 Conditional processing in input:
123 --ifdocbook
124 process @ifdocbook and @docbook even if not generating Docbook.
125 --ifhtml
127 process @ifhtml and @html even if not generating HTML.
128 --ifinfo
130 process @ifinfo even if not generating Info.
131 --ifplaintext
133 process @ifplaintext even if not generating plain text.
134 --iftex
136 process @iftex and @tex; implies --no-split.
137 --ifxml
139 process @ifxml and @xml.
140 --no-ifdocbook
142 do not process @ifdocbook and @docbook text.
143 --no-ifhtml
145 do not process @ifhtml and @html text.
146 --no-ifinfo
148 do not process @ifinfo text.
149 --no-ifplaintext
151 do not process @ifplaintext text.
152 --no-iftex
154 do not process @iftex and @tex text.
155 --no-ifxml
157 do not process @ifxml and @xml text.
158 Also, for the --no-ifFORMAT options, do process @ifnotFORMAT text.
160 The defaults for the @if... conditionals depend on the output format:
162 if generating HTML, --ifhtml is on and the others are off; if generat‐
163 ing Info, --ifinfo is on and the others are off; if generating plain
164 text, --ifplaintext is on and the others are off; if generating XML,
165 --ifxml is on and the others are off.
166
168 makeinfo foo.texi
169 write Info to foo's @setfilename
170 makeinfo --html foo.texi
172 write HTML to @setfilename
173 makeinfo --xml foo.texi
175 write Texinfo XML to @setfilename
176 makeinfo --docbook foo.texi
178 write DocBook XML to @setfilename
179 makeinfo --no-headers foo.texi
181 write plain text to standard output
182 makeinfo --html --no-headers foo.texi
184 write html without node lines, menus
185 makeinfo --number-sections foo.texi
187 write Info with numbered sections
188 makeinfo --no-split foo.texi
190 write one Info file however big
191
193 Email bug reports to bug-texinfo@gnu.org, general questions and discus‐
194 sion to help-texinfo@gnu.org. Texinfo home page:
195 http://www.gnu.org/software/texinfo/
196
198 Copyright © 2007 Free Software Foundation, Inc. License GPLv3+: GNU
199 GPL version 3 or later <http://gnu.org/licenses/gpl.html>
200 This is free software: you are free to change and redistribute it.
201 There is NO WARRANTY, to the extent permitted by law.
202
204 The full documentation for makeinfo is maintained as a Texinfo manual.
205 If the info and makeinfo programs are properly installed at your site,
206 the command
207 info makeinfo
209 should give you access to the complete manual.
211makeinfo 4.11 September 2007 MAKEINFO(1)