format - Specification of simple tcl markup for manpages
SYNOPSIS
|
This manpage specifies
The manpage format described here is simpler than TMML, but convertible into it (and other formats, like HTML and nroff).
The tcl sources of this manpage can serve as an example for all of the
markup described by it. Every possible construct (with the exception
of require) is used here.
OVERVIEW
The remaining commands (moddesc and titledesc) provide
one-line descriptions of module and specific title respectively.
The argument to the first command denotes the type of the list. The
allowed values and their associated item command are explained later,
in the section detailing the Commands.
The other commands start list items and each can be used only inside a
list of their type. In other words, bullet is allowed in
bulleted lists but nowhere else, enum in enumerated lists and
lst_item and call are for definition lists. These two
commands also have some text directly associated with the item
although the major bulk of the item is the text following the item
until the next list command.
The last list command, call is special. It is used to describe
the syntax of a command and its arguments. It should not only cause
the appropriate markup of a list item at its place but also add the
syntax to the table of contents (synopsis) if supported by the output
format in question. nroff and HTML for example do. A format focused on
logical markup, like TMML, may not.
Commands
SEE ALSO
expander(n), formatter(n), mpexpand(n)
KEYWORDS
manpage, TMML, HTML, nroff, conversion, markup