{ "content": [ { "type": "text", "text": "# pdftex (man)\n\n## NAME\n\npdftex - PDF output from TeX\n\n## SYNOPSIS\n\npdftex [options] [&format] [file|\\commands]\n\n## DESCRIPTION\n\nRun the pdfTeX typesetter on file, usually creating file.pdf. If the file argument has no\nextension, \".tex\" will be appended to it. Instead of a filename, a set of pdfTeX commands\ncan be given, the first of which must start with a backslash. With a &format argument pdfTeX\nuses a different set of precompiled commands, contained in format.fmt; it is usually better\nto use the -fmt format option instead.\n\n## TLDR\n\n> Compile a PDF document from TeX source files.\n\n- Compile a PDF document:\n `pdftex {{source.tex}}`\n- Compile a PDF document, specifying an output directory:\n `pdftex -output-directory={{path/to/directory}} {{source.tex}}`\n- Compile a PDF document, exiting on each error:\n `pdftex -halt-on-error {{source.tex}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (36 subsections)\n- **ENVIRONMENT**\n- **FILES**\n- **NOTES**\n- **BUGS**\n- **AVAILABILITY**\n- **SEE ALSO**\n- **AUTHORS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "pdftex", "section": "", "mode": "man", "summary": "pdftex - PDF output from TeX", "synopsis": "pdftex [options] [&format] [file|\\commands]", "tldr_summary": "Compile a PDF document from TeX source files.", "tldr_examples": [ { "description": "Compile a PDF document", "command": "pdftex {{source.tex}}" }, { "description": "Compile a PDF document, specifying an output directory", "command": "pdftex -output-directory={{path/to/directory}} {{source.tex}}" }, { "description": "Compile a PDF document, exiting on each error", "command": "pdftex -halt-on-error {{source.tex}}" } ], "tldr_source": "official", "flags": [ { "flag": "", "long": null, "arg": null, "description": "Parse string as a texmf.cnf configuration line. See the Kpathsea manual." }, { "flag": "", "long": null, "arg": null, "description": "Sets \\pdfdraftmode so pdfTeX doesn't write a PDF and doesn't read any included images, thus speeding up execution." }, { "flag": "", "long": null, "arg": null, "description": "For documentation of the encTeX extensions see http://www.olsak.net/enctex.html." }, { "flag": "", "long": null, "arg": null, "description": "See etex(1)." }, { "flag": "", "long": null, "arg": null, "description": "Print error messages in the form file:line:error which is similar to the way many com‐ pilers format them." }, { "flag": "", "long": null, "arg": null, "description": "Disable printing error messages in the file:line:error style." }, { "flag": "", "long": null, "arg": null, "description": "This is the old name of the -file-line-error option." }, { "flag": "", "long": null, "arg": null, "description": "Use format as the name of the format to be used, instead of the name by which pdfTeX was called or a %& line." }, { "flag": "", "long": null, "arg": null, "description": "Exit with an error code when an error is encountered during processing." }, { "flag": "", "long": null, "arg": null, "description": "" }, { "flag": "", "long": null, "arg": null, "description": "setting, but no format is preloaded, and basic initializations like setting catcodes may be required." }, { "flag": "", "long": null, "arg": null, "description": "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 correspond‐ ing \\commands." }, { "flag": "", "long": null, "arg": null, "description": "tion is available is the choice of the installer." }, { "flag": "", "long": null, "arg": null, "description": "As -ipc, and starts the server at the other end as well. Whether this option is available is the choice of the installer." }, { "flag": "", "long": null, "arg": null, "description": "Use name for the job name, instead of deriving it from the name of the input file." }, { "flag": "", "long": null, "arg": null, "description": "Sets path searching debugging flags according to the bitmask. See the Kpathsea manual for details." }, { "flag": "", "long": null, "arg": null, "description": "Enable mktexfmt, where fmt must be either tex or tfm." }, { "flag": "", "long": null, "arg": null, "description": "" }, { "flag": "", "long": null, "arg": null, "description": "Disable mktexfmt, where fmt must be either tex or tfm." }, { "flag": "", "long": null, "arg": null, "description": "In DVI mode, use string for the DVI file comment instead of the date. This option is ignored in PDF mode." }, { "flag": "", "long": null, "arg": null, "description": "Write output files in directory instead of the current directory. Look up input files in directory first, the along the normal search path." }, { "flag": "", "long": null, "arg": null, "description": "Set the output format mode, where format must be either pdf or dvi. This also influ‐ ences the set of graphics formats understood by pdfTeX." }, { "flag": "", "long": null, "arg": null, "description": "If the first line of the main input file begins with %& parse it to look for a dump name or a -translate-file option." }, { "flag": "", "long": null, "arg": null, "description": "Disable parsing of the first line of the main input file." }, { "flag": "", "long": null, "arg": null, "description": "Pretend to be program name. This affects both the format used and the search paths." }, { "flag": "", "long": null, "arg": null, "description": "Enable the filename recorder. This leaves a trace of the files opened for input and output in a file with extension .fls." }, { "flag": "", "long": null, "arg": null, "description": "Enable the \\write18{command} construct. The command can be any shell command. This construct is normally disallowed for security reasons." }, { "flag": "", "long": null, "arg": null, "description": "Disable the \\write18{command} construct, even if it is enabled in the texmf.cnf file." }, { "flag": "", "long": null, "arg": null, "description": "Enable restricted \\write18{}, as explained in the ``Shell escapes'' section of the Web2c Texinfo manual." }, { "flag": "", "long": null, "arg": null, "description": "In DVI mode, insert source specials into the DVI file. This option is ignored in PDF mode." }, { "flag": "", "long": null, "arg": null, "description": "In DVI mode, insert source specials in certain places of the DVI file. The where argu‐ ment is a comma-separated value list: cr, display, hbox, math, par, parent, or vbox. This option is ignored in PDF mode." }, { "flag": "", "long": null, "arg": null, "description": "generate SyncTeX data for previewers according to bits of NUMBER. See the synctex man‐ ual page for details." }, { "flag": "", "long": null, "arg": null, "description": "Use the tcxname translation table to set the mapping of input characters and re-map‐ ping of output characters." }, { "flag": "", "long": null, "arg": null, "description": "Like -translate-file except that a %& line can overrule this setting." }, { "flag": "", "long": null, "arg": null, "description": "Print version information and exit." }, { "flag": "", "long": null, "arg": null, "description": "" } ], "examples": [], "see_also": [ { "name": "epstopdf", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/epstopdf/1/json" }, { "name": "etex", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/etex/1/json" }, { "name": "latex", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/latex/1/json" }, { "name": "luatex", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/luatex/1/json" }, { "name": "mptopdf", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/mptopdf/1/json" }, { "name": "tex", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/tex/1/json" }, { "name": "mf", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/mf/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 27, "subsections": [] }, { "name": "OPTIONS", "lines": 2, "subsections": [ { "name": "-cnf-line", "lines": 2 }, { "name": "-draftmode", "lines": 3 }, { "name": "-enc -ini", "lines": 2 }, { "name": "-etex -ini", "lines": 2 }, { "name": "-file-line-error", "lines": 3 }, { "name": "-no-file-line-error", "lines": 2 }, { "name": "-file-line-error-style", "lines": 2 }, { "name": "-fmt", "lines": 3 }, { "name": "-halt-on-error", "lines": 2 }, { "name": "-help", "lines": 1 }, { "name": "-ini", "lines": 3 }, { "name": "-interaction", "lines": 4 }, { "name": "-ipc", "lines": 2 }, { "name": "-ipc-start", "lines": 3 }, { "name": "-jobname", "lines": 2 }, { "name": "-kpathsea-debug", "lines": 3 }, { "name": "-mktex", "lines": 2 }, { "name": "-mltex -ini", "lines": 1 }, { "name": "-no-mktex", "lines": 2 }, { "name": "-output-comment", "lines": 3 }, { "name": "-output-directory", "lines": 3 }, { "name": "-output-format", "lines": 3 }, { "name": "-parse-first-line", "lines": 3 }, { "name": "-no-parse-first-line", "lines": 2 }, { "name": "-progname", "lines": 2 }, { "name": "-recorder", "lines": 3 }, { "name": "-shell-escape", "lines": 3 }, { "name": "-no-shell-escape", "lines": 2 }, { "name": "-shell-restricted", "lines": 3 }, { "name": "-src-specials", "lines": 3 }, { "name": "-src-specials", "lines": 4 }, { "name": "-synctex", "lines": 3 }, { "name": "-translate-file", "lines": 3 }, { "name": "-default-translate-file", "lines": 2 }, { "name": "-version", "lines": 2 }, { "name": "-8bit", "lines": 1 } ] }, { "name": "ENVIRONMENT", "lines": 50, "subsections": [] }, { "name": "FILES", "lines": 10, "subsections": [] }, { "name": "NOTES", "lines": 1, "subsections": [] }, { "name": "BUGS", "lines": 4, "subsections": [] }, { "name": "AVAILABILITY", "lines": 6, "subsections": [] }, { "name": "SEE ALSO", "lines": 7, "subsections": [] }, { "name": "AUTHORS", "lines": 12, "subsections": [] } ], "sections": { "NAME": { "content": "pdftex - PDF output from TeX\n", "subsections": [] }, "SYNOPSIS": { "content": "pdftex [options] [&format] [file|\\commands]\n", "subsections": [] }, "DESCRIPTION": { "content": "Run the pdfTeX typesetter on file, usually creating file.pdf. If the file argument has no\nextension, \".tex\" will be appended to it. Instead of a filename, a set of pdfTeX commands\ncan be given, the first of which must start with a backslash. With a &format argument pdfTeX\nuses a different set of precompiled commands, contained in format.fmt; it is usually better\nto use the -fmt format option instead.\n\npdfTeX is a version of TeX, with the e-TeX extensions, that can create PDF files as well as\nDVI files.\n\nIn DVI mode, pdfTeX can be used as a complete replacement for the TeX engine.\n\nThe typical use of pdfTeX is with a pregenerated formats for which PDF output has been en‐\nabled. The pdftex command uses the equivalent of the plain TeX format, and the pdflatex com‐\nmand uses the equivalent of the LaTeX format. To generate formats, use the -ini switch.\n\nThe pdfinitex and pdfvirtex commands are pdfTeX's analogues to the initex and virtex com‐\nmands. In this installation, if the links exist, they are symbolic links to the pdftex exe‐\ncutable.\n\nIn PDF mode, pdfTeX can natively handle the PDF, JPG, JBIG2, and PNG graphics formats. pdf‐\nTeX cannot include PostScript or Encapsulated PostScript (EPS) graphics files; first convert\nthem to PDF using epstopdf(1). pdfTeX's handling of its command-line arguments is similar to\nthat of of the other TeX programs in the web2c implementation.\n\nStarting with version 1.40, pdfTeX incorporates the e-TeX extensions, and pdfeTeX is just a\ncopy of pdfTeX. See etex(1).\n", "subsections": [] }, "OPTIONS": { "content": "This version of pdfTeX understands the following command line options.\n", "subsections": [ { "name": "-cnf-line", "content": "Parse string as a texmf.cnf configuration line. See the Kpathsea manual.\n" }, { "name": "-draftmode", "content": "Sets \\pdfdraftmode so pdfTeX doesn't write a PDF and doesn't read any included images,\nthus speeding up execution.\n" }, { "name": "-enc -ini", "content": "For documentation of the encTeX extensions see http://www.olsak.net/enctex.html.\n" }, { "name": "-etex -ini", "content": "See etex(1).\n" }, { "name": "-file-line-error", "content": "Print error messages in the form file:line:error which is similar to the way many com‐\npilers format them.\n" }, { "name": "-no-file-line-error", "content": "Disable printing error messages in the file:line:error style.\n" }, { "name": "-file-line-error-style", "content": "This is the old name of the -file-line-error option.\n" }, { "name": "-fmt", "content": "Use format as the name of the format to be used, instead of the name by which pdfTeX\nwas called or a %& line.\n" }, { "name": "-halt-on-error", "content": "Exit with an error code when an error is encountered during processing.\n" }, { "name": "-help", "content": "" }, { "name": "-ini", "content": "setting, but no format is preloaded, and basic initializations like setting catcodes\nmay be required.\n" }, { "name": "-interaction", "content": "Sets the interaction mode. The mode can be either batchmode, nonstopmode, scrollmode,\nand errorstopmode. The meaning of these modes is the same as that of the correspond‐\ning \\commands.\n" }, { "name": "-ipc", "content": "tion is available is the choice of the installer.\n" }, { "name": "-ipc-start", "content": "As -ipc, and starts the server at the other end as well. Whether this option is\navailable is the choice of the installer.\n" }, { "name": "-jobname", "content": "Use name for the job name, instead of deriving it from the name of the input file.\n" }, { "name": "-kpathsea-debug", "content": "Sets path searching debugging flags according to the bitmask. See the Kpathsea manual\nfor details.\n" }, { "name": "-mktex", "content": "Enable mktexfmt, where fmt must be either tex or tfm.\n" }, { "name": "-mltex -ini", "content": "" }, { "name": "-no-mktex", "content": "Disable mktexfmt, where fmt must be either tex or tfm.\n" }, { "name": "-output-comment", "content": "In DVI mode, use string for the DVI file comment instead of the date. This option is\nignored in PDF mode.\n" }, { "name": "-output-directory", "content": "Write output files in directory instead of the current directory. Look up input files\nin directory first, the along the normal search path.\n" }, { "name": "-output-format", "content": "Set the output format mode, where format must be either pdf or dvi. This also influ‐\nences the set of graphics formats understood by pdfTeX.\n" }, { "name": "-parse-first-line", "content": "If the first line of the main input file begins with %& parse it to look for a dump\nname or a -translate-file option.\n" }, { "name": "-no-parse-first-line", "content": "Disable parsing of the first line of the main input file.\n" }, { "name": "-progname", "content": "Pretend to be program name. This affects both the format used and the search paths.\n" }, { "name": "-recorder", "content": "Enable the filename recorder. This leaves a trace of the files opened for input and\noutput in a file with extension .fls.\n" }, { "name": "-shell-escape", "content": "Enable the \\write18{command} construct. The command can be any shell command. This\nconstruct is normally disallowed for security reasons.\n" }, { "name": "-no-shell-escape", "content": "Disable the \\write18{command} construct, even if it is enabled in the texmf.cnf file.\n" }, { "name": "-shell-restricted", "content": "Enable restricted \\write18{}, as explained in the ``Shell escapes'' section of the\nWeb2c Texinfo manual.\n" }, { "name": "-src-specials", "content": "In DVI mode, insert source specials into the DVI file. This option is ignored in PDF\nmode.\n" }, { "name": "-src-specials", "content": "In DVI mode, insert source specials in certain places of the DVI file. The where argu‐\nment is a comma-separated value list: cr, display, hbox, math, par, parent, or vbox.\nThis option is ignored in PDF mode.\n" }, { "name": "-synctex", "content": "generate SyncTeX data for previewers according to bits of NUMBER. See the synctex man‐\nual page for details.\n" }, { "name": "-translate-file", "content": "Use the tcxname translation table to set the mapping of input characters and re-map‐\nping of output characters.\n" }, { "name": "-default-translate-file", "content": "Like -translate-file except that a %& line can overrule this setting.\n" }, { "name": "-version", "content": "Print version information and exit.\n" }, { "name": "-8bit", "content": "" } ] }, "ENVIRONMENT": { "content": "See the Kpathsea library documentation (e.g., the `Path specifications' node) for precise de‐\ntails of how the environment variables are used. The kpsewhich utility can be used to query\nthe values of the variables.\n\nOne caveat: In most pdfTeX formats, you cannot use ~ in a filename you give directly to pdf‐\nTeX, because ~ is an active character in TeX, and hence is expanded, not taken as part of the\nfilename. Other programs, such as Metafont, do not have this problem.\n\nTEXMFOUTPUT\nNormally, pdfTeX puts its output files in the current directory. If any output file\ncannot be opened there, it tries to open it in the directory specified in the environ‐\nment variable TEXMFOUTPUT. There is no default value for that variable. For example,\nif you say pdftex paper and the current directory is not writable and TEXMFOUTPUT has\nthe value /tmp, pdfTeX attempts to create /tmp/paper.log (and /tmp/paper.pdf, if any\noutput is produced.) TEXMFOUTPUT is also checked for input files, as TeX often gener‐\nates files that need to be subsequently read; for input, no suffixes (such as\n``.tex'') are added by default, the input name is simply checked as given.\n\nTEXINPUTS\nSearch path for \\input and \\openin files. This normally starts with ``.'', so that\nuser files are found before system files. An empty path component will be replaced\nwith the paths defined in the texmf.cnf file. For example, set TEXINPUTS to\n\".:/home/user/tex:\" to prepend the current directory and ``/home/user/tex'' to the\nstandard search path.\n\nTEXFORMATS\nSearch path for format files.\n\nTEXEDIT\nCommand template for switching to editor. The default, usually vi, is set when pdfTeX\nis compiled.\n\nTFMFONTS\nSearch path for font metric (.tfm) files.\n\nSOURCEDATEEPOCH\nIf set, its value, taken to be in epoch-seconds, will be used for the timestamps in\nthe PDF output, such as the CreationDate and ModDate keys. This is useful for making\nreproducible builds.\n\nFORCESOURCEDATE\nIf set to the value \"1\", the time-related TeX primitives (\\year, \\month, \\day, \\time)\nare also initialized from the value of SOURCEDATEEPOCH. This is not recommended if\nthere is any viable alternative.\npdfTeX also has several primitives to support reproducible builds, which are prefer‐\nable to setting these environment variables; see the main manual.\n\nMany, many more environment variables may be consulted related to path searching. See the\nKpathsea manual.\n", "subsections": [] }, "FILES": { "content": "The location of the files mentioned below varies from system to system. Use the kpsewhich\nutility to find their locations.\n\npdftex.map\nFont name mapping definitions.\n\n*.tfm Metric files for pdfTeX's fonts.\n\n*.fmt Predigested pdfTeX format (.fmt) files.\n", "subsections": [] }, "NOTES": { "content": "", "subsections": [] }, "BUGS": { "content": "This version of pdfTeX fails to trap arithmetic overflow when dimensions are added or sub‐\ntracted. Cases where this occurs are rare, but when it does the generated DVI or PDF file\nwill be invalid.\n", "subsections": [] }, "AVAILABILITY": { "content": "pdfTeX is available for a large variety of machine architectures and operating systems. pdf‐\nTeX is part of all major TeX distributions.\nThe pdfTeX home page: http://www.pdftex.org.\npdfTeX on CTAN: https://ctan.org/pkg/pdftex.\npdfTeX mailing list for all discussion: https://lists.tug.org/pdftex.\n", "subsections": [] }, "SEE ALSO": { "content": "This manual page is not meant to be exhaustive. The complete documentation for this version\nof pdfTeX can be found in the pdfTeX user manual and the Texinfo manuals Kpathsea library,\nWeb2C: A TeX implementation. These manuals, and more, can be accessed from the pdfTeX or\nCTAN web pages given above.\n\nSome related programs: epstopdf(1), etex(1), latex(1), luatex(1), mptopdf(1), tex(1), mf(1).\n", "subsections": [] }, "AUTHORS": { "content": "The primary authors of pdfTeX are Han The Thanh, Petr Sojka, Jiri Zlatuska, and Peter Breit‐\nenlohner (eTeX).\n\nTeX was designed by Donald E. Knuth, who implemented it using his Web system for Pascal pro‐\ngrams. It was ported to Unix at Stanford by Howard Trickey, and at Cornell by Pavel Curtis.\nThe version now offered with the Unix TeX distribution is that generated by the Web to C sys‐\ntem (web2c), originally written by Tomas Rokicki and Tim Morgan. The encTeX extensions were\nwritten by Petr Olsak.\n\n\n\nWeb2C 2022/dev 6 August 2019 PDFTEX(1)", "subsections": [] } } } }