version 1.36, 2009/08/22 09:10:37 |
version 1.44, 2009/11/02 09:53:15 |
|
|
whether in a macro or free-form text line, is ignored to the end of |
whether in a macro or free-form text line, is ignored to the end of |
line. A macro line with only a control character and comment escape, |
line. A macro line with only a control character and comment escape, |
.Sq \&.\e" , |
.Sq \&.\e" , |
is also ignored. Macro lines with only a control charater and |
is also ignored. Macro lines with only a control character and |
optionally whitespace are stripped from input. |
optionally whitespace are stripped from input. |
. |
. |
. |
. |
|
|
.Xr mandoc 1 . |
.Xr mandoc 1 . |
. |
. |
. |
. |
|
.Ss Dates |
|
The |
|
.Sx \&TH |
|
macro is the only |
|
.Nm |
|
macro that requires a date. The form for this date is the ISO-8601 |
|
standard |
|
.Cm YYYY-MM-DD . |
|
. |
|
. |
|
.Ss Scaling Widths |
|
Many macros support scaled widths for their arguments, such as |
|
stipulating a two-inch paragraph indentation with the following: |
|
.Bd -literal -offset indent |
|
\&.HP 2i |
|
.Ed |
|
. |
|
.Pp |
|
The syntax for scaled widths is |
|
.Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? , |
|
where a decimal must be preceded or proceeded by at least one digit. |
|
Negative numbers, while accepted, are truncated to zero. The following |
|
scaling units are accepted: |
|
. |
|
.Pp |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It c |
|
centimetre |
|
.It i |
|
inch |
|
.It P |
|
pica (~1/6 inch) |
|
.It p |
|
point (~1/72 inch) |
|
.It f |
|
synonym for |
|
.Sq u |
|
.It v |
|
default vertical span |
|
.It m |
|
width of rendered |
|
.Sq m |
|
.Pq em |
|
character |
|
.It n |
|
width of rendered |
|
.Sq n |
|
.Pq en |
|
character |
|
.It u |
|
default horizontal span |
|
.It M |
|
mini-em (~1/100 em) |
|
.El |
|
.Pp |
|
Using anything other than |
|
.Sq m , |
|
.Sq n , |
|
.Sq u , |
|
or |
|
.Sq v |
|
is necessarily non-portable across output media. |
|
. |
|
.Pp |
|
If a scaling unit is not provided, the numerical value is interpreted |
|
under the default rules of |
|
.Sq v |
|
for vertical spaces and |
|
.Sq u |
|
for horizontal ones. |
|
.Em Note : |
|
this differs from |
|
.Xr mdoc 7 , |
|
which, if a unit is not provided, will instead interpret the string as |
|
literal text. |
|
. |
|
. |
.Sh MANUAL STRUCTURE |
.Sh MANUAL STRUCTURE |
Each |
Each |
.Nm |
.Nm |
document must contain contains at least the |
document must contain contains at least the |
.Sq TH |
.Sx \&TH |
macro describing the document's section and title. It may occur |
macro describing the document's section and title. It may occur |
anywhere in the document, although conventionally, it appears as the |
anywhere in the document, although conventionally, it appears as the |
first macro. |
first macro. |
. |
. |
.Pp |
.Pp |
Beyond |
Beyond |
.Sq TH , |
.Sx \&TH , |
at least one macro or text node must appear in the document. Documents |
at least one macro or text node must appear in the document. Documents |
are generally structured as follows: |
are generally structured as follows: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.TH FOO 1 "13 Aug 2009" |
\&.TH FOO 1 2009-10-10 |
\&. |
\&. |
\&.SH NAME |
\&.SH NAME |
\efBfoo\efR \e(en a description goes here |
\efBfoo\efR \e(en a description goes here |
Line 162 The \efBfoo\efR utility processes files... |
|
Line 239 The \efBfoo\efR utility processes files... |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\*q .SH ERRORS |
\&.\e\*q .SH ERRORS |
\&.\e\*q .SH SEE ALSO |
\&.\e\*q .SH SEE ALSO |
\&.\e\*q \efBbar\efR(1) |
\&.\e\*q .BR foo ( 1 ) |
\&.\e\*q .SH STANDARDS |
\&.\e\*q .SH STANDARDS |
\&.\e\*q .SH HISTORY |
\&.\e\*q .SH HISTORY |
\&.\e\*q .SH AUTHORS |
\&.\e\*q .SH AUTHORS |
Line 170 The \efBfoo\efR utility processes files... |
|
Line 247 The \efBfoo\efR utility processes files... |
|
\&.\e\*q .SH BUGS |
\&.\e\*q .SH BUGS |
\&.\e\*q .SH SECURITY CONSIDERATIONS |
\&.\e\*q .SH SECURITY CONSIDERATIONS |
.Ed |
.Ed |
|
.Pp |
|
The sections in a |
|
.Nm |
|
document are conventionally ordered as they appear above. Sections |
|
should be composed as follows: |
|
.Bl -ohang -offset indent |
|
.It Em NAME |
|
The name(s) and a short description of the documented material. The |
|
syntax for this is generally as follows: |
|
.Pp |
|
.D1 \efBname\efR \e(en description |
|
.It Em LIBRARY |
|
The name of the library containing the documented material, which is |
|
assumed to be a function in a section 2 or 3 manual. For functions in |
|
the C library, this may be as follows: |
|
.Pp |
|
.D1 Standard C Library (libc, -lc) |
|
.It Em SYNOPSIS |
|
Documents the utility invocation syntax, function call syntax, or device |
|
configuration. |
|
.Pp |
|
For the first, utilities (sections 1, 6, and 8), this is |
|
generally structured as follows: |
|
.Pp |
|
.D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR... |
|
.Pp |
|
For the second, function calls (sections 2, 3, 9): |
|
.Pp |
|
.D1 \&.B char *name(char *\efIarg\efR); |
|
.Pp |
|
And for the third, configurations (section 4): |
|
.Pp |
|
.D1 \&.B name* at cardbus ? function ? |
|
.Pp |
|
Manuals not in these sections generally don't need a |
|
.Em SYNOPSIS . |
|
.It Em DESCRIPTION |
|
This expands upon the brief, one-line description in |
|
.Em NAME . |
|
It usually contains a break-down of the options (if documenting a |
|
command). |
|
.It Em IMPLEMENTATION NOTES |
|
Implementation-specific notes should be kept here. This is useful when |
|
implementing standard functions that may have side effects or notable |
|
algorithmic implications. |
|
.It Em EXIT STATUS |
|
Command exit status for section 1, 6, and 8 manuals. This section is |
|
the dual of |
|
.Em RETURN VALUES , |
|
which is used for functions. Historically, this information was |
|
described in |
|
.Em DIAGNOSTICS , |
|
a practise that is now discouraged. |
. |
. |
|
.It Em RETURN VALUES |
|
This section is the dual of |
|
.Em EXIT STATUS , |
|
which is used for commands. It documents the return values of functions |
|
in sections 2, 3, and 9. |
. |
. |
|
.It Em ENVIRONMENT |
|
Documents any usages of environment variables, e.g., |
|
.Xr environ 7 . |
|
. |
|
.It Em FILES |
|
Documents files used. It's helpful to document both the file and a |
|
short description of how the file is used (created, modified, etc.). |
|
. |
|
.It Em EXAMPLES |
|
Example usages. This often contains snippets of well-formed, |
|
well-tested invocations. Make doubly sure that your examples work |
|
properly! |
|
. |
|
.It Em DIAGNOSTICS |
|
Documents error conditions. This is most useful in section 4 manuals. |
|
Historically, this section was used in place of |
|
.Em EXIT STATUS |
|
for manuals in sections 1, 6, and 8; however, this practise is |
|
discouraged. |
|
. |
|
.It Em ERRORS |
|
Documents error handling in sections 2, 3, and 9. |
|
. |
|
.It Em SEE ALSO |
|
References other manuals with related topics. This section should exist |
|
for most manuals. |
|
.Pp |
|
.D1 \&.BR bar \&( 1 \&), |
|
.Pp |
|
Cross-references should conventionally be ordered |
|
first by section, then alphabetically. |
|
. |
|
.It Em STANDARDS |
|
References any standards implemented or used, such as |
|
.Pp |
|
.D1 IEEE Std 1003.2 (\e(lqPOSIX.2\e(rq) |
|
.Pp |
|
If not adhering to any standards, the |
|
.Em HISTORY |
|
section should be used. |
|
. |
|
.It Em HISTORY |
|
The history of any manual without a |
|
.Em STANDARDS |
|
section should be described in this section. |
|
. |
|
.It Em AUTHORS |
|
Credits to authors, if applicable, should appear in this section. |
|
Authors should generally be noted by both name and an e-mail address. |
|
. |
|
.It Em CAVEATS |
|
Explanations of common misuses and misunderstandings should be explained |
|
in this section. |
|
. |
|
.It Em BUGS |
|
Extant bugs should be described in this section. |
|
. |
|
.It Em SECURITY CONSIDERATIONS |
|
Documents any security precautions that operators should consider. |
|
. |
|
.El |
|
. |
|
. |
.Sh MACRO SYNTAX |
.Sh MACRO SYNTAX |
Macros are one to three three characters in length and begin with a |
Macros are one to three three characters in length and begin with a |
control character , |
control character , |
.Sq \&. , |
.Sq \&. , |
at the beginning of the line. An arbitrary amount of whitespace may |
at the beginning of the line. An arbitrary amount of whitespace may |
sit between the control character and the macro name. Thus, |
sit between the control character and the macro name. Thus, the |
.Sq .PP |
following are equivalent: |
and |
.Bd -literal -offset indent |
.Sq \&.\ \ \ PP |
\&.PP |
are equivalent. |
\&.\ \ \ PP |
|
.Ed |
. |
. |
.Pp |
.Pp |
The |
The |
|
|
.Pp |
.Pp |
is equivalent to |
is equivalent to |
.Sq \&.I foo . |
.Sq \&.I foo . |
If next-line macros are invoked consecutively, only the last is used. |
If next-line macros are invoked consecutively, only the last is used; in |
If a next-line macro is proceded by a block macro, it is ignored. |
other words, if a next-line macro is preceded by a block macro, it is |
|
ignored. |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.YO \(lBbody...\(rB |
\&.YO \(lBbody...\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
Line 215 If a next-line macro is proceded by a block macro, it |
|
Line 415 If a next-line macro is proceded by a block macro, it |
|
.Pp |
.Pp |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" |
.It Em Macro Ta Em Arguments Ta Em Scope |
.It Em Macro Ta Em Arguments Ta Em Scope |
.It B Ta n Ta next-line |
.It Sx \&B Ta n Ta next-line |
.It BI Ta n Ta current |
.It Sx \&BI Ta n Ta current |
.It BR Ta n Ta current |
.It Sx \&BR Ta n Ta current |
.It DT Ta 0 Ta current |
.It Sx \&DT Ta 0 Ta current |
.It I Ta n Ta next-line |
.It Sx \&I Ta n Ta next-line |
.It IB Ta n Ta current |
.It Sx \&IB Ta n Ta current |
.It IR Ta n Ta current |
.It Sx \&IR Ta n Ta current |
.It R Ta n Ta next-line |
.It Sx \&PD Ta n Ta current |
.It RB Ta n Ta current |
.It Sx \&R Ta n Ta next-line |
.It RI Ta n Ta current |
.It Sx \&RB Ta n Ta current |
.It SB Ta n Ta next-line |
.It Sx \&RI Ta n Ta current |
.It SM Ta n Ta next-line |
.It Sx \&SB Ta n Ta next-line |
.It TH Ta >1, <6 Ta current |
.It Sx \&SM Ta n Ta next-line |
.It UC Ta n Ta current |
.It Sx \&TH Ta >1, <6 Ta current |
.It br Ta 0 Ta current |
.It Sx \&UC Ta n Ta current |
.It fi Ta 0 Ta current |
.It Sx \&br Ta 0 Ta current |
.It i Ta n Ta current |
.It Sx \&fi Ta 0 Ta current |
.It na Ta 0 Ta current |
.It Sx \&i Ta n Ta current |
.It nf Ta 0 Ta current |
.It Sx \&na Ta 0 Ta current |
.It r Ta 0 Ta current |
.It Sx \&nf Ta 0 Ta current |
.It sp Ta 1 Ta current |
.It Sx \&r Ta 0 Ta current |
|
.It Sx \&sp Ta 1 Ta current |
.El |
.El |
. |
. |
.Pp |
.Pp |
The |
The |
.Sq RS , |
.Sx \&PD , |
.Sq RE , |
.Sx \&RS , |
.Sq UC , |
.Sx \&RE , |
.Sq br , |
.Sx \&UC , |
.Sq fi , |
.Sx \&br , |
.Sq i , |
.Sx \&fi , |
.Sq na , |
.Sx \&i , |
.Sq nf , |
.Sx \&na , |
.Sq r , |
.Sx \&nf , |
|
.Sx \&r , |
and |
and |
.Sq sp |
.Sx \&sp |
macros should not be used. They're included for compatibility. |
macros should not be used. They're included for compatibility. |
. |
. |
. |
. |
Line 268 subsequent block macro invocation. |
|
Line 470 subsequent block macro invocation. |
|
.Pp |
.Pp |
The closure of body scope may be to the section, where a macro is closed |
The closure of body scope may be to the section, where a macro is closed |
by |
by |
.Sq SH ; |
.Sx \&SH ; |
sub-section, closed by a section or |
sub-section, closed by a section or |
.Sq SS ; |
.Sx \&SS ; |
part, closed by a section, sub-section, or |
part, closed by a section, sub-section, or |
.Sq RE ; |
.Sx \&RE ; |
or paragraph, closed by a section, sub-section, part, |
or paragraph, closed by a section, sub-section, part, |
.Sq HP , |
.Sx \&HP , |
.Sq IP , |
.Sx \&IP , |
.Sq LP , |
.Sx \&LP , |
.Sq P , |
.Sx \&P , |
.Sq PP , |
.Sx \&PP , |
or |
or |
.Sq TP . |
.Sx \&TP . |
No closure refers to an explicit block closing macro. |
No closure refers to an explicit block closing macro. |
. |
. |
.Pp |
.Pp |
.Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent |
.Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent |
.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope |
.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope |
.It HP Ta <2 Ta current Ta paragraph |
.It Sx \&HP Ta <2 Ta current Ta paragraph |
.It IP Ta <3 Ta current Ta paragraph |
.It Sx \&IP Ta <3 Ta current Ta paragraph |
.It LP Ta 0 Ta current Ta paragraph |
.It Sx \&LP Ta 0 Ta current Ta paragraph |
.It P Ta 0 Ta current Ta paragraph |
.It Sx \&P Ta 0 Ta current Ta paragraph |
.It PP Ta 0 Ta current Ta paragraph |
.It Sx \&PP Ta 0 Ta current Ta paragraph |
.It RE Ta 0 Ta current Ta none |
.It Sx \&RE Ta 0 Ta current Ta none |
.It RS Ta 1 Ta current Ta part |
.It Sx \&RS Ta 1 Ta current Ta part |
.It SH Ta >0 Ta next-line Ta section |
.It Sx \&SH Ta >0 Ta next-line Ta section |
.It SS Ta >0 Ta next-line Ta sub-section |
.It Sx \&SS Ta >0 Ta next-line Ta sub-section |
.It TP Ta n Ta next-line Ta paragraph |
.It Sx \&TP Ta n Ta next-line Ta paragraph |
.El |
.El |
. |
. |
.Pp |
.Pp |
If a block macro is next-line scoped, it may only be followed by in-line |
If a block macro is next-line scoped, it may only be followed by in-line |
macros (excluding |
macros (excluding |
.Sq DT , |
.Sx \&DT , |
.Sq TH , |
.Sx \&PD , |
.Sq UC , |
.Sx \&TH , |
.Sq br , |
.Sx \&UC , |
.Sq na , |
.Sx \&br , |
.Sq sp , |
.Sx \&na , |
.Sq nf , |
.Sx \&sp , |
|
.Sx \&nf , |
and |
and |
.Sq fi ) . |
.Sx \&fi ) . |
. |
. |
. |
. |
.Sh REFERENCE |
.Sh REFERENCE |
Line 318 alphabetically. For the scoping of individual macros, |
|
Line 521 alphabetically. For the scoping of individual macros, |
|
.Sx MACRO SYNTAX . |
.Sx MACRO SYNTAX . |
. |
. |
. |
. |
.Ss Definitions |
.Ss \&B |
In this reference, a numerical width may be either a standalone natural |
Text is rendered in bold face. |
number (such as 3, 4, 10, etc.) or a natural number followed by a width |
|
multiplier |
|
.Qq n , |
|
corresponding to the width of the formatted letter n, or |
|
.Qq m , |
|
corresponding to the width of the formatted letter m. The latter is the |
|
default, if unspecified. Thus, |
|
.Bd -literal -offset indent |
|
\&.HP 12n |
|
.Ed |
|
. |
|
.Pp |
.Pp |
indicates an offset of 12 |
See also |
.Qq n |
.Sx \&I , |
.Ns -sized |
.Sx \&R , |
letters. |
.Sx \&b , |
|
.Sx \&i , |
|
and |
|
.Sx \&r . |
. |
. |
. |
. |
.Ss Macro Reference |
.Ss \&BI |
.Bl -tag -width Ds |
|
.It B |
|
Text is rendered in bold face. |
|
.It BI |
|
Text is rendered alternately in bold face and italic. Thus, |
Text is rendered alternately in bold face and italic. Thus, |
.Sq .BI this word and that |
.Sq .BI this word and that |
causes |
causes |
Line 354 to render in bold face, while |
|
Line 545 to render in bold face, while |
|
and |
and |
.Sq that |
.Sq that |
render in italics. Whitespace between arguments is omitted in output. |
render in italics. Whitespace between arguments is omitted in output. |
.It BR |
.Pp |
|
Examples: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&BI |
|
bold italic bold italic |
|
.Ed |
|
.Pp |
|
The output of this example will be emboldened |
|
.Dq bold |
|
and italicised |
|
.Dq italic , |
|
with spaces stripped between arguments. |
|
.Pp |
|
See also |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
|
.Ss \&BR |
Text is rendered alternately in bold face and roman (the default font). |
Text is rendered alternately in bold face and roman (the default font). |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.It DT |
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
|
.Ss \&DT |
Has no effect. Included for compatibility. |
Has no effect. Included for compatibility. |
.It HP |
. |
|
. |
|
.Ss \&HP |
Begin a paragraph whose initial output line is left-justified, but |
Begin a paragraph whose initial output line is left-justified, but |
subsequent output lines are indented, with the following syntax: |
subsequent output lines are indented, with the following syntax: |
.Bd -literal -offset indent |
.Bd -filled -offset indent |
\&.HP [width] |
.Pf \. Sx \&HP |
|
.Op Cm width |
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
If |
The |
.Va width |
.Cm width |
is specified, it's saved for later paragraph left-margins; if |
argument must conform to |
unspecified, the saved or default width is used. |
.Sx Scaling Widths . |
.It I |
If specified, it's saved for later paragraph left-margins; if unspecified, the |
|
saved or default width is used. |
|
.Pp |
|
See also |
|
.Sx IP , |
|
.Sx LP , |
|
.Sx P , |
|
.Sx PP , |
|
and |
|
.Sx TP . |
|
. |
|
. |
|
.Ss \&I |
Text is rendered in italics. |
Text is rendered in italics. |
.It IB |
.Pp |
|
See also |
|
.Sx \&B , |
|
.Sx \&R , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
|
.Sx \&r . |
|
. |
|
. |
|
.Ss \&IB |
Text is rendered alternately in italics and bold face. Whitespace |
Text is rendered alternately in italics and bold face. Whitespace |
between arguments is omitted in output. |
between arguments is omitted in output. |
.It IP |
.Pp |
Begin a paragraph with the following syntax: |
See |
.Bd -literal -offset indent |
.Sx \&BI |
\&.IP [head [width]] |
for an equivalent example. |
.Ed |
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
. |
. |
|
. |
|
.Ss \&IP |
|
Begin an indented paragraph with the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&IP |
|
.Op Cm head Op Cm width |
|
.Ed |
.Pp |
.Pp |
This follows the behaviour of the |
The |
.Sq TP |
.Cm width |
except for the macro syntax (all arguments on the line, instead of |
argument defines the width of the left margin and is defined by |
having next-line scope). If |
.Sx Scaling Widths , |
.Va width |
It's saved for later paragraph left-margins; if unspecified, the saved or |
is specified, it's saved for later paragraph left-margins; if |
default width is used. |
unspecified, the saved or default width is used. |
.Pp |
.It IR |
The |
|
.Cm head |
|
argument is used as a leading term, flushed to the left margin. This is |
|
useful for bulleted paragraphs and so on. |
|
.Pp |
|
See also |
|
.Sx HP , |
|
.Sx LP , |
|
.Sx P , |
|
.Sx PP , |
|
and |
|
.Sx TP . |
|
. |
|
. |
|
.Ss \&IR |
Text is rendered alternately in italics and roman (the default font). |
Text is rendered alternately in italics and roman (the default font). |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.It LP, P, PP |
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
and |
|
.Sx \&RI . |
|
. |
|
. |
|
.Ss \&LP |
Begin an undecorated paragraph. The scope of a paragraph is closed by a |
Begin an undecorated paragraph. The scope of a paragraph is closed by a |
subsequent paragraph, sub-section, section, or end of file. The saved |
subsequent paragraph, sub-section, section, or end of file. The saved |
paragraph left-margin width is re-set to the default. |
paragraph left-margin width is re-set to the default. |
.It R |
.Pp |
|
See also |
|
.Sx HP , |
|
.Sx IP , |
|
.Sx P , |
|
.Sx PP , |
|
and |
|
.Sx TP . |
|
. |
|
. |
|
.Ss \&P |
|
Synonym for |
|
.Sx \&LP . |
|
.Pp |
|
See also |
|
.Sx HP , |
|
.Sx IP , |
|
.Sx LP , |
|
.Sx PP , |
|
and |
|
.Sx TP . |
|
. |
|
. |
|
.Ss \&PP |
|
Synonym for |
|
.Sx \&LP . |
|
.Pp |
|
See also |
|
.Sx HP , |
|
.Sx IP , |
|
.Sx LP , |
|
.Sx P , |
|
and |
|
.Sx TP . |
|
. |
|
. |
|
.Ss \&R |
Text is rendered in roman (the default font). |
Text is rendered in roman (the default font). |
.It RB |
.Pp |
|
See also |
|
.Sx \&I , |
|
.Sx \&B , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
|
.Sx \&r . |
|
. |
|
. |
|
.Ss \&RB |
Text is rendered alternately in roman (the default font) and bold face. |
Text is rendered alternately in roman (the default font) and bold face. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.It RE |
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
|
.Ss \&RE |
Explicitly close out the scope of a prior |
Explicitly close out the scope of a prior |
.Sq RS . |
.Sx \&RS . |
.It RI |
. |
|
. |
|
.Ss \&RI |
Text is rendered alternately in roman (the default font) and italics. |
Text is rendered alternately in roman (the default font) and italics. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.It RS |
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
|
.Ss \&RS |
Begin a part setting the left margin. The left margin controls the |
Begin a part setting the left margin. The left margin controls the |
offset, following an initial indentation, to un-indented text such as |
offset, following an initial indentation, to un-indented text such as |
that of |
that of |
.Sq PP . |
.Sx \&PP . |
The width may be specified as following: |
This has the following syntax: |
.Bd -literal -offset indent |
.Bd -filled -offset indent |
\&.RS [width] |
.Pf \. Sx \&Rs |
|
.Op Cm width |
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
If |
The |
.Va width |
.Cm width |
is not specified, the saved or default width is used. |
argument must conform to |
.It SB |
.Sx Scaling Widths . |
|
If not specified, the saved or default width is used. |
|
. |
|
. |
|
.Ss \&SB |
Text is rendered in small size (one point smaller than the default font) |
Text is rendered in small size (one point smaller than the default font) |
bold face. |
bold face. |
.It SH |
. |
|
. |
|
.Ss \&SH |
Begin a section. The scope of a section is only closed by another |
Begin a section. The scope of a section is only closed by another |
section or the end of file. The paragraph left-margin width is re-set |
section or the end of file. The paragraph left-margin width is re-set |
to the default. |
to the default. |
.It SM |
. |
|
. |
|
.Ss \&SM |
Text is rendered in small size (one point smaller than the default |
Text is rendered in small size (one point smaller than the default |
font). |
font). |
.It SS |
. |
|
. |
|
.Ss \&SS |
Begin a sub-section. The scope of a sub-section is closed by a |
Begin a sub-section. The scope of a sub-section is closed by a |
subsequent sub-section, section, or end of file. The paragraph |
subsequent sub-section, section, or end of file. The paragraph |
left-margin width is re-set to the default. |
left-margin width is re-set to the default. |
.It TH |
. |
|
. |
|
.Ss \&TH |
Sets the title of the manual page with the following syntax: |
Sets the title of the manual page with the following syntax: |
.Bd -literal -offset indent |
.Bd -filled -offset indent |
\&.TH title section [date [source [volume]]] |
.Pf \. Sx \&TH |
|
.Cm title section |
|
.Op Cm date Op Cm source Op Cm volume |
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
At least the |
At least the upper-case document title |
.Va title |
.Cm title |
and |
and numeric manual section |
.Va section |
.Cm section |
arguments must be provided. The |
arguments must be provided. The |
.Va date |
.Cm date |
argument should be formatted as |
argument should be formatted as described in |
.Qq %b [%d] %Y |
.Sx Dates : |
format, described in |
if it does not conform, the current date is used instead. The |
.Xr strptime 3 . |
.Cm source |
The |
|
.Va source |
|
string specifies the organisation providing the utility. The |
string specifies the organisation providing the utility. The |
.Va volume |
.Cm volume |
replaces the default rendered volume as dictated by the manual section. |
string replaces the default rendered volume, which is dictated by the |
.It TP |
manual section. |
|
.Pp |
|
Examples: |
|
.Bd -filled -offset indent |
|
\&.TH CVS 5 "1992-02-12" GNU |
|
.Ed |
|
. |
|
. |
|
.Ss \&TP |
Begin a paragraph where the head, if exceeding the indentation width, is |
Begin a paragraph where the head, if exceeding the indentation width, is |
followed by a newline; if not, the body follows on the same line after a |
followed by a newline; if not, the body follows on the same line after a |
buffer to the indentation width. Subsequent output lines are indented. |
buffer to the indentation width. Subsequent output lines are indented. |
. |
The syntax is as follows: |
.Pp |
.Bd -filled -offset indent |
The indentation width may be set as follows: |
.Pf \. Sx \&TP |
.Bd -literal -offset indent |
.Op Cm width |
\&.TP [width] |
|
.It UC |
|
Has no effect. Included for compatibility. |
|
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
Where |
The |
.Va width |
.Cm width |
must be a properly-formed numeric width. If |
argument must conform to |
.Va width |
.Sx Scaling Widths . |
is specified, it's saved for later paragraph left-margins; if |
If specified, it's saved for later paragraph left-margins; if |
unspecified, the saved or default width is used. |
unspecified, the saved or default width is used. |
.It br |
.Pp |
|
See also |
|
.Sx HP , |
|
.Sx IP , |
|
.Sx LP , |
|
.Sx P , |
|
and |
|
.Sx PP . |
|
. |
|
. |
|
.Ss \&PD |
|
Has no effect. Included for compatibility. |
|
. |
|
. |
|
.Ss \&UC |
|
Has no effect. Included for compatibility. |
|
. |
|
. |
|
.Ss \&br |
Breaks the current line. Consecutive invocations have no further effect. |
Breaks the current line. Consecutive invocations have no further effect. |
.It fi |
.Pp |
|
See also |
|
.Sx \&sp . |
|
. |
|
. |
|
.Ss \&fi |
End literal mode begun by |
End literal mode begun by |
.Sq nf . |
.Sx \&nf . |
.It i |
. |
|
. |
|
.Ss \&i |
Italicise arguments. If no arguments are specified, all subsequent text |
Italicise arguments. If no arguments are specified, all subsequent text |
is italicised. |
is italicised. |
.It na |
.Pp |
|
See also |
|
.Sx \&B , |
|
.Sx \&I , |
|
.Sx \&R . |
|
.Sx \&b , |
|
and |
|
.Sx \&r . |
|
. |
|
. |
|
.Ss \&na |
Don't align to the right margin. |
Don't align to the right margin. |
.It nf |
. |
|
. |
|
.Ss \&nf |
Begin literal mode: all subsequent free-form lines have their end of |
Begin literal mode: all subsequent free-form lines have their end of |
line boundaries preserved. May be ended by |
line boundaries preserved. May be ended by |
.Sq fi . |
.Sx \&fi . |
.It r |
. |
|
. |
|
.Ss \&r |
Fonts and styles (bold face, italics) reset to roman (default font). |
Fonts and styles (bold face, italics) reset to roman (default font). |
.It sp |
.Pp |
Insert n spaces, where n is the macro's positive numeric argument. If |
See also |
0, this is equivalent to the |
.Sx \&B , |
.Sq br |
.Sx \&I , |
macro. |
.Sx \&R , |
.El |
.Sx \&b , |
|
and |
|
.Sx \&i . |
|
. |
|
. |
|
.Ss \&sp |
|
Insert vertical spaces into output with the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&sp |
|
.Op Cm height |
|
.Ed |
|
.Pp |
|
Insert |
|
.Cm height |
|
spaces, which must conform to |
|
.Sx Scaling Widths . |
|
If 0, this is equivalent to the |
|
.Sx \&br |
|
macro. Defaults to 1, if unspecified. |
|
.Pp |
|
See also |
|
.Sx \&br . |
. |
. |
. |
. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |