[Pkg-gmagick-im-team] Bug#1099614: convert-im7.q16.1: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Wed Mar 5 17:51:17 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>:145: 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 convert-im7.q16.1
Output from "mandoc -T lint convert-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: The \fBconvert-im7.q...
1 input text line longer than 80 bytes: Use any setting or o...
1 input text line longer than 80 bytes: convert \- convert b...
2 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-nroff -mandoc -t -ww -z convert-im7.q16.1": (shortened list)
2 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
2
-.-.
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-im7.q16.1:340:\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 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.
convert-im7.q16.1:13: \-adjoin join images into a single multi-image file
[ plus lines until nr. 330]
-.-.
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.
223: pixel value less than |epsilon| become epsilon or -epsilon
334: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 URL (web address)
10 For more information about the convert command, point your browser to file:///usr/share/doc/imagemagick-7-common/html/www/convert.html (on debian system you may install the imagemagick-7 package) or https://www.imagemagick.org/script/convert.php.
340 \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.
48: \-features distance analyze image features (e.g. contrast, correlation)
334: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 \fBconvert-im7.q16\fP program is a member of the ImageMagick-ims7.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.
48: \-features distance analyze image features (e.g. contrast, correlation)
332: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.
334: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.
340:\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 3, length 146
convert \- convert between image formats as well as resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, and much more.
Line 6, length 108
\fBmagick-im7.q16 convert\fP [\fIinput-options\fP] \fIinput-file\fP [\fIoutput-options\fP] \fIoutput-file\fP
Line 8, length 239
The \fBconvert-im7.q16\fP program is a member of the ImageMagick-ims7.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.
Line 10, length 246
For more information about the convert command, point your browser to file:///usr/share/doc/imagemagick-7-common/html/www/convert.html (on debian system you may install the imagemagick-7 package) or https://www.imagemagick.org/script/convert.php.
Line 94, length 92
replace each pixel with corresponding statistic from the neighborhood
Line 133, length 88
non-linear, edge-preserving, and noise-reducing smoothing filter
Line 154, length 83
force all pixels in the color range to white otherwise black
Line 203, length 91
improve contrast by `stretching with saturation' the intensity range
Line 208, length 83
\-mode geometry make each pixel the 'predominant color' of the neighborhood
Line 223, length 81
pixel value less than |epsilon| become epsilon or -epsilon
Line 234, length 103
perform either hard or soft thresholding within some range of values in an image
Line 291, length 94
\-append append an image sequence top to bottom (use +append for left to right)
Line 295, length 115
\-compare mathematically and visually annotate the difference between an image and its reconstruction
Line 309, length 126
\-poly terms build a polynomial from the image sequence and the corresponding terms (coefficients and degree pairs)
Line 332, length 272
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.
Line 334, 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 340, 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).
336:ImageMagick-im7.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).
77: \-pointsize value font point size
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
convert-im7.q16.1:10:For more information about the convert command, point your browser to file:///usr/share/doc/imagemagick-7-common/html/www/convert.html (on debian system you may install the imagemagick-7 package) or https://www.imagemagick.org/script/convert.php.
convert-im7.q16.1:334: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.
convert-im7.q16.1:340:\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.
convert-im7.q16.1:8:The \fBconvert-im7.q16\fP program is a member of the ImageMagick-ims7.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.
convert-im7.q16.1:48: \-features distance analyze image features (e.g. contrast, correlation)
convert-im7.q16.1:332: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.
convert-im7.q16.1:334: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.
convert-im7.q16.1:340:\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.
convert-im7.q16.1:3: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-im7.q16.1:8:The \fBconvert-im7.q16\fP program is a member of the ImageMagick-ims7.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.
convert-im7.q16.1:10:For more information about the convert command, point your browser to file:///usr/share/doc/imagemagick-7-common/html/www/convert.html (on debian system you may install the imagemagick-7 package) or https://www.imagemagick.org/script/convert.php.
convert-im7.q16.1:332: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.
convert-im7.q16.1:334: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.
convert-im7.q16.1:340:\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.
convert-im7.q16.1:1:.TH convert-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>:145: warning: trailing space in the line
[...]
troff:<stdin>:215: warning: trailing space in the line
[...]
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-------------- next part --------------
--- convert-im7.q16.1 2025-03-05 12:01:26.586078614 +0000
+++ convert-im7.q16.1.new 2025-03-05 17:44:43.480029685 +0000
@@ -1,340 +1,555 @@
-.TH convert-im7.q16 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
+.TH convert-im7.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
\fBmagick-im7.q16 convert\fP [\fIinput-options\fP] \fIinput-file\fP [\fIoutput-options\fP] \fIoutput-file\fP
.SH OVERVIEW
-The \fBconvert-im7.q16\fP program is a member of the ImageMagick-ims7.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-im7.q16\fP program is a member of the
+ImageMagick-ims7.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-7-common/html/www/convert.html (on debian system you may install the imagemagick-7 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\-7\-common/html/www/convert.html
+(on debian system you may install the imagemagick\-7 package)
+or \%https://www.imagemagick.org/script/convert.php.
.SH DESCRIPTION
+.TS
+l .
Image Settings:
- \-adjoin join images into a single multi-image file
- \-affine matrix affine transform matrix
- \-alpha option activate, deactivate, reset, or set the alpha channel
- \-antialias remove pixel-aliasing
- \-authenticate value decrypt image with this password
- \-attenuate value lessen (or intensify) when adding noise to an image
- \-background color background color
- \-bias value add bias when convolving an image
- \-black-point-compensation
- use black point compensation
- \-blue-primary point chromaticity blue primary point
- \-bordercolor color border color
- \-caption string assign a caption to an image
- \-cdl filename color correct with a color decision list
- \-clip clip along the first path from the 8BIM profile
- \-clip-mask filename associate a clip mask with the image
- \-clip-path id clip along a named path from the 8BIM profile
- \-colorspace type alternate image colorspace
- \-comment string annotate image with comment
- \-compose operator set image composite operator
- \-compress type type of pixel compression when writing the image
- \-decipher filename convert cipher pixels to plain pixels
- \-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
- \-direction type render text right-to-left or left-to-right
- \-display server get image or font from this X server
- \-dispose method layer disposal method
- \-dither method apply error diffusion to image
- \-encipher filename convert plain pixels to cipher pixels
- \-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)
- \-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
- \-font name render text with this font
- \-format "string" output formatted image characteristics
- \-fuzz distance colors within this distance are considered equal
- \-gravity type horizontal and vertical text placement
- \-green-primary point chromaticity green primary point
- \-intensity method method to generate intensity value from pixel
- \-intent type type of rendering intent when managing the image color
- \-interlace type type of image interlacing scheme
- \-interline-spacing value
- set the space between two text lines
- \-interpolate method pixel color interpolation method
- \-interword-spacing value
- set the space between two words
- \-kerning value set the space between two letters
- \-label string assign a label to an image
- \-limit type value pixel cache resource limit
- \-loop iterations add Netscape loop extension to your GIF animation
- \-matte store matte channel if the image has one
- \-mattecolor color frame color
- \-metric type measure differences between images with this metric
- \-moments report image moments
- \-monitor monitor progress
- \-orient type image orientation
- \-page geometry size and location of an image canvas (setting)
- \-ping efficiently determine image attributes
- \-pointsize value font point size
- \-precision value maximum number of significant digits to print
- \-preview type image preview type
- \-quality value JPEG/MIFF/PNG compression level
- \-quiet suppress all warning messages
- \-read-mask filename associate a read mask with the image
- \-red-primary point chromaticity red primary point
- \-regard-warnings pay attention to warning messages
- \-remap filename transform image colors to match this set of colors
- \-repage geometry size and location of an image canvas
- \-respect-parentheses settings remain in effect until parenthesis boundary
- \-sampling-factor geometry
- horizontal and vertical sampling factor
- \-scene value image scene number
- \-seed value seed a new sequence of pseudo-random numbers
- \-size geometry width and height of image
- \-statistic type geometry
- replace each pixel with corresponding statistic from the neighborhood
- \-stretch type render text with this font stretch
- \-stroke color graphic primitive stroke color
- \-strokewidth value graphic primitive stroke width
- \-style type render text with this font style
- \-support factor resize support: > 1.0 is blurry, < 1.0 is sharp
- \-synchronize synchronize image to storage device
- \-taint declare the image as modified
- \-texture filename name of texture to tile onto the image background
- \-tile-offset geometry
- tile offset
- \-treedepth value color tree depth
- \-transparent-color color
- transparent color
- \-undercolor color annotation bounding box color
- \-units type the units of image resolution
- \-verbose print detailed information about the image
- \-virtual-pixel method
- virtual pixel access method
- \-weight type render text with this font weight
- \-white-point point chromaticity white point
- \-write-mask filename associate a write mask with the image
+.TE
+.TS
+l lw(50n) .
+\-adjoin join images into a single multi-image file
+\-affine matrix affine transform matrix
+\-alpha option T{
+activate, deactivate, reset, or set the alpha channel.
+T}
+\-antialias remove pixel-aliasing
+\-authenticate value decrypt image with this password
+\-attenuate value T{
+lessen (or intensify) when adding noise to an image
+T}
+\-background color background color
+\-bias value add bias when convolving an image
+.TE
+.\" New table for a wide first column
+.TS
+l l .
+\-black-point-compensation use black point compensation
+.TE
+.TS
+l l .
+\-blue-primary point chromaticity blue primary point
+\-bordercolor color border color
+\-caption string assign a caption to an image
+\-cdl filename color correct with a color decision list
+\-clip clip along the first path from the 8BIM profile
+\-clip-mask filename associate a clip mask with the image
+\-clip-path id clip along a named path from the 8BIM profile
+\-colorspace type alternate image colorspace
+\-comment string annotate image with comment
+\-compose operator set image composite operator
+\-compress type T{
+type of pixel compression when writing the image
+T}
+\-decipher filename convert cipher pixels to plain pixels
+\-define format:option T{
+define one or more image format options
+T}
+\-delay centiseconds display the next image after pausing
+\-density geometry horizontal and vertical density of the image
+\-depth value image depth
+\-direction type render text right-to-left or left-to-right
+\-display server get image or font from this X server
+\-dispose method layer disposal method
+\-dither method apply error diffusion to image
+\-encipher filename convert plain pixels to cipher pixels
+\-encoding type text encoding type
+\-endian type endianness (MSB or LSB) of the image
+\-family name render text with this font family
+\-features distance T{
+analyze image features (e.g.\& contrast, correlation)
+T}
+\-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
+\-font name render text with this font
+\-format "string" output formatted image characteristics
+\-fuzz distance colors within this distance are considered equal
+\-gravity type horizontal and vertical text placement
+\-green-primary point chromaticity green primary point
+\-intensity method method to generate intensity value from pixel
+\-intent type T{
+type of rendering intent when managing the image color
+T}
+\-interlace type type of image interlacing scheme
+.TE
+.\" New table for wide first column
+.TS
+l l .
+\-interline-spacing value set the space between two text lines
+\-interpolate method pixel color interpolation method
+\-interword-spacing value T{
+set the space between two words
+T}
+.TE
+.TS
+l l .
+\-kerning value set the space between two letters
+\-label string assign a label to an image
+\-limit type value pixel cache resource limit
+\-loop iterations T{
+add Netscape loop extension to your GIF animation
+T}
+\-matte store matte channel if the image has one
+\-mattecolor color frame color
+\-metric type T{
+measure differences between images with this metric
+T}
+\-moments report image moments
+\-monitor monitor progress
+\-orient type image orientation
+\-page geometry size and location of an image canvas (setting)
+\-ping efficiently determine image attributes
+\-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
+\-quiet suppress all warning messages
+\-read-mask filename associate a read mask with the image
+\-red-primary point chromaticity red primary point
+\-regard-warnings pay attention to warning messages
+\-remap filename T{
+transform image colors to match this set of colors
+T}
+\-repage geometry size and location of an image canvas
+\-respect-parentheses T{
+settings remain in effect until parenthesis boundary
+T}
+.TE
+.TS
+l l .
+\-sampling-factor geometry T{
+horizontal and vertical sampling factor
+T}
+.TE
+.TS
+l l .
+\-scene value image scene number
+\-seed value seed a new sequence of pseudo-random numbers
+\-size geometry width and height of image
+\-statistic type geometry T{
+replace each pixel with corresponding statistic from the neighborhood
+T}
+\-stretch type render text with this font stretch
+\-stroke color graphic primitive stroke color
+\-strokewidth value graphic primitive stroke width
+\-style type render text with this font style
+\-support factor resize support: > 1.0 is blurry, < 1.0 is sharp
+\-synchronize synchronize image to storage device
+\-taint declare the image as modified
+\-texture filename T{
+name of texture to tile onto the image background
+T}
+\-tile-offset geometry T{
+tile offset
+T}
+\-treedepth value color tree depth
+\-transparent-color color T{
+transparent color
+T}
+\-undercolor color annotation bounding box color
+\-units type the units of image resolution
+\-verbose print detailed information about the image
+\-virtual-pixel method T{
+virtual pixel access method
+T}
+\-weight type render text with this font weight
+\-white-point point chromaticity white point
+\-write-mask filename associate a write mask with the image
+.TE
-Image Operators:
- \-adaptive-blur geometry
- adaptively blur pixels; decrease effect near edges
- \-adaptive-resize geometry
- adaptively resize image with data dependent triangulation
- \-adaptive-sharpen geometry
- adaptively sharpen pixels; increase effect near edges
- \-annotate geometry text
- annotate the image with text
- \-auto-gamma automagically adjust gamma level of image
- \-auto-level automagically adjust color levels of image
- \-auto-orient automatically orient image
- \-auto-threshold method
- automatically perform image thresholding
- \-bench iterations measure performance
- \-bilateral-blur geometry
- non-linear, edge-preserving, and noise-reducing smoothing filter
- \-black-threshold value
- force all pixels below the threshold into black
- \-blue-shift factor simulate a scene at nighttime in the moonlight
- \-blur geometry reduce image noise and reduce detail levels
- \-border geometry surround image with a border of color
- \-brightness-contrast geometry
- improve brightness / contrast of the image
- \-canny geometry detect edges in the image
- \-channel mask set the image channel mask
- \-charcoal radius simulate a charcoal drawing
- \-chop geometry remove pixels from the image interior
- \-clahe geometry contrast limited adaptive histogram equalization
- \-clamp keep pixel values in range (0-QuantumRange)
- \-clip clip along the first path from the 8BIM profile
- \-clip-mask filename associate a clip mask with the image
- \-clip-path id clip along a named path from the 8BIM profile
- \-colorize value colorize the image with the fill color
- \-color-matrix matrix apply color correction to the image
- \-colors value preferred number of colors in the image
- \-color-threshold start_color-stop_color
- force all pixels in the color range to white otherwise black
- \-connected-component connectivity
- connected-components uniquely labeled
- \-contrast enhance or reduce the image contrast
- \-contrast-stretch geometry
- improve contrast by `stretching' the intensity range
- \-convolve coefficients
- apply a convolution kernel to the image
- \-cycle amount cycle the image colormap
- \-deskew threshold straighten an image
- \-despeckle reduce the speckles within an image
- \-distort method args
- distort images according to given method and args
- \-draw string annotate the image with a graphic primitive
- \-edge radius apply a filter to detect edges in the image
- \-emboss radius emboss an image
- \-enhance apply a digital filter to enhance a noisy image
- \-equalize perform histogram equalization to an image
- \-evaluate operator value
- evaluate an arithmetic, relational, or logical expression
- \-extent geometry set the image size
- \-extract geometry extract area from image
- \-fft implements the discrete Fourier transform (DFT)
- \-flip flip image vertically
- \-floodfill geometry color
- floodfill the image with color
- \-flop flop image horizontally
- \-frame geometry surround image with an ornamental border
- \-function name apply a function to the image
- \-gamma value level of gamma correction
- \-gaussian-blur geometry
- reduce image noise and reduce detail levels
- \-geometry geometry preferred size or location of the image
- \-grayscale method convert image to grayscale
- \-hough-lines geometry
- identify lines in the image
- \-identify identify the format and characteristics of the image
- \-ift implements the inverse discrete Fourier transform (DFT)
- \-implode amount implode image pixels about the center
- \-integral calculate the sum of values (pixel values) in the image
- \-interpolative-resize geometry
- resize image using interpolation
- \-kmeans geometry K means color reduction
- \-lat geometry local adaptive thresholding
- \-layers method optimize or compare image layers
- \-level value adjust the level of image contrast
- \-level-colors color,color
- level image with the given colors
- \-linear-stretch geometry
- improve contrast by `stretching with saturation' the intensity range
- \-liquid-rescale geometry
- rescale image with seam-carving
- \-mean-shift geometry delineate arbitrarily shaped clusters in the image
- \-median geometry apply a median filter to the image
- \-mode geometry make each pixel the 'predominant color' of the neighborhood
- \-modulate value vary the brightness, saturation, and hue
- \-monochrome transform image to black and white
- \-morphology method kernel
- apply a morphology method to the image
- \-motion-blur geometry
- simulate motion blur
- \-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
- \-ordered-dither NxN
- 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
- \-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
- \-profile filename add, delete, or apply an image profile
- \-quantize colorspace reduce colors in this colorspace
- \-radial-blur angle radial blur the image
- \-raise value lighten/darken image edges to create a 3-D effect
- \-random-threshold low,high
- random threshold the image
- \-range-threshold values
- perform either hard or soft thresholding within some range of values in an image
- \-region geometry apply options to a portion of the image
- \-render render vector graphics
- \-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
- \-scale geometry scale the image
- \-segment values segment an image
- \-selective-blur geometry
- selectively blur pixels within a contrast threshold
- \-sepia-tone threshold
- simulate a sepia-toned photo
- \-set property value set an image property
- \-shade degrees shade the image using a distant light source
- \-shadow geometry simulate an image shadow
- \-sharpen geometry sharpen the image
- \-shave geometry shave pixels from the image edges
- \-shear geometry slide one edge of the image along the X or Y axis
- \-sigmoidal-contrast geometry
- lightness rescaling using sigmoidal contrast enhancement
- \-sketch geometry simulate a pencil sketch
- \-solarize threshold negate all pixels above the threshold level
- \-sort-pixels sort each scanline in ascending order of intensity
- \-sparse-color method args
- fill in a image based on a few color points
- \-splice geometry splice the background color into the image
- \-spread amount displace image pixels by a random amount
- \-strip strip image of all profiles and comments
- \-swirl degrees swirl image pixels about the center
- \-threshold value threshold the image
- \-thumbnail geometry create a thumbnail of the image
- \-tile filename tile image when filling a graphic primitive
- \-tint value tint the image with the fill color
- \-transform affine transform image
- \-transparent color make this color transparent within the image
- \-transpose flip image vertically and rotate 90 degrees
- \-transverse flop image horizontally and rotate 270 degrees
- \-trim trim image edges
- \-type type image type
- \-unique-colors discard all but one of any pixel color
- \-unsharp geometry sharpen the image
- \-vignette geometry soften the edges of the image in vignette style
- \-wave geometry alter an image along a sine wave
- \-wavelet-denoise threshold
- removes noise from the image using a wavelet transform
- \-white-balance automagically adjust white balance of image
- \-white-threshold value
- force all pixels above the threshold into white
+.TS
+l l .
+Image Operators: \&
+\-adaptive-blur geometry T{
+adaptively blur pixels; decrease effect near edges
+T}
+\-adaptive-resize geometry T{
+adaptively resize image with data dependent triangulation
+T}
+\-adaptive-sharpen geometry T{
+adaptively sharpen pixels; increase effect near edges
+T}
+\-annotate geometry text T{
+annotate the image with text
+T}
+\-auto-gamma automagically adjust gamma level of image
+\-auto-level automagically adjust color levels of image
+\-auto-orient automatically orient image
+\-auto-threshold method T{
+automatically perform image thresholding
+T}
+\-bench iterations measure performance
+\-bilateral-blur geometry T{
+non-linear, edge-preserving, and noise-reducing smoothing filter
+T}
+\-black-threshold value T{
+force all pixels below the threshold into black
+T}
+\-blue-shift factor simulate a scene at nighttime in the moonlight
+\-blur geometry reduce image noise and reduce detail levels
+\-border geometry surround image with a border of color
+.TE
+.\" New table for wide first column
+.TS
+l l .
+\-brightness-contrast geometry improve brightness / contrast of the image
+.TE
+.TS
+l l .
+\-canny geometry detect edges in the image
+\-channel mask set the image channel mask
+\-charcoal radius simulate a charcoal drawing
+\-chop geometry remove pixels from the image interior
+\-clahe geometry contrast limited adaptive histogram equalization
+\-clamp keep pixel values in range (0-QuantumRange)
+\-clip clip along the first path from the 8BIM profile
+\-clip-mask filename associate a clip mask with the image
+\-clip-path id clip along a named path from the 8BIM profile
+\-colorize value colorize the image with the fill color
+\-color-matrix matrix apply color correction to the image
+\-colors value preferred number of colors in the image
+.TE
+\" News table for wide first column
+.TS
+l l .
+\-color-threshold start_color-stop_color T{
+force all pixels in the color range to white otherwise black
+T}
+\-connected-component connectivity T{
+connected-components uniquely labeled
+T}
+.TE
+.TS
+l l .
+\-contrast enhance or reduce the image contrast
+.TE
+.\" New table for wide first column
+.TS
+l l .
+\-contrast-stretch geometry T{
+improve contrast by `stretching' the intensity range
+T}
+.TE
+.TS
+l l .
+\-convolve coefficients apply a convolution kernel to the image
+\-cycle amount cycle the image colormap
+\-deskew threshold straighten an image
+\-despeckle reduce the speckles within an image
+\-distort method args T{
+distort images according to given method and args
+T}
+\-draw string annotate the image with a graphic primitive
+\-edge radius apply a filter to detect edges in the image
+\-emboss radius emboss an image
+\-enhance apply a digital filter to enhance a noisy image
+\-equalize perform histogram equalization to an image
+\-evaluate operator value T{
+evaluate an arithmetic, relational, or logical expression
+T}
+\-extent geometry set the image size
+\-extract geometry extract area from image
+\-fft implements the discrete Fourier transform (DFT)
+\-flip flip image vertically
+\-floodfill geometry color floodfill the image with color
+\-flop flop image horizontally
+\-frame geometry surround image with an ornamental border
+\-function name apply a function to the image
+\-gamma value level of gamma correction
+\-gaussian-blur geometry reduce image noise and reduce detail levels
+\-geometry geometry preferred size or location of the image
+\-grayscale method convert image to grayscale
+\-hough-lines geometry identify lines in the image
+\-identify T{
+identify the format and characteristics of the image
+T}
+\-ift T{
+implements the inverse discrete Fourier transform (DFT)
+T}
+\-implode amount implode image pixels about the center
+\-integral T{
+calculate the sum of values (pixel values) in the image
+T}
+.TE
+.\" New table for wide first column
+.TS
+l l .
+\-interpolative-resize geometry resize image using interpolation
+.TE
+.TS
+l l .
+\-kmeans geometry K means color reduction
+\-lat geometry local adaptive thresholding
+\-layers method optimize or compare image layers
+\-level value adjust the level of image contrast
+\-level-colors color,color level image with the given colors
+.TE
+.\" New table for a wide first column
+.TS
+l l .
+\-linear-stretch geometry T{
+improve contrast by `stretching with saturation' the intensity range
+T}
+\-liquid-rescale geometry rescale image with seam-carving
+\-mean-shift geometry T{
+delineate arbitrarily shaped clusters in the image
+T}
+.TE
+.TS
+l l .
+\-median geometry apply a median filter to the image
+\-mode geometry T{
+make each pixel the 'predominant color' of the neighborhood
+T}
+\-modulate value vary the brightness, saturation, and hue
+\-monochrome transform image to black and white
+.TE
+.\" New table
+.TS
+l l .
+\-morphology method kernel apply a morphology method to the image
+\-motion-blur geometry simulate motion blur
+.TE
+.TS
+l l .
+\-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
+\-ordered-dither NxN T{
+add a noise pattern to the image with specific amplitudes
+T}
+\-paint radius simulate an oil painting
+\-perceptible epsilon T{
+pixel value less than |epsilon| become epsilon or \-epsilon
+T}
+\-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
+\-profile filename add, delete, or apply an image profile
+\-quantize colorspace reduce colors in this colorspace
+\-radial-blur angle radial blur the image
+\-raise value lighten/darken image edges to create a 3-D effect
+.TE
+.\" New table for a wide first columns
+.TS
+l l .
+\-random-threshold low,high random threshold the image
+\-range-threshold values T{
+perform either hard
+or soft thresholding within some range of values in an image
+T}
+.TE
+.TS
+l l .
+\-region geometry apply options to a portion of the image
+\-render render vector graphics
+\-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
+\-scale geometry scale the image
+\-segment values segment an image
+.TE
+.\" New table
+.TS
+l l .
+\-selective-blur geometry T{
+selectively blur pixels within a contrast threshold
+T}
+.TE
+.TS
+l l .
+\-sepia-tone threshold simulate a sepia-toned photo
+\-set property value set an image property
+\-shade degrees shade the image using a distant light source
+\-shadow geometry simulate an image shadow
+\-sharpen geometry sharpen the image
+\-shave geometry shave pixels from the image edges
+\-shear geometry slide one edge of the image along the X or Y axis
+.TE
+.\" New table for wide first column
+.TS
+l l .
+\-sigmoidal-contrast geometry T{
+lightness rescaling using sigmoidal contrast enhancement
+T}
+.TE
+.TS
+l l .
+\-sketch geometry simulate a pencil sketch
+\-solarize threshold negate all pixels above the threshold level
+\-sort-pixels T{
+sort each scanline in ascending order of intensity
+T}
+.TE
+.\" New table
+.TS
+l l .
+\-sparse-color method args fill in a image based on a few color points
+.TE
+.TS
+l l .
+\-splice geometry splice the background color into the image
+\-spread amount displace image pixels by a random amount
+\-strip strip image of all profiles and comments
+\-swirl degrees swirl image pixels about the center
+\-threshold value threshold the image
+\-thumbnail geometry create a thumbnail of the image
+\-tile filename tile image when filling a graphic primitive
+\-tint value tint the image with the fill color
+\-transform affine transform image
+\-transparent color make this color transparent within the image
+\-transpose flip image vertically and rotate 90 degrees
+\-transverse flop image horizontally and rotate 270 degrees
+\-trim trim image edges
+\-type type image type
+\-unique-colors discard all but one of any pixel color
+\-unsharp geometry sharpen the image
+\-vignette geometry soften the edges of the image in vignette style
+\-wave geometry alter an image along a sine wave
+.TE
+.\" New table
+.TS
+l l .
+\-wavelet-denoise threshold T{
+removes noise from the image using a wavelet transform
+T}
+\-white-balance automagically adjust white balance of image
+\-white-threshold value T{
+force all pixels above the threshold into white
+T}
+.TE
-Image Channel Operators:
- \-channel-fx expression
- exchange, extract, or transfer one or more image channels
- \-separate separate an image channel into a grayscale image
+.TS
+l l .
+Image Channel Operators: \&
+\-channel-fx expression T{
+exchange, extract, or transfer one or more image channels
+T}
+\-separate separate an image channel into a grayscale image
+.TE
-Image Sequence Operators:
- \-append append an image sequence top to bottom (use +append for left to right)
- \-clut apply a color lookup table to the image
- \-coalesce merge a sequence of images
- \-combine combine a sequence of images
- \-compare mathematically and visually annotate the difference between an image and its reconstruction
- \-complex operator perform complex mathematics on an image sequence
- \-composite composite image
- \-copy geometry offset,
- copy pixels from one area of an image to another
- \-crop geometry cut out a rectangular region of the image
- \-deconstruct break down an image sequence into constituent parts
- \-evaluate-sequence operator
- evaluate an arithmetic, relational, or logical expression
- \-flatten flatten a sequence of images
- \-fx expression apply mathematical expression to an image channel(s)
- \-hald-clut apply a Hald color lookup table to the image
- \-morph value morph an image sequence
- \-mosaic create a mosaic from an image sequence
- \-poly terms build a polynomial from the image sequence and the corresponding terms (coefficients and degree pairs)
- \-process arguments process the image with a custom image filter
- \-smush geometry smush an image sequence together
- \-write filename write images to this file
+.TS
+l l .
+Image Sequence Operators: \&
+.TE
+.TS
+l l .
+\-append T{
+append an image sequence top to bottom (use +append for left to right)
+T}
+\-clut apply a color lookup table to the image
+\-coalesce merge a sequence of images
+\-combine combine a sequence of images
+\-compare T{
+mathematically and visually annotate the difference between an image and its reconstruction
+T}
+\-complex operator perform complex mathematics on an image sequence
+\-composite composite image
+.TE
+.\" New table
+.TS
+l l .
+\-copy geometry offset, T{
+copy pixels from one area of an image to another
+T}
+.TE
+.TS
+l l .
+\-crop geometry cut out a rectangular region of the image
+\-deconstruct break down an image sequence into constituent parts
+.TE
+.TS
+l l .
+\-evaluate-sequence operator T{
+evaluate an arithmetic, relational, or logical expression
+T}
+.TE
+.TS
+l l .
+\-flatten flatten a sequence of images
+\-fx expression apply mathematical expression to an image channel(s)
+\-hald-clut apply a Hald color lookup table to the image
+\-morph value morph an image sequence
+\-mosaic create a mosaic from an image sequence
+\-poly terms T{
+build a polynomial from the image sequence and the corresponding terms
+(coefficients and degree pairs)
+T}
+\-process arguments process the image with a custom image filter
+\-smush geometry smush an image sequence together
+\-write filename write images to this file
+.TE
-Image Stack Operators:
- \-clone indexes clone an image
- \-delete indexes delete the image from the image sequence
- \-duplicate count,indexes
- duplicate an image one or more times
- \-insert index insert last image into the image sequence
- \-reverse reverse image sequence
- \-swap indexes swap two images in the image sequence
+.TS
+l l .
+Image Stack Operators: \&
+\-clone indexes clone an image
+\-delete indexes delete the image from the image sequence
+\-duplicate count,indexes T{
+duplicate an image one or more times
+T}
+\-insert index insert last image into the image sequence
+\-reverse reverse image sequence
+\-swap indexes swap two images in the image sequence
+.TE
-Miscellaneous Options:
- \-debug events display copious debugging information
- \-distribute-cache port
- distributed pixel cache spanning one or more servers
- \-help print program options
- \-log format format of debugging information
- \-list type print a list of supported option arguments
- \-version print version information
+.TS
+l l .
+Miscellaneous Options: \&
+\-debug events display copious debugging information
+\-distribute-cache port T{
+distributed pixel cache spanning one or more servers
+T}
+\-help print program options
+\-log format format of debugging information
+\-list type print a list of supported option arguments
+\-version print version information
+.TE
-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-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