[Pkg-gmagick-im-team] Bug#1099631: display-im7.q16.1: Some remarks and a patch with editorial changes for this man page

Bjarni Ingi Gislason bjarniig at simnet.is
Thu Mar 6 01:12:35 GMT 2025


Package: imagemagick-7.q16
Version: 8:7.1.1.43+dfsg1-1
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>:13: style: 2 leading space(s) on input line
[...]
troff:<stdin>:127: 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.12-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-7.q16 depends on:
ii  hicolor-icon-theme      0.18-2
ii  libc6                   2.40-7
ii  libmagickcore-7.q16-10  8:7.1.1.43+dfsg1-1
ii  libmagickwand-7.q16-10  8:7.1.1.43+dfsg1-1

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

Versions of packages imagemagick-7.q16 suggests:
pn  autotrace                            <none>
pn  cups-bsd | lpr | lprng               <none>
ii  curl                                 8.12.1-3
pn  enscript                             <none>
pn  ffmpeg                               <none>
pn  gimp                                 <none>
pn  gnuplot                              <none>
pn  grads                                <none>
pn  graphviz                             <none>
ii  groff-base                           1.23.0-7
pn  hp2xx                                <none>
pn  html2ps                              <none>
pn  imagemagick-7-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-5+b1
pn  transfig                             <none>
ii  xdg-utils                            1.2.1-2

-- no debconf information
-------------- next part --------------
Input file is display-im7.q16.1

Output from "mandoc -T lint  display-im7.q16.1": (shortened list)

      1 input text line longer than 80 bytes: By default, the imag...
      1 input text line longer than 80 bytes: For more information...
      1 input text line longer than 80 bytes: In addition to those...
      1 input text line longer than 80 bytes: The \fBdisplay-im7.q...
      1 input text line longer than 80 bytes: The display program ...
      1 whitespace at end of input line

Remove trailing space with: sed -e 's/  *$//'

-.-.

Output from "test-nroff -mandoc -t -ww -z display-im7.q16.1": (shortened list)

      1 trailing space in the line

Remove trailing space with: sed -e 's/  *$//'

-.-.

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

1

-.-.

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.

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

-.-.

Reduce space between words.

[List of affected lines removed.]

-.-.

Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it; ".nf" and ".fi" to end
it, for an extra indention.
  This i changed into tables.

[List of affected lines.]

-.-.

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.

125: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.
134:  display -density 72 drawing.svg

-.-.

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 URL (web address)

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

-.-.

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

125: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.

Mark a final abbreviation point as such by suffixing it with "\&".

Some sentences (etc.) do not begin on a new line.

Split (sometimes) lines after a punctuation mark; before a conjunction.

  Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.

Use

#!/usr/bin/sh

sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\.  */\1.\n/g' $1

to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"

