1 .TH PDFTEX 1 "4 May 2016" "Web2C @VERSION@"
2 .\"=====================================================================
5 .if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP
7 .ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP
9 .\" BX definition must follow TX so BX can use TX
10 .if t .ds BX \fRB\s-2IB\s0\fP\*(TX
12 .\" LX definition must follow TX so LX can use TX
13 .if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
15 .if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX
17 .if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX
20 .if t .ds WB W\s-2EB\s0
21 .\"=====================================================================
23 pdftex \- PDF output from TeX
28 .RI [ file | \fB\e\fPcommands ]
29 .\"=====================================================================
31 Run the pdf\*(TX typesetter on
35 If the file argument has no extension, ".tex" will be appended to it.
36 Instead of a filename, a set of pdf\*(TX commands can be given, the first
37 of which must start with a backslash.
40 argument pdf\*(TX uses a different set of precompiled commands,
42 .IR format\fB.fmt\fP ;
43 it is usually better to use the
48 pdf\*(TX is a version of \*(TX, with the e-\*(TX extensions, that can create
56 mode, pdf\*(TX can be used as a complete replacement for the \*(TX
59 The typical use of pdf\*(TX is with a pregenerated formats for which
60 PDF output has been enabled. The
62 command uses the equivalent of the plain \*(TX format, and the
64 command uses the equivalent of the \*(LX format.
65 To generate formats, use the
73 commands are pdf\*(TX's analogues to the
77 commands. In this installation, if the links exist, they are symbolic
84 mode, pdf\*(TX can natively handle the
90 graphics formats. pdf\*(TX cannot include PostScript or Encapsulated
91 PostScript (EPS) graphics files; first convert them to PDF using
93 pdf\*(TX's handling of its command-line arguments is similar to that of
94 of the other \*(TX programs in the
97 .\"=====================================================================
99 This version of pdf\*(TX understands the following command line options.
102 Sets \epdfdraftmode so pdf\*(TX doesn't write a PDF and doesn't read any
103 included images, thus speeding up execution.
106 Enable the enc\*(TX extensions. This option is only effective in
109 For documentation of the enc\*(TX extensions see
110 .BR http://www.olsak.net/enctex.html .
113 Enable the e-\*(TX extensions. This option is only effective in
120 Print error messages in the form
122 which is similar to the way many compilers format them.
124 .B -no-file-line-error
125 Disable printing error messages in the
129 .B -file-line-error-style
130 This is the old name of the
137 as the name of the format to be used, instead of the name by which
138 pdf\*(TX was called or a
143 Exit with an error code when an error is encountered during processing.
146 Print help message and exit.
151 mode, which is used to dump formats. The
153 mode can be used for typesetting, but no format is preloaded, and
154 basic initializations like setting catcodes may be required.
156 .BI -interaction \ mode
157 Sets the interaction mode. The mode can be either
163 The meaning of these modes is the same as that of the corresponding
167 Send DVI or PDF output to a socket as well as the usual output file.
168 Whether this option is available is the choice of the installer.
173 and starts the server at the other end as well. Whether this option
174 is available is the choice of the installer.
179 for the job name, instead of deriving it from the name of the input file.
181 .BI -kpathsea-debug \ bitmask
182 Sets path searching debugging flags according to the bitmask. See the
197 Enable ML\*(TX extensions. Only effective in combination with
210 .BI -output-comment \ string
217 file comment instead of the date. This option is ignored
222 .BI -output-directory \ directory
223 Write output files in
225 instead of the current directory. Look up input files in
227 first, the along the normal search path.
229 .BI -output-format \ format
230 Set the output format mode, where
236 This also influences the set of graphics formats understood by pdf\*(TX.
239 If the first line of the main input file begins with
241 parse it to look for a dump name or a
245 .B -no-parse-first-line
246 Disable parsing of the first line of the main input file.
249 Pretend to be program
251 This affects both the format used and the search paths.
254 Enable the filename recorder.
255 This leaves a trace of the files opened for input and output
256 in a file with extension
261 .BI \ewrite18{ command }
264 can be any shell command. This construct is normally
265 disallowed for security reasons.
269 .BI \ewrite18{ command }
270 construct, even if it is enabled in the
277 mode, insert source specials into the
280 This option is ignored in
284 .BI -src-specials \ where
287 mode, insert source specials in certain placed of the
291 is a comma-separated value list:
300 This option is ignored in
304 .BI -translate-file \ tcxname
307 translation table to set the mapping of input characters and
308 re-mapping of output characters.
310 .BI -default-translate-file \ tcxname
315 line can overrule this setting.
318 Print version information and exit.
319 .\"=====================================================================
321 See the Kpathsea library documentation (e.g., the `Path specifications'
322 node) for precise details of how the environment variables are used.
325 utility can be used to query the values of the variables.
327 One caveat: In most pdf\*(TX formats, you cannot use ~ in a filename you
328 give directly to pdf\*(TX, because ~ is an active character, and hence is
329 expanded, not taken as part of the filename. Other programs, such as
330 \*(MF, do not have this problem.
334 Normally, pdf\*(TX puts its output files in the current directory. If
335 any output file cannot be opened there, it tries to open it in the
336 directory specified in the environment variable TEXMFOUTPUT.
337 There is no default value for that variable. For example, if you say
339 and the current directory is not writable and TEXMFOUTPUT has
342 pdf\*(TX attempts to create
346 if any output is produced.) TEXMFOUTPUT is also checked for input
347 files, as \*(TX often generates files that need to be subsequently
348 read; for input, no suffixes (such as ``.tex'') are added by default,
349 the input name is simply checked as given.
357 This should start with ``.'', so
358 that user files are found before system files. An empty path
359 component will be replaced with the paths defined in the
361 file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the
362 current directory and ``/home/user/tex'' to the standard search path.
365 Search path for format files.
368 Command template for switching to editor. The default, usually
370 is set when pdf\*(TX is compiled.
373 Search path for font metric
378 If set, its value, taken to be in epoch-seconds, will be used for the
379 timestamps in the PDF output, such as the CreationDate and ModDate keys.
380 This is useful for making reproducible builds.
383 If set to the value "1", the time-related \*(TX primitives
388 are also initialized from the value of SOURCE_DATE_EPOCH. This is not
389 recommended if there is any viable alternative.
391 pdf\*(TX also has several primitives to support reproducible builds,
392 which are preferable to setting these environment variables; see the
395 Many, many more environment variables may be consulted related to path
396 searching. See the Kpathsea manual.
397 .\"=====================================================================
399 The location of the files mentioned below varies from system to
402 utility to find their locations.
405 Font name mapping definitions.
408 Metric files for pdf\*(TX's fonts.
411 Predigested pdf\*(TX format (.\|fmt) files.
413 .\"=====================================================================
415 Starting with version 1.40, pdf\*(TX incorporates the e-\*(TX
416 extensions, and pdfe\*(TX is just a copy of pdf\*(TX. See
418 This manual page is not meant to be exhaustive. The complete
419 documentation for this version of pdf\*(TX can be found in the
420 .IR "pdf\*(TX manual"
422 .IR "Web2C: A TeX implementation" .
423 .\"=====================================================================
425 This version of pdf\*(TX fails to trap arithmetic overflow when
426 dimensions are added or subtracted. Cases where this occurs are rare,
427 but when it does the generated
429 file will be invalid. Whether a generated
431 file would be usable is unknown.
432 .\"=====================================================================
434 pdf\*(TX is available for a large variety of machine architectures
435 and operating systems.
436 pdf\*(TX is part of all major \*(TX distributions.
438 The pdf\*(TX home page: http://www.pdftex.org.
440 pdf\*(TX on CTAN: http://www.ctan.org/pkg/pdftex.
442 pdf\*(TX mailing list for all discussion: http://lists.tug.org/pdftex.
443 .\"=====================================================================
445 The full pdf\*(TX manual can be accessed from the home page or CTAN page.
446 Same for the Web2C, Kpathsea, and other manuals.
447 Some related programs:
455 .\"=====================================================================
457 The primary authors of pdf\*(TX are Han The Thanh, Petr Sojka,
458 Jiri Zlatuska, and Peter Breitenlohner (e\*(TX).
460 \*(TX was designed by Donald E. Knuth,
461 who implemented it using his \*(WB system for Pascal programs.
462 It was ported to Unix at Stanford by Howard Trickey, and
463 at Cornell by Pavel Curtis.
464 The version now offered with the Unix \*(TX distribution is that
465 generated by the \*(WB to C system
467 originally written by Tomas Rokicki and Tim Morgan.
469 The enc\*(TX extensions were written by Petr Olsak.
470 .\" vim: syntax=nroff