MIKTEX-TEX(1)

πŸ“¦ version 25.12, in nixos 26.05, nixpkgs unstable

πŸ¦‹ MIKTEX-TEX(1) β€” miktex-tex πŸ¦‹

Okay bestie, welcome to the miktex-tex manual page β€” filed under User Commands β€” and it is literally the page for text formatting and typesetting. Buckle up, because this is the TeX typesetter and she has lore. πŸ’…

🌸 NAME 🌸

miktex-tex β€” text formatting and typesetting.

✨ SYNOPSIS ✨

miktex-tex [option...] [[file] | [\command...]]

πŸ’– DESCRIPTION πŸ’–

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

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

TeX formats the interspersed text and commands contained in the named files and outputs a typesetter independent file (called DVI, which is short for DeVice Independent). TeX's capabilities and language are described in The TeXbook. TeX is normally used with a large body of precompiled macros, and there are several specific formatting systems, such as LaTeX, which require the support of several macro files.

This version of TeX looks at its command-line to see what name it was called under. Both initex and virtex are links to the miktex-tex executable.

  • When called as initex (or when the -initialize option is given) it can be used to precompile macros into a .fmt file.
  • When called as virtex it will use the plain format.
  • When called under any other name, TeX will use that name as the name of the format to use.
  • For example, when called as miktex-tex the tex format is used, which is identical to the plain format.

The commands defined by the plain format are documented in The TeXbook. Other formats that are often available include latex and amstex.

