


      MAN(5)                        (DWB)                        MAN(5)



      NAME
           man - macros for formatting manual entries

      SYNTAX
           nroff -man files

           troff -man [ -rs1 ] files

      DESCRIPTION
           These troff(1) macros are used to lay out the format of
           manual entries such as those in this manual.  These macros
           are used by the man(1) command.

           The default page size is 8.5" X 11", with a 6.5" X 10" text
           area; the -rs1 option reduces these dimensions to 6" X 9"
           and 4.75" X 8.375", respectively; this option (which is not
           effective in nroff(1)) also reduces the default type size
           from 10-point to 9-point, and the vertical line spacing from
           12-point to 10-point.  The -rV2 option may be used to set
           certain parameters to values appropriate for certain
           Versatec printers:  it sets the line length to 82
           characters, the page length to 84 lines, and it inhibits
           underlining; this option should not be confused with the
           -Tvp option of the man(1) command, which is available at
           some UNIX system sites.

           Any text argument below may be one to six ``words''.  Double
           quotes may be used to include blanks in a ``word''.  If text
           is empty, the special treatment is applied to the next line
           that contains text to be printed.  For example, .I may be
           used to italicize a whole line, or .SM followed by .B to
           make small bold text.  By default, hyphenation is turned off
           for nroff(1), but remains on for troff(1).

           Type font and size are reset to default values before each
           paragraph and after processing font- and size-setting
           macros, e.g., .I, .RB, .SM.  Tab stops are neither used nor
           set by any macro except .DT and .TH.

           Default units for indents in are ens.  When in is omitted,
           the previous indent is used.  This remembered indent is set
           to its default value (7.2 ens in troff(1), 5 ens in nroff
           this corresponds to 0.5 in the default page size) by .TH,
           .P, and .RS, and restored by .RE.

           .TH t s c n  Set the title and entry heading; t is the
                        title, s is the section number, c is extra
                        commentary, e.g., ``local'', n is new manual
                        name.  Invokes .DT (see below).
           .SH text     Place subhead text, e.g., SYNOPSIS, here.
           .SS text     Place sub-subhead text, e.g., Options, here.
           .B text      Make text bold.



      Page 1                                         (73 A2 02MTA REV1)






      MAN(5)                        (DWB)                        MAN(5)



           .I text      Make text italic.
           .SM text     Make text 1 point smaller than default point
                        size.
           .RI a b      Concatenate roman a with italic b, and
                        alternate these two fonts for up to six
                        arguments.  Similar macros alternate between
                        any two of roman, italic, and bold:
                             .IR   .RB   .BR   .IB   .BI
           .P           Begin a paragraph with normal font, point size,
                        and indent.  .PP is a synonym for .P.
           .HP in       Begin paragraph with hanging indent.
           .TP in       Begin indented paragraph with hanging tag.  The
                        next line that contains text to be printed is
                        taken as the tag.  If the tag does not fit, it
                        is printed on a separate line.
           .IP t in     Same as .TP in with tag t; often used to get an
                        indented paragraph without a tag.
           .RS in       Increase relative indent (initially zero).
                        Indent all output an extra in units from the
                        current left margin.
           .RE k        Return to the kth relative indent level
                        (initially, k=1; k=0 is equivalent to k=1); if
                        k is omitted, return to the most recent lower
                        indent level.
           .PM m        Produces proprietary markings; where m may be P
                        for PRIVATE, N for NOTICE, BP for BELL
                        LABORATORIES PROPRIETARY, or BR for BELL
                        LABORATORIES RESTRICTED.
           .DT          Restore default tab settings (every 7.2 ens in
                        troff(1), 5 ens in nroff(1)).
           .PD v        Set the interparagraph distance to v vertical
                        spaces.  If v is omitted, set the
                        interparagraph distance to the default value
                        (0.4v in troff(1), 1v in nroff(1)).

           The following strings are defined:

           \*R          Registered Trademark symbol in troff(1), (Reg.)
                        in nroff. ``(Reg.)'' in nroff(1),
                        ``Registered'' symbol in troff(1).
           \*S          Change to default type size.
           \*(Tm        Trademark indicator.

           The following number registers are given default values by
           .TH:

           IN           Left margin indent relative to subheads
                        (default is 7.2 ens in troff(1), 5 ens in
                        nroff(1)).
           LL           Line length including IN.
           PD           Current interparagraph distance.




      Page 2                                         (73 A2 02MTA REV1)






      MAN(5)                        (DWB)                        MAN(5)



      CAVEATS
           In addition to the macros, strings, and number registers
           mentioned above, there are defined a number of internal
           macros, strings, and number registers.  Except for names
           predefined by troff (1) and number registers d, m, and y,
           all such internal names are of the form XA, where X is one
           of ), ], and }, and A stands for any alphanumeric character.

           If a manual entry needs to be preprocessed by eqn(1) (or
           neqn), and/or tbl(1), it must begin with a special line
           (described in man(1)), causing the man command to invoke the
           appropriate preprocessor(s).

           The programs that prepare the Table of Contents and the
           Permuted Index for this Manual assume the NAME section of
           each entry consists of a single line of input that has the
           following format:

                name[, name, name ...] \- explanatory text

           The macro package increases the inter-word spaces (to
           eliminate ambiguity) in the SYNTAX section of each entry.

           The macro package itself uses only the roman font (so that
           one can replace, for example, the bold font by the
           constant-width font (CW).  Of course, if the input text of
           an entry contains requests for other fonts (e.g., .I, .RB,
           \fI), the corresponding fonts must be mounted.

      FILES
           /usr/lib/tmac/tmac.an
           /usr/lib/macros/cmp.[nt].d.an
           /usr/lib/macros/ucmp.[nt].an

      SEE ALSO
           ocw(1), eqn(1), nroff(1), tbl(1), tc(1), troff(1).
           In ROS Reference Manual, man(1).

      BUGS
           If the argument to .TH contains any blanks and is not
           enclosed by double quotes, there will be strange irregular
           dots on the output.













      Page 3                                         (73 A2 02MTA REV1)



