| 1 |
.TH PDFTEX 1 "14 February 2026" "Web2C 2026" |
| 2 |
.\"===================================================================== |
| 3 |
.if t .ds TX \fRT\\h'-0.10m'\\v'0.17v'E\\v'-0.17v'\\h'-0.06m'X\fP |
| 4 |
.if n .ds TX TeX |
| 5 |
.ie t .ds OX \fIT\h'-0.17m'\v'+0.21m'E\v'-0.21m'\h'-0.04m'X\fP |
| 6 |
.el .ds OX TeX |
| 7 |
.\" LX definition must follow TX so LX can use TX |
| 8 |
.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s+2\\h'-0.15m'\\v'0.15v'\fP\*(TX |
| 9 |
.if n .ds LX LaTeX |
| 10 |
.\"===================================================================== |
| 11 |
.SH NAME |
| 12 |
pdftex, pdfetex \- PDF output from TeX |
| 13 |
.SH SYNOPSIS |
| 14 |
.B pdftex |
| 15 |
.RI [ options ] |
| 16 |
.RI [ \fB&\fPformat ] |
| 17 |
\h'.25' [ \fIfile\fP [ \fImore-input\fP ] \h'.5'|\h'.5' [ \fB\e\fP\fImore-input\fP ] |
| 18 |
.\"===================================================================== |
| 19 |
.SH DESCRIPTION |
| 20 |
Run the pdf\*(TX typesetter on |
| 21 |
.IR file [.tex], |
| 22 |
usually creating |
| 23 |
.IR file.pdf . |
| 24 |
If the file argument has no extension, ".tex" will be appended to it. See |
| 25 |
.BR tex (1) |
| 26 |
for details of command-line parsing. |
| 27 |
.PP |
| 28 |
pdf\*(TX is a descendant of \*(TX that can create pdf files directly as |
| 29 |
well as dvi files (determined by the value of the \epdfoutput primitive |
| 30 |
parameter). It includes the |
| 31 |
.BR etex (1) |
| 32 |
extensions, and adds many more extensions of its own. In dvi mode, |
| 33 |
pdf\*(TX can be used as an upward-compatible replacement for the \*(TX |
| 34 |
engine. |
| 35 |
.PP |
| 36 |
The typical use of pdf\*(TX is with pregenerated \*(TX formats |
| 37 |
(\fI.fmt\fP files), usually with pdf output enabled. For example, the |
| 38 |
.B pdftex |
| 39 |
command uses the plain \*(TX format, and the |
| 40 |
.BR pdflatex (1) |
| 41 |
command uses the \*(LX format. As described in |
| 42 |
.BR etex (1), |
| 43 |
the e-\*(TX extensions are enabled when building the \fI.fmt\fP file. |
| 44 |
.PP |
| 45 |
.B Image formats supported |
| 46 |
.PP |
| 47 |
In pdf mode, pdf\*(TX can natively handle the |
| 48 |
.IR pdf , |
| 49 |
.IR jpg , |
| 50 |
.IR jbig2 , |
| 51 |
and |
| 52 |
.I png |
| 53 |
graphics formats. It cannot include PostScript or Encapsulated |
| 54 |
PostScript (eps) graphics files; you can convert them to pdf using, for |
| 55 |
example, |
| 56 |
.BR epstopdf (1). |
| 57 |
The PostScript files output by |
| 58 |
.BR mpost (1), |
| 59 |
which are highly restricted in their use of PostScript, can be handled |
| 60 |
directly using the \fIsupp-pdf.tex\fP macros, or converted to pdf with |
| 61 |
.BR mptopdf (1). |
| 62 |
.PP |
| 63 |
.B Program variants |
| 64 |
.PP |
| 65 |
Starting with version 1.40 (around 2007), pdf\*(TX incorporated the |
| 66 |
e-\*(TX extensions, and the |
| 67 |
.B pdfetex |
| 68 |
and |
| 69 |
.B etex |
| 70 |
executables became symlinks to the |
| 71 |
.B pdftex |
| 72 |
binary. The |
| 73 |
.B etex |
| 74 |
executable generates dvi files by default; \fBpdfetex\fP has the same |
| 75 |
behavior as \fBpdftex\fP. |
| 76 |
.PP |
| 77 |
.B Both engine and driver |
| 78 |
.PP |
| 79 |
When generating pdf output, pdf\*(TX must have all necessary font and |
| 80 |
device information and thus is acting like a device driver with dvi |
| 81 |
output, similar to, say, |
| 82 |
.BR dvips (1). |
| 83 |
Therefore there are various primitives to specify the device |
| 84 |
information, such as the height, width, resolution, and so forth. Also, |
| 85 |
pdf\*(TX reads glyph information for the fonts used, e.g., from Type\~1 |
| 86 |
or PK bitmap files. pdf\*(TX also supports TrueType fonts, but it's |
| 87 |
necessary to define an encoding before using them (see references). |
| 88 |
OpenType fonts are not supported. |
| 89 |
.\"===================================================================== |
| 90 |
.SH OPTIONS |
| 91 |
For the common \*(TX command-line options and handling, see |
| 92 |
.BR tex (1). |
| 93 |
The following pdf\*(TX-specific options are also supported: |
| 94 |
.\" from Master/tlpkg/bin/tloptdiff. |
| 95 |
.TP |
| 96 |
.B -draftmode |
| 97 |
Enabled \epdfdraftmode, in which pdf\*(TX doesn't write a pdf and |
| 98 |
doesn't read any included images, thus speeding up execution. |
| 99 |
.TP |
| 100 |
.B -etex |
| 101 |
Enable the e-\*(TX extensions. This option is only effective in |
| 102 |
combination with |
| 103 |
.BR -ini . |
| 104 |
It is typically enabled implicitly, with a leading "*" on the format |
| 105 |
initialization file, as described in |
| 106 |
.BR etex (1). |
| 107 |
.TP |
| 108 |
.BI -output-format \ format |
| 109 |
Set the output format mode; |
| 110 |
.I format |
| 111 |
must be either ``pdf'' or ``dvi''. |
| 112 |
.TP |
| 113 |
.BI -synctex \ number |
| 114 |
generate Sync\*(TX data for previewers according to bits of \fInumber\fP. |
| 115 |
See |
| 116 |
.BR synctex (1). |
| 117 |
.\"===================================================================== |
| 118 |
.SH ENVIRONMENT |
| 119 |
See |
| 120 |
.BR tex (1). |
| 121 |
Also, this environment variable is specific to pdf\*(TX: |
| 122 |
.TP |
| 123 |
.B TEXMF_DEBUG_PNG_COPY |
| 124 |
If set to "1", pdf\*(TX reports various attributes of each png image, |
| 125 |
including whether the image is copied. This is useful when a document uses |
| 126 |
numerous png images, since reencoding (instead of copying) can take |
| 127 |
considerable time. See the Graphics chapter in the pdf\*(TX manual for |
| 128 |
more information. |
| 129 |
.PP |
| 130 |
Also, these environment variables are considered for all engines except |
| 131 |
original \*(TX: |
| 132 |
.TP |
| 133 |
.B SOURCE_DATE_EPOCH |
| 134 |
If set, its value, taken to be in epoch-seconds, will be used for the |
| 135 |
timestamps in the PDF output, such as the CreationDate and ModDate keys. |
| 136 |
This is useful for making reproducible builds. |
| 137 |
.TP |
| 138 |
.B FORCE_SOURCE_DATE |
| 139 |
If set to the value "1", the time-related \*(TX primitives |
| 140 |
.RI ( \eyear , |
| 141 |
.IR \emonth , |
| 142 |
.IR \eday , |
| 143 |
.IR \etime ) |
| 144 |
are also initialized from the value of SOURCE_DATE_EPOCH. This is not |
| 145 |
recommended if there is any viable alternative. |
| 146 |
.br |
| 147 |
pdf\*(TX also has several primitives to support reproducible builds; |
| 148 |
see the manual. |
| 149 |
.\"===================================================================== |
| 150 |
.SH FILES |
| 151 |
See |
| 152 |
.BR tex (1). |
| 153 |
Also: |
| 154 |
.TP |
| 155 |
.I $TEXMFMAIN/tex/plain/config/etex.ini |
| 156 |
The driver file that builds the plain format files for pdf\*(TX, |
| 157 |
\fIpdftex.fmt\fP and \fIpdfetex.fmt\fP, in \*(TX Live. |
| 158 |
.TP |
| 159 |
.I $TEXMFMAIN/tex/plain/config/pdftexmagfix.tex |
| 160 |
Make \emagnification work as expected under pdf\*(TX. Included in the |
| 161 |
format files. |
| 162 |
.TP |
| 163 |
.I $TEXMFMAIN/tex/generic/tex-ini-files/pdftexconfig.tex |
| 164 |
Define shared pdf settings, such as the default pdf version, the pdf |
| 165 |
height and width, etc. |
| 166 |
.TP |
| 167 |
.I $TEXMF[SYS]CONFIG/tex/generic/tex-ini-files/pdftexconfig.tex |
| 168 |
The installation-specific version of the above (in \*(TX Live), since |
| 169 |
the default paper size is defined by the installation. |
| 170 |
.TP |
| 171 |
.I $TEXMF[SYS]VAR/fonts/map/pdftex/updmap/pdftex.map |
| 172 |
Mapping of tfm files to Type\~1 fonts; generally maintained |
| 173 |
automatically in \*(TX Live. |
| 174 |
.\"===================================================================== |
| 175 |
.SH BUGS |
| 176 |
See |
| 177 |
.BR tex (1). |
| 178 |
.\"===================================================================== |
| 179 |
.SH "SEE ALSO" |
| 180 |
.BR epstopdf (1), |
| 181 |
.BR etex (1), |
| 182 |
.BR luatex (1), |
| 183 |
.BR mptopdf (1), |
| 184 |
.BR tex (1). |
| 185 |
.PP |
| 186 |
Micro-typographic extensions to the \*(TX typesetting system, by |
| 187 |
H\[`a]n The Th\[`a]nh |
| 188 |
(thesis describing the major new typesetting feature in pdf\*(TX): |
| 189 |
https://tug.org/TUGboat/tb21-4/ |
| 190 |
.br |
| 191 |
A closer look at TrueType fonts and pdf\*(TX, by |
| 192 |
H\[`a]n The Th\[`a]nh (on using TrueType fonts with \*(TX): |
| 193 |
https://tug.org/TUGboat/tb30-1/tb94thanh.pdf |
| 194 |
.br |
| 195 |
pdf\*(TX home page: https://www.pdftex.org |
| 196 |
.br |
| 197 |
Package page on CTAN: https://ctan.org/pkg/pdftex |
| 198 |
.br |
| 199 |
pdf\*(TX manual: https://mirror.ctan.org/systems/doc/pdftex/manual/pdftex-a.pdf |
| 200 |
.br |
| 201 |
Web2c manual: https://tug.org/web2c |
| 202 |
.br |
| 203 |
Kpathsea manual: https://tug.org/kpathsea |
| 204 |
.br |
| 205 |
Sources for the \*(TX-world literate programs, as pdf: |
| 206 |
https://ctan.org/pkg/knuth-pdf |
| 207 |
.\"===================================================================== |
| 208 |
.SH AUTHORS |
| 209 |
\*(TX was created by Donald E. Knuth. The primary author of the |
| 210 |
pdf\*(TX enhancements is H\[`a]n The Th\[`a]nh, with major contributions |
| 211 |
from Petr Sojka, Jiri Zlatuska, and Peter Breitenlohner (e-\*(TX). |
| 212 |
.\" the double accent 0x1EBF in Thanh's name is not easily available. |
| 213 |
.PP |
| 214 |
Public discussion list for pdf\*(TX-specific issues: |
| 215 |
https://lists.tug.org/pdftex |
| 216 |
.br |
| 217 |
Public discussion list for \*(TX Live: |
| 218 |
https://lists.tug.org/tex-live |
| 219 |
.br |
| 220 |
Public discussion list for all things \*(TX (and \*(LX): |
| 221 |
https://lists.tug.org/texhax |