8:The \fBdisplay-im7.q16\fP program is a member of the ImageMagick-ims7.q16(1) suite of tools.  Use it to display an image or image sequence on any X server.
125: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.
132:The display program defaults to the X screen resolution.  To display vector formats at their intended size, override the default resolution:
140:\fBCopyright (C) 1999-2021 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-7-common/html/www/license.html (on debian system you may install the imagemagick-7 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.
Add "\:" to split the string for the output, "\<newline>" in the source.  

Line 8, length 155

The \fBdisplay-im7.q16\fP program is a member of the ImageMagick-ims7.q16(1) suite of tools.  Use it to display an image or image sequence on any X server.

Line 10, length 246

For more information about the display command, point your browser to file:///usr/share/doc/imagemagick-7-common/html/www/display.html (on debian system you may install the imagemagick-7 package) or https://www.imagemagick.org/script/display.php.

Line 123, length 259

In addition to those listed above, you can specify these standard X resources as command line options:  \-background, \-bordercolor, \-borderwidth, \-font, \-foreground, \-iconGeometry, \-iconic, \-mattecolor, \-name, \-shared-memory, \-usePixmap, or \-title.

Line 125, 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 132, length 140

The display program defaults to the X screen resolution.  To display vector formats at their intended size, override the default resolution:

Line 140, length 292

\fBCopyright (C) 1999-2021 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-7-common/html/www/license.html (on debian system you may install the imagemagick-7 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).

136:ImageMagick-im7.q16(1)

-.-.

Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".

display-im7.q16.1:10:For more information about the display command, point your browser to file:///usr/share/doc/imagemagick-7-common/html/www/display.html (on debian system you may install the imagemagick-7 package) or https://www.imagemagick.org/script/display.php.
display-im7.q16.1:32:  \-endian type         endianness (MSB or LSB) of the image
display-im7.q16.1:125: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.
display-im7.q16.1:140:\fBCopyright (C) 1999-2021 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-7-common/html/www/license.html (on debian system you may install the imagemagick-7 package) or https://www.imagemagick.org/script/license.php\fP

-.-.

Space after an end of sentence.

display-im7.q16.1:8:The \fBdisplay-im7.q16\fP program is a member of the ImageMagick-ims7.q16(1) suite of tools.  Use it to display an image or image sequence on any X server.
display-im7.q16.1:125: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.
display-im7.q16.1:132:The display program defaults to the X screen resolution.  To display vector formats at their intended size, override the default resolution:
display-im7.q16.1:140:\fBCopyright (C) 1999-2021 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-7-common/html/www/license.html (on debian system you may install the imagemagick-7 package) or https://www.imagemagick.org/script/license.php\fP

-.-.

Put a subordinate sentence (after a comma) on a new line.

display-im7.q16.1:10:For more information about the display command, point your browser to file:///usr/share/doc/imagemagick-7-common/html/www/display.html (on debian system you may install the imagemagick-7 package) or https://www.imagemagick.org/script/display.php.
display-im7.q16.1:123:In addition to those listed above, you can specify these standard X resources as command line options:  \-background, \-bordercolor, \-borderwidth, \-font, \-foreground, \-iconGeometry, \-iconic, \-mattecolor, \-name, \-shared-memory, \-usePixmap, or \-title.
display-im7.q16.1:125: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.
display-im7.q16.1:132:The display program defaults to the X screen resolution.  To display vector formats at their intended size, override the default resolution:
display-im7.q16.1:140:\fBCopyright (C) 1999-2021 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/imagemagick-7-common/html/www/license.html (on debian system you may install the imagemagick-7 package) or https://www.imagemagick.org/script/license.php\fP

-.-.

Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.

display-im7.q16.1:1:.TH display-im7.q16 1 "Date: 2009/01/10 01:00:00" "ImageMagick"

-.-.

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

an.tmac:<stdin>:13: style: 2 leading space(s) on input line
[...]
troff:<stdin>:127: warning: trailing space in the line
[...]

-.-

Generally:

Split (sometimes) lines after a punctuation mark; before a conjunction.
-------------- next part --------------
--- display-im7.q16.1	2025-03-05 23:56:16.852771193 +0000
+++ display-im7.q16.1.new	2025-03-06 01:02:14.195983873 +0000
@@ -1,140 +1,199 @@
-.TH display-im7.q16 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
+.TH display-im7.q16 1 "Date: 2009/01/10 01:00:00" ImageMagick
 .SH NAME
 display \- displays an image or image sequence on any X server.
 .SH SYNOPSIS
 .TP
 \fBmagick-im7.q16 display\fP [\fIoptions\fP] \fIinput-file\fP
 .SH OVERVIEW
-The \fBdisplay-im7.q16\fP program is a member of the ImageMagick-ims7.q16(1) suite of tools.  Use it to display an image or image sequence on any X server.
-
-For more information about the display command, point your browser to file:///usr/share/doc/imagemagick-7-common/html/www/display.html (on debian system you may install the imagemagick-7 package) or https://www.imagemagick.org/script/display.php.
+The \fBdisplay-im7.q16\fP program is a member of the
+.BR ImageMagick-ims7.q16 (1)
+suite of tools.
+Use it to display an image or image sequence on any X server.
+
+For more information about the display command,
+point your browser to
+\%file:///usr/share/doc/imagemagick\-7\-common/html/www/display.html
+(on debian system you may install the imagemagick-7 package)
+or \%https://www.imagemagick.org/script/display.php.
 .SH DESCRIPTION
+.TS
+l s
+l l .
 Image Settings:
-  \-alpha option        on, activate, off, deactivate, set, opaque, copy
-                        transparent, extract, background, or shape
-  \-antialias           remove pixel-aliasing
-  \-authenticate value  decrypt image with this password
-  \-backdrop            display image centered on a backdrop
-  \-colormap type       Shared or Private
-  \-colorspace type     alternate image colorspace
-  \-comment string      annotate image with comment
-  \-compress type       type of pixel compression when writing the image
-  \-decipher filename   convert cipher pixels to plain pixels
-  \-deskew threshold    straighten an image
-  \-define format:option
-                       define one or more image format options
-  \-delay centiseconds  display the next image after pausing
-  \-density geometry    horizontal and vertical density of the image
-  \-depth value         image depth
-  \-display server      display image to this X server
-  \-dispose method      layer disposal method
-  \-dither method       apply error diffusion to image
-  \-endian type         endianness (MSB or LSB) of the image
-  \-equalize            perform histogram equalization to an image
-  \-filter type         use this filter when resizing an image
-  \-format "string"     output formatted image characteristics
-  \-fuzz distance       colors within this distance are considered equal
-  \-geometry geometry   preferred size and location of the Image window
-  \-gravity type        horizontal and vertical backdrop placement
-  \-identify            identify the format and characteristics of the image
-  \-immutable           displayed image cannot be modified
-  \-interlace type      type of image interlacing scheme
-  \-interpolate method  pixel color interpolation method
-  \-label string        assign a label to an image
-  \-limit type value    pixel cache resource limit
-  \-loop iterations     loop images then exit
-  \-map type            display image using this Standard Colormap
-  \-matte               store matte channel if the image has one
-  \-monitor             monitor progress
-  \-page geometry       size and location of an image canvas
-  \-profile filename    add, delete, or apply an image profile
-  \-quality value       JPEG/MIFF/PNG compression level
-  \-quantize colorspace reduce colors in this colorspace
-  \-quiet               suppress all warning messages
-  \-regard-warnings     pay attention to warning messages
-  \-remote command      execute a command in an remote display process
-  \-repage geometry     size and location of an image canvas (operator)
-  \-respect-parentheses settings remain in effect until parenthesis boundary
-  \-sampling-factor geometry
-                       horizontal and vertical sampling factor
-  \-scenes range        image scene range
-  \-seed value          seed a new sequence of pseudo-random numbers
-  \-set property value  set an image property
-  \-size geometry       width and height of image
-  \-support factor      resize support: > 1.0 is blurry, < 1.0 is sharp
-  \-texture filename    name of texture to tile onto the image background
-  \-transparent-color color
-                       transparent color
-  \-treedepth value     color tree depth
-  \-update seconds      detect when image file is modified and redisplay
-  \-verbose             print detailed information about the image
-  \-visual type         display image using this visual type
-  \-virtual-pixel method
-                       virtual pixel access method
-  \-window id           display image to background of this window
-  \-window-group id     exit program when this window id is destroyed
-  \-write filename      write image to a file
-
+\-alpha option	T{
+on, activate, off, deactivate, set, opaque, copy
+transparent, extract, background, or shape
+T}
+\-antialias	remove pixel-aliasing
+\-authenticate value	decrypt image with this password
+\-backdrop	display image centered on a backdrop
+\-colormap type	Shared or Private
+\-colorspace type	alternate image colorspace
+\-comment string	annotate image with comment
+\-compress type	type of pixel compression when writing the image
+\-decipher filename	convert cipher pixels to plain pixels
+\-deskew threshold	straighten an image
+.TE
+.TS
+l l .
+\-define format:option	define one or more image format options
+.TE
+.TS
+l l .
+\-delay centiseconds	display the next image after pausing
+\-density geometry	horizontal and vertical density of the image
+\-depth value	image depth
+\-display server	display image to this X server
+\-dispose method	layer disposal method
+\-dither method	apply error diffusion to image
+\-endian type	endianness (MSB or LSB) of the image
+\-equalize	perform histogram equalization to an image
+\-filter type	use this filter when resizing an image
+\-format "string"	output formatted image characteristics
+\-fuzz distance	colors within this distance are considered equal
+\-geometry geometry	preferred size and location of the Image window
+\-gravity type	horizontal and vertical backdrop placement
+\-identify	identify the format and characteristics of the image
+\-immutable	displayed image cannot be modified
+\-interlace type	type of image interlacing scheme
+\-interpolate method	pixel color interpolation method
+\-label string	assign a label to an image
+\-limit type value	pixel cache resource limit
+\-loop iterations	loop images then exit
+\-map type	display image using this Standard Colormap
+\-matte	store matte channel if the image has one
+\-monitor	monitor progress
+\-page geometry	size and location of an image canvas
+\-profile filename	add, delete, or apply an image profile
+\-quality value	JPEG/MIFF/PNG compression level
+\-quantize colorspace	reduce colors in this colorspace
+\-quiet	suppress all warning messages
+\-regard-warnings	pay attention to warning messages
+\-remote command	execute a command in an remote display process
+\-repage geometry	size and location of an image canvas (operator)
+\-respect-parentheses	settings remain in effect until parenthesis boundary
+.TE
+.TS
+l l .
+\-sampling-factor geometry	horizontal and vertical sampling factor
+.TE
+.TS
+l l .
+\-scenes range	image scene range
+\-seed value	seed a new sequence of pseudo-random numbers
+\-set property value	set an image property
+\-size geometry	width and height of image
+\-support factor	resize support: > 1.0 is blurry, < 1.0 is sharp
+\-texture filename	name of texture to tile onto the image background
+.TE
+.TS
+l l .
+\-transparent-color color	transparent color
+.TE
+.TS
+l l .
+\-treedepth value	color tree depth
+\-update seconds	detect when image file is modified and redisplay
+\-verbose	print detailed information about the image
+\-visual type	display image using this visual type
+\-virtual-pixel method	virtual pixel access method
+\-window id	display image to background of this window
+\-window-group id	exit program when this window id is destroyed
+\-write filename	write image to a file
+.TE
+
+.TS
+l s
+l l .
 Image Operators:
-  \-auto-orient         automatically orient image
-  \-border geometry     surround image with a border of color
-  \-channel mask        set the image channel mask
-  \-clip                clip along the first path from the 8BIM profile
-  \-clip-path id        clip along a named path from the 8BIM profile
-  \-colors value        preferred number of colors in the image
-  \-contrast            enhance or reduce the image contrast
-  \-crop geometry       preferred size and location of the cropped image
-  \-despeckle           reduce the speckles within an image
-  \-edge factor         apply a filter to detect edges in the image
-  \-enhance             apply a digital filter to enhance a noisy image
-  \-extent geometry     set the image size
-  \-extract geometry    extract area from image
-  \-flip                flip image in the vertical direction
-  \-flop                flop image in the horizontal direction
-  \-frame geometry      surround image with an ornamental border
-  \-gamma value         level of gamma correction
-  \-monochrome          transform image to black and white
-  \-negate              replace each pixel with its complementary color
-  \-normalize           transform image to span the full range of colors
-  \-raise value         lighten/darken image edges to create a 3-D effect
-  \-resample geometry   change the resolution of an image
-  \-resize geometry     resize the image
-  \-roll geometry       roll an image vertically or horizontally
-  \-rotate degrees      apply Paeth rotation to the image
-  \-sample geometry     scale image with pixel sampling
-  \-segment value       segment an image
-  \-sharpen geometry    sharpen the image
-  \-strip               strip image of all profiles and comments
-  \-threshold value     threshold the image
-  \-thumbnail geometry  create a thumbnail of the image
-  \-trim                trim image edges
-
+\-auto-orient	automatically orient image
+\-border geometry	surround image with a border of color
+\-channel mask	set the image channel mask
+\-clip	clip along the first path from the 8BIM profile
+\-clip-path id	clip along a named path from the 8BIM profile
+\-colors value	preferred number of colors in the image
+\-contrast	enhance or reduce the image contrast
+\-crop geometry	preferred size and location of the cropped image
+\-despeckle	reduce the speckles within an image
+\-edge factor	apply a filter to detect edges in the image
+\-enhance	apply a digital filter to enhance a noisy image
+\-extent geometry	set the image size
+\-extract geometry	extract area from image
+\-flip	flip image in the vertical direction
+\-flop	flop image in the horizontal direction
+\-frame geometry	surround image with an ornamental border
+\-gamma value	level of gamma correction
+\-monochrome	transform image to black and white
+\-negate	replace each pixel with its complementary color
+\-normalize	transform image to span the full range of colors
+\-raise value	lighten/darken image edges to create a 3-D effect
+\-resample geometry	change the resolution of an image
+\-resize geometry	resize the image
+\-roll geometry	roll an image vertically or horizontally
+\-rotate degrees	apply Paeth rotation to the image
+\-sample geometry	scale image with pixel sampling
+\-segment value	segment an image
+\-sharpen geometry	sharpen the image
+\-strip	strip image of all profiles and comments
+\-threshold value	threshold the image
+\-thumbnail geometry	create a thumbnail of the image
+\-trim	trim image edges
+.TE
+
+.TS
+l s
+l l .
 Image Sequence Operators:
-  \-coalesce            merge a sequence of images
-  \-flatten             flatten a sequence of images
+\-coalesce	merge a sequence of images
+\-flatten	flatten a sequence of images
 
+.T&
+l s
+l l .
 Miscellaneous Options:
-  \-debug events        display copious debugging information
-  \-help                print program options
-  \-log format          format of debugging information
-  \-list type           print a list of supported option arguments
-  \-version             print version information
+\-debug events	display copious debugging information
+\-help	print program options
+\-log format	format of debugging information
+\-list type	print a list of supported option arguments
+\-version	print version information
+.TE
+
+In addition to those listed above,
+you can specify these standard X resources as command line options:
+\-background, \-bordercolor, \-borderwidth, \-font, \-foreground,
+\-iconGeometry, \-iconic, \-mattecolor, \-name, \-shared-memory,
+\-usePixmap, or \-title.
+
+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.
 
-In addition to those listed above, you can specify these standard X resources as command line options:  \-background, \-bordercolor, \-borderwidth, \-font, \-foreground, \-iconGeometry, \-iconic, \-mattecolor, \-name, \-shared-memory, \-usePixmap, or \-title.
-
-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.
-
-Buttons: 
+Buttons:
+.nf
   1    press to map or unmap the Command widget
   2    press and drag to magnify a region of an image
   3    press to load an image from a visual image directory
+.fi
 .SH NOTE
-The display program defaults to the X screen resolution.  To display vector formats at their intended size, override the default resolution:
-
+The display program defaults to the X screen resolution.
+To display vector formats at their intended size,
+override the default resolution:
+.nf
   display -density 72 drawing.svg
+.fi
 .SH SEE ALSO
-ImageMagick-im7.q16(1)
+.BR ImageMagick-im7.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-7-common/html/www/license.html (on debian system you may install the imagemagick-7 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\-7\-common/html/www/license.html
+(on debian system you may install the imagemagick-7 package)
+or \%https://www.imagemagick.org/script/license.php\fP
-------------- 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

-.-

  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.

  "git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")

  Not beginning each input sentence on a new line.
Line length and patch size 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 -d -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 -d -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)

-.-


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