version 1.14, 2011/07/22 12:55:02 |
version 1.32, 2015/01/20 19:39:34 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
|
.\" Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.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 |
|
.Nm |
|
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 67 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 |
| { eqn } |
| \*q{\*q eqn \*q}\*q |
| DEFINE text text |
| \*qdefine\*q text text |
| SET text text |
| \*qndefine\*q text text |
| UNDEF text |
| \*qtdefine\*q text text |
|
| \*qgfont\*q text |
|
| \*qgsize\*q text |
|
| \*qset\*q text text |
|
| \*qundef\*q text |
|
| \*qsqrt\*q box |
| box pos box |
| box pos box |
| box mark |
| box mark |
| pile { list } |
| \*qmatrix\*q \*q{\*q [col \*q{\*q list \*q}\*q ]* |
|
| pile \*q{\*q list \*q}\*q |
| font box |
| font box |
| SIZE text box |
| \*qsize\*q text box |
| LEFT text eqn [RIGHT text] |
| \*qleft\*q text eqn [\*qright\*q text] |
text : TEXT |
col : \*qlcol\*q | \*qrcol\*q | \*qccol\*q | \*qcol\*q |
pile : LPILE |
text : [^space\e\*q]+ | \e\*q.*\e\*q |
| CPILE |
pile : \*qlpile\*q | \*qcpile\*q | \*qrpile\*q | \*qpile\*q |
| RPILE |
pos : \*qover\*q | \*qsup\*q | \*qsub\*q | \*qto\*q | \*qfrom\*q |
pos : OVER |
mark : \*qdot\*q | \*qdotdot\*q | \*qhat\*q | \*qtilde\*q | \*qvec\*q |
| SUP |
| \*qdyad\*q | \*qbar\*q | \*qunder\*q |
| SUB |
font : \*qroman\*q | \*qitalic\*q | \*qbold\*q | \*qfat\*q |
| TO |
list : eqn |
| FROM |
| list \*qabove\*q eqn |
mark : DOT |
space : [\e^~ \et] |
| DOTDOT |
|
| HAT |
|
| TILDE |
|
| VEC |
|
| DYAD |
|
| BAR |
|
| UNDER |
|
font : ROMAN |
|
| ITALIC |
|
| BOLD |
|
list : eqn | list ABOVE eqn |
|
.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. |
Unless within a quoted string, white-space (and enclosing literal quote |
It is required to delimit tokens consisting of alphabetic characters |
pairs) is thrown away. |
and it is ignored at other places. |
Quoted strings are not scanned for replacement definitions. |
Braces and quotes also delimit tokens. |
|
If within a quoted string, these space characters are retained. |
|
Quoted strings are also not scanned for keywords, glyph names, |
|
and expansion of definitions. |
|
To print a literal quote character, it can be prepended with a |
|
backslash or expressed with the \e(dq escape sequence. |
.Pp |
.Pp |
|
Subequations can be enclosed in braces to pass them as arguments |
|
to operation keywords, overriding standard operation precedence. |
|
Braces can be nested. |
|
To set a brace verbatim, it needs to be enclosed in quotes. |
|
.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 (center-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). |
|
The character escape sequences documented in |
|
.Xr mandoc_char 7 |
|
can be used, too. |
|
.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 cvalc |
.D1 Cm define Ar key cvalc |
.Pp |
.Pp |
The first character of the value string, |
The first character of the value string, |
.Ar c , |
.Ar c , |
Line 116 is used as the delimiter for the value |
|
Line 146 is used as the delimiter for the value |
|
.Ar val . |
.Ar val . |
This allows for arbitrary enclosure of terms (not just quotes), such as |
This allows for arbitrary enclosure of terms (not just quotes), such as |
.Pp |
.Pp |
.D1 define Ar foo 'bar baz' |
.D1 Cm define Ar foo 'bar baz' |
.D1 define Ar foo cbar bazc |
.D1 Cm define Ar foo cbar bazc |
.Pp |
.Pp |
It is an error to have an empty |
It is an error to have an empty |
.Ar key or |
.Ar key |
|
or |
.Ar val . |
.Ar val . |
Note that a quoted |
Note that a quoted |
.Ar key |
.Ar key |
|
|
.Ed |
.Ed |
.Pp |
.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 Cm 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 Cm gsize Oo +|\- Oc Ns Ar size |
|
.Pp |
|
The |
|
.Ar size |
|
value should be an integer. |
|
If prepended by a sign, |
|
the font size is changed relative to the current size. |
.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: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 set Ar key val |
.D1 Cm set Ar key val |
.Pp |
.Pp |
The |
The |
.Ar key |
.Ar key |
and |
and |
.Ar val |
.Ar val |
are not expanded for replacements. |
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: |
.Pp |
.Pp |
.D1 define Ar key |
.D1 Cm define Ar key |
.Pp |
.Pp |
Once invoked, the definition for |
Once invoked, the definition for |
.Ar key |
.Ar key |
|
|
The |
The |
.Ar key |
.Ar key |
is not expanded for replacements. |
is not expanded for replacements. |
|
This statement is a GNU extension. |
.El |
.El |
|
.Pp |
|
Operation keywords have the following semantics: |
|
.Bl -tag -width Ds |
|
.It Cm above |
|
See |
|
.Cm pile . |
|
.It Cm bar |
|
Draw a line over the preceding box. |
|
.It Cm bold |
|
Set the following box using bold font. |
|
.It Cm ccol |
|
Like |
|
.Cm cpile , |
|
but for use in |
|
.Cm matrix . |
|
.It Cm cpile |
|
Like |
|
.Cm pile , |
|
but with slightly increased vertical spacing. |
|
.It Cm dot |
|
Set a single dot over the preceding box. |
|
.It Cm dotdot |
|
Set two dots (dieresis) over the preceding box. |
|
.It Cm dyad |
|
Set a dyad symbol (left-right arrow) over the preceding box. |
|
.It Cm fat |
|
A synonym for |
|
.Cm bold . |
|
.It Cm font |
|
Set the second argument using the font specified by the first argument; |
|
currently not recognized by the |
|
.Xr mandoc 1 |
|
.Nm |
|
parser. |
|
.It Cm from |
|
Set the following box below the preceding box, |
|
using a slightly smaller font. |
|
Used for sums, integrals, limits, and the like. |
|
.It Cm hat |
|
Set a hat (circumflex) over the preceding box. |
|
.It Cm italic |
|
Set the following box using italic font. |
|
.It Cm lcol |
|
Like |
|
.Cm lpile , |
|
but for use in |
|
.Cm matrix . |
|
.It Cm left |
|
Set the first argument as a big left delimiter before the second argument. |
|
As an optional third argument, |
|
.Cm right |
|
can follow. |
|
In that case, the fourth argument is set as a big right delimiter after |
|
the second argument. |
|
.It Cm lpile |
|
Like |
|
.Cm cpile , |
|
but subequations are left-justified. |
|
.It Cm matrix |
|
Followed by a list of columns enclosed in braces. |
|
All columns need to have the same number of subequations. |
|
The columns are set as a matrix. |
|
The difference compared to multiple subsequent |
|
.Cm pile |
|
operators is that in a |
|
.Cm matrix , |
|
corresponding subequations in all columns line up horizontally, |
|
while each |
|
.Cm pile |
|
does vertical spacing independently. |
|
.It Cm over |
|
Set a fraction. |
|
The preceding box is the numerator, the following box is the denominator. |
|
.It Cm pile |
|
Followed by a list of subequations enclosed in braces, |
|
the subequations being separated by |
|
.Cm above |
|
keywords. |
|
Sets the subequations one above the other, each of them centered. |
|
Typically used to represent vectors in coordinate representation. |
|
.It Cm rcol |
|
Like |
|
.Cm rpile , |
|
but for use in |
|
.Cm matrix . |
|
.It Cm right |
|
See |
|
.Cm left ; |
|
.Cm right |
|
cannot be used without |
|
.Cm left . |
|
To set a big right delimiter without a big left delimiter, the following |
|
construction can be used: |
|
.Pp |
|
.D1 Cm left No \(dq\(dq Ar box Cm right Ar delimiter |
|
.It Cm roman |
|
Set the following box using the default font. |
|
.It Cm rpile |
|
Like |
|
.Cm cpile , |
|
but subequations are right-justified. |
|
.It Cm size |
|
Set the second argument with the font size specified by the first |
|
argument; currently ignored by |
|
.Xr mandoc 1 . |
|
By prepending a plus or minus sign to the first argument, |
|
the font size can be selected relative to the current size. |
|
.It Cm sqrt |
|
Set the square root of the following box. |
|
.It Cm sub |
|
Set the following box as a subscript to the preceding box. |
|
.It Cm sup |
|
Set the following box as a superscript to the preceding box. |
|
As a special case, if a |
|
.Cm sup |
|
clause immediately follows a |
|
.Cm sub |
|
clause as in |
|
.Pp |
|
.D1 Ar mainbox Cm sub Ar subbox Cm sup Ar supbox |
|
.Pp |
|
both are set with respect to the same |
|
.Ar mainbox , |
|
that is, |
|
.Ar supbox |
|
is set above |
|
.Ar subbox . |
|
.It Cm tilde |
|
Set a tilde over the preceding box. |
|
.It Cm to |
|
Set the following box above the preceding box, |
|
using a slightly smaller font. |
|
Used for sums and integrals and the like. |
|
As a special case, if a |
|
.Cm to |
|
clause immediately follows a |
|
.Cm from |
|
clause as in |
|
.Pp |
|
.D1 Ar mainbox Cm from Ar frombox Cm to Ar tobox |
|
.Pp |
|
both are set below and above the same |
|
.Ar mainbox . |
|
.It Cm under |
|
Underline the preceding box. |
|
.It Cm vec |
|
Set a vector symbol (right arrow) over the preceding box. |
|
.El |
|
.Pp |
|
The binary operations |
|
.Cm from , |
|
.Cm to , |
|
.Cm sub , |
|
and |
|
.Cm sup |
|
group to the right, that is, |
|
.Pp |
|
.D1 Ar mainbox Cm sup Ar supbox Cm sub Ar subbox |
|
.Pp |
|
is the same as |
|
.Pp |
|
.D1 Ar mainbox Cm sup Brq Ar supbox Cm sub Ar subbox |
|
.Pp |
|
and different from |
|
.Pp |
|
.D1 Bro Ar mainbox Cm sup Ar supbox Brc Cm sub Ar subbox . |
|
.Pp |
|
By contrast, |
|
.Cm over |
|
groups to the left. |
|
.Pp |
|
In the following list, earlier operations bind more tightly than |
|
later operations: |
|
.Pp |
|
.Bl -enum -compact |
|
.It |
|
.Cm dyad , |
|
.Cm vec , |
|
.Cm under , |
|
.Cm bar , |
|
.Cm tilde , |
|
.Cm hat , |
|
.Cm dot , |
|
.Cm dotdot |
|
.It |
|
.Cm fat , |
|
.Cm roman , |
|
.Cm italic , |
|
.Cm bold , |
|
.Cm size |
|
.It |
|
.Cm sub , |
|
.Cm sup |
|
.It |
|
.Cm sqrt |
|
.It |
|
.Cm over |
|
.It |
|
.Cm from , |
|
.Cm to |
|
.El |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents the compatibility of mandoc |
This section documents the compatibility of mandoc |
.Nm |
.Nm |
|
|
.Sq \e\*q |
.Sq \e\*q |
is interpreted as a literal quote in troff. |
is interpreted as a literal quote in troff. |
In mandoc, this is interpreted as a comment. |
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. |
|
.It |
|
Inline equations and the |
|
.Cm delim |
|
control statement are not yet implemented in |
|
.Xr mandoc 1 . |
.El |
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
Line 207 In mandoc, this is interpreted as a comment. |
|
Line 491 In mandoc, this is interpreted as a comment. |
|
.%D 1978 |
.%D 1978 |
.Re |
.Re |
.Sh HISTORY |
.Sh HISTORY |
The eqn utility, a preprocessor for troff, was originally written by |
The eqn utility, a preprocessor for troff, was originally written by |
Brian W. Kernighan and Lorinda L. Cherry in 1975. |
Brian W. Kernighan and Lorinda L. Cherry in 1975. |
The GNU reimplementation of eqn, part of the GNU troff package, was |
The GNU reimplementation of eqn, part of the GNU troff package, was |
released in 1989 by James Clark. |
released in 1989 by James Clark. |
Line 218 was added in 2011. |
|
Line 502 was added in 2011. |
|
This |
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 . |