version 1.7, 2009/02/27 09:14:02 |
version 1.12, 2009/03/04 13:57:35 |
|
|
.Ss Character Escapes |
.Ss Character Escapes |
This section documents the character-escapes accepted by |
This section documents the character-escapes accepted by |
.Xr mdocterm 1 . |
.Xr mdocterm 1 . |
Note that the \\x, \\(xx and \\[n] forms are described here; the \\*(xx |
Note that the \\x, \\(xx and \\[n] forms are described here; the \\*(xx, |
and \\*x forms described in |
\\*[n] and \\*x forms described in |
.Xr mdoc.samples 7 |
.Xr mdoc.samples 7 |
are deprecated, but still correctly rendered. For all two-character |
are deprecated, but still rendered. All one- and two-character |
sequences, \\(xx is equivalent to the n-character \\[xx]. |
sequences may be used in the n-character sequence \\[n]. |
.Pp |
.Pp |
Note that the |
Note that the |
.Em Output |
.Em Output |
Line 106 column will render differently whether executed with |
|
Line 106 column will render differently whether executed with |
|
or another output filter. |
or another output filter. |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Enclosures: |
Grammatic: |
.Pp |
.Pp |
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.It Em Output |
.It Em Output |
.Em Input (Name) |
.Em Input (Name) |
.El |
.It \(em |
|
\\(em (em-dash) |
|
.It \(en |
|
\\(en (en-dash) |
|
.It \- |
|
\\- (hyphen) |
|
.It \\ |
|
\\ (back-slash) |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Enclosures: |
|
.Pp |
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It Em Output |
|
.Em Input (Name) |
.It \(rB |
.It \(rB |
\\(rB (right bracket) |
\\(rB (right bracket) |
.It \(lB |
.It \(lB |
|
|
.It \(lq |
.It \(lq |
\\(lq (left double-quote) |
\\(lq (left double-quote) |
.It \(rq |
.It \(rq |
\\(rq (right double-quote) |
\\(rq, \\' (right double-quote) |
.It \(oq |
.It \(oq |
\\(lq (left single-quote) |
\\(lq, \\` (left single-quote) |
.It \(aq |
.It \(aq |
\\(aq (right single-quote, apostrophe) |
\\(aq (right single-quote, apostrophe) |
.El |
.El |
|
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.It Em Output |
.It Em Output |
.Em Input (Name) |
.Em Input (Name) |
.El |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It \(<- |
.It \(<- |
\\(<- (left arrow) |
\\(<- (left arrow) |
.It \(-> |
.It \(-> |
|
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.It Em Output |
.It Em Output |
.Em Input (Name) |
.Em Input (Name) |
.El |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It \(<= |
.It \(<= |
\\(<= (less-than-equal) |
\\(<= (less-than-equal) |
.It \(>= |
.It \(>= |
|
|
\\(na (NaN)* |
\\(na (NaN)* |
.It \(+- |
.It \(+- |
\\(+- (plus-minus) |
\\(+- (plus-minus) |
|
.It \(** |
|
\\(** (asterisk) |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
*This is a deviation from the standard, as NaN is usually rendered as |
|
\\*(Na, which is a deprecated form. We introduce \\(na, which follows |
|
the more general syntax. |
|
.Pp |
|
Diacritics: |
Diacritics: |
.Pp |
.Pp |
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.It Em Output |
.It Em Output |
.Em Input (Name) |
.Em Input (Name) |
.El |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It \(ga |
.It \(ga |
\\(ga (accent grave) |
\\(ga (accent grave) |
.It \(aa |
.It \(aa |
Line 193 Special symbols: |
|
Line 199 Special symbols: |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.It Em Output |
.It Em Output |
.Em Input (Name) |
.Em Input (Name) |
.El |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It \(bu |
.It \(bu |
\\(bu (bullet) |
\\(bu (bullet) |
.It \(ba |
.It \(ba |
\\(ba (bar) |
\\(ba (bar) |
|
.It \(co |
|
\\(co (copyright) |
.El |
.El |
|
.Pp |
|
*This is a deviation from the standard, as NaN is usually rendered as |
|
\\*(Na, which is a deprecated form. We introduce \\(na, which follows |
|
the more general syntax. |
.\" SECTION |
.\" SECTION |
.Sh EXAMPLES |
.Sh EXAMPLES |
To display this manual page: |
To display this manual page: |
|
|
.Xr mdoc 3 |
.Xr mdoc 3 |
for a list of bugs, caveats, and incomplete macros regarding the |
for a list of bugs, caveats, and incomplete macros regarding the |
document parse. |
document parse. |
|
.Pp |
|
The |
|
.Nm |
|
utility doesn't yet know how to display the following: |
|
.Pp |
|
.Bl -bullet -compact |
|
.It |
|
The \-hang and \-column |
|
.Sq \&Bl |
|
lists are not yet supported. |
|
.It |
|
The \-literal and \-unfilled |
|
.Sq \&Bd |
|
displays only accept text contents. |
|
.It |
|
The |
|
.Sq \&Xo/Xc |
|
pair isn't supported (and never will be). |
|
.It |
|
The |
|
.Sq \&Sm |
|
macro has no effect, yet. |
|
.El |