contrib/mdocml/eqn.7

   1 .\"     $Id: eqn.7,v 1.2 2011/03/17 15:12:42 kristaps Exp $
   2 .\"
   3 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd $Mdocdate: March 17 2011 $
  18 .Dt EQN 7
  19 .Os
  20 .Sh NAME
  21 .Nm eqn
  22 .Nd eqn language reference for mandoc
  23 .Sh DESCRIPTION
  24 The
  25 .Nm eqn
  26 language is a equation-formatting language.
  27 It is used within
  28 .Xr mdoc 7
  29 and
  30 .Xr man 7
  31 .Ux
  32 manual pages.
  33 This manual describes the subset of the
  34 .Nm
  35 language accepted by the
  36 .Xr mandoc 1
  37 utility.
  38 .Pp
  39 Equations within
  40 .Xr mdoc 7
  41 or
  42 .Xr man 7
  43 are enclosed by the
  44 .Sq EQ
  45 and
  46 .Sq EN
  47 macro tags, whose precise syntax is documented in
  48 .Xr roff 7 .
  49 Equations consist of multi-line equation data.
  50 .Pp
  51 For the time being,
  52 .Xr mandoc 1
  53 reproduces the contents of
  54 .Nm
  55 equations verbatim in its output.
  56 .Pp
  57 The
  58 .Nm
  59 implementation in
  60 .Xr mandoc 1
  61 is
  62 .Ud
  63 .Sh SEE ALSO
  64 .Xr mandoc 1 ,
  65 .Xr man 7 ,
  66 .Xr mandoc_char 7 ,
  67 .Xr mdoc 7 ,
  68 .Xr roff 7
  69 .Rs
  70 .%A Brian W. Kernighan
  71 .%A Lorinda L. Cherry
  72 .%T System for Typesetting Mathematics
  73 .%J Communications of the ACM
  74 .%V 18
  75 .%P 151\(en157
  76 .%D March, 1975
  77 .Re
  78 .\" .Sh HISTORY
  79 .\" The tbl utility, a preprocessor for troff, was originally written by M.
  80 .\" E. Lesk at Bell Labs in 1975.
  81 .\" The GNU reimplementation of tbl, part of the groff package, was released
  82 .\" in 1990 by James Clark.
  83 .\" A standalone tbl implementation was written by Kristaps Dzonsons in
  84 .\" 2010.
  85 .\" This formed the basis of the implementation that is part of the
  86 .\" .Xr mandoc 1
  87 .\" utility.
  88 .Sh AUTHORS
  89 This partial
  90 .Nm
  91 reference was written by
  92 .An Kristaps Dzonsons Aq kristaps@bsd.lv .