LinuxCommandLibrary

texdoc

TLDR

Open package documentation

$ texdoc [package-name]
copy
List available docs
$ texdoc -l [package-name]
copy
Search documentation
$ texdoc -s [query]
copy
Open in specific viewer
$ texdoc --viewer=[evince] [package-name]
copy
Show file path
$ texdoc -f [package-name]
copy
Interactive mode
$ texdoc -I [package-name]
copy

SYNOPSIS

texdoc [-l] [-s] [-I] [options] query

DESCRIPTION

texdoc finds and opens TeX/LaTeX documentation. It searches the TeX Live documentation tree.
Package names find their docs. Most packages have PDF manuals.
List mode shows all matches. Multiple docs may exist.
Interactive mode lets you choose. Select from numbered list.
Search mode does full-text search. Finds docs mentioning query.

PARAMETERS

-l, --list

List matches.
-s, --search
Full search.
-I, --interact
Interactive mode.
-f, --files
Show file paths.
-w, --view
View documentation.
--viewer CMD
PDF viewer.
-D, --debug
Debug output.

CAVEATS

Requires TeX Live documentation. Not all packages documented. PDF viewer needed.

HISTORY

texdoc is part of TeX Live for accessing documentation. It simplifies finding manuals for the thousands of available packages.

SEE ALSO

tlmgr(1), latex(1), pdflatex(1)

Copied to clipboard