Linux Certif

Toute la documentation sur la certification Linux LPI

texdoclua

NAME

texdoc - Search for NAME in the TeX documentation and start a viewer.

SYNOPSIS

texdoc [-h|--help] [-v|--verbose] [-V|--version] [-l|--list] [-S|--search] [name|pattern]

DESCRIPTION

texdoc is a script which attempts to find and display documentation for tex files. Without any options, the file name.ext is displayed, where .ext is one of the extensions defined in the variable TEXDOCEXT in texmf.cnf. The viewer used for displaying the file can be customized.

texdoc accepts compressed files, too. You can also specify the complete filename, e.g. to decide which of two files with equal basename you want., In this case, however, access to compressed files is not possible.

OPTIONS

-h, --help

Display a usage message

-V, --version

Display version information and exit

-v, --verbose

verbose mode: show viewer command

-l, --list

Just list all files that match name, do not start a viewer.

-S, --search pattern

pattern is treated as a lua pattern (similar to basic regular expressions, with `%' as escape character instead of `\'). The output first lists all directory names which match pattern and then all files. Currently, directories without an ls-R file are ignored.

VARIABLES

TEXDOCS = .;$TEXMF/doc//

Specifies the directories where TeX documentation is stored

TEXDOCEXT = {:.pdf:.ps:.dvi:.txt:.tex}{:.gz:.bz2}:.html

Recognized formats for documentation, the first match wins. The default uses standard kpathsea brace notation. `html' should be last in order to prevent the catalogue entry from being shown when other documentation exists.

TEXDOC_VIEWER_FORMAT = (command %s) &

Defines the viewer to be used for FORMAT, e.g. TEXDOC_VIEWER_DVI. The filename (and tempfile cleanup commands, if needed after decompression) is substituted for `%s'. If the viewer does not put itself in the background, the command must be enclosed in parentheses and the `&' sign appended, as shown in the example for command.

TEXDOC_UNZIP_FORMAT = command -a -c

This variable specifies the command which is used to uncompress a file compressed as FORMAT. It result must go to stdout.

TEXDOC_FORMATS = pdf,dvi,ps,txt,tex

The formats for which a viewer is defined in texmf.cnf (order does not matter).

TEXDOC_ZIPFORMATS = gz,bz2

The compression formats for which a decompression command is defined in texmf.cnf.

TEXDOC_RMFILE = rm -f

The command used to remove a file on the target system. This is used for temporary files which are needed for viewing compressed documents.

TEXDOC_RMDIR = rmdir

The command used to remove a directory on the target system. This is used for temporary directories which are needed for viewing compressed documents.

BUGS

Currently no bugs are known, but there are some limitations:

Specifying the filename, complete with extension

This doesn't work for compressed files.

manpage

The manpage has been written on a template created by pod2man, and its source contains a lot of (probably) useless cruft at the beginning.

HISTORY

Original version by David Aspinall <da@dcs.ed.ac.uk>

Rewritten for use with bash 2 and teTeX under Linux by Simon Wilkinson <sxw@dcs.ed.ac.uk>

Changes for web2c-7.2 resp. teTeX-0.9 and portability fixes by Thomas Esser <te@dbs.uni-hannover.de>, Jun 14 1998

Support for compressed documentation implemented by adopting changes made by debian. Thomas Esser, Dec. 2004.

Rewritten using texlua by Frank KÃŒster <frank@kuesterei.ch>. Changed the -s option to use ls-R instead of find, May/June 2007.