man.7

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

.\" SCCSID: @(#)man.7	8.6	2/26/91
.TH man 7
.SH Name
man \- the man macro package for online reference pages
.SH Syntax
.B tbl
.I file...
.B | nroff
[
.BI \-n N
] [
.B \-rl1
]
.B \-man | col | ...
.br
.B tbl
.I file...
.B | *troff
[
.BI \-n N
] [
.B \-rl1
]
.B \-man | ...
.SH Description
.NXAM "man command" "man macro package"
.NXAM "troff text processor" "man macro package"
.NXAM "nroff text processor" "man macro package"
.NXR "man macro package"
.NXB "man macro package"
.NXR "manual page" "formatting"
The
.PN man
macro package is used to format reference manual pages for online viewing
or printing.
.if t .ig
This reference page was formatted by the
.MS nroff 1
command and the
.PN man
macros, or was
..
.if n .ig
The installed reference pages are
..
formatted by the
.MS man 1
and the
.MS catman 8
commands, using the
.PN man
macro package.
..
.PP
The page size is 80 columns by 66 lines for
.PN nroff
output and is 8.5" x 11" when formatted with 
.PN *troff
text formatters.  Page numbers appear at the bottom of each output page with
odd page numbers appearing on the right side and even page numbers appearing
on the left side.
.PP
The format of the ULTRIX online reference pages is determined by the
.MS man.repro 7
macro package.  The
.PN man
macros are a compatible subset of the
.PN man.repro
macros.
.SS Macros
.NXB "man macro package" "macros"
The following describes the macros in the
.PN man
macro package.
.PP
Any
.I text
argument
can range from zero to six words.
Quotation marks (" ") can be used to include blanks in words.
If 
.I text
is not specified,
special treatment is applied to
the next input line that has text to be printed.
In this way,
.PN \&.I
can be used to italicize a whole line or
.PN \&.SM
followed by
.PN \&.B
to make small bold letters.
.PP
A prevailing indent distance is remembered between
successive indented paragraphs,
and is reset to a default value upon reaching a nonindented paragraph.
Default units for indents
.I i
are ens (an en is 1 
.PN nroff
character or 1/2 em space in current point size).
.PP
Typeface and size are reset to default values
before each paragraph, and after processing
font and size setting macros.
.PP
.IP "\&.B [ \fItext...\fR ]" 12
Sets text \fItext\fR in boldface.  If no text is specified, the next text line
is set in boldface.
.IP "\&.BI \fIword1 word2\fR [ \fIwords...\fR ]"
Sets \fIword1\fR in boldface, \fIword2\fR in an italic typeface, and then
alternates between these two fonts for the remaining words, up to six
words.  Blanks between words are stripped unless the string is enclosed
in quotation marks (" ").
.IP "\&.BR \fIword1 word2\fR [ \fIwords...\fR ]"
Sets \fIword1\fR in boldface, \fIword2\fR in a roman typeface, and
then alternates
between these two fonts for the remaining words, up to six words.
Blanks between words are stripped unless the string is enclosed
in quotation marks (" ").
.IP "\&.CT \fIcharacter\fR"
Prints the keyboard control character indicator
.CT \fIcharacter\fP
\&.  For example,
.PN "\&.CT A"
prints as
.CT A
\&.
.IP \&.CW
Sets text in constant width font until another font change is found.
.IP \&.De
Ends an unfilled display block (started by
.PN \&.Ds ).  
Also ends automatic centering, if it was in effect.
.IP \&.Ds
Starts an unfilled display block.  Text between
.PN \&.Ds
and
.PN \&.De
is printed in a roman typeface,
with `no fill' mode (no wrapping and blank lines allowed) in effect.
The display block is set flush left.
.IP \&.DT
Restores default tabs.  Default tabs are set to 
\&.5 inches, starting with \&.5i, 1i, \&... .
.IP \&.EE
Ends an example and restores basic text defaults and indents.
.IP "\&.EX [ \fIi\fR ]"
Starts an example.  Text between 
.PN \&.EX
and
.PN \&.EE
is printed in a constant width
font with `no fill' mode (no wrapping and blank lines allowed) in effect.
The example is set flush left unless an indent \fIi\fR is specified.  Units
of \fIi\fR are ens.
.IP "\&.G [ \fItext...\fR ]"
Sets \fItext\fR in a sans-serif typeface.  If no text is specified, 
the next text line is set in a sans-serif typeface.
.IP "\&.GL [ \fItext...\fR ]"
Sets \fItext\fR in a sans-serif italic typeface.  If no text is specified,
the next text line is set in a sans-serif italic typeface.
.IP "\&.HB [ \fIwords...\fR ]"
Sets the text in underline mode or in a sans-serif bold typeface, depending on
the type of text formatter 
.Pn ( nroff
or
.PN troff ).
If the text formatter is of type
.PN nroff ,
the next 999 input lines are formatted in underline mode 
.Pn ( nroff
italic mode), or all the lines up to a font change are formatted in
underline mode, depending on which limit is encountered first.
If the text formatter is of type
.PN troff ,
text is set in a sans-serif bold typeface until a font change is
encountered.  Up to nine words can also be specified as arguments.
.IP "\&.HP [\|\fIi\fP\|]\fR"
Begins a paragraph with a hanging indent of \fIi\fR ens.
.IP "\&.I [ \fItext...\fR ]"
Sets \fItext\fR in an italic typeface.  If no text is specified, the next text
line is set in an italic typeface.
.IP "\&.I1 \fIword\fR"
Sets a temporary indent to the length of the specified word.
.IP "\&.I2 \fIword\fR"
Reverses one line and then sets a temporary indent to the length of 
the specified word.
.IP "\&.IB \fIword1 word2\fR [ \fIwords...\fR ]"
Sets \fIword1\fR in an italic typeface, \fIword2\fR in boldface, and then
alternates between these two fonts for the remaining words, up to six
words.  Blanks between words are stripped unless the string is enclosed
in quotation marks (" ").
.IP "\&.IP \fIx \fP[\|\fIi\fP\|]\fR"
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.
Tag \fIx\fR appears in bold typeface.
.IP "\&.IR \fIword1 word2\fR [ \fIwords...\fR ]"
Sets \fIword1\fR in an italic typeface, \fIword2\fR in a roman typeface, 
and then alternates between these two fonts for the remaining 
words, up to six words.  Blanks between words are stripped unless the
string is enclosed in quotation marks (" ").
.IP \&.LP
Same as the
.PN \&.PP
macro.  This macro is obsolete, but is provided for backwards
compatibility.
.IP "\&.MS \fIreference_page section_subsection\fR [ \fIpunctuation\fR ]"
Sets \fIreference_page\fR immediately followed by \fIsection_subsection\fR in
parentheses
followed by optional \fIpunctuation\fR, using fonts that distinguish this
reference page reference from ordinary text.  For example,
.MS manual section .
.IP \&.NE
Ends a note. Also cancels automatic centering if it was in effect.
.IP "\&.NT [ \fIheader1\fR ] [ \fBC\fR ]"
.ns
.IP "\&.NT [ \fBC\fR ] [ \fIheader2\fR ]" 12
Starts a note.  If no arguments are specified, the default header for the
note is `Note'.
If the first argument is the letter `C',
all text in the note is
centered, for the next 99 text lines or until the
.PN \&.NE
macro is called, whichever comes first.  
If the first argument is not `C', it becomes the header of the
note, even if \fIheader2\fR is also specified.  
The \fIheader2\fR argument becomes the
header of the note if the first argument is `C'.
.IP "\&.PD [ \fIv\fR ]"
Sets the interparagraph distance to \fIv\fR vertical spaces.  Resets 
the distance to the default value if \fIv\fP is omitted.
.IP "\&.PN \fIx\fR [ \fIy\fR ]"
Sets \fIx\fR in an italic or constant width typeface (depending on
the 
.PN *roff
formatter type) and then reverts to the previous typeface.
The optional argument \fIy\fR is appended to \fIx\fR with
no space, but printed in the previous typeface. 
The \fIx\fR argument is usually a path name;
\fIy\fR is usually punctuation.
.IP "\&.Pn \fIx y\fR [ \fIz\fR ]"
Sets \fIx\fR in the current typeface, sets \fIy\fR in an italic or constant
width typeface (depending on the 
.PN *roff
formatter type) and appends it to \fIx\fR, and finally
reverts to the previous typeface. 
The optional argument \fIz\fR is appended to \fIy\fR, but printed in the
previous typeface.  Spaces are removed between \fIx\fR, \fIy\fR, and \fIz\fR,
unless quotation marks (" ") are used to enclose strings with spaces.
The \fIx\fR argument is usually a fixed path name; \fIy\fR is
usually a variable path name; and \fIz\fR is usually punctuation.
.IP \&.PP
Starts a block paragraph.  Sets the prevailing indent to \&.5i for
.PN nroff 
and four picas for
.PN *troff 
text formatters.
.IP \&.R
Sets the text in a roman typeface until another font change is encountered.  
Also ends
.PN nroff
underline mode if it was in effect.
.IP "\&.RB \fIword1 word2\fR [ \fIwords...\fR ]"
Sets \fIword1\fR in a roman typeface, \fIword2\fR in boldface, and 
then alternates between these two fonts for the remaining 
words, up to six words.
Blanks between words are stripped unless the string is enclosed in
quotation marks (" ").
.IP "\&.RE [ \fIk\fR ]"
Returns to the \fIk\fRth relative right shift indent level.  (Restores the left
margin to the position prior to the \fIk\fRth
.PN \&.RS
call).  Specifying \fIk\fR=0 is equivalent to specifying \fIk\fR=1.  
If \fIk\fR is omitted,
.PN \&.RE
restores the left margin to the most recent previous position.  
When \fIk\fR=1 or 0,
the default 
.PN \&.RS
indent increment is restored.
.IP "\&.RI \fIword1 word2\fR [ \fIwords...\fR ]"
Sets \fIword1\fR in a roman typeface, \fIword2\fR in an italic typeface, and 
then alternates between these two fonts for the remaining words, up to six
words.  Blanks between words are stripped unless the string is enclosed
in quotation marks (" ").
.IP \&.RN
Prints the return character indicator,
.RN
\&.
.IP "\&.RS [ \fIi\fR ]"
Shifts the left margin to the right (relatively) the amount of \fIi\fR ens. The
.PN \&.RS
macro calls can be nested up to nine levels.  If \fIi\fR is not specified for
the first
.PN \&.RS
call, the relative right shift increases \&.5 inch for
.PN nroff ,
and four picas for
.PN *troff 
text formatters.
Nested
.PN \&.RS
calls increment the relative indent by \fIi\fR ens, or by \&.2 inch for
.PN nroff ,
or by 2 picas for
.PN *troff 
text formatters.
.IP "\&.SH \fItext\fR"
Creates a section header.
.IP "\&.SM [ \fItext\fR ]"
Sets \fItext\fR to be two points smaller than the current point size.  If no 
text is specified, the next text line is set in the smaller point size.
.IP "\&.SS \fItext\fR"
Creates a subsection header.
.IP "\&.TB [ \fIwords...\fR ]"
Same as the 
.PN \&.HB
macro.  This macro is obsolete, but is provided for backwards
compatibility.
.IP "\&.TH \fIn c\fR[\fIs\fR] [ \fIa\fR ] [ \fIf\fR ] [ \fIx\fR ]"
Begins a new reference page and sets the page title.  Also sets up headers
and footers for output pages, sets up all defaults and traps, and calls the
.PN \&.DT
and 
.PN \&.PD
macros.  The title appears as
a header on all pages of the formatted reference page. The
\fIn\fR argument is the reference page name.  
The \fIc\fR argument is the primary section number or letter.
The \fIs\fR argument is the subsection, if any.
The \fIa\fR argument is for an optional machine architecture specific label;
for example ``VAX''.
The \fIf\fR argument optionally alters a portion of the page footer. 
The \fIx\fR argument is for optional extra commentary; 
for example ``Unsupported''.
.IP
Fields \fIn\fR, \fIc\fR, and \fIs\fR appear together at the top of each
output page (see the top
of this page for an example).  These fields alternate between the right top
and left top of a page header, corresponding to odd and even page numbers.
Field \fIa\fR appears opposing the page name in the header when formatted
with
.PN nroff ,
but appears as a bleed tab when formatted with 
.PN *troff 
text formatters.
The \fIf\fR argument appears in the page footer on the inside 
edge of the page (left for
odd page numbers, right for even).  
The \fIx\fR argument appears underneath the page
name in the header.
.IP
The last three fields are optional.  To skip a field, specify a pair of
quotation marks ("") in the field to be skipped.
.IP "\&.TP [\|\fIi\fP\|]\fR"