blob: b8aa8a4ae1556426b5bd268b2890eed743aecccd [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +00001.TH mogrify 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
2.SH NAME
3mogrify \- resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, and much more. Mogrify overwrites the original image file, whereas, convert(1) writes to a different image file.
4.SH SYNOPSIS
5.TP
6\fBmogrify\fP [\fIoptions\fP] \fIinput-file\fP
7.SH OVERVIEW
8The \fBmogrify\fP program is a member of the ImageMagick(1) suite of tools. Use it to resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, and much more. This tool is similar to convert(1) except the original image file is overwritten with any changes you request.
9
10For more information about the mogrify command, point your browser to file://@DOCUMENTATION_PATH@/www/mogrify.html or http://www.imagemagick.org/script/mogrify.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
cristye9252c22013-07-30 15:43:21 +000017 \-attenuate value lessen (or intensify) when adding noise to an image
cristy3ed852e2009-09-05 21:47:34 +000018 \-background color background color
19 \-bias value add bias when convolving an image
20 \-black-point-compensation
21 use black point compensation
22 \-blue-primary point chromaticity blue primary point
23 \-bordercolor color border color
24 \-caption string assign a caption to an image
25 \-cdl filename color correct with a color decision list
cristy3ed852e2009-09-05 21:47:34 +000026 \-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 type image format type
51 \-function name apply a function to the image
52 \-fuzz distance colors within this distance are considered equal
53 \-gravity type horizontal and vertical text placement
54 \-green-primary point chromaticity green primary point
cristye9252c22013-07-30 15:43:21 +000055 \-intensity method method to generate intensity value from pixel
cristy3ed852e2009-09-05 21:47:34 +000056 \-intent type type of rendering intent when managing the image color
57 \-interlace type type of image interlacing scheme
cristye9252c22013-07-30 15:43:21 +000058 \-interline-spacing value set the space between two text lines
cristy3ed852e2009-09-05 21:47:34 +000059 \-interpolate method pixel color interpolation method
cristye9252c22013-07-30 15:43:21 +000060 \-interword-spacing value set the space between two words
cristy837699d2010-07-28 23:49:03 +000061 \-kerning value set the space between two letters
cristy3ed852e2009-09-05 21:47:34 +000062 \-label string assign a label to an image
63 \-limit type value pixel cache resource limit
64 \-loop iterations add Netscape loop extension to your GIF animation
cristy3ed852e2009-09-05 21:47:34 +000065 \-matte store matte channel if the image has one
66 \-mattecolor color frame color
cristyb92495a2013-08-20 00:10:59 +000067 \-metric type measure differences between images with this metric
cristy3ed852e2009-09-05 21:47:34 +000068 \-monitor monitor progress
cristy02d5b4f2010-02-01 01:08:27 +000069 \-morphology method kernel
70 apply a morphology method to the image
cristy3ed852e2009-09-05 21:47:34 +000071 \-orient type image orientation
cristy3ed852e2009-09-05 21:47:34 +000072 \-page geometry size and location of an image canvas (setting)
73 \-path path write images to this path on disk
cristy3d629e22012-11-04 01:32:13 +000074 \-perceptible epsilon
75 pixel value less than |epsilon| become epsilon or -epsilon
cristy3ed852e2009-09-05 21:47:34 +000076 \-ping efficiently determine image attributes
77 \-pointsize value font point size
cristye9252c22013-07-30 15:43:21 +000078 \-precision value maximum number of significant digits to print
cristy3ed852e2009-09-05 21:47:34 +000079 \-preview type image preview type
80 \-quality value JPEG/MIFF/PNG compression level
81 \-quiet suppress all warning messages
cristy327030c2015-07-25 18:05:50 +000082 \-read-mask filename associate a read mask with the image
cristy3ed852e2009-09-05 21:47:34 +000083 \-red-primary point chromaticity red primary point
84 \-regard-warnings pay attention to warning messages
cristye9252c22013-07-30 15:43:21 +000085 \-remap filename transform image colors to match this set of colors
86 \-respect-parentheses settings remain in effect until parenthesis boundary
cristy3ed852e2009-09-05 21:47:34 +000087 \-sampling-factor geometry
88 horizontal and vertical sampling factor
89 \-scene value image scene number
90 \-seed value seed a new sequence of pseudo-random numbers
91 \-size geometry width and height of image
92 \-stretch type render text with this font stretch
93 \-stroke color graphic primitive stroke color
94 \-strokewidth value graphic primitive stroke width
95 \-style type render text with this font style
cristyd9a29192010-10-16 16:49:53 +000096 \-synchronize synchronize image to storage device
97 \-taint declare the image as modified
cristy3ed852e2009-09-05 21:47:34 +000098 \-texture filename name of texture to tile onto the image background
99 \-tile-offset geometry
100 tile offset
101 \-treedepth value color tree depth
102 \-transparent-color color
103 transparent color
104 \-undercolor color annotation bounding box color
105 \-units type the units of image resolution
106 \-verbose print detailed information about the image
107 \-view FlashPix viewing transforms
108 \-virtual-pixel method
109 virtual pixel access method
110 \-weight type render text with this font weight
111 \-white-point point chromaticity white point
cristy327030c2015-07-25 18:05:50 +0000112 \-write-mask filename associate a write mask with the image
cristy3ed852e2009-09-05 21:47:34 +0000113
114Image Operators:
115 \-adaptive-blur geometry
116 adaptively blur pixels; decrease effect near edges
117 \-adaptive-resize geometry
118 adaptively resize image with data dependent triangulation
119 \-adaptive-sharpen geometry
120 adaptively sharpen pixels; increase effect near edges
cristye9252c22013-07-30 15:43:21 +0000121 \-alpha option on, activate, off, deactivate, set, opaque, copy
122 transparent, extract, background, or shape
cristy3ed852e2009-09-05 21:47:34 +0000123 \-annotate geometry text
124 annotate the image with text
cristye9252c22013-07-30 15:43:21 +0000125 \-auto-gamma automagically adjust gamma level of image
126 \-auto-level automagically adjust color levels of image
cristy3ed852e2009-09-05 21:47:34 +0000127 \-auto-orient automatically orient image
cristye9252c22013-07-30 15:43:21 +0000128 \-bench iterations measure performance
cristy3ed852e2009-09-05 21:47:34 +0000129 \-black-threshold value
130 force all pixels below the threshold into black
cristye9252c22013-07-30 15:43:21 +0000131 \-blue-shift simulate a scene at nighttime in the moonlight
cristy3ed852e2009-09-05 21:47:34 +0000132 \-blur geometry reduce image noise and reduce detail levels
133 \-border geometry surround image with a border of color
cristye9252c22013-07-30 15:43:21 +0000134 \-brightness-contrast geometry
135 improve brightness / contrast of the image
cristy4ceadb82014-03-29 15:30:43 +0000136 \-canny geometry detect edges in the image
cristy17ada022014-11-07 22:12:23 +0000137 \-channel mask set the image channel mask
cristy3ed852e2009-09-05 21:47:34 +0000138 \-charcoal radius simulate a charcoal drawing
139 \-chop geometry remove pixels from the image interior
cristy1df20892012-11-04 01:06:40 +0000140 \-clamp keep pixel values in range (0-QuantumRange)
cristy3ed852e2009-09-05 21:47:34 +0000141 \-clip clip along the first path from the 8BIM profile
142 \-clip-mask filename associate a clip mask with the image
143 \-clip-path id clip along a named path from the 8BIM profile
144 \-colorize value colorize the image with the fill color
cristye6365592010-04-02 17:31:23 +0000145 \-color-matrix matrix apply color correction to the image
cristy6e0b3bc2014-10-19 17:51:42 +0000146 \-connected-component connectivity
147 connected-components uniquely labeled
cristy3ed852e2009-09-05 21:47:34 +0000148 \-contrast enhance or reduce the image contrast
149 \-contrast-stretch geometry
150 improve contrast by `stretching' the intensity range
151 \-convolve coefficients
152 apply a convolution kernel to the image
153 \-cycle amount cycle the image colormap
cristye9252c22013-07-30 15:43:21 +0000154 \-deskew threshold straighten an image
cristy3ed852e2009-09-05 21:47:34 +0000155 \-despeckle reduce the speckles within an image
cristye9252c22013-07-30 15:43:21 +0000156 \-distort method args
157 distort images according to given method ad args
cristy3ed852e2009-09-05 21:47:34 +0000158 \-draw string annotate the image with a graphic primitive
159 \-edge radius apply a filter to detect edges in the image
160 \-emboss radius emboss an image
161 \-enhance apply a digital filter to enhance a noisy image
162 \-equalize perform histogram equalization to an image
163 \-evaluate operator value
164 evaluate an arithmetic, relational, or logical expression
165 \-extent geometry set the image size
166 \-extract geometry extract area from image
167 \-fft implements the discrete Fourier transform (DFT)
168 \-flip flip image vertically
169 \-floodfill geometry color
170 floodfill the image with color
171 \-flop flop image horizontally
172 \-frame geometry surround image with an ornamental border
173 \-gamma value level of gamma correction
174 \-gaussian-blur geometry
175 reduce image noise and reduce detail levels
cristy901f09d2009-10-16 22:56:10 +0000176 \-geometry geometry preferred size or location of the image
cristye0b9b8f2013-03-28 12:39:39 +0000177 \-grayscale method convert image to grayscale
cristy3ed852e2009-09-05 21:47:34 +0000178 \-help print program options
cristyc1510622014-04-19 16:23:30 +0000179 \-hough-lines geometry
cristy2fc10e52014-04-26 14:13:53 +0000180 identify lines in the image
cristy3ed852e2009-09-05 21:47:34 +0000181 \-identify identify the format and characteristics of the image
cristyc1510622014-04-19 16:23:30 +0000182 \-ift implements the inverse discrete Fourier transform (DFT)
cristy3ed852e2009-09-05 21:47:34 +0000183 \-implode amount implode image pixels about the center
cristye9252c22013-07-30 15:43:21 +0000184 \-interpolative-resize geometry
185 resize image using interpolation
cristy3ed852e2009-09-05 21:47:34 +0000186 \-lat geometry local adaptive thresholding
187 \-layers method optimize or compare image layers
188 \-level value adjust the level of image contrast
cristye9252c22013-07-30 15:43:21 +0000189 \-level-colors color,color
190 level image with the given colors
cristy3ed852e2009-09-05 21:47:34 +0000191 \-linear-stretch geometry
192 improve contrast by `stretching with saturation' the intensity range
cristye9252c22013-07-30 15:43:21 +0000193 \-liquid-rescale geometry
194 rescale image with seam-carving
cristy7220ee42013-04-14 01:30:34 +0000195 \-magnify double the size of the image with pixel art scaling
cristy2fc10e52014-04-26 14:13:53 +0000196 \-mean-shift geometry delineate arbitrarily shaped clusters in the image
cristy3c741502011-04-01 23:21:16 +0000197 \-median geometry apply a median filter to the image
glennrp30d2dc62011-06-25 03:17:16 +0000198 \-mode geometry make each pixel the 'predominant color' of the neighborhood
cristy3ed852e2009-09-05 21:47:34 +0000199 \-modulate value vary the brightness, saturation, and hue
200 \-monochrome transform image to black and white
201 \-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
210 \-polaroid angle simulate a Polaroid picture
211 \-posterize levels reduce the image to a limited number of color levels
212 \-print string interpret string and print to console
213 \-profile filename add, delete, or apply an image profile
214 \-quantize colorspace reduce colors in this colorspace
215 \-radial-blur angle radial blur the image
216 \-raise value lighten/darken image edges to create a 3-D effect
217 \-random-threshold low,high
218 random threshold the image
cristy3ed852e2009-09-05 21:47:34 +0000219 \-region geometry apply options to a portion of the image
220 \-render render vector graphics
221 \-repage geometry size and location of an image canvas
222 \-resample geometry change the resolution of an image
223 \-resize geometry resize the image
224 \-roll geometry roll an image vertically or horizontally
225 \-rotate degrees apply Paeth rotation to the image
226 \-sample geometry scale image with pixel sampling
227 \-scale geometry scale the image
228 \-segment values segment an image
229 \-selective-blur geometry
230 selectively blur pixels within a contrast threshold
231 \-sepia-tone threshold
232 simulate a sepia-toned photo
233 \-set property value set an image property
234 \-shade degrees shade the image using a distant light source
235 \-shadow geometry simulate an image shadow
236 \-sharpen geometry sharpen the image
237 \-shave geometry shave pixels from the image edges
238 \-shear geometry slide one edge of the image along the X or Y axis
239 \-sigmoidal-contrast geometry
240 lightness rescaling using sigmoidal contrast enhancement
241 \-sketch geometry simulate a pencil sketch
242 \-solarize threshold negate all pixels above the threshold level
cristye9252c22013-07-30 15:43:21 +0000243 \-sparse-color method args
244 fill in a image based on a few color points
cristy3ed852e2009-09-05 21:47:34 +0000245 \-splice geometry splice the background color into the image
246 \-spread amount displace image pixels by a random amount
cristy95c38342011-03-18 22:39:51 +0000247 \-statistic type geometry
cristy0834d642011-03-18 18:26:08 +0000248 replace each pixel with corresponding statistic from the neighborhood
cristy3ed852e2009-09-05 21:47:34 +0000249 \-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 +0000268Image Channel Operators:
cristye9252c22013-07-30 15:43:21 +0000269 \-channel-fx expression
270 exchange, extract, or transfer one or more image channels
271 \-separate separate an image channel into a grayscale image
cristy87c02f42012-02-24 00:19:10 +0000272
cristy3ed852e2009-09-05 21:47:34 +0000273Image Sequence Operators:
274 \-affinity filename transform image colors to match this set of colors
cristyde5f6c62010-09-13 17:16:07 +0000275 \-append append an image sequence top to botto (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
292 \-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
295 \-separate separate an image channel into a grayscale image
cristydac5af22011-02-23 02:16:00 +0000296 \-smush geometry smush an image sequence together
cristy3ed852e2009-09-05 21:47:34 +0000297 \-write filename write images to this file
298
299Image Stack Operators:
anthonyac85a312011-03-23 08:19:50 +0000300 \-delete indexes delete the image from the image sequence
301 \-duplicate count,indexes
cristyecb10ff2011-03-22 13:14:03 +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
316By 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.
317.SH SEE ALSO
318ImageMagick(1)
319
320.SH COPYRIGHT
321
cristyb56bb242014-11-25 17:12:48 +0000322\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