1MAKEINFO(1)                      User Commands                     MAKEINFO(1)
2
3
4

NAME

6       makeinfo - translate Texinfo documents
7

SYNOPSIS

9       makeinfo [OPTION]... TEXINFO-FILE...
10

DESCRIPTION

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
16   General options:
17       --error-limit=NUM
18              quit after NUM errors (default 100).
19
20       --document-language=STR locale to use in translating Texinfo keywords
21              for the output document (default C).
22
23       --force
24              preserve output even if errors.
25
26       --help display this help and exit.
27
28       --no-validate
29              suppress node cross-reference validation.
30
31       --no-warn
32              suppress warnings (but not errors).
33
34       -v, --verbose
35              explain what is being done.
36
37       --version
38              display version information and exit.
39
40   Output format selection (default is to produce Info):
41       --docbook
42              output Docbook XML rather than Info.
43
44       --html output HTML rather than Info.
45
46       --xml  output Texinfo XML rather than Info.
47
48       --plaintext
49              output plain text rather than Info.
50
51   General output options:
52       -E, --macro-expand=FILE
53              output macro-expanded source to FILE, ignoring any @setfilename.
54
55       --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
60       --no-split
61              suppress the splitting of Info or HTML output, generate only one
62              output file.
63
64       --number-sections
65              output chapter and sectioning numbers.
66
67       -o, --output=FILE
68              output to FILE (or directory if split HTML).
69
70   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
75       --enable-encoding
76              override --disable-encoding (default).
77
78       --fill-column=NUM
79              break Info lines at NUM characters (default 72).
80
81       --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
86       --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
91       --split-size=NUM
92              split Info files at size NUM (default 300000).
93
94   Options for HTML:
95       --css-include=FILE
96              include FILE in HTML <style> output; read stdin if FILE is -.
97
98       --css-ref=URL
99              generate reference to a CSS file.
100
101       --internal-links=FILE
102              produce list of internal links in FILE.
103
104       --transliterate-file-names
105              produce file names in ASCII transliteration.
106
107   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
112   Input file options:
113       --commands-in-node-names
114              allow @ commands in node names.
115
116       -D VAR define the variable VAR, as with @set.
117
118       -I DIR append DIR to the @include search path.
119
120       -P DIR prepend DIR to the @include search path.
121
122       -U VAR undefine the variable VAR, as with @clear.
123
124   Conditional processing in input:
125       --ifdocbook
126              process @ifdocbook and @docbook even if not generating Docbook.
127
128       --ifhtml
129              process @ifhtml and @html even if not generating HTML.
130
131       --ifinfo
132              process @ifinfo even if not generating Info.
133
134       --ifplaintext
135              process @ifplaintext even if not generating plain text.
136
137       --iftex
138              process @iftex and @tex; implies --no-split.
139
140       --ifxml
141              process @ifxml and @xml.
142
143       --no-ifdocbook
144              do not process @ifdocbook and @docbook text.
145
146       --no-ifhtml
147              do not process @ifhtml and @html text.
148
149       --no-ifinfo
150              do not process @ifinfo text.
151
152       --no-ifplaintext
153              do not process @ifplaintext text.
154
155       --no-iftex
156              do not process @iftex and @tex text.
157
158       --no-ifxml
159              do not process @ifxml and @xml text.
160
161       Also, for the --no-ifFORMAT options, do process @ifnotFORMAT text.
162
163       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

EXAMPLES

170       makeinfo foo.texi
171              write Info to foo's @setfilename
172
173       makeinfo --html foo.texi
174              write HTML to @setfilename
175
176       makeinfo --xml foo.texi
177              write Texinfo XML to @setfilename
178
179       makeinfo --docbook foo.texi
180              write DocBook XML to @setfilename
181
182       makeinfo --no-headers foo.texi
183              write plain text to standard output
184
185       makeinfo --html --no-headers foo.texi
186              write html without node lines, menus
187
188       makeinfo --number-sections foo.texi
189              write Info with numbered sections
190
191       makeinfo --no-split foo.texi
192              write one Info file however big
193

REPORTING BUGS

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

SEE ALSO

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
210              info makeinfo
211
212       should give you access to the complete manual.
213
214
215
216makeinfo 4.13                   September 2008                     MAKEINFO(1)
Impressum