Miktex
Miktex
Miktex
Revision 4.6
Christian Schenk
MiKTeX Manual: Revision 4.6
Christian Schenk
Copyright © 2022 Christian Schenk
Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved
on all copies.
Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire
resulting derived work is distributed under the terms of a permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation approved by the Free Software Foundation.
Table of Contents
About this Document ........................................................................................................... v
I. User Guide ..................................................................................................................... 1
1. Introduction ............................................................................................................ 3
About this Manual .............................................................................................. 3
About MiKTeX .................................................................................................. 3
How to Get MiKTeX ........................................................................................... 3
Give Back .......................................................................................................... 3
The MiKTeX Project Page ................................................................................... 3
Documentation .................................................................................................... 4
2. Installing MiKTeX ................................................................................................... 5
Windows ........................................................................................................... 5
macOS .............................................................................................................. 5
Linux ................................................................................................................ 5
3. Using MiKTeX ....................................................................................................... 6
Getting Started .................................................................................................... 6
Unique TeX features ............................................................................................ 6
Automatic Package Installation ...................................................................... 6
Finding out Package Usages ......................................................................... 6
Specifying Additional Input Directories .......................................................... 7
Specifying the Directory for Auxiliary Files ..................................................... 7
texify: The MiKTeX Compiler Driver .................................................................... 7
Printing ............................................................................................................. 8
Using a Viewer to Print DVI/PDF Files .......................................................... 8
Using mtprint to Print DVI Files .................................................................. 8
4. Maintenance ........................................................................................................... 9
Refreshing the File Name Database ........................................................................ 9
Setting the Preferred Paper Format ......................................................................... 9
Installing Updates ............................................................................................... 9
Automatic Package Installation .............................................................................. 9
Integrating Local Additions ................................................................................... 9
5. Advanced Topics ................................................................................................... 11
Managing Font Map Files ................................................................................... 11
Changing TEXMF run-time parameters ................................................................. 11
II. Reference ..................................................................................................................... 13
6. Programs .............................................................................................................. 15
miktex-bibtex .................................................................................................... 16
miktex-dvicopy ................................................................................................. 18
miktex-dvips ..................................................................................................... 20
findtexmf ......................................................................................................... 26
miktex-gftodvi .................................................................................................. 28
initexmf ........................................................................................................... 30
miktex-filesystem .............................................................................................. 32
miktex-filetypes ................................................................................................. 33
miktex-fndb ...................................................................................................... 34
miktex-fontmaps ................................................................................................ 35
miktex-formats .................................................................................................. 36
miktex-links ...................................................................................................... 37
miktex-languages ............................................................................................... 38
miktex-luatex .................................................................................................... 39
miktex-mf ........................................................................................................ 43
miktex-mpost .................................................................................................... 47
iii
MiKTeX Manual
miktex-packages ................................................................................................ 49
miktex-repositories ............................................................................................. 51
miktex ............................................................................................................. 52
miktexsetup ...................................................................................................... 54
mpm ................................................................................................................ 58
mthelp ............................................................................................................. 60
mtprint ............................................................................................................. 62
miktex-pdftex .................................................................................................... 63
setupwiz ........................................................................................................... 68
miktex-tex ........................................................................................................ 70
texify ............................................................................................................... 75
miktex-xetex ..................................................................................................... 77
7. Files .................................................................................................................... 81
miktex.ini ......................................................................................................... 82
pdftex.cfg ....................................................................................................... 101
8. Environment variables ........................................................................................... 103
9. Trace Streams ...................................................................................................... 104
10. Run-Time Defaults ............................................................................................. 106
All MiKTeX Programs ..................................................................................... 106
BibTeX .......................................................................................................... 124
All TeXMF Programs ....................................................................................... 124
All TeX Programs ............................................................................................ 125
pdfTeX .......................................................................................................... 126
METAFONT & MetaPost ................................................................................. 126
METAFONT ................................................................................................... 126
MetaPost ........................................................................................................ 127
Index ............................................................................................................................. 128
iv
About this Document
This is version 4.6 of the MiKTeX manual. It corresponds to MiKTeX 22.8.28 as of August 28, 2022.
v
Part I. User Guide
Table of Contents
1. Introduction .................................................................................................................... 3
About this Manual ...................................................................................................... 3
About MiKTeX .......................................................................................................... 3
How to Get MiKTeX ................................................................................................... 3
Give Back .................................................................................................................. 3
The MiKTeX Project Page ........................................................................................... 3
Documentation ............................................................................................................ 4
2. Installing MiKTeX ........................................................................................................... 5
Windows ................................................................................................................... 5
macOS ...................................................................................................................... 5
Linux ........................................................................................................................ 5
3. Using MiKTeX ............................................................................................................... 6
Getting Started ............................................................................................................ 6
Unique TeX features .................................................................................................... 6
Automatic Package Installation .............................................................................. 6
Finding out Package Usages ................................................................................. 6
Specifying Additional Input Directories .................................................................. 7
Specifying the Directory for Auxiliary Files ............................................................. 7
texify: The MiKTeX Compiler Driver ............................................................................ 7
Printing ..................................................................................................................... 8
Using a Viewer to Print DVI/PDF Files .................................................................. 8
Using mtprint to Print DVI Files .......................................................................... 8
4. Maintenance ................................................................................................................... 9
Refreshing the File Name Database ................................................................................ 9
Setting the Preferred Paper Format ................................................................................. 9
Installing Updates ....................................................................................................... 9
Automatic Package Installation ...................................................................................... 9
Integrating Local Additions ........................................................................................... 9
5. Advanced Topics ........................................................................................................... 11
Managing Font Map Files ........................................................................................... 11
Changing TEXMF run-time parameters ......................................................................... 11
2
Chapter 1. Introduction
About this Manual
This manual is about MiKTeX, a modern implementation of TeX & Friends.
If you are not yet familiar with using TeX (LaTeX), then please consider reading one of the tutorials
available on the Internet.
About MiKTeX
TeX is a typesetting system invented by D. E. Knuth. MiKTeX (pronounced mik-tech) is an
implementation of TeX and related programs.
MiKTeX is available for Windows, macOS and selected Linux distributions. Its main features include:
• Easy to install
• Integrated package management: MiKTeX's integrated package manager installs missing components
from the Internet, if required. This allows users to keep the TeX installation as minimal as possible
(“Just enough TeX”).
• Complete: the MiKTeX distribution contains almost all packages that are freely redistributable.
• Always up-to-date: the MiKTeX package repository is updated regularly and MiKTeX provides tools
to easily install package updates.
• Open source
For selected Linux distributions, you can install MiKTeX via the system package manager frontend. The
MiKTeX download page [https://miktex.org/download] has relevant information available.
Give Back
If you enjoy MiKTeX and want to support the project, then please become a known MiKTeX user by
giving back something. It encourages me to continue, and is the perfect way to say thank you!
Visit the MiKTeX Give Back page [https://miktex.org/giveback], for more information.
3
Introduction
Documentation
Use the mthelp utility to quickly access general TeX related documentation. For example, run mthelp
memoir to view documentation of the memoir package.
4
Chapter 2. Installing MiKTeX
Windows
You use the Basic MiKTeX Installer to install MiKTeX on your Windows computer Please read the
installation tutorial [https://miktex.org/howto/install-miktex], for step-by-step guidance.
macOS
MiKTeX for macOS is distributed as a disk image (.dmg) file. To set up MiKTeX, download and open the
disk image. Then drag the MiKTeX icon onto the Applications folder. Please read the installation tutorial
[https://miktex.org/howto/install-miktex-mac], for step-by-step guidance.
Linux
MiKTeX is available for selected Linux distributions.
1. Register the GPG key with which MiKTeX installation packages and metadata is signed.
2. Register the installation source which contains the MiKTeX installation package. The installation
source depends on the Linux distribution version.
5
Chapter 3. Using MiKTeX
Getting Started
If you have never used TeX before, then it is recommendable to work through one of the TeX/LaTeX
tutorials. A good starting point is the TeX FAQ: https://texfaq.org/.
MiKTeX doesn't differ very much from any other TeX system you might have used before. Typesetting
with MiKTeX involves these steps:
1. Start TeXworks (a sophisticated TeX frontend) and edit your LaTeX document.
It is possible to override the global configuration setting with these command line options:
to create the file packages.txt, which contains the names of the packages used by test.tex.
\documentclass{scrartcl}
\begin{document}
Hello, world!
\end{document}
cm
koma-script
ltxbase
6
Using MiKTeX
The package list can be handed over to the package manager (see mpm(1)), e.g.
mpm --update-some=packages.txt
For example:
This prepends C:\My Styles to the input search path, i.e., C:\My Styles will be searched first,
when TeX tries to find an input file.
This ensures that 1) foo.dvi will be created in C:\texoutput and 2) all other files (foo.log, …)
will be created in C:\tobedeleted.
texify foo.tex
As shown in the example above, the input file names to texify must include any extension (.tex, .ltx,
…).
There are several command line options you can use to control texify (see texify(1)). Here are some
examples:
All auxiliary files will be removed, i.e., only the output foo.dvi file will be left in the current folder.
7
Using MiKTeX
Opens the output file foo.dvi (unless there are compile erros).
Compiles foo.tex with source file information (--src) and then initiates forward DVI search to
open foo.dvi at the source special location “200 foo.tex”. The previewer option -1 re-uses an existing
previewer window.
Printing
Using a Viewer to Print DVI/PDF Files
TeX output files (*.dvi/*.pdf) can be printed from within the viewer.
For example, run mtprint paper to send the DVI file paper.dvi to the default Windows printer.
8
Chapter 4. Maintenance
Refreshing the File Name Database
To speed up file search, MiKTeX makes use of a list of known file names. This list is called the file name
database (FNDB).
It is necessary that you refresh the file name database whenever you manually install TeX/LaTeX-related
files in a user-managed TEXMF directory.
You can update the file name database with the help of MiKTeX Console [https://miktex.org/howto/
miktex-console]. If you prefer the command-line, you can use One MiKTeX Utility (see miktex(1)).
Installing Updates
You can use MiKTeX Console to install the latest MiKTeX updates.
To start MiKTeX Console, search and click the MiKTeX Console icon in the application launcher. Please
read the MiKTeX Console tutorial [https://miktex.org/howto/miktex-console], for a step-by-step guide.
Click Install to start the installation of the package. Click Cancel, to cancel the installation. If you do not
want to see this dialog in the future, clear the mark from the check box Always show this dialog before
installing packages. Your decision will be remembered.
See the section called “Specifying Additional Input Directories”, for more information.
9
Maintenance
set TEXINPUTS=C:\path\to\my\style\files
latex thesis.tex
See Chapter 8, Environment variables, to learn more about MiKTeX environment variables.
Tip
This is the recommended method. You can register TEXMF root directories with the help of
MiKTeX Console [https://miktex.org/howto/miktex-console].
10
Chapter 5. Advanced Topics
Managing Font Map Files
Information about outline fonts is stored in a file by the name of psfonts.map. This file is normally
created automatically. It can be manually created by running miktex fontmaps configure (see
miktex(1)).
psfonts.map depends on the file updmap.cfg. This configuration file contains declarative
instructions, which will be used to build psfonts.map.
Caution
The contents of psfonts.map should never be edited directly. Your modifications get lost
when you install new packages.
For example, follow these steps if you want to add an entry for the font map file xyz.map:
Map xyz.map
main_memory Total words of memory available, for TeX, METAFONT, and MetaPost.
extra_mem_bot Extra space for large TeX data structures: boxes, glue, breakpoints, et al.
See Chapter 10, Run-Time Defaults, for a complete list of the TEXMF run-time parameters.
main_memory=2000000
extra_mem_bot=2000000
font_mem_size=2000000
The name of the configuration file is that of the engine (e.g., miktex-pdftex) or format (e.g, miktex-
pdflatex). You use the --edit-config-file option of initexmf to edit the configuration file, e.g.:
11
Advanced Topics
>
12
Part II. Reference
Table of Contents
6. Programs ...................................................................................................................... 15
miktex-bibtex ............................................................................................................ 16
miktex-dvicopy ......................................................................................................... 18
miktex-dvips ............................................................................................................. 20
findtexmf ................................................................................................................. 26
miktex-gftodvi ........................................................................................................... 28
initexmf ................................................................................................................... 30
miktex-filesystem ...................................................................................................... 32
miktex-filetypes ......................................................................................................... 33
miktex-fndb .............................................................................................................. 34
miktex-fontmaps ........................................................................................................ 35
miktex-formats .......................................................................................................... 36
miktex-links .............................................................................................................. 37
miktex-languages ....................................................................................................... 38
miktex-luatex ............................................................................................................ 39
miktex-mf ................................................................................................................ 43
miktex-mpost ............................................................................................................ 47
miktex-packages ........................................................................................................ 49
miktex-repositories ..................................................................................................... 51
miktex ..................................................................................................................... 52
miktexsetup .............................................................................................................. 54
mpm ........................................................................................................................ 58
mthelp ..................................................................................................................... 60
mtprint ..................................................................................................................... 62
miktex-pdftex ............................................................................................................ 63
setupwiz ................................................................................................................... 68
miktex-tex ................................................................................................................ 70
texify ....................................................................................................................... 75
miktex-xetex ............................................................................................................. 77
7. Files ............................................................................................................................ 81
miktex.ini ................................................................................................................. 82
pdftex.cfg ............................................................................................................... 101
8. Environment variables ................................................................................................... 103
9. Trace Streams .............................................................................................................. 104
10. Run-Time Defaults ..................................................................................................... 106
All MiKTeX Programs ............................................................................................. 106
BibTeX .................................................................................................................. 124
All TeXMF Programs ............................................................................................... 124
All TeX Programs .................................................................................................... 125
pdfTeX .................................................................................................................. 126
METAFONT & MetaPost ......................................................................................... 126
METAFONT ........................................................................................................... 126
MetaPost ................................................................................................................ 127
14
Chapter 6. Programs
15
Programs
Name
miktex-bibtex — make a bibliography for LaTeX
Synopsis
miktex-bibtex [option...] auxfile
Description
This man page is an adaption of the corresponding TeX Live man page.
BibTeX reads the top-level auxiliary (.aux) file that was output during the running of miktex-latex(1)
miktex-tex(1) and creates a bibliography (.bbl) file that will be incorporated into the document on
subsequent runs of LaTeX or TeX.
BibTeX looks up, in bibliographic database (.bib) files specified by the \bibliography command, the
entries specified by the \cite and \nocite commands in the LaTeX or TeX source file. It formats the
information from those entries according to instructions in a bibliography style (.bst) file (specified by
the \bibliographystyle command, and it outputs the results to the .bbl file.
The LaTeX reference manual explains what a LaTeX source file must contain to work with BibTeX.
Appendix B of the manual describes the format of the .bib files. The BibTeXing document describes
extensions and details of this format, and it gives other useful hints for using BibTeX.
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 invoking name.
--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.
--min-crossrefs=n
Defines the minimum number of crossrefs required for automatic
inclusion of the crossref'd entry on the citation list; the default is
two.
16
Programs
--record-package- Record all package usages and write them into file.
usages=file
--version
Show version information and exit.
Environment
BIBINPUTS
Extra paths to locate .bib files.
BSTINPUTS
Extra paths to locate .bst files.
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.
See Also
miktex-latex(1), miktex-tex(1)
978-0201529838. LaTeX: A Document Preparation System. 2nd Edition. Leslie Lamport. Addison-Wesley. 1994.
17
Programs
Name
miktex-dvicopy — produce modified copy of DVI file
Synopsis
miktex-dvicopy [option...] indvi outdvi
Description
This man page is an adaption of the corresponding TeX Live man page.
miktex-dvicopy reads a DVI file, expands any references to virtual fonts to base fonts, and writes the
resulting DVI file. Thus you can use virtual fonts even if your DVI processor does not support them, by
passing the documents through miktex-dvicopy first.
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 invoking name.
--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.
--mag=mag
Override existing magnification with mag.
--max-pages=n
Process n pages; default one million. This option cannot be used
together with --select.
--page-start=pagespec
Start at page-spec, for example 2 or 5.*.-2. This option cannot
be used together with --select.
--record-package- Record all package usages and write them into file.
usages=file
--select=sel
Select pages to be copied.
18
Programs
The syntax for sel is: start [n], where start is the starting
page specification (for example 2 or 5.*.-2) and n (optional) is
the maximum number of pages to be copied.
--version
Show version information and exit.
Environment
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.
19
Programs
Name
miktex-dvips — convert a DVI file to PostScript
Synopsis
miktex-dvips [option...] dvifile
Description
This man page is an adaption of the corresponding TeX Live man page.
Dvips takes a DVI file produced by TeX (or by some other processor such as miktex-gftodvi) and converts
it to PostScript. The DVI file may be specified without the .dvi extension.
Options
Many of the parameterless options listed here can be turned off by suffixing the option with a zero (0); for
instance, to turn off page reversal, use -r0. Such options are marked with a trailing *.
-a* Conserve memory by making three passes over the DVI file instead of two
and only loading those characters actually used. Generally only useful on
machines with a very limited amount of memory.
-A Print only the odd pages. This option uses TeX page numbers, not physical
page numbers.
-b num Generate num copies of each page, but duplicating the page body
rather than using the /#copies PostScript variable. This can be useful in
conjunction with a header file setting bop-hook to do color separations
or other neat tricks.
-B Print only the even pages. This option uses TeX page numbers, not
physical page numbers.
-c num Generate num consecutive copies of every page, i.e., the output is
uncollated. This merely sets the builtin PostScript variable /#copies.
-C num Generate num copies, but collated (by replicating the data in the
PostScript file). Slower than the -c option, but easier on the hands, and
faster than resubmitting the same PostScript file multiple times.
-d num Set the debug flags, showing what Dvips (thinks it) is doing. See the Dvips
manual, for the possible values of num. Use -d -1 as the first option
for maximum output.
-D num Set both the horizontal and vertical resolution to num, given in dpi (dots
per inch). This affects the choice of bitmap fonts that are loaded and also
20
Programs
-e num Maximum drift in pixels of each character from its “true” resolution-
independent position on the page. The default value of this parameter is
resolution dependent (it is the number of entries in the list [100, 200,
300, 400, 500, 600, 800, 1000, 1200, 1600, 2000, 2400, 2800, 3200, …]
that are less than or equal to the resolution in dots per inch). Allowing
individual characters to “drift” from their correctly rounded positions by
a few pixels, while regaining the true position at the beginning of each
new word, improves the spacing of letters in words.
-E* Generate an EPSF file with a tight bounding box. This only looks at marks
made by characters and rules, not by any included graphics. In addition, it
gets the glyph metrics from the TFM file, so characters that print outside
their enclosing TFM box may confuse it. In addition, the bounding box
might be a bit too loose if the character glyph has significant left or right
side bearings. Nonetheless, this option works well enough for creating
small EPSF files for equations or tables or the like. (Of course, Dvips
output, especially when using bitmap fonts, is resolution-dependent and
thus does not make very good EPSF files, especially if the images are to
be scaled; use these EPSF files with care.) For multiple page input files,
also specify -i to get each page as a separate EPSF file; otherwise, all
the pages are overlaid in the single output file.
-f* Read the DVI file from standard input and write the PostScript to standard
output. The standard input must be seekable, so it cannot be a pipe. If your
input must be a pipe, write a shell script that copies the pipe output to a
temporary file and then points Dvips at this file. It turns off the automatic
sending of control-D if it was turned on with the -F option or in the
configuration file; use -F after the -f to send it anyway.
-F* Write control-D (ASCII code 4) as the very last character of the PostScript
file. This is useful when Dvips is driving the printer directly instead
of working through a spooler, as is common on personal systems. On
systems shared by more than one person, this is not recommended.
-h name Prepend name as an additional header file, or, if name is -, suppress all
header files. Any definitions in the header file get added to the PostScript
userdict.
-i* Make each section be a separate file; a section is a part of the document
processed independently, most often created to avoid memory overflow.
The filenames are created replacing the suffix of the supplied output file
name by a three-digit sequence number. This option is most often used in
conjunction with the -S option which sets the maximum section length
21
Programs
On the other hand, if your document uses very large fonts or very large
included figures, Dvips might take it upon itself to split the output into
unwanted sections, to try to avoid overflowing printer memory.
-j* Download only needed characters from Type 1 fonts. This is the default.
Some debugging flags trace this operation. You can also control partial
downloading on a per-font basis.
-k* Print crop marks. This option increases the paper size (which should be
specified, either with a paper size special or with the -T option) by a half
inch in each dimension. It translates each page by a quarter inch and draws
cross-style crop marks. It is mostly useful with typesetters that can set the
page size automatically. This works by downloading crop.pro.
-l [=]num The last page printed will be the first one numbered num. Default is the
last page in the document. If num is prefixed by an equals sign, then it
(and the argument to the -p option, if specified) is treated as a physical
(absolute) page number, rather than a value to compare with the TeX
\count0 values stored in the DVI file. Thus, using -l =9 will end with
the ninth page of the document, no matter what the pages are actually
numbered.
-mode mode Use mode as the METAFONT device name for path searching and font
generation. This overrides any value from configuration files. With the
default paths, explicitly specifying the mode also makes the program
assume the fonts are in a subdirectory named mode.
-N* Turns off generation of structured comments such as %%Page; this may
be necessary on some systems that try to interpret PostScript comments
in weird ways, or on some PostScript printers. Beware: This also disables
page movement, etc., in PostScript viewers such as GSview.
-noomega Disable the use of Omega extensions when interpreting DVI files. By
default, the additional opcodes 129 and 134 are recognized by Dvips
as Omega or pTeX extensions and interpreted as requests to set 2-byte
characters.
22
Programs
-noptex Disable the use of pTeX extensions when interpreting DVI files. By
default, the additional opcodes 130 and 135 are recognized by Dvips as
Omega extensions and interpreted as requests to set 3-byte characters, and
255 as request to change the typesetting direction.
The only drawback is that the virtual font array will (at least temporarily)
require 65536 or more positions instead of the default 256 positions, i.e.,
the memory requirements of Dvips will be somewhat larger. If you find
this unacceptable or encounter another problem with the Omega or pTeX
extensions, you can switch off the pTeX extension by -noptex, or both
by -noomega.
-o name Send output to the file name. If -o is specified without name, the default
is file.ps where the input DVI file was file.dvi. If -o isn't given
at all, the configuration file default is used.
-o turns off the automatic sending of control-D. See the -f option for
how to override this.
If your printer offsets every other page consistently, instead of every page,
your best recourse is to use bop-hook (see the Dvips manual for more
information).
-p [=]num The first page printed will be the first one numbered num. Default is the
first page in the document. If num is prefixed by an equals sign, then it
(and the argument to the -l option, if specified) is treated as a physical
(absolute) page number, rather than a value to compare with the TeX
\count0 values stored in the DVI file. Thus, using -p =3 will start with
the third page of the document, no matter what the pages are actually
numbered.
-pp first-last Print pages first through last; equivalent to -p first -l last,
except that multiple -pp options accumulate, unlike -p and -l. The -
separator can also be :.
-P printer Read the configuration file config.printer, which can set the output
name (most likely o |lpr -Pprinter), resolution, METAFONT
mode, and perhaps font paths and other printer-specific defaults. It works
best to put sitewide defaults in the one master config.ps file and
23
Programs
-q* Run quietly. Don't chatter about pages converted, etc. to standard output;
report no warnings (only errors) to standard error.
-s* Enclose the output in a global save/restore pair. This causes the file to not
be truly conformant, and is thus not recommended, but is useful if you
are driving a deficient printer directly and thus don't care too much about
the portability of the output to other environments.
-S num Set the maximum number of pages in each “section”. This option is most
commonly used with the -i option; see its description above for more
information.
-t papertype Set the paper type to papertype, usually defined in one of the
configuration files, along with the appropriate PostScript code to select
it. You can also specify a papertype of landscape, which rotates a
document by 90 degrees. To rotate a document whose paper type is not
the default, you can use the -t option twice, once for the paper type, and
once for landscape.
In general, you should not use any -t option when using a papaersize
special, which some LaTeX packages (e.g., hyperref) insert
One exception is when using a nonstandard paper size that is not already
defined in config.ps; in this case, you need to specify -t unknown.
-u psmapfile Set psmapfile to be the file that Dvips uses for looking up PostScript
font aliases. If psmapfile starts with a + character, then the rest of the
name is used as the name of the map file, and the map file is appended
to the list of map files (instead of replacing the list). In either case, if the
name has no extension, .map is added at the end.
24
Programs
bitmap information. This is only necessary when driving the Xerox 4045
PostScript interpreter, which has a bug that puts garbage on the bottom
of each character. Not recommended unless you must drive this printer.
-z* Pass html hyperdvi specials through to the output for eventual
distillation into PDF. This is not enabled by default to avoid including
the header files unnecessarily, and use of temporary files in creating the
output.
-Z* Compress bitmap fonts in the output file, thereby reducing the size of what
gets downloaded. Especially useful at high resolutions or when very large
fonts are used. May slow down printing, especially on early 68000-based
PostScript printers. Generally recommend today, and can be enabled in
the configuration file.
Environment
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.
25
Programs
Name
findtexmf — search files in MiKTeX directories
Synopsis
findtexmf [option...] file...
Description
findtexmf can be used to find files in the MiKTeX directories. When the -file-type option is not
given, the search path used when looking for a file is inferred from the name given, by looking for a known
extension. If no known extension is found, the search path for TeX source files is used.
Options
--alias=name
Pretend to be name when finding files.
--help
Give help and exit.
--file-type=filetype
Use the specified file type (see below).
--list-file-types
Print known file types.
--must-exist
Allow installation of a packacke, if a file should exist because it is
a part of the package.
--show-path=filetype
Print the search path for the specified file type (see below).
--start
Start the associated program, if the file was found.
--the-name-of-the-
game=name Set the name of the engine. Relevant when searching for format
files.
--version
Show version information and exit.
File Types
afm (.afm)
base (.base)
bib (.bib)
bst (.bst)
cid maps (.cid;.cidmap)
clua (.dll;.so)
cweb (.w)
dvi (.dvi)
enc (.enc)
26
Programs
executables (.COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC)
font feature files (.fea)
fmt (.fmt)
hbf (.hbf)
graphic/figure (.eps;.epsi;.png)
gf (.gf)
ist (.ist)
lig files (.lig)
lua (.lua;.luatex;.luc;.luctex;.texlua;.texluc;.tlu)
map (.map)
mem (.mem)
mf (.mf)
mfpool (.pool)
mft (.mft)
mlbib (.mlbib;.bib)
mlbst (.bst)
mp (.mp)
mppool (.pool)
ocp (.ocp)
ofm (.ofm;.tfm)
opl (.opl)
opentype fonts (.otf)
otp (.otp)
ovf (.ovf)
ovp (.ovp)
pk (.pk)
PostScript header (.pro;.enc)
subfont definition files (.sfd)
tcx (.tcx)
tex (.tex)
texpool (.pool)
TeX system documentation (.pdf;.html;.md;.txt;.ps;.dvi)
tfm (.tfm)
truetype fonts (.ttf;.ttc)
type1 fonts (.pfb;.pfa)
type42 fonts (.t42;.T42)
vf (.vf)
web (.web)
27
Programs
Name
miktex-gftodvi — make proof sheets from generic font files
Synopsis
miktex-gftodvi [option...] [gffile]
Description
This man page is an adaption of the corresponding TeX Live man page.
The miktex-gftodvi program converts a generic font (GF) file output by, for example, METAFONT, to
a device independent (DVI) file (that can then be typeset using the same software that has already been
written for). The characters in the GF file will appear one per page, with labels, titles, and annotations as
specified in Appendix H (Hardcopy Proofs) of The METAFONTbook.
miktex-gftodvi uses other fonts in addition to the main GF file. A “gray” font is used to typeset the pixels
that actually make up the character. (We wouldn't want all the pixels to be simply black, since then labels,
key points, and other information would be lost.) A “title” font is used for the information at the top of
the page. A “label” font is used for the labels on key points of the figure. A “slant” font is used to typeset
diagonal lines, which otherwise have to be simulated using horizontal and vertical rules. The default gray,
title, and label fonts are gray, cmr8, and cmtt10, respectively; there is no default slant font.
To change the default fonts, you can give special commands in your source file, or you can change the
fonts on the command-line.
The GF file name on the command-line must be complete. Because the resolution is part of the extension,
it would not make sense to append a default extension as is done with other DVI-reading software. The
output file name defaults to the same root as the GF file, with the .dvi extension added. For example,
the input file cmr10.2602gf would become cmr10.dvi.
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 invoking name.
--gray-font=font
Sets the “gray” font. Default is gray.
--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.
28
Programs
--include-directory=dir Add the directory dir to the head of the list of directories to be
searched for input files.
--label-font=font
Sets the “label” font. Default is cmtt10.
--logo-font=font
Sets the “logo” font. Default is logo8.
--overflow-label-
offset=real Specifies the distance from the right edge of the character bounding
box at which the overflow equations (if any) are typeset. The value
is given in points. The default is a little over two inches.
--record-package- Record all package usages and write them into file.
usages=file
-slant-font=font
Sets the “slant” font. There is no default.
-title-font=font
Sets the “title” font. Default is cmr8.
--version
Show version information and exit.
Environment
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.
See also
miktex-mf(1)
29
Programs
Name
initexmf — MiKTeX configuration utility
Synopsis
initexmf [option...]
Description
initexmf can be used to configure MiKTeX.
User mode (default) MiKTeX operates on user-scoped configuration and data files.
Administrator mode Only system-wide MiKTeX configuration and data files are modified,
assuming that the MiKTeX setup is shared by all users. The utility must be
run with administrator privileges.
By default, the utility runs in user mode. You can turn on administrator mode with the --admin option.
Options
--admin Run in administrator mode:
--default-paper-
size=paper
--edit-config-
file=configfile Open the specified config file in a text editor.
--list-modes
--print-only
Print what would be done. Nothing is changed.
--quiet
Suppress screen output.
--register-root=dir
30
--report
Programs
--set-config-
Set a value to be stored in the MiKTeX configuration data store (see
value=[section]valuename=value
miktex.ini(5)).
--show-config-
value=[section]valuename Print a value from the MiKTeX configuration data store (see
miktex.ini(5)).
--unregister-root=dir
--verbose
Print information on what is being done.
--version
Print the version number and exit.
See also
miktex(1), miktex.ini(5)
31
Programs
Name
miktex-filesystem — watch the file system
Synopsis
miktex [common-option...] filesystem command [command-option-or-parameter...]
Description
Commands for watching the file system.
Commands
watch [--template Watch for changes in a directory.
template] directory
template controls the output of each directory event. It can
contain the following placeholders:
{action}, {fileName}
See also
miktex(1)
32
Programs
Name
miktex-filetypes — manage Windows filetypes
Synopsis
miktex [common-option...] filetypes command [command-option-or-parameter...]
Description
Commands for managing Windows file types.
Commands
list [--template template] List Windows file types.
See also
miktex(1)
33
Programs
Name
miktex-fndb — manage the MiKTeX file name database
Synopsis
miktex [common-option...] fndb command [command-option-or-parameter...]
Description
Commands for managing the MiKTeX file name database.
Commands
refresh
Refresh the MiKTeX file name database.
See also
miktex(1)
34
Programs
Name
miktex-fontmaps — manage PDF/PostScript font maps
Synopsis
miktex [common-option...] fontmaps command [command-option-or-parameter...]
Description
Commands for managing PDF/PostScript font maps.
Commands
configure
Configure font map files for PDF/PostScript output drivers.
{name}, {value}
See also
miktex(1)
35
Programs
Name
miktex-formats — manage TeX formats
Synopsis
miktex [common-option...] formats command [command-option-or-parameter...]
Description
Commands for managing TeX formats and METAFONT bases.
Commands
build [--engine engine]
[key]
See also
miktex(1)
36
Programs
Name
miktex-links — manage links from scripts and formats to executables
Synopsis
miktex [common-option...] links command [command-option-or-parameter...]
Description
Commands for managing links from scripts and formats to executables.
Commands
install [--force] Install all links. Existing links will be overwritten, if --force is
specified.
See also
miktex(1)
37
Programs
Name
miktex-languages — manage LaTeX language definitions
Synopsis
miktex [common-option...] languages command [command-option-or-parameter...]
Description
Commands for managing LaTeX language definitions.
Commands
configure
Configure LaTeX language definition files.
See also
miktex(1)
38
Programs
Name
miktex-luatex — an extended version of pdfTeX using Lua as an embedded scripting language
Synopsis
miktex-luatex [option...] [[command...] | [file]]
Description
This man page is an adaption of the corresponding TeX Live man page.
Run the LuaTeX typesetter on file, usually creating file.pdf. Any remaining commands are
processed as LuaTeX input, after file is read.
Alternatively, if the first non-option argument begins with a backslash, interpret all non-option arguments
as a line of LuaTeX input.
Alternatively, if the first non-option argument begins with a &, the next word is taken as the format to
read, overriding all else. Any remaining arguments are processed as above.
If called as miktex-texlua it acts as Lua interpreter. If called as miktex-texluac it acts as Lua bytecode
compiler.
LuaTeX is an extended version of pdfTeX with Unicode and OpenType font support, embeded Lua
scripting language, the eTeX and Omega extensions, as well as integrated MetaPost engine, that can create
PDF files as well as DVI files. For more information about LuaTeX, see http://www.luatex.org, you can
read the LuaTeX manual using the MiKTeX Help Utility (mthelp luatex).
In DVI mode, LuaTeX can be used as a complete replacement for the TeX engine.
In PDF mode, LuaTeX can natively handle the PDF, JPG, JBIG2, and PNG graphics formats. LuaTeX
cannot include PostScript or Encapsulated PostScript (EPS) graphics files; first convert them to PDF using
miktex-epstopdf(1).
Options
When the LuaTeX executable starts, it looks for the --lua commandline option. If there is no --lua
option, the commandline is interpreted in a similar fashion as in traditional pdfTeX. But if the option is
present, LuaTeX will enter an alternative mode of commandline parsing in comparison to the standard
MiKTeX programs. The presence of --lua makes most of other options unreliable, because the Lua
initialization file can disable path searching and/or hook functions into various callbacks.
--luaonly Start LuaTeX as a Lua interpreter. In this mode, it will set Lua’s arg[0] to the
found script name, pushing preceding options in negative values and the rest of the
commandline in the positive values, just like the Lua interpreter. LuaTeX will exit
immediately after executing the specified Lua script.
39
Programs
--luaconly Start LuaTeX as a Lua byte compiler. In this mode, LuaTeX is exactly like luac from
the standalone Lua distribution, except that it does not have the #l switch, and that it
accepts (but ignores) the ##luaconly switch.
--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 invoking 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.
--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-write18
--draftmode Switch on draft mode. luaTeX; doesn't write a PDF and doesn't read
any included images, thus speeding up execution.
--enable-write18
--help
Give help and exit.
--include-directory=dir Add the directory dir to the head of the list of directories to be
searched for input files.
--job-name=name Set the name of the job (\jobname). This has an affect on the output
file names.
--mktex=fmt
Enable fmt generation, where fmt must be either tex or tfm.
--no-mktex=fmt
Disable fmt generation, where fmt must be either tex or tfm.
40
Programs
--nosocket
Disable the Lua socket library.
--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 Use format for job output (one of: dvi, pdf).
--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
--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.
Environment
MIKTEX_EDITOR
The editor to use when selecting e in the error prompt menu.
%f The name of the file, which contains the erroneous line of TeX code.
41
Programs
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.
See Also
miktex-epstopdf(1), miktex-pdftex(1)
42
Programs
Name
miktex-mf — METAFONT, a language for font and logo design
Synopsis
miktex-mf [option...] [[command...] | [file]]
Description
This man page is an adaption of the corresponding TeX Live man page.
METAFONT reads the program in the specified files and outputs font rasters (in GF format) and font
metrics (in TFM format). The METAFONT language is described in The METAFONTbook.
Like TeX, METAFONT is normally used with a large body of precompiled macros, and font generation in
particular requires the support of several macro files. This version of METAFONT looks at its command
line to see what name it was called under. Both inimf and virmf are links to the miktex-mf executable.
When called as inimf (or when the --initialize option is given) it can be used to precompile macros
into a .base file. When called as virmf it will use the plain base. When called under any other name,
METAFONT will use that name as the name of the base to use. For example, when called as miktex-mf
the mf base is used, which is identical to the plain base. Other bases than plain are rarely used.
The commands given on the command line to the METAFONT 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 METAFONT's favorite symbols, like semicolons, unless you quote them.) As described in
The METAFONTbook, that first line should begin with a filename, a \controlsequence, or a &basename.
The normal usage is to say miktex-mf \mode=printengine; input font to start processing
font.mf. (Or you can just say miktex-mf and give the other stuff on the next line.) Other control
sequences, such as batchmode (for silent operation) can also appear. The name font will be the
“jobname”, and is used in forming output file names. If METAFONT doesn't get a file name in the first
line, the job name is mfput. The default extension, .mf, can be overridden by specifying an extension
explicitly.
A log of error messages goes into the file jobname.log. The output files are jobname.tfm and
jobname.numbergf, where number depends on the resolution and magnification of the font. The
mode in this example is shown generically as printengine, a symbolic term for which the name of
an actual device or, most commonly, the name localfont (see below) must be substituted. If the mode
is not specified or is not valid, METAFONT will default to proof mode which produces large character
images for use in font design and refinement. Proof mode can be recognized by the suffix .2602gf after
the job name. Examples of proof mode output can be found in Computer Modern Typefaces (Volume E of
Computers and Typesetting). The system of magsteps is identical to the system used by TeX, with values
generally in the range 0.5, 1.0, 2.0, 3.0, 4.0 and 5.0.
Magnification can also be specified not as a magstep but as an arbitrary value, such as 1.315, to create
special character sizes.
Before font production can begin, it is necessary to set up the appropriate base files. The minimum set
of components for font production for a given printengine is the plain.mf macro file and the local
mode_def file. The macros in plain.mf can be studied in an appendix to The METAFONTbook; they
were developed by Donald E. Knuth, and this file should never be altered except when it is officially
upgraded. Each mode_def specification helps adapt fonts to a particular printengine. The local ones in use
on this computer should be in modes.mf.
43
Programs
The e response to METAFONT'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
A convenient file is null.mf, containing nothing. When METAFONT can't find the 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.
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 invoking 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.
--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.
--dont-parse-first-line Disable checking whether the first line of the main input file starts
with %&.
--half-error-line=n Set the width of first lines of contexts in terminal error messages.
--help
44
Programs
--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.
--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 file's time-stamp.
--main-memory=n Change the total size (in memory words) of the main memory array.
Relevant only while creating memory dump files.
--max-print-line=n Set the width of longest text lines output; should be at least 60.
--move-size=n Set the the space for storing moves in a single octant.
--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.
--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 options.
--record-package- Record all package usages and write them into file.
usages=file
45
Programs
--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.
--screen
Enable screen output.
--tcx=tcxname
--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.
Environment
MFINPUTS
Extra paths to locate METAFONT input and openin files.
MIKTEX_EDITOR
The editor to use when selecting e in the error prompt menu.
%f The name of the file, which contains the erroneous line of TeX code.
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.
See also
978-0201134452. The METAFONTbook. Donald E. Knuth. Addison-Wesley. 1986.
46
Programs
Name
miktex-mpost — MetaPost, a system for creating graphics
Synopsis
miktex-mpost [option...] [[command...] | [file]]
Description
This man page is an adaption of the corresponding TeX Live man page.
MetaPost interprets the MetaPost language and produces PostScript (EPS) or Scalable Vector Graphics
(SVG) pictures. The MetaPost language is similar to Knuth's METAFONT with additional features for
including TeX commands and accessing features of PostScript not found in METAFONT.
MetaPost is normally used with some preloaded macros, and it will use its executable name as the name
of the preload file to use. For example, when called as miktex-mpost the mpost.mp file is used, which
is identical to plain.mp. When the --initialize option is given, preloading does not happen.
The commands given on the command line to the MetaPost 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 MetaPost's favorite symbols, like semicolons, unless you quote them.) The normal usage
is to say miktex-mpost figs to process the file figs.mp. The basename of figs becomes the
“jobname”, and is used in forming output file names. If no file is named, the jobname becomes mpout.
The default extension, .mp, can be overridden by specifying an extension explicitly.
When the --dvitomp option is given, MetaPost acts as DVI-to-MPX converter only. Run miktex-
mpost --dvitomp --help for option explanation.
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 invoking name.
--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.
--help
Give help and exit.
--job-name=name Set the name of the job (\jobname). This has an affect on the output
file names.
47
Programs
--numbersystem=string Set number system mode (string one of: scaled, double,
binary, decimal).
--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.
--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.
--tex=texprogram
Use texprogram instead of miktex-tex when compiling text labels.
--troff
Set prologues:=1 and assume --tex=troff.
--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.
Environment
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.
MPINPUTS
Extra paths to locate MetaPost input files.
MPINPUTS
Extra paths to locate MetaPost input files.
48
Programs
Name
miktex-packages — manage MiKTeX packages
Synopsis
miktex [common-option...] packages command [command-option-or-parameter...]
Description
Commands for managing MiKTeX packages.
Commands
check-update [--repository Check for MiKTeX package updates. The exit code will be 100,
url-or-directory] when package updates are available.
check-upgrade [--repository Check for a MiKTeX upgrade. The exit code will be 100, when an
url-or-directory] upgrade is available.
package-level
{archiveFileSize}, {copyrightOwner},
{copyrightYear}, {creator}, {ctanPath},
{description}, {digest}, {displayName},
{docFiles}, {id}, {isContained}, {isContainer},
{isInstalled}, {isInstalledCommon},
{isInstalledUser}, {isObsolete},
{isPureContainer}, {isRemovable},
{licenseType}, {minTargetSystemVersion},
{numFiles}, {refCount}, {releaseState},
{requiredBy}, {requiredPackages}, {runFiles},
{size}, {sizeDocFiles}, {sizeRunFiles},
{sizeSourceFiles}, {sourceFiles},
{targetSystem}, {timeInstalled},
{timeInstalledCommon}, {timeInstalledUser},
{timePackaged}, {title}, {version},
{versionDate}
49
Programs
See also
miktex(1)
50
Programs
Name
miktex-repositories — manage MiKTeX package repositories
Synopsis
miktex [common-option...] repositories command [command-option...]
Description
Commands for managing MiKTeX package repositories.
Commands
check-bandwidth [-- Check the bandwidth of MiKTeX package repositories.
template=template] [--
url=url] template controls the output of each record. See the info
command, for a list of possible placeholders.
See also
miktex(1)
51
Programs
Name
miktex — One MiKTeX Utility
Synopsis
miktex [common-option...] topic command [command-option-or-parameter...]
Description
miktex is the utility to configure and maintain a MiKTeX installation.
User mode (default) MiKTeX operates on user-scoped configuration and data files.
Administrator mode Only system-wide MiKTeX configuration and data files are modified,
assuming that the MiKTeX setup is shared by all users. The utility must be
run with administrator privileges.
By default, the utility runs in user mode. You can turn on administrator mode with the --admin option.
For example, if you want to update the system-wide file name database, you invoke the utility as follows:
Common options
--admin Run in administrator mode:
Using this option requires a shared MiKTeX setup, i.e., MiKTeX must
have been set up for all users. The program must be run with administrator
privileges.
--quiet
Suppress screen output.
--verbose
Increase the verbosity level.
--version
Print the version number and exit.
Topics
miktex-filesystem(1) Commands for watching the file system.
52
Programs
See also
miktex.ini(5)
53
Programs
Name
miktexsetup — MiKTeX setup utility
Synopsis
miktexsetup_standalone [options] download
Description
The MiKTeX Setup Utility is used to download, set up and remove MiKTeX. This utility is the command
line counterpart of the MiKTeX Setup Wizard. It is suitable for unattended setup tasks.
The download task creates a local package package repository which is a mirror of the remote package
repository. It is possible to run the task on a regular basis in order to maintain an up-to-date package
repository.
The install task installs MiKTeX from a local package repository. This task is only available in the
standalone variant.
The uninstall task removes MiKTeX. This task is only available in the integrated variant and only
on Windows.
Options
--common-config=dir Set the location of the common configuration directory. This option
requires administrator privileges.
--common-data=dir Set the location of the common data directory. This option requires
administrator privileges.
--list-repositories Download the list of known package repository URLs, then print
the list.
54
Programs
--shared=yes Run the task for all users. This option requires administrator
privileges.
--use-registry=no Don't write configuration settings into the Windows registry. Use
configuration files instead.
--user-config=dir Set the location of the configuration directory for the current user.
--user-data=dir Set the location of the data directory for the current user.
--user-roots=dirs Register additional directories for the current user. dirs must be
a semicolon-separated list of fully qualified path names.
55
Programs
--version
Show version information and exit.
Examples
Downloading
The first task is to download MiKTeX into a local package repository:
> miktexsetup_standalone ^
--verbose ^
--local-package-repository=C:\miktex-repository ^
--package-set=complete ^
download
It is possible to interrupt (Control+C) this operation at anytime and resume it later by running the same
command again.
> miktexsetup_standalone ^
--verbose ^
--local-package-repository=C:\miktex-repository ^
--shared=yes ^
--user-config="<APPDATA>\MiKTeX" ^
--user-data="<LOCALAPPDATA>\MiKTeX" ^
--user-install=<APPDATA>\MiKTeX" ^
--print-info-only
install
setup task: install from local package repository
local package repository: C:\miktex-repository
package level: complete
install for all users?: yes
use registry?: yes
modify path?: yes
common install root: "C:\Program Files (x86)\MiKTeX"
user install root: <APPDATA>\MiKTeX
user config root: <LOCALAPPDATA>\MiKTeX
user data root: <APPDATA>\MiKTeX
program folder name: "MiKTeX"
Uninstalling
MiKTeX can be removed by selecting the uninstall task (only available in the integrated variant on
Windows). --shared=yes should be specified, if MiKTeX is installed for all users.
56
Programs
57
Programs
Name
mpm — MiKTeX package manager
Synopsis
mpm [option...]
Description
MPM starts in windowed mode, if you do not specify any command-line options.
User mode (default) MPM operates on the user installation directory (usually
%LOCALAPPDATA%\Programs\MiKTeX 2.9).
By default, MPM runs in user mode. You can turn on administrator mode with the --admin option. For
example, if you want to install a package for all users, you invoke MPM as follows:
Options
--admin Run in administrator mode:
--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.
--import=package
Import the specified package from another MiKTeX installation.
The root directory must be specified via --repository=dir.
--import-all
Import all packages from another MiKTeX installation. The root
directory must be specified via --repository=dir.
58
Programs
--pick-repository-url Pick up a suitable URL from the package repository list and print it.
--repository=location Use the specified location as the package repository. The location
can be either a fully qualified path name (a local package
repository) or an URL (a remote package repository).
--set-
repository=location Store the location of the default package repository in the MiKTeX
configuration data store. The location can be either a fully qualified
path name (a local package repository) or an URL (a remote
package repository).
--version
Show version information and exit.
Environment
MIKTEX_REPOSITORY
Location of the default package repository. This can be either a fully qualified
path name (a local package repository) or an URL (a remote package
repository).
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.
NO_PROXY Comma-separated list of host names that should not go through any proxy.
See also
miktex(1)
59
Programs
Name
mthelp — MiKTeX help utility
Synopsis
mthelp [option...] {name...}
Description
mthelp is a utility to look up MiKTeX related documentation.
mthelp creates an HTML page which contains a short description of the package together with links to all
documentation files. An HTML viewer is started to view the page.
You can use the --view to bypass the intermediate HTML file.
Options
--list-only List documentation files, but do not start a viewer.
--print-only Print the command that would be executed to view the documentation, but do not start
the command.
--version
Show version information and exit.
Environment
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.
The environment variables should be set with a “%f” as a placeholder for the name of the file. For example:
60
Programs
Files
The intermediate HTML file (package.html) is stored in the directory miktex/mthelp relative to
the data TEXMF data root (usually %LOCALAPPDATA%\MiKTeX\2.9).
See also
MiKTeX Project Page [https://miktex.org/]
Environment
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.
61
Programs
Name
mtprint — MiKTeX print utility
Synopsis
mtprint [option...] file...
Description
mtprint sends TeX output files to a printing device.
Options
--even-only
Prints only even TeX pages.
--landscape
Selects landscape output format.
--odd-only
Prints only odd TeX pages.
--page-range=range
Selects a TeX page range (e.g., 20–21). Multiple --page-range
options accumulate
--print-method=method
Selects a print method. One of
psbmp This method uses Dvips and Ghostscript to produce the print
output.
--print-nothing
Simulates printing.
--printer=printer
Selects a printing device. The default printer is used, if this option is
omitted.
62
Programs
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 engine.
The typical use of pdfTeX is with a pregenerated formats for which PDF output 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 graphics 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 invoking 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.
--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.
63
Programs
--disable-write18
--dont-parse-first-line Disable checking whether the first line of the main input file starts
with %&.
--draftmode Sets \pdfdraftmode so pdfTeX doesn't write a PDF and doesn't read
any included images, thus speeding up execution.
--enable-enctex
Enable encTeX extensions such as \mubyte.
--enable-etex
Enable eTeX extensions.
--enable-mltex
Enable MLTeX extensions such as \charsubdef.
--enable-write18
--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-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.
--hash-extra=n Set the extra space for the hash table of control sequences (which
allows 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.
--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 file's time-stamp.
--main-memory=n Change the total size (in memory words) of the main memory array.
Relevant 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.
--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.
--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 options.
--pool-free=n Set the minimum pool space left after loading the format.
--record-package- Record all package usages and write them into file.
usages=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
--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 DVI file.
65
Programs
--tcx=tcxname
--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.
%f The name of the file, which contains the erroneous line of TeX code.
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
66
Programs
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.
67
Programs
Name
setupwiz — MiKTeX setup wizard
Synopsis
basic-miktex-22.8.28.exe [options]
setup-22.8.28.exe [options]
Description
MiKTeX Setup Wizard is used to install MiKTeX.
Basic MiKTeX Installer (basic- Basic MiKTeX Installer is used to set up a basic MiKTeX system.
miktex-22.8.28.exe) All required resources are embedded in the installer, i.e., nothing
else needs to be downloaded from the Internet.
MiKTeX Net Installer MiKTeX Net Installer is used to set up a complete MiKTeX system.
(setup-22.8.28.exe) In a first step, all required resources will be downloaded from the
Internet. In a second step, a complete MiKTeX system is installed.
Both installers read command-line options from the file setupwiz.opt, if it exists.
Options
--allow-unattended- Restart the system, if necessary.
reboot
--common-config=dir Set the location of the common configuration directory. This option
requires administrator privileges.
--common-data=dir Set the location of the common data directory. This option requires
administrator privileges.
68
Programs
--no-registry Do not store path information in the Windows Registry but write
the startup configuration file (miktexstartup.ini).
--shared Install MiKTeX for everyone using this computer. This option
requires administrator privileges.
--user-config=dir Set the location of the configuration directory for the current user.
--user-data=dir Set the location of the data directory for the current user.
--user-roots=dirs Register additional directories for the current user. dirs must be
a semicolon-separated list of fully qualified path names.
Examples
In this example, MiKTeX is installed from a network share (\\server\miktex\repository). User
directories are specified by using environment variables (<VARNAME>) which are expanded at run-time.
69
Programs
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 argiments 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 transation 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
70
Programs
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
--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 invoking 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.
--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-write18
--dont-parse-first-line Disable checking whether the first line of the main input file starts
with %&.
--enable-enctex
Enable encTeX extensions such as \mubyte.
--enable-mltex
Enable MLTeX extensions such as \charsubdef.
--enable-write18
--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-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.
--hash-extra=n Set the extra space for the hash table of control sequences (which
allows 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.
--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 file's time-stamp.
--main-memory=n Change the total size (in memory words) of the main memory array.
Relevant 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.
--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.
--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 options.
--pool-free=n Set the minimum pool space left after loading the format.
72
Programs
--record-package- Record all package usages and write them into file.
usages=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
--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 DVI file.
--tcx=tcxname
--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.
Environment
MIKTEX_EDITOR
The editor to use when selecting e in the error prompt menu.
%f The name of the file, which contains the erroneous line of TeX code.
MIKTEX_TRACE
73
Programs
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
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
texify(1)
74
Programs
Name
texify — MiKTeX compiler driver
Synopsis
texify [option...] file...
Description
texify runs Texinfo or LaTeX input files through miktex-tex (miktex-pdftex) in turn until all cross-
references are resolved, building all indices.
The directory containing each file is searched for included files. The suffix of file is used to determine
its language (LaTeX or Texinfo).
makeinfo is used to perform Texinfo macro expansion before running miktex-tex when needed.
Options
-@ Use @input (instead of \input); for preloaded Texinfo.
--batch, -b
No interaction.
--clean, -c
Remove all auxiliary files.
--expand, -e
Force macro expansion using makeinfo.
--help, -h
Display help and exit successfully.
--language=lang, -l
lang Specify the language of input files: either latex or texinfo.
--max-iterations=n
Limits the number of iterations to prevent endless processing. The
default for n is 5.
--mkidx-option=option
Pass option to the index generator.
--pdf, -p
Use miktex-pdftex (or miktex-pdflatex) for processing.
--run-viewer
Run a viewer on the resulting DVI (PDF) file.
--src
Pass --src-specials to the TeX compiler.
75
Programs
--texinfo=cmd, -t=cmd
Insert cmd after @setfilename in copy of input file. Multiple
values accumulate.
--tex-option=option
Pass option to the compiler.
--verbose, -V
Print information on what is being done.
--version, -v
Display version information and exit successfully.
--viewer-option=option
Pass option to the viewer.
Environment Variables
The values of the BIBTEX, LATEX (or PDFLATEX), MAKEINDEX, MAKEINFO, TEX (or PDFTEX), and
TEXINDEX environment variables are used to run those commands, if they are set.
76
Programs
Name
miktex-xetex — Unicode-based TeX engine
Synopsis
miktex-xetex [option...] [[file] | [\command...]]
Description
This man page is an adaption of the corresponding TeX Live man page.
Run the XeTeX 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 XeTeX commands can be given, the first of
which must start with a backslash.
XeTeX has simple font installation; it can use any installed fonts in the operating system without
configuring TeX font metric. As a result, XeTeX can access font features such as special ligatures and
variable font weights.
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 invoking 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.
--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-write18
--dont-parse-first-line Disable checking whether the first line of the main input file starts
with %&.
--enable-etex
Enable eTeX extensions.
77
Programs
--enable-mltex
Enable MLTeX extensions such as \charsubdef.
--enable-write18
--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-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.
--hash-extra=n Set the extra space for the hash table of control sequences (which
allows 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.
--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 file's time-stamp.
--main-memory=n Change the total size (in memory words) of the main memory array.
Relevant 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.
78
Programs
--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.
--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 options.
--pool-free=n Set the minimum pool space left after loading the format.
--record-package- Record all package usages and write them into file.
usages=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
--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 DVI file.
79
Programs
--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.
Environment
MIKTEX_EDITOR
The editor to use when selecting e in the error prompt menu.
%f The name of the file, which contains the erroneous line of TeX code.
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
80
Chapter 7. Files
81
Files
Name
miktex.ini — MiKTeX configuration data store
Description
MiKTeX configurations settings are read from the file miktex.ini.
Syntax
The syntax follows the informal conventions of a traditional INI file [https://en.wikipedia.org/wiki/
INI_file].
Settings Reference
[General]
;; Deprecated.
;GUIFramework = 1
;; Deprecated.
;UserInfoFile =
[Core]
82
Files
AllowedShellCommands[] = miktex-gregorio
AllowedShellCommands[] = miktex-kpsewhich
AllowedShellCommands[] = miktex-makeindex
AllowedShellCommands[] = bibtex
AllowedShellCommands[] = bibtex8
AllowedShellCommands[] = extractbb
AllowedShellCommands[] = findtexmf
AllowedShellCommands[] = gregorio
AllowedShellCommands[] = kpsewhich
AllowedShellCommands[] = makeindex
AllowedShellCommands[] = texosquery-jre8
;; Deprecated.
;NoRegistry =
83
Files
;; Trace flags.
Trace =
;; Preferred UI languages.
;UILanguages[] =
[Core.FileTypes.afm]
84
Files
Paths[] = .
Paths[] = %R/fonts/afm//
[Core.FileTypes.base]
[Core.FileTypes.bib]
[Core.FileTypes.bst]
[Core.FileTypes.cid maps]
85
Files
EnvVars[] = FONTCIDMAPS
[Core.FileTypes.clua]
[Core.FileTypes.cmap files]
[Core.FileTypes.cweb]
[Core.FileTypes.dvi]
[Core.FileTypes.dvips config]
86
Files
[Core.FileTypes.enc]
[Core.FileTypes.fmt]
[Core.FileTypes.gf]
87
Files
EnvVars[] = TEXFONTS
[Core.FileTypes.bitmap font]
[Core.FileTypes.graphic/figure]
[Core.FileTypes.hbf]
[Core.FileTypes.ist]
88
Files
[Core.FileTypes.lig files]
[Core.FileTypes.ls-R]
[Core.FileTypes.lua]
[Core.FileTypes.map]
89
Files
[Core.FileTypes.mem]
[Core.FileTypes.mf]
[Core.FileTypes.mfpool]
[Core.FileTypes.mft]
[Core.FileTypes.misc fonts]
90
Files
[Core.FileTypes.mlbib]
[Core.FileTypes.mlbst]
[Core.FileTypes.mp]
[Core.FileTypes.mppool]
91
Files
[Core.FileTypes.MetaPost support]
[Core.FileTypes.ocp]
[Core.FileTypes.ofm]
[Core.FileTypes.opl]
92
Files
Paths[] = %R/fonts/opl//
[Core.FileTypes.otp]
[Core.FileTypes.opentype fonts]
[Core.FileTypes.ovf]
[Core.FileTypes.ovp]
93
Files
[Core.FileTypes.pdftex config]
[Core.FileTypes.pk]
[Core.FileTypes.PostScript header]
94
Files
[Core.FileTypes.texmfscripts]
[Core.FileTypes.tcx]
[Core.FileTypes.tex]
[Core.FileTypes.texpool]
95
Files
[Core.FileTypes.tfm]
96
Files
[Core.FileTypes.troff fonts]
[Core.FileTypes.truetype fonts]
[Core.FileTypes.type1 fonts]
[Core.FileTypes.type42 fonts]
97
Files
[Core.FileTypes.vf]
[Core.FileTypes.web2c files]
[Core.FileTypes.web]
[MakeBase]
[MakeFMT]
[MakePk]
[MakeTFM]
[MPM]
98
Files
;; Deprecated.
ForceLocalServer = f
;; Deprecated.
;MiKTeXDirectRoot =
[Setup]
;; Last time (a time_t value) a MiKTeX administrator has checked for system-wide i
;LastAdminDiagnose =
;; Last time (a time_t value) a MiKTeX administrator changed the system-wide confi
;LastAdminMaintenance =
;; Last time (a time_t value) a MiKTeX administrator has installed system-wide upd
;LastAdminUpdate =
;; Last time (a time_t value) a MiKTeX administrator has checked for system-wide u
;LastAdminUpdateCheck =
99
Files
;; Last time (a time_t value) a MiKTeX administrator has updated the system-wide p
;LastAdminUpdateDb =
;; Last time (a time_t value) the current MiKTeX user has checked for issues.
;LastUserDiagnose =
;; Last time (a time_t value) the current MiKTeX user changed the configuration.
;LastUserMaintenance =
;; Last time (a time_t value) the current MiKTeX user has installed updates.
;LastUserUpdate =
;; Last time (a time_t value) the current MiKTeX user has checked for updates.
;LastUserUpdateCheck =
;; Last time (a time_t value) the current MiKTeX user has updated the package data
;LastUserUpdateDb =
[TeXandFriends]
;; Deprecated.
;ParseFirstLine =
[TeXjp]
See also
initexmf(1)
100
Files
Name
pdftex.cfg — configuration settings for MiKTeX-pdfTeX
Description
MiKTeX-pdfTeX configurations settings are read from the file pdftex.cfg when a format file is being
created by MiKTeX-pdfTeX.
Caution
Do not edit this file directly. Run initexmf --edit-config-file pdftex.cfg to edit
configuration settings for MiKTeX-pdfTeX.
Instructions
A typical pdftex.cfg file looks like this, setting up output for A4 paper size and the standard TeX
offset of 1 inch:
compress_level 9
decimal_digits 3
horigin 1 true in
vorigin 1 true in
image_resolution 300
move_chars 1
output_format 1
page_width 210 true mm
page_height 297 true mm
pdf_minorversion 4
pk_resolution 600
The configuration file sets default values for these parameters, and they all can be overridden in the TeX
source file. Dimensions can be specified as true, which makes them immune for magnification (when
set).
compress_level This integer parameter specifies the level of text and in||line
graphics compression. MiKTeX-pdfTeX uses Zip compression. A
value of 0 means no compression, 1 means fastest, 9 means best,
2..8 means something in between. Just set this value to 9, unless
there is a good reason to do otherwise; 0 is great for testing macros
that use \pdfliteral.
decimal_digits This integer specifies the preciseness of real numbers in PDF page
descriptions. It gives the maximal number of decimal digits after
the decimal point of real numbers. Valid values are in range 0..5. A
higher value means more precise output, but also results in a much
larger file size and more time to display or print. In most cases the
optimal value is 2. This parameter does not influence the precision
of numbers used in raw PDF code, like that used in \pdfliteral and
annotation action specifications.
horigin & vorigin These dimension parameters can be used to set the offset of the TeX
output box from the top left corner of the “paper”.
101
Files
output_format This integer parameter specifies whether the output format should
be DVI or PDF. A positive value means PDF output, otherwise we
get DVI output.
page_width & page_height These two dimension parameters specify the output medium
dimensions (the paper, screen or whatever the page is put on). If
they are not specified, these values are calculated.
pdf_minorversion Sets the PDF version of the generated file and the latest allowed
PDF version of included PDFs. The value 3 tells MiKTeX-pdfTeX
to set the PDF version to 1.3 and allows only included PDFs with
versions less than 1.3. A suitable default value is 4.
pk_resolution One can use this entry to specify the resolution for bitmap fonts.
Nowadays most printers are capable to print at least 600 dots per
inch, so this is a reasonable default.
102
Chapter 8. Environment variables
BIBINPUTS
Extra paths to locate .bib files.
BSTINPUTS
Extra paths to locate .bst files.
MFINPUTS
Extra paths to locate METAFONT input and openin files.
MIKTEX_REPOSITORY
Location of the default package repository. This can be either a fully qualified
path name (a local package repository) or an URL (a remote package
repository).
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.
MFINPUTS
Extra paths to locate METAFONT input and openin files.
TEXINPUTS
Extra paths to locate TeX \input and \openin files.
TFMFONTS
Extra paths to locate TeX font metric files
103
Chapter 9. Trace Streams
access file tests (access(), stat())
104
Trace Streams
packages packages
yap Yap
105
Chapter 10. Run-Time Defaults
MiKTeX configuration settings are initialized with default values which are described in this chapter.
;; Deprecated.
;GUIFramework = 1
;; Deprecated.
;UserInfoFile =
[Core]
106
Run-Time Defaults
;; Deprecated.
;NoRegistry =
107
Run-Time Defaults
;; Trace flags.
Trace =
;; Preferred UI languages.
;UILanguages[] =
[Core.FileTypes.afm]
[Core.FileTypes.base]
108
Run-Time Defaults
Paths[] = .
Paths[] = %r/miktex/data/le
[Core.FileTypes.bib]
[Core.FileTypes.bst]
[Core.FileTypes.cid maps]
[Core.FileTypes.clua]
109
Run-Time Defaults
[Core.FileTypes.cmap files]
[Core.FileTypes.cweb]
[Core.FileTypes.dvi]
[Core.FileTypes.dvips config]
[Core.FileTypes.enc]
110
Run-Time Defaults
[Core.FileTypes.fmt]
[Core.FileTypes.gf]
[Core.FileTypes.bitmap font]
111
Run-Time Defaults
EnvVars[] = GLYPHFONTS
EnvVars[] = TEXFONTS
[Core.FileTypes.graphic/figure]
[Core.FileTypes.hbf]
[Core.FileTypes.ist]
[Core.FileTypes.lig files]
112
Run-Time Defaults
[Core.FileTypes.ls-R]
[Core.FileTypes.lua]
[Core.FileTypes.map]
[Core.FileTypes.mem]
[Core.FileTypes.mf]
113
Run-Time Defaults
[Core.FileTypes.mfpool]
[Core.FileTypes.mft]
[Core.FileTypes.misc fonts]
[Core.FileTypes.mlbib]
114
Run-Time Defaults
Paths[] = %R/bibtex/bib/{mlbib,}//
[Core.FileTypes.mlbst]
[Core.FileTypes.mp]
[Core.FileTypes.mppool]
[Core.FileTypes.MetaPost support]
115
Run-Time Defaults
[Core.FileTypes.ocp]
[Core.FileTypes.ofm]
[Core.FileTypes.opl]
[Core.FileTypes.otp]
116
Run-Time Defaults
Paths[] = .
Paths[] = %R/fonts/otp//
[Core.FileTypes.opentype fonts]
[Core.FileTypes.ovf]
[Core.FileTypes.ovp]
[Core.FileTypes.pdftex config]
117
Run-Time Defaults
[Core.FileTypes.pk]
[Core.FileTypes.PostScript header]
[Core.FileTypes.texmfscripts]
118
Run-Time Defaults
EnvVars[] = TEXMFSCRIPTS
[Core.FileTypes.tcx]
[Core.FileTypes.tex]
[Core.FileTypes.texpool]
119
Run-Time Defaults
[Core.FileTypes.tfm]
[Core.FileTypes.troff fonts]
[Core.FileTypes.truetype fonts]
120
Run-Time Defaults
;; font files.
EnvVars[] = TTFONTS
EnvVars[] = TEXFONTS
[Core.FileTypes.type1 fonts]
[Core.FileTypes.type42 fonts]
[Core.FileTypes.vf]
121
Run-Time Defaults
[Core.FileTypes.web2c files]
[Core.FileTypes.web]
[MakeBase]
[MakeFMT]
[MakePk]
[MakeTFM]
[MPM]
;; Deprecated.
ForceLocalServer = f
122
Run-Time Defaults
;; Deprecated.
;MiKTeXDirectRoot =
[Setup]
;; Last time (a time_t value) a MiKTeX administrator has checked for system-wide i
;LastAdminDiagnose =
;; Last time (a time_t value) a MiKTeX administrator changed the system-wide confi
;LastAdminMaintenance =
;; Last time (a time_t value) a MiKTeX administrator has installed system-wide upd
;LastAdminUpdate =
;; Last time (a time_t value) a MiKTeX administrator has checked for system-wide u
;LastAdminUpdateCheck =
;; Last time (a time_t value) a MiKTeX administrator has updated the system-wide p
;LastAdminUpdateDb =
;; Last time (a time_t value) the current MiKTeX user has checked for issues.
;LastUserDiagnose =
;; Last time (a time_t value) the current MiKTeX user changed the configuration.
;LastUserMaintenance =
;; Last time (a time_t value) the current MiKTeX user has installed updates.
;LastUserUpdate =
;; Last time (a time_t value) the current MiKTeX user has checked for updates.
123
Run-Time Defaults
;LastUserUpdateCheck =
;; Last time (a time_t value) the current MiKTeX user has updated the package data
;LastUserUpdateDb =
[TeXandFriends]
;; Deprecated.
;ParseFirstLine =
[TeXjp]
BibTeX
;; Maximum size of a str_entry_var.
ent_str_size = 500
124
Run-Time Defaults
125
Run-Time Defaults
;; Words of font info for TeX (total size of all TFM files,
;; approximately).
font_mem_size = 8000000
;; Extra space for the hash table of control sequences (which allows
;; 10K names as distributed).
hash_extra = 600000
pdfTeX
pdf_mem_size = 10000
obj_tab_size = 1000
dest_names_size = 131072
pdf_os_buf_size = 1
METAFONT
;; Number of autorounded points per cycle.
max_wiggle = 1000
126
Run-Time Defaults
MetaPost
;; Number of words for TFM information for text fonts.
font_mem_size = 10000
127
--landscape, 62
Index --language=lang, 75
--lib-table-size=n, 45
--list-file-types, 26
Symbols --list-modes, 30
--admin, 30, 52, 58 --logo-font=font, 29
--alias=name, 16, 18, 26, 28, 40, 44, 47, 63, 71, 77 --lua=file, 39
--aux-directory=dir, 7, 40, 44, 63, 71, 77 --luaconly, 40
--batch, 75 --luaonly, 39
--bistack-size=n, 44 --mag=mag, 18
--buf-size=n, 44, 63, 71, 77 --main-memory=n, 45, 65, 72, 78
--c-style-errors, 40, 44, 47, 63, 71, 77 --max-in-open=n, 65, 72, 78
--clean, 75 --max-pages=n, 18
--credits, 40 --max-print-line=n, 45, 65, 72, 78
--debug, 47 --max-strings=n, 45, 65, 72, 79
--debug-format, 40 --max-wiggle=n, 45
--default-paper-size=paper, 30 --min-crossrefs=n, 16
--disable-8bit-chars, , , --mkidx-option=option, 75
--disable-installer, 6, 16, 18, 28, 30, 40, 44, 52, 64, 71, 77 --mktex=fmt, 40
--disable-write18, 40, 64, 71, 77 --move-size=n, 45
--dont-parse-first-line, 44, 64, 71, 77 --must-exist, 26
--draftmode, 40, 64 --nest-size=n, 65, 72, 79
--dump, 36 --no-c-style-errors, 40, 45, 48, 65, 72, 79
--edit-config-file=file, 30 --no-file-line-error, 40, 45, 48, 65, 72, 79
--enable-8bit-chars, , , --no-file-line-error-style, 40, 45, 48, 65, 72, 79
--enable-enctex, 64, 71 --no-mktex=fmt, 40
--enable-etex, 64, 77 --no-pdf,
--enable-installer, 6, 16, 18, 28, 30, 40, 44, 52, 64, 71, 78 --no-registry, 69
--enable-mltex, 64, 71, 78 --no-shell-escape, , , ,
--enable-write18, 40, 64, 71, 78 --nosocket, 41
--error-line=n, 44, 64, 71, 78 --numbersystem=string, 48
--even-only, 62 --odd-only, 62
--expand, 75 --output-comment=string, 41
--extra-mem-bot=n, 64, 71, 78 --output-directory=dir, 41, 45, 48, 65, 72, 79
--extra-mem-top=n, 64, 71, 78 --output-driver=cmd,
--file-line-error, 40, 44, 47, 63, 71, 77 --output-format=format, 41,
--file-line-error-style, 40, 44, 47, 63, 71, 77 --overflow-label-offset=real, 29
--file-type=filetype, 26 --page-range=range, 62
--font-max=n, 64, 71, 78 --page-start=pagespec, 18
--font-mem-size=n, 64, 72, 78 --papersize=string,
--gray-font=font, 28 --param-size=n, 45, 65, 72, 79
--half-error=n, 44, 64, 72, 78 --parse-first-line, 45, 65, 72, 79
--halt-on-error, 40, 44, 47, 64, 72, 78 --path-size=n, 45
--hash-extra=n, 64, 72, 78 --pdf, 75
--help, 16, 18, 26, 28, 40, 44, 47, 58, 64, 72, 75, 78 --pool-free=n, 65, 72, 79
--hhelp, 16, 18, 28, 45, 58, 64, 72, 78 --pool-size=n, 45, 65, 73, 79
--import-all, 58 --print-method=method, 62
--import=package, 58 --print-nothing, 62
--include-directory=dir, 7, 16, 18, 29, 40, 45, 64, 72, 78 --print-only, 30
--initialize, 40, 45, 47, 64, 72, 78 --printer=printer, 62
--interaction=mode, 40, 45, 47, 65, 72, 78 --quiet, , 30, , 52, , , ,
--job-name=name, 40, 45, 47, 65, 72, 78 , , 75,
--job-time=file, 45, 65, 72, 78 --record-package-usages=file, 6, 17, 18, 29, 45, 65, 73, 79
--label-font=font, 29 --recorder, 41, 46, 48, 65, 73, 79
128
Index
--register-root, 30 A
--report, 30
automatic package installation, 6
--restrict-write18, 41, 65, 73, 79
auxiliary files
--restricted, 48
removing, 7
--run-viewer, 75
specifying the directory for, 7
--safer, 41
--save-size=n, 65, 73, 79
--screen, 46 B
--select=sel, 18 BIBINPUTS, 17, 103
--set-config-value=[section]valuename=value, 31 bibliography
--set-repository=location, 59 creation, 16
--shell-escape, , , , BibTeX
--shell-restricted, , , , invoked by texify, 7
--show-config-value=[section]valuename, 31 BSTINPUTS, 17, 103
--show-path=filetype, 26
--src, 75 C
--src-specials, 65, 73, 79 cross-references
--stack-size=n, 46, 65, 73, 79 minimum number required, 16
--start, 26 resolving, 7
--string-vacancies=n, 46, 66, 73, 79
--synctex=n, 41, 66, 79 D
--tcx=tcxname, 46, 66, 73 DVI search, 8
--tex-option=option, 76
--tex=texprogram, 48
--texinfo=cmd, 76 E
--the-name-of-the-game=engine, 26 error messages
--time-statistics, 46, 66, 73, 80 C/C++ style, 40, 44, 47, 63, 71, 77
--trace=tracestreams, 17, 19, 29, 46, 55, 59, 66, 73, 80 line width, 44, 64, 71, 78
--translate-file=tcxname, , , extra_mem_bot, 11
--trie-size=n, 66, 73, 80
--troff, 48 F
--undump=name, 41, 46, 48, 66, 73, 80 file name database
--unregister-root, 31 defined, 9
--utc, 41 refreshing, 9
--verbose, 31, 52, , 76 file name datasbase
--version, 17, 19, 26, 29, 31, 41, 46, 48, 52, 56, 59, 60, refreshing, 34
66, 73, 76, 80 font_mem_size, 11
--viewer-option=option, 76 format files
-max-iterations=n, 75 build,
-s internal=NUMBER, 48
-s internal=STRING, 48 G
-slant-font=font, 29 gftodvi, 20
-src, 65, 73, 79 give back, 3
-title-font=font, 29
.bbl, 16
.bbl (bibliography file), 16
K
.bib (bibliographic database), 16 Knuth
.bst (bibliography style file), 16 Donald E., 3
.dvi (DVI file), 20
\write18 (run a program from within TeX), , L
, , , , , , , LaTeX
, , , invoked by texify, 7
LaTeX language definition files
configuring, 38
129
Index
130