NAME

tmml -
Command-line utility for processing TMML documents

SYNOPSIS

tmml command  ? args... ?   ? --option=value ... ?  

DESCRIPTION

tmml is a command-line utility for processing TMML documents. Available subcommands are:

help

Prints usage information

validate ? file... ?

Validates each file against the DTD using nsgmls Errors are reported on stderr.

tohtml filename.tmml

Convert file to HTML

toman filename.tmml

Convert filename.tmml to nroff -man format. Output will be stored in filename.man in the directory specified by the manDirectory option.

navpages

Builds all the HTML navigation pages listed below: (keywords, table of contents, and index). For these to work, the masterDocument option should be specified in the tmml.options customization file.

makemap

Build INDEX.MAP file from the master document. This is a package-wide index of all the commands, variables, and other symbols defined in the manual. It is used by the HTML conversion stylesheets to process cross-references, among other things.

makecontents

Builds table of contents in htmlDir/index.html

makekeywords

Builds keyword index page

makeindex

Builds index page

PROGRAM OPTIONS

tmml reads site-wide customization options from the file $TMML_DIR/site.options, user options from ~/.tmmlrc, and package-specific options from the file tmml.options in the current working directory. These are Tcl scripts read by source. Customization options are specified by setting elements in the global array Options.

For the full list of available options, run tmml options. Options may also be specified on the command line using the syntax --option=value .

Package-specific options

Options(masterDocument)

The name of the top-level XML document; this should contain the top-level manual element.

Options(htmlDirectory)

Directory to store HTML output; default is ./html.

Options(manDirectory)

Directory to store man pages; default is ./man.

Site-specific options

Options(xsltProcessor)

Specifies the XSLT processor to use for TMML-to-HTML conversion. One of: tdom, saxon, msxsl, or xsltproc. Others may also be available; check the source code for the current list. tDOM is currently the preferred XSLT driver.

SEE ALSO

nsgmls(1), TMML, tmml2man, tmml-dtd