The non-option command line arguments to the TeX program are passed to it as the first input line. (But it is often easier to type extended arguments as the first input line, since shells tend to gobble up or misinterpret TeX's favorite symbols, like backslashes, unless you quote them.) As described in The TeXbook, that first line should begin with a file name, a \controlsequence, or a &formatname.

The normal usage is to say miktex-tex paper to start processing paper.tex. The name paper will be the β€œjobname”, and is used in forming output file names. If TeX doesn't get a file name in the first line, the job name is texput. When looking for a file, TeX looks for the name with and without the default extension (.tex) appended, unless the name already contains that extension. If paper is the β€œjobname”, a log of error messages, with rather more detail than normally appears on the screen, will appear in paper.log, and the output file will be in paper.dvi.

This version of TeX will look in the first line of the file paper.tex to see if it begins with the magic sequence %&. If the first line begins with %&format --translate-file tcxname, then TeX will use the named format and translation table tcxname to process the source file. Either the format name or the --translate-file specification may be omitted, but not both. This overrides the format selection based on the name by which the program is invoked. The -parse-first-line option or the parse_first_line configuration value controls whether this behaviour is enabled.

The e response to TeX's error-recovery prompt causes the default editor to start up at the current line of the current file. The configuration value [Core]Editor can be used to change the editor used. It may contain a string with %f indicating where the file name goes and %l indicating where the decimal line number (if any) goes. For example, an [Core]Editor string for emacs can be set with the command

> initexmf --set-config-value="[Core]Editor=emacs +%l %f"

A convenient file is null.tex, containing nothing. When TeX can't find a file it thinks you want to input, it keeps asking you for another file name; responding null gets you out of the loop if you don't want to input anything. You can also type your EOF character (usually Control+Z).

✨ OPTIONS ✨

Okay bestie, this is the options section and it is long β€” but every single flag is here, no skips, no cap. πŸ’…

  • --alias=name β€” pretends to be program name, i.e. it sets the program (and memory dump) name to name. This may affect the search paths and other values used. It’s equivalent to copying the program file to name and invoking name.
  • --aux-directory=dir β€” sets dir as the directory where auxiliary files get written. It also looks for input files in dir first, before going along the normal search path.
  • --buf-size=n β€” sets the max number of characters simultaneously present in current lines of open files and in control sequences between \csname and \endcsname. TeX uses the buffer to hold input lines, but macro expansion works by writing material into the buffer and reparsing the line. That means certain constructs need the buffer to be very large, even though most documents can be handled with a small value.
  • --c-style-errors β€” changes how 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 β€” makes only 7-bit characters printable.
  • --disable-installer β€” disables automatic installation of packages. Specifying this option overrules settings in the MiKTeX configuration data store.
  • --disable-write18 β€” disables the \write18{command} construct.
  • --dont-parse-first-line β€” disables checking whether the first line of the main input file starts with %&.
  • --enable-8bit-chars β€” makes all characters printable.
  • --enable-enctex β€” enables encTeX extensions such as \mubyte.
  • --enable-installer β€” enables automatic installation of packages. Specifying this option overrules settings in the MiKTeX configuration data store.
  • --enable-mltex β€” enables MLTeX extensions such as \charsubdef.
  • --enable-write18 β€” fully enables the \write18{command} construct. It is only partially enabled 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 anywhere, so it will not appear in the log file. The command execution either happens at \output time or right away, according to the absence or presence of the \immediate prefix.
  • --error-line=n β€” sets the width of context lines on terminal error messages.
  • --extra-mem-bot=n β€” sets 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 β€” sets the extra size (in memory words) for chars, tokens, et al. Relevant only after the memory dump file has been read.
  • --font-max=n β€” sets the maximum internal font number.
  • --font-mem-size=n β€” sets the size, in TeX memory words, of the font memory.
  • --half-error-line=n β€” sets the width of first lines of contexts in terminal error messages.
  • --halt-on-error β€” quits after the first error.
  • --hash-extra=n β€” sets the extra space for the hash table of control sequences (which allows 10K names as distributed).
  • --help β€” gives help and exits.
  • --hhelp β€” only available on Windows systems: shows the manual page in an HTML Help window and exits when the window is closed.
  • --include-directory=dir β€” adds the directory dir to the head of the list of directories to be searched for input files.
  • --initialize β€” becomes the INI variant of the program.
  • --interaction=mode β€” sets the interaction mode. Must be one of batchmode, scrollmode and errorstopmode. The meaning of these modes is the same as the corresponding commands.
  • --job-name=name β€” sets the name of the job (\jobname). This has an effect on the output file names.
  • --job-time=file β€” sets the time-stamp of all output files equal to (and the source line literally ends there, bestie β€” no extra info to give 😭).
  • --main-memory=n β€” changes the total size (in memory words) of the main memory array. Relevant only while creating memory dump files.
  • --max-in-open=n β€” sets the maximum number of input files and error insertions that can be going on simultaneously.
  • --max-print-line=n β€” sets the width of longest text lines output; should be at least 60.
  • --max-strings=n β€” sets the maximum number of strings.
  • --nest-size=n β€” sets the maximum number of semantic levels simultaneously active.
  • --no-c-style-errors β€” does not change the way error messages are printed.
  • --output-directory=dir β€” writes output files in dir instead of the current directory. Looks up input files in dir first, then along the normal search path.
  • --param-size=n β€” sets the maximum number of simultaneous macro parameters.
  • --parse-first-line β€” checks whether the first line of the main input file starts with %&, and parses it if it does. This can be used to specify extra command-line options.
  • --pool-free=n β€” sets the minimum pool space left after loading the format.
  • --pool-size=n β€” sets the maximum number of characters in strings, including all error messages and help texts, and the names of all fonts and control sequences.
  • --quiet β€” suppresses all output, except errors.
  • --record-package-usages=file β€” records all package usages and writes them into file.
  • --recorder β€” enables 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 enables the \write18{command} construct.
  • --save-size=n β€” sets the amount of space for saving values outside of the current group.
  • --src-specials β€” embeds source file information (source specials) in the file.
  • --stack-size=n β€” sets the maximum number of simultaneous input sources.
  • --string-vacancies=n β€” sets 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.
  • --tcx=tcxname β€” uses the tcxname translation table to set the mapping of input characters and re-mapping of output characters.
  • --time-statistics β€” shows processing time statistics.
  • --trace[=tracestreams] β€” enables trace messages. The tracestreams argument, if specified, is a comma-separated list of trace stream names (Chapter 9, Trace Streams).
  • --trie-size=n β€” sets the amount of space for hyphenation patterns.
  • --undump=name β€” uses name as the name of the format to be used, instead of the name by which the program was called or a %& line.
  • --version β€” shows version information and exits.

🌸 ENVIRONMENT 🌸

Env vars are the little backstage pass for this program, and these are the ones listed:

  • MIKTEX_EDITOR β€” the editor to use when selecting e in the error prompt menu.

The value can contain these placeholders:

  • %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.
  • TFMFONTS β€” extra paths to locate TeX font metric files.

πŸ’€ BUGS πŸ’€

⚠️ Spicy part, bestie: this version of TeX implements a number of optional extensions. In fact, many of these extensions conflict to a greater or lesser extent with the definition of TeX. This version of TeX fails to trap arithmetic overflow when dimensions are added or subtracted. Cases where this occurs are rare, but when it does the generated DVI file will be invalid.

πŸ‘€ SEE ALSO πŸ‘€

978-0201134476. The TeXbook. Donald E. Knuth. Addison-Wesley. 1986.


That’s the end of the page, bestie. Source/version: MiKTeX 25.12; dated December 29, 2025; page name: MIKTEX-TEX(1). Stay iconic, close your groups, and may your DVI never be invalid πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from