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

Diff for /mandoc/eqn.7 between version 1.3 and 1.15

version 1.3, 2011/07/17 14:08:49 version 1.15, 2011/07/22 13:48:52
Line 59  these are not the same as
Line 59  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          | "{" eqn "}"
         | SET text text          | "define" text text
         | UNDEF text          | "set" text text
           | "undef" text
           | box pos box
           | box mark
           | pile "{" list "}"
           | font box
           | "size" text box
           | "left" text eqn ["right" text]
 text    : TEXT  text    : TEXT
   pile    : "lpile" | "cpile" | "rpile"
   pos     : "over" | "sup" | "sub" | "to" | "from"
   mark    : "dot" | "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  Data in TEXT form is a non-empty sequence of non-space characters or a
 non-empty quoted string.  non-empty quoted string.
 White-space (and enclosing literal quote pairs) is thrown away and  Unless within a quoted string, white-space (and enclosing literal quote
 productions may not be broken by newlines.  pairs) is thrown away.
   Quoted strings are not scanned for replacement definitions.
   The following text tokens are translated into an acceptable front-end
   format, 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, and XI.
 .Pp  .Pp
 The following control statements are available:  The following control statements are available:
 .Bl -tag -width Ds  .Bl -tag -width Ds
Line 80  The following control statements are available:
Line 101  The following control statements are available:
 Replace all occurances of a key with a value.  Replace all occurances 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 or
 .Ar value .  .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
   recursively when text replacement occurs and not when the definition is
   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.
 .It Cm set  .It Cm set
 Set an equation mode.  Set an equation mode.
 Both arguments are thrown away.  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.
 .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 102  Its syntax is as follows:
Line 154  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.
 .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.
   .El
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr man 7 ,  .Xr man 7 ,
Line 118  is discarded.
Line 187  is discarded.
 .%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 kristaps@bsd.lv .

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.15

CVSweb