groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 01/10: eqn(1): Fix content and style nits.


From: G. Branden Robinson
Subject: [groff] 01/10: eqn(1): Fix content and style nits.
Date: Fri, 5 Aug 2022 03:52:23 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 81294e834d9609c81ed8ad474a82f3af491a814e
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Aug 4 01:36:35 2022 -0500

    eqn(1): Fix content and style nits.
    
    * Clarify that equation delimiters need not be distinct.
    * Align terminology with recent groff documentation reforms.
        point size -> type size
    * Use "output device" correctly.  The device and driver are not the same
      thing.
    * Tighten wording.
---
 src/preproc/eqn/eqn.1.man | 54 +++++++++++++++++++++++++----------------------
 1 file changed, 29 insertions(+), 25 deletions(-)

diff --git a/src/preproc/eqn/eqn.1.man b/src/preproc/eqn/eqn.1.man
index 7009f3d9a..2baedda86 100644
--- a/src/preproc/eqn/eqn.1.man
+++ b/src/preproc/eqn/eqn.1.man
@@ -225,7 +225,7 @@ disabled with a call to
 .RB \[lq] "delim off" \[rq].
 .
 If delimiters haven't been specified,
-the call has no effect.
+these commands have no effect.
 .
 .
 .\" ====================================================================
@@ -1333,28 +1333,31 @@ for the left and right ends,
 respectively,
 of inline equations.
 .
+.I x
+and
+.I y
+need not be distinct.
+.
 Any
 .B delim
-statements in the source file override this.
+.I xy
+statements in the source file override this option.
 .
 .
 .TP
 .BI \-f\~ F
-This is equivalent to a
+is equivalent to
 .RB \[lq] gfont
-.IR F \[rq]
-command.
+.IR F \[rq].
 .
 .
 .TP
 .BI \-m\~ n
-Set the minimum point size
-.RI to\~ n .
+Set the minimum type size to
+.IR n \~points.
 .
 .I @g@eqn
-will not reduce the size of subscripts or superscripts to
-a smaller size
-.RI than\~ n .
+will not reduce the size of sub- or superscripts beyond this size.
 .
 .
 .TP
@@ -1363,12 +1366,12 @@ Search
 .I dir
 for
 .I eqnrc
-before the default directories.
+before those listed in section \[lq]Description\[rq] above.
 .
 .
 .TP
 .B \-N
-Don't allow newlines within delimiters.
+Prohibit newlines within delimiters.
 .
 This option allows
 .I @g@eqn
@@ -1377,21 +1380,21 @@ to recover better from missing closing delimiters.
 .
 .TP
 .BI \-p\~ n
-This says that subscripts and superscripts should be
+Set sub- and superscripts
 .IR n \~points
 smaller than the surrounding text.
 .
 This option is deprecated.
 .
-Normally,
 .I @g@eqn
-sets subscripts and superscripts at 70% of the size of the surrounding
-text.
+normally sets sub- and superscripts at 70% of the type size of the
+surrounding text.
 .
 .
 .TP
 .B \-r
-Only one size reduction.
+Reduce the type size of subscripts at most once relative to the base
+type size for the equation.
 .
 .
 .TP
@@ -1408,34 +1411,35 @@ This is equivalent to a
 command.
 .
 This option is deprecated.
+.
 .I @g@eqn
-normally sets equations at whatever the current point size is when the
-equation is encountered.
+normally sets equations at the type size current when the equation is
+encountered.
 .
 .
 .TP
 .BI \-T\~ name
-The output is for output driver
+Prepare output for the device
 .IR name .
 .
-Normally,
-the only effect of this is to define a macro
+In most cases,
+the effect of this is to define a macro
 .I name
 with a value
 .RB of\~ 1 ;
 .I eqnrc
-uses this to provide definitions appropriate for the output driver.
+uses this to provide definitions appropriate for the device.
 .
 However,
 if the specified driver is \[lq]MathML\[rq],
 the output is MathML markup rather than
 .I @g@troff
-commands,
+input,
 and
 .I eqnrc
 is not loaded at all.
 .
-The default output driver is
+The default output device is
 .BR @DEVICE@ .
 .
 .



reply via email to

[Prev in Thread] Current Thread [Next in Thread]