NAME

man − macros to format Reference Manual pages

SYNOPSIS

nroff  −man  filename ...

troff  −man  filename ...

DESCRIPTION

These macros are used to lay out the reference pages in this manual. 

Any text argument t may be zero to six words.  Quotes may be used to include blanks 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 .SM followed by .B 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 i are ens. 

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 −man:

\∗R‘®’, ‘(Reg)’ in nroff. 

\∗SChange to default type size. 

FILES

/usr/lib/tmac/tmac.an

SEE ALSO

troff(1), nroff(1), man(1)

The −man Macro Package, in Formatting Documents on the Sun Workstation. 

REQUESTS

RequestCauseIf noExplanation

BreakArgument

.B tnot=n.t.l.∗Text t is bold. 

.BI tnot=n.t.l.Join words of t alternating bold and italic. 

.BR tnot=n.t.l.Join words of t alternating bold and Roman. 

.DTno.5i 1i...Restore default tabs. 

.HP iyesi=p.i.∗Set prevailing indent to i.  Begin paragraph with hanging indent. 

.I tnot=n.t.l.Text t is italic. 

.IB tnot=n.t.l.Join words of t alternating italic and bold. 

.IP x iyesx=""Same as .TP with tag x. 

.IR tnot=n.t.l.Join words of t alternating italic and Roman. 

.LPyes-Same as .PP. 

.PD dnod=.4vInterparagraph distance is d. 

.PPyes-Begin paragraph.  Set prevailing indent to .5i. 

.REyes-End of relative indent.  Set prevailing indent to amount of starting .RS. 

.RB tnot=n.t.l.Join words of t alternating Roman and bold. 

.RI tnot=n.t.l.Join words of t alternating Roman and italic. 

.RS iyesi=p.i.Start relative indent, move left margin in distance i.  Set prevailing indent to .5i for nested indents. 

.SH tyest=n.t.l.Subhead. 

.SM tnot=n.t.l.Text t is small. 

.TH n s d f myes-Begin page named 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. 

.TP iyesi=p.i.Set prevailing indent to i.  Begin indented paragraph with hanging tag given by next text line.  If tag doesn’t fit, place it on separate line. 

∗ n.t.l. = next text line; p.i. = prevailing indent

CONVENTIONS

A typical manual page for a command or function is laid out as follows:

.TH TITLE [1-8]
The name of the command or function in upper-case, which serves as the title of the manual page. This is followed by the number of the section in which it appears.

.SH NAME name (or comma-separated list of names) − one-line summary
The name, or list of names, by which the command is called, followed by a dash and then a one-line summary of the action performed.  All in roman font, this section contains no troff(1) commands or escapes, and no macro requests.  It is used to generate the whatis(1) database.

.SH SYNOPSIS

Commands:

The syntax of the command and its arguments as typed on the command line.  When in boldface, a word must be typed exactly as printed.  When in italics, a word can be replaced with text that you supply.  Syntactic symbols appear in roman face:

[ ] An argument, when surrounded by brackets is optional. 

| Arguments separated by a vertical bar are exclusive.  You can supply only item from such a list. 

... Arguments followed by an elipsis can be repeated.  When an elipsis follows a bracketed set, the expression within the brackets can be repeated. 

Functions:

If required, the data declaration, or #include directive, is shown first, followed by the  function declaration.  Otherwise, the function declaration is shown. 

.SH DESCRIPTION
A narrative description of the command or function in detail, including how it interacts with files or data, and how it handles the standard input, standard output and standard error.

Filenames, and references to commands or functions described elswhere in the manual, are italicised.  The names of options, variables and other literal terms are in boldface. 

.SH OPTIONS
The list of options along with a description of how each affects the commands operation.

.SH FILES
A list of files associated with the command or function.

.SH "SEE ALSO"
A comma-separated list of related manual pages, followed by references to other published materials.  This section contains no troff(1) escapes or commands, and no macro requests.

.SH DIAGNOSTICS
A list of diagnostic messages and an explanation of each.

.SH BUGS
A description of limitations, known defects, and possible problems associated with the command or function.

Sun Release 3.2  —  Last change: 3 February 1987