version 1.4, 2011/07/18 13:47:38 |
version 1.30, 2014/10/10 08:44:24 |
|
|
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm eqn |
.Nm eqn |
language is a equation-formatting language. |
language is an equation-formatting language. |
It is used within |
It is used within |
.Xr mdoc 7 |
.Xr mdoc 7 |
and |
and |
.Xr man 7 |
.Xr man 7 |
.Ux |
.Ux |
manual pages. |
manual pages. |
This manual describes the subset of the |
It describes the |
|
.Em structure |
|
of an equation, not its mathematical meaning. |
|
This manual describes the |
.Nm |
.Nm |
language accepted by the |
language accepted by the |
.Xr mandoc 1 |
.Xr mandoc 1 |
utility. |
utility, which corresponds to the Second Edition eqn specification (see |
|
.Sx SEE ALSO |
|
for references). |
.Pp |
.Pp |
Equations within |
Equations within |
.Xr mdoc 7 |
.Xr mdoc 7 |
Line 59 these are not the same as |
|
Line 64 these are not the same as |
|
macros, and may only be invoked as |
macros, and may only be invoked as |
.Sq \&.EQ . |
.Sq \&.EQ . |
.Pp |
.Pp |
The equation grammar is as follows: |
The equation grammar is as follows, where quoted strings are |
|
case-sensitive literals in the input: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
eqn : box | eqn box |
eqn : box | eqn box |
box : text |
box : text |
| DEFINE text text |
| \*q{\*q eqn \*q}\*q |
| SET text text |
| \*qdefine\*q text text |
| UNDEF text |
| \*qndefine\*q text text |
text : TEXT |
| \*qtdefine\*q text text |
|
| \*qgfont\*q text |
|
| \*qgsize\*q text |
|
| \*qundef\*q text |
|
| box pos box |
|
| box mark |
|
| \*qmatrix\*q \*q{\*q [col \*q{\*q list \*q}\*q ]* |
|
| pile \*q{\*q list \*q}\*q |
|
| font box |
|
| \*qsize\*q text box |
|
| \*qleft\*q text eqn [\*qright\*q text] |
|
col : \*qlcol\*q | \*qrcol\*q | \*qccol\*q | \*qcol\*q |
|
text : [^space\e\*q]+ | \e\*q.*\e\*q |
|
pile : \*qlpile\*q | \*qcpile\*q | \*qrpile\*q | \*qpile\*q |
|
pos : \*qover\*q | \*qsup\*q | \*qsub\*q | \*qto\*q | \*qfrom\*q |
|
mark : \*qdot\*q | \*qdotdot\*q | \*qhat\*q | \*qtilde\*q | \*qvec\*q |
|
| \*qdyad\*q | \*qbar\*q | \*qunder\*q |
|
font : \*qroman\*q | \*qitalic\*q | \*qbold\*q | \*qfat\*q |
|
list : eqn |
|
| list \*qabove\*q eqn |
|
space : [\e^~ \et] |
.Ed |
.Ed |
.Pp |
.Pp |
Data in TEXT form is a non-empty sequence of non-space characters or a |
White-space consists of the space, tab, circumflex, and tilde |
non-empty quoted string. |
characters. |
White-space (and enclosing literal quote pairs) is thrown away and |
If within a quoted string, these space characters are retained. |
productions may not be broken by newlines. |
Quoted strings are also not scanned for replacement definitions. |
.Pp |
.Pp |
|
The following text terms are translated into a rendered glyph, if |
|
available: alpha, beta, chi, delta, epsilon, eta, gamma, iota, kappa, |
|
lambda, mu, nu, omega, omicron, phi, pi, psi, rho, sigma, tau, theta, |
|
upsilon, xi, zeta, DELTA, GAMMA, LAMBDA, OMEGA, PHI, PI, PSI, SIGMA, |
|
THETA, UPSILON, XI, inter (intersection), union (union), prod (product), |
|
int (integral), sum (summation), grad (gradient), del (vector |
|
differential), times (multiply), cdot (centre-dot), nothing (zero-width |
|
space), approx (approximately equals), prime (prime), half (one-half), |
|
partial (partial differential), inf (infinity), >> (much greater), << |
|
(much less), \-> (left arrow), <\- (right arrow), += (plus-minus), != |
|
(not equal), == (equivalence), <= (less-than-equal), and >= |
|
(more-than-equal). |
|
.Pp |
The following control statements are available: |
The following control statements are available: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Cm define |
.It Cm define |
Replace all occurances of a key with a value. |
Replace all occurrences of a key with a value. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 define Ar key val |
.D1 define Ar key cvalc |
.Pp |
.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 |
It is an error to have an empty |
.Ar key or |
.Ar key |
.Ar value . |
or |
|
.Ar val . |
Note that a quoted |
Note that a quoted |
.Ar key |
.Ar key |
causes errors in some |
causes errors in some |
.Nm |
.Nm |
implementations and should not be considered portable. |
implementations and should not be considered portable. |
|
It is not expanded for replacements. |
Definitions may refer to other definitions; these are evaluated |
Definitions may refer to other definitions; these are evaluated |
recursively when text replacement occurs and not when the definition is |
recursively when text replacement occurs and not when the definition is |
created. |
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. |
Self-referencing definitions will raise an error. |
|
The |
|
.Cm ndefine |
|
statement is a synonym for |
|
.Cm define , |
|
while |
|
.Cm tdefine |
|
is discarded. |
|
.It Cm gfont |
|
Set the default font of subsequent output. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 gfont Ar font |
|
.Pp |
|
In mandoc, this value is discarded. |
|
.It Cm gsize |
|
Set the default size of subsequent output. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 gsize Ar size |
|
.Pp |
|
The |
|
.Ar size |
|
value should be an integer. |
.It Cm set |
.It Cm set |
Set an equation mode. |
Set an equation mode. |
Both arguments are thrown away. |
In mandoc, 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. |
|
This statement is a GNU extension. |
.It Cm undef |
.It Cm undef |
Unset a previously-defined key. |
Unset a previously-defined key. |
Its syntax is as follows: |
Its syntax is as follows: |
Line 106 Its syntax is as follows: |
|
Line 197 Its syntax is as follows: |
|
Once invoked, the definition for |
Once invoked, the definition for |
.Ar key |
.Ar key |
is discarded. |
is discarded. |
|
The |
|
.Ar key |
|
is not expanded for replacements. |
|
This statement is a GNU extension. |
.El |
.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. |
|
.It |
|
In troff, The circumflex and tilde white-space symbols map to |
|
fixed-width spaces. |
|
In mandoc, these characters are synonyms for the space character. |
|
.It |
|
The troff implementation of |
|
.Nm |
|
allows for equation alignment with the |
|
.Cm mark |
|
and |
|
.Cm lineup |
|
tokens. |
|
mandoc discards these tokens. |
|
The |
|
.Cm back Ar n , |
|
.Cm fwd Ar n , |
|
.Cm up Ar n , |
|
and |
|
.Cm down Ar n |
|
commands are also ignored. |
|
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr man 7 , |
.Xr man 7 , |
|
|
.%P 151\(en157 |
.%P 151\(en157 |
.%D March, 1975 |
.%D March, 1975 |
.Re |
.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 |
.Sh AUTHORS |
This partial |
This |
.Nm |
.Nm |
reference was written by |
reference was written by |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |