.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.43.3.
.TH TEXI2DVI "1" "September 2013" "texi2dvi 5381" "User Commands"
.SH NAME
texi2dvi \- convert Texinfo documents to DVI or PDF
.SH SYNOPSIS
.B texi2dvi
[\fIOPTION\fR]... \fIFILE\fR...
.br
.B texi2pdf
[\fIOPTION\fR]... \fIFILE\fR...
.br
.B pdftexi2dvi
[\fIOPTION\fR]... \fIFILE\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
In order to make texi2dvi a drop\-in replacement of TeX/LaTeX in AUC\-TeX,
the FILE may also be composed of the following simple TeX commands.
.TP
`\einput{FILE}'
the actual file to compile
.TP
`\enonstopmode'
same as \fB\-\-batch\fR
.PP
When invoked as `texi2pdf' or `pdftexi2dvi', or given the option \fB\-\-pdf\fR
or \fB\-\-dvipdf\fR, generate PDF output.  Otherwise, generate DVI.
.SS "General options:"
.TP
\fB\-b\fR, \fB\-\-batch\fR
no interaction
.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=\fIOFILE\fR
leave output in OFILE; only one input FILE is allowed
.TP
\fB\-q\fR, \fB\-\-quiet\fR
no output unless errors (implies \fB\-\-batch\fR)
.TP
\fB\-s\fR, \fB\-\-silent\fR
same as \fB\-\-quiet\fR
.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
.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
\-@
use @input instead of \einput for preloaded Texinfo
.TP
\fB\-e\fR, \fB\-E\fR, \fB\-\-expand\fR
force macro expansion using makeinfo
.TP
\fB\-I\fR DIR
search DIR for Texinfo files
.TP
\fB\-l\fR, \fB\-\-language\fR=\fILANG\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\-r\fR, \fB\-\-recode\fR
call recode before TeX to translate input
.TP
\fB\-\-recode\-from\fR=\fIENC\fR
recode from ENC to the @documentencoding
.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\-t\fR, \fB\-\-command\fR=\fICMD\fR
insert CMD in copy of input file
.TP
or \fB\-\-texinfo\fR=\fICMD\fR
multiple values accumulate
.TP
\fB\-\-translate\-file\fR=\fIFILE\fR
use given charset translation file for TeX
.SS "Build modes:"
.TP
\fB\-\-build\fR=\fIMODE\fR
specify the treatment of auxiliary files [local]
.TP
\fB\-\-tidy\fR
same as \fB\-\-build\fR=\fItidy\fR
.TP
\fB\-c\fR, \fB\-\-clean\fR
same as \fB\-\-build\fR=\fIclean\fR
.TP
\fB\-\-build\-dir\fR=\fIDIR\fR
specify where the tidy compilation is performed;
implies \fB\-\-tidy\fR;
defaults to TEXI2DVI_BUILD_DIRECTORY [.]
.TP
\fB\-\-mostly\-clean\fR
remove the auxiliary files and directories
but not the output
.TP
\fB\-\-max\-iterations\fR=\fIN\fR
don't process files more than N times
.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 MODEs 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.
.SS "Using the `tidy' mode brings several advantages:"
.IP
\- the current directory is not cluttered with plethora of temporary files.
\- clutter can be even further reduced using \fB\-\-build\-dir\fR=\fIdir\fR: all the *.t2d
.IP
directories are stored there.
.IP
\- clutter can be reduced to zero using, e.g., \fB\-\-build\-dir=\fR/tmp/$USER.t2d
.IP
or \fB\-\-build\-dir=\fR$HOME/.t2d.
.IP
\- the output file is updated after every successful TeX run, for
.TP
sake of concurrent visualization of the output.
In a `local' build
.IP
the viewer stops during the whole TeX run.
.IP
\- if the compilation fails, the previous state of the output file
.IP
is preserved.
.IP
\- PDF and DVI compilation are kept in separate subdirectories
.IP
preventing any possibility of auxiliary file incompatibility.
.PP
On the other hand, because `tidy' compilation takes place in another
directory, occasionally TeX won't be able to find some files (e.g., when
using \egraphicspath): in that case, use \fB\-I\fR to specify the additional
directories to consider.
.PP
The values of the BIBER, BIBTEX, DVIPDF, DVIPS, HEVEA, LATEX, MAKEINDEX,
MAKEINFO, PDFLATEX, PDFTEX, T4HT, TEX, TEX4HT, TEXINDEX, and THUMBPDF
environment variables are used to run those commands, if they are set.
.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
Any CMD strings are added after @setfilename for Texinfo input, or in
the first line for LaTeX input.
.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 2013 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.