version 1.69, 2010/05/12 17:08:03 |
version 1.75, 2010/07/16 10:25:54 |
Line 61 Blank lines are acceptable; where found, the output wi |
|
Line 61 Blank lines are acceptable; where found, the output wi |
|
vertical space. |
vertical space. |
.Ss Comments |
.Ss Comments |
Text following a |
Text following a |
.Sq \e\*" , |
.Sq \e\*q , |
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. |
line. |
A macro line with only a control character and comment escape, |
A macro line with only a control character and comment escape, |
.Sq \&.\e" , |
.Sq \&.\e\*q , |
is also ignored. |
is also ignored. |
Macro lines with only a control character and optionally whitespace are |
Macro lines with only a control character and optionally whitespace are |
stripped from input. |
stripped from input. |
|
|
When composing a manual, make sure that your sentences end at the end of |
When composing a manual, make sure that your sentences end at the end of |
a line. |
a line. |
By doing so, front-ends will be able to apply the proper amount of |
By doing so, front-ends will be able to apply the proper amount of |
spacing after the end of sentence (unescaped) period, exclamation, or question |
spacing after the end of sentence (unescaped) period, exclamation mark, |
mark. |
or question mark followed by zero or more non-sentence closing |
|
delimiters ( |
|
.Ns Sq \&) , |
|
.Sq \&] , |
|
.Sq \&' , |
|
.Sq \&" ) . |
.Sh MANUAL STRUCTURE |
.Sh MANUAL STRUCTURE |
Each |
Each |
.Nm |
.Nm |
Line 429 The syntax is as follows: |
|
Line 434 The syntax is as follows: |
|
.Pp |
.Pp |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
|
.It Sx \&AT Ta <=1 Ta current Ta \& |
.It Sx \&B Ta n Ta next-line Ta \& |
.It Sx \&B Ta n Ta next-line Ta \& |
.It Sx \&BI Ta n Ta current Ta \& |
.It Sx \&BI Ta n Ta current Ta \& |
.It Sx \&BR Ta n Ta current Ta \& |
.It Sx \&BR Ta n Ta current Ta \& |
Line 443 The syntax is as follows: |
|
Line 449 The syntax is as follows: |
|
.It Sx \&SB Ta n Ta next-line Ta \& |
.It Sx \&SB Ta n Ta next-line Ta \& |
.It Sx \&SM Ta n Ta next-line Ta \& |
.It Sx \&SM Ta n Ta next-line Ta \& |
.It Sx \&TH Ta >1, <6 Ta current Ta \& |
.It Sx \&TH Ta >1, <6 Ta current Ta \& |
.\" .It Sx \&UC Ta n Ta current Ta compat |
.It Sx \&UC Ta <=1 Ta current Ta \& |
.It Sx \&br Ta 0 Ta current Ta compat |
.It Sx \&br Ta 0 Ta current Ta compat |
.It Sx \&fi Ta 0 Ta current Ta compat |
.It Sx \&fi Ta 0 Ta current Ta compat |
.It Sx \&i Ta n Ta current Ta compat |
.It Sx \&i Ta n Ta current Ta compat |
Line 451 The syntax is as follows: |
|
Line 457 The syntax is as follows: |
|
.It Sx \&nf Ta 0 Ta current Ta compat |
.It Sx \&nf Ta 0 Ta current Ta compat |
.It Sx \&r Ta 0 Ta current Ta compat |
.It Sx \&r Ta 0 Ta current Ta compat |
.It Sx \&sp Ta 1 Ta current Ta compat |
.It Sx \&sp Ta 1 Ta current Ta compat |
.\" .It Sx \&Sp Ta 0 Ta current Ta compat |
.\" .It Sx \&Sp Ta <1 Ta current Ta compat |
.\" .It Sx \&Vb Ta <1 Ta current Ta compat |
.\" .It Sx \&Vb Ta <1 Ta current Ta compat |
.\" .It Sx \&Ve Ta 0 Ta current Ta compat |
.\" .It Sx \&Ve Ta 0 Ta current Ta compat |
.El |
.El |
Line 524 This section is a canonical reference to all macros, a |
|
Line 530 This section is a canonical reference to all macros, a |
|
alphabetically. |
alphabetically. |
For the scoping of individual macros, see |
For the scoping of individual macros, see |
.Sx MACRO SYNTAX . |
.Sx MACRO SYNTAX . |
|
.Ss \&AT |
|
Sets the volume for the footer for compatibility with man pages from |
|
.Tn AT&T UNIX |
|
releases. |
|
The optional arguments specify which release it is from. |
.Ss \&B |
.Ss \&B |
Text is rendered in bold face. |
Text is rendered in bold face. |
.Pp |
.Pp |
Line 798 arguments must be provided. |
|
Line 809 arguments must be provided. |
|
The |
The |
.Cm date |
.Cm date |
argument should be formatted as described in |
argument should be formatted as described in |
.Sx Dates : |
.Sx Dates , |
if it does not conform, the current date is used instead. |
but will be printed verbatim if it is not. |
|
If the date is not specified, the current date is used. |
The |
The |
.Cm source |
.Cm source |
string specifies the organisation providing the utility. |
string specifies the organisation providing the utility. |
|
|
.\" Has no effect. Included for compatibility. |
.\" Has no effect. Included for compatibility. |
.\" . |
.\" . |
.\" . |
.\" . |
.\" .Ss \&UC |
.Ss \&UC |
.\" Has no effect. Included for compatibility. |
Sets the volume for the footer for compatibility with man pages from |
|
BSD releases. |
|
The optional first argument specifies which release it is from. |
.Ss \&br |
.Ss \&br |
Breaks the current line. |
Breaks the current line. |
Consecutive invocations have no further effect. |
Consecutive invocations have no further effect. |