]> granicus.if.org Git - imagemagick/blob - utilities/compare.1
(no commit message)
[imagemagick] / utilities / compare.1
1 .TH compare 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
2 .SH NAME
3 compare \- mathematically and visually annotate the difference between an image and its reconstruction.
4 .SH SYNOPSIS
5 .TP
6 \fBcompare\fP \fIinput-file\fP \fIinput-file\fP [\fIoptions\fP] \fIoutput-file\fP
7 .SH OVERVIEW
8 The \fBcompare\fP program is a member of the ImageMagick(1) suite of tools.  Use it to mathematically and visually annotate the difference between an image and its reconstruction.
9
10 For more information about the compare command, point your browser to file:///usr/share/doc/ImageMagick-7/www/compare.html or http://www.imagemagick.org/script/compare.php.
11 .SH DESCRIPTION
12 Image Settings:
13   \-alpha option        on, activate, off, deactivate, set, opaque, copy
14   \                     transparent, extract, background, or shape
15   \-authenticate value  decrypt image with this password
16   \-channel type        apply option to select image channels
17   \-colorspace type     alternate image colorspace
18   \-compose operator    set image composite operator
19   \-compress type       type of pixel compression when writing the image
20   \-decipher filename   convert cipher pixels to plain pixels
21   \-define format:option
22                        define one or more image format options
23   \-density geometry    horizontal and vertical density of the image
24   \-depth value         image depth
25   \-dissimilarity-threshold value
26                         maximum distortion for (sub)image match
27   \-encipher filename   convert plain pixels to cipher pixels
28   \-extract geometry    extract area from image
29   \-format "string"     output formatted image characteristics
30   \-fuzz distance       colors within this distance are considered equal
31   \-identify            identify the format and characteristics of the image
32   \-interlace type      type of image interlacing scheme
33   \-highlight-color color
34                        emphasize pixel differences with this color
35   \-limit type value    pixel cache resource limit
36   \-lowlight-color color
37                        de-emphasize pixel differences with this color
38   \-metric type         measure differences between images with this metric
39   \-monitor             monitor progress
40   \-profile filename    add, delete, or apply an image profile
41   \-quality value       JPEG/MIFF/PNG compression level
42   \-quiet               suppress all warning messages
43   \-quantize colorspace reduce colors in this colorspace
44   \-regard-warnings     pay attention to warning messages
45   \-respect-parentheses settings remain in effect until parenthesis boundary
46   \-sampling-factor geometry
47                        horizontal and vertical sampling factor
48   \-seed value          seed a new sequence of pseudo-random numbers
49   \-set attribute value set an image attribute
50   \-similarity-threshold value
51                         minimum distortion for (sub)image match
52   \-size geometry       width and height of image
53   \-subimage-search     search for subimage
54   \-synchronize         synchronize image to storage device
55   \-taint               declare the image as modified
56   \-transparent-color color
57                        transparent color
58   \-type type           image type
59   \-verbose             print detailed information about the image
60   \-virtual-pixel method
61                        virtual pixel access method
62
63 Miscellaneous Options:
64   \-debug events        display copious debugging information
65   \-help                print program options
66   \-log format          format of debugging information
67   \-list type           print a list of supported option arguments
68   \-version             print version information
69
70 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.
71
72 The compare program returns 2 on error otherwise 0 if the images are similar or
73 1 if they are dissimilar.
74 .SH SEE ALSO
75 ImageMagick(1)
76
77 .SH COPYRIGHT
78
79 \fBCopyright (C) 1999-2014 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/share/doc/ImageMagick-7/www/license.html or http://www.imagemagick.org/script/license.php\fP