contrib/texinfo/doc/pdftexi2dvi.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
   2 .TH TEXI2DVI "1" "September 2008" "texi2dvi 1.135" "User Commands"
   3 .SH NAME
   4 texi2dvi \- convert Texinfo documents to PDF
   5 .SH SYNOPSIS
   6 .B texi2dvi
   7 [\fIOPTION\fR]... \fIFILE\fR...
   8 .SH DESCRIPTION
   9 Run each Texinfo or (La)TeX FILE through TeX in turn until all
  10 cross\-references are resolved, building all indices.  The directory
  11 containing each FILE is searched for included files.  The suffix of FILE
  12 is used to determine its language ((La)TeX or Texinfo).  To process
  13 (e)plain TeX files, set the environment variable LATEX=tex.
  14 .PP
  15 In order to make texi2dvi a drop\-in replacement of TeX/LaTeX in AUC\-TeX,
  16 the FILE may also be composed of the following simple TeX commands.
  17 .TP
  18 `\einput{FILE}'
  19 the actual file to compile
  20 .TP
  21 `\enonstopmode'
  22 same as \fB\-\-batch\fR
  23 .PP
  24 Makeinfo is used to perform Texinfo macro expansion before running TeX
  25 when needed.
  26 .SS "General options:"
  27 .TP
  28 \fB\-b\fR, \fB\-\-batch\fR
  29 no interaction
  30 .TP
  31 \fB\-D\fR, \fB\-\-debug\fR
  32 turn on shell debugging (set \fB\-x\fR)
  33 .TP
  34 \fB\-h\fR, \fB\-\-help\fR
  35 display this help and exit successfully
  36 .TP
  37 \fB\-o\fR, \fB\-\-output\fR=\fIOFILE\fR
  38 leave output in OFILE (implies \fB\-\-clean\fR);
  39 only one input FILE may be specified in this case
  40 .TP
  41 \fB\-q\fR, \fB\-\-quiet\fR
  42 no output unless errors (implies \fB\-\-batch\fR)
  43 .TP
  44 \fB\-s\fR, \fB\-\-silent\fR
  45 same as \fB\-\-quiet\fR
  46 .TP
  47 \fB\-v\fR, \fB\-\-version\fR
  48 display version information and exit successfully
  49 .TP
  50 \fB\-V\fR, \fB\-\-verbose\fR
  51 report on what is done
  52 .SS "TeX tuning:"
  53 .TP
  54 \-@
  55 use @input instead of \einput for preloaded Texinfo
  56 .TP
  57 \fB\-\-dvi\fR
  58 output a DVI file [default]
  59 .TP
  60 \fB\-\-dvipdf\fR
  61 output a PDF file via DVI (using dvipdf)
  62 .TP
  63 \fB\-e\fR, \fB\-E\fR, \fB\-\-expand\fR
  64 force macro expansion using makeinfo
  65 .TP
  66 \fB\-I\fR DIR
  67 search DIR for Texinfo files
  68 .TP
  69 \fB\-l\fR, \fB\-\-language\fR=\fILANG\fR
  70 specify LANG for FILE, either latex or texinfo
  71 .TP
  72 \fB\-\-no\-line\-error\fR
  73 do not pass \fB\-\-file\-line\-error\fR to TeX
  74 .TP
  75 \fB\-p\fR, \fB\-\-pdf\fR
  76 use pdftex or pdflatex for processing
  77 .TP
  78 \fB\-r\fR, \fB\-\-recode\fR
  79 call recode before TeX to translate input
  80 .TP
  81 \fB\-\-recode\-from\fR=\fIENC\fR
  82 recode from ENC to the @documentencoding
  83 .TP
  84 \fB\-\-src\-specials\fR
  85 pass \fB\-\-src\-specials\fR to TeX
  86 .TP
  87 \fB\-t\fR, \fB\-\-command\fR=\fICMD\fR
  88 insert CMD in copy of input file
  89 .TP
  90 or \fB\-\-texinfo\fR=\fICMD\fR
  91 multiple values accumulate
  92 .TP
  93 \fB\-\-translate\-file\fR=\fIFILE\fR
  94 use given charset translation file for TeX
  95 .SS "Build modes:"
  96 .TP
  97 \fB\-\-build\fR=\fIMODE\fR
  98 specify the treatment of auxiliary files [local]
  99 .TP
 100 \fB\-\-tidy\fR
 101 same as \fB\-\-build\fR=\fItidy\fR
 102 .TP
 103 \fB\-c\fR, \fB\-\-clean\fR
 104 same as \fB\-\-build\fR=\fIclean\fR
 105 .TP
 106 \fB\-\-build\-dir\fR=\fIDIR\fR
 107 specify where the tidy compilation is performed;
 108 implies \fB\-\-tidy\fR;
 109 defaults to TEXI2DVI_BUILD_DIRECTORY [.]
 110 .TP
 111 \fB\-\-mostly\-clean\fR
 112 remove the auxiliary files and directories
 113 but not the output
 114 .PP
 115 The MODE specifies where the TeX compilation takes place, and, as a
 116 consequence, how auxiliary files are treated.  The build mode
 117 can also be set using the environment variable TEXI2DVI_BUILD_MODE.
 118 .SS "Valid MODEs are:"
 119 .TP
 120 `local'
 121 compile in the current directory, leaving all the auxiliary
 122 files around.  This is the traditional TeX use.
 123 .TP
 124 `tidy'
 125 compile in a local *.t2d directory, where the auxiliary files
 126 are left.  Output files are copied back to the original file.
 127 .TP
 128 `clean'
 129 same as `tidy', but remove the auxiliary directory afterwards.
 130 Every compilation therefore requires the full cycle.
 131 .SS "Using the `tidy' mode brings several advantages:"
 132 .TP
 133 \-
 134 the current directory is not cluttered with plethora of temporary files.
 135 .TP
 136 \-
 137 clutter can be even reduced using \fB\-\-build\-dir\fR=\fIdir\fR: all the *.t2d
 138 directories are stored there.
 139 .TP
 140 \-
 141 clutter can be reduced to zero using, e.g., \fB\-\-build\-dir=\fR/tmp/$USER.t2d
 142 or \fB\-\-build\-dir=\fR$HOME/.t2d.
 143 .TP
 144 \-
 145 the output file is updated after every succesful TeX run, for
 146 sake of concurrent visualization of the output.  In a `local' build
 147 the viewer stops during the whole TeX run.
 148 .TP
 149 \-
 150 if the compilation fails, the previous state of the output file
 151 is preserved.
 152 .TP
 153 \-
 154 PDF and DVI compilation are kept in separate subdirectories
 155 preventing any possibility of auxiliary file incompatibility.
 156 .PP
 157 On the other hand, because `tidy' compilation takes place in another
 158 directory, occasionally TeX won't be able to find some files (e.g., when
 159 using \egraphicspath): in that case use \fB\-I\fR to specify the additional
 160 directories to consider.
 161 .PP
 162 The values of the BIBTEX, LATEX (or PDFLATEX), MAKEINDEX, MAKEINFO,
 163 TEX (or PDFTEX), TEXINDEX, and THUMBPDF environment variables are used
 164 to run those commands, if they are set.  Any CMD strings are added
 165 after @setfilename for Texinfo input, in the first line for LaTeX input.
 166 .SH "REPORTING BUGS"
 167 Email bug reports to <bug\-texinfo@gnu.org>,
 168 general questions and discussion to <help\-texinfo@gnu.org>.
 169 Texinfo home page: http://www.gnu.org/software/texinfo/
 170 .SH COPYRIGHT
 171 Copyright \(co 2008 Free Software Foundation, Inc.
 172 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
 173 .br
 174 This is free software: you are free to change and redistribute it.
 175 There is NO WARRANTY, to the extent permitted by law.
 176 .SH "SEE ALSO"
 177 The full documentation for
 178 .B texi2dvi
 179 is maintained as a Texinfo manual.  If the
 180 .B info
 181 and
 182 .B texi2dvi
 183 programs are properly installed at your site, the command
 184 .IP
 185 .B info texi2dvi
 186 .PP
 187 should give you access to the complete manual.