[BACK]Return to eqn.7 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

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

version 1.2, 2011/03/17 15:12:42 version 1.21, 2011/07/23 12:08:43
Line 40  Equations within
Line 40  Equations within
 .Xr mdoc 7  .Xr mdoc 7
 or  or
 .Xr man 7  .Xr man 7
 are enclosed by the  documents are enclosed by the standalone
 .Sq EQ  .Sq \&.EQ
 and  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.
   Each equation is bracketed by
   .Sq \&.EQ
   .Sq \&.EN
   .Em Note :
   these are not the same as
   .Xr roff 7
   macros, and may only be invoked as
   .Sq \&.EQ .
 .Pp  .Pp
 For the time being,  The equation grammar is as follows, where quoted strings are
 .Xr mandoc 1  case-sensitive literals in the input:
 reproduces the contents of  .Bd -literal -offset indent
   eqn     : box | eqn box
   box     : text
           | \*q{\*q eqn \*q}\*q
           | \*qdefine\*q text text
           | \*qgfont\*q text
           | \*qgsize\*q text
           | \*qset\*q text 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
   text    : [^space\e\*q]+ | \e\*q.*\e\*q
   pile    : \*qlpile\*q | \*qcpile\*q | \*qrpile\*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
   list    : eqn
           | list \*qabove\*q eqn
   space   : [\e^~ \et]
   White-space consists of the space, tab, circumflex, and tilde
   If within a quoted string, these space characters are retained.
   Quoted strings are also not scanned for replacement definitions.
   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 >=
   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:
   .D1 define Ar key cvalc
   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
   .D1 define Ar foo 'bar baz'
   .D1 define Ar foo cbar bazc
   It is an error to have an empty
   .Ar key or
   .Ar val .
   Note that a quoted
   .Ar key
   causes errors in some
 .Nm  .Nm
 equations verbatim in its output.  implementations and should not be considered portable.
   It is not expanded for replacements.
   Definitions may refer to other definitions; these are evaluated
   recursively when text replacement occurs and not when the definition is
 .Pp  .Pp
   Definitions can create arbitrary strings, for example, the following is
   a legal construction.
   .Bd -literal -offset indent
   define foo 'define'
   foo bar 'baz'
   Self-referencing definitions will raise an error.
   .It Cm gfont
   Set the default font of subsequent output.
   Its syntax is as follows:
   .D1 gfont Ar font
   In mandoc, this value is discarded.
   .It Cm gsize
   Set the default size of subsequent output.
   Its syntax is as follows:
   .D1 gsize Ar size
 The  The
   .Ar size
   value should be an integer.
   .It Cm set
   Set an equation mode.
   In mandoc, both arguments are thrown away.
   Its syntax is as follows:
   .D1 set Ar key val
   .Ar key
   .Ar val
   are not expanded for replacements.
   .It Cm undef
   Unset a previously-defined key.
   Its syntax is as follows:
   .D1 define Ar key
   Once invoked, the definition for
   .Ar key
   is discarded.
   .Ar key
   is not expanded for replacements.
   This section documents the compatibility of mandoc
 .Nm  .Nm
 implementation in  and the troff
 .Xr mandoc 1  .Nm
 is  implementation (including GNU troff).
 .Ud  .Pp
   .Bl -dash -compact
   The text string
   .Sq \e\*q
   is interpreted as a literal quote in troff.
   In mandoc, this is interpreted as a comment.
   In troff, The circumflex and tilde white-space symbols map to
   fixed-width spaces.
   In mandoc, these characters are synonyms for the space character.
   The troff implementation of
   allows for equation alignment with the
   .Cm mark
   .Cm lineup
   mandoc discards these tokens.
   .Cm back Ar n ,
   .Cm fwd Ar n ,
   .Cm up Ar n ,
   .Cm down Ar n
   commands are also ignored.
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr man 7 ,  .Xr man 7 ,
Line 75  is
Line 235  is
 .%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
   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.
 This partial  This
 .Nm  .Nm
 reference was written by  reference was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .  .An Kristaps Dzonsons Aq kristaps@bsd.lv .

Removed from v.1.2  
changed lines
  Added in v.1.21