[Pkg-gmagick-im-team] Bug#1086597: convert-im6.q16.1: Some remarks and editorial changes for this man page

Bjarni Ingi Gislason bjarniig at simnet.is
Fri Nov 1 23:19:34 GMT 2024


Package: imagemagick-6.q16
Version: 8:6.9.13.12+dfsg1-1+b1
Severity: minor
Tags: patch

   * What led up to the situation?

     Checking for defects with

test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"

  [Use "groff -e ' $' <file>" to find trailing space.]

  ["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).

  [The fate of "test-nroff" was decided in groff bug #55941.]

   * What was the outcome of this action?


troff: backtrace: file '<stdin>':8
troff:<stdin>:8: warning: trailing space in the line
troff: backtrace: file '<stdin>':207
troff:<stdin>:207: warning: trailing space in the line


   * What outcome did you expect instead?

     No output (no warnings).

-.-

  General remarks and further material, if a diff-file exist, are in the
attachments.


-- System Information:
Debian Release: trixie/sid
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 6.11.4-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)

Versions of packages imagemagick-6.q16 depends on:
ii  hicolor-icon-theme        0.18-1
ii  libc6                     2.40-3
ii  libmagickcore-6.q16-7t64  8:6.9.13.12+dfsg1-1+b1
ii  libmagickwand-6.q16-7t64  8:6.9.13.12+dfsg1-1+b1

Versions of packages imagemagick-6.q16 recommends:
ii  ghostscript                  10.04.0~dfsg-1
pn  libmagickcore-6.q16-7-extra  <none>
ii  netpbm                       2:11.08.01-1+b1

Versions of packages imagemagick-6.q16 suggests:
pn  autotrace                            <none>
pn  cups-bsd | lpr | lprng               <none>
ii  curl                                 8.10.1-2
pn  enscript                             <none>
pn  ffmpeg                               <none>
pn  gimp                                 <none>
pn  gnuplot                              <none>
pn  grads                                <none>
pn  graphviz                             <none>
ii  groff-base                           1.23.0-5
pn  hp2xx                                <none>
pn  html2ps                              <none>
pn  imagemagick-6-doc                    <none>
pn  libraw-bin                           <none>
pn  libwmf-bin                           <none>
pn  mplayer                              <none>
pn  povray                               <none>
pn  radiance                             <none>
pn  sane-utils                           <none>
ii  texlive-binaries [texlive-base-bin]  2024.20240313.70630+ds-4
pn  transfig                             <none>
ii  xdg-utils                            1.1.3-4.1

-- no debconf information
-------------- next part --------------
  Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)

[gn]roff -mandoc -t -ww -b -z -K utf8  <man page>

  The same goes for man pages that are used as an input.

  For a style guide use

  mandoc -T lint

-.-

  So any 'generator' should check its products with the above mentioned
'groff', 'mandoc',  and additionally with 'nroff ...'.

  This is just a simple quality control measure.

  The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.

  Common defects:

  Input text line longer than 80 bytes.

  Not removing trailing spaces (in in- and output).
  The reason for these trailing spaces should be found and eliminated.

  Not beginning each input sentence on a new line.
Lines should thus be shorter.

  See man-pages(7), item 'semantic newline'.

-.-

The difference between the formatted output of the original and patched file
can be seen with:

  nroff -mandoc <file1> > <out1>
  nroff -mandoc <file2> > <out2>
  diff -u <out1> <out2>

and for groff, using

"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - "

instead of 'nroff -mandoc'

  Add the option '-t', if the file contains a table.

  Read the output of 'diff -u' with 'less -R' or similar.

-.-.

  If 'man' (man-db) is used to check the manual for warnings,
the following must be set:

  The option "-warnings=w"

  The environmental variable:

export MAN_KEEP_STDERR=yes (or any non-empty value)

  or

  (produce only warnings):

export MANROFFOPT="-ww -b -z"

export MAN_KEEP_STDERR=yes (or any non-empty value)

-.-.

Output from "mandoc -T lint convert-im6.q16.1": (possibly shortened list)

mandoc: convert-im6.q16.1:3:146: STYLE: input text line longer than 80 bytes: convert \- convert b...
mandoc: convert-im6.q16.1:8:241: STYLE: input text line longer than 80 bytes: The \fBconvert-im6.q...
mandoc: convert-im6.q16.1:8:241: STYLE: whitespace at end of input line
mandoc: convert-im6.q16.1:10:246: STYLE: input text line longer than 80 bytes: For more information...
mandoc: convert-im6.q16.1:207:72: STYLE: whitespace at end of input line
mandoc: convert-im6.q16.1:316:272: STYLE: input text line longer than 80 bytes: Use any setting or o...
mandoc: convert-im6.q16.1:318:306: STYLE: input text line longer than 80 bytes: By default, the imag...

