← Back to branch summary

~ubuntu-branches/debian/lenny/texinfo/lenny

« back to all changes in this revision

Viewing changes to doc/texi2dvi.1

  • Committer: Bazaar Package Importer
  • Author(s): Norbert Preining
  • Date: 2008-02-20 08:24:18 UTC
  • mfrom: (3.1.4 hardy)
  • Revision ID: james.westby@ubuntu.com-20080220082418-v0mwknqadr1gzkzm
Tags: 4.11.dfsg.1-4
http://bugs.debian.org/461352
fix bashism in texi2dvi (Closes: #461352)

Show diffs side-by-side

added added

removed removed

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