← Back to branch summary

~ubuntu-branches/ubuntu/maverick/texinfo/maverick

« back to all changes in this revision

Viewing changes to doc/makeinfo.1

  • Committer: Bazaar Package Importer
  • Author(s): Norbert Preining
  • Date: 2005-10-28 15:10:30 UTC
  • mto: (2.1.1 dapper) (3.1.4 hardy)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20051028151030-9nsf2s2k2z3fktjt
Tags: upstream-4.8
Import upstream version 4.8

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/makeinfo.1
1
 
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.24.
2
 
.TH MAKEINFO "1" "March 2002" "GNU texinfo 4.1" FSF
 
1
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.34.
 
2
.TH MAKEINFO "1" "December 2004" "makeinfo 4.8" "User Commands"
3
3
.SH NAME
4
4
makeinfo \- translate Texinfo documents
5
5
.SH SYNOPSIS
20
20
display this help and exit.
21
21
.TP
22
22
\fB\-\-no\-validate\fR
23
 
suppress node cross-reference validation.
 
23
suppress node cross\-reference validation.
24
24
.TP
25
25
\fB\-\-no\-warn\fR
26
26
suppress warnings (but not errors).
36
36
.SS "Output format selection (default is to produce Info):"
37
37
.TP
38
38
\fB\-\-docbook\fR
39
 
output DocBook rather than Info.
 
39
output Docbook XML rather than Info.
40
40
.TP
41
41
\fB\-\-html\fR
42
42
output HTML rather than Info.
43
43
.TP
44
 
\fB\-\-no\-headers\fR
45
 
output plain text, suppressing Info node
46
 
separators and Node: lines; also, write to
47
 
standard output without \fB\-\-output\fR.
48
 
.TP
49
44
\fB\-\-xml\fR
50
 
output XML (TexinfoML) rather than Info.
 
45
output Texinfo XML rather than Info.
 
46
.TP
 
47
\fB\-\-plaintext\fR
 
48
output plain text rather than Info.
51
49
.SS "General output options:"
52
50
.TP
53
51
\fB\-E\fR, \fB\-\-macro\-expand\fR FILE
54
 
output macro-expanded source to FILE.
 
52
output macro\-expanded source to FILE.
55
53
ignoring any @setfilename.
56
54
.TP
 
55
\fB\-\-no\-headers\fR
 
56
suppress node separators, Node: lines, and menus
 
57
from Info output (thus producing plain text)
 
58
or from HTML (thus producing shorter output);
 
59
also, write to standard output by default.
 
60
.TP
57
61
\fB\-\-no\-split\fR
58
62
suppress splitting of Info or HTML output,
59
63
generate only one output file.
85
89
`asis', preserve existing indentation.
86
90
.TP
87
91
\fB\-\-split\-size\fR=\fINUM\fR
88
 
split Info files at size NUM (default 50000).
 
92
split Info files at size NUM (default 300000).
 
93
.SS "Options for HTML:"
 
94
.TP
 
95
\fB\-\-css\-include\fR=\fIFILE\fR
 
96
include FILE in HTML <style> output;
 
97
read stdin if FILE is \-.
 
98
.SS "Options for XML and Docbook:"
 
99
.TP
 
100
\fB\-\-output\-indent\fR=\fIVAL\fR
 
101
indent XML elements by VAL spaces (default 2).
 
102
If VAL is 0, ignorable whitespace is dropped.
89
103
.SS "Input file options:"
90
104
.TP
91
105
\fB\-\-commands\-in\-node\-names\fR
104
118
undefine the variable VAR, as with @clear.
105
119
.SS "Conditional processing in input:"
106
120
.TP
 
121
\fB\-\-ifdocbook\fR
 
122
process @ifdocbook and @docbook even if
 
123
not generating Docbook.
 
124
.TP
107
125
\fB\-\-ifhtml\fR
108
126
process @ifhtml and @html even if not generating HTML.
109
127
.TP
110
128
\fB\-\-ifinfo\fR
111
 
process @ifinfo text even when generating HTML.
 
129
process @ifinfo even if not generating Info.
 
130
.TP
 
131
\fB\-\-ifplaintext\fR
 
132
process @ifplaintext even if not generating plain text.
112
133
.TP
113
134
\fB\-\-iftex\fR
114
 
process @iftex and @tex text; implies \fB\-\-no\-split\fR.
 
135
process @iftex and @tex; implies \fB\-\-no\-split\fR.
 
136
.TP
 
137
\fB\-\-ifxml\fR
 
138
process @ifxml and @xml.
 
139
.TP
 
140
\fB\-\-no\-ifdocbook\fR
 
141
do not process @ifdocbook and @docbook text.
115
142
.TP
116
143
\fB\-\-no\-ifhtml\fR
117
144
do not process @ifhtml and @html text.
119
146
\fB\-\-no\-ifinfo\fR
120
147
do not process @ifinfo text.
121
148
.TP
 
149
\fB\-\-no\-ifplaintext\fR
 
150
do not process @ifplaintext text.
 
151
.TP
122
152
\fB\-\-no\-iftex\fR
123
153
do not process @iftex and @tex text.
 
154
.TP
 
155
\fB\-\-no\-ifxml\fR
 
156
do not process @ifxml and @xml text.
 
157
.IP
 
158
Also, for the \fB\-\-no\-ifFORMAT\fR options, do process @ifnotFORMAT text.
124
159
.IP
125
160
The defaults for the @if... conditionals depend on the output format:
126
161
if generating HTML, \fB\-\-ifhtml\fR is on and the others are off;
127
 
if generating Info or plain text, \fB\-\-ifinfo\fR is on and the others are off.
 
162
if generating Info, \fB\-\-ifinfo\fR is on and the others are off;
 
163
if generating plain text, \fB\-\-ifplaintext\fR is on and the others are off;
 
164
if generating XML, \fB\-\-ifxml\fR is on and the others are off.
128
165
.SH EXAMPLES
129
166
.TP
130
167
makeinfo foo.texi
131
168
write Info to foo's @setfilename
132
169
.TP
133
170
makeinfo \fB\-\-html\fR foo.texi
134
 
write HTML to foo's @setfilename
135
 
.TP
136
 
makeinfo \fB\-\-no\-headers\fR \fB\-o\fR - foo.texi
 
171
write HTML to @setfilename
 
172
.TP
 
173
makeinfo \fB\-\-xml\fR foo.texi
 
174
write Texinfo XML to @setfilename
 
175
.TP
 
176
makeinfo \fB\-\-docbook\fR foo.texi
 
177
write DocBook XML to @setfilename
 
178
.TP
 
179
makeinfo \fB\-\-no\-headers\fR foo.texi
137
180
write plain text to standard output
138
 
.TP
139
 
makeinfo \fB\-\-number\-sections\fR foo.texi
140
 
write Info with numbered sections
141
 
.TP
142
 
makeinfo \fB\-\-no\-split\fR foo.texi
143
 
write one Info file however big
 
181
.IP
 
182
makeinfo \fB\-\-html\fR \fB\-\-no\-headers\fR foo.texi write html without node lines, menus
 
183
makeinfo \fB\-\-number\-sections\fR foo.texi   write Info with numbered sections
 
184
makeinfo \fB\-\-no\-split\fR foo.texi          write one Info file however big
144
185
.SH "REPORTING BUGS"
145
 
Email bug reports to bug-texinfo@gnu.org,
146
 
general questions and discussion to help-texinfo@gnu.org.
 
186
Email bug reports to bug\-texinfo@gnu.org,
 
187
general questions and discussion to help\-texinfo@gnu.org.
 
188
Texinfo home page: http://www.gnu.org/software/texinfo/
147
189
.SH COPYRIGHT
148
 
Copyright \(co 2002 Free Software Foundation, Inc.
 
190
Copyright \(co 2004 Free Software Foundation, Inc.
149
191
There is NO warranty.  You may redistribute this software
150
192
under the terms of the GNU General Public License.
151
193
For more information about these matters, see the files named COPYING.