-.-.

Remove space characters at the end of lines.

Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".

8:The \fBconvert-im6.q16\fP program is a member of the ImageMagick-ims6.q16(1) suite of tools.  Use it to convert between image formats as well as resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, and much more.  
207:  \-negate              replace each pixel with its complementary color 

-.-.

Change '-' (\-) to '\(en' (en-dash) for a numeric range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.

convert-im6.q16.1:324:\fBCopyright (C) 1999-2021 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-6-common/html/www/license.html (on debian system you may install the imagemagick-6 package) or https://www.imagemagick.org/script/license.php\fP

-.-.

Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.

215:                       pixel value less than |epsilon| become epsilon or -epsilon
318:By default, the image format of `file' is determined by its magic number.  To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps).  Specify 'file' as '-' for standard input or output.

-.-.

Strings longer than 3/4 of a standard line length (80)
Use "\:" to split the string at the end of an output line, for example a
long URLs (web address)

10 For more information about the convert command, point your browser to file:///usr/share/doc/imagemagick-6-common/html/www/convert.html (on debian system you may install the imagemagick-6 package) or https://www.imagemagick.org/script/convert.php.
324 \fBCopyright (C) 1999-2021 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-6-common/html/www/license.html (on debian system you may install the imagemagick-6 package) or https://www.imagemagick.org/script/license.php\fP

-.-.

Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.

50:  \-features distance   analyze image features (e.g. contrast, correlation)
318:By default, the image format of `file' is determined by its magic number.  To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps).  Specify 'file' as '-' for standard input or output.

-.-.

Wrong distance between sentences in the input file.

  Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").

  The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.

Remember coding: Only one command ("sentence") on each (logical) line.

E-mail: Easier to quote exactly the relevant lines.

Generally: Easier to edit the sentence.

Patches: Less unaffected text.

Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.

  The amount of space between sentences in the output can then be
controlled with the ".ss" request.

