Scroll to navigation

TEXDOC(1) Texdoc manual TEXDOC(1)

NAME

texdoc - find & view documentation in TeX Live

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

Use view mode: start a viewer. (default)
Use mixed mode (view or list).
Use list mode: show a list of results.
Use showall mode: show also "bad" results.
Use interactive menus. (default)
Use plain lists, no interaction required.
Machine-readable output for lists (implies -I).
Suppress warnings and most error messages.
Print additional information (e.g., viewer command).
Activate all debug output (equal to "--debug=all").
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.
Set configuration item NAME to VALUE.

ACTIONS

Print this help message.
Print the version number.
Print the list of configuration files used.
Display FILE, given with full path (no searching).
Print SHELL completion.

ENVIRONMENT

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

Set the command to be used for HTML documents.
Set the command to be used for DVI documents.
Set the command to be used for Markdown documents.
Set the command to be used for text documents.
Set the command to be used for PDF documents.
Set the command to be used for PS documents.

The following environment variables are also used:

Set the locale, which will influence on the search results.
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

COPYRIGHT

Copyright 2008-2024 Manuel Pe´gourie´-Gonnard, Takuto Asakura, the TeX Live Team.
License: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html.
This is free software: you are free to change and redistribute it.

SEE ALSO

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

texdoc texdoc

should give you access to the complete manual.

March 2024 Texdoc 4.1