granicus.if.org Git - imagemagick/blob - utilities/compare.1.in

   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://@DOCUMENTATION_PATH@/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   \-colorspace type     alternate image colorspace
  17   \-compose operator    set image composite operator
  18   \-compress type       type of pixel compression when writing the image
  19   \-decipher filename   convert cipher pixels to plain pixels
  20   \-define format:option
  21                        define one or more image format options
  22   \-density geometry    horizontal and vertical density of the image
  23   \-depth value         image depth
  24   \-dissimilarity-threshold value
  25                         maximum distortion for (sub)image match
  26   \-encipher filename   convert plain pixels to cipher pixels
  27   \-extract geometry    extract area from image
  28   \-format "string"     output formatted image characteristics
  29   \-fuzz distance       colors within this distance are considered equal
  30   \-identify            identify the format and characteristics of the image
  31   \-interlace type      type of image interlacing scheme
  32   \-highlight-color color
  33                        emphasize pixel differences with this color
  34   \-limit type value    pixel cache resource limit
  35   \-lowlight-color color
  36                        de-emphasize pixel differences with this color
  37   \-metric type         measure differences between images with this metric
  38   \-monitor             monitor progress
  39   \-negate              replace each pixel with its complementary color
  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   \-read-mask filename  associate a read mask with the image
  45   \-regard-warnings     pay attention to warning messages
  46   \-respect-parentheses settings remain in effect until parenthesis boundary
  47   \-sampling-factor geometry
  48                        horizontal and vertical sampling factor
  49   \-seed value          seed a new sequence of pseudo-random numbers
  50   \-set attribute value set an image attribute
  51   \-similarity-threshold value
  52                         minimum distortion for (sub)image match
  53   \-size geometry       width and height of image
  54   \-subimage-search     search for subimage
  55   \-synchronize         synchronize image to storage device
  56   \-taint               declare the image as modified
  57   \-transparent-color color
  58                        transparent color
  59   \-type type           image type
  60   \-write-mask filename associate a write mask with the image
  61   \-verbose             print detailed information about the image
  62   \-virtual-pixel method
  63                        virtual pixel access method
  64
  65 Miscellaneous Options:
  66   \-channel mask        set the image channel mask
  67   \-debug events        display copious debugging information
  68   \-help                print program options
  69   \-log format          format of debugging information
  70   \-list type           print a list of supported option arguments
  71   \-version             print version information
  72
  73 By default, the image format of `file' is determined by its magic number.  To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps).  Specify 'file' as '-' for standard input or output.
  74
  75 The compare program returns 2 on error otherwise 0 if the images are similar or
  76 1 if they are dissimilar.
  77 .SH SEE ALSO
  78 ImageMagick(1)
  79
  80 .SH COPYRIGHT
  81
  82 \fBCopyright (C) 1999-2016 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file://@DOCUMENTATION_PATH@/www/license.html or http://www.imagemagick.org/script/license.php\fP