man.5 (2010 09)

ManualsBrandsHP ManualsSoftwareHP-UX Manpages

man(5) man(5)

NAME

man - macros for formatting manpages

SYNOPSIS

man ﬁle ...

nroff -man

[option ]... [ﬁle]...

DESCRIPTION

The

man macros are used by the man

and nroff commands (see man(1) and nroff(1)) — and are usable

troff (see third-party documentation) — to format the on-line versions of manpages found in HP-UX

Reference and other related reference manuals. The

man command calls nroff.

man and nroff Defaults

The default page size is 85 characters by 66 lines (8.5×11 inches), with a 75-character by 60-line text

area. Hyphenation is turned off and paragraphs are left-adjusted, ragged-right.

troff Defaults

The default page size is 8.5×11 inches with a 6.5×10-inch text area. The type size is 10 points and the

vertical line spacing is 12 points. Hyphenation is turned on and paragraphs are justiﬁed left and right.

Other Defaults

Type font and size are reset to default values before each paragraph and after processing font- and size-

setting macros such as

.I, .RB, and .SM. Tab stops are neither used nor set by any macro except

.DT

and .TH. The .TH macro invokes .DT (see below).

Options

The following options can be speciﬁed for

nroff or troff. They are not permitted for the

man com-

mand.

-rs1 Reduce the dimensions for troff to a page size of 6×9 inches with a 4.75×8.375-inch text

area, the type size to 9 points, and the vertical line spacing to 10 points. This option is ignored

nroff.

-rV2 Set certain parameters to values appropriate for certain Versatec printers: line length to 82

characters (ens); page length to 84 lines; underlining inhibited. Do not confuse this option

with the

-Tvp option of the man command, which is available on some operating systems, but

not on HP-UX.

Summary of Macros, Strings, and Numbers

The deﬁned

man macros, strings, and numbers are summarized here and described in detail in the fol-

lowing subsections.

.B Set text in bold.

.BC Set words alternately in bold and constant-width.

.BI Set words alternately in bold and italics.

.BR Set words alternately in bold and roman.

.C Set text in constant-width.

.CB Set words alternately in constant-width and bold.

.CD Identify command name.

.CI Set words alternately in constant-width and italics.

.CR Set words alternately in constant-width and roman.

.CT Identify citation title.

.DT Restore default tab settings.

.EM Identify emphasis.

.ER Identify error name.

.EV Identify environment variable name.

.GT Identify glossary term.

.HP Begin paragraph with hanging indent.

.I Set text in italics.

.IB Set words alternately in italics and bold.

.IC Set words alternately in italics and constant-width.

.IP Begin indented paragraph with optional tag.

HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1

Summary of content (8 pages)

PAGE 1
man(5) man(5) NAME man - macros for formatting manpages SYNOPSIS man file ... nroff -man [option ]... [file ]... DESCRIPTION The man macros are used by the man and nroff commands (see man(1) and nroff(1)) — and are usable by troff (see third-party documentation) — to format the on-line versions of manpages found in HP-UX Reference and other related reference manuals. The man command calls nroff. man and nroff Defaults The default page size is 85 characters by 66 lines (8.
PAGE 2
man(5) .IR .KC .P .PD .PM .PP .RB .RC .RE .RI .RS .RV .S3 .SC .SH .SM .SS .TH .TP \*R \*S \*(Tm \n(IN \n(LL \n(PD man(5) Set words alternately in italics and roman. Identify keycap. Begin normal paragraph. Set interparagraph spacing. Use Bell System proprietary subfooters. Begin normal paragraph. Set words alternately in roman and bold. Set words alternately in roman and constant-width. End relative margin indent. Set words alternately in roman and italics. Start relative margin indent.
PAGE 3
man(5) man(5) The resulting output is in the form: t1(s2) a5 n4 t1(s2) a5 c3 .SH text Place section head text , such as SYNOPSIS, here. Section headings start at the left margin. Since they are normally all uppercase, they are printed a point-size smaller in troff. .SS text Place subsection head text , such as Options, here. Subsection headings start between the left margin and the normal text indent. .S3 text Place third-level head text , such as subhead, here.
PAGE 4
man(5) man(5) The first parameter is set in an appropriate font or format. The second parameter, punctuation , is set in roman font and is provided for concatenated punctuation. The two parameters are concatenated as with the font macros. .CD commandname punctuation commandname is a command name, usually defined in a section 1 or 1M manpage, such as man. It is displayed in constant-width font. .CT citationtitle punctuation citationtitle is the name of a document, such as HP-UX Reference .
PAGE 5
man(5) man(5) \n(LL Line length including \n(IN: 75 characters in nroff; 6.5 inches in troff. Also see the Options subsection. LL is expressed in basic units (u). \n(PD Current interparagraph distance. Set by .PD. PD is expressed in vertical line spaces (v). Measure nroff and troff use a number of scale indicators to qualify horizontal and vertical measurements. Many macro parameters have default units of measure.
PAGE 6
man(5) man(5) produces a footer with text in the form: XYZ Company −1− Release 2.3: May 1996 Tables The tbl preprocessor (see tbl (1)) can be used to insert tables in manpages. The man macros allow you to use the standard tbl macros: .TS, .T&, and .TE. They do not support the mm macro extensions, .TS H and .TH (see mm(5)). In general, avoid using the man macros within a table, particularly the font macros, which can produce peculiar and unpredictable results.
PAGE 7
man(5) man(5) /usr/share/lib/whatis File of strings from manpage NAME sections, created by catman, and used by the man -k and -f options. SEE ALSO col(1), man(1), neqn(1), nroff(1), tbl(1), catman(1M), mm(5).
PAGE 8
(Notes) A (Notes) mA 8 Hewlett-Packard Company −1− HP-UX 11i Version 3: September 2010