Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MIKTEX-PDFTEX(1)		  User Commands 		MIKTEX-PDFTEX(1)

NAME
     miktex-pdftex - DVI/PDF output from TeX

SYNOPSIS
     miktex-pdftex [option...] [[file] | [\command...]]

DESCRIPTION
     This man page is an adaption of the corresponding TeX Live man page.

     Run  the  pdfTeX typesetter on file, usually creating file.pdf. If the file
     argument has no extension, .tex will be appended to it. Instead of  a  file
     name,  a set of pdfTeX commands can be given, the first of which must start
     with a backslash. With a &format argument pdfTeX uses a  different  set  of
     precompiled  commands, contained in format.fmt; it is usually better to use
     the --undump=format option instead.

     pdfTeX is a version of TeX, with the eTeX extensions, that can  create  PDF
     files as well as DVI files.

     In  DVI  mode, pdfTeX can be used as a complete replacement for the TeX en-
     gine.

     The typical use of pdfTeX is with a pregenerated formats for which PDF out-
     put has been enabled. The miktex-pdftex command uses the equivalent of  the
     plain  TeX  format,  and the miktex-pdflatex command uses the equivalent of
     the LaTeX format. To generate formats, use the --initialize switch.

     In PDF mode, pdfTeX can natively handle the PDF, JPG, JBIG2 and PNG  graph-
     ics  formats.   pdfTeX cannot include PostScript or Encapsulated PostScript
     (EPS) graphics files; first convert them to PDF  using  miktex-epstopdf(1).
     pdfTeX's  handling  of  its command-line arguments is similar to that of of
     the other TeX programs in the MiKTeX implementation.

