1 .\" $Id: eqn.7,v 1.36 2017/07/20 11:07:27 schwarze Exp $
2 .\"
3 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 .\" Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
5 .\"
6 .\" Permission to use, copy, modify, and distribute this software for any
7 .\" purpose with or without fee is hereby granted, provided that the above
8 .\" copyright notice and this permission notice appear in all copies.
9 .\"
10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 .\"
18 .Dd $Mdocdate: July 20 2017 $
19 .Dt EQN 5
20 .Os
21 .Sh NAME
22 .Nm eqn
23 .Nd eqn language reference for mandoc
24 .Sh DESCRIPTION
25 The
26 .Nm eqn
27 language is an equation-formatting language.
28 It is used within
29 .Xr mdoc 5
30 and
31 .Xr man 5
32 .Ux
33 manual pages.
34 It describes the
35 .Em structure
36 of an equation, not its mathematical meaning.
37 This manual describes the
38 .Nm
66 .Xr mandoc_roff 5
67 macros, and may only be invoked as
68 .Sq \&.EQ .
69 .Pp
70 The equation grammar is as follows, where quoted strings are
71 case-sensitive literals in the input:
72 .Bd -literal -offset indent
73 eqn : box | eqn box
74 box : text
75 | \(dq{\(dq eqn \(dq}\(dq
76 | \(dqdefine\(dq text text
77 | \(dqndefine\(dq text text
78 | \(dqtdefine\(dq text text
79 | \(dqgfont\(dq text
80 | \(dqgsize\(dq text
81 | \(dqset\(dq text text
82 | \(dqundef\(dq text
83 | \(dqsqrt\(dq box
84 | box pos box
85 | box mark
86 | \(dqmatrix\(dq \(dq{\(dq [col \(dq{\(dq list \(dq}\(dq ]*
87 | pile \(dq{\(dq list \(dq}\(dq
88 | font box
89 | \(dqsize\(dq text box
90 | \(dqleft\(dq text eqn [\(dqright\(dq text]
91 col : \(dqlcol\(dq | \(dqrcol\(dq | \(dqccol\(dq | \(dqcol\(dq
92 text : [^space\e\(dq]+ | \e\(dq.*\e\(dq
93 pile : \(dqlpile\(dq | \(dqcpile\(dq | \(dqrpile\(dq | \(dqpile\(dq
94 pos : \(dqover\(dq | \(dqsup\(dq | \(dqsub\(dq | \(dqto\(dq | \(dqfrom\(dq
95 mark : \(dqdot\(dq | \(dqdotdot\(dq | \(dqhat\(dq | \(dqtilde\(dq | \(dqvec\(dq
96 | \(dqdyad\(dq | \(dqbar\(dq | \(dqunder\(dq
97 font : \(dqroman\(dq | \(dqitalic\(dq | \(dqbold\(dq | \(dqfat\(dq
98 list : eqn
99 | list \(dqabove\(dq eqn
100 space : [\e^~ \et]
101 .Ed
102 .Pp
103 White-space consists of the space, tab, circumflex, and tilde
104 characters.
105 It is required to delimit tokens consisting of alphabetic characters
106 and it is ignored at other places.
|
1 .\" $Id: eqn.7,v 1.37 2017/09/04 10:35:27 schwarze Exp $
2 .\"
3 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 .\" Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
5 .\"
6 .\" Permission to use, copy, modify, and distribute this software for any
7 .\" purpose with or without fee is hereby granted, provided that the above
8 .\" copyright notice and this permission notice appear in all copies.
9 .\"
10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 .\"
18 .Dd $Mdocdate: September 4 2017 $
19 .Dt EQN 5
20 .Os
21 .Sh NAME
22 .Nm eqn
23 .Nd eqn language reference for mandoc
24 .Sh DESCRIPTION
25 The
26 .Nm eqn
27 language is an equation-formatting language.
28 It is used within
29 .Xr mdoc 5
30 and
31 .Xr man 5
32 .Ux
33 manual pages.
34 It describes the
35 .Em structure
36 of an equation, not its mathematical meaning.
37 This manual describes the
38 .Nm
66 .Xr mandoc_roff 5
67 macros, and may only be invoked as
68 .Sq \&.EQ .
69 .Pp
70 The equation grammar is as follows, where quoted strings are
71 case-sensitive literals in the input:
72 .Bd -literal -offset indent
73 eqn : box | eqn box
74 box : text
75 | \(dq{\(dq eqn \(dq}\(dq
76 | \(dqdefine\(dq text text
77 | \(dqndefine\(dq text text
78 | \(dqtdefine\(dq text text
79 | \(dqgfont\(dq text
80 | \(dqgsize\(dq text
81 | \(dqset\(dq text text
82 | \(dqundef\(dq text
83 | \(dqsqrt\(dq box
84 | box pos box
85 | box mark
86 | \(dqmatrix\(dq \(dq{\(dq [col \(dq{\(dq list \(dq}\(dq]* \(dq}\(dq
87 | pile \(dq{\(dq list \(dq}\(dq
88 | font box
89 | \(dqsize\(dq text box
90 | \(dqleft\(dq text eqn [\(dqright\(dq text]
91 col : \(dqlcol\(dq | \(dqrcol\(dq | \(dqccol\(dq | \(dqcol\(dq
92 text : [^space\e\(dq]+ | \e\(dq.*\e\(dq
93 pile : \(dqlpile\(dq | \(dqcpile\(dq | \(dqrpile\(dq | \(dqpile\(dq
94 pos : \(dqover\(dq | \(dqsup\(dq | \(dqsub\(dq | \(dqto\(dq | \(dqfrom\(dq
95 mark : \(dqdot\(dq | \(dqdotdot\(dq | \(dqhat\(dq | \(dqtilde\(dq | \(dqvec\(dq
96 | \(dqdyad\(dq | \(dqbar\(dq | \(dqunder\(dq
97 font : \(dqroman\(dq | \(dqitalic\(dq | \(dqbold\(dq | \(dqfat\(dq
98 list : eqn
99 | list \(dqabove\(dq eqn
100 space : [\e^~ \et]
101 .Ed
102 .Pp
103 White-space consists of the space, tab, circumflex, and tilde
104 characters.
105 It is required to delimit tokens consisting of alphabetic characters
106 and it is ignored at other places.
|