version 1.103, 2010/05/14 15:02:03 |
version 1.107, 2010/05/15 07:01:51 |
Line 301 When composing a manual, make sure that your sentences |
|
Line 301 When composing a manual, make sure that your sentences |
|
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 mark, |
spacing after the end of sentence (unescaped) period, exclamation mark, |
or question mark. |
or question mark followed by zero or more non-sentence closing |
|
delimiters ( |
|
.Ns Sq \&) , |
|
.Sq \&] , |
|
.Sq \&' , |
|
.Sq \&" ) . |
.Pp |
.Pp |
The proper spacing is also intelligently preserved if a sentence ends at |
The proper spacing is also intelligently preserved if a sentence ends at |
the boundary of a macro line. |
the boundary of a macro line, e.g., |
|
.Pp |
|
.D1 \&Xr mandoc 1 \. |
|
.D1 \&Fl T \&Ns \&Cm ascii \. |
.Sh MANUAL STRUCTURE |
.Sh MANUAL STRUCTURE |
A well-formed |
A well-formed |
.Nm |
.Nm |
|
|
.Ss \&Bk |
.Ss \&Bk |
.Ss \&Bl |
.Ss \&Bl |
Begins a list composed of one or more list entries. |
Begins a list composed of one or more list entries. |
|
A list is associated with a type, which is a required argument. |
|
Other arguments are |
|
.Fl width , |
|
defined per-type as accepting a literal or |
|
.Sx Scaling Widths |
|
value; |
|
.Fl offset , |
|
also accepting a literal or |
|
.Sx Scaling Widths |
|
value setting the list's global offset; and |
|
.Fl compact , |
|
suppressing the default vertical space printed before each list entry. |
A list entry is specified by the |
A list entry is specified by the |
.Sx \&It |
.Sx \&It |
macro, which consists of a head and optional body (depending on the list |
macro, which consists of a head and optional body (depending on the list |
Line 1103 A list must specify one of the following list types: |
|
Line 1123 A list must specify one of the following list types: |
|
A list offset by a bullet. |
A list offset by a bullet. |
The head of list entries must be empty. |
The head of list entries must be empty. |
List entry bodies are positioned after the bullet. |
List entry bodies are positioned after the bullet. |
|
The |
|
.Fl width |
|
argument varies the width of list bodies' left-margins. |
.It Fl column |
.It Fl column |
A columnated list. |
A columnated list. |
|
The |
|
.Fl width |
|
argument has no effect. |
The number of columns is specified as parameters to the |
The number of columns is specified as parameters to the |
.Sx \&Bl |
.Sx \&Bl |
macro. |
macro. |
Line 1131 will preserve the semicolon whitespace except for the |
|
Line 1157 will preserve the semicolon whitespace except for the |
|
A list offset by a dash (hyphen). |
A list offset by a dash (hyphen). |
The head of list entries must be empty. |
The head of list entries must be empty. |
List entry bodies are positioned past the dash. |
List entry bodies are positioned past the dash. |
|
The |
|
.Fl width |
|
argument varies the width of list bodies' left-margins. |
.It Fl diag |
.It Fl diag |
Like |
Like |
.Fl inset , |
.Fl inset , |
but with additional formatting to the head. |
but with additional formatting to the head. |
|
The |
|
.Fl width |
|
argument varies the width of list bodies' left-margins. |
.It Fl enum |
.It Fl enum |
An enumerated list offset by the enumeration from 1. |
An enumerated list offset by the enumeration from 1. |
The head of list entries must be empty. |
The head of list entries must be empty. |
List entry bodies are positioned after the enumeration. |
List entry bodies are positioned after the enumeration. |
|
The |
|
.Fl width |
|
argument varies the width of list bodies' left-margins. |
.It Fl hang |
.It Fl hang |
Like |
Like |
.Fl tag , |
.Fl tag , |
but instead of list bodies positioned after the head, they trail the |
but instead of list bodies positioned after the head, they trail the |
head text. |
head text. |
|
The |
|
.Fl width |
|
argument varies the width of list bodies' left-margins. |
.It Fl hyphen |
.It Fl hyphen |
Synonym for |
Synonym for |
.Fl dash . |
.Fl dash . |
.It Fl inset |
.It Fl inset |
List bodies follow the list head. |
List bodies follow the list head. |
|
The |
|
.Fl width |
|
argument is ignored. |
.It Fl item |
.It Fl item |
This produces blocks of text. |
This produces blocks of text. |
The head of list entries must be empty. |
The head of list entries must be empty. |
|
The |
|
.Fl width |
|
argument is ignored. |
.It Fl ohang |
.It Fl ohang |
List bodies are positioned on the line following the head. |
List bodies are positioned on the line following the head. |
|
The |
|
.Fl width |
|
argument is ignored. |
.It Fl tag |
.It Fl tag |
A list offset by list entry heads. List entry bodies are positioned |
A list offset by list entry heads. List entry bodies are positioned |
after the head as specified by the |
after the head as specified by the |
Line 1917 This is not the case in mandoc. |
|
Line 1964 This is not the case in mandoc. |
|
In groff, the |
In groff, the |
.Sx \&Cd , |
.Sx \&Cd , |
.Sx \&Er , |
.Sx \&Er , |
|
.Sx \&Ex , |
and |
and |
.Sx \&Ex |
.Sx \&Rv |
macros were stipulated only to occur in certain manual sections. |
macros were stipulated only to occur in certain manual sections. |
mandoc does not have these restrictions. |
mandoc does not have these restrictions. |
|
.It |
|
Newer groff and mandoc print |
|
.Qq AT&T UNIX |
|
prior to unknown arguments of |
|
.Sx \&At ; |
|
older groff did nothing. |
.El |
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |