Character-escape addition simplified (see README.addescape, also added).

[mandoc.git] / mdocterm.1

diff --git a/mdocterm.1 b/mdocterm.1
index 0782dd42c5869d2710ae23ff2d092113b488d0f5..e104a51dd734f4554f79255e6477326524625682 100644 (file)
--- a/mdocterm.1
+++ b/mdocterm.1
@@ -1,4 +1,4 @@
-.\" $Id: mdocterm.1,v 1.7 2009/02/27 09:14:02 kristaps Exp $
+.\" $Id: mdocterm.1,v 1.10 2009/03/03 21:07:01 kristaps Exp $
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"
@@ -16,7 +16,7 @@
 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 .\" PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: February 27 2009 $
+.Dd $Mdocdate: March 3 2009 $
 .Dt mdocmterm 1
 .Os
 .\" SECTION
@@ -93,11 +93,11 @@ is
 .Ss Character Escapes
 This section documents the character-escapes accepted by
 .Xr mdocterm 1 .
-Note that the \\x, \\(xx and \\[n] forms are described here; the \\*(xx
-and \\*x forms described in
+Note that the \\x, \\(xx and \\[n] forms are described here; the \\*(xx,
+\\*[n] and \\*x forms described in
 .Xr mdoc.samples 7
-are deprecated, but still correctly rendered.  For all two-character
-sequences, \\(xx is equivalent to the n-character \\[xx].
+are deprecated, but still rendered.  All one- and two-character
+sequences may be used in the n-character sequence \\[n].
 .Pp
 Note that the
 .Em Output
@@ -106,13 +106,27 @@ column will render differently whether executed with
 or another output filter.
 .\" PARAGRAPH
 .Pp
-Enclosures:
+Grammatic:
 .Pp
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
 .It Em Output
 .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
+.It Em Output
+.Em Input (Name)
 .It \(rB
 \\(rB (right bracket)
 .It \(lB
@@ -120,9 +134,9 @@ Enclosures:
 .It \(lq
 \\(lq (left double-quote)
 .It \(rq
-\\(rq (right double-quote)
+\\(rq, \\' (right double-quote)
 .It \(oq
-\\(lq (left single-quote)
+\\(lq, \\` (left single-quote)
 .It \(aq
 \\(aq (right single-quote, apostrophe)
 .El
@@ -133,8 +147,6 @@ Indicatives:
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
 .It Em Output
 .Em Input (Name)
-.El 
-.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
 .It \(<-
 \\(<- (left arrow)
 .It \(->
@@ -151,8 +163,6 @@ Mathematical:
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
 .It Em Output
 .Em Input (Name)
-.El 
-.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
 .It \(<=
 \\(<= (less-than-equal)
 .It \(>=
@@ -167,20 +177,16 @@ Mathematical:
 \\(na (NaN)*
 .It \(+-
 \\(+- (plus-minus)
+.It \(**
+\\(** (asterisk)
 .El
 .\" PARAGRAPH
 .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:
 .Pp
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
 .It Em Output
 .Em Input (Name)
-.El 
-.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
 .It \(ga
 \\(ga (accent grave)
 .It \(aa
@@ -193,13 +199,17 @@ Special symbols:
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
 .It Em Output
 .Em Input (Name)
-.El 
-.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
 .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
 .Sh EXAMPLES
 To display this manual page:
@@ -230,3 +240,22 @@ See
 .Xr mdoc 3
 for a list of bugs, caveats, and incomplete macros regarding the
 document parse.
+.Pp
+The 
+.Nm
+utility doesn't yet know how to display the following:
+.Pp
+.Bl -bullet -compact
+.It
+Only \-bullet , \-dash , \-enum , \-hyphen , \-tag and \-ohang
+.Sq \&Bl
+lists are 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).
+.El