version 1.8, 2009/07/26 19:53:40 |
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 special characters with slightly different semantics; consult the |
encode special characters with |
respective manuals for these escapes. |
.Sq \eX |
|
.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 \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 space |
.Pq space |
.It \e^ |
.It \e^ |
.Pq zero-width space |
.Pq zero-width space |
.It \e^ |
.It \e% |
.Pq zero-width space |
.Pq zero-width space |
.It \e& |
.It \e& |
.Pq zero-width space |
.Pq zero-width space |
|
.It \e| |
|
.Pq zero-width space |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
|
|
.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(Lq |
|
.Pq left double-quote, deprecated |
|
.It \e(rq |
.It \e(rq |
.Pq right double-quote |
.Pq right double-quote |
.It \e(Rq |
|
.Pq right double-quote, deprecated |
|
.It \e(oq |
.It \e(oq |
.Pq left single-quote |
.Pq left single-quote |
.It \e(aq |
.It \e(aq |
|
|
.Pq approximately equals |
.Pq approximately equals |
.It \e(=~ |
.It \e(=~ |
.Pq congruent |
.Pq congruent |
.It \e(Gt |
|
.Pq greater-than, deprecated |
|
.It \e(Lt |
|
.Pq less-than, deprecated |
|
.It \e(<= |
.It \e(<= |
.Pq less-than-equal |
.Pq less-than-equal |
.It \e(Le |
|
.Pq less-than-equal, deprecated |
|
.It \e(>= |
.It \e(>= |
.Pq greater-than-equal |
.Pq greater-than-equal |
.It \e(Ge |
|
.Pq greater-than-equal |
|
.It \e(== |
.It \e(== |
.Pq equal |
.Pq equal |
.It \e(!= |
.It \e(!= |
.Pq not equal |
.Pq not equal |
.It \e(Ne |
|
.Pq not equal, deprecated |
|
.It \e(if |
.It \e(if |
.Pq infinity |
.Pq infinity |
.It \e(If |
|
.Pq infinity, deprecated |
|
.It \e(na |
.It \e(na |
.Pq NaN , an extension |
.Pq NaN, an extension |
.It \e(Na |
|
.Pq NaN, deprecated |
|
.It \e(+- |
.It \e(+- |
.Pq plus-minus |
.Pq plus-minus |
.It \e(Pm |
|
.Pq plus-minus, deprecated |
|
.It \e(** |
.It \e(** |
.Pq asterisk |
.Pq asterisk |
.El |
.El |
Line 457 Special symbols: |
|
Line 471 Special symbols: |
|
.Pq bar |
.Pq bar |
.It \e(bb |
.It \e(bb |
.Pq broken bar |
.Pq broken bar |
.It \e(Ba |
|
.Pq bar, deprecated |
|
.It \e(co |
.It \e(co |
.Pq copyright |
.Pq copyright |
.It \e(rg |
.It \e(rg |
.Pq registered |
.Pq registered |
.It \e(tm |
.It \e(tm |
.Pq trademarked |
.Pq trademarked |
.It \e& |
|
.Pq non-breaking space |
|
.It \ee |
.It \ee |
.Pq escape |
.Pq escape |
.It \e(Am |
|
.Pq ampersand, deprecated |
|
.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 |