texi2dvi(1)

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

NAME

6       texi2dvi - convert Texinfo documents to DVI or PDF
7

SYNOPSIS

9       texi2dvi [OPTION]... FILE...
10       texi2pdf [OPTION]... FILE...
11       pdftexi2dvi [OPTION]... FILE...
12

DESCRIPTION

14       Run  each  Texinfo  or  (La)TeX  FILE  through  TeX  in  turn until all
15       cross-references are resolved, building  all  indices.   The  directory
16       containing  each  FILE  is  searched for included files.  The suffix of
17       FILE is used to  determine  its  language  ((La)TeX  or  Texinfo).   To
18       process (e)plain TeX files, set the environment variable LATEX=tex.
19
20       In  order  to  make  texi2dvi  a  drop-in  replacement  of TeX/LaTeX in
21       AUC-TeX, the FILE may also be composed of the following simple TeX com‐
22       mands.
23
24       `\input{FILE}'
25              the actual file to compile
26
27       `\nonstopmode'
28              same as --batch
29
30       When  invoked as `texi2pdf' or `pdftexi2dvi', or given the option --pdf
31       or --dvipdf, generate PDF output.  Otherwise, generate DVI.
32
33   General options:
34       -b, --batch
35              no interaction
36
37       -D, --debug
38              turn on shell debugging (set -x)
39
40       -h, --help
41              display this help and exit successfully
42
43       -o, --output=OFILE
44              leave output in OFILE; only one input FILE is allowed
45
46       -q, --quiet
47              no output unless errors (implies --batch)
48
49       -s, --silent
50              same as --quiet
51
52       -v, --version
53              display version information and exit successfully
54
55       -V, --verbose
56              report on what is done
57
58   Output format:
59       --dvi  output a DVI file [default]
60
61       --dvipdf
62              output a PDF file via DVI (using a dvi-to-pdf program)
63
64       --html output an HTML file from LaTeX, using HeVeA
65
66       --info output an Info file from LaTeX, using HeVeA
67
68       -p, --pdf
69              use pdftex or pdflatex for processing
70
71       --ps   output a PostScript file via DVI (using dvips)
72
73       --text output a plain text file from LaTeX, using HeVeA
74
75   TeX tuning:
76       -@     use @input instead of \input for preloaded Texinfo
77
78       -e, -E, --expand
79              force macro expansion using makeinfo
80
81       -I DIR search DIR for Texinfo files
82
83       -l, --language=LANG
84              specify LANG for FILE, either latex or texinfo
85
86       --no-line-error
87              do not pass --file-line-error to TeX
88
89       -r, --recode
90              call recode before TeX to translate input
91
92       --recode-from=ENC
93              recode from ENC to the @documentencoding
94
95       --shell-escape
96              pass --shell-escape to TeX
97
98       --src-specials
99              pass --src-specials to TeX
100
101       -t, --command=CMD
102              insert CMD in copy of input file
103
104       or --texinfo=CMD
105              multiple values accumulate
106
107       --translate-file=FILE
108              use given charset translation file for TeX
109
110   Build modes:
111       --build=MODE
112              specify the treatment of auxiliary files [local]
113
114       --tidy same as --build=tidy
115
116       -c, --clean
117              same as --build=clean
118
119       --build-dir=DIR
120              specify where the tidy compilation is performed; implies --tidy;
121              defaults to TEXI2DVI_BUILD_DIRECTORY [.]
122
123       --mostly-clean
124              remove the auxiliary files and directories but not the output
125
126       --max-iterations=N
127              don't process files more than N times
128
129       The  MODE  specifies  where  the TeX compilation takes place, and, as a
130       consequence, how auxiliary files are treated.  The build mode can  also
131       be set using the environment variable TEXI2DVI_BUILD_MODE.
132
133   Valid MODEs are:
134       `local'
135              compile  in  the  current  directory,  leaving all the auxiliary
136              files around.  This is the traditional TeX use.
137
138       `tidy' compile in a local *.t2d directory, where  the  auxiliary  files
139              are left.  Output files are copied back to the original file.
140
141       `clean'
142              same  as  `tidy', but remove the auxiliary directory afterwards.
143              Every compilation therefore requires the full cycle.
144
145   Using the `tidy' mode brings several advantages:
146              - the current directory is not cluttered with plethora of tempo‐
147              rary  files.   -  clutter  can  be  even  further  reduced using
148              --build-dir=dir: all the *.t2d
149
150              directories are stored there.
151
152              -   clutter   can   be   reduced   to    zero    using,    e.g.,
153              --build-dir=/tmp/$USER.t2d
154
155              or --build-dir=$HOME/.t2d.
156
157              - the output file is updated after every successful TeX run, for
158
159       sake of concurrent visualization of the output.
160              In a `local' build
161
162              the viewer stops during the whole TeX run.
163
164              -  if  the  compilation  fails, the previous state of the output
165              file
166
167              is preserved.
168
169              - PDF and DVI compilation are kept in separate subdirectories
170
171              preventing any possibility of auxiliary file incompatibility.
172
173       On the other hand, because `tidy' compilation takes  place  in  another
174       directory,  occasionally  TeX  won't  be able to find some files (e.g.,
175       when using \graphicspath): in that case, use -I to  specify  the  addi‐
176       tional directories to consider.
177
178       The values of the BIBTEX, DVIPDF, DVIPS, HEVEA, LATEX, MAKEINDEX, MAKE‐
179       INFO, PDFLATEX, PDFTEX, T4HT, TEX, TEX4HT, TEXINDEX, and THUMBPDF envi‐
180       ronment variables are used to run those commands, if they are set.
181
182       Regarding  --dvipdf,  if DVIPDF is not set in the environment, the fol‐
183       lowing programs are looked for (in this order): dvipdfmx dvipdfm dvipdf
184       dvi2pdf dvitopdf.
185
186       Any  CMD  strings are added after @setfilename for Texinfo input, or in
187       the first line for LaTeX input.
188

REPORTING BUGS

190       Report bugs to bug-texinfo@gnu.org, general questions and discussion to
191       help-texinfo@gnu.org.
192       GNU Texinfo home page: <http://www.gnu.org/software/texinfo/>
193       General help using GNU software: <http://www.gnu.org/gethelp/>
194

COPYRIGHT

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

NAME

SYNOPSIS

DESCRIPTION

REPORTING BUGS

COPYRIGHT

SEE ALSO