version 1.21, 2009/03/15 07:08:52 |
version 1.24, 2009/03/16 23:37:28 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the |
.\" purpose with or without fee is hereby granted, provided that the |
Line 60 Override default compiler behaviour. See |
|
Line 60 Override default compiler behaviour. See |
|
for details. |
for details. |
.\" ITEM |
.\" ITEM |
.It Fl O Ns Ar option... |
.It Fl O Ns Ar option... |
Terminal-encoding options. See |
Front-end options. See |
.Sx Front-end Options |
.Sx Front-end Options |
for details. |
for details. |
.\" ITEM |
.\" ITEM |
|
|
if |
if |
.Ar infile |
.Ar infile |
may not be parsed. |
may not be parsed. |
.It Fl O Ns Ar ansi |
|
Use ANSI/VT100 output encoding instead of backspaces. |
|
.El |
.El |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss Compiler Options |
.Ss Compiler Options |
Line 169 options may be grouped and delimited with a comma. Us |
|
Line 167 options may be grouped and delimited with a comma. Us |
|
for example, will try to ignore scope and character-escape errors. |
for example, will try to ignore scope and character-escape errors. |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss Character Escapes |
.Ss Character Escapes |
The following table shows all |
The |
|
.Nm |
|
utility correctly renders all |
|
.Sx Special Characters |
|
in |
.Xr mdoc 7 |
.Xr mdoc 7 |
character escapes rendered by |
in 7-bit ASCII. |
.Nm . |
|
Note that the |
|
.Em Output |
|
column will render differently whether executed with |
|
.Xr mdocterm 1 |
|
or another output filter. |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Grammatic: |
In the general sense, |
.Pp |
.Nm |
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
will make a |
.It Em Output |
.Pq best-effort |
.Em Input (Name) |
to render complex characters; however, if a manual is using considerable |
.It \(em |
special characters, some meaning may be lost in translation. |
\\(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 |
|
.It Em Output |
|
.Em Input (Name) |
|
.It \(rC |
|
\\(rC (right brace) |
|
.It \(lC |
|
\\(lC (left brace) |
|
.It \(ra |
|
\\(ra (right angle) |
|
.It \(la |
|
\\(la (left angle) |
|
.It \(rB |
|
\\(rB (right bracket) |
|
.It \(lB |
|
\\(lB (left bracket) |
|
.It \q |
|
\\q (double-quote) |
|
.It \(lq |
|
\\(lq (left double-quote) |
|
.It \(rq |
|
\\(rq (right double-quote) |
|
.It \(oq |
|
\\(oq, \\` (left single-quote) |
|
.It \(aq |
|
\\(aq, \\' (right single-quote, apostrophe) |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Indicatives: |
|
.Pp |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It Em Output |
|
.Em Input (Name) |
|
.It \(<- |
|
\\(<- (left arrow) |
|
.It \(-> |
|
\\(-> (right arrow) |
|
.It \(ua |
|
\\(ua (up arrow) |
|
.It \(da |
|
\\(da (down arrow) |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Mathematical: |
|
.Pp |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It Em Output |
|
.Em Input (Name) |
|
.It \(<= |
|
\\(<= (less-than-equal) |
|
.It \(>= |
|
\\(>= (greater-than-equal) |
|
.It \(== |
|
\\(== (equal) |
|
.It \(!= |
|
\\(!= (not equal) |
|
.It \(if |
|
\\(if (infinity) |
|
.It \(na |
|
\\(na (NaN)* |
|
.It \(+- |
|
\\(+- (plus-minus) |
|
.It \(** |
|
\\(** (asterisk) |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Diacritics: |
|
.Pp |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It Em Output |
|
.Em Input (Name) |
|
.It \(ga |
|
\\(ga (accent grave) |
|
.It \(aa |
|
\\(aa (accent accute) |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Special symbols: |
|
.Pp |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It Em Output |
|
.Em Input (Name) |
|
.It \(bu |
|
\\(bu (bullet) |
|
.It \(ba |
|
\\(ba (bar) |
|
.It \(co |
|
\\(co (copyright) |
|
.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 on ANSI-capable terminal: |
To display this manual page: |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
.D1 % mdocterm \-Wall,error mdocterm.1 |
.D1 % mdocterm \-Wall,error mdocterm.1 |
Line 316 To pipe a manual page to the pager: |
|
Line 203 To pipe a manual page to the pager: |
|
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@openbsd.org . |
.\" SECTION |
.\" SECTION |
.Sh CAVEATS |
.Sh CAVEATS |
See |
See |