1ETEX(1) Web2C 7.5.6 ETEX(1)
2
6 etex, einitex, evirtex - extended TeX
7
9 etex [options] [& format ] [ file | \ commands ]
10
12 Run the e-TeX typesetter on file, usually creating file.dvi. If the
13 file argument has no extension, ".tex" will be appended to it. Instead
14 of a filename, a set of e-TeX commands can be given, the first of which
15 must start with a backslash. With a &format argument e-TeX uses a dif‐
16 ferent set of precompiled commands, contained in format.fmt; it is usu‐
17 ally better to use the -fmt format option instead.
18 e-TeX is the first concrete result of an international research &
20 development project, the NTS Project, which was established under the
21 aegis of DANTE e.V. during 1992. The aims of the project are to perpet‐
22 uate and develop the spirit and philosophy of TeX, whilst respecting
23 Knuth's wish that TeX should remain frozen.
24 e-TeX can be used in two different modes: in compatibility mode it is
26 supposed to be completely interchangable with standard TeX. In
27 extended mode several new primitives are added that facilitate (among
28 other things) bidirectional typesetting.
29 An extended mode format is generated by prefixing the name of the
31 source file for the format with an asterisk (*). Such formats are
32 often prefixed with an `e', hence etex as the extended version of tex
33 and elatex as the extended version of latex. However, eplain is an
34 exception to this rule.
35 The einitex and evirtex commands are e-TeX's analogues to the initex
37 and virtex commands. In this installation, they are symbolic links to
38 the etex executable. These symbolic links may not exist at all.
39 e-TeX's handling of its command-line arguments is similar to that of
41 the other TeX programs in the web2c implementation.
42
44 This version of e-TeX understands the following command line options.
45 -fmt format
47 Use format as the name of the format to be used, instead of the
48 name by which e-TeX was called or a %& line.
49 -enc Enable the encTeX extensions. This option is only effective in
51 combination with -ini. For documentation of the encTeX exten‐
52 sions see http://www.olsak.net/enctex.html.
53 -etex Enable the e-TeX extensions. This option is only effective in
55 combination with -ini.
56 -file-line-error
58 Print error messages in the form file:line:error which is simi‐
59 lar to the way many compilers format them.
60 -no-file-line-error
62 Disable printing error messages in the file:line:error style.
63 -file-line-error-style
65 This is the old name of the -file-line-error option.
66 -halt-on-error
68 Exit with an error code when an error is encountered during pro‐
69 cessing.
70 -help Print help message and exit.
72 -ini Start in INI mode, which is used to dump formats. The INI mode
74 can be used for typesetting, but no format is preloaded, and
75 basic initializations like setting catcodes may be required.
76 -interaction mode
78 Sets the interaction mode. The mode can be either batchmode,
79 nonstopmode, scrollmode, and errorstopmode. The meaning of
80 these modes is the same as that of the corresponding \commands.
81 -ipc Send DVI output to a socket as well as the usual output file.
83 Whether this option is available is the choice of the installer.
84 -ipc-start
86 As -ipc, and starts the server at the other end as well.
87 Whether this option is available is the choice of the installer.
88 -jobname name
90 Use name for the job name, instead of deriving it from the name
91 of the input file.
92 -kpathsea-debug bitmask
94 Sets path searching debugging flags according to the bitmask.
95 See the Kpathsea manual for details.
96 -mktex fmt
98 Enable mktexfmt, where fmt must be either tex or tfm.
99 -mltex Enable MLTeX extensions. Only effective in combination with
101 -ini.
102 -no-mktex fmt
104 Disable mktexfmt, where fmt must be either tex or tfm.
105 -output-comment string
107 Use string for the DVI file comment instead of the date.
108 -output-directory directory
110 directory instead of the current directory. Look up input files
111 in directory first, the along the normal search path.
112 -parse-first-line
114 If the first line of the main input file begins with %& parse it
115 to look for a dump name or a -translate-file option.
116 -no-parse-first-line
118 Disable parsing of the first line of the main input file.
119 -progname name
121 Pretend to be program name. This affects both the format used
122 and the search paths.
123 -recorder
125 Enable the filename recorder. This leaves a trace of the files
126 opened for input and output in a file with extension .fls.
127 -shell-escape
129 Enable the \write18{command} construct. The command can be any
130 shell command. This construct is normally disallowed for secu‐
131 rity reasons.
132 -no-shell-escape
134 Disable the \write18{command} construct, even if it is enabled
135 in the texmf.cnf file.
136 -src-specials
138 Insert source specials into the DVI file.
139 -src-specials where
141 Insert source specials in certain placed of the DVI file. where
142 is a comma-separated value list: cr, display, hbox, math, par,
143 parent, or vbox.
144 -translate-file tcxname
146 Use the tcxname translation table to set the mapping of input
147 characters and re-mapping of output characters.
148 -default-translate-file tcxname
150 Like -translate-file except that a %& line can overrule this
151 setting.
152 -version
154 Print version information and exit.
155
157 See the Kpathsearch library documentation (the `Path specifications'
158 node) for precise details of how the environment variables are used.
159 The kpsewhich utility can be used to query the values of the variables.
160 One caveat: In most e-TeX formats, you cannot use ~ in a filename you
162 give directly to e-TeX, because ~ is an active character, and hence is
163 expanded, not taken as part of the filename. Other programs, such as
164 Metafont, do not have this problem.
165 TEXMFOUTPUT
167 Normally, e-TeX puts its output files in the current directory.
168 If any output file cannot be opened there, it tries to open it
169 in the directory specified in the environment variable TEXMFOUT‐
170 PUT. There is no default value for that variable. For example,
171 if you say etex paper and the current directory is not writable,
172 if TEXMFOUTPUT has the value /tmp, e-TeX attempts to create
173 /tmp/paper.log (and /tmp/paper.dvi, if any output is produced.)
174 TEXINPUTS
176 Search path for \input and \openin files. This should probably
177 start with ``.'', so that user files are found before system
178 files. An empty path component will be replaced with the paths
179 defined in the texmf.cnf file. For example, set TEXINPUTS to
180 ".:/home/usr/tex:" to prepend the current direcory and
181 ``/home/user/tex'' to the standard search path.
182 TEXFORMATS
184 Search path for format files.
185 TEXPOOL
187 search path for etex internal strings.
188 TEXEDIT
190 Command template for switching to editor. The default, usually
191 vi, is set when e-TeX is compiled.
192 TFMFONTS
194 Search path for font metric (.tfm) files.
195
197 The location of the files mentioned below varies from system to system.
198 Use the kpsewhich utility to find their locations.
199 etex.pool
201 Text file containing e-TeX's internal strings.
202 texfonts.map
204 Filename mapping definitions.
205 *.tfm Metric files for e-TeX's fonts.
207 *.fmt Predigested e-TeX format (.fmt) files.
209
211 Starting with version 1.40, pdfTeX incorporates the e-TeX extensions,
212 so in this installation eTeX is just a symbolic link to pdfTeX. See
213 pdftex(1). This manual page is not meant to be exhaustive. The com‐
214 plete documentation for this version of e-TeX can be found in the info
215 manual Web2C: A TeX implementation.
216
218 This version of e-TeX implements a number of optional extensions. In
219 fact, many of these extensions conflict to a greater or lesser extent
220 with the definition of e-TeX. When such extensions are enabled, the
221 banner printed when e-TeX starts is changed to print e-TeXk instead of
222 e-TeX.
223 This version of e-TeX fails to trap arithmetic overflow when dimensions
225 are added or subtracted. Cases where this occurs are rare, but when it
226 does the generated DVI file will be invalid.
227
229 pdftex(1), tex(1), mf(1).
230
232 e-TeX was developed by Peter Breitenlohner (and the NTS team).
233 TeX was designed by Donald E. Knuth, who implemented it using his sys‐
235 tem for Pascal programs. It was ported to Unix at Stanford by Howard
236 Trickey, and at Cornell by Pavel Curtis. The version now offered with
237 the Unix TeX distribution is that generated by the to C system
238 (web2c), originally written by Tomas Rokicki and Tim Morgan.
239 The encTeX extensions were written by Petr Olsak.
241pdftex 1.40 7 January 2007 ETEX(1)