CTAN Comprehensive TeX Archive Network

Direc­tory support/texdoc


Tex­doc v3.1 (2019-03-28)

Build Status Build status

Tex­doc is a com­mand line pro­gram to find and view doc­u­men­ta­tion in Live.

Gen­eral In­for­ma­tion

Us­ing Tex­doc

Tex­doc is part of the Live dis­tri­bu­tion. Gen­er­ally, you don't have to in­stall it your­self.

If you want to try/test the de­velop ver­sion, please see be­low.

How to In­stall the Develop Ver­sion

Us­ing Bundler

The eas­i­est way to in­stall the de­velop ver­sion of Tex­doc is us­ing Bundler and Rake:

$ bundle install
$ rake install

If you want to unin­stall the de­velop ver­sion (to use the Live ver­sion), just try:

$ rake uninstall

In­stalling man­u­ally

Here, $TEXDOC means the path to the tex­doc dev sources you cloned (or down­loaded), and $TEXMFHOME de­notes your per­sonal TEXMF tree (you can get its lo­ca­tion with kpsewhich --var-value TEXMFHOME).

  • The com­mand. Sym­link or copy $TEXDOC/script as $TEXMFHOME/scripts/texdoc.
  • The con­fig­u­ra­tion file. Sym­link or copy $TEXDOC/texdoc.cnf as $TEXMFHOME/texdoc/texdoc-dist.cnf (no­tice the -dist part). It will com­pletely over­ride the other con­fig­u­ra­tion files ex­cept $TEXMFHOME/texdoc/texdoc.cnf which you can still use for you per­sonal set­tings.

You can make sure that the right files are used by run­ning texdoc --files: the first line con­tains the full path to the ver­sion of used texdoclib.tlu, and the rest lists the con­fig­u­ra­tion files in use.

Files in This Re­pos­i­tory

  • doc/ con­tains the doc­u­men­ta­tion,
  • script/ con­tains the source code,
  • spec/ is a di­rec­tory for test­ing scripts, and
  • texdoc.cnf is the de­fault con­fig­u­ra­tion file.

Build­ing and Test­ing

Many build­ing tasks are de­fined as Rake tasks:

Gen­er­at­ing all doc­u­men­ta­tion

Fol­low­ing will gen­er­ate both the PDF and the man­page in doc/ di­rec­tory.

$ rake doc

Gen­er­at­ing a pre-hashed cache file

Fol­low­ing will gen­er­ate a pre-hashed cache file script/Data.tlpdb.lua. This task have to be done un­der a Live setup with tlpdb.

$ rake gen_datafile

Run­ning tests

Fol­low­ing will run all tests in spec/ di­rec­tory.

$ rake test

Al­ter­na­tively, you can give spec names with the --list (-l) op­tion for this task. E.g., fol­low­ing will run only spec/action/help_spec.rb and spec/mode/list_spec.rb:

$ rake test -- -l action/help,mode/list

Show­ing all avail­able tasks

Fol­low­ing will show all avail­able tasks with a short de­scrip­tion.

$ rake -T

In ad­di­tion to that, for op­tions avail­able tasks (e.g., rake test and rake run_texdoc) you can get op­tions in­for­ma­tion with -h op­tion for each task:

$ rake test -- -h

Fur­ther In­for­ma­tion

More spe­cific in­for­ma­tion (e.g., TODO) can be found in the Wiki of our GitHub repos­i­tory. Please visit:

Copy­right and Li­cense

Copy­right 2008 Manuel Pé­gourié-Gon­nard, Takuto Asakura, and the Live Team.

This pack­age is dis­tributed un­der the terms of the GNU Gen­eral Public Li­cense as pub­lished by the Free Soft­ware Foun­da­tion, ei­ther ver­sion 3 of the Li­cense, or (at your op­tion) any later ver­sion.

Pre­vi­ous work (tex­doc pro­gram) in the pub­lic do­main:

  • Con­tri­bu­tions from Rein­hard Ko­tucha (2008).
  • First texlua ver­sions by Frank Küster (2007).
  • Orig­i­nal shell script by Thomas Esser, David Aspinall, and Si­mon Wilkin­son.

Down­load the con­tents of this pack­age in one zip archive (136.3k).

tex­doc – Doc­u­men­ta­tion ac­cess for Live

tex­doc is a Lua script pro­vid­ing easy ac­cess to the doc­u­men­ta­tion in Live: PDF, DVI, plain text files, and more. View­ing and other con­fig­u­ra­tion can be ex­ten­sively cus­tomized. It is dis­tributed with Live; MiK pro­vides a pro­gram by the same name to do the same job, but its im­ple­men­ta­tion is un­re­lated.

Home pagehttp://tug.org/tex­doc/
Bug trackerhttps://github.com/TeX-Live/tex­doc/is­sues
Li­censesGNU Gen­eral Public Li­cense
Main­tainerTakuto Asakura
The Live Team
Thomas Esser (in­ac­tive)
Manuel Pé­gourié-Gon­nard (in­ac­tive)
Con­tained inTeX Live as tex­doc
MiKTeX as mik­tex-mthelp-bin-2.9
TopicsView doc
See alsotexdoctk
Guest Book Sitemap Contact Contact Author