MAN (7)

NAME

man - macros to typeset manual

CONTENTS

Synopsis
Description
Requests
See Also
Notes

SYNOPSIS

nroff -man file ...

troff -man file ...

DESCRIPTION

These macros are used to lay out pages of 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.
\*S Change to default type size.

REQUESTS

                           \ka    
RequestCauseIf no          Explanation    
       BreakArgument    .B t   no   t=n.t.l.*      Text t is bold.    .BI t  no   t=n.t.l.       Join words of t alternating bold and italic.    .BR t  no   t=n.t.l.       Join words of t alternating bold and Roman.    .DT    no   .5i 1i...      Restore default tabs.    .HP i  yes  i=p.i.*        Set prevailing indent to i. Begin paragraph with hanging indent.    .I t   no   t=n.t.l.       Text t is italic.    .IB t  no   t=n.t.l.       Join words of t alternating italic and bold.    .IP x iyes  x=""           Same as .TP with tag x.    .IR t  no   t=n.t.l.       Join words of t alternating italic and Roman.    .LP    yes  -              Same as .PP.    .PD d  no   d=.4v          Interparagraph distance is d.    .PP    yes  -              Begin paragraph. Set prevailing indent to .5i.    .RE    yes  -              End of relative indent. Set prevailing indent to amount of starting .RS.    .RB t  no   t=n.t.l.       Join words of t alternating Roman and bold.    .RI t  no   t=n.t.l.       Join words of t alternating Roman and italic.    .RS i  yes  i=p.i.         Start relative indent, move left margin in distance i. Set prevailing indent to .5i for nested indents.    .SH t  yes  t=n.t.l.       Subhead.    .SB t  no   t=n.t.l.       Text t is small and bold.    .SM t  no   t=n.t.l.       Text t is small.    .TH n c d x s               yes-Begin page named n of chapter c; d is date of last change; x is extra commentary, e.g. 'local', for page foot; s is a section description. Set prevailing indent and tabs to .5i.    .TP i  yes  i=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

SEE ALSO

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

NOTES

Relative indents don't nest.


Heirloom Toolchest MAN (7) 7/21/03
Generated by a modified version of manServer 1.07 from man.7 using man macros.