50:  \-features distance   analyze image features (e.g. contrast, correlation)
316:Use any setting or operator as an \fIoutput-option\fP.  Only a limited number of setting are  \fIinput-option\fP. They include: \-antialias, \-caption, \-density, \-define, \-encoding, \-font, \-pointsize, \-size, and \-texture as well as any of the miscellaneous options.
318:By default, the image format of `file' is determined by its magic number.  To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps).  Specify 'file' as '-' for standard input or output.
324:\fBCopyright (C) 1999-2021 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-6-common/html/www/license.html (on debian system you may install the imagemagick-6 package) or https://www.imagemagick.org/script/license.php\fP

-.-.

Name of a manual is set in bold, the section in roman.
See man-pages(7).

320:ImageMagick-im6.q16(1)

-.-.

point size: the typographical term is 'type size'.  There exist
several point sizes, like 'Didot point', 'big point' (PostScript point),
and 'pica point' (printer's point, English, USA).

80:  \-pointsize value     font point size

-.-.

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":

troff: backtrace: file '<stdin>':8
troff:<stdin>:8: warning: trailing space in the line
troff: backtrace: file '<stdin>':207
troff:<stdin>:207: warning: trailing space in the line

-.-

  Additionally (general):

  Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.
-------------- next part --------------
--- convert-im6.q16.1	2024-11-01 22:19:44.229881751 +0000
+++ convert-im6.q16.1.new	2024-11-01 23:06:43.309926820 +0000
@@ -1,13 +1,23 @@
 .TH convert-im6.q16 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
 .SH NAME
-convert \- convert between image formats as well as resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, and much more.
+convert \- convert between image formats as well as resize an image, blur, \
+crop, despeckle, dither, draw on, flip, join, re-sample, and much more.
 .SH SYNOPSIS
 .TP
-\fBconvert-im6.q16\fP [\fIinput-option\fP] \fIinput-file\fP [\fIoutput-option\fP] \fIoutput-file\fP
+\fBconvert-im6.q16\fP [\fIinput-option\fP] \fIinput-file\fP \
+[\fIoutput-option\fP] \fIoutput-file\fP
 .SH OVERVIEW
-The \fBconvert-im6.q16\fP program is a member of the ImageMagick-ims6.q16(1) suite of tools.  Use it to convert between image formats as well as resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, and much more.  
+The \fBconvert-im6.q16\fP program is a member of the
+.BR ImageMagick-ims6.q16 (1)
+suite of tools.
+Use it to convert between image formats as well as resize an image, blur,
+crop, despeckle, dither, draw on, flip, join, re-sample, and much more.
 
-For more information about the convert command, point your browser to file:///usr/share/doc/imagemagick-6-common/html/www/convert.html (on debian system you may install the imagemagick-6 package) or https://www.imagemagick.org/script/convert.php.
+For more information about the convert command,
+point your browser to
+file:///usr/share/doc/imagemagick-6-common/html/www/convert.html
+(on debian system you may install the imagemagick-6 package) or
+https://www.imagemagick.org/script/convert.php.
 .SH DESCRIPTION
 Image Settings:
   \-adjoin              join images into a single multi-image file
@@ -47,7 +57,7 @@ Image Settings:
   \-encoding type       text encoding type
   \-endian type         endianness (MSB or LSB) of the image
   \-family name         render text with this font family
-  \-features distance   analyze image features (e.g. contrast, correlation)
+  \-features distance   analyze image features (e.g., contrast, correlation)
   \-fill color          color to use when filling a graphic primitive
   \-filter type         use this filter when resizing an image
   \-flatten             flatten a sequence of images
@@ -77,7 +87,7 @@ Image Settings:
   \-orient type         image orientation
   \-page geometry       size and location of an image canvas (setting)
   \-ping                efficiently determine image attributes
-  \-pointsize value     font point size
+  \-pointsize value     font type size
   \-precision value     maximum number of significant digits to print
   \-preview type        image preview type
   \-quality value       JPEG/MIFF/PNG compression level
@@ -204,7 +214,7 @@ Image Operators:
                        apply a morphology method to the image
   \-motion-blur geometry
                        simulate motion blur
-  \-negate              replace each pixel with its complementary color 
+  \-negate              replace each pixel with its complementary color
   \-noise geometry      add or reduce noise in an image
   \-normalize           transform image to span the full range of colors
   \-opaque color        change this color to the fill color
@@ -212,7 +222,7 @@ Image Operators:
                        add a noise pattern to the image with specific amplitudes
   \-paint radius        simulate an oil painting
   \-perceptible epsilon
-                       pixel value less than |epsilon| become epsilon or -epsilon
+                       pixel value less than |epsilon| become epsilon or \-epsilon
   \-polaroid angle      simulate a Polaroid picture
   \-posterize levels    reduce the image to a limited number of color levels
   \-print string        interpret string and print to console
@@ -313,12 +323,24 @@ Miscellaneous Options:
   \-list type           print a list of supported option arguments
   \-version             print version information
 
-Use any setting or operator as an \fIoutput-option\fP.  Only a limited number of setting are  \fIinput-option\fP. They include: \-antialias, \-caption, \-density, \-define, \-encoding, \-font, \-pointsize, \-size, and \-texture as well as any of the miscellaneous options.
+Use any setting or operator as an \fIoutput-option\fP.
+Only a limited number of setting are \fIinput-option\fP.
+They include: \-antialias, \-caption, \-density, \-define, \-encoding,
+\-font, \-pointsize, \-size, and \-texture as well as any of the
+miscellaneous options.
 
-By default, the image format of `file' is determined by its magic number.  To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps).  Specify 'file' as '-' for standard input or output.
+By default, the image format of `file' is determined by its magic number.
+To specify a particular image format,
+precede the filename with an image format name and a colon (i.e.\& ps:image) or
+specify the image type as the filename suffix (i.e.\& image.ps).
+Specify 'file' as '\-' for standard input or output.
 .SH SEE ALSO
-ImageMagick-im6.q16(1)
+.BR ImageMagick-im6.q16 (1)
 
 .SH COPYRIGHT
 
-\fBCopyright (C) 1999-2021 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-6-common/html/www/license.html (on debian system you may install the imagemagick-6 package) or https://www.imagemagick.org/script/license.php\fP
+\fBCopyright (C) 1999\(en2021 ImageMagick Studio LLC.
+Additional copyrights and licenses apply to this software,
+see file:///usr/share/doc/imagemagick-6-common/html/www/license.html
+(on debian system you may install the imagemagick-6 package) or
+https://www.imagemagick.org/script/license.php\fP


More information about the Pkg-gmagick-im-team mailing list