|MAN(7)||Standards, Environments, and Macros||MAN(7)|
man — macros to
format Reference Manual pages
These macros are used to lay out the reference pages in this manual. Note: if file contains format input for a preprocessor, the commands shown above must be piped through the appropriate preprocessor. This is handled automatically by the man(1) command. See the Conventions section.
Any text argument t may be zero to six
words. Quotes may be used to include SPACE characters in a "word".
If text is empty, the special treatment is applied to
the next input line with text to be printed. In this way
.I may be used to italicize a whole line, or
.SB may be used to make small bold letters.
A prevailing indent distance is remembered between successive
indented paragraphs, and is reset to default value upon reaching a
non-indented paragraph. Default units for indents
Type font and size are reset to default values before each paragraph, and after processing font and size setting macros.
These strings are predefined by
* n.t.l. = next text line; p.i. = prevailing indent
|Request||Sy Cause||Sy If No||Sy Explanation|
|Sy Break||Sy Argument|
|Nm .B t||no||Ar t=n.t.l.*||Text is in bold font.|
||no||Ar t=n.t.l.||Join words, alternating bold and italic.|
||no||Ar t=n.t.l.||Join words, alternating bold and roman.|
||no||Li .5i 1i...||Restore default tabs.|
||yes||Ar i=p.i.*||Begin paragraph with hanging indent. Set prevailing indent to Ar i.|
||no||Ar t=n.t.l.||Text is italic.|
||no||Ar t=n.t.l.||Join words, alternating italic and bold.|
||yes||Ar x=""||Same as
||no||Ar t=n.t.l.||Join words, alternating italic and roman.|
||no||-||Index macro, not used (obsolete).|
||yes||-||Begin left-aligned paragraph. Set prevailing indent to .5i.|
||no||Ar d=.4v||Set vertical distance between paragraphs.|
||yes||-||End of relative indent. Restores prevailing indent.|
||no||Ar t=n.t.l.||Join words, alternating roman and bold.|
||no||Ar t=n.t.l.||Join words, alternating roman and italic.|
||yes||Ar i=p.i.||Start relative indent, increase indent by i. Sets prevailing indent to .5i for nested indents.|
||no||-||Reduce size of text by 1 point, make text bold.|
||no||Ar t=n.t.l.||Reduce size of text by 1 point.|
||yes||Ar t=n.t.l.||Section Subheading.|
||yes||-||Begin reference page n, of section s; d is the date of the most recent change. If present, f is the left page footer; m is the main page (center) header. Sets prevailing indent and tabs to .5i.|
||yes||Ar i=p.i.||Begin indented paragraph, with the tag given on the next text line. Set prevailing indent to i.|
||no||-||Resolve the title abbreviation t; join to punctuation mark (or text) p.|
When formatting a manual page,
examines the first line to determine whether it requires special processing.
For example a first line consisting of:
indicates that the manual page must be run through the tbl(1) preprocessor.
A typical manual page for a command or function is laid out as follows:
Syntactic symbols appear in roman face:
#includedirective, is shown first, followed by the function declaration. Otherwise, the function declaration is shown.
Literal text from the synopsis appears in constant width, as do literal filenames and references to items that appear elsewhere in the reference manuals. Arguments are italicized.
If a command interprets either subcommands or an input
grammar, its command interface or input grammar is normally described in
USAGE section, which follows the
OPTIONS section. The
DESCRIPTION section only describes the behavior
of the command itself, not that of subcommands.
.SH RETURN VALUES
.SH EXIT STATUS
.SH SEE ALSO
man package should not be used for new
documentation. The mdoc(7), package is
preferred, as it uses semantic markup rather than physical markup.
Dale Dougherty and Tim O'Reilly, Unix Text Processing.
|March 10, 2023||OmniOS|