mandoc/eqn.7 - diff

Return to eqn.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/eqn.7 between version 1.2 and 1.5

-version 1.2, 2011/03/17 15:12:42
+version 1.5, 2011/07/21 10:24:35
 Line 40  Equations within
 Line 40  Equations within
 Line 40  Equations within
  .Xr mdoc 7
  or
  .Xr man 7
- are enclosed by the
+ documents are enclosed by the standalone
- .Sq EQ
+ .Sq \&.EQ
  and
- .Sq EN
+ .Sq \&.EN
- macro tags, whose precise syntax is documented in
+ tags.
- .Xr roff 7 .
+ Equations are multi-line blocks consisting of formulas and control
- Equations consist of multi-line equation data.
+ statements.
+ .Sh EQUATION STRUCTURE
+ Each equation is bracketed by
+ .Sq \&.EQ
+ and
+ .Sq \&.EN
+ strings.
+ .Em Note :
+ these are not the same as
+ .Xr roff 7
+ macros, and may only be invoked as
+ .Sq \&.EQ .
  .Pp
- For the time being,
+ The equation grammar is as follows:
- .Xr mandoc 1
+ .Bd -literal -offset indent
- reproduces the contents of
+ eqn     : box | eqn box
+ box     : text
+         | DEFINE text text
+         | SET text text
+         | UNDEF text
+ text    : TEXT
+ .Ed
+ .Pp
+ Data in TEXT form is a non-empty sequence of non-space characters or a
+ non-empty quoted string.
+ Unless within a quoted string, white-space (and enclosing literal quote
+ pairs) is thrown away.
+ .Pp
+ The following control statements are available:
+ .Bl -tag -width Ds
+ .It Cm define
+ Replace all occurances of a key with a value.
+ Its syntax is as follows:
+ .Pp
+ .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 val .
+ Note that a quoted
+ .Ar key
+ causes errors in some
  .Nm
- equations verbatim in its output.
+ implementations and should not be considered portable.
+ Definitions may refer to other definitions; these are evaluated
+ recursively when text replacement occurs and not when the definition is
+ created.
  .Pp
- The
+ 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.
+ .It Cm undef
+ Unset a previously-defined key.
+ Its syntax is as follows:
+ .Pp
+ .D1 define Ar key
+ .Pp
+ Once invoked, the definition for
+ .Ar key
+ is discarded.
+ .El
+ .Sh COMPATIBILITY
+ This section documents the compatibility of mandoc
  .Nm
- implementation in
+ and the troff
- .Xr mandoc 1
+ .Nm
- is
+ implementation (including GNU troff).
- .Ud
+ .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 ,
-Line 75  is
+Line 153  is
 Line 75  is
 Line 153  is
  .%P 151\(en157
  .%D March, 1975
  .Re
- .\" .Sh HISTORY
+ .Rs
- .\" The tbl utility, a preprocessor for troff, was originally written by M.
+ .%A Brian W. Kernighan
- .\" E. Lesk at Bell Labs in 1975.
+ .%A Lorinda L. Cherry
- .\" The GNU reimplementation of tbl, part of the groff package, was released
+ .%T Typesetting Mathematics, User's Guide
- .\" in 1990 by James Clark.
+ .%D 1976
- .\" A standalone tbl implementation was written by Kristaps Dzonsons in
+ .Re
- .\" 2010.
+ .Rs
- .\" This formed the basis of the implementation that is part of the
+ .%A Brian W. Kernighan
- .\" .Xr mandoc 1
+ .%A Lorinda L. Cherry
- .\" utility.
+ .%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 .

CVSweb