groff, eqn2graph.man: Macro IX not defined and some improvements in the manual

[Bjarni Ingi Gislason]

                           Groff Bug Report

GROFF VERSION: 1.22.2
'current-groff' from 12th October 2013

MACHINE: laptop i586

OS: Linux 3.2.46-1-rt67-1 (Debian)

COMPILER: gcc (Debian 4.7.2-5) 4.7.2

INPUT FILES:

  .../groff-current/contrib/eqn2graph/eqn2graph.man

COMMAND LINE:

  groff -b -ww -mandoc -z <  <inputfile>

DESCRIPTION OF INCORRECT BEHAVIOUR [OR DEFECTS IN (INPUT) SOURCE]:

  groff:<standard input>:14: warning: macro `IX' not defined

###

  Changes (besides warning):

  Space at end of lines removed

  Added a ".ad l" request to eliminate too much space between (long)
words.
  
  Manuals should generally have this request at the beginning of the
file.

  A full stop, that is a part of a string at the beginning or end,
protected with \& (for example, an abbreviation, an ellipsis).

SUGGESTED FIX [optional]:

  Patch:

--- eqn2graph.man       2013-10-31 23:43:21.000000000 +0000
+++ eqn2graph.man.new   2013-10-31 23:56:05.000000000 +0000
@@ -11,6 +11,13 @@
 .
 .
 .TH EQN2GRAPH @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
+.\" Macro IX is not a part of groff
+.if \n(.g \{\
+.if !dIX \{\
+.de IX
+..
+.\}
+.\}
 .IX eqn2graph
 .SH NAME
 eqn2graph \- convert an EQN equation into a cropped image
@@ -34,8 +41,8 @@ Web as output.
 Your input EQN code should
 .I not
 have the \&.EQ/.EN preamble that
-that normally precedes it within 
-.BR groff (@MAN1EXT@) 
+that normally precedes it within
+.BR groff (@MAN1EXT@)
 macros; nor do you need to have dollar-sign or other delimiters
 around the equation.
 .P
@@ -45,15 +52,15 @@ Older versions of
 .BR convert (1)
 will produce a black-on-white graphic; newer ones may produce a
 black-on-transparent graphic.
-By specifying command-line options to be passed to 
+By specifying command-line options to be passed to
 .BR convert (1)
 you can give it a border, force the background transparent, set the
 image's pixel density, or perform other useful transformations.
 .P
-This program uses 
+This program uses
 .BR @address@hidden (@MAN1EXT@),
 .BR groff (@MAN1EXT@),
-and the ImageMagick 
+and the ImageMagick
 .BR convert (1)
 program.
 These programs must be installed on your system and accessible on your
@@ -65,7 +72,7 @@ to work.
 .SH OPTIONS
 .TP
 .B \-unsafe
-Run 
+Run
 .BR groff (@MAN1EXT@)
 in the `unsafe' mode enabling the PIC macro
 .B sh
@@ -85,7 +92,7 @@ Command-line switches and arguments not
 .SH FILES
 .Tp \w'address@hidden@/eqnrc'u+2n
 .B @MACRODIR@/eqnrc
-The 
+The
 .BR @address@hidden (@MAN1EXT@)
 initialization file.
 .
@@ -112,22 +119,23 @@ Due to changes in the behavior of ImageM
 that are both forward and backward-incompatible,
 mismatches between your
 .B eqn2graph
-and 
+and
 .BR convert (1)
 versions may produce zero-sized or untrimmed output images.
-For this version of 
+For this version of
 .B eqn2graph
 you will need a version of
 .BR convert (1)
 that supports the
 .B \-trim
-option; older versions of 
+option; older versions of
 .B eqn2graph
 used
 .BR \-crop\~0x0 ,
 which no longer has trimming behavior.
 .
 .
+.ad l
 .SH "SEE ALSO"
 .BR pic2graph (@MAN1EXT@),
 .BR grap2graph (@MAN1EXT@),
@@ -138,7 +146,7 @@ which no longer has trimming behavior.
 .
 .
 .SH AUTHOR
-Eric S. Raymond <address@hidden>.
+Eric S.\& Raymond <address@hidden>.
 .
 .\" Local Variables:
 .\" mode: nroff

-- 
Bjarni I. Gislason