texdoc - Man Page

find & view documentation in TeX Live

Examples (TL;DR)

Synopsis

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

Description

Try to find appropriate TeX documentation for the specified NAME(s). Alternatively, perform the given ACTION and exit.

Options

-w,  --view

Use view mode: start a viewer. (default)

-m,  --mixed

Use mixed mode (view or list).

-l,  --list

Use list mode: show a list of results.

-s,  --showall

Use showall mode: show also "bad" results.

-i,  --interact

Use interactive menus. (default)

-I,  --nointeract

Use plain lists, no interaction required.

-M,  --machine

Machine-readable output for lists (implies -I).

-q,  --quiet

Suppress warnings and most error messages.

-v,  --verbose

Print additional information (e.g., viewer command).

-D,  --debug

Activate all debug output (equal to "--debug=all").

-d LIST, --debug=LIST

Activate debug output restricted to the categories specified in LIST.
Available categories: config, files, search, score, texdocs, tlpdb, version, view, and all to activate all of these.

-c NAME=VALUE

Set configuration item NAME to VALUE.

Actions

-h,  --help

Print this help message.

-V,  --version

Print the version number.

-f,  --files

Print the list of configuration files used.

--just-view FILE

Display FILE, given with full path (no searching).

Environment

The following environment variables can be split by colon and used to set viewers:

BROWSER,  BROWSER_texdoc

Set the command to be used for HTML documents.

DVIVIEWER,  DVIVIEWER_texdoc

Set the command to be used for DVI documents.

MDVIEWER,  MDVIEWER_texdoc

Set the command to be used for Markdown documents.

PAGER,  PAGER_texdoc

Set the command to be used for text documents.

PDFVIEWER,  PDFVIEWER_texdoc

Set the command to be used for PDF documents.

PSVIEWER,  PSVIEWER_texdoc

Set the command to be used for PS documents.

The following environment variables are also used:

LANG,  LC_ALL and so on

Set the locale (which will influence on the search results).

TEXDOCS

In addition to the documents included in the TeX Live database, Texdoc also searches documentation under TEXMF trees specified by the kpathsea variable TEXDOCS.

Files

<texmf>/texdoc/texdoc.cnf, see output of the --files option.

Exit Status

The texdoc command exists with one of the following values:

0

Success.

1

Internal error.

2

Usage error.

3

No documentation found.

Reporting Bugs

Report bugs to texdoc@tug.org.
Texdoc home page: http://tug.org/texdoc/
Source: https://github.com/TeX-Live/texdoc

See Also

The full documentation is maintained as a PDF manual. The command

texdoc texdoc

should give you access to the complete manual.

Info

March 2021 Texdoc 3.3 Texdoc manual