===================================================================
RCS file: /cvs/mandoc/eqn.7,v
retrieving revision 1.4
retrieving revision 1.11
diff -u -p -r1.4 -r1.11
--- mandoc/eqn.7	2011/07/18 13:47:38	1.4
+++ mandoc/eqn.7	2011/07/21 14:13:00	1.11
@@ -1,4 +1,4 @@
-.\"	$Id: eqn.7,v 1.4 2011/07/18 13:47:38 kristaps Exp $
+.\"	$Id: eqn.7,v 1.11 2011/07/21 14:13:00 kristaps Exp $
 .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: July 18 2011 $
+.Dd $Mdocdate: July 21 2011 $
 .Dt EQN 7
 .Os
 .Sh NAME
@@ -63,16 +63,37 @@ The equation grammar is as follows:
 .Bd -literal -offset indent
 eqn     : box | eqn box
 box     : text
+        | { eqn }
         | DEFINE text text
         | SET text text
         | UNDEF text
+        | box pos box
+        | box mark
+        | font box
 text    : TEXT
+pos     : OVER
+        | SUP
+        | SUB
+        | TO
+        | FROM
+mark	: DOT
+        | DOTDOT
+        | HAT
+        | TILDE
+        | VEC
+        | DYAD
+        | BAR
+        | UNDER
+font    : ROMAN
+        | ITALIC
+        | BOLD
 .Ed
 .Pp
 Data in TEXT form is a non-empty sequence of non-space characters or a
 non-empty quoted string.
-White-space (and enclosing literal quote pairs) is thrown away and
-productions may not be broken by newlines.
+Unless within a quoted string, white-space (and enclosing literal quote
+pairs) is thrown away.
+Quoted strings are not scanned for replacement definitions.
 .Pp
 The following control statements are available:
 .Bl -tag -width Ds
@@ -80,23 +101,50 @@ The following control statements are available:
 Replace all occurances of a key with a value.
 Its syntax is as follows:
 .Pp
-.D1 define Ar key val
+.D1 define Ar key cvalc
 .Pp
+The first character of the value string,
+.Ar c ,
+is used as the delimiter for the value
+.Ar val .
+This allows for arbitrary enclosure of terms (not just quotes), such as
+.Pp
+.D1 define Ar foo 'bar baz'
+.D1 define Ar foo cbar bazc
+.Pp
 It is an error to have an empty
 .Ar key or
-.Ar value .
+.Ar val .
 Note that a quoted
 .Ar key
 causes errors in some
 .Nm
 implementations and should not be considered portable.
+It is not expanded for replacements.
 Definitions may refer to other definitions; these are evaluated
 recursively when text replacement occurs and not when the definition is
 created.
+.Pp
+Definitions can create arbitrary strings, for example, the following is
+a legal construction.
+.Bd -literal -offset indent
+define foo 'define'
+foo bar 'baz'
+.Ed
+.Pp
 Self-referencing definitions will raise an error.
 .It Cm set
 Set an equation mode.
 Both arguments are thrown away.
+Its syntax is as follows:
+.Pp
+.D1 set Ar key val
+.Pp
+The
+.Ar key
+and
+.Ar val
+are not expanded for replacements.
 .It Cm undef
 Unset a previously-defined key.
 Its syntax is as follows:
@@ -106,7 +154,24 @@ Its syntax is as follows:
 Once invoked, the definition for
 .Ar key
 is discarded.
+The
+.Ar key
+is not expanded for replacements.
 .El
+.Sh COMPATIBILITY
+This section documents the compatibility of mandoc
+.Nm
+and the troff
+.Nm
+implementation (including GNU troff).
+.Pp
+.Bl -dash -compact
+.It
+The text string
+.Sq \e\*q
+is interpreted as a literal quote in troff.
+In mandoc, this is interpreted as a comment.
+.El
 .Sh SEE ALSO
 .Xr mandoc 1 ,
 .Xr man 7 ,
@@ -122,18 +187,28 @@ is discarded.
 .%P 151\(en157
 .%D March, 1975
 .Re
-.\" .Sh HISTORY
-.\" The tbl utility, a preprocessor for troff, was originally written by M.
-.\" E. Lesk at Bell Labs in 1975.
-.\" The GNU reimplementation of tbl, part of the groff package, was released
-.\" in 1990 by James Clark.
-.\" A standalone tbl implementation was written by Kristaps Dzonsons in
-.\" 2010.
-.\" This formed the basis of the implementation that is part of the
-.\" .Xr mandoc 1
-.\" utility.
+.Rs
+.%A Brian W. Kernighan
+.%A Lorinda L. Cherry
+.%T Typesetting Mathematics, User's Guide
+.%D 1976
+.Re
+.Rs
+.%A Brian W. Kernighan
+.%A Lorinda L. Cherry
+.%T Typesetting Mathematics, User's Guide (Second Edition)
+.%D 1978
+.Re
+.Sh HISTORY
+The eqn utility, a preprocessor for troff, was originally written by 
+Brian W. Kernighan and Lorinda L. Cherry in 1975.
+The GNU reimplementation of eqn, part of the GNU troff package, was
+released in 1989 by James Clark.
+The eqn component of
+.Xr mandoc 1
+was added in 2011.
 .Sh AUTHORS
-This partial
+This
 .Nm
 reference was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .