1 .TH ETEX 1 "16 June 2015" "Web2C @VERSION@"
2 .\"=====================================================================
5 .if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP
7 .ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP
9 .\" BX definition must follow TX so BX can use TX
10 .if t .ds BX \fRB\s-2IB\s0\fP\*(TX
12 .\" LX definition must follow TX so LX can use TX
13 .if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
15 .if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX
17 .if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX
20 .if t .ds WB W\s-2EB\s0
21 .\"=====================================================================
23 etex \- extended (plain) TeX
28 .RI [ file | \fB\e\fPcommands ]
29 .\"=====================================================================
31 Run the e-\*(TX typesetter on
35 If the file argument has no extension, ".tex" will be appended to it.
36 Instead of a filename, a set of e-\*(TX commands can be given, the first
37 of which must start with a backslash.
40 argument e-\*(TX uses a different set of precompiled commands,
42 .IR format\fB.fmt\fP ;
43 it is usually better to use the
48 e-\*(TX is the first concrete result of an international research &
49 development project, the NTS Project, which was established under the
50 aegis of DANTE e.V. during 1992. The aims of the project are to
51 perpetuate and develop the spirit and philosophy of \*(TX, whilst
52 respecting Knuth's wish that \*(TX should remain frozen.
54 e-\*(TX can be used in two different modes: in
56 it is supposed to be completely interchangable with standard \*(TX.
59 several new primitives are added that facilitate (among other things)
60 bidirectional typesetting.
62 An extended mode format is generated by prefixing the name of the
63 source file for the format with an asterisk (*).
65 e-\*(TX's handling of its command-line arguments is similar to that of
66 the other \*(TX programs in the
69 .\"=====================================================================
71 This version of e-\*(TX understands the following command line options.
76 as the name of the format to be used, instead of the name by which
77 e-\*(TX was called or a
82 Enable the enc\*(TX extensions. This option is only effective in
85 For documentation of the enc\*(TX extensions see
86 .BR http://www.olsak.net/enctex.html .
89 Enable the e-\*(TX extensions. This option is only effective in
94 Print error messages in the form
96 which is similar to the way many compilers format them.
98 .B -no-file-line-error
99 Disable printing error messages in the
103 .B -file-line-error-style
104 This is the old name of the
109 Exit with an error code when an error is encountered during processing.
112 Print help message and exit.
117 mode, which is used to dump formats. The
119 mode can be used for typesetting, but no format is preloaded, and
120 basic initializations like setting catcodes may be required.
122 .BI -interaction \ mode
123 Sets the interaction mode. The mode can be either
129 The meaning of these modes is the same as that of the corresponding
133 Send DVI output to a socket as well as the usual output file. Whether
134 this option is available is the choice of the installer.
139 and starts the server at the other end as well. Whether this option
140 is available is the choice of the installer.
145 for the job name, instead of deriving it from the name of the input file.
147 .BI -kpathsea-debug \ bitmask
148 Sets path searching debugging flags according to the bitmask. See the
163 Enable ML\*(TX extensions. Only effective in combination with
176 .BI -output-comment \ string
181 file comment instead of the date.
183 .BI -output-directory \ directory
184 Write output files in
186 instead of the current directory. Look up input files in
188 first, the along the normal search path.
191 If the first line of the main input file begins with
193 parse it to look for a dump name or a
197 .B -no-parse-first-line
198 Disable parsing of the first line of the main input file.
201 Pretend to be program
203 This affects both the format used and the search paths.
206 Enable the filename recorder. This leaves a trace of the files opened
207 for input and output in a file with extension
212 .BI \ewrite18{ command }
215 can be any shell command. This construct is normally
216 disallowed for security reasons.
220 .BI \ewrite18{ command }
221 construct, even if it is enabled in the
226 Insert source specials into the
230 .BI -src-specials \ where
231 Insert source specials in certain placed of the
235 is a comma-separated value list:
245 .BI -translate-file \ tcxname
248 translation table to set the mapping of input characters and
249 re-mapping of output characters.
251 .BI -default-translate-file \ tcxname
256 line can overrule this setting.
259 Print version information and exit.
260 .\"=====================================================================
262 See the Kpathsearch library documentation (the `Path specifications'
263 node) for precise details of how the environment variables are used.
266 utility can be used to query the values of the variables.
268 One caveat: In most e-\*(TX formats, you cannot use ~ in a filename you
269 give directly to e-\*(TX, because ~ is an active character, and hence is
270 expanded, not taken as part of the filename. Other programs, such as
271 \*(MF, do not have this problem.
275 Normally, e-\*(TX puts its output files in the current directory. If
276 any output file cannot be opened there, it tries to open it in the
277 directory specified in the environment variable TEXMFOUTPUT.
278 There is no default value for that variable. For example, if you say
280 and the current directory is not writable, if TEXMFOUTPUT has
283 e-\*(TX attempts to create
287 if any output is produced.) TEXMFOUTPUT is also checked for input
288 files, as \*(TX often generates files that need to be subsequently
289 read; for input, no suffixes (such as ``.tex'') are added by default,
290 the input name is simply checked as given.
298 This should start with ``.'', so
299 that user files are found before system files. An empty path
300 component will be replaced with the paths defined in the
302 file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the
303 current direcory and ``/home/user/tex'' to the standard search path.
306 Search path for format files.
314 Command template for switching to editor. The default, usually
316 is set when e-\*(TX is compiled.
319 Search path for font metric
322 .\"=====================================================================
324 The location of the files mentioned below varies from system to
327 utility to find their locations.
330 Text file containing e-\*(TX's internal strings.
333 Filename mapping definitions.
336 Metric files for e-\*(TX's fonts.
339 Predigested e-\*(TX format (.\|fmt) files.
340 .\"=====================================================================
342 Starting with version 1.40, pdf\*(TX incorporates the e-\*(TX
343 extensions, so in this installation e\*(TX may be just a symbolic link to
346 This manual page is not meant to be exhaustive. The complete
347 documentation for this version of e-\*(TX can be found in the info
349 .IR "Web2C: A TeX implementation" .
350 .\"=====================================================================
352 This version of e-\*(TX implements a number of optional extensions.
353 In fact, many of these extensions conflict to a greater or lesser
354 extent with the definition of e-\*(TX. When such extensions are
355 enabled, the banner printed when e-\*(TX starts is changed to print
360 This version of e-\*(TX fails to trap arithmetic overflow when
361 dimensions are added or subtracted. Cases where this occurs are rare,
362 but when it does the generated
364 file will be invalid.
365 .\"=====================================================================
370 .\"=====================================================================
372 e-\*(TX was developed by Peter Breitenlohner and the NTS team; Peter
373 later continued its development outside of the team.
375 \*(TX was designed by Donald E. Knuth,
376 who implemented it using his \*(WB system for Pascal programs.
377 It was ported to Unix at Stanford by Howard Trickey, and
378 at Cornell by Pavel Curtis.
379 The version now offered with the Unix \*(TX distribution is that
380 generated by the \*(WB to C system
382 originally written by Tomas Rokicki and Tim Morgan.
384 The enc\*(TX extensions were written by Petr Olsak.