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.

name should be the name of a package in the TeX distribution.

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.

--quiet

Suppress all output, except errors.

--version

Show version information and exit.

--view

Open the main documenation file in a viewer.

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.

MIKTEX_VIEW_dvi

DVI viewer.

MIKTEX_VIEW_pdf

PDF viewer.

MIKTEX_VIEW_ps

PostScript viewer.

MIKTEX_VIEW_html

HTML viewer.

MIKTEX_VIEW_txt

Text viewer.

The environment variables should be set with a %f as a placeholder for the name of the file. For example:

C:> MIKTEX_VIEW_pdf="gv %f"

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).

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.