version 1.56, 2010/03/22 05:59:32 |
version 1.57, 2010/03/23 11:30:48 |
Line 438 If a next-line macro is followed by a non-next-line ma |
|
Line 438 If a next-line macro is followed by a non-next-line ma |
|
raised (unless in the case of |
raised (unless in the case of |
.Sx \&br , |
.Sx \&br , |
.Sx \&sp , |
.Sx \&sp , |
|
.Sx \&Sp , |
or |
or |
.Sx \&na ) . |
.Sx \&na ) . |
.Pp |
.Pp |
Line 448 The syntax is as follows: |
|
Line 449 The syntax is as follows: |
|
.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 manuals. |
.Sx \&br , |
|
.Sx \&fi , |
|
.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 next-line stipulations for line macros apply here as |
next line (the next-line stipulations as in |
well). |
.Sx Line Macros |
|
apply here as well). |
.Pp |
.Pp |
The syntax is as follows: |
The syntax is as follows: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
|
|
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 -compact -offset indent "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" |
.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 Ta Em Notes |
.It Sx \&HP Ta <2 Ta current Ta paragraph |
.It Sx \&HP Ta <2 Ta current Ta paragraph Ta \& |
.It Sx \&IP Ta <3 Ta current Ta paragraph |
.It Sx \&IP Ta <3 Ta current Ta paragraph Ta \& |
.It Sx \&LP Ta 0 Ta current Ta paragraph |
.It Sx \&LP Ta 0 Ta current Ta paragraph Ta \& |
.It Sx \&P Ta 0 Ta current Ta paragraph |
.It Sx \&P Ta 0 Ta current Ta paragraph Ta \& |
.It Sx \&PP Ta 0 Ta current Ta paragraph |
.It Sx \&PP Ta 0 Ta current Ta paragraph Ta \& |
.It Sx \&RE Ta 0 Ta current Ta none |
.It Sx \&RE Ta 0 Ta current Ta none Ta compat |
.It Sx \&RS Ta 1 Ta current Ta part |
.It Sx \&RS Ta 1 Ta current Ta part Ta compat |
.It Sx \&SH Ta >0 Ta next-line Ta section |
.It Sx \&SH Ta >0 Ta next-line Ta section Ta \& |
.It Sx \&SS Ta >0 Ta next-line Ta sub-section |
.It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \& |
.It Sx \&TP Ta n Ta next-line Ta paragraph |
.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 |
Line 978 macro. Defaults to 1, if unspecified. |
|
Line 970 macro. Defaults to 1, if unspecified. |
|
.Pp |
.Pp |
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 |