man.7

<B>Digital的Unix操作系统VAX 4.2源码</B>

Sets the prevailing indent to \fIi\fR.  Then begins the indented
paragraph with a hanging tag given by the next text line.  If the tag
does not fit, the macro places the next text on a separate line.
.IP \&.VE
End a vertical margin bar.
.IP "\&.VS [ 4 ]"
Starts a vertical margin bar, if `4' is specified; otherwise, the
macro does nothing.
.PP
.NXE "man macro package" "macros"
.SS Macros That Cause Line Breaks
The following macros cause line breaks:
.RS
.PP
.TS
tab(@);
l l l l l l.
De@Ds@EE@EX@HP@IP
LP@PP@RE@SH@SS@TH
TP
.TE
.PP
.RE
.SS Macros That Need Text Lines
The following macros affect the following line of text if they are specified
in the input without arguments:
.RS
.PP
.TS
tab(@);
l l l l l l.
B@BI@BR@G@GL@I
IB@IR@RI@RB@SH@SS
SM
.TE
.PP
.RE
.TP
.SS Defaults
Automatic hyphenation is turned on. However, \fIlast\fP lines (ones that will
cause a trap) are not hyphenated and the last and first two characters of
a word are not split off.
.PP
Characters printed from the Special Font are artificially bolded by three units
whenever the current font is `3'.
.PP
The default page size is 80 columns by 66 lines for
.PN nroff
output and 8.5" x 11" for output generated by
.PN *troff 
text formatters.
The text area is horizontally placed on the page so that the effective page
margin is
\&.3 inches for
.PN nroff 
and 7.5 picas for
.PN *troff
text formatters.
.PP
The
.PN \&.TH
macro sets up the following defaults:
.IP \(bu 4
Text is set in ``noadjust'' mode; the right margin is ragged.
.IP \(bu 4
The default interparagraph distance is 1v for
.PN nroff 
and \&.5v for
.PN *troff
text formatters.
.IP \(bu 4
The basic text indent is \&.5 inches for
.PN nroff 
and four picas for
.PN *troff
text formatters, from the left margin.
.IP \(bu 4
The maximum text line length is 7.4 inches for
.PN nroff 
and 36 picas for
.PN *troff
text formatters.
.IP \(bu 4
Sets tab stops every \&.5 inches.
.IP \(bu 4
The basic text point size is 11 points, with line spacing set to 12 points.
.IP \(bu 4
The basic text font is ``R'' (a roman typeface).
.IP \(bu 4
Reference page headers, section headers, and subsection headers are set
in a sans-serif bold typeface.
.SH Options
.IP \-n\fIN\fP 12
Numbers the first generated page as
.IR N .
.IP \-rl1
Turns on line double-spacing mode.
.SH Restrictions
.SS Predefined Registers
The following registers are predefined by the
.PN man
macro package and should not be changed:
.IP PO 12
Page offset and page margin
.IP IN
Left margin indent relative to the section headers
.IP LL
Line length including
.PN IN 
.IP PL
Page length
.PP
The register `l' is predefined when you specify the
.PN *roff
.PN \-rl
option. Its default value is 0.  The
.MS man 1
command does not use this option.
.SS Reserved Registers
The following registers are reserved for internal use by the
.PN man ,
.PN man.nopage ,
and
.PN man.repro
macro packages:
.RS
.PP
.TS
tab(@);
l l l l l l.
A1@DX@EX@l@p@p#
PF
.TE
.PP
.RE
In addition, registers beginning with the characters
`)', `]', and `}' are also reserved for internal use.
.\"
.\" At this moment the following registers are internally used:
.\" 	}W }L PO ]C ]T
.\"	p#
.\"	)I )R )E )P
.\"	)p ][1-9] )[1-9]
.\"	EX PF
.\" p is reserved for \-rpS \-man.nopage and \-man.repro use.
.\"
.PP
Registers predefined by the
.MS nroff 1 ,
.MS tbl 1 ,
commands, and the
.PN *eqn
and
.PN *troff
text preprocessors and formatters should not be redefined.
.SS Predefined Strings
The following strings are predefined by the
.PN man
macro package and should not be changed:
.IP lq 12
.ie n \{\
\&\*(lq if
.PN nroff ,
\&`` if
.PN *troff
.\}
.el \{\
\&" if
.PN nroff ,
\&\*(lq if
.PN *troff
.\}
.IP rq
.ie n \{\
\&\*(rq if
.PN nroff ,
\&'' if
.PN *troff
.\}
.el \{\
\&" if
.PN nroff ,
\&\*(rq if
.PN *troff
.\}
.IP S
Command string to change type size to 10 points.
.SS Reserved Strings and Macros
The following string and macro names are reserved for internal use by the
.PN man ,
.PN man.nopage ,
and
.PN man.repro
macro packages:
.RS
.PP
.TS
tab(@);
l l l l l l.
##@A1@BD@BK@CD@D
DE@DS@HH@ID@LD@NO
NX@P@UF@ya@yn@yl
ys
.TE
.PP
.RE
In addition, names beginning with the characters
`)', `]', and `}' are also reserved for internal use.
.\"
.\" At this moment the following strings, macros, diversions are internally
.\" used:
.\"	]I ]R 
.\"	}1 }2
.\"	}E }F }f }H }K }M }N }S }X
.\"	]B ]D ]H ]L ]W ]X
.\"	]I ]R
.\"	}C
.\"	]F \" inside }S macro
.\"	]i ]r
.\"	D \fI?\fPD
.\" ]S is defined in man.nopage and man.repro
.\" ]T is defined in man.repro
.\" NX is defined in man.repro
.\"	## A1 HH ya yn yl ys are defined in other tools
.\"	BK is defined in man.repro for use by another tool
.\" UF is defined in man.repro
.\" D, ID, CD, LD, BD are reserved in case we need to add full DS/DE
.\"  support
.\" DS/DE are reserved in case we need backwards compatibility with BSD.
.\" P is reserved in case we need backwards compatibility with BSD and SysV.
.\"	f.	\" defined by tbl
.\"
.PP
Names predefined by the
.MS nroff 1 ,
.MS tbl 1 ,
commands, and the
.PN *eqn
and
.PN *troff
text preprocessors and formatters should not be redefined.
.SS \&.TH Macro Restrictions
The section number should only be 1-8, `n', `l', `o', or `p'.
Other values might not be recognized by the 
.MS man 1
or
.MS catman 8
commands.
.PP
Sections 6, 7, `n', `l', `o', and `p' do not currently have subsections,
so subsections should not be specified.
.PP
The architecture field (\fIa\fP) should not exceed four characters.  A value
longer than four characters might print outside the right page margin.
.PP
Reference pages containing
.PN *eqn
commands should be preprocessed by
an
.PN *neqn
text preprocessor before being installed on the system.
.PP
Reference pages containing
.MS tbl 1
commands must not be preprocessed before being installed on the system.
.SS The Name Section
The
.MS catman 8
command assumes the Name section of a reference page has the
following format:
.EX
name[, name, name ...] \\- explanatory text
.EE
There should be at least one space after any comma and only one space
following the ``backslash hyphen'' (\\-).
There should not be
any
.PN *roff
commands in the explanatory text.  The explanatory text should be brief.
The
.MS catman 8
command combines information in the Name section with parameters of the
.PN \&.TH
macro to create an entry in a database searched by the
.MS apropos 1 ,
.MS man 1 ,
and 
.MS whatis 1
commands.
.SH Portability Considerations
The ULTRIX
.PN man
macro packages contain extensions and enhancements borrowed from
other macro packages.  If you have a need to write portable reference pages,
you should not use the following macros:
.RS
.PP
.TS
tab(@);
l l l l l l.
CT@CW@De@Ds@EE@EX
G@GL@HB@I1@I2@LP
MS@NE@NT@PN@Pn@R
RN@TB@UF
.TE
.PP
.RE
The
.PN LP 
and
.PN TB
macros are obsolete.
.PP
The ULTRIX
.PN man
.PN \&.TH
macro differs from other implementations of the 
.PN \&.TH
macro.  The primary differences are in the placement of the page title,
and third and fifth fields in the
.PN *roff
output.
The page title (the page name and section number) is commonly placed on
both sides of the page header in other implementations.
The more common placement of the third field is
in the center of the page footer.  The more common placement
of the fifth field is in the center of the page header.
.PP
The 
.PN \&.TH 
macro permits the use of the percent (%) character in any 
of its fields.  The presence of the percent character may cause
problems for other implementations of this macro.
.PP
Use of the
.MS tbl 1
and
.PN *eqn
commands should be avoided, because the version of the
.MS man 1
command in some other implementations might not preprocess reference
pages through the
.MS tbl 1
command.  The
.PN *eqn
commands also might not be installed.
.SH Files
.TP 27
.PN /usr/lib/tmac/tmac.an
The
.PN man
macro package file
.br
.SH See Also
col(1), man(1), nroff(1), tbl(1), man.nopage(7), man.repro(7), catman(8)
.NXE "man macro package"