Documentation

Most packages come with some form of documentation: user manuals, example files, programming guides, etc. In addition, many independent files not part of a macro or other package describe various aspects of the TeX system.

The TDS specifies that these additional documentation files shall be stored in a structure that parallels to some extent the `fonts' and `tex' directories, as follows:

texmf/doc/category/...

`category' identifies the general topic of documentation that resides below it; for example, a TeX format name (`latex'), program name (`bibtex', `tex'), language (`french', `german'), or other system components (`web', `fonts').

The TDS reserves the following categories:

• Within each `category' tree for a TeX format, the directory `base' is reserved for base documentation distributed by the format's maintainers.
• `general', for standalone documents not specific to any particular program (for example, Joachim Schrod's Components of TeX).
• `help', for meta-information, such as FAQ's, David Jones' macro index, etc.
• `html', for HTML documents.
• `info', for processed Texinfo documents. (Info files, like anything else, may also be stored outside the TDS, at the installer's option.)
• `local', for local additions. See Section section Local additions.

The `doc' directory is intended for implementation-independent and operating system-independent documentation files. Implementation-dependent files shall be stored elsewhere, as provided for by the implementation and/or TeX administrator (for example, VMS help files under `texmf/vms/help').

The documentation directories may contain TeX sources, DVI files, PostScript files, text files, example input files, or any other useful documentation format(s).

See Section section Documentation tree summary for a summary.

Go to the first, previous, next, last section, table of contents.