suite is a collection of text formatters which understands a small family of
SGML-based document-structure markup languages. Each formatter (or "back-end")
renders the common markup languages into a variety of
output formats, including HTML, TeX, DVI, PostScript, plain text, and
source in manual-page format. The SGML-tools suite is useful for
authoring documents which must be distributed in a variety of formats
including plain text, hypertext, and high-quality typeset books.
The markup language(s) accepted by these formatters is described in the
SGML-Tools User's Guide.
They are variants of an SGML document type definition originally
designed by Matt Welsh for Linux documentation.
Most command-line options are accepted by all back-ends. Some
back-ends have additional specific options to control rendering to
their particular output format. Here are the common options:
Set the paper size. Default is ``letter''.
You may also specify ``a4'' size (European 297x210mm paper).
Specify the language of the document (this may change which style
files are used for formatting by a back end). The default language is
English. Run an SGML-tools command without arguments to see the list
of valid language codes.
Specify the output character encoding. Defaults to ``ascii''
selecting the ASCII set; you may specify "latin" to specify the
ISO 8859-1 (Latin-1) character set.
Include an auxiliary DTD (Document Type Definition) from $LINUXDOCLIB/dtd.
Set the tab spacing assumed for generating the output document. The
default tab spacing is 8.
Don't delete intermediate files (such as .TeX files generated on the
way to a .dvi, or .man files deleted on the way to plain text).
Pass attribute/value pairs to be matched against "if" and "unless"
conditionals. See the User's Guide for extended discussion of this
Pass a -i option to
This may be used for conditional inclusion. See the
manual page for details.
Pass an option string to the back end. The exact semantics of this
option are dependent on the back end and should be explained in the
individual manual pages for each.
The SGML source file, named either
Running a back-end with no arguments will cause it to list all its
options. The available back ends include:
translate to HTML
translate to GNU info
translate to Lyx macros
translate to LaTeX 2e
translate to Microsoft Rich Text Format
translate to plain text or Unix manual-page markup.
There is also a tool
available for checking the SGML-Tools syntax of document sources
without actually generating a translated version.
Many files and executables in $LINUXDOCLIB and $LINUXDOCBIN are used.