Package: xloadimage
Version: 4.1-26
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man
page"
[Use "groff -e ' $' -e '\\~$' <file>" to find obvious 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?
an.tmac:<stdin>:1: warning: TH: second argument is not a numeric expression: 1x
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:166: warning: trailing space in the line
troff:<stdin>:169: warning: trailing space in the line
troff:<stdin>:178: warning: trailing space in the line
troff:<stdin>:179: warning: trailing space in the line
troff:<stdin>:187: warning: trailing space in the line
troff:<stdin>:210: warning: trailing space in the line
troff:<stdin>:215: warning: trailing space in the line
troff:<stdin>:220: warning: trailing space in the line
troff:<stdin>:225: warning: trailing space in the line
troff:<stdin>:231: warning: trailing space in the line
troff:<stdin>:252: warning: trailing space in the line
troff:<stdin>:338: 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.12.10-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 xloadimage depends on:
ii libc6 2.40-5
ii libjpeg62-turbo 1:2.1.5-3+b1
ii libpng16-16t64 1.6.44-3
ii libtiff6 4.5.1+git230720-5
ii libx11-6 2:1.8.10-2
xloadimage recommends no packages.
xloadimage suggests no packages.
-- no debconf information
Input file is xloadimage.1x
Output from "mandoc -T lint xloadimage.1x": (shortened list)
1 input text line longer than 80 bytes: xloadimage my.image ...
2 skipping paragraph macro: PP after SH
3 skipping paragraph macro: PP empty
12 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z xloadimage.1x": (shortened list)
1 1x
1 name 'an-extra3' not defined
12 trailing space in the line
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
12
-.-.
Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).
477:using a backslash (\\).
487:Use backslash (\\) characters to allow inclusion of double\(hyquote marks
-.-.
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.
224:the first image, and the \fI-onroot\fR option is specified, the image
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Not considered in a patch, too many lines.
xloadimage.1x:16:that image type (most types do support reading from stdin).
xloadimage.1x:19:image, the image will be dithered (monochrome destination) or
have its
xloadimage.1x:20:colormap reduced (color destination) as appropriate. This can
also be
xloadimage.1x:57:\fIXLoadImage\fR (which was difficult to predict) or
\fIxloadimage\fR
xloadimage.1x:80:root weave (see \fBEXAMPLES\fR below).
xloadimage.1x:310:physical screen (eg DECWINDOWS servers).
xloadimage.1x:320:Tile this image (after any necessary merging or tiling) to
create a
xloadimage.1x:358:to dither the image for a cleaner (and faster) display:
xloadimage.1x:410:passes (although this can take awhile to do on slow
machines). There
xloadimage.1x:425:The file ~/.xloadimagerc (and optionally a system-wide file)
defines a
xloadimage.1x:435:in the list by whitespace (eg one or more spaces, tabs, or
newlines).
xloadimage.1x:443:name in ~/images (the tilde is expanded to the value of
$HOME), then
xloadimage.1x:603:\fInone\fR (no compression),
xloadimage.1x:604:\fIrle\fR (CCITT RLE compression),
xloadimage.1x:605:\fIg3fax\fR (CCITT Group 3 FAX compression),
xloadimage.1x:606:\fIg4fax\fR (CCITT Group 4 FAX compression),
xloadimage.1x:607:\fIlzw\fR (Limpel\(hyZiv\(hyWelsh compression, the default),
xloadimage.1x:608:\fIjpeg\fR (JPEG compression),
xloadimage.1x:609:\fInext\fR (NeXT run\(hylength compression),
xloadimage.1x:610:\fIrlew\fR (CCITT RLEW compression),
xloadimage.1x:611:\fImac\fR (Macintosh PackBits compression),
xloadimage.1x:612:\fIpackbits\fR (same as \fImac\fR),
xloadimage.1x:613:\fIthunderscan\fR (ThunderScan compression).
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:1: warning: TH: second argument is not a numeric expression: 1x
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:166: warning: trailing space in the line
troff:<stdin>:169: warning: trailing space in the line
troff:<stdin>:178: warning: trailing space in the line
troff:<stdin>:179: warning: trailing space in the line
troff:<stdin>:187: warning: trailing space in the line
troff:<stdin>:210: warning: trailing space in the line
troff:<stdin>:215: warning: trailing space in the line
troff:<stdin>:220: warning: trailing space in the line
troff:<stdin>:225: warning: trailing space in the line
troff:<stdin>:231: warning: trailing space in the line
troff:<stdin>:252: warning: trailing space in the line
troff:<stdin>:338: warning: trailing space in the line
--- xloadimage.1x 2025-01-27 03:00:35.763869049 +0000
+++ xloadimage.1x.new 2025-01-27 03:14:14.768232851 +0000
@@ -163,10 +163,10 @@ shared unless there are not enough color
.TP
\-quiet
Forces \fIxloadimage\fR and \fIxview\fR to be quiet. This is the
-default for \fIxsetbg\fR, but the others like to whistle.
+default for \fIxsetbg\fR, but the others like to whistle.
.TP
\-supported
-List the supported image types.
+List the supported image types.
.TP
\-type \fItype_name\fR
Forces \fIxloadimage\fR to try to load the image as a particular file
@@ -175,8 +175,8 @@ performance noticeably.
.TP
\-verbose
Causes \fIxloadimage\fR to be talkative, telling you what kind of
-image it's playing with and any special processing that it has to do.
-This is the default for \fIxview\fR and \fIxloadimage\fR.
+image it's playing with and any special processing that it has to do.
+This is the default for \fIxview\fR and \fIxloadimage\fR.
.TP
\-version
Print the version number and patchlevel of this version of
@@ -184,7 +184,7 @@ Print the version number and patchlevel
.TP
\-view
View image(s) in a window. This is the opposite of \fI\-onroot\fR and
-the default for \fIxview\fR and \fIxloadimage\fR.
+the default for \fIxview\fR and \fIxloadimage\fR.
.TP
\-visual \fIvisual_name\fR
Force the use of a specific visual type to display an image. Normally
@@ -207,28 +207,28 @@ local to the image they precede.
Indicates coordinates to load the image at on the base image. If
this is an option to the first image, and the \fI\-onroot\fR option is
specified, the image will be loaded at the given location on the
-display background.
+display background.
.TP
\-background \fIcolor\fR
Use \fIcolor\fR as the background color instead of the default
(usually white but this depends on the image type) if you are
-transferring a monochrome image to a color display.
+transferring a monochrome image to a color display.
.TP
\-brighten \fIpercentage\fR
Specify a percentage multiplier for a color image's colormap. A value
of more than 100 will brighten an image, one of less than 100 will
-darken it.
+darken it.
.TP
\-center
Center the image on the base image loaded. If this is an option to
-the first image, and the \fI-onroot\fR option is specified, the image
-will be centered on the display background.
+the first image, and the \fI\-onroot\fR option is specified, the image
+will be centered on the display background.
.TP
\-clip \fIX\fR,\fIY\fR,\fIW\fR,\fIH\fR
Clip the image before loading it. \fIX\fR and \fIY\fR define the
upper\(hyleft corner of the clip area, and \fIW\fR and \fIH\fR define the
extents of the area. A zero value for \fIW\fR or \fIH\fR will be
-interpreted as the remainder of the image.
+interpreted as the remainder of the image.
.TP
\-colors \fIn\fR
Specify the maximum number of colors to use in the image. This is a
@@ -249,7 +249,7 @@ the image accuracy but usually looks muc
Use \fIcolor\fR as the foreground color instead of black if you are
transferring a monochrome image to a color display. This can also be
used to invert the foreground and background colors of a monochrome
-image.
+image.
.TP
\-gamma \fIdisplay_gamma\fR
Specify the gamma correction for the display.
@@ -335,7 +335,7 @@ useful for correcting the aspect ratio o
.TP
\-yzoom \fIpercentage\fR
Zoom the Y axis of an image by \fIpercentage\fR. See \fI\-xzoom\fR for
-more information.
+more information.
.TP
\-zoom \fIpercentage\fR
Zoom both the X and Y axes by \fIpercentage\fR. See \fI\-xzoom\fR for
@@ -474,7 +474,7 @@ filters.
.PP
Any text on a line following a hash\(hymark (#) is ignored; if you wish
to use a hash\(hymark in a path, extension, or filter you can escape it
-using a backslash (\\).
+using a backslash (\e).
.PP
If you wish to include white-space in a filter program name, path, or
extension you can enclose the entire text in double\(hyquotes. For
@@ -484,7 +484,7 @@ example:
filter = "gzip \-cd" .gz
.fi
.PP
-Use backslash (\\) characters to allow inclusion of double\(hyquote marks
+Use backslash (\e) characters to allow inclusion of double\(hyquote marks
or newlines.
.PP
The following is a sample ~/.xloadimagerc file:
@@ -502,9 +502,7 @@ The following is a sample ~/.xloadimager
filter = "gzip \-cd" .z .zip
.fi
-.PP
.SH IMAGE TYPES
-.PP
\fIXloadimage\fR currently supports many common and some uncommon
image types, and can create images in several formats. For a complete
list use the \fI\-supported\fR option.
@@ -551,9 +549,7 @@ The filter will be automatically invoked
.PP
For a list of filters automatically recognized by xloadimage use the
\fI\-configuration\fR option.
-.PP
.SH SUPPORTED IMAGE OPTIONS
-.PP
The JPEG image dumper supports the following options:
.TP 8
arithmetic
@@ -616,7 +612,6 @@ Image data compression technique. Can b
or RGB photometrics as appropriate for its internal image format.
There is no way to specify a particular photometric or any other TIFF
fields.
-.PP
.SH AUTHOR
.nf
Jim Frost
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
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
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.
Line length should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
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 from '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)
-.-
