blob: ebd9c9c098d156d07239e1214aa443c6ec25d2e9 [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +00001.TH convert 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
2.SH NAME
3convert \- convert between image formats as well as resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, and much more.
4.SH SYNOPSIS
5.TP
6\fBconvert\fP [\fIinput-options\fP] \fIinput-file\fP [\fIoutput-options\fP] \fIoutput-file\fP
7.SH OVERVIEW
8The \fBconvert\fP program is a member of the ImageMagick(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.
9
10For more information about the convert command, point your browser to file://@DOCUMENTATION_PATH@/www/convert.html or http://www.imagemagick.org/script/convert.php.
11.SH DESCRIPTION
12Image Settings:
13 \-adjoin join images into a single multi-image file
14 \-affine matrix affine transform matrix
cristye9252c22013-07-30 15:43:21 +000015 \-alpha option activate, deactivate, reset, or set the alpha channel
cristy3ed852e2009-09-05 21:47:34 +000016 \-antialias remove pixel-aliasing
17 \-authenticate value decrypt image with this password
cristye9252c22013-07-30 15:43:21 +000018 \-attenuate value lessen (or intensify) when adding noise to an image
cristy3ed852e2009-09-05 21:47:34 +000019 \-background color background color
20 \-bias value add bias when convolving an image
21 \-black-point-compensation
22 use black point compensation
23 \-blue-primary point chromaticity blue primary point
24 \-bordercolor color border color
25 \-caption string assign a caption to an image
26 \-cdl filename color correct with a color decision list
cristy1e618102013-03-17 14:52:31 +000027 \-clip clip along the first path from the 8BIM profile
28 \-clip-mask filename associate a clip mask with the image
29 \-clip-path id clip along a named path from the 8BIM profile
cristy3ed852e2009-09-05 21:47:34 +000030 \-colors value preferred number of colors in the image
31 \-colorspace type alternate image colorspace
32 \-comment string annotate image with comment
33 \-compose operator set image composite operator
34 \-compress type type of pixel compression when writing the image
35 \-decipher filename convert cipher pixels to plain pixels
36 \-define format:option
37 define one or more image format options
38 \-delay value display the next image after pausing
39 \-density geometry horizontal and vertical density of the image
40 \-depth value image depth
cristyc9b12952010-03-28 01:12:28 +000041 \-direction type render text right-to-left or left-to-right
cristy3ed852e2009-09-05 21:47:34 +000042 \-display server get image or font from this X server
43 \-dispose method layer disposal method
44 \-dither method apply error diffusion to image
45 \-encipher filename convert plain pixels to cipher pixels
46 \-encoding type text encoding type
47 \-endian type endianness (MSB or LSB) of the image
48 \-family name render text with this font family
cristy14154222012-06-15 23:21:49 +000049 \-features distance analyze image features (e.g. contrast, correlation)
cristy3ed852e2009-09-05 21:47:34 +000050 \-fill color color to use when filling a graphic primitive
51 \-filter type use this filter when resizing an image
52 \-flatten flatten a sequence of images
53 \-font name render text with this font
54 \-format "string" output formatted image characteristics
55 \-fuzz distance colors within this distance are considered equal
56 \-gravity type horizontal and vertical text placement
57 \-green-primary point chromaticity green primary point
cristye9252c22013-07-30 15:43:21 +000058 \-intensity method method to generate intensity value from pixel
cristy3ed852e2009-09-05 21:47:34 +000059 \-intent type type of rendering intent when managing the image color
60 \-interlace type type of image interlacing scheme
cristye9252c22013-07-30 15:43:21 +000061 \-interline-spacing value
62 \ set the space between two text lines
cristy3ed852e2009-09-05 21:47:34 +000063 \-interpolate method pixel color interpolation method
cristye9252c22013-07-30 15:43:21 +000064 \-interword-spacing value
65 \ set the space between two words
cristy837699d2010-07-28 23:49:03 +000066 \-kerning value set the space between two letters
cristy3ed852e2009-09-05 21:47:34 +000067 \-label string assign a label to an image
68 \-limit type value pixel cache resource limit
69 \-loop iterations add Netscape loop extension to your GIF animation
70 \-mask filename associate a mask with the image
71 \-matte store matte channel if the image has one
72 \-mattecolor color frame color
cristyb92495a2013-08-20 00:10:59 +000073 \-metric type measure differences between images with this metric
cristy80b1dee2014-01-09 11:27:24 +000074 \-moments report image moments
cristy3ed852e2009-09-05 21:47:34 +000075 \-monitor monitor progress
76 \-orient type image orientation
cristy3ed852e2009-09-05 21:47:34 +000077 \-page geometry size and location of an image canvas (setting)
78 \-ping efficiently determine image attributes
79 \-pointsize value font point size
cristye9252c22013-07-30 15:43:21 +000080 \-precision value maximum number of significant digits to print
cristy3ed852e2009-09-05 21:47:34 +000081 \-preview type image preview type
82 \-quality value JPEG/MIFF/PNG compression level
83 \-quiet suppress all warning messages
84 \-red-primary point chromaticity red primary point
85 \-regard-warnings pay attention to warning messages
cristye9252c22013-07-30 15:43:21 +000086 \-remap filename transform image colors to match this set of colors
87 \-respect-parentheses settings remain in effect until parenthesis boundary
cristy3ed852e2009-09-05 21:47:34 +000088 \-sampling-factor geometry
89 horizontal and vertical sampling factor
90 \-scene value image scene number
91 \-seed value seed a new sequence of pseudo-random numbers
92 \-size geometry width and height of image
cristy95c38342011-03-18 22:39:51 +000093 \-statistic type geometry
cristy0834d642011-03-18 18:26:08 +000094 replace each pixel with corresponding statistic from the neighborhood
cristy3ed852e2009-09-05 21:47:34 +000095 \-stretch type render text with this font stretch
96 \-stroke color graphic primitive stroke color
97 \-strokewidth value graphic primitive stroke width
98 \-style type render text with this font style
99 \-support factor resize support: > 1.0 is blurry, < 1.0 is sharp
cristyd9a29192010-10-16 16:49:53 +0000100 \-synchronize synchronize image to storage device
101 \-taint declare the image as modified
cristy3ed852e2009-09-05 21:47:34 +0000102 \-texture filename name of texture to tile onto the image background
103 \-tile-offset geometry
104 tile offset
105 \-treedepth value color tree depth
106 \-transparent-color color
107 transparent color
108 \-undercolor color annotation bounding box color
109 \-units type the units of image resolution
110 \-verbose print detailed information about the image
111 \-view FlashPix viewing transforms
112 \-virtual-pixel method
113 virtual pixel access method
114 \-weight type render text with this font weight
115 \-white-point point chromaticity white point
116
117Image Operators:
118 \-adaptive-blur geometry
119 adaptively blur pixels; decrease effect near edges
120 \-adaptive-resize geometry
121 adaptively resize image with data dependent triangulation
122 \-adaptive-sharpen geometry
123 adaptively sharpen pixels; increase effect near edges
124 \-annotate geometry text
125 annotate the image with text
cristye9252c22013-07-30 15:43:21 +0000126 \-auto-gamma automagically adjust gamma level of image
127 \-auto-level automagically adjust color levels of image
cristy3ed852e2009-09-05 21:47:34 +0000128 \-auto-orient automatically orient image
cristye9252c22013-07-30 15:43:21 +0000129 \-bench iterations measure performance
cristy3ed852e2009-09-05 21:47:34 +0000130 \-black-threshold value
131 force all pixels below the threshold into black
cristye9252c22013-07-30 15:43:21 +0000132 \-blue-shift factor simulate a scene at nighttime in the moonlight
cristy3ed852e2009-09-05 21:47:34 +0000133 \-blur geometry reduce image noise and reduce detail levels
134 \-border geometry surround image with a border of color
cristye9252c22013-07-30 15:43:21 +0000135 \-brightness-contrast geometry
136 \ improve brightness / contrast of the image
cristy4ceadb82014-03-29 15:30:43 +0000137 \-canny geometry detect edges in the image
cristy17ada022014-11-07 22:12:23 +0000138 \-channel mask set the image channel mask
cristy3ed852e2009-09-05 21:47:34 +0000139 \-charcoal radius simulate a charcoal drawing
140 \-chop geometry remove pixels from the image interior
cristy1df20892012-11-04 01:06:40 +0000141 \-clamp keep pixel values in range (0-QuantumRange)
cristye9252c22013-07-30 15:43:21 +0000142 \-clip clip along the first path from the 8BIM profile
143 \-clip-mask filename associate a clip mask with the image
144 \-clip-path id clip along a named path from the 8BIM profile
cristy3ed852e2009-09-05 21:47:34 +0000145 \-colorize value colorize the image with the fill color
cristye6365592010-04-02 17:31:23 +0000146 \-color-matrix matrix apply color correction to the image
cristy6e0b3bc2014-10-19 17:51:42 +0000147 \-connected-component connectivity
148 connected-components uniquely labeled
cristy3ed852e2009-09-05 21:47:34 +0000149 \-contrast enhance or reduce the image contrast
150 \-contrast-stretch geometry
151 improve contrast by `stretching' the intensity range
152 \-convolve coefficients
153 apply a convolution kernel to the image
154 \-cycle amount cycle the image colormap
cristye9252c22013-07-30 15:43:21 +0000155 \-deskew threshold straighten an image
cristy3ed852e2009-09-05 21:47:34 +0000156 \-despeckle reduce the speckles within an image
cristye9252c22013-07-30 15:43:21 +0000157 \-distort method args
158 \ distort images according to given method ad args
cristy3ed852e2009-09-05 21:47:34 +0000159 \-draw string annotate the image with a graphic primitive
160 \-edge radius apply a filter to detect edges in the image
161 \-emboss radius emboss an image
162 \-enhance apply a digital filter to enhance a noisy image
163 \-equalize perform histogram equalization to an image
164 \-evaluate operator value
165 evaluate an arithmetic, relational, or logical expression
166 \-extent geometry set the image size
167 \-extract geometry extract area from image
168 \-fft implements the discrete Fourier transform (DFT)
169 \-flip flip image vertically
170 \-floodfill geometry color
171 floodfill the image with color
172 \-flop flop image horizontally
173 \-frame geometry surround image with an ornamental border
174 \-function name apply a function to the image
175 \-gamma value level of gamma correction
176 \-gaussian-blur geometry
177 reduce image noise and reduce detail levels
cristy901f09d2009-10-16 22:56:10 +0000178 \-geometry geometry preferred size or location of the image
cristye0b9b8f2013-03-28 12:39:39 +0000179 \-grayscale method convert image to grayscale
cristyc1510622014-04-19 16:23:30 +0000180 \-hough-lines geometry
cristy2fc10e52014-04-26 14:13:53 +0000181 identify lines in the image
cristy3ed852e2009-09-05 21:47:34 +0000182 \-identify identify the format and characteristics of the image
183 \-ift implements the inverse discrete Fourier transform (DFT)
184 \-implode amount implode image pixels about the center
185 \-lat geometry local adaptive thresholding
186 \-layers method optimize or compare image layers
187 \-level value adjust the level of image contrast
cristye9252c22013-07-30 15:43:21 +0000188 \-level-colors color,color
189 \ level image with the given colors
cristy3ed852e2009-09-05 21:47:34 +0000190 \-linear-stretch geometry
191 improve contrast by `stretching with saturation' the intensity range
cristye9252c22013-07-30 15:43:21 +0000192 \-liquid-rescale geometry
cristy2fc10e52014-04-26 14:13:53 +0000193 rescale image with seam-carving
194 \-mean-shift geometry delineate arbitrarily shaped clusters in the image
cristy3c741502011-04-01 23:21:16 +0000195 \-median geometry apply a median filter to the image
glennrp30d2dc62011-06-25 03:17:16 +0000196 \-mode geometry make each pixel the 'predominant color' of the neighborhood
cristy3ed852e2009-09-05 21:47:34 +0000197 \-modulate value vary the brightness, saturation, and hue
198 \-monochrome transform image to black and white
cristy02d5b4f2010-02-01 01:08:27 +0000199 \-morphology method kernel
200 apply a morphology method to the image
cristy3ed852e2009-09-05 21:47:34 +0000201 \-motion-blur geometry
202 simulate motion blur
cristy2146a5f2010-02-01 01:28:35 +0000203 \-negate replace each pixel with its complementary color
cristy3c741502011-04-01 23:21:16 +0000204 \-noise geometry add or reduce noise in an image
cristy3ed852e2009-09-05 21:47:34 +0000205 \-normalize transform image to span the full range of colors
206 \-opaque color change this color to the fill color
207 \-ordered-dither NxN
208 add a noise pattern to the image with specific amplitudes
209 \-paint radius simulate an oil painting
cristy3d629e22012-11-04 01:32:13 +0000210 \-perceptible epsilon
211 pixel value less than |epsilon| become epsilon or -epsilon
cristy3ed852e2009-09-05 21:47:34 +0000212 \-polaroid angle simulate a Polaroid picture
213 \-posterize levels reduce the image to a limited number of color levels
214 \-print string interpret string and print to console
215 \-profile filename add, delete, or apply an image profile
216 \-quantize colorspace reduce colors in this colorspace
217 \-radial-blur angle radial blur the image
218 \-raise value lighten/darken image edges to create a 3-D effect
219 \-random-threshold low,high
220 random threshold the image
cristy3ed852e2009-09-05 21:47:34 +0000221 \-region geometry apply options to a portion of the image
222 \-render render vector graphics
223 \-repage geometry size and location of an image canvas
224 \-resample geometry change the resolution of an image
225 \-resize geometry resize the image
226 \-roll geometry roll an image vertically or horizontally
227 \-rotate degrees apply Paeth rotation to the image
228 \-sample geometry scale image with pixel sampling
229 \-scale geometry scale the image
230 \-segment values segment an image
231 \-selective-blur geometry
232 selectively blur pixels within a contrast threshold
233 \-sepia-tone threshold
234 simulate a sepia-toned photo
235 \-set property value set an image property
236 \-shade degrees shade the image using a distant light source
237 \-shadow geometry simulate an image shadow
238 \-sharpen geometry sharpen the image
239 \-shave geometry shave pixels from the image edges
240 \-shear geometry slide one edge of the image along the X or Y axis
241 \-sigmoidal-contrast geometry
242 lightness rescaling using sigmoidal contrast enhancement
243 \-sketch geometry simulate a pencil sketch
244 \-solarize threshold negate all pixels above the threshold level
cristye9252c22013-07-30 15:43:21 +0000245 \-sparse-color method args
246 \ fill in a image based on a few color points
cristy3ed852e2009-09-05 21:47:34 +0000247 \-splice geometry splice the background color into the image
248 \-spread amount displace image pixels by a random amount
249 \-strip strip image of all profiles and comments
250 \-swirl degrees swirl image pixels about the center
251 \-threshold value threshold the image
252 \-thumbnail geometry create a thumbnail of the image
253 \-tile filename tile image when filling a graphic primitive
254 \-tint value tint the image with the fill color
255 \-transform affine transform image
256 \-transparent color make this color transparent within the image
257 \-transpose flip image vertically and rotate 90 degrees
258 \-transverse flop image horizontally and rotate 270 degrees
259 \-trim trim image edges
260 \-type type image type
261 \-unique-colors discard all but one of any pixel color
262 \-unsharp geometry sharpen the image
263 \-vignette geometry soften the edges of the image in vignette style
264 \-wave geometry alter an image along a sine wave
265 \-white-threshold value
266 force all pixels above the threshold into white
267
cristy87c02f42012-02-24 00:19:10 +0000268
269Image Channel Operators:
cristye9252c22013-07-30 15:43:21 +0000270 \-channel-fx expression
271 exchange, extract, or transfer one or more image channels
272 \-separate separate an image channel into a grayscale image
cristy87c02f42012-02-24 00:19:10 +0000273
cristy3ed852e2009-09-05 21:47:34 +0000274Image Sequence Operators:
cristyde5f6c62010-09-13 17:16:07 +0000275 \-append append an image sequence top to bottom (use +append for left to right)
cristy3ed852e2009-09-05 21:47:34 +0000276 \-clut apply a color lookup table to the image
277 \-coalesce merge a sequence of images
278 \-combine combine a sequence of images
cristyb92495a2013-08-20 00:10:59 +0000279 \-compare mathematically and visually annotate the difference between an image and its reconstruction
cristy790190d2013-10-04 00:51:51 +0000280 \-complex operator perform complex mathematics on an image sequence
cristy3ed852e2009-09-05 21:47:34 +0000281 \-composite composite image
cristy88742622015-06-26 23:07:49 +0000282 \-copy geometry offset,
283 copy pixels from one area of an image to another
cristy3ed852e2009-09-05 21:47:34 +0000284 \-crop geometry cut out a rectangular region of the image
285 \-deconstruct break down an image sequence into constituent parts
cristyd18ae7c2010-03-07 17:39:52 +0000286 \-evaluate-sequence operator
287 evaluate an arithmetic, relational, or logical expression
cristy3ed852e2009-09-05 21:47:34 +0000288 \-flatten flatten a sequence of images
289 \-fx expression apply mathematical expression to an image channel(s)
290 \-hald-clut apply a Hald color lookup table to the image
291 \-morph value morph an image sequence
cristye9252c22013-07-30 15:43:21 +0000292 \-mosaic create a mosaic from an image sequence
cristydbc2da92012-11-12 13:16:07 +0000293 \-poly terms build a polynomial from the image sequence and the corresponding terms (coefficients and degree pairs)
cristy3ed852e2009-09-05 21:47:34 +0000294 \-process arguments process the image with a custom image filter
cristydac5af22011-02-23 02:16:00 +0000295 \-smush geometry smush an image sequence together
cristy3ed852e2009-09-05 21:47:34 +0000296 \-write filename write images to this file
297
298Image Stack Operators:
anthonyac85a312011-03-23 08:19:50 +0000299 \-clone indexes clone an image
300 \-delete indexes delete the image from the image sequence
301 \-duplicate count,indexes
cristy5d28d482011-03-20 21:59:40 +0000302 duplicate an image one or more times
cristy3ed852e2009-09-05 21:47:34 +0000303 \-insert index insert last image into the image sequence
cristye9252c22013-07-30 15:43:21 +0000304 \-reverse reverse image sequence
cristy3ed852e2009-09-05 21:47:34 +0000305 \-swap indexes swap two images in the image sequence
306
307Miscellaneous Options:
308 \-debug events display copious debugging information
cristye9252c22013-07-30 15:43:21 +0000309 \-distribute-cache port
310 distributed pixel cache spanning one or more servers
cristy3ed852e2009-09-05 21:47:34 +0000311 \-help print program options
312 \-log format format of debugging information
313 \-list type print a list of supported option arguments
314 \-version print version information
315
cristy94d9ee42011-12-22 15:18:27 +0000316Use 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.
317
cristy3ed852e2009-09-05 21:47:34 +0000318By 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.
319.SH SEE ALSO
320ImageMagick(1)
321
322.SH COPYRIGHT
cristyb56bb242014-11-25 17:12:48 +0000323\fBCopyright (C) 1999-2015 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