Memory-corruption fix.

[mandoc.git] / mdoc.3

diff --git a/mdoc.3 b/mdoc.3
index 5b5f70e860a8d12facab4d2e9b954f63d1869e81..226895b9e9e09be03aaad48b46b36b1972af8e9f 100644 (file)
--- a/mdoc.3
+++ b/mdoc.3
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.3,v 1.11 2009/02/25 17:02:47 kristaps Exp $
+.\" $Id: mdoc.3,v 1.13 2009/02/27 09:14:02 kristaps Exp $

 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"
 .\"
 .\" 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.
 .\" 
 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 .\" PERFORMANCE OF THIS SOFTWARE.
 .\" 

-.Dd $Mdocdate: February 25 2009 $
+.Dd $Mdocdate: February 27 2009 $

 .Dt mdoc 3
 .Os
 .\" SECTION
 .Dt mdoc 3
 .Os
 .\" SECTION


@@ -184,7 +184,8 @@ The
 .Xr mdoc 3
 library accepts only printable ASCII characters as defined by
 .Xr isprint 3 .
 .Xr mdoc 3
 library accepts only printable ASCII characters as defined by
 .Xr isprint 3 .

-Non-ASCII character sequences are escaped with an escape character 
+Non-ASCII character sequences are delimited in various ways.  All are
+preceeded by an escape character

 .Sq \\
 and followed by either an open-parenthesis 
 .Sq \&(
 .Sq \\
 and followed by either an open-parenthesis 
 .Sq \&(


@@ -192,7 +193,48 @@ for two-character sequences; an open-bracket
 .Sq \&[
 for n-character sequences (terminated at a close-bracket
 .Sq \&] ) ;
 .Sq \&[
 for n-character sequences (terminated at a close-bracket
 .Sq \&] ) ;

-or one of a small set of single characters for other escapes.
+an asterisk and open-parenthesis
+.Sq \&*(
+for two-character sequences;
+an asterisk and non-open-parenthesis 
+.Sq \&*
+for single-character sequences; or one of a small set of standalone
+single characters for other escapes.
+.\" PARAGRAPH
+.Pp
+Examples:
+.Pp
+.Bl -tag -width "XXXXXXXX" -offset "XXXX" -compact
+.\" LIST-ITEM
+.It \\*(<=
+prints 
+.Dq \*(<=
+.Pq greater-equal
+.\" LIST-ITEM
+.It \\(<-
+prints
+.Dq \(<-
+.Pq left-arrow
+.\" LIST-ITEM
+.It \\[<-]
+also prints
+.Dq \(<-
+.Pq left-arrow
+.\" LIST-ITEM
+.It \\*(Ba
+prints
+.Dq \*(Ba
+.Pq bar
+.\" LIST-ITEM
+.It \\*q
+prints
+.Dq \*q
+.Pq double-quote
+.El
+.\" PARAGRAPH
+.Pp
+All escaped sequences are syntax-checked, but it's up to the front-end
+system to correctly render them to the output device.

 .\" SUBSECTION
 .Ss Abstract Syntax Tree
 The 
 .\" SUBSECTION
 .Ss Abstract Syntax Tree
 The