Strings abstracted into dynamically-created C files.

[mandoc.git] / mdocterm.1

diff --git a/mdocterm.1 b/mdocterm.1
index f350c33670f35d07553f5f1e36ae961347014a0b..92fdedda35535b1eaa1b5a0e6c3235aa75e62c2a 100644 (file)
--- a/mdocterm.1
+++ b/mdocterm.1
@@ -1,4 +1,4 @@
-.\" $Id: mdocterm.1,v 1.8 2009/02/27 10:55:16 kristaps Exp $
+.\" $Id: mdocterm.1,v 1.14 2009/03/06 14:13:47 kristaps Exp $

 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"


@@ -16,8 +16,8 @@
 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 .\" PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 .\" PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: February 27 2009 $
-.Dt mdocmterm 1
+.Dd $Mdocdate: March 6 2009 $
+.Dt mdocterm 1

 .Os
 .\" SECTION
 .Sh NAME
 .Os
 .\" SECTION
 .Sh NAME


@@ -93,11 +93,11 @@ is
 .Ss Character Escapes
 This section documents the character-escapes accepted by
 .Xr mdocterm 1 .
 .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
 .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
 .Pp
 Note that the
 .Em Output


@@ -106,23 +106,43 @@ column will render differently whether executed with
 or another output filter.
 .\" PARAGRAPH
 .Pp
 or another output filter.
 .\" PARAGRAPH
 .Pp

+Grammatic:
+.Pp
+.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
+.It Em Output
+.Em Input (Name)
+.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)
 Enclosures:
 .Pp
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
 .It Em Output
 .Em Input (Name)

+.It \(ra
+\\(ra (right angle)
+.It \(la
+\\(la (left angle)

 .It \(rB
 \\(rB (right bracket)
 .It \(lB
 .It \(rB
 \\(rB (right bracket)
 .It \(lB

-\\(rB (left bracket)
+\\(lB (left bracket)

 .It \(lq
 \\(lq (left double-quote)
 .It \(rq
 \\(rq (right double-quote)
 .It \(oq
 .It \(lq
 \\(lq (left double-quote)
 .It \(rq
 \\(rq (right double-quote)
 .It \(oq

-\\(lq (left single-quote)
+\\(oq, \\` (left single-quote)

 .It \(aq
 .It \(aq

-\\(aq (right single-quote, apostrophe)
+\\(aq, \\' (right single-quote, apostrophe)

 .El
 .\" PARAGRAPH
 .Pp
 .El
 .\" PARAGRAPH
 .Pp


@@ -152,7 +172,7 @@ Mathematical:
 .It \(>=
 \\(>= (greater-than-equal)
 .It \(==
 .It \(>=
 \\(>= (greater-than-equal)
 .It \(==

-\\(== (greater-than-equal)
+\\(== (equal)

 .It \(!=
 \\(!= (not equal)
 .It \(if
 .It \(!=
 \\(!= (not equal)
 .It \(if


@@ -161,13 +181,11 @@ Mathematical:
 \\(na (NaN)*
 .It \(+-
 \\(+- (plus-minus)
 \\(na (NaN)*
 .It \(+-
 \\(+- (plus-minus)

+.It \(**
+\\(** (asterisk)

 .El
 .\" PARAGRAPH
 .Pp
 .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
 Diacritics:
 .Pp
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact


@@ -189,7 +207,13 @@ Special symbols:
 \\(bu (bullet)
 .It \(ba
 \\(ba (bar)
 \\(bu (bullet)
 .It \(ba
 \\(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
 .Sh EXAMPLES
 To display this manual page:
 .\" SECTION
 .Sh EXAMPLES
 To display this manual page:


@@ -200,7 +224,7 @@ To display this manual page:
 .Pp
 To pipe a manual page to the pager:
 .Pp
 .Pp
 To pipe a manual page to the pager:
 .Pp

-.D1 % mdocterm mdocterm.1 | less -R
+.D1 % mdocterm mdocterm.1 | less \-R

 .\" SECTION
 .Sh SEE ALSO
 .Xr mdoctree 1 ,
 .\" SECTION
 .Sh SEE ALSO
 .Xr mdoctree 1 ,


@@ -220,3 +244,26 @@ See
 .Xr mdoc 3
 for a list of bugs, caveats, and incomplete macros regarding the
 document parse.
 .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
+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