version 2, including all changes.
.
Rev |
Author |
# |
Line |
1 |
perry |
1 |
MAKEINFO |
|
|
2 |
!!!MAKEINFO |
|
|
3 |
NAME |
|
|
4 |
SYNOPSIS |
|
|
5 |
DESCRIPTION |
|
|
6 |
EXAMPLES |
|
|
7 |
REPORTING BUGS |
|
|
8 |
COPYRIGHT |
|
|
9 |
SEE ALSO |
|
|
10 |
---- |
|
|
11 |
!!NAME |
|
|
12 |
|
|
|
13 |
|
|
|
14 |
makeinfo - translate Texinfo documents |
|
|
15 |
!!SYNOPSIS |
|
|
16 |
|
|
|
17 |
|
|
|
18 |
__makeinfo__ [[''OPTION'']... |
|
|
19 |
''TEXINFO-FILE''... |
|
|
20 |
!!DESCRIPTION |
|
|
21 |
|
|
|
22 |
|
|
|
23 |
Translate Texinfo source documentation to various other |
|
|
24 |
formats, by default Info files suitable for reading online |
|
|
25 |
with Emacs or standalone GNU Info. |
|
|
26 |
|
|
|
27 |
|
|
|
28 |
__General options:__ |
|
|
29 |
|
|
|
30 |
|
|
|
31 |
__--error-limit__=''NUM'' |
|
|
32 |
|
|
|
33 |
|
|
|
34 |
quit after NUM errors (default 100). |
|
|
35 |
|
|
|
36 |
|
|
|
37 |
__--force__ |
|
|
38 |
|
|
|
39 |
|
|
|
40 |
preserve output even if errors. |
|
|
41 |
|
|
|
42 |
|
|
|
43 |
__--help__ |
|
|
44 |
|
|
|
45 |
|
|
|
46 |
display this help and exit. |
|
|
47 |
|
|
|
48 |
|
|
|
49 |
__--no-validate__ |
|
|
50 |
|
|
|
51 |
|
|
|
52 |
suppress node cross-reference validation. |
|
|
53 |
|
|
|
54 |
|
|
|
55 |
__--no-warn__ |
|
|
56 |
|
|
|
57 |
|
|
|
58 |
suppress warnings (but not errors). |
|
|
59 |
|
|
|
60 |
|
|
|
61 |
__--reference-limit__=''NUM'' |
|
|
62 |
|
|
|
63 |
|
|
|
64 |
warn about at most NUM references (default |
|
|
65 |
1000). |
|
|
66 |
|
|
|
67 |
|
|
|
68 |
__-v__, __--verbose__ |
|
|
69 |
|
|
|
70 |
|
|
|
71 |
explain what is being done. |
|
|
72 |
|
|
|
73 |
|
|
|
74 |
__--version__ |
|
|
75 |
|
|
|
76 |
|
|
|
77 |
display version information and exit. |
|
|
78 |
|
|
|
79 |
|
|
|
80 |
__Output format selection (default is to produce |
|
|
81 |
Info):__ |
|
|
82 |
|
|
|
83 |
|
|
|
84 |
__--docbook__ |
|
|
85 |
|
|
|
86 |
|
2 |
perry |
87 |
output !DocBook rather than Info. |
1 |
perry |
88 |
|
|
|
89 |
|
|
|
90 |
__--html__ |
|
|
91 |
|
|
|
92 |
|
|
|
93 |
output HTML rather than Info. |
|
|
94 |
|
|
|
95 |
|
|
|
96 |
__--no-headers__ |
|
|
97 |
|
|
|
98 |
|
|
|
99 |
output plain text, suppressing Info node separators and |
|
|
100 |
Node: lines; also, write to standard output without |
|
|
101 |
__--output__. |
|
|
102 |
|
|
|
103 |
|
|
|
104 |
__--xml__ |
|
|
105 |
|
|
|
106 |
|
|
|
107 |
output XML (TexinfoML) rather than Info. |
|
|
108 |
|
|
|
109 |
|
|
|
110 |
__General output options:__ |
|
|
111 |
|
|
|
112 |
|
|
|
113 |
__-E__, __--macro-expand__ FILE |
|
|
114 |
|
|
|
115 |
|
|
|
116 |
output macro-expanded source to FILE. ignoring any |
|
|
117 |
@setfilename. |
|
|
118 |
|
|
|
119 |
|
|
|
120 |
__--no-split__ |
|
|
121 |
|
|
|
122 |
|
|
|
123 |
suppress splitting of Info or HTML output, generate only one |
|
|
124 |
output file. |
|
|
125 |
|
|
|
126 |
|
|
|
127 |
__--number-sections__ |
|
|
128 |
|
|
|
129 |
|
|
|
130 |
output chapter and sectioning numbers. |
|
|
131 |
|
|
|
132 |
|
|
|
133 |
__-o__, __--output__=''FILE'' |
|
|
134 |
|
|
|
135 |
|
|
|
136 |
output to FILE (directory if split HTML), |
|
|
137 |
|
|
|
138 |
|
|
|
139 |
__Options for Info and plain text:__ |
|
|
140 |
|
|
|
141 |
|
|
|
142 |
__--enable-encoding__ |
|
|
143 |
|
|
|
144 |
|
|
|
145 |
output accented and special characters in Info output based |
|
|
146 |
on @documentencoding. |
|
|
147 |
|
|
|
148 |
|
|
|
149 |
__--fill-column__=''NUM'' |
|
|
150 |
|
|
|
151 |
|
|
|
152 |
break Info lines at NUM characters (default |
|
|
153 |
72). |
|
|
154 |
|
|
|
155 |
|
|
|
156 |
__--footnote-style__=''STYLE'' |
|
|
157 |
|
|
|
158 |
|
|
|
159 |
output footnotes in Info according to STYLE: `separate' to |
|
|
160 |
put them in their own node; `end' to put them at the end of |
|
|
161 |
the node |
|
|
162 |
|
|
|
163 |
|
|
|
164 |
in which they are defined (default). |
|
|
165 |
|
|
|
166 |
|
|
|
167 |
__--paragraph-indent__=''VAL'' |
|
|
168 |
|
|
|
169 |
|
|
|
170 |
indent Info paragraphs by VAL spaces (default 3). If VAL is |
|
|
171 |
`none', do not indent; if VAL is `asis', preserve existing |
|
|
172 |
indentation. |
|
|
173 |
|
|
|
174 |
|
|
|
175 |
__--split-size__=''NUM'' |
|
|
176 |
|
|
|
177 |
|
|
|
178 |
split Info files at size NUM (default 50000). |
|
|
179 |
|
|
|
180 |
|
|
|
181 |
__Input file options:__ |
|
|
182 |
|
|
|
183 |
|
|
|
184 |
__--commands-in-node-names__ |
|
|
185 |
|
|
|
186 |
|
|
|
187 |
allow @ commands in node names. |
|
|
188 |
|
|
|
189 |
|
|
|
190 |
__-D__ VAR |
|
|
191 |
|
|
|
192 |
|
|
|
193 |
define the variable VAR, as with @set. |
|
|
194 |
|
|
|
195 |
|
|
|
196 |
__-I__ DIR |
|
|
197 |
|
|
|
198 |
|
|
|
199 |
append DIR to the @include search path. |
|
|
200 |
|
|
|
201 |
|
|
|
202 |
__-P__ DIR |
|
|
203 |
|
|
|
204 |
|
|
|
205 |
prepend DIR to the @include search path. |
|
|
206 |
|
|
|
207 |
|
|
|
208 |
__-U__ VAR |
|
|
209 |
|
|
|
210 |
|
|
|
211 |
undefine the variable VAR, as with @clear. |
|
|
212 |
|
|
|
213 |
|
|
|
214 |
__Conditional processing in input:__ |
|
|
215 |
|
|
|
216 |
|
|
|
217 |
__--ifhtml__ |
|
|
218 |
|
|
|
219 |
|
|
|
220 |
process @ifhtml and @html even if not generating |
|
|
221 |
HTML. |
|
|
222 |
|
|
|
223 |
|
|
|
224 |
__--ifinfo__ |
|
|
225 |
|
|
|
226 |
|
|
|
227 |
process @ifinfo text even when generating HTML. |
|
|
228 |
|
|
|
229 |
|
|
|
230 |
__--iftex__ |
|
|
231 |
|
|
|
232 |
|
|
|
233 |
process @iftex and @tex text; implies |
|
|
234 |
__--no-split__. |
|
|
235 |
|
|
|
236 |
|
|
|
237 |
__--no-ifhtml__ |
|
|
238 |
|
|
|
239 |
|
|
|
240 |
do not process @ifhtml and @html text. |
|
|
241 |
|
|
|
242 |
|
|
|
243 |
__--no-ifinfo__ |
|
|
244 |
|
|
|
245 |
|
|
|
246 |
do not process @ifinfo text. |
|
|
247 |
|
|
|
248 |
|
|
|
249 |
__--no-iftex__ |
|
|
250 |
|
|
|
251 |
|
|
|
252 |
do not process @iftex and @tex text. |
|
|
253 |
|
|
|
254 |
|
|
|
255 |
The defaults for the @if... conditionals depend on the |
|
|
256 |
output format: if generating HTML, __--ifhtml__ is on and |
|
|
257 |
the others are off; if generating Info or plain text, |
|
|
258 |
__--ifinfo__ is on and the others are off. |
|
|
259 |
!!EXAMPLES |
|
|
260 |
|
|
|
261 |
|
|
|
262 |
makeinfo foo.texi |
|
|
263 |
|
|
|
264 |
|
|
|
265 |
write Info to foo's @setfilename |
|
|
266 |
|
|
|
267 |
|
|
|
268 |
makeinfo __--html__ foo.texi |
|
|
269 |
|
|
|
270 |
|
|
|
271 |
write HTML to foo's @setfilename |
|
|
272 |
|
|
|
273 |
|
|
|
274 |
makeinfo __--no-headers -o__ - foo.texi |
|
|
275 |
|
|
|
276 |
|
|
|
277 |
write plain text to standard output |
|
|
278 |
|
|
|
279 |
|
|
|
280 |
makeinfo __--number-sections__ foo.texi |
|
|
281 |
|
|
|
282 |
|
|
|
283 |
write Info with numbered sections |
|
|
284 |
|
|
|
285 |
|
|
|
286 |
makeinfo __--no-split__ foo.texi |
|
|
287 |
|
|
|
288 |
|
|
|
289 |
write one Info file however big |
|
|
290 |
!!REPORTING BUGS |
|
|
291 |
|
|
|
292 |
|
|
|
293 |
Email bug reports to bug-texinfo@gnu.org, general questions |
|
|
294 |
and discussion to help-texinfo@gnu.org. |
|
|
295 |
!!COPYRIGHT |
|
|
296 |
|
|
|
297 |
|
|
|
298 |
Copyright 2002 Free Software Foundation, Inc. There is NO |
|
|
299 |
warranty. You may redistribute this software under the terms |
|
|
300 |
of the GNU General Public License. For more information |
|
|
301 |
about these matters, see the files named |
|
|
302 |
COPYING. |
|
|
303 |
!!SEE ALSO |
|
|
304 |
|
|
|
305 |
|
|
|
306 |
The full documentation for __makeinfo__ is maintained as |
|
|
307 |
a Texinfo manual. If the __info__ and __makeinfo__ |
|
|
308 |
programs are properly installed at your site, the |
|
|
309 |
command |
|
|
310 |
|
|
|
311 |
|
|
|
312 |
__info makeinfo__ |
|
|
313 |
|
|
|
314 |
|
|
|
315 |
should give you access to the complete manual. |
|
|
316 |
---- |