version 1.47, 2009/11/05 08:40:16 |
version 1.59, 2010/03/27 10:10:10 |
Line 67 line termination. |
|
Line 67 line termination. |
|
Blank lines are acceptable; where found, the output will assert a |
Blank lines are acceptable; where found, the output will assert a |
vertical space. |
vertical space. |
. |
. |
.Pp |
|
The |
|
.Sq \ec |
|
escape is common in historical |
|
.Nm |
|
documents; if encountered at the end of a word, it ensures that the |
|
subsequent word isn't off-set by whitespace. |
|
. |
. |
. |
|
.Ss Comments |
.Ss Comments |
Text following a |
Text following a |
.Sq \e\*" , |
.Sq \e\*" , |
|
|
Terms may be text-decorated using the |
Terms may be text-decorated using the |
.Sq \ef |
.Sq \ef |
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P |
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P |
(revert to previous mode). A numerical representation 3, 2, or 1 |
(revert to previous mode): |
(bold, italic, and Roman, respectively) may be used instead. |
.Pp |
|
.D1 \efBbold\efR \efIitalic\efP |
|
.Pp |
|
A numerical representation 3, 2, or 1 (bold, italic, and Roman, |
|
respectively) may be used instead. A text decoration is only valid, if |
|
specified in free-form text, until the next macro invocation; if |
|
specified within a macro, it's only valid until the macro closes scope. |
|
Note that macros like |
|
.Sx \&BR |
|
open and close a font scope with each argument. |
|
.Pp |
|
Text may also be sized with the |
|
.Sq \es |
|
escape, whose syntax is one of |
|
.Sq \es+-n |
|
for one-digit numerals; |
|
.Sq \es(+-nn |
|
or |
|
.Sq \es+-(nn |
|
for two-digit numerals; and |
|
.Sq \es[+-N] , |
|
.Sq \es+-[N] , |
|
.Sq \es'+-N' , |
|
or |
|
.Sq \es+-'N' |
|
for arbitrary-digit numerals: |
|
.Pp |
|
.D1 \es+1bigger\es-1 |
|
.D1 \es[+10]much bigger\es[-10] |
|
.D1 \es+(10much bigger\es-(10 |
|
.D1 \es+'100'much much bigger\es-'100' |
|
.Pp |
|
Both |
|
.Sq \es |
|
and |
|
.Sq \ef |
|
attributes are forgotten when entering or exiting a macro block. |
. |
. |
. |
. |
.Ss Whitespace |
.Ss Whitespace |
Line 267 the C library, this may be as follows: |
|
Line 295 the C library, this may be as follows: |
|
.D1 Standard C Library (libc, -lc) |
.D1 Standard C Library (libc, -lc) |
.It Em SYNOPSIS |
.It Em SYNOPSIS |
Documents the utility invocation syntax, function call syntax, or device |
Documents the utility invocation syntax, function call syntax, or device |
configuration. |
configuration. |
.Pp |
.Pp |
For the first, utilities (sections 1, 6, and 8), this is |
For the first, utilities (sections 1, 6, and 8), this is |
generally structured as follows: |
generally structured as follows: |
Line 282 And for the third, configurations (section 4): |
|
Line 310 And for the third, configurations (section 4): |
|
.Pp |
.Pp |
.D1 \&.B name* at cardbus ? function ? |
.D1 \&.B name* at cardbus ? function ? |
.Pp |
.Pp |
Manuals not in these sections generally don't need a |
Manuals not in these sections generally don't need a |
.Em SYNOPSIS . |
.Em SYNOPSIS . |
.It Em DESCRIPTION |
.It Em DESCRIPTION |
This expands upon the brief, one-line description in |
This expands upon the brief, one-line description in |
.Em NAME . |
.Em NAME . |
It usually contains a break-down of the options (if documenting a |
It usually contains a break-down of the options (if documenting a |
command). |
command). |
Line 333 Documents error handling in sections 2, 3, and 9. |
|
Line 361 Documents error handling in sections 2, 3, and 9. |
|
. |
. |
.It Em SEE ALSO |
.It Em SEE ALSO |
References other manuals with related topics. This section should exist |
References other manuals with related topics. This section should exist |
for most manuals. |
for most manuals. |
.Pp |
.Pp |
.D1 \&.BR bar \&( 1 \&), |
.D1 \&.BR bar \&( 1 \&), |
.Pp |
.Pp |
Line 375 Documents any security precautions that operators shou |
|
Line 403 Documents any security precautions that operators shou |
|
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. The |
sit between the control character and the macro name. Thus, the |
.Sq \(aq |
following are equivalent: |
macro control character is also accepted. An arbitrary amount of |
|
whitespace may sit between the control character and the macro name. |
|
Thus, the following are equivalent: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.PP |
\&.PP |
\&.\ \ \ PP |
\&.\ \ \ PP |
Line 395 subsequent lines until closed by another block macro. |
|
Line 425 subsequent lines until closed by another block macro. |
|
.Ss Line Macros |
.Ss Line Macros |
Line macros are generally scoped to the current line, with the body |
Line macros are generally scoped to the current line, with the body |
consisting of zero or more arguments. If a macro is scoped to the next |
consisting of zero or more arguments. If a macro is scoped to the next |
line and the line arguments are empty, the next line is used instead, |
line and the line arguments are empty, the next line, which must be |
else the general syntax is used. Thus: |
text, is used instead. Thus: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.I |
\&.I |
foo |
foo |
|
|
.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; in |
If next-line macros are invoked consecutively, only the last is used. |
other words, if a next-line macro is preceded by a block macro, it is |
If a next-line macro is followed by a non-next-line macro, an error is |
ignored. |
raised (unless in the case of |
|
.Sx \&br , |
|
.Sx \&sp , |
|
.Sx \&Sp , |
|
or |
|
.Sx \&na ) . |
|
.Pp |
|
The syntax is as follows: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.YO \(lBbody...\(rB |
\&.YO \(lBbody...\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
.Ed |
.Ed |
. |
. |
.Pp |
.Pp |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" |
.It Em Macro Ta Em Arguments Ta Em Scope |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
.It Sx \&B Ta n Ta next-line |
.It Sx \&B Ta n Ta next-line Ta \& |
.It Sx \&BI Ta n Ta current |
.It Sx \&BI Ta n Ta current Ta \& |
.It Sx \&BR Ta n Ta current |
.It Sx \&BR Ta n Ta current Ta \& |
.It Sx \&DT Ta 0 Ta current |
.It Sx \&DT Ta 0 Ta current Ta \& |
.It Sx \&I Ta n Ta next-line |
.It Sx \&I Ta n Ta next-line Ta \& |
.It Sx \&IB Ta n Ta current |
.It Sx \&IB Ta n Ta current Ta \& |
.It Sx \&IR Ta n Ta current |
.It Sx \&IR Ta n Ta current Ta \& |
.It Sx \&PD Ta n Ta current |
.\" .It Sx \&PD Ta n Ta current Ta compat |
.It Sx \&R Ta n Ta next-line |
.It Sx \&R Ta n Ta next-line Ta \& |
.It Sx \&RB Ta n Ta current |
.It Sx \&RB Ta n Ta current Ta \& |
.It Sx \&RI Ta n Ta current |
.It Sx \&RI Ta n Ta current Ta \& |
.It Sx \&SB Ta n Ta next-line |
.It Sx \&SB Ta n Ta next-line Ta \& |
.It Sx \&SM Ta n Ta next-line |
.It Sx \&SM Ta n Ta next-line Ta \& |
.It Sx \&TH Ta >1, <6 Ta current |
.It Sx \&TH Ta >1, <6 Ta current Ta \& |
.It Sx \&UC Ta n Ta current |
.\" .It Sx \&UC Ta n Ta current Ta compat |
.It Sx \&br Ta 0 Ta current |
.It Sx \&br Ta 0 Ta current Ta compat |
.It Sx \&fi Ta 0 Ta current |
.It Sx \&fi Ta 0 Ta current Ta compat |
.It Sx \&i Ta n Ta current |
.It Sx \&i Ta n Ta current Ta compat |
.It Sx \&na Ta 0 Ta current |
.It Sx \&na Ta 0 Ta current Ta compat |
.It Sx \&nf Ta 0 Ta current |
.It Sx \&nf Ta 0 Ta current Ta compat |
.It Sx \&r Ta 0 Ta current |
.It Sx \&r Ta 0 Ta current Ta compat |
.It Sx \&sp Ta 1 Ta current |
.It Sx \&sp Ta 1 Ta current Ta compat |
|
.\" .It Sx \&Sp Ta 0 Ta current Ta compat |
|
.\" .It Sx \&Vb Ta <1 Ta current Ta compat |
|
.\" .It Sx \&Ve Ta 0 Ta current Ta compat |
.El |
.El |
. |
. |
.Pp |
.Pp |
The |
Macros marked as |
.Sx \&PD , |
.Qq compat |
.Sx \&RS , |
are included for compatibility with the significant corpus of existing |
.Sx \&RE , |
manuals that mix dialects of roff. These macros should not be used for |
.Sx \&UC , |
portable |
.Sx \&br , |
.Nm |
.Sx \&fi , |
manuals. |
.Sx \&i , |
|
.Sx \&na , |
|
.Sx \&nf , |
|
.Sx \&r , |
|
and |
|
.Sx \&sp |
|
macros should not be used. They're included for compatibility. |
|
. |
. |
. |
. |
.Ss Block Macros |
.Ss Block Macros |
Block macros are comprised of a head and body. Like for in-line macros, |
Block macros are comprised of a head and body. Like for in-line macros, |
the head is scoped to the current line and, in one circumstance, the |
the head is scoped to the current line and, in one circumstance, the |
next line; the body is scoped to subsequent lines and is closed out by a |
next line (the next-line stipulations as in |
subsequent block macro invocation. |
.Sx Line Macros |
|
apply here as well). |
|
.Pp |
|
The syntax is as follows: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.YO \(lBhead...\(rB |
\&.YO \(lBhead...\(rB |
\(lBhead...\(rB |
\(lBhead...\(rB |
Line 476 sub-section, closed by a section or |
|
Line 512 sub-section, closed by a section or |
|
.Sx \&SS ; |
.Sx \&SS ; |
part, closed by a section, sub-section, or |
part, closed by a section, sub-section, or |
.Sx \&RE ; |
.Sx \&RE ; |
or paragraph, closed by a section, sub-section, part, |
or paragraph, closed by a section, sub-section, part, |
.Sx \&HP , |
.Sx \&HP , |
.Sx \&IP , |
.Sx \&IP , |
.Sx \&LP , |
.Sx \&LP , |
|
|
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 |
As a rule, block macros may not be nested; thus, calling a block macro |
.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope |
while another block macro scope is open, and the open scope is not |
.It Sx \&HP Ta <2 Ta current Ta paragraph |
implicitly closed, is syntactically incorrect. |
.It Sx \&IP Ta <3 Ta current Ta paragraph |
. |
.It Sx \&LP Ta 0 Ta current Ta paragraph |
.Pp |
.It Sx \&P Ta 0 Ta current Ta paragraph |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" |
.It Sx \&PP Ta 0 Ta current Ta paragraph |
.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope Ta Em Notes |
.It Sx \&RE Ta 0 Ta current Ta none |
.It Sx \&HP Ta <2 Ta current Ta paragraph Ta \& |
.It Sx \&RS Ta 1 Ta current Ta part |
.It Sx \&IP Ta <3 Ta current Ta paragraph Ta \& |
.It Sx \&SH Ta >0 Ta next-line Ta section |
.It Sx \&LP Ta 0 Ta current Ta paragraph Ta \& |
.It Sx \&SS Ta >0 Ta next-line Ta sub-section |
.It Sx \&P Ta 0 Ta current Ta paragraph Ta \& |
.It Sx \&TP Ta n Ta next-line Ta paragraph |
.It Sx \&PP Ta 0 Ta current Ta paragraph Ta \& |
|
.It Sx \&RE Ta 0 Ta current Ta none Ta compat |
|
.It Sx \&RS Ta 1 Ta current Ta part Ta compat |
|
.It Sx \&SH Ta >0 Ta next-line Ta section Ta \& |
|
.It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \& |
|
.It Sx \&TP Ta n Ta next-line Ta paragraph Ta \& |
.El |
.El |
|
.Pp |
. |
. |
|
Macros marked |
|
.Qq compat |
|
are as mentioned in |
|
.Sx Line Macros . |
|
. |
.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 for decorating text. |
.Sx \&DT , |
|
.Sx \&PD , |
|
.Sx \&TH , |
|
.Sx \&UC , |
|
.Sx \&br , |
|
.Sx \&na , |
|
.Sx \&sp , |
|
.Sx \&nf , |
|
and |
|
.Sx \&fi ) . |
|
. |
. |
. |
. |
.Sh REFERENCE |
.Sh REFERENCE |
|
|
. |
. |
. |
. |
.Ss \&BI |
.Ss \&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 |
.Sq this |
.Sq this |
and |
and |
.Sq and |
.Sq and |
to render in bold face, while |
to render in bold face, while |
.Sq word |
.Sq word |
and |
and |
.Sq that |
.Sq that |
|
|
.Cm width |
.Cm width |
argument must conform to |
argument must conform to |
.Sx Scaling Widths . |
.Sx Scaling Widths . |
If not specified, the saved or default width is used. |
If not specified, the saved or default width is used. |
. |
. |
. |
. |
.Ss \&SB |
.Ss \&SB |
|
|
.Sx \&P , |
.Sx \&P , |
and |
and |
.Sx \&PP . |
.Sx \&PP . |
|
.\" . |
|
.\" . |
|
.\" .Ss \&PD |
|
.\" Has no effect. Included for compatibility. |
|
.\" . |
|
.\" . |
|
.\" .Ss \&UC |
|
.\" Has no effect. Included for compatibility. |
. |
. |
. |
. |
.Ss \&PD |
|
Has no effect. Included for compatibility. |
|
. |
|
. |
|
.Ss \&UC |
|
Has no effect. Included for compatibility. |
|
. |
|
. |
|
.Ss \&br |
.Ss \&br |
Breaks the current line. Consecutive invocations have no further effect. |
Breaks the current line. Consecutive invocations have no further effect. |
.Pp |
.Pp |
Line 891 End literal mode begun by |
|
Line 928 End literal mode begun by |
|
. |
. |
. |
. |
.Ss \&i |
.Ss \&i |
Italicise arguments. If no arguments are specified, all subsequent text |
Italicise arguments. Synonym for |
is italicised. |
.Sx \&I . |
.Pp |
.Pp |
See also |
See also |
.Sx \&B , |
.Sx \&B , |
Line 932 Insert vertical spaces into output with the following |
|
Line 969 Insert vertical spaces into output with the following |
|
.Op Cm height |
.Op Cm height |
.Ed |
.Ed |
.Pp |
.Pp |
Insert |
Insert |
.Cm height |
.Cm height |
spaces, which must conform to |
spaces, which must conform to |
.Sx Scaling Widths . |
.Sx Scaling Widths . |
Line 943 macro. Defaults to 1, if unspecified. |
|
Line 980 macro. Defaults to 1, if unspecified. |
|
See also |
See also |
.Sx \&br . |
.Sx \&br . |
. |
. |
|
.\" .Ss \&Sp |
|
.\" A synonym for |
|
.\" .Sx \&sp |
|
.\" .Cm 0.5v . |
|
.\" . |
|
.\" .Ss \&Vb |
|
.\" A synonym for |
|
.\" .Sx \&nf . |
|
.\" Accepts an argument (the height of the formatted space) which is |
|
.\" disregarded. |
|
.\" . |
|
.\" .Ss \&Ve |
|
.\" A synonym for |
|
.\" .Sx \&fi . |
|
.\" . |
. |
. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility with other roff implementations, at |
This section documents areas of questionable portability between |
this time limited to |
implementations of the |
.Xr groff 1 . |
.Nm |
.Bl -hyphen |
language. |
|
. |
|
.Pp |
|
.Bl -dash -compact |
.It |
.It |
In quoted literals, groff allowed pair-wise double-quotes to produce a |
In quoted literals, GNU troff allowed pair-wise double-quotes to produce |
standalone double-quote in formatted output. This idiosyncratic |
a standalone double-quote in formatted output. It is not known whether |
behaviour is no longer applicable. |
this behaviour is exhibited by other formatters. |
|
. |
.It |
.It |
|
Blocks of whitespace are stripped from macro and free-form text lines |
|
(except when in literal mode) in mandoc. This is not the case for GNU |
|
troff: for maximum portability, whitespace sensitive blocks should be |
|
enclosed in literal contexts. |
|
. |
|
.It |
The |
The |
.Sq sp |
.Sx \&sp |
macro does not accept negative numbers. |
macro does not accept negative values in mandoc. In GNU troff, this |
|
would result in strange behaviour. |
|
. |
.It |
.It |
Blocks of whitespace are stripped from both macro and free-form text |
The |
lines (except when in literal mode), while groff would retain whitespace |
.Sq \(aq |
in free-form text lines. |
macro control character, in GNU troff (and prior troffs) suppresses a |
|
newline before macro output; in mandoc, it is an alias for the standard |
|
.Sq \&. |
|
control character. |
.El |
.El |
. |
. |
. |
. |