version 1.21, 2011/07/23 12:08:43 |
version 1.29, 2013/07/13 19:41:16 |
|
|
.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 66 eqn : box | eqn box |
|
Line 71 eqn : box | eqn box |
|
box : text |
box : text |
| \*q{\*q eqn \*q}\*q |
| \*q{\*q eqn \*q}\*q |
| \*qdefine\*q text text |
| \*qdefine\*q text text |
|
| \*qndefine\*q text text |
|
| \*qtdefine\*q text text |
| \*qgfont\*q text |
| \*qgfont\*q text |
| \*qgsize\*q text |
| \*qgsize\*q text |
| \*qset\*q text text |
| \*qset\*q text text |
|
|
| font box |
| font box |
| \*qsize\*q text box |
| \*qsize\*q text box |
| \*qleft\*q text eqn [\*qright\*q text] |
| \*qleft\*q text eqn [\*qright\*q text] |
col : \*qlcol\*q | \*qrcol\*q | \*qccol\*q |
col : \*qlcol\*q | \*qrcol\*q | \*qccol\*q | \*qcol\*q |
text : [^space\e\*q]+ | \e\*q.*\e\*q |
text : [^space\e\*q]+ | \e\*q.*\e\*q |
pile : \*qlpile\*q | \*qcpile\*q | \*qrpile\*q |
pile : \*qlpile\*q | \*qcpile\*q | \*qrpile\*q | \*qpile\*q |
pos : \*qover\*q | \*qsup\*q | \*qsub\*q | \*qto\*q | \*qfrom\*q |
pos : \*qover\*q | \*qsup\*q | \*qsub\*q | \*qto\*q | \*qfrom\*q |
mark : \*qdot\*q | \*qdotdot\*q | \*qhat\*q | \*qtilde\*q | \*qvec\*q |
mark : \*qdot\*q | \*qdotdot\*q | \*qhat\*q | \*qtilde\*q | \*qvec\*q |
| \*qdyad\*q | \*qbar\*q | \*qunder\*q |
| \*qdyad\*q | \*qbar\*q | \*qunder\*q |
font : \*qroman\*q | \*qitalic\*q | \*qbold\*q |
font : \*qroman\*q | \*qitalic\*q | \*qbold\*q | \*qfat\*q |
list : eqn |
list : eqn |
| list \*qabove\*q eqn |
| list \*qabove\*q eqn |
space : [\e^~ \et] |
space : [\e^~ \et] |
Line 110 partial (partial differential), inf (infinity), >> (mu |
|
Line 117 partial (partial differential), inf (infinity), >> (mu |
|
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 define Ar key cvalc |
Line 125 This allows for arbitrary enclosure of terms (not just |
|
Line 132 This allows for arbitrary enclosure of terms (not just |
|
.D1 define Ar foo cbar bazc |
.D1 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 |
.It Cm gfont |
Set the default font of subsequent output. |
Set the default font of subsequent output. |
Its syntax is as follows: |
Its syntax is as follows: |
|
|
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: |
|
|
The |
The |
.Ar key |
.Ar key |
is not expanded for replacements. |
is not expanded for replacements. |
|
This statement is a GNU extension. |
.El |
.El |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents the compatibility of mandoc |
This section documents the compatibility of mandoc |
Line 259 was added in 2011. |
|
Line 276 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 . |