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

FreeBSD Manual Pages

  
 
  

home | help
MTHELP(1)			  User Commands 		       MTHELP(1)

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 pack-
     age  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:

	 > MIKTEX_VIEW_pdf="gv %f"

FILES
     The  intermediate	HTML file (package.html) is stored in the directory mik-
     tex/mthelp  relative  to  the  data  TEXMF  data  root   (usually	 ~/.mik-
     tex/texmfs/data).

SEE ALSO
     MiKTeX Project Page[1]

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.

NOTES
      1. MiKTeX Project Page
	 https://miktex.org/

MiKTeX 25.4			 April 18, 2025 		       MTHELP(1)

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

home | help