version 1.194, 2011/08/01 07:45:11 |
version 1.195, 2011/08/02 01:07:26 |
Line 65 A macro line with only a control character and comment |
|
Line 65 A macro line with only a control character and comment |
|
is also ignored. |
is also ignored. |
Macro lines with only a control character and optional whitespace are |
Macro lines with only a control character and optional whitespace are |
stripped from input. |
stripped from input. |
.Ss Reserved Terms |
|
Within a macro line, the following terms are reserved: |
|
.Pp |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It \&. |
|
.Pq period |
|
.It \e. |
|
.Pq escaped period |
|
.It \&, |
|
.Pq comma |
|
.It \&: |
|
.Pq colon |
|
.It \&; |
|
.Pq semicolon |
|
.It \&( |
|
.Pq left-parenthesis |
|
.It \&) |
|
.Pq right-parenthesis |
|
.It \&[ |
|
.Pq left-bracket |
|
.It \&] |
|
.Pq right-bracket |
|
.It \&? |
|
.Pq question |
|
.It \&! |
|
.Pq exclamation |
|
.It \&| |
|
.Pq vertical bar |
|
.It \e*(Ba |
|
.Pq reserved-word vertical bar |
|
.El |
|
.Pp |
|
For general use in macro lines, these can be escaped with a non-breaking |
|
space |
|
.Pq Sq \e& . |
|
In text lines, these may be used as normal punctuation. |
|
.Ss Special Characters |
.Ss Special Characters |
Special characters may occur in both macro and text lines. |
Special characters may occur in both macro and text lines. |
Sequences begin with the escape character |
Sequences begin with the escape character |
|
|
produces |
produces |
.Sq Op Fl O Ar file . |
.Sq Op Fl O Ar file . |
To prevent a macro call and render the macro name literally, |
To prevent a macro call and render the macro name literally, |
escape it by prepending a non-breaking space, |
escape it by prepending a zero-width space, |
.Sq \e& . |
.Sq \e& . |
For example, |
For example, |
.Sq \&Op \e&Fl O |
.Sq \&Op \e&Fl O |
|
|
.It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc |
.It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc |
.El |
.El |
.Ss Block partial-implicit |
.Ss Block partial-implicit |
Like block full-implicit, but with single-line scope closed by |
Like block full-implicit, but with single-line scope closed by the |
.Sx Reserved Terms |
end of the line. |
or end of line. |
|
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB |
.Ed |
.Ed |
Line 810 these blocks have bodies, but no heads. |
|
Line 773 these blocks have bodies, but no heads. |
|
.It Sx \&Ta Ta Yes Ta Yes Ta closed by Sx \&Ta , Sx \&It |
.It Sx \&Ta Ta Yes Ta Yes Ta closed by Sx \&Ta , Sx \&It |
.El |
.El |
.Ss In-line |
.Ss In-line |
Closed by |
Closed by the end of the line, fixed argument lengths, |
.Sx Reserved Terms , |
and/or subsequent macros. |
end of line, fixed argument lengths, and/or subsequent macros. |
|
In-line macros have only text children. |
In-line macros have only text children. |
If a number (or inequality) of arguments is |
If a number (or inequality) of arguments is |
.Pq n , |
.Pq n , |
Line 902 then the macro accepts an arbitrary number of argument |
|
Line 864 then the macro accepts an arbitrary number of argument |
|
.It Sx \&br Ta \&No Ta \&No Ta 0 |
.It Sx \&br Ta \&No Ta \&No Ta 0 |
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
.El |
.El |
|
.Ss Delimiters |
|
When a macro argument consists of one single input character |
|
considered as a delimiter, the argument gets special handling. |
|
This does not apply when delimiters appear in arguments containing |
|
more than one character. |
|
Consequently, to prevent special handling and just handle it |
|
like any other argument, a delimiter can be escaped by prepending |
|
a zero-width space |
|
.Pq Sq \e& . |
|
In text lines, delimiters never need escaping, but may be used |
|
as normal punctuation. |
|
.Pp |
|
For many macros, when the leading arguments are opening delimiters, |
|
these delimiters are put before the macro scope, |
|
and when the trailing arguments are closing delimiters, |
|
these delimiters are put after the macro scope. |
|
For example, |
|
.Pp |
|
.D1 Pf \. \&Aq "( [ word ] ) ." |
|
.Pp |
|
renders as: |
|
.Pp |
|
.D1 Aq ( [ word ] ) . |
|
.Pp |
|
Opening delimiters are: |
|
.Pp |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It \&( |
|
left parenthesis |
|
.It \&[ |
|
left bracket |
|
.El |
|
.Pp |
|
Closing delimiters are: |
|
.Pp |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It \&. |
|
period |
|
.It \&, |
|
comma |
|
.It \&: |
|
colon |
|
.It \&; |
|
semicolon |
|
.It \&) |
|
right parenthesis |
|
.It \&] |
|
right bracket |
|
.It \&? |
|
question mark |
|
.It \&! |
|
exclamation mark |
|
.El |
|
.Pp |
|
Note that even a period preceded by a backslash |
|
.Pq Sq \e.\& |
|
gets this special handling; use |
|
.Sq \e&. |
|
to prevent that. |
|
.Pp |
|
Many in-line macros interrupt their scope when they encounter |
|
delimiters, and resume their scope when more arguments follow that |
|
are not delimiters. |
|
For example, |
|
.Pp |
|
.D1 Pf \. \&Fl "a ( b | c \e*(Ba d ) e" |
|
.Pp |
|
renders as: |
|
.Pp |
|
.D1 Fl a ( b | c \*(Ba d ) e |
|
.Pp |
|
This applies to both opening and closing delimiters, |
|
and also to the middle delimiter: |
|
.Pp |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It \&| |
|
vertical bar |
|
.El |
|
.Pp |
|
As a special case, the predefined string \e*(Ba is handled and rendered |
|
in the same way as a plain |
|
.Sq \&| |
|
character. |
|
Using this predefined string is not recommended in new manuals. |
.Sh REFERENCE |
.Sh REFERENCE |
This section is a canonical reference of all macros, arranged |
This section is a canonical reference of all macros, arranged |
alphabetically. |
alphabetically. |
Line 2917 In new groff and mandoc, any list may be nested by def |
|
Line 2963 In new groff and mandoc, any list may be nested by def |
|
lists will restart the sequence only for the sub-list. |
lists will restart the sequence only for the sub-list. |
.It |
.It |
.Sx \&Li |
.Sx \&Li |
followed by a reserved character is incorrectly used in some manuals |
followed by a delimiter is incorrectly used in some manuals |
instead of properly quoting that character, which sometimes works with |
instead of properly quoting that character, which sometimes works with |
historic groff. |
historic groff. |
.It |
.It |