summaryrefslogtreecommitdiff
path: root/macros/texinfo/texinfo/man/texi2dvi.1
blob: b73edb871e331e4dc9018489957f75ceee9f8ad8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.13.
.TH TEXI2DVI "1" "November 2022" "texi2dvi 7.0.1)" "User Commands"
.SH NAME
texi2dvi (GNU Texinfo \- convert Texinfo documents to DVI or PDF
.SH SYNOPSIS
.B texi2dvi
[\fI\,OPTION\/\fR]... \fI\,FILE\/\fR...
.br
.B texi2pdf
[\fI\,OPTION\/\fR]... \fI\,FILE\/\fR...
.br
.B pdftexi2dvi
[\fI\,OPTION\/\fR]... \fI\,FILE\/\fR...
.SH DESCRIPTION
Run each Texinfo or (La)TeX FILE through TeX in turn until all
cross\-references are resolved, building all indices.  The directory
containing each FILE is searched for included files.  The suffix of FILE
is used to determine its language ((La)TeX or Texinfo).  To process
(e)plain TeX files, set the environment variable LATEX=tex.
.PP
When invoked as `texi2pdf' or given the option \fB\-\-pdf\fR generate PDF output.
Otherwise, generate DVI.
.SS "General options:"
.TP
\fB\-D\fR, \fB\-\-debug\fR
turn on shell debugging (set \fB\-x\fR)
.TP
\fB\-h\fR, \fB\-\-help\fR
display this help and exit successfully
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,OFILE\/\fR
leave output in OFILE; only one input FILE is allowed
.TP
\fB\-q\fR, \fB\-\-quiet\fR
no output unless errors
.TP
\fB\-v\fR, \fB\-\-version\fR
display version information and exit successfully
.TP
\fB\-V\fR, \fB\-\-verbose\fR
report on what is done
.TP
\fB\-\-max\-iterations\fR=\fI\,N\/\fR
don't process files more than N times [7]
.TP
\fB\-\-mostly\-clean\fR
remove auxiliary files or directories from
previous runs (but not the output)
.SS "Output format:"
.TP
\fB\-\-dvi\fR
output a DVI file [default]
.TP
\fB\-\-dvipdf\fR
output a PDF file via DVI (using a dvi\-to\-pdf program)
.TP
\fB\-\-html\fR
output an HTML file from LaTeX, using HeVeA
.TP
\fB\-\-info\fR
output an Info file from LaTeX, using HeVeA
.TP
\fB\-p\fR, \fB\-\-pdf\fR
use pdftex or pdflatex for processing
.TP
\fB\-\-ps\fR
output a PostScript file via DVI (using dvips)
.TP
\fB\-\-text\fR
output a plain text file from LaTeX, using HeVeA
.SS "TeX tuning:"
.TP
\fB\-E\fR, \fB\-\-expand\fR
macro expansion using makeinfo
.TP
\fB\-I\fR DIR
search DIR for Texinfo files
.TP
\fB\-l\fR, \fB\-\-language\fR=\fI\,LANG\/\fR
specify LANG for FILE, either latex or texinfo
.TP
\fB\-\-no\-line\-error\fR
do not pass \fB\-\-file\-line\-error\fR to TeX
.TP
\fB\-\-shell\-escape\fR
pass \fB\-\-shell\-escape\fR to TeX
.TP
\fB\-\-src\-specials\fR
pass \fB\-\-src\-specials\fR to TeX
.TP
\fB\-\-translate\-file\fR=\fI\,FILE\/\fR
use given charset translation file for TeX
.TP
\fB\-t\fR, \fB\-\-command\fR=\fI\,CMD\/\fR
insert CMD in copy of input file
.SS "Build modes:"
.TP
\fB\-\-build\fR=\fI\,MODE\/\fR
specify the treatment of auxiliary files [local]
.TP
\fB\-\-tidy\fR
same as \fB\-\-build\fR=\fI\,tidy\/\fR
.TP
\fB\-c\fR, \fB\-\-clean\fR
same as \fB\-\-build\fR=\fI\,clean\/\fR
.TP
\fB\-\-build\-dir\fR=\fI\,DIR\/\fR
specify where the tidy compilation is performed;
implies \fB\-\-tidy\fR;
defaults to TEXI2DVI_BUILD_DIRECTORY [.]
.PP
The MODE specifies where the TeX compilation takes place, and, as a
consequence, how auxiliary files are treated.  The build mode can also
be set using the environment variable TEXI2DVI_BUILD_MODE.
.SS "Valid values of MODE are:"
.TP
`local'
compile in the current directory, leaving all the auxiliary
files around.  This is the traditional TeX use.
.TP
`tidy'
compile in a local *.t2d directory, where the auxiliary files
are left.  Output files are copied back to the original file.
.TP
`clean'
same as `tidy', but remove the auxiliary directory afterwards.
Every compilation therefore requires the full cycle.
.PP
The values of these environment variables are used to run the
corresponding commands, if they are set:
.IP
BIBER BIBTEX DVIPDF DVIPS EGREP HEVEA LATEX MAKEINDEX MAKEINFO
PDFLATEX PDFTEX SED T4HT TEX TEX4HT TEXINDEX TEXINDY THUMBPDF_CMD
.PP
Regarding \fB\-\-dvipdf\fR, if DVIPDF is not set in the environment, the
following programs are looked for (in this order): dvipdfmx dvipdfm
dvipdf dvi2pdf dvitopdf.
.PP
If Texinfo is installed on your site, then the command
.IP
info texi2dvi
.PP
should give you access to more documentation.
.SH "REPORTING BUGS"
Report bugs to bug\-texinfo@gnu.org,
general questions and discussion to help\-texinfo@gnu.org.
.br
GNU Texinfo home page: <http://www.gnu.org/software/texinfo/>
.br
General help using GNU software: <http://www.gnu.org/gethelp/>
.SH COPYRIGHT
Copyright \(co 2022 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
The full documentation for
.B texi2dvi
is maintained as a Texinfo manual.  If the
.B info
and
.B texi2dvi
programs are properly installed at your site, the command
.IP
.B info texi2dvi
.PP
should give you access to the complete manual.