Man page 1 : pdfetex

pdfetex, pdfeinitex, pdfevirtex - PDF output from e-TeX

pdfetex [ options ] [& format ] [ file | \ commands ]

Run the pdfe\*(TX typesetter on file , usually creating file.pdf . If the file argument has no extension, ".tex" will be appended to it. Instead of a filename, a set of pdfe\*(TX commands can be given, the first of which must start with a backslash. With a & format argument pdfe\*(TX uses a different set of precompiled commands, contained in format.fmt ; it is usually better to use the

-fmt formatoption instead.

pdfe\*(TX is a version of e-\*(TX that can create PDFfiles as well as DVIfiles.

In DVImode, pdfe\*(TX can be used as a complete replacement of the e-\*(TX engine.

The typical use of pdfe\*(TX is with a pregenerated formats for which PDF output has been enabled. The

pdfetex command uses the equivalent of the plain e-\*(TX format, and the

pdfelatex command uses the equivalent of the e-\*(LX format. To generate formats, use the

-ini switch.

The

pdfeinitex and

pdfevirtex commands are pdfe\*(TX's analogues to the

einitex and

evirtex commands. In this installation, they are symbolic links to the

pdfetex executable. These symbolic links may not exist at all.

In PDFmode, pdfe\*(TX can natively handle the PDF , JPG , JBIG2 , and PNGgraphics formats. pdfe\*(TX cannot include PostScript or Encapsulated PostScript (EPS) graphics files; first convert them to PDF using

R epstopdf (1). pdfe\*(TX's handling of its command-line arguments is similar to that of of the other \*(TX programs in the web2cimplementation.

This version of pdfe\*(TX understands the following command line options.

-draftmode

    .rb Sets \pdfdraftmode so pdf\*(TX doesn't write a PDF and doesn't read any included images, thus speeding up execution.

-enc

    .rb Enable the enc\*(TX extensions. This option is only effective in combination with

-etex

    .rb Enable the e-\*(TX extensions. This option is only effective in combination with

R -ini . See

R etex (1).

R -ini .

    For documentation of the enc\*(TX extensions see

R http://www.olsak.net/enctex.html .

-file-line-error .rb Print error messages in the form file:line:errorwhich is similar to the way many compilers format them.

-no-file-line-error

    .rb Disable printing error messages in the file:line:errorstyle.

-file-line-error-style

    .rb This is the old name of the

-file-line-error option.

• -fmt  format
      .rb Use formatas the name of the format to be used, instead of the name by which pdfe\*(TX was called or a %&line.

-halt-on-error

    .rb Exit with an error code when an error is encountered during processing.

-help

    .rb Print help message and exit.

-ini

    .rb Start in INImode, which is used to dump formats. The INImode can be used for typesetting, but no format is preloaded, and basic initializations like setting catcodes may be required.

• -interaction  mode
      .rb Sets the interaction mode. The mode can be either batchmode , nonstopmode , scrollmode , and errorstopmode . The meaning of these modes is the same as that of the corresponding \commands.

-ipc

    .rb 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.

-ipc-start

    .rb As

R -ipc , and starts the server at the other end as well. Whether this option is available is the choice of the installer.

• -jobname  name
      .rb Use namefor the job name, instead of deriving it from the name of the input file.
• -kpathsea-debug  bitmask
      .rb Sets path searching debugging flags according to the bitmask. See the Kpathseamanual for details.
• -mktex  fmt
      .rb Enable mktex fmt , where fmtmust be either texor tfm .

-mltex

    .rb Enable ML\*(TX extensions. Only effective in combination with

R -ini .

• -no-mktex  fmt
      .rb Disable mktex fmt , where fmtmust be either texor tfm .
• -output-comment  string
      .rb In DVImode, use stringfor the DVIfile comment instead of the date. This option is ignored in PDFmode.
• -output-directory  directory
      .rb Write output files in directoryinstead of the current directory. Look up input files in directoryfirst, the along the normal search path.
• -output-format  format
      .rb Set the output format mode, where formatmust be either pdfor dvi . This also influences the set of graphics formats understood by pdfe\*(TX.

-parse-first-line

    .rb If the first line of the main input file begins with %&parse it to look for a dump name or a

-translate-file option.

-no-parse-first-line

    .rb Disable parsing of the first line of the main input file.

• -progname  name
      .rb Pretend to be program name . This affects both the format used and the search paths.

-recorder

    .rb Enable the filename recorder. This leaves a trace of the files opened for input and output in a file with extension .fls .

-shell-escape

    .rb Enable the \write18{ command } construct. The commandcan be any shell command. This construct is normally disallowed for security reasons.

-no-shell-escape

    .rb Disable the \write18{ command } construct, even if it is enabled in the texmf.cnffile.

-src-specials

    .rb In DVImode, insert source specials into the DVIfile. This option is ignored in PDFmode.

• -src-specials  where
      .rb In DVImode, insert source specials in certain placed of the DVIfile. whereis a comma-separated value list: cr , display , hbox , math , par , parent , or vbox . This option is ignored in PDFmode.
• -translate-file  tcxname
      .rb Use the tcxnametranslation table to set the mapping of input characters and re-mapping of output characters.
• -default-translate-file  tcxname
      .rb Like

-translate-file except that a %&line can overrule this setting.

-version

    .rb Print version information and exit.

See the Kpathsearch library documentation (the `Path specifications' node) for precise details of how the environment variables are used. The

kpsewhich utility can be used to query the values of the variables.

One caveat: In most pdfe\*(TX formats, you cannot use ~ in a filename you give directly to pdfe\*(TX, because ~ is an active character, and hence is expanded, not taken as part of the filename. Other programs, such as \*(MF, do not have this problem.

• TEXMFOUTPUT
      Normally, pdfe\*(TX 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 pdfetex paperand the current directory is not writable, if TEXMFOUTPUT has the value /tmp , pdfe\*(TX attempts to create /tmp/paper.log(and /tmp/paper.pdf , if any output is produced.)
• TEXINPUTS
      Search path for \inputand \openinfiles. 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 texmf.cnffile. For example, set TEXINPUTS to ".:/home/usr/tex:" to prepend the current directory and ``/home/user/tex'' to the standard search path.
• TEXFORMATS
      Search path for format files.
• TEXPOOL
      search path for

pdfetex internal strings.

• TEXEDIT
      Command template for switching to editor. The default, usually

R vi , is set when pdfe\*(TX is compiled.

• TFMFONTS
      Search path for font metric ( .tfm ) files.

The location of the files mentioned below varies from system to system. Use the

kpsewhich utility to find their locations.

• pdfetex.pool
      Text file containing pdfe\*(TX's internal strings.
• pdftex.map
      Filename mapping definitions.
• *.tfm
      Metric files for pdfe\*(TX's fonts.
• *.fmt
      Predigested pdfe\*(TX format (. fmt) files.
  

Starting with version 1.40, pdf\*(TX incorporates the e-\*(TX extensions, and pdfe\*(TX is just a copy of pdf\*(TX. See

R pdftex (1). This manual page is not meant to be exhaustive. The complete documentation for this version of pdfe\*(TX can be found in the "pdf\*(TX manual" and the info manual "Web2C: A TeX implementation" .

This version of pdfe\*(TX implements a number of optional extensions. In fact, many of these extensions conflict to a greater or lesser extent with the definition of pdfe\*(TX. When such extensions are enabled, the banner printed when pdfe\*(TX starts is changed to print

pdfeTeXk instead of

R pdfeTeX .

This version of pdfe\*(TX fails to trap arithmetic overflow when dimensions are added or subtracted. Cases where this occurs are rare, but when it does the generated DVIfile will be invalid. Whether a generated PDFfile would be usable is unknown.

pdfe\*(TX is available for a large variety of machine architectures and operation systems. pdfe\*(TX is part of all major \*(TX distributions.

Information on how to get pdfe\*(TX and related information is available at the

http://www.pdftex.org "pdf\*(TX" website.

The following pdf\*(TX related mailing list is available:

R . This is a mailman list; to subscribe send a message containing subscribeto

R . More about the list can be found at the

http://tug.org/mailman/listinfo/pdftex mailing listwebsite.

R etex (1),

R mf (1),

R pdftex (1),

R tex (1).

The primary authors of pdfe\*(TX are Han The Thanh, Petr Sojka, Jiri Zlatuska, and Peter Breitenlohner (e\*(TX).

\*(TX was designed by Donald E. Knuth, who implemented it using his \*(WB 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 \*(TX distribution is that generated by the \*(WB to C system ( web2c ), originally written by Tomas Rokicki and Tim Morgan.

The enc\*(TX extensions were written by Petr Olsak.