Chapter 4. Embedded Documentation
Tools exist to extract embedded documentation and generate input suitable for several formatters like troff, LATEX, and HTML. The following commands can be used to control embedded documentation:
Sets the subsequent text up to a matching
=endto be included only when processed for formatter fmt.
Ends a document section.
Restricts the remainder of just this paragraph to be included only when processed for formatter fmt.
Produces a heading. N must be 1, 2, 3, or 4.
Starts an enumeration with indent N. Items are specified using
=item.The enumeration is ended with
Introduces a document section. Any of the
=commands can be used to introduce a document section.
Each of the preceding commands applies to the paragraph of text that follows them; paragraphs are terminated by at least one empty line.
An indented paragraph is considered to be verbatim text and will be rendered as such.
Within normal paragraphs, markup sequences can be inserted:
Bold text (for switches and programs).
A named character, e.g.,
Italic text (for emphasis and variables).
|] [ ref ] [
A cross reference. text, if present, is used for output.
Text that cannot break on spaces.
A zero-width character.
Markup sequences may be nested. If a markup sequence has to contain
> characters, use
C<<< . . .
>>>, etc. The last of the opening
< must be followed by whitespace, and whitespace must precede the first of the closing