blob: d997b5012b03174b9d13fa8b6a64d25652425c3c [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
15 \-antialias remove pixel-aliasing
16 \-authenticate value decrypt image with this password
17 \-background color background color
18 \-bias value add bias when convolving an image
19 \-black-point-compensation
20 use black point compensation
21 \-blue-primary point chromaticity blue primary point
22 \-bordercolor color border color
23 \-caption string assign a caption to an image
24 \-cdl filename color correct with a color decision list
25 \-channel type apply option to select image channels
26 \-colors value preferred number of colors in the image
27 \-colorspace type alternate image colorspace
28 \-comment string annotate image with comment
29 \-compose operator set image composite operator
30 \-compress type type of pixel compression when writing the image
31 \-decipher filename convert cipher pixels to plain pixels
32 \-define format:option
33 define one or more image format options
34 \-delay value display the next image after pausing
35 \-density geometry horizontal and vertical density of the image
36 \-depth value image depth
cristyc9b12952010-03-28 01:12:28 +000037 \-direction type render text right-to-left or left-to-right
cristy3ed852e2009-09-05 21:47:34 +000038 \-display server get image or font from this X server
39 \-dispose method layer disposal method
40 \-dither method apply error diffusion to image
41 \-encipher filename convert plain pixels to cipher pixels
42 \-encoding type text encoding type
43 \-endian type endianness (MSB or LSB) of the image
44 \-family name render text with this font family
cristy14154222012-06-15 23:21:49 +000045 \-features distance analyze image features (e.g. contrast, correlation)
cristy3ed852e2009-09-05 21:47:34 +000046 \-fill color color to use when filling a graphic primitive
47 \-filter type use this filter when resizing an image
48 \-flatten flatten a sequence of images
49 \-font name render text with this font
50 \-format "string" output formatted image characteristics
51 \-fuzz distance colors within this distance are considered equal
52 \-gravity type horizontal and vertical text placement
53 \-green-primary point chromaticity green primary point
54 \-intent type type of rendering intent when managing the image color
55 \-interlace type type of image interlacing scheme
56 \-interpolate method pixel color interpolation method
cristy837699d2010-07-28 23:49:03 +000057 \-kerning value set the space between two letters
cristy3ed852e2009-09-05 21:47:34 +000058 \-label string assign a label to an image
59 \-limit type value pixel cache resource limit
60 \-loop iterations add Netscape loop extension to your GIF animation
61 \-mask filename associate a mask with the image
62 \-matte store matte channel if the image has one
63 \-mattecolor color frame color
64 \-monitor monitor progress
65 \-orient type image orientation
66 \-origin geometry image origin
67 \-page geometry size and location of an image canvas (setting)
68 \-ping efficiently determine image attributes
69 \-pointsize value font point size
70 \-preview type image preview type
71 \-quality value JPEG/MIFF/PNG compression level
72 \-quiet suppress all warning messages
73 \-red-primary point chromaticity red primary point
74 \-regard-warnings pay attention to warning messages
75 \-sampling-factor geometry
76 horizontal and vertical sampling factor
77 \-scene value image scene number
78 \-seed value seed a new sequence of pseudo-random numbers
79 \-size geometry width and height of image
cristy95c38342011-03-18 22:39:51 +000080 \-statistic type geometry
cristy0834d642011-03-18 18:26:08 +000081 replace each pixel with corresponding statistic from the neighborhood
cristy3ed852e2009-09-05 21:47:34 +000082 \-stretch type render text with this font stretch
83 \-stroke color graphic primitive stroke color
84 \-strokewidth value graphic primitive stroke width
85 \-style type render text with this font style
86 \-support factor resize support: > 1.0 is blurry, < 1.0 is sharp
cristyd9a29192010-10-16 16:49:53 +000087 \-synchronize synchronize image to storage device
88 \-taint declare the image as modified
cristy3ed852e2009-09-05 21:47:34 +000089 \-texture filename name of texture to tile onto the image background
90 \-tile-offset geometry
91 tile offset
92 \-treedepth value color tree depth
93 \-transparent-color color
94 transparent color
95 \-undercolor color annotation bounding box color
96 \-units type the units of image resolution
97 \-verbose print detailed information about the image
98 \-view FlashPix viewing transforms
99 \-virtual-pixel method
100 virtual pixel access method
101 \-weight type render text with this font weight
102 \-white-point point chromaticity white point
103
104Image Operators:
105 \-adaptive-blur geometry
106 adaptively blur pixels; decrease effect near edges
107 \-adaptive-resize geometry
108 adaptively resize image with data dependent triangulation
109 \-adaptive-sharpen geometry
110 adaptively sharpen pixels; increase effect near edges
111 \-annotate geometry text
112 annotate the image with text
113 \-auto-orient automatically orient image
114 \-black-threshold value
115 force all pixels below the threshold into black
116 \-blur geometry reduce image noise and reduce detail levels
117 \-border geometry surround image with a border of color
118 \-charcoal radius simulate a charcoal drawing
119 \-chop geometry remove pixels from the image interior
cristy1df20892012-11-04 01:06:40 +0000120 \-clamp keep pixel values in range (0-QuantumRange)
cristy3ed852e2009-09-05 21:47:34 +0000121 \-clip clip along the first path from the 8BIM profile
122 \-clip-mask filename associate a clip mask with the image
123 \-clip-path id clip along a named path from the 8BIM profile
124 \-colorize value colorize the image with the fill color
cristye6365592010-04-02 17:31:23 +0000125 \-color-matrix matrix apply color correction to the image
cristy3ed852e2009-09-05 21:47:34 +0000126 \-contrast enhance or reduce the image contrast
127 \-contrast-stretch geometry
128 improve contrast by `stretching' the intensity range
129 \-convolve coefficients
130 apply a convolution kernel to the image
131 \-cycle amount cycle the image colormap
132 \-despeckle reduce the speckles within an image
133 \-draw string annotate the image with a graphic primitive
134 \-edge radius apply a filter to detect edges in the image
135 \-emboss radius emboss an image
136 \-enhance apply a digital filter to enhance a noisy image
137 \-equalize perform histogram equalization to an image
138 \-evaluate operator value
139 evaluate an arithmetic, relational, or logical expression
140 \-extent geometry set the image size
141 \-extract geometry extract area from image
142 \-fft implements the discrete Fourier transform (DFT)
143 \-flip flip image vertically
144 \-floodfill geometry color
145 floodfill the image with color
146 \-flop flop image horizontally
147 \-frame geometry surround image with an ornamental border
148 \-function name apply a function to the image
149 \-gamma value level of gamma correction
150 \-gaussian-blur geometry
151 reduce image noise and reduce detail levels
cristy901f09d2009-10-16 22:56:10 +0000152 \-geometry geometry preferred size or location of the image
cristy3ed852e2009-09-05 21:47:34 +0000153 \-identify identify the format and characteristics of the image
154 \-ift implements the inverse discrete Fourier transform (DFT)
155 \-implode amount implode image pixels about the center
156 \-lat geometry local adaptive thresholding
157 \-layers method optimize or compare image layers
158 \-level value adjust the level of image contrast
159 \-linear-stretch geometry
160 improve contrast by `stretching with saturation' the intensity range
cristy3c741502011-04-01 23:21:16 +0000161 \-median geometry apply a median filter to the image
glennrp30d2dc62011-06-25 03:17:16 +0000162 \-mode geometry make each pixel the 'predominant color' of the neighborhood
cristy3ed852e2009-09-05 21:47:34 +0000163 \-modulate value vary the brightness, saturation, and hue
164 \-monochrome transform image to black and white
cristy02d5b4f2010-02-01 01:08:27 +0000165 \-morphology method kernel
166 apply a morphology method to the image
cristy3ed852e2009-09-05 21:47:34 +0000167 \-motion-blur geometry
168 simulate motion blur
cristy2146a5f2010-02-01 01:28:35 +0000169 \-negate replace each pixel with its complementary color
cristy3c741502011-04-01 23:21:16 +0000170 \-noise geometry add or reduce noise in an image
cristy3ed852e2009-09-05 21:47:34 +0000171 \-normalize transform image to span the full range of colors
172 \-opaque color change this color to the fill color
173 \-ordered-dither NxN
174 add a noise pattern to the image with specific amplitudes
175 \-paint radius simulate an oil painting
cristy3d629e22012-11-04 01:32:13 +0000176 \-perceptible epsilon
177 pixel value less than |epsilon| become epsilon or -epsilon
cristy3ed852e2009-09-05 21:47:34 +0000178 \-polaroid angle simulate a Polaroid picture
179 \-posterize levels reduce the image to a limited number of color levels
180 \-print string interpret string and print to console
181 \-profile filename add, delete, or apply an image profile
182 \-quantize colorspace reduce colors in this colorspace
183 \-radial-blur angle radial blur the image
184 \-raise value lighten/darken image edges to create a 3-D effect
185 \-random-threshold low,high
186 random threshold the image
cristy3ed852e2009-09-05 21:47:34 +0000187 \-region geometry apply options to a portion of the image
188 \-render render vector graphics
189 \-repage geometry size and location of an image canvas
190 \-resample geometry change the resolution of an image
191 \-resize geometry resize the image
192 \-roll geometry roll an image vertically or horizontally
193 \-rotate degrees apply Paeth rotation to the image
194 \-sample geometry scale image with pixel sampling
195 \-scale geometry scale the image
196 \-segment values segment an image
197 \-selective-blur geometry
198 selectively blur pixels within a contrast threshold
199 \-sepia-tone threshold
200 simulate a sepia-toned photo
201 \-set property value set an image property
202 \-shade degrees shade the image using a distant light source
203 \-shadow geometry simulate an image shadow
204 \-sharpen geometry sharpen the image
205 \-shave geometry shave pixels from the image edges
206 \-shear geometry slide one edge of the image along the X or Y axis
207 \-sigmoidal-contrast geometry
208 lightness rescaling using sigmoidal contrast enhancement
209 \-sketch geometry simulate a pencil sketch
210 \-solarize threshold negate all pixels above the threshold level
211 \-splice geometry splice the background color into the image
212 \-spread amount displace image pixels by a random amount
213 \-strip strip image of all profiles and comments
214 \-swirl degrees swirl image pixels about the center
215 \-threshold value threshold the image
216 \-thumbnail geometry create a thumbnail of the image
217 \-tile filename tile image when filling a graphic primitive
218 \-tint value tint the image with the fill color
219 \-transform affine transform image
220 \-transparent color make this color transparent within the image
221 \-transpose flip image vertically and rotate 90 degrees
222 \-transverse flop image horizontally and rotate 270 degrees
223 \-trim trim image edges
224 \-type type image type
225 \-unique-colors discard all but one of any pixel color
226 \-unsharp geometry sharpen the image
227 \-vignette geometry soften the edges of the image in vignette style
228 \-wave geometry alter an image along a sine wave
229 \-white-threshold value
230 force all pixels above the threshold into white
231
cristy87c02f42012-02-24 00:19:10 +0000232
233Image Channel Operators:
234 \-channel-extract channel-list
235 extract the channels in order
236 \-channel-inject channel-list
237 inject the channels in order
238 \-channel-swap channel,channel
239 swap the channels
240
cristy3ed852e2009-09-05 21:47:34 +0000241Image Sequence Operators:
242 \-affinity filename transform image colors to match this set of colors
cristyde5f6c62010-09-13 17:16:07 +0000243 \-append append an image sequence top to bottom (use +append for left to right)
cristy3ed852e2009-09-05 21:47:34 +0000244 \-clut apply a color lookup table to the image
245 \-coalesce merge a sequence of images
246 \-combine combine a sequence of images
247 \-composite composite image
248 \-crop geometry cut out a rectangular region of the image
249 \-deconstruct break down an image sequence into constituent parts
cristyd18ae7c2010-03-07 17:39:52 +0000250 \-evaluate-sequence operator
251 evaluate an arithmetic, relational, or logical expression
cristy3ed852e2009-09-05 21:47:34 +0000252 \-flatten flatten a sequence of images
253 \-fx expression apply mathematical expression to an image channel(s)
254 \-hald-clut apply a Hald color lookup table to the image
255 \-morph value morph an image sequence
256 \-mosaic create a mosaic from an image sequence
257 \-process arguments process the image with a custom image filter
258 \-separate separate an image channel into a grayscale image
cristydac5af22011-02-23 02:16:00 +0000259 \-smush geometry smush an image sequence together
cristy3ed852e2009-09-05 21:47:34 +0000260 \-write filename write images to this file
261
262Image Stack Operators:
anthonyac85a312011-03-23 08:19:50 +0000263 \-clone indexes clone an image
264 \-delete indexes delete the image from the image sequence
265 \-duplicate count,indexes
cristy5d28d482011-03-20 21:59:40 +0000266 duplicate an image one or more times
cristy3ed852e2009-09-05 21:47:34 +0000267 \-insert index insert last image into the image sequence
268 \-swap indexes swap two images in the image sequence
269
270Miscellaneous Options:
271 \-debug events display copious debugging information
272 \-help print program options
273 \-log format format of debugging information
274 \-list type print a list of supported option arguments
275 \-version print version information
276
cristy94d9ee42011-12-22 15:18:27 +0000277Use 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.
278
cristy3ed852e2009-09-05 21:47:34 +0000279By 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.
280.SH SEE ALSO
281ImageMagick(1)
282
283.SH COPYRIGHT
cristy1454be72011-12-19 01:52:48 +0000284\fBCopyright (C) 1999-2012 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