diff options
Diffstat (limited to 'Master/texmf/doc/man/man1/texi2dvi.1')
-rw-r--r-- | Master/texmf/doc/man/man1/texi2dvi.1 | 129 |
1 files changed, 109 insertions, 20 deletions
diff --git a/Master/texmf/doc/man/man1/texi2dvi.1 b/Master/texmf/doc/man/man1/texi2dvi.1 index 41fae2f7d5e..98a889f6c73 100644 --- a/Master/texmf/doc/man/man1/texi2dvi.1 +++ b/Master/texmf/doc/man/man1/texi2dvi.1 @@ -1,26 +1,33 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.33. -.TH TEXI2DVI "1" "February 2005" "texi2dvi 1.39" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.35. +.TH TEXI2DVI "1" "April 2008" "texi2dvi 1.122" "User Commands" .SH NAME -texi2dvi \- print Texinfo documents +texi2dvi \- convert Texinfo documents to DVI .SH SYNOPSIS .B texi2dvi [\fIOPTION\fR]... \fIFILE\fR... .SH DESCRIPTION -Run each Texinfo or LaTeX FILE through TeX in turn until all -cross-references are resolved, building all indices. The directory +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 (LaTeX or Texinfo). +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 Makeinfo is used to perform Texinfo macro expansion before running TeX when needed. -.SS "Operation modes:" +.SS "General options:" .TP \fB\-b\fR, \fB\-\-batch\fR no interaction .TP -\fB\-c\fR, \fB\-\-clean\fR -remove all auxiliary files -.TP \fB\-D\fR, \fB\-\-debug\fR turn on shell debugging (set \fB\-x\fR) .TP @@ -29,7 +36,7 @@ display this help and exit successfully .TP \fB\-o\fR, \fB\-\-output\fR=\fIOFILE\fR leave output in OFILE (implies \fB\-\-clean\fR); -Only one input FILE may be specified in this case +only one input FILE may be specified in this case .TP \fB\-q\fR, \fB\-\-quiet\fR no output unless errors (implies \fB\-\-batch\fR) @@ -44,8 +51,11 @@ display version information and exit successfully report on what is done .SS "TeX tuning:" .TP --@ -use @input instead of \einput; for preloaded Texinfo +\-@ +use @input instead of \einput for preloaded Texinfo +.TP +\fB\-\-dvi\fR +output a DVI file [default] .TP \fB\-e\fR, \fB\-E\fR, \fB\-\-expand\fR force macro expansion using makeinfo @@ -56,31 +66,110 @@ search DIR for Texinfo files \fB\-l\fR, \fB\-\-language\fR=\fILANG\fR specify the LANG of FILE (LaTeX or Texinfo) .TP +\fB\-\-no\-line\-error\fR +do not pass \fB\-\-file\-line\-error\fR to TeX +.TP \fB\-p\fR, \fB\-\-pdf\fR use pdftex or pdflatex for processing .TP \fB\-r\fR, \fB\-\-recode\fR -call recode before TeX to translate input characters +call recode before TeX to translate input +.TP +\fB\-\-recode\-from\fR=\fIENC\fR +recode from ENC to the @documentencoding +.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 +.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:" +.TP +\- +the current directory is not cluttered with plethora of temporary files. +.TP +\- +clutter can be even reduced using \fB\-\-build\-dir\fR=\fIdir\fR: all the *.t2d +directories are stored there. +.TP +\- +clutter can be reduced to zero using, e.g., \fB\-\-build\-dir=\fR/tmp/$USER.t2d +or \fB\-\-build\-dir=\fR$HOME/.t2d. +.TP +\- +the output file is updated after every succesful TeX run, for +sake of concurrent visualization of the output. In a `local' build +the viewer stops during the whole TeX run. +.TP +\- +if the compilation fails, the previous state of the output file +is preserved. +.TP +\- +PDF and DVI compilation are kept in separate subdirectories +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 BIBTEX, LATEX (or PDFLATEX), MAKEINDEX, MAKEINFO, TEX (or PDFTEX), TEXINDEX, and THUMBPDF environment variables are used to run those commands, if they are set. Any CMD strings are added after @setfilename for Texinfo input, in the first line for LaTeX input. .SH "REPORTING BUGS" -Email bug reports to <bug-texinfo@gnu.org>, -general questions and discussion to <help-texinfo@gnu.org>. +Email bug reports to <bug\-texinfo@gnu.org>, +general questions and discussion to <help\-texinfo@gnu.org>. Texinfo home page: http://www.gnu.org/software/texinfo/ .SH COPYRIGHT -Copyright \(co 2005 Free Software Foundation, Inc. -There is NO warranty. You may redistribute this software -under the terms of the GNU General Public License. -For more information about these matters, see the files named COPYING. +Copyright \(co 2008 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 |