texdoc - Utility to look up TeX documentation

texdoc [ OPTION ... ] NAME [ ... ]

texdoc seaches for NAME in the TeX documentation and starts an appropriate viewer.

NAME should be the name of a command or package in the teTeX distribution.

--help

Display a brief summary of options.

-l

List matching files. Does not start a viewer.

-s

Search the disk. From all documentation files found by texdoc, the ones whose names match the remaining arguments (as egrep pattern) will be displayed.

-v

Sets verbose mode. Shows the command being used to display the documentation.

$TEXDOCVIEW_dvi

DVI viewer. Defaults to xdvi(1).

$TEXDOCVIEW_pdf

PDF viewer. The default is to use the program defined in the mailcap file, see mailcap(5).

$TEXDOCVIEW_ps

PostScript viewer. The default is to use the program defined in the mailcap file, see mailcap(5). ghostview(1).

$TEXDOCVIEW_html

HTML viewer. The default is to use the program defined in the mailcap file, see mailcap(5).

$TEXDOCVIEW_txt

Text viewer. Defaults is to use the program indicated by the $PAGER variable, or more if this is unset.

The environment variables should be set with a ``%s'' as a placeholder for the name of the file. For example,

hostname% setenv TEXDOCVIEW_pdf "gv %s"

or

hostname$ TEXDOCVIEW_html="mozilla %s" hostname$ export TEXDOCVIEW_html

The Debian teTeX packages texdoc use the mime-support package to determine the appropriate viewer for the respective file type except for dvi and txt. texdoc of Debian is able to handle gzip- and bzip2-compressed files. If texdoc finds more than on file for a string the first hit is displayed. The file extensions are regarded and the search order can be configured in texmf.cnf (90TeXDoc.cnf).

acroread(1), gv(1), kpsewhich(1), less(1), more(1), xdvi(1)

Web page: <http://tug.org/teTeX/>

None known, but report any bugs found to <tetex@dbs.uni-hannover.de> (mailing list).

texdoc was written by Thomas Esser <te@dbs.uni-hannover.de>, David Aspinall <da@dcs.ed.ac.uk>, and Simon Wilkinson <sxw@dcs.ed.ac.uk> during 1998 and 1999. texdoc is in the public domain.

This manual page was written by C.M. Connelly <c@eskimo.com>, for the Debian GNU/Linux system. It may be used by other distributions without contacting the author. Any mistakes or omissions in the manual page are my fault; inquiries about or corrections to this manual page should be directed to me (and not to the primary author).