version 1.68, 2010/05/12 16:52:33 |
version 1.76, 2010/07/19 09:19:22 |
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. |
Line 106 Note that macros like |
|
Line 106 Note that macros like |
|
.Sx \&BR |
.Sx \&BR |
open and close a font scope with each argument. |
open and close a font scope with each argument. |
.Pp |
.Pp |
Text may also be sized with the |
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 |
.Sq \ef |
attributes are forgotten when entering or exiting a macro block. |
attribute is forgotten when entering or exiting a macro block. |
.Ss Whitespace |
.Ss Whitespace |
Whitespace consists of the space character. |
Whitespace consists of the space character. |
In free-form lines, whitespace is preserved within a line; un-escaped |
In free-form lines, whitespace is preserved within a line; un-escaped |
Line 212 this differs from |
|
Line 189 this differs from |
|
.Xr mdoc 7 , |
.Xr mdoc 7 , |
which, if a unit is not provided, will instead interpret the string as |
which, if a unit is not provided, will instead interpret the string as |
literal text. |
literal text. |
|
.Ss Sentence Spacing |
|
When composing a manual, make sure that your sentences end at the end of |
|
a line. |
|
By doing so, front-ends will be able to apply the proper amount of |
|
spacing after the end of sentence (unescaped) period, exclamation 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 227 at least one macro or text node must appear in the doc |
|
Line 215 at least one macro or text node must appear in the doc |
|
Documents are generally structured as follows: |
Documents are generally structured as follows: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.TH FOO 1 2009-10-10 |
\&.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 |
\&.\e\*q The next is for sections 2 & 3 only. |
\&.\e\*q The next is for sections 2 & 3 only. |
\&.\e\*q .SH LIBRARY |
\&.\e\*q .SH LIBRARY |
\&. |
|
\&.SH SYNOPSIS |
\&.SH SYNOPSIS |
\efBfoo\efR [\efB\e-options\efR] arguments... |
\efBfoo\efR [\efB\e-options\efR] arguments... |
\&. |
|
\&.SH DESCRIPTION |
\&.SH DESCRIPTION |
The \efBfoo\efR utility processes files... |
The \efBfoo\efR utility processes files... |
\&. |
|
\&.\e\*q .SH IMPLEMENTATION NOTES |
\&.\e\*q .SH IMPLEMENTATION NOTES |
\&.\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 RETURN VALUES |
\&.\e\*q .SH RETURN VALUES |
Line 423 The syntax is as follows: |
|
Line 407 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 437 The syntax is as follows: |
|
Line 422 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 445 The syntax is as follows: |
|
Line 430 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 518 This section is a canonical reference to all macros, a |
|
Line 503 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 792 arguments must be provided. |
|
Line 782 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. |