OPTIONS
     --alias=name
	 Pretend to be program name, i.e., set program (and memory dump) name to
	 name.	This may affect the search paths and other  values  used.  Using
	 this  option  is equivalent to copying the program file to name and in-
	 voking name.

     --aux-directory=dir
	 Set dir as the directory to which auxiliary  files  are  written.  Also
	 look for input files in dir first, before along the normal search path.

     --buf-size=n
	 Set the the maximum number of characters simultaneously present in cur-
	 rent  lines  of open files and in control sequences between \csname and
	 \endcsname.  TeX uses the buffer to contain input lines, but macro  ex-
	 pansion  works  by  writing  material into the buffer and reparsing the
	 line. As a consequence, certain constructs require  the  buffer  to  be
	 very  large,  even  though  most  documents can be handled with a small
	 value.

     --c-style-errors
	 Change the way, error messages are printed. The alternate  style  looks
	 like error messages from many compilers and is easier to parse for some
	 editors.

     --disable-8bit-chars
	 Make only 7-bit characters printable.

     --disable-installer
	 Disable  automatic  installation  of  packages.  Specifying this option
	 overrules settings in the MiKTeX configuration data store.

     --disable-write18
	 Disable the \write18{command} construct.

     --dont-parse-first-line
	 Disable checking whether the first line of the main input  file  starts
	 with %&.

     --draftmode
	 Sets \pdfdraftmode so doesn't write a PDF and doesn't read any included
	 images, thus speeding up execution.

     --enable-8bit-chars
	 Make all characters printable.

     --enable-enctex
	 Enable encTeX extensions such as \mubyte.

     --enable-etex
	 Enable eTeX extensions.

     --enable-installer
	 Enable  automatic  installation  of  packages.   Specifying this option
	 overrules settings in the MiKTeX configuration data store.

     --enable-mltex
	 Enable MLTeX extensions such as \charsubdef.

     --enable-write18
	 Fully enable the \write18{command} construct. It is only partially  en-
	 abled	by  default  to avoid security problems. When fully enabled, the
	 command (which undergoes the usual TeX expansions)  is  passed  to  the
	 command  interpreter.	The  output  of the command is not diverted any-
	 where, so it will not appear in the log file. The command execution ei-
	 ther happens at \output time or right away, according to the absence or
	 presence of the \immediate prefix.

     --error-line=n
	 Set the width of context lines on terminal error messages.

     --extra-mem-bot=n
	 Set the extra size (in memory words) for  large  data	structures  like
	 boxes,  glue,	breakpoints,  et al. Relevant only after the memory dump
	 file has been read.

     --extra-mem-top=n
	 Set the extra size (in memory words) for chars, tokens, et al. Relevant
	 only after the memory dump file has been read.

     --font-max=n
	 Set the maximum internal font number.

     --font-mem-size=n
	 Set the size, in TeX memory words, of the font memory.

     --half-error-line=n
	 Set the width of first lines of contexts in terminal error messages.

     --halt-on-error
	 Quit after the first error.

     --hash-extra=n
	 Set the extra space for the hash table of control sequences (which  al-
	 lows 10K names as distributed).

     --help
	 Give help and exit.

     --hhelp
	 This  option is only available on Windows systems: show the manual page
	 in an HTML Help window and exit when the window is closed.

     --include-directory=dir
	 Add the directory dir to the head of the  list  of  directories  to  be
	 searched for input files.

     --initialize
	 Become the INI variant of the program.

     --interaction=mode
	 Set  the interaction mode. Must be one of batchmode, scrollmode and er-
	 rorstopmode. The meaning of these modes is the same as the  correspond-
	 ing commands.

     --job-name=name
	 Set  the  name of the job (\jobname).	This has an affect on the output
	 file names.

     --job-time=file
	 Set the time-stamp of all output files equal to

     --main-memory=n
	 Change the total size (in memory words) of the main memory array. Rele-
	 vant only while creating memory dump files.

     --max-in-open=n
	 Set the maximum number of input files and error insertions that can  be
	 going on simultaneously.

     --max-print-line=n
	 Set the width of longest text lines output; should be at least 60.

     --max-strings=n
	 Set the maximum number of strings.

     --nest-size=n
	 Set the maximum number of semantic levels simultaneously active.

     --no-c-style-errors
	 Don't change the way, error messages are printed.

     --output-directory=dir
	 Write	output	files in dir.  instead of the current directory. Look up
	 input files in dir first, then along the normal search path.

     --output-format=format
	 Set the output format mode, where format must be  either  dvi	or  pdf.
	 This also influences the set of graphics formats understood by pdfTeX.

     --param-size=n
	 Set the the maximum number of simultaneous macro parameters.

     --parse-first-line
	 Check whether the first line of the main input file starts with %&, and
	 parse	if  it does.  This can be used to specify extra command-line op-
	 tions.

     --pool-free=n
	 Set the minimum pool space left after loading the format.

     --pool-size=n
	 Set the maximum number of characters in strings,  including  all  error
	 messages  and	help  texts,  and the names of all fonts and control se-
	 quences.

     --quiet
	 Suppress all output, except errors.

     --record-package-usages=file
	 Record all package usages and write them into file.

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

     --restrict-write18
	 Partially enable the \write18{command} construct.

     --save-size=n
	 Set the the amount of space for saving values outside of current group.

     --src-specials
	 Embed source file information (source specials) in the file.

     --stack-size=n
	 Set the maximum number of simultaneous input sources.

     --string-vacancies=n
	 Set  the  minimum number of characters that should be available for the
	 user's control sequences and font names, after the compiler's own error
	 messages are stored. Must be at least 25000 less  than  pool_size,  but
	 doesn't need to be nearly that large.

     --synctex=n
	 Generate  SyncTeX  data for previewers.  If n is zero, no .synctex file
	 is created. If n is negative, the .synctex file is a text file. If n is
	 positive, the .synctex file is compressed with gzip and  the  .gz  file
	 name extension is added.

	 Furthermore, n is interpreted as a bit field:

	 Bit 1 (n AND 2)
	     Don't add the .gz file name extension.

	 Bit 2 (n AND 4)
	     Activate form support.

	 Bit 3 (n AND 8)
	     Activate better compression.

     --tcx=tcxname
	 Use  the  tcxname translation table to set the mapping of input charac-
	 ters and re-mapping of output characters.

     --time-statistics
	 Show processing time statistics.

     --trace[=tracestreams]
	 Enable trace messages.  The tracestreams argument, if specified,  is  a
	 comma-separated list of trace stream names (Chapter 9, Trace Streams).

     --trie-size=n
	 Set the amount of space for hyphenation patterns.

     --undump=name
	 Use  name  as the name of the format to be used, instead of the name by
	 which the program was called or a

	     %&

	 line.

     --version
	 Show version information and exit.

FILES
     pdftex.cfg(5)

ENVIRONMENT
     MIKTEX_EDITOR
	 The editor to use when selecting e in the error prompt menu.

	 The value can contain these placesholder:

	 %f
	     The name of the file, which contains  the	erroneous  line  of  TeX
	     code.

	 %l
	     The line number.

     MIKTEX_TRACE
	 Comma-separated  list	of  trace  stream  names  (see	Chapter 9, Trace
	 Streams). If this variable is set,  then  MiKTeX  programs  will  write
	 trace messages into the configured log sink.

     TEXINPUTS
	 Extra paths to locate TeX\input and \openin files.

     TEXINPUTS
	 Extra paths to locate TeX\input and \openin files.

     TFMFONTS
	 Extra paths to locate TeX font metric files

SEE ALSO
     miktex-epstopdf(1)

     The full pdfTeX manual can be accessed from the home page or CTAN page.

MiKTeX 25.4			 April 18, 2025 		MIKTEX-PDFTEX(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=miktex-pdftex&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help