1PDFETEX(1) Web2C 7.5.6 PDFETEX(1)
2
6 pdfetex, pdfeinitex, pdfevirtex - PDF output from e-TeX
7
9 pdfetex [options] [& format ] [ file | \ commands ]
10
12 Run the pdfeTeX typesetter on file, usually creating file.pdf. If the
13 file argument has no extension, ".tex" will be appended to it. Instead
14 of a filename, a set of pdfeTeX commands can be given, the first of
15 which must start with a backslash. With a &format argument pdfeTeX
16 uses a different set of precompiled commands, contained in format.fmt;
17 it is usually better to use the -fmt format option instead.
18 pdfeTeX is a version of e-TeX that can create PDF files as well as DVI
20 files.
21 In DVI mode, pdfeTeX can be used as a complete replacement of the e-TeX
23 engine.
24 The typical use of pdfeTeX is with a pregenerated formats for which PDF
26 output has been enabled. The pdfetex command uses the equivalent of
27 the plain e-TeX format, and the pdfelatex command uses the equivalent
28 of the e-LaTeX format. To generate formats, use the -ini switch.
29 The pdfeinitex and pdfevirtex commands are pdfeTeX's analogues to the
31 einitex and evirtex commands. In this installation, they are symbolic
32 links to the pdfetex executable. These symbolic links may not exist at
33 all.
34 In PDF mode, pdfeTeX can natively handle the PDF, JPG, JBIG2, and PNG
36 graphics formats. pdfeTeX cannot include PostScript or Encapsulated
37 PostScript (EPS) graphics files; first convert them to PDF using
38 epstopdf(1). pdfeTeX's handling of its command-line arguments is simi‐
39 lar to that of of the other TeX programs in the web2c implementation.
40
42 This version of pdfeTeX understands the following command line options.
43 -draftmode
45 Sets \pdfdraftmode so pdfTeX doesn't write a PDF and doesn't
46 read any included images, thus speeding up execution.
47 -enc Enable the encTeX extensions. This option is only effective in
49 combination with
50 -etex Enable the e-TeX extensions. This option is only effective in
52 combination with -ini. See etex(1).
53 -ini. For documentation of the encTeX extensions see
55 http://www.olsak.net/enctex.html. -file-line-error Print error
56 messages in the form file:line:error which is similar to the way
57 many compilers format them.
58 -no-file-line-error
60 Disable printing error messages in the file:line:error style.
61 -file-line-error-style
63 This is the old name of the -file-line-error option.
64 -fmt format
66 Use format as the name of the format to be used, instead of the
67 name by which pdfeTeX was called or a %& line.
68 -halt-on-error
70 Exit with an error code when an error is encountered during pro‐
71 cessing.
72 -help Print help message and exit.
74 -ini Start in INI mode, which is used to dump formats. The INI mode
76 can be used for typesetting, but no format is preloaded, and
77 basic initializations like setting catcodes may be required.
78 -interaction mode
80 Sets the interaction mode. The mode can be either batchmode,
81 nonstopmode, scrollmode, and errorstopmode. The meaning of
82 these modes is the same as that of the corresponding \commands.
83 -ipc Send DVI or PDF output to a socket as well as the usual output
85 file. Whether this option is available is the choice of the in‐
86 staller.
87 -ipc-start
89 As -ipc, and starts the server at the other end as well.
90 Whether this option is available is the choice of the installer.
91 -jobname name
93 Use name for the job name, instead of deriving it from the name
94 of the input file.
95 -kpathsea-debug bitmask
97 Sets path searching debugging flags according to the bitmask.
98 See the Kpathsea manual for details.
99 -mktex fmt
101 Enable mktexfmt, where fmt must be either tex or tfm.
102 -mltex Enable MLTeX extensions. Only effective in combination with
104 -ini.
105 -no-mktex fmt
107 Disable mktexfmt, where fmt must be either tex or tfm.
108 -output-comment string
110 In DVI mode, use string for the DVI file comment instead of the
111 date. This option is ignored in PDF mode.
112 -output-directory directory
114 directory instead of the current directory. Look up input files
115 in directory first, the along the normal search path.
116 -output-format format
118 Set the output format mode, where format must be either pdf or
119 dvi. This also influences the set of graphics formats under‐
120 stood by pdfeTeX.
121 -parse-first-line
123 If the first line of the main input file begins with %& parse it
124 to look for a dump name or a -translate-file option.
125 -no-parse-first-line
127 Disable parsing of the first line of the main input file.
128 -progname name
130 Pretend to be program name. This affects both the format used
131 and the search paths.
132 -recorder
134 Enable the filename recorder. This leaves a trace of the files
135 opened for input and output in a file with extension .fls.
136 -shell-escape
138 Enable the \write18{command} construct. The command can be any
139 shell command. This construct is normally disallowed for secu‐
140 rity reasons.
141 -no-shell-escape
143 Disable the \write18{command} construct, even if it is enabled
144 in the texmf.cnf file.
145 -src-specials
147 In DVI mode, insert source specials into the DVI file. This
148 option is ignored in PDF mode.
149 -src-specials where
151 In DVI mode, insert source specials in certain placed of the DVI
152 file. where is a comma-separated value list: cr, display, hbox,
153 math, par, parent, or vbox. This option is ignored in PDF mode.
154 -translate-file tcxname
156 Use the tcxname translation table to set the mapping of input
157 characters and re-mapping of output characters.
158 -default-translate-file tcxname
160 Like -translate-file except that a %& line can overrule this
161 setting.
162 -version
164 Print version information and exit.
165
167 See the Kpathsearch library documentation (the `Path specifications'
168 node) for precise details of how the environment variables are used.
169 The kpsewhich utility can be used to query the values of the variables.
170 One caveat: In most pdfeTeX formats, you cannot use ~ in a filename you
172 give directly to pdfeTeX, because ~ is an active character, and hence
173 is expanded, not taken as part of the filename. Other programs, such
174 as Metafont, do not have this problem.
175 TEXMFOUTPUT
177 Normally, pdfeTeX puts its output files in the current direc‐
178 tory. If any output file cannot be opened there, it tries to
179 open it in the directory specified in the environment variable
180 TEXMFOUTPUT. There is no default value for that variable. For
181 example, if you say pdfetex paper and the current directory is
182 not writable, if TEXMFOUTPUT has the value /tmp, pdfeTeX
183 attempts to create /tmp/paper.log (and /tmp/paper.pdf, if any
184 output is produced.)
185 TEXINPUTS
187 Search path for \input and \openin files. This should probably
188 start with ``.'', so that user files are found before system
189 files. An empty path component will be replaced with the paths
190 defined in the texmf.cnf file. For example, set TEXINPUTS to
191 ".:/home/usr/tex:" to prepend the current direcory and
192 ``/home/user/tex'' to the standard search path.
193 TEXFORMATS
195 Search path for format files.
196 TEXPOOL
198 search path for pdfetex internal strings.
199 TEXEDIT
201 Command template for switching to editor. The default, usually
202 vi, is set when pdfeTeX is compiled.
203 TFMFONTS
205 Search path for font metric (.tfm) files.
206
208 The location of the files mentioned below varies from system to system.
209 Use the kpsewhich utility to find their locations.
210 pdfetex.pool
212 Text file containing pdfeTeX's internal strings.
213 pdftex.map
215 Filename mapping definitions.
216 *.tfm Metric files for pdfeTeX's fonts.
218 *.fmt Predigested pdfeTeX format (.fmt) files.
220
222 Starting with version 1.40, pdfTeX incorporates the e-TeX extensions,
223 and pdfeTeX is just a copy of pdfTeX. See pdftex(1). This manual page
224 is not meant to be exhaustive. The complete documentation for this
225 version of pdfeTeX can be found in the pdfTeX manual and the info man‐
226 ual Web2C: A TeX implementation.
227
229 This version of pdfeTeX implements a number of optional extensions. In
230 fact, many of these extensions conflict to a greater or lesser extent
231 with the definition of pdfeTeX. When such extensions are enabled, the
232 banner printed when pdfeTeX starts is changed to print pdfeTeXk instead
233 of pdfeTeX.
234 This version of pdfeTeX fails to trap arithmetic overflow when dimen‐
236 sions are added or subtracted. Cases where this occurs are rare, but
237 when it does the generated DVI file will be invalid. Whether a gener‐
238 ated PDF file would be usable is unknown.
239
241 pdfeTeX is available for a large variety of machine architectures and
242 operation systems. pdfeTeX is part of all major TeX distributions.
243 Information on how to get pdfeTeX and related information is available
245 at the http://www.pdftex.org pdfTeX website.
246 The following pdfTeX related mailing list is available: pdftex@tug.org.
248 This is a mailman list; to subscribe send a message containing sub‐
249 scribe to pdftex-request@tug.org. More about the list can be found at
250 the http://tug.org/mailman/listinfo/pdftex mailing list website.
251
253 etex(1), mf(1), pdftex(1), tex(1).
254
256 The primary authors of pdfeTeX are Han The Thanh, Petr Sojka, Jiri Zla‐
257 tuska, and Peter Breitenlohner (eTeX).
258 TeX was designed by Donald E. Knuth, who implemented it using his sys‐
260 tem for Pascal programs. It was ported to Unix at Stanford by Howard
261 Trickey, and at Cornell by Pavel Curtis. The version now offered with
262 the Unix TeX distribution is that generated by the to C system
263 (web2c), originally written by Tomas Rokicki and Tim Morgan.
264 The encTeX extensions were written by Petr Olsak.
266pdftex 1.40 8 January 2007 PDFETEX(1)