Debian Codegraph @

texmf-dist/doc/man/man1/etex.1

raw
1 .TH ETEX 1 "1 March 2011" "Web2C 2015"
2 .\"=====================================================================
3 .if n .ds MF Metafont
4 .if t .ds MF M\s-2ETAFONT\s0
5 .if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP
6 .if n .ds TX TeX
7 .if n .ds MF Metafont
8 .if t .ds MF M\s-2ETAFONT\s0
9 .ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff
10 .el .ds OX TeX for nroff
11 .\" the same but obliqued
12 .\" BX definition must follow TX so BX can use TX
13 .if t .ds BX \fRB\s-2IB\s0\fP\*(TX
14 .if n .ds BX BibTeX
15 .\" LX definition must follow TX so LX can use TX
16 .if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
17 .if n .ds LX LaTeX
18 .if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX
19 .if n .ds AX AmSTeX
20 .if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX
21 .if n .ds AY AmSLaTeX
22 .if n .ds WB Web
23 .if t .ds WB W\s-2EB\s0
24 .\"=====================================================================
25 .SH NAME
26 etex \- extended (plain) TeX
27 .SH SYNOPSIS
28 .B etex
29 .RI [ options ]
30 .RI [ \fB&\fPformat ]
31 .RI [ file | \fB\e\fPcommands ]
32 .\"=====================================================================
33 .SH DESCRIPTION
34 Run the e-\*(TX typesetter on
35 .IR file ,
36 by default creating
37 .IR file.dvi .
38 If the file argument has no extension, ".tex" will be appended to it.
39 Instead of a filename, a set of e-\*(TX commands can be given, the first
40 of which must start with a backslash.
41 With a
42 .BI & format
43 argument e-\*(TX uses a different set of precompiled commands,
44 contained in
45 .IR format\fB.fmt\fP ;
46 it is usually better to use the
47 .B -fmt
48 .I format
49 option instead.
50 .PP
51 e-\*(TX is the first concrete result of an international research &
52 development project, the NTS Project, which was established under the
53 aegis of DANTE e.V. during 1992. The aims of the project are to
54 perpetuate and develop the spirit and philosophy of \*(TX, whilst
55 respecting Knuth's wish that \*(TX should remain frozen.
56 .PP
57 e-\*(TX can be used in two different modes: in
58 .I compatibility mode
59 it is supposed to be completely interchangable with standard \*(TX.
60 In
61 .I extended mode
62 several new primitives are added that facilitate (among other things)
63 bidirectional typesetting.
64 .PP
65 An extended mode format is generated by prefixing the name of the
66 source file for the format with an asterisk (*).
67 .PP
68 e-\*(TX's handling of its command-line arguments is similar to that of
69 the other \*(TX programs in the
70 .I web2c
71 implementation.
72 .\"=====================================================================
73 .SH OPTIONS
74 This version of e-\*(TX understands the following command line options.
75 .TP
76 .BI -fmt \ format
77 Use
78 .I format
79 as the name of the format to be used, instead of the name by which
80 e-\*(TX was called or a
81 .I %&
82 line.
83 .TP
84 .B -enc
85 Enable the enc\*(TX extensions. This option is only effective in
86 combination with
87 .BR -ini .
88 For documentation of the enc\*(TX extensions see
89 .BR http://www.olsak.net/enctex.html .
90 .TP
91 .B -etex
92 Enable the e-\*(TX extensions. This option is only effective in
93 combination with
94 .BR -ini .
95 .TP
96 .B -file-line-error
97 Print error messages in the form
98 .I file:line:error
99 which is similar to the way many compilers format them.
100 .TP
101 .B -no-file-line-error
102 Disable printing error messages in the
103 .I file:line:error
104 style.
105 .TP
106 .B -file-line-error-style
107 This is the old name of the
108 .B -file-line-error
109 option.
110 .TP
111 .B -halt-on-error
112 Exit with an error code when an error is encountered during processing.
113 .TP
114 .B -help
115 Print help message and exit.
116 .TP
117 .B -ini
118 Start in
119 .I INI
120 mode, which is used to dump formats. The
121 .I INI
122 mode can be used for typesetting, but no format is preloaded, and
123 basic initializations like setting catcodes may be required.
124 .TP
125 .BI -interaction \ mode
126 Sets the interaction mode. The mode can be either
127 .IR batchmode ,
128 .IR nonstopmode ,
129 .IR scrollmode ,
130 and
131 .IR errorstopmode .
132 The meaning of these modes is the same as that of the corresponding
133 \ecommands.
134 .TP
135 .B -ipc
136 Send DVI output to a socket as well as the usual output file. Whether
137 this option is available is the choice of the installer.
138 .TP
139 .B -ipc-start
140 As
141 .BR -ipc ,
142 and starts the server at the other end as well. Whether this option
143 is available is the choice of the installer.
144 .TP
145 .BI -jobname \ name
146 Use
147 .I name
148 for the job name, instead of deriving it from the name of the input file.
149 .TP
150 .BI -kpathsea-debug \ bitmask
151 Sets path searching debugging flags according to the bitmask. See the
152 .I Kpathsea
153 manual for details.
154 .TP
155 .BI -mktex \ fmt
156 Enable
157 .RI mktex fmt ,
158 where
159 .I fmt
160 must be either
161 .I tex
162 or
163 .IR tfm .
164 .TP
165 .B -mltex
166 Enable ML\*(TX extensions. Only effective in combination with
167 .BR -ini .
168 .TP
169 .BI -no-mktex \ fmt
170 Disable
171 .RI mktex fmt ,
172 where
173 .I fmt
174 must be either
175 .I tex
176 or
177 .IR tfm .
178 .TP
179 .BI -output-comment \ string
180 Use
181 .I string
182 for the
183 .I DVI
184 file comment instead of the date.
185 .TP
186 .BI -output-directory \ directory
187 Write output files in
188 .I directory
189 instead of the current directory. Look up input files in
190 .I directory
191 first, the along the normal search path.
192 .TP
193 .B -parse-first-line
194 If the first line of the main input file begins with
195 .I %&
196 parse it to look for a dump name or a
197 .B -translate-file
198 option.
199 .TP
200 .B -no-parse-first-line
201 Disable parsing of the first line of the main input file.
202 .TP
203 .BI -progname \ name
204 Pretend to be program
205 .IR name .
206 This affects both the format used and the search paths.
207 .TP
208 .B -recorder
209 Enable the filename recorder. This leaves a trace of the files opened
210 for input and output in a file with extension
211 .IR .fls .
212 .TP
213 .B -shell-escape
214 Enable the
215 .BI \ewrite18{ command }
216 construct. The
217 .I command
218 can be any shell command. This construct is normally
219 disallowed for security reasons.
220 .TP
221 .B -no-shell-escape
222 Disable the
223 .BI \ewrite18{ command }
224 construct, even if it is enabled in the
225 .I texmf.cnf
226 file.
227 .TP
228 .B -src-specials
229 Insert source specials into the
230 .I DVI
231 file.
232 .TP
233 .BI -src-specials \ where
234 Insert source specials in certain placed of the
235 .I DVI
236 file.
237 .I where
238 is a comma-separated value list:
239 .IR cr ,
240 .IR display ,
241 .IR hbox ,
242 .IR math ,
243 .IR par ,
244 .IR parent ,
245 or
246 .IR vbox .
247 .TP
248 .BI -translate-file \ tcxname
249 Use the
250 .I tcxname
251 translation table to set the mapping of input characters and
252 re-mapping of output characters.
253 .TP
254 .BI -default-translate-file \ tcxname
255 Like
256 .B -translate-file
257 except that a
258 .I %&
259 line can overrule this setting.
260 .TP
261 .B -version
262 Print version information and exit.
263 .\"=====================================================================
264 .SH ENVIRONMENT
265 See the Kpathsearch library documentation (the `Path specifications'
266 node) for precise details of how the environment variables are used.
267 The
268 .B kpsewhich
269 utility can be used to query the values of the variables.
270 .PP
271 One caveat: In most e-\*(TX formats, you cannot use ~ in a filename you
272 give directly to e-\*(TX, because ~ is an active character, and hence is
273 expanded, not taken as part of the filename. Other programs, such as
274 \*(MF, do not have this problem.
275 .PP
276 .TP
277 .B TEXMFOUTPUT
278 Normally, e-\*(TX puts its output files in the current directory. If
279 any output file cannot be opened there, it tries to open it in the
280 directory specified in the environment variable TEXMFOUTPUT.
281 There is no default value for that variable. For example, if you say
282 .I etex paper
283 and the current directory is not writable, if TEXMFOUTPUT has
284 the value
285 .IR /tmp ,
286 e-\*(TX attempts to create
287 .I /tmp/paper.log
288 (and
289 .IR /tmp/paper.dvi ,
290 if any output is produced.) TEXMFOUTPUT is also checked for input
291 files, as \*(TX often generates files that need to be subsequently
292 read; for input, no suffixes (such as ``.tex'') are added by default,
293 the input name is simply checked as given.
294 .TP
295 .B TEXINPUTS
296 Search path for
297 .I \einput
298 and
299 .I \eopenin
300 files.
301 This should start with ``.'', so
302 that user files are found before system files. An empty path
303 component will be replaced with the paths defined in the
304 .I texmf.cnf
305 file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the
306 current direcory and ``/home/user/tex'' to the standard search path.
307 .TP
308 .B TEXFORMATS
309 Search path for format files.
310 .TP
311 .B TEXPOOL
312 search path for
313 .B etex
314 internal strings.
315 .TP
316 .B TEXEDIT
317 Command template for switching to editor. The default, usually
318 .BR vi ,
319 is set when e-\*(TX is compiled.
320 .TP
321 .B TFMFONTS
322 Search path for font metric
323 .RI ( .tfm )
324 files.
325 .\"=====================================================================
326 .SH FILES
327 The location of the files mentioned below varies from system to
328 system. Use the
329 .B kpsewhich
330 utility to find their locations.
331 .TP
332 .I etex.pool
333 Text file containing e-\*(TX's internal strings.
334 .TP
335 .I texfonts.map
336 Filename mapping definitions.
337 .TP
338 .I *.tfm
339 Metric files for e-\*(TX's fonts.
340 .TP
341 .I *.fmt
342 Predigested e-\*(TX format (.\|fmt) files.
343 .\"=====================================================================
344 .SH NOTES
345 Starting with version 1.40, pdf\*(TX incorporates the e-\*(TX
346 extensions, so in this installation e\*(TX may be just a symbolic link to
347 pdf\*(TX. See
348 .BR pdftex (1).
349 This manual page is not meant to be exhaustive. The complete
350 documentation for this version of e-\*(TX can be found in the info
351 manual
352 .IR "Web2C: A TeX implementation" .
353 .\"=====================================================================
354 .SH BUGS
355 This version of e-\*(TX implements a number of optional extensions.
356 In fact, many of these extensions conflict to a greater or lesser
357 extent with the definition of e-\*(TX. When such extensions are
358 enabled, the banner printed when e-\*(TX starts is changed to print
359 .B e-TeXk
360 instead of
361 .BR e-TeX .
362 .PP
363 This version of e-\*(TX fails to trap arithmetic overflow when
364 dimensions are added or subtracted. Cases where this occurs are rare,
365 but when it does the generated
366 .I DVI
367 file will be invalid.
368 .\"=====================================================================
369 .SH "SEE ALSO"
370 .BR pdftex (1),
371 .BR tex (1),
372 .BR mf (1).
373 .\"=====================================================================
374 .SH AUTHORS
375 e-\*(TX was developed by Peter Breitenlohner and the NTS team; Peter
376 later continued its development outside of the team.
377 .PP
378 \*(TX was designed by Donald E. Knuth,
379 who implemented it using his \*(WB system for Pascal programs.
380 It was ported to Unix at Stanford by Howard Trickey, and
381 at Cornell by Pavel Curtis.
382 The version now offered with the Unix \*(TX distribution is that
383 generated by the \*(WB to C system
384 .RB ( web2c ),
385 originally written by Tomas Rokicki and Tim Morgan.
386 .PP
387 The enc\*(TX extensions were written by Petr Olsak.