makeinfo(1)

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

NAME

6       makeinfo - translate Texinfo documents
7

SYNOPSIS

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

DESCRIPTION

13       Translate  Texinfo  source  documentation  to various other formats, by
14       default Info files suitable for reading online with Emacs or standalone
15       GNU Info.
16
17   General options:
18       --document-language=STR locale to use in translating Texinfo keywords
19              for the output document (default C).
20
21       --error-limit=NUM
22              quit after NUM errors (default 100).
23
24       --force
25              preserve output even if errors.
26
27       --help display this help and exit.
28
29       --no-validate
30              suppress node cross-reference validation.
31
32       --no-warn
33              suppress warnings (but not errors).
34
35       --conf-dir=DIR
36              search also for initialization files in DIR.
37
38       --init-file=FILE
39              load FILE to modify the default behavior.
40
41       -c, --set-customization-variable VAR=VAL
42              set customization variable VAR to VAL.
43
44       -v, --verbose
45              explain what is being done.
46
47       --version
48              display version information and exit.
49
50   Output format selection (default is to produce Info):
51       --docbook
52              output Docbook XML rather than Info.
53
54       --html output HTML rather than Info.
55
56       --plaintext
57              output plain text rather than Info.
58
59       --xml  output Texinfo XML rather than Info.
60
61       --dvi, --dvipdf, --ps, --pdf
62              call texi2dvi to generate given output.
63
64   General output options:
65       -E, --macro-expand=FILE
66              output macro-expanded source to FILE, ignoring any @setfilename.
67
68       --no-headers
69              suppress  node separators, Node: lines, and menus from Info out‐
70              put (thus producing plain text) or  from  HTML  (thus  producing
71              shorter  output).   Also,  if  producing Info, write to standard
72              output by default
73
74       --no-split
75              suppress any splitting of the output; generate only  one  output
76              file.
77
78       --[no-]number-sections
79              output chapter and sectioning numbers; default is on.
80
81       -o, --output=DEST
82              output to DEST.  With split output, create DEST as a directory
83
84              and put the output files there.
85
86              With non-split output, if DEST is already
87
88              a directory or ends with a /, put the output file there.
89
90              Otherwise, DEST names the output file.
91
92   Options for Info and plain text:
93       --disable-encoding
94              do  not  output  accented  and special characters in Info output
95              based on @documentencoding.
96
97       --enable-encoding
98              override --disable-encoding (default).
99
100       --fill-column=NUM
101              break Info lines at NUM characters (default 72).
102
103       --footnote-style=STYLE
104              output footnotes in Info according to STYLE: `separate'  to  put
105              them  in  their  own  node;  `end' to put them at the end of the
106              node, in which they are defined (this is the default).
107
108       --paragraph-indent=VAL
109              indent Info paragraphs by VAL spaces (default  3).   If  VAL  is
110              `none',  do  not  indent;  if  VAL  is `asis', preserve existing
111              indentation.
112
113       --split-size=NUM
114              split Info files at size NUM (default 300000).
115
116   Options for HTML:
117       --css-include=FILE
118              include FILE in HTML <style> output; read stdin if FILE is -.
119
120       --css-ref=URL
121              generate CSS reference to URL.
122
123       --internal-links=FILE
124              produce list of internal links in FILE.
125
126       --split=SPLIT
127              split at SPLIT, where  SPLIT  may  be  `chapter',  `section'  or
128              `node'.
129
130       --transliterate-file-names
131              use file names in ASCII transliteration.
132
133       --node-files
134              produce  redirection files for nodes and anchors; default is set
135              only if split.
136
137   Options for XML and Docbook:
138       --output-indent=VAL
139              does nothing, retained for compatibility.
140
141   Options for DVI/PS/PDF:
142       --Xopt=OPT
143              pass OPT to texi2dvi; can be repeated.
144
145   Input file options:
146       --commands-in-node-names
147              does nothing, retained for compatibility.
148
149       -D VAR define the variable VAR, as with @set.
150
151       -I DIR append DIR to the @include search path.
152
153       -P DIR prepend DIR to the @include search path.
154
155       -U VAR undefine the variable VAR, as with @clear.
156
157   Conditional processing in input:
158       --ifdocbook
159              process @ifdocbook and @docbook even if not generating Docbook.
160
161       --ifhtml
162              process @ifhtml and @html even if not generating HTML.
163
164       --ifinfo
165              process @ifinfo even if not generating Info.
166
167       --ifplaintext
168              process @ifplaintext even if not generating plain text.
169
170       --iftex
171              process @iftex and @tex.
172
173       --ifxml
174              process @ifxml and @xml.
175
176       --no-ifdocbook
177              do not process @ifdocbook and @docbook text.
178
179       --no-ifhtml
180              do not process @ifhtml and @html text.
181
182       --no-ifinfo
183              do not process @ifinfo text.
184
185       --no-ifplaintext
186              do not process @ifplaintext text.
187
188       --no-iftex
189              do not process @iftex and @tex text.
190
191       --no-ifxml
192              do not process @ifxml and @xml text.
193
194       Also, for the --no-ifFORMAT options, do process @ifnotFORMAT text.
195
196       The defaults for the @if... conditionals depend on the  output  format:
197       if  generating  Docbook,  --ifdocbook  is on and the others are off; if
198       generating HTML, --ifhtml is on and the others are off;  if  generating
199       Info,  --ifinfo is on and the others are off; if generating plain text,
200       --ifplaintext is on and the others are off; if generating XML,  --ifxml
201       is on and the others are off.
202

EXAMPLES

204       makeinfo foo.texi
205              write Info to foo's @setfilename
206
207       makeinfo --html foo.texi
208              write HTML to @setfilename
209
210       makeinfo --xml foo.texi
211              write Texinfo XML to @setfilename
212
213       makeinfo --docbook foo.texi
214              write Docbook XML to @setfilename
215
216       makeinfo --plaintext foo.texi
217              write plain text to standard output
218
219       makeinfo --pdf foo.texi
220              write PDF using texi2dvi
221
222       makeinfo --html --no-headers foo.texi
223              write html without node lines, menus
224
225       makeinfo --number-sections foo.texi
226              write Info with numbered sections
227
228       makeinfo --no-split foo.texi
229              write one Info file however big
230

REPORTING BUGS

232       Email bug reports to bug-texinfo@gnu.org, general questions and discus‐
233       sion to help-texinfo@gnu.org.
234       Texinfo home page: http://www.gnu.org/software/texinfo/
235

COPYRIGHT

237       Copyright © 2013 Free Software Foundation, Inc.   License  GPLv3+:  GNU
238       GPL version 3 or later <http://gnu.org/licenses/gpl.html>
239       This  is  free  software:  you  are free to change and redistribute it.
240       There is NO WARRANTY, to the extent permitted by law.
241

NAME

SYNOPSIS

DESCRIPTION

EXAMPLES

REPORTING BUGS

COPYRIGHT

SEE ALSO