blob: b50cb3bc6438fe7ed7428d0d012542e4bcfce241 [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
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 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
55 \-intent type type of rendering intent when managing the image color
56 \-interlace type type of image interlacing scheme
57 \-interpolate method pixel color interpolation method
cristy837699d2010-07-28 23:49:03 +000058 \-kerning value set the space between two letters
cristy3ed852e2009-09-05 21:47:34 +000059 \-label string assign a label to an image
60 \-limit type value pixel cache resource limit
61 \-loop iterations add Netscape loop extension to your GIF animation
62 \-mask filename associate a mask with the image
63 \-matte store matte channel if the image has one
64 \-mattecolor color frame color
65 \-monitor monitor progress
cristy02d5b4f2010-02-01 01:08:27 +000066 \-morphology method kernel
67 apply a morphology method to the image
cristy3ed852e2009-09-05 21:47:34 +000068 \-orient type image orientation
69 \-origin geometry image origin
70 \-page geometry size and location of an image canvas (setting)
71 \-path path write images to this path on disk
cristy3d629e22012-11-04 01:32:13 +000072 \-perceptible epsilon
73 pixel value less than |epsilon| become epsilon or -epsilon
cristy3ed852e2009-09-05 21:47:34 +000074 \-ping efficiently determine image attributes
75 \-pointsize value font point size
76 \-preview type image preview type
77 \-quality value JPEG/MIFF/PNG compression level
78 \-quiet suppress all warning messages
79 \-red-primary point chromaticity red primary point
80 \-regard-warnings pay attention to warning messages
81 \-sampling-factor geometry
82 horizontal and vertical sampling factor
83 \-scene value image scene number
84 \-seed value seed a new sequence of pseudo-random numbers
85 \-size geometry width and height of image
86 \-stretch type render text with this font stretch
87 \-stroke color graphic primitive stroke color
88 \-strokewidth value graphic primitive stroke width
89 \-style type render text with this font style
90 \-support factor resize support: > 1.0 is blurry, < 1.0 is sharp
cristyd9a29192010-10-16 16:49:53 +000091 \-synchronize synchronize image to storage device
92 \-taint declare the image as modified
cristy3ed852e2009-09-05 21:47:34 +000093 \-texture filename name of texture to tile onto the image background
94 \-tile-offset geometry
95 tile offset
96 \-treedepth value color tree depth
97 \-transparent-color color
98 transparent color
99 \-undercolor color annotation bounding box color
100 \-units type the units of image resolution
101 \-verbose print detailed information about the image
102 \-view FlashPix viewing transforms
103 \-virtual-pixel method
104 virtual pixel access method
105 \-weight type render text with this font weight
106 \-white-point point chromaticity white point
107
108Image Operators:
109 \-adaptive-blur geometry
110 adaptively blur pixels; decrease effect near edges
111 \-adaptive-resize geometry
112 adaptively resize image with data dependent triangulation
113 \-adaptive-sharpen geometry
114 adaptively sharpen pixels; increase effect near edges
115 \-annotate geometry text
116 annotate the image with text
117 \-auto-orient automatically orient image
118 \-black-threshold value
119 force all pixels below the threshold into black
120 \-blur geometry reduce image noise and reduce detail levels
121 \-border geometry surround image with a border of color
122 \-charcoal radius simulate a charcoal drawing
123 \-chop geometry remove pixels from the image interior
cristy1df20892012-11-04 01:06:40 +0000124 \-clamp keep pixel values in range (0-QuantumRange)
cristy3ed852e2009-09-05 21:47:34 +0000125 \-clip clip along the first path from the 8BIM profile
126 \-clip-mask filename associate a clip mask with the image
127 \-clip-path id clip along a named path from the 8BIM profile
128 \-colorize value colorize the image with the fill color
cristye6365592010-04-02 17:31:23 +0000129 \-color-matrix matrix apply color correction to the image
cristy3ed852e2009-09-05 21:47:34 +0000130 \-contrast enhance or reduce the image contrast
131 \-contrast-stretch geometry
132 improve contrast by `stretching' the intensity range
133 \-convolve coefficients
134 apply a convolution kernel to the image
135 \-cycle amount cycle the image colormap
136 \-despeckle reduce the speckles within an image
137 \-draw string annotate the image with a graphic primitive
138 \-edge radius apply a filter to detect edges in the image
139 \-emboss radius emboss an image
140 \-enhance apply a digital filter to enhance a noisy image
141 \-equalize perform histogram equalization to an image
142 \-evaluate operator value
143 evaluate an arithmetic, relational, or logical expression
144 \-extent geometry set the image size
145 \-extract geometry extract area from image
146 \-fft implements the discrete Fourier transform (DFT)
147 \-flip flip image vertically
148 \-floodfill geometry color
149 floodfill the image with color
150 \-flop flop image horizontally
151 \-frame geometry surround image with an ornamental border
152 \-gamma value level of gamma correction
153 \-gaussian-blur geometry
154 reduce image noise and reduce detail levels
cristy901f09d2009-10-16 22:56:10 +0000155 \-geometry geometry preferred size or location of the image
cristye0b9b8f2013-03-28 12:39:39 +0000156 \-grayscale method convert image to grayscale
cristy3ed852e2009-09-05 21:47:34 +0000157 \-ift implements the inverse discrete Fourier transform (DFT)
158 \-help print program options
159 \-identify identify the format and characteristics of the image
160 \-implode amount implode image pixels about the center
161 \-lat geometry local adaptive thresholding
162 \-layers method optimize or compare image layers
163 \-level value adjust the level of image contrast
164 \-linear-stretch geometry
165 improve contrast by `stretching with saturation' the intensity range
cristy7220ee42013-04-14 01:30:34 +0000166 \-magnify double the size of the image with pixel art scaling
cristy3c741502011-04-01 23:21:16 +0000167 \-median geometry apply a median filter to the image
glennrp30d2dc62011-06-25 03:17:16 +0000168 \-mode geometry make each pixel the 'predominant color' of the neighborhood
cristy3ed852e2009-09-05 21:47:34 +0000169 \-modulate value vary the brightness, saturation, and hue
170 \-monochrome transform image to black and white
171 \-motion-blur geometry
172 simulate motion blur
cristy2146a5f2010-02-01 01:28:35 +0000173 \-negate replace each pixel with its complementary color
cristy3c741502011-04-01 23:21:16 +0000174 \-noise geometry add or reduce noise in an image
cristy3ed852e2009-09-05 21:47:34 +0000175 \-normalize transform image to span the full range of colors
176 \-opaque color change this color to the fill color
177 \-ordered-dither NxN
178 add a noise pattern to the image with specific amplitudes
179 \-paint radius simulate an oil painting
180 \-polaroid angle simulate a Polaroid picture
181 \-posterize levels reduce the image to a limited number of color levels
182 \-print string interpret string and print to console
183 \-profile filename add, delete, or apply an image profile
184 \-quantize colorspace reduce colors in this colorspace
185 \-radial-blur angle radial blur the image
186 \-raise value lighten/darken image edges to create a 3-D effect
187 \-random-threshold low,high
188 random threshold the image
cristy3ed852e2009-09-05 21:47:34 +0000189 \-region geometry apply options to a portion of the image
190 \-render render vector graphics
191 \-repage geometry size and location of an image canvas
192 \-resample geometry change the resolution of an image
193 \-resize geometry resize the image
194 \-roll geometry roll an image vertically or horizontally
195 \-rotate degrees apply Paeth rotation to the image
196 \-sample geometry scale image with pixel sampling
197 \-scale geometry scale the image
198 \-segment values segment an image
199 \-selective-blur geometry
200 selectively blur pixels within a contrast threshold
201 \-sepia-tone threshold
202 simulate a sepia-toned photo
203 \-set property value set an image property
204 \-shade degrees shade the image using a distant light source
205 \-shadow geometry simulate an image shadow
206 \-sharpen geometry sharpen the image
207 \-shave geometry shave pixels from the image edges
208 \-shear geometry slide one edge of the image along the X or Y axis
209 \-sigmoidal-contrast geometry
210 lightness rescaling using sigmoidal contrast enhancement
211 \-sketch geometry simulate a pencil sketch
212 \-solarize threshold negate all pixels above the threshold level
213 \-splice geometry splice the background color into the image
214 \-spread amount displace image pixels by a random amount
cristy95c38342011-03-18 22:39:51 +0000215 \-statistic type geometry
cristy0834d642011-03-18 18:26:08 +0000216 replace each pixel with corresponding statistic from the neighborhood
cristy3ed852e2009-09-05 21:47:34 +0000217 \-strip strip image of all profiles and comments
218 \-swirl degrees swirl image pixels about the center
219 \-threshold value threshold the image
220 \-thumbnail geometry create a thumbnail of the image
221 \-tile filename tile image when filling a graphic primitive
222 \-tint value tint the image with the fill color
223 \-transform affine transform image
224 \-transparent color make this color transparent within the image
225 \-transpose flip image vertically and rotate 90 degrees
226 \-transverse flop image horizontally and rotate 270 degrees
227 \-trim trim image edges
228 \-type type image type
229 \-unique-colors discard all but one of any pixel color
230 \-unsharp geometry sharpen the image
231 \-vignette geometry soften the edges of the image in vignette style
232 \-wave geometry alter an image along a sine wave
233 \-white-threshold value
234 force all pixels above the threshold into white
235
cristy87c02f42012-02-24 00:19:10 +0000236Image Channel Operators:
237 \-channel-extract channel-list
238 extract the channels in order
239 \-channel-inject channel-list
240 inject the channels in order
241 \-channel-swap channel,channel
242 swap the channels
243
cristy3ed852e2009-09-05 21:47:34 +0000244Image Sequence Operators:
245 \-affinity filename transform image colors to match this set of colors
cristyde5f6c62010-09-13 17:16:07 +0000246 \-append append an image sequence top to botto (use +append for left to right)
cristy3ed852e2009-09-05 21:47:34 +0000247 \-clut apply a color lookup table to the image
248 \-coalesce merge a sequence of images
249 \-combine combine a sequence of images
250 \-composite composite image
251 \-crop geometry cut out a rectangular region of the image
252 \-deconstruct break down an image sequence into constituent parts
cristyd18ae7c2010-03-07 17:39:52 +0000253 \-evaluate-sequence operator
254 evaluate an arithmetic, relational, or logical expression
cristy3ed852e2009-09-05 21:47:34 +0000255 \-flatten flatten a sequence of images
256 \-fx expression apply mathematical expression to an image channel(s)
257 \-hald-clut apply a Hald color lookup table to the image
258 \-morph value morph an image sequence
259 \-mosaic create a mosaic from an image sequence
cristydbc2da92012-11-12 13:16:07 +0000260 \-poly terms build a polynomial from the image sequence and the corresponding terms (coefficients and degree pairs)
cristy3ed852e2009-09-05 21:47:34 +0000261 \-process arguments process the image with a custom image filter
262 \-separate separate an image channel into a grayscale image
cristydac5af22011-02-23 02:16:00 +0000263 \-smush geometry smush an image sequence together
cristy3ed852e2009-09-05 21:47:34 +0000264 \-write filename write images to this file
265
266Image Stack Operators:
anthonyac85a312011-03-23 08:19:50 +0000267 \-delete indexes delete the image from the image sequence
268 \-duplicate count,indexes
cristyecb10ff2011-03-22 13:14:03 +0000269 duplicate an image one or more times
cristy3ed852e2009-09-05 21:47:34 +0000270 \-insert index insert last image into the image sequence
271 \-swap indexes swap two images in the image sequence
272
273Miscellaneous Options:
274 \-debug events display copious debugging information
275 \-help print program options
276 \-log format format of debugging information
277 \-list type print a list of supported option arguments
278 \-version print version information
279
280By 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.
281.SH SEE ALSO
282ImageMagick(1)
283
284.SH COPYRIGHT
285
cristy45ef08f2012-12-07 13:13:34 +0000286\fBCopyright (C) 1999-2013 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