[Pkg-gmagick-im-team] Bug#1086606: identify-im6.q16.1: Some remarks and editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Sat Nov 2 01:25:16 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 spaces.]
["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>':63
troff:<stdin>:63: 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.
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 identify-im6.q16.1": (possibly shortened list)
mandoc: identify-im6.q16.1:8:662: STYLE: input text line longer than 80 bytes: The \fBidentify-im6....
mandoc: identify-im6.q16.1:10:249: STYLE: input text line longer than 80 bytes: For more information...
mandoc: identify-im6.q16.1:63:72: STYLE: whitespace at end of input line
mandoc: identify-im6.q16.1:72:306: STYLE: input text line longer than 80 bytes: By default, the imag...
mandoc: identify-im6.q16.1:74:202: STYLE: input text line longer than 80 bytes: Although some option...
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
63: \-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.
identify-im6.q16.1:81:\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.
72: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 identify command, point your browser to file:///usr/share/doc/imagemagick-6-common/html/www/identify.html (on debian system you may install the imagemagick-6 package) or https://www.imagemagick.org/script/identify.php.
81 \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.
30: \-features distance analyze image features (e.g. contrast, correlation)
72: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.
N.B.
The number of lines affected can be too large to be in a patch.
8:The \fBidentify-im6.q16\fP program is a member of the ImageMagick-ims6.q16(1) suite of tools. It describes the format and characteristics of one or more image files. It also reports if an image is incomplete or corrupt. The information returned includes the image number, the file name, the width and height of the image, whether the image is colormapped or not, the number of colors in the image (by default off use \fI-define unique=true\fP option), the number of bytes in the image, the format of the image (JPEG, PNM, etc.), and finally the number of seconds it took to read and process the image. Many more attributes are available with the verbose option.
72: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.
74:Although some options appear to modify the file to be identified, the identify command is strictly \fBread only\fP. For instance, the crop option crops the in-memory image and then describes the result.
81:\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
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 8, length 662
The \fBidentify-im6.q16\fP program is a member of the ImageMagick-ims6.q16(1) suite of tools. It describes the format and characteristics of one or more image files. It also reports if an image is incomplete or corrupt. The information returned includes the image number, the file name, the width and height of the image, whether the image is colormapped or not, the number of colors in the image (by default off use \fI-define unique=true\fP option), the number of bytes in the image, the format of the image (JPEG, PNM, etc.), and finally the number of seconds it took to read and process the image. Many more attributes are available with the verbose option.
Line 10, length 249
For more information about the identify command, point your browser to file:///usr/share/doc/imagemagick-6-common/html/www/identify.html (on debian system you may install the imagemagick-6 package) or https://www.imagemagick.org/script/identify.php.
Line 72, length 306
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.
Line 74, length 202
Although some options appear to modify the file to be identified, the identify command is strictly \fBread only\fP. For instance, the crop option crops the in-memory image and then describes the result.
Line 81, length 292
\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).
77:ImageMagick-im6.q16(1)
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
identify-im6.q16.1:8:The \fBidentify-im6.q16\fP program is a member of the ImageMagick-ims6.q16(1) suite of tools. It describes the format and characteristics of one or more image files. It also reports if an image is incomplete or corrupt. The information returned includes the image number, the file name, the width and height of the image, whether the image is colormapped or not, the number of colors in the image (by default off use \fI-define unique=true\fP option), the number of bytes in the image, the format of the image (JPEG, PNM, etc.), and finally the number of seconds it took to read and process the image. Many more attributes are available with the verbose option.
identify-im6.q16.1:10:For more information about the identify command, point your browser to file:///usr/share/doc/imagemagick-6-common/html/www/identify.html (on debian system you may install the imagemagick-6 package) or https://www.imagemagick.org/script/identify.php.
identify-im6.q16.1:30: \-features distance analyze image features (e.g. contrast, correlation)
identify-im6.q16.1:72: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.
identify-im6.q16.1:81:\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
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':63
troff:<stdin>:63: 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 --------------
--- identify-im6.q16.1 2024-11-02 00:49:58.121232169 +0000
+++ identify-im6.q16.1.new 2024-11-02 01:18:14.956373657 +0000
@@ -5,9 +5,26 @@ identify \- describes the format and cha
.TP
\fBidentify-im6.q16\fP [\fIoptions\fP] \fIinput-file\fP
.SH OVERVIEW
-The \fBidentify-im6.q16\fP program is a member of the ImageMagick-ims6.q16(1) suite of tools. It describes the format and characteristics of one or more image files. It also reports if an image is incomplete or corrupt. The information returned includes the image number, the file name, the width and height of the image, whether the image is colormapped or not, the number of colors in the image (by default off use \fI-define unique=true\fP option), the number of bytes in the image, the format of the image (JPEG, PNM, etc.), and finally the number of seconds it took to read and process the image. Many more attributes are available with the verbose option.
+The \fBidentify-im6.q16\fP program is a member of the
+.BR ImageMagick-ims6.q16 (1)
+suite of tools.
+It describes the format and characteristics of one or more image files.
+It also reports if an image is incomplete or corrupt.
+The information returned includes the image number,
+the file name, the width and height of the image,
+whether the image is colormapped or not,
+the number of colors in the image
+(by default off use \fI\-define unique=true\fP option),
+the number of bytes in the image,
+the format of the image
+(JPEG, PNM, etc.),
+and finally the number of seconds it took to read and process the image.
+Many more attributes are available with the verbose option.
-For more information about the identify command, point your browser to file:///usr/share/doc/imagemagick-6-common/html/www/identify.html (on debian system you may install the imagemagick-6 package) or https://www.imagemagick.org/script/identify.php.
+For more information about the identify command, point your browser to
+file:///usr/share/doc/imagemagick-6-common/html/www/identify.html
+(on debian system you may install the imagemagick-6 package)
+or https://www.imagemagick.org/script/identify.php.
.SH DESCRIPTION
Image Settings:
\-alpha option on, activate, off, deactivate, set, opaque, copy
@@ -27,7 +44,7 @@ Image Settings:
\-depth value image depth
\-endian type endianness (MSB or LSB) of the image
\-extract geometry extract area from image
- \-features distance analyze image features (e.g. contrast, correlation)
+ \-features distance analyze image features (e.g.\& contrast, correlation)
\-format "string" output formatted image characteristics
\-fuzz distance colors within this distance are considered equal
\-gamma value of gamma correction
@@ -60,7 +77,7 @@ Image Settings:
Image Operators:
\-auto-orient automatically orient image
\-grayscale method convert image to grayscale
- \-negate replace each pixel with its complementary color
+ \-negate replace each pixel with its complementary color
Miscellaneous Options:
\-debug events display copious debugging information
@@ -69,13 +86,26 @@ Miscellaneous Options:
\-log format format of debugging information
\-version print version information
-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 NOTE
-Although some options appear to modify the file to be identified, the identify command is strictly \fBread only\fP. For instance, the crop option crops the in-memory image and then describes the result.
+Although some options appear to modify the file to be identified,
+the identify command is strictly \fBread only\fP.
+For instance,
+the crop option crops the in-memory image and then describes the result.
.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