version 1.9, 2009/07/27 12:02:49 |
version 1.10, 2009/07/27 12:35:53 |
|
|
.Nd mandoc special characters |
.Nd mandoc special characters |
.\" SECTION |
.\" SECTION |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
This documents the special characters accepted by |
This documents the special characters and predefined strings accepted by |
.Xr mandoc 1 |
.Xr mandoc 1 |
to format |
to format |
.Xr mdoc 7 |
.Xr mdoc 7 |
Line 34 documents. Specific output devices of |
|
Line 34 documents. Specific output devices of |
|
dictated by the |
dictated by the |
.Fl T Ns Ar output |
.Fl T Ns Ar output |
argument, will properly render these sequences. |
argument, will properly render these sequences. |
|
.\" PARAGRAPH |
.Pp |
.Pp |
Both |
Both |
.Xr mdoc 7 |
.Xr mdoc 7 |
and |
and |
.Xr man 7 |
.Xr man 7 |
encode these special characters with |
encode special characters with |
.Sq \eX |
.Sq \eX |
.Pq for a one-character escape , |
.Pq for a one-character escape , |
.Sq \e(XX |
.Sq \e(XX |
|
|
One may generalise |
One may generalise |
.Sq \e(XX |
.Sq \e(XX |
as |
as |
.Sq \e[XX] . |
.Sq \e[XX] |
|
and |
|
.Sq \eX |
|
as |
|
.Sq \e[X] . |
|
Predefined strings are functionally similar to special characters, using |
|
.Sq \e*X |
|
.Pq for a one-character escape , |
|
.Sq \e*(XX |
|
.Pq two-character , |
|
and |
|
.Sq \e*[N] |
|
.Pq N-character . |
|
One may generalise |
|
.Sq \e*(XX |
|
as |
|
.Sq \e*[XX] |
|
and |
|
.Sq \e*X |
|
as |
|
.Sq \e*[X] . |
|
.\" SECTION |
|
.Sh Special Characters |
|
These are the preferred input symbols for producing special characters. |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Typographic: |
Typographic: |
|
|
.Pq right bracket |
.Pq right bracket |
.It \e(lB |
.It \e(lB |
.Pq left bracket |
.Pq left bracket |
.It \eq |
|
.Pq double-quote |
|
.It \e(lq |
.It \e(lq |
.Pq left double-quote |
.Pq left double-quote |
.It \e(rq |
.It \e(rq |
|
|
.It \e(if |
.It \e(if |
.Pq infinity |
.Pq infinity |
.It \e(na |
.It \e(na |
.Pq NaN , an extension |
.Pq NaN, an extension |
.It \e(+- |
.It \e(+- |
.Pq plus-minus |
.Pq plus-minus |
.It \e(** |
.It \e(** |
Line 458 Special symbols: |
|
Line 480 Special symbols: |
|
.It \ee |
.It \ee |
.Pq escape |
.Pq escape |
.El |
.El |
|
.\" SECTION |
|
.Sh PREDEFINED STRINGS |
|
These are not recommended for use, as they differ across |
|
implementations: |
|
.Pp |
|
Mathematical: |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It \e*(Ne |
|
.Pq not equal |
|
.It \e*(Ge |
|
.Pq greater-than-equal |
|
.It \e*(Le |
|
.Pq less-than-equal |
|
.It \e*(Gt |
|
.Pq greater-than |
|
.It \e*(Lt |
|
.Pq greater-than |
|
.It \e*(Pm |
|
.Pq plus-minus |
|
.It \e*(If |
|
.Pq infinity |
|
.It \e*(Pi |
|
.Pq pi |
|
.It \e*(Na |
|
.Pq NaN |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Special symbols: |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It \e*(Ba |
|
.Pq vertical bar |
|
.It \e*(Am |
|
.Pq ampersand |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Enclosures: |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It \e*q |
|
.Pq double-quote |
|
.It \e*(Rq |
|
.Pq right-double-quote |
|
.It \e*(Lq |
|
.Pq left-double-quote |
|
.It \e*(lp |
|
.Pq right-parenthesis |
|
.It \e*(rp |
|
.Pq left-parenthesis |
|
.El |
.\" SECTION |
.\" SECTION |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility of |
This section documents compatibility of |