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 @setfilename.
54 --no-headers
56 suppress node separators, Node: lines, and menus from Info out‐
57 put (thus producing plain text) or from HTML (thus producing
58 shorter output); also, write to standard output by default.
59 --no-split
61 suppress the splitting of Info or HTML output, generate only one
62 output file.
63 --number-sections
65 output chapter and sectioning numbers.
66 -o, --output=FILE
68 output to FILE (or directory if split HTML).
69 Options for Info and plain text:
71 --disable-encoding
72 do not output accented and special characters in Info output
73 based on @documentencoding.
74 --enable-encoding
76 override --disable-encoding (default).
77 --fill-column=NUM
79 break Info lines at NUM characters (default 72).
80 --footnote-style=STYLE
82 output footnotes in Info according to STYLE: `separate' to put
83 them in their own node; `end' to put them at the end of the
84 node, in which they are defined (this is the default).
85 --paragraph-indent=VAL
87 indent Info paragraphs by VAL spaces (default 3). If VAL is
88 `none', do not indent; if VAL is `asis', preserve existing
89 indentation.
90 --split-size=NUM
92 split Info files at size NUM (default 300000).
93 Options for HTML:
95 --css-include=FILE
96 include FILE in HTML <style> output; read stdin if FILE is -.
97 --css-ref=URL
99 generate reference to a CSS file.
100 --internal-links=FILE
102 produce list of internal links in FILE.
103 --transliterate-file-names
105 produce file names in ASCII transliteration.
106 Options for XML and Docbook:
108 --output-indent=VAL
109 indent XML elements by VAL spaces (default 2). If VAL is 0,
110 ignorable whitespace is dropped.
111 Input file options:
113 --commands-in-node-names
114 allow @ commands in node names.
115 -D VAR define the variable VAR, as with @set.
117 -I DIR append DIR to the @include search path.
119 -P DIR prepend DIR to the @include search path.
121 -U VAR undefine the variable VAR, as with @clear.
123 Conditional processing in input:
125 --ifdocbook
126 process @ifdocbook and @docbook even if not generating Docbook.
127 --ifhtml
129 process @ifhtml and @html even if not generating HTML.
130 --ifinfo
132 process @ifinfo even if not generating Info.
133 --ifplaintext
135 process @ifplaintext even if not generating plain text.
136 --iftex
138 process @iftex and @tex; implies --no-split.
139 --ifxml
141 process @ifxml and @xml.
142 --no-ifdocbook
144 do not process @ifdocbook and @docbook text.
145 --no-ifhtml
147 do not process @ifhtml and @html text.
148 --no-ifinfo
150 do not process @ifinfo text.
151 --no-ifplaintext
153 do not process @ifplaintext text.
154 --no-iftex
156 do not process @iftex and @tex text.
157 --no-ifxml
159 do not process @ifxml and @xml text.
160 Also, for the --no-ifFORMAT options, do process @ifnotFORMAT text.
162 The defaults for the @if... conditionals depend on the output format:
164 if generating HTML, --ifhtml is on and the others are off; if generat‐
165 ing Info, --ifinfo is on and the others are off; if generating plain
166 text, --ifplaintext is on and the others are off; if generating XML,
167 --ifxml is on and the others are off.
168
170 makeinfo foo.texi
171 write Info to foo's @setfilename
172 makeinfo --html foo.texi
174 write HTML to @setfilename
175 makeinfo --xml foo.texi
177 write Texinfo XML to @setfilename
178 makeinfo --docbook foo.texi
180 write DocBook XML to @setfilename
181 makeinfo --no-headers foo.texi
183 write plain text to standard output
184 makeinfo --html --no-headers foo.texi
186 write html without node lines, menus
187 makeinfo --number-sections foo.texi
189 write Info with numbered sections
190 makeinfo --no-split foo.texi
192 write one Info file however big
193
195 Email bug reports to bug-texinfo@gnu.org, general questions and discus‐
196 sion to help-texinfo@gnu.org. Texinfo home page:
197 http://www.gnu.org/software/texinfo/
198
200 Copyright © 2008 Free Software Foundation, Inc. License GPLv3+: GNU
201 GPL version 3 or later <http://gnu.org/licenses/gpl.html>
202 This is free software: you are free to change and redistribute it.
203 There is NO WARRANTY, to the extent permitted by law.
204
206 The full documentation for makeinfo is maintained as a Texinfo manual.
207 If the info and makeinfo programs are properly installed at your site,
208 the command
209 info makeinfo
211 should give you access to the complete manual.
213makeinfo 4.13 September 2008 MAKEINFO(1)