Section: User Commands (1)
Updated: 21 August 2004
Return to Main Contents
pdfetex, pdfeinitex, pdfevirtex - PDF output from e-TeX
[& format ]
[ file | \ commands ]
Run the pdfeTeX typesetter on
If the file argument has no extension, ".tex" will be appended to it.
Instead of a filename, a set of pdfeTeX commands can be given, the first
of which must start with a backslash.
argument pdfeTeX uses a different set of precompiled commands,
it is usually better to use the
pdfeTeX is a version of e-TeX that can create
files as well as
mode, pdfeTeX can be used as a complete replacement of the e-TeX
The typical use of pdfeTeX is with a pregenerated formats for which
PDF output has been enabled. The
command uses the equivalent of the plain e-TeX format, and the
command uses the equivalent of the e-LaTeX format.
To generate formats, use the
commands are pdfeTeX's analogues to the
commands. In this installation, they are symbolic links to the
executable. These symbolic links may not exist at all.
mode, pdfeTeX can natively handle the
pdfeTeX's handling of its command-line arguments is similar to that of
of the other TeX programs in the
This version of pdfeTeX understands the following command line options.
Enable the encTeX extensions. This option is only effective in
For documentation of the encTeX extensions see
Print error messages in the form
which is similar to the way many compilers format them.
Disable printing error messages in the
This is the old name of the
- -fmt format
as the name of the format to be used, instead of the name by which
pdfeTeX was called or a
Exit with an error code when an error is encountered during processing.
Print help message and exit.
mode, which is used to dump formats. The
mode can be used for typesetting, but no format is preloaded, and
basic initializations like setting catcodes may be required.
- -interaction mode
Sets the interaction mode. The mode can be either
The meaning of these modes is the same as that of the corresponding
Send DVI or PDF output to a socket as well as the usual output file.
Whether this option is available is the choice of the installer.
and starts the server at the other end as well. Whether this option
is available is the choice of the installer.
- -jobname name
for the job name, instead of deriving it from the name of the input file.
- -kpathsea-debug bitmask
Sets path searching debugging flags according to the bitmask. See the
manual for details.
- -mktex fmt
must be either
Enable MLTeX extensions. Only effective in combination with
- -no-mktex fmt
must be either
- -output-comment string
file comment instead of the date. This option is ignored
- -output-directory directory
instead of the current directory. Look up input files in
first, the along the normal search path.
- -output-format format
Set the output format mode, where
must be either
This also influences the set of graphics formats understood by pdfeTeX.
If the first line of the main input file begins with
parse it to look for a dump name or a
Disable parsing of the first line of the main input file.
- -progname name
Pretend to be program
This affects both the format used and the search paths.
Enable the filename recorder.
This leaves a trace of the files opened for input and output
in a file with extension
can be any shell command. This construct is normally
disallowed for security reasons.
construct, even if it is enabled in the
mode, insert source specials into the
This option is ignored in
- -src-specials where
mode, insert source specials in certain placed of the
is a comma-separated value list:
This option is ignored in
- -translate-file tcxname
translation table to set the mapping of input characters and
re-mapping of output characters.
- -default-translate-file tcxname
except that a
line can overrule this setting.
Print version information and exit.
See the Kpathsearch library documentation (the `Path specifications'
node) for precise details of how the environment variables are used.
utility can be used to query the values of the variables.
One caveat: In most pdfeTeX formats, you cannot use ~ in a filename you
give directly to pdfeTeX, because ~ is an active character, and hence is
expanded, not taken as part of the filename. Other programs, such as
Metafont, do not have this problem.
Normally, pdfeTeX puts its output files in the current directory. If
any output file cannot be opened there, it tries to open it in the
directory specified in the environment variable TEXMFOUTPUT.
There is no default value for that variable. For example, if you say
and the current directory is not writable, if TEXMFOUTPUT has
pdfeTeX attempts to create
if any output is produced.)
Search path for
This should probably start with ``.'', so
that user files are found before system files. An empty path
component will be replaced with the paths defined in the
file. For example, set TEXINPUTS to ".:/home/usr/tex:" to prepend the
current direcory and ``/home/user/tex'' to the standard search path.
Search path for format files.
search path for
Command template for switching to editor. The default, usually
is set when pdfeTeX is compiled.
Search path for font metric
The location of the files mentioned below varies from system to
system. Use the
utility to find their locations.
Text file containing pdfeTeX's internal strings.
Filename mapping definitions.
Metric files for pdfeTeX's fonts.
Predigested pdfeTeX format (.fmt) files.
This manual page is not meant to be exhaustive. The complete
documentation for this version of pdfeTeX can be found in the info
Web2C: A TeX implementation.
This version of pdfeTeX implements a number of optional extensions.
In fact, many of these extensions conflict to a greater or lesser
extent with the definition of pdfeTeX. When such extensions are
enabled, the banner printed when pdfeTeX starts is changed to print
This version of pdfeTeX fails to trap arithmetic overflow when
dimensions are added or subtracted. Cases where this occurs are rare,
but when it does the generated
file will be invalid. Whether a generated
file would be usable is unknown.
pdfeTeX is available for a large variety of machine architectures
and operation systems.
pdfeTeX is part of all major TeX distributions.
Information on how to get pdfeTeX and related information
is available at the
The most recent version of pdfeTeX is available for anonymous
ftp at the
pdfeTeX development site.
The following pdfeTeX related mailing list is available:
This is a mailman list;
to subscribe send a message containing
More about the list can be found at the
The primary authors of pdfTeX are Han The Thanh, Petr Sojka, and
TeX was designed by Donald E. Knuth,
who implemented it using his system for Pascal programs.
It was ported to Unix at Stanford by Howard Trickey, and
at Cornell by Pavel Curtis.
The version now offered with the Unix TeX distribution is that
generated by the to C system
originally written by Tomas Rokicki and Tim Morgan.
The encTeX extensions were written by Petr Olsak.
- SEE ALSO
This document was created by
using the manual pages.
Time: 09:57:39 GMT, September 25, 2018