version 1.50, 2009/07/20 13:45:11 |
version 1.55, 2009/07/29 08:58:11 |
Line 111 for two-character sequences; an open-bracket |
|
Line 111 for two-character sequences; an open-bracket |
|
for n-character sequences (terminated at a close-bracket |
for n-character sequences (terminated at a close-bracket |
.Sq \&] ) ; |
.Sq \&] ) ; |
or a single one-character sequence. See |
or a single one-character sequence. See |
.Xr mandoc_char 1 |
.Xr mandoc_char 7 |
for a complete list. Examples include |
for a complete list. Examples include |
.Sq \e(em |
.Sq \e(em |
.Pq em-dash |
.Pq em-dash |
and |
and |
.Sq \ee |
.Sq \ee |
.Pq back-slash . |
.Pq back-slash . |
.\" PARAGRAPH------------ |
.\" SUB-SECTION---------------------- |
.Pp |
.Ss Text Decoration |
An alternative escape sequence is |
Terms may be text-decorated using the |
the slash-asterisk, |
|
.Sq \e* , |
|
but this method is discouraged for compatibility reasons. |
|
.\" PARAGRAPH------------ |
|
.Pp |
|
Terms may |
|
also be text-decorated using the |
|
.Sq \ef |
.Sq \ef |
escape followed by an indicator: B (bold), I, (italic), or P and R |
escape followed by an indicator: B (bold), I, (italic), or P and R |
(Roman, or reset). This form is not recommended. |
(Roman, or reset). This form is not recommended for |
|
.Nm , |
|
which encourages semantic, not presentation, annotation. |
.\" SUB-SECTION---------------------- |
.\" SUB-SECTION---------------------- |
|
.Ss Predefined Strings |
|
Historically, |
|
.Xr groff 1 |
|
also defined a set of package-specific |
|
.Dq predefined strings , |
|
which, like |
|
.Sx Special Characters , |
|
demark special output characters and strings by way of input codes. |
|
Predefined strings are escaped with the slash-asterisk, |
|
.Sq \e* : |
|
single-character |
|
.Sq \e*X , |
|
two-character |
|
.Sq \e*(XX , |
|
and N-character |
|
.Sq \e*[N] . |
|
See |
|
.Xr mandoc_char 7 |
|
for a complete list. Examples include |
|
.Sq \e*(Am |
|
.Pq ampersand |
|
and |
|
.Sq \e*(Ba |
|
.Pq vertical bar . |
|
.\" SUB-SECTION---------------------- |
.Ss Whitespace |
.Ss Whitespace |
In non-literal free-form lines, consecutive blocks of whitespace are |
In non-literal free-form lines, consecutive blocks of whitespace are |
pruned from input and added later in the output filter, if applicable: |
pruned from input and added later in the output filter, if applicable: |
|
|
The |
The |
.Em Callable |
.Em Callable |
column indicates that the macro may be called subsequent to the initial |
column indicates that the macro may be called subsequent to the initial |
line-macro. The |
line-macro. If a macro is not callable, then its invocation after the |
|
initial line macro is interpreted as opaque text, such that |
|
.Sq \&.Fl Sh |
|
produces |
|
.Sq Fl Sh . |
|
.\" PARAGRAPH------------ |
|
.Pp |
|
The |
.Em Parsable |
.Em Parsable |
column indicates whether the macro may be followed by further |
column indicates whether the macro may be followed by further |
(ostensibly callable) macros. The |
(ostensibly callable) macros. If a macro is not parsable, subsequent |
|
macro invocations on the line will be interpreted as opaque text. |
|
.\" PARAGRAPH------------ |
|
.Pp |
|
The |
.Em Scope |
.Em Scope |
column, if applicable, describes closure rules. |
column, if applicable, describes closure rules. |
.\" SUB-SECTION---------------------- |
.\" SUB-SECTION---------------------- |
|
|
.Bl -dash -compact |
.Bl -dash -compact |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
|
The |
|
.Sq \-split |
|
or |
|
.Sq \-nosplit |
|
argument to |
|
.Sq \&An |
|
applies to the whole document, not just to the current section as it |
|
does in groff. |
|
.\" LIST-ITEM |
|
.It |
In quoted literals, groff allowed pair-wise double-quotes to produce a |
In quoted literals, groff allowed pair-wise double-quotes to produce a |
standalone double-quote in formatted output. This idiosyncratic |
standalone double-quote in formatted output. This idiosyncratic |
behaviour is no longer applicable. |
behaviour is no longer applicable. |
|
|
macro does not accept negative numbers. |
macro does not accept negative numbers. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
Some character sequences in groff are not handled depending on escape |
|
style, e.g., |
|
.Sq \e(ba |
|
and |
|
.Sq \e*(Ba |
|
may not be interchanged. This is no longer the case: all character |
|
sequences resolve to the same symbol, regardless the escape style. |
|
.\" LIST-ITEM |
|
.It |
|
Blocks of whitespace are stripped from both macro and free-form text |
Blocks of whitespace are stripped from both macro and free-form text |
lines (except when in literal mode), while groff would retain whitespace |
lines (except when in literal mode), while groff would retain whitespace |
in free-form text lines. |
in free-form text lines. |
Line 515 incorrectly by following it with a reserved character |
|
Line 547 incorrectly by following it with a reserved character |
|
delimiter to render. This is not supported. |
delimiter to render. This is not supported. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
If an special-character control character is escaped |
|
.Sq \e\e , |
|
it will obviously not render the subsequent sequence. Even newer |
|
versions of groff seem to dither on this. |
|
.\" LIST-ITEM |
|
.It |
|
In groff, the |
In groff, the |
.Sq \&Fo |
.Sq \&Fo |
macro only produces the first parameter. This is no longer the case. |
macro only produces the first parameter. This is no longer the case. |
Line 605 There's no way to refer to references in |
|
Line 631 There's no way to refer to references in |
|
blocks. |
blocks. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
The \-split and \-nosplit arguments to |
The \-split and \-nosplit dictates via |
.Sq \&An |
.Sq \&An |
are inane. |
are re-set when entering and leaving the AUTHORS section. |
.El |
.El |