groff-commit
[Top][All Lists]
Advanced

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

[groff] 61/122: [man pages]: Fix content nits.


From: G. Branden Robinson
Subject: [groff] 61/122: [man pages]: Fix content nits.
Date: Wed, 11 Nov 2020 02:59:23 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 7f03e01490cc7cc8400045e857c0bdf1db023b4e
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Nov 8 17:15:31 2020 +1100

    [man pages]: Fix content nits.
    
    * contrib/gdiffmk/gdiffmk.1.man (Options): Program recognizes only
      '--version', not '-v'.
    * src/utils/addftinfo/addftinfo.1.man (Options): Set "n" in italics as
      the metasyntactic variable, not "value".
    * src/utils/afmtodit/afmtodit.1.man: Tighten discussion; summarize
      purpose of each operand before going into details on each of them.
      Pare down redundant redundant.  Be precise (if not surprising) about
      function of -v option.
---
 contrib/gdiffmk/gdiffmk.1.man       |  2 +-
 src/utils/addftinfo/addftinfo.1.man |  2 +-
 src/utils/afmtodit/afmtodit.1.man   | 77 +++++++++++++++++--------------------
 3 files changed, 37 insertions(+), 44 deletions(-)

diff --git a/contrib/gdiffmk/gdiffmk.1.man b/contrib/gdiffmk/gdiffmk.1.man
index 952c5e7..cdbca87 100644
--- a/contrib/gdiffmk/gdiffmk.1.man
+++ b/contrib/gdiffmk/gdiffmk.1.man
@@ -110,7 +110,7 @@ cannot be both input and output.
 .B \-\-help
 displays a usage message
 and
-.B \-v
+.B \-\-version
 shows version information;
 both exit afterward.
 .
diff --git a/src/utils/addftinfo/addftinfo.1.man 
b/src/utils/addftinfo/addftinfo.1.man
index aef0ba7..6358713 100644
--- a/src/utils/addftinfo/addftinfo.1.man
+++ b/src/utils/addftinfo/addftinfo.1.man
@@ -120,7 +120,7 @@ the heights and depths.
 .
 Like the existing quantities in the font file,
 each
-.I value
+.RI value\~ n
 is in
 .RI inches/ resolution
 for a font whose point size is
diff --git a/src/utils/afmtodit/afmtodit.1.man 
b/src/utils/afmtodit/afmtodit.1.man
index a2be571..6916c13 100644
--- a/src/utils/afmtodit/afmtodit.1.man
+++ b/src/utils/afmtodit/afmtodit.1.man
@@ -58,31 +58,35 @@ afmtodit \- adapt Adobe Font Metrics files for groff \-Tps 
and \-Tpdf
 .\" ====================================================================
 .
 .I afmtodit
-creates a font file for use with
-.IR groff ,
-.IR grops ,
+converts an
+Adobe Font Metric
+file,
+.IR afm-file ,
+for use with the
+.B ps
 and
-.IR gropdf .
-.
-.I afmtodit
-is written in Perl;
-you must have Perl version 5.004 or newer installed in order to run
-.IR afmtodit .
+.B pdf
+output drivers of
+.IR groff (@MAN1EXT@).
 .
+.I map-file
+associates a
+.I groff
+character name with a PostScript character name.
 .
-.LP
-.I afm-file
-is the AFM
-(Adobe Font Metric)
-file for the font.
+Output is written to
+.IR font,
+a file named for the intended
+.I groff
+font name
+(but see the
+.B -o
+option).
 .
 .
 .LP
-.I map-file
-is a file that says which
-.I groff
-character names map onto each PostScript character name;
-this file should contain a sequence of lines of the form
+.I afm-file
+should contain a sequence of lines of the form
 .
 .RS
 .I ps-char groff-char
@@ -109,7 +113,7 @@ must occur at most once.
 Lines starting with \[lq]#\[rq] and blank lines are ignored.
 .
 If the file isn't found in the current directory,
-it is searched for in the
+it is sought in the
 .I devps/generate
 subdirectory of the default font directory.
 .
@@ -137,9 +141,9 @@ this is true for glyph variants named in the form 
\[lq]foo.bar\[rq];
 all glyph names containing one or more periods are mapped to unnamed
 entities.
 .
-If option
+Unless
 .B \-e
-is not specified,
+is specified,
 the encoding defined in the AFM file
 (i.e.,
 entries
@@ -174,16 +178,6 @@ it is best to access them with glyph names only.
 .
 .
 .LP
-The
-.I groff
-font file will be output to a file called
-.IR font ,
-unless the
-.B \-o
-option is used.
-.
-.
-.LP
 If there is a downloadable font file for the font,
 it may be listed in the file
 .IR \%@FONTDIR@/\:\%devps/\:\%download ;
@@ -196,12 +190,12 @@ If the
 .B \-i
 option is used,
 .I afmtodit
-will automatically generate an italic correction,
-a left italic correction and a subscript correction
-for each character
-(the significance of these parameters is explained in
+automatically generates an italic correction,
+a left italic correction,
+and a subscript correction for each character
+(the significance of these is explained in
 .IR groff_font (@MAN5EXT@));
-these parameters may be specified for individual characters by
+they be specified for individual characters by
 adding to the
 .I afm-file
 lines of the form:
@@ -222,7 +216,7 @@ and
 is the desired value of the corresponding parameter in thousandths of an
 em.
 .
-These parameters are normally needed only for italic
+Such parameters are normally needed only for italic
 (or oblique)
 fonts.
 .
@@ -388,16 +382,15 @@ use with monospaced (constant-width) fonts.
 .
 .TP
 .B \-s
-The font is special.
-.
-The effect of this option is to add the
+The font is special;
+add the
 .B special
 command to the font file.
 .
 .
 .TP
 .B \-v
-Print version and exit.
+Write version information to the standard output stream and exit.
 .
 .
 .TP



reply via email to

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