From e3b328e1e14266253839d3605472b1478fff543a Mon Sep 17 00:00:00 2001
From: Werner LEMBERG <wl@gnu.org>
Date: Sun, 20 Feb 2005 10:38:37 +0000
Subject: [PATCH] * src/preproc/eqn/eqn.man, NEWS: Document various extensions
 of eqn.

---
 ChangeLog               |  5 +++
 NEWS                    | 28 ++++++++++++++++
 src/preproc/eqn/eqn.man | 85 +++++++++++++++++++++++++++++++++++++++++++++++--
 3 files changed, 116 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index fab55ddb..8940fb85 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2005-02-20  Werner LEMBERG  <wl@gnu.org>
+
+	* src/preproc/eqn/eqn.man, NEWS: Document various extensions of
+	eqn.
+
 2005-02-17  Werner LEMBERG  <wl@gnu.org>
 
 	* doc/pic.ms, man/groff.man: Fix typos.
diff --git a/NEWS b/NEWS
index 448ba97c..0cafe4ac 100644
--- a/NEWS
+++ b/NEWS
@@ -24,6 +24,34 @@ Pic
 o The `by' argument in a `for' loop can now be negative if it is additive.
   For the multiplicative case, it must be greater than zero.
 
+Eqn
+---
+
+o The following keywords aren't new but haven't been documented previously:
+
+    undef NAME    (to undefine a macro)
+    copy  "FILE"  (a synonym for `include')
+    space n       (to modify the vertical spacing before and after
+                   an equation)
+
+o The following macros aren't new but haven't been documented previously:
+
+    Alpha, ..., Omega   (the same as `ALPHA', ..., `OMEGA')
+    ldots               (three dots on the base line)
+    dollar              (a dollar glyph)
+
+o The following keywords have been extended.  Again, this isn't new but
+  hasn't been documented previously:
+
+    col n { ... }
+    lcol n { ... }
+    rcol n { ... }
+    ccol n { ... }
+    pile n { ... }
+    lpile n { ... }
+    rpile n { ... }
+    cpile n { ... }   (set vertical spacing between rows to N)
+
 Grohtml
 -------
 
diff --git a/src/preproc/eqn/eqn.man b/src/preproc/eqn/eqn.man
index 4f0696bd..0f47771c 100644
--- a/src/preproc/eqn/eqn.man
+++ b/src/preproc/eqn/eqn.man
@@ -1,5 +1,5 @@
 .ig
-Copyright (C) 1989-2000, 2001, 2004 Free Software Foundation, Inc.
+Copyright (C) 1989-2000, 2001, 2004, 2005 Free Software Foundation, Inc.
 
 Permission is granted to make and distribute verbatim copies of
 this manual provided the copyright notice and this permission notice
@@ -32,6 +32,13 @@ the original English.
 ..
 .
 .
+.de TQ
+.  br
+.  ns
+.  TP \\$1
+..
+.
+.
 .\" The BSD man macros can't handle " in arguments to font change macros,
 .\" so use \(ts instead of ".
 .tr \(ts"
@@ -623,6 +630,51 @@ define box 'special Bx'
 .ft
 .RE
 .
+.TP
+.BI space\  n
+A positive value of the integer\~\c
+.I n
+(in hundredths of an em) sets the vertical spacing before the equation,
+a negative value sets the spacing after the equation, replacing the
+default values.
+This primitive provides an interface to
+.BR groff 's
+.B \ex
+escape (but with opposite sign).
+.
+.IP
+This keyword has no effect if the equation is part of a
+.B pic
+picture.
+.
+.SS Extended primitives
+.TP
+.BI col\  n\  {\  .\|.\|.\  }
+.TQ
+.BI ccol\  n\  {\  .\|.\|.\  }
+.TQ
+.BI lcol\  n\  {\  .\|.\|.\  }
+.TQ
+.BI rcol\  n\  {\  .\|.\|.\  }
+.TQ
+.BI pile\  n\  {\  .\|.\|.\  }
+.TQ
+.BI cpile\  n\  {\  .\|.\|.\  }
+.TQ
+.BI lpile\  n\  {\  .\|.\|.\  }
+.TQ
+.BI rpile\  n\  {\  .\|.\|.\  }
+The integer value\~\c
+.I n
+(in hundredths of an em) increases the vertical spacing between rows,
+using
+.BR groff 's
+.B \ex
+escape.
+Negative values are possible but have no effect.
+If there is more than a single value given in a matrix, the biggest one
+is used.
+.
 .SS Customization
 The appearance of equations is controlled by a large number of parameters.
 These can be set using
@@ -968,8 +1020,14 @@ will not be recognized if called with arguments.
 .
 .TP
 .BI include\ \(ts file \(ts
+.TQ
+.BI copy\ \(ts file \(ts
 Include the contents of
-.IR file .
+.I file
+.RB ( include
+and
+.B copy
+are synonyms).
 Lines of
 .I file
 beginning with
@@ -995,6 +1053,28 @@ otherwise ignore
 can be any character not appearing in
 .IR anything .
 .
+.TP
+.BI undef\  name
+Remove definition of
+.IR name ,
+making it undefined.
+.
+.LP
+Besides the macros mentioned above, the following definitions are available:
+.BR Alpha ,
+.BR Beta ,
+\&.\|.\|.,
+.B Omega
+(this is the same as
+.BR ALPHA ,
+.BR BETA ,
+\&.\|.\|.,
+.BR OMEGA ),
+.B ldots
+(three dots on the base line),
+and
+.BR dollar .
+.
 .SS Fonts
 .B eqn
 normally uses at least two fonts to set an equation:
@@ -1071,6 +1151,7 @@ beginning of the input line.
 .SH "SEE ALSO"
 .BR groff (@MAN1EXT@),
 .BR @g@troff (@MAN1EXT@),
+.BR @g@pic (@MAN1EXT@),
 .BR groff_font (@MAN5EXT@),
 .I The\ \*(txbook
 .
-- 
2.11.4.GIT