Texdoc 3.3 (2021-03-17)
Texdoc is a command line program to find and view documentation in TeX Live.
- Website: https://www.tug.org/texdoc/
- Repository: https://github.com/TeX-Live/texdoc/
- Mailing list: <email@example.com>
Texdoc is part of the TeX Live distribution. Generally, you don't have to install it yourself.
If you want to try/test the develop version, please see below.
How to Install the Develop Version
$ bundle install $ rake install
If you want to uninstall the develop version (to use the TeX Live version), just try:
$ rake uninstall
$TEXDOC means the path to the texdoc dev sources you cloned (or downloaded), and
$TEXMFHOME denotes your personal TEXMF tree (you can get its location with
kpsewhich --var-value TEXMFHOME).
- The command. Symlink or copy
- The configuration file. Symlink or copy
-distpart). It will completely override the other configuration files except
$TEXMFHOME/texdoc/texdoc.cnfwhich you can still use for you personal settings.
You can make sure that the right files are used by running
texdoc --files: the first line contains the full path to the version of used
texdoclib.tlu, and the rest lists the configuration files in use.
Files in This Repository
doc/contains the documentation,
script/contains the source code,
spec/is a directory for testing scripts, and
texdoc.cnfis the default configuration file.
Building and Testing
Many building tasks are defined as Rake tasks:
Generating all documentation
The following will generate both the PDF and the manpage in
$ rake doc
Generating a pre-hashed cache file
The following will generate a pre-hashed cache file
script/Data.tlpdb.lua. This task have to be done under a TeX Live setup with tlpdb.
$ rake gen_datafile
The following will run all tests in
$ rake test
Alternatively, you can give spec names with the
-l) option for this task. E.g., following will run only
$ rake test -- -l action/help,mode/list
Showing all available tasks
Following will show all available tasks with a short description.
$ rake -T
In addition to that, for options available tasks, e.g.,
rake test and
rake run_texdoc, you can get options information with
-h option for each task:
$ rake test -- -h
More specific information, such as the TODO list of this project and some information for distributors, can be found in the Wiki of our GitHub repository. Please visit:
Copyright and License
Copyright 2008-2021 Manuel Pégourié-Gonnard, Takuto Asakura, the TeX Live Team.
This package is distributed under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Previous work (texdoc program) in the public domain:
- Contributions from Reinhard Kotucha (2008).
- First texlua versions by Frank Küster (2007).
- Original shell script by Thomas Esser, David Aspinall, and Simon Wilkinson.
Download the contents of this package in one zip archive (147.5k).
texdoc – Documentation access for TeX Live
texdoc is a Lua script providing easy access to the documentation in TeX Live: PDF, DVI, plain text files, and more. Viewing and other configuration can be extensively customized. It is distributed with TeX Live; MiKTeX provides a program by the same name to do the same job, but its implementation is unrelated.
|Licenses||GNU General Public License|
|Copyright||2008–2021 Manuel Pégourié-Gonnard, Takuto Asakura, the TeX Live Team|
The TeX Live Team
Thomas Esser (inactive)
Manuel Pégourié-Gonnard (inactive)
|Contained in||TeX Live as texdoc|
MiKTeX as miktex-mthelp-bin-2.9