]> granicus.if.org Git - imagemagick/blob - utilities/magick-script.1.in
...
[imagemagick] / utilities / magick-script.1.in
1 .TH magick 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
2 .SH NAME
3 magick-script \- scripting language that converts 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 \fBmagick-script\fP [\fIinput-options\fP] \fIinput-file\fP [\fIoutput-options\fP] \fIoutput-file\fP
7 .SH OVERVIEW
8 The \fBmagick-script\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.  Here is an example script:
9
10     #!/bin/env magick-script
11     -size 100x100 xc:red ( rose: -rotate -90 ) +append  -write show:
12
13 For more information about the magick-script command, point your browser to file://@DOCUMENTATION_PATH@/www/magick-script.html or http://www.imagemagick.org/script/magick-script.php.
14 .SH DESCRIPTION
15 Image Settings:
16   \-adjoin              join images into a single multi-image file
17   \-affine matrix       affine transform matrix
18   \-antialias           remove pixel-aliasing
19   \-authenticate value  decrypt image with this password
20   \-background color    background color
21   \-bias value          add bias when convolving an image
22   \-black-point-compensation
23                        use black point compensation
24   \-blue-primary point  chromaticity blue primary point
25   \-bordercolor color   border color
26   \-caption string      assign a caption to an image
27   \-cdl filename        color correct with a color decision list
28   \-colors value        preferred number of colors in the image
29   \-colorspace type     alternate image colorspace
30   \-comment string      annotate image with comment
31   \-compose operator    set image composite operator
32   \-compress type       type of pixel compression when writing the image
33   \-decipher filename   magick cipher pixels to plain pixels
34   \-define format:option
35                        define one or more image format options
36   \-delay value         display the next image after pausing
37   \-density geometry    horizontal and vertical density of the image
38   \-depth value         image depth
39   \-direction type      render text right-to-left or left-to-right
40   \-display server      get image or font from this X server
41   \-dispose method      layer disposal method
42   \-dither method       apply error diffusion to image
43   \-encipher filename   magick plain pixels to cipher pixels
44   \-encoding type       text encoding type
45   \-endian type         endianness (MSB or LSB) of the image
46   \-family name         render text with this font family
47   \-fill color          color to use when filling a graphic primitive
48   \-filter type         use this filter when resizing an image
49   \-flatten             flatten a sequence of images
50   \-font name           render text with this font
51   \-format "string"     output formatted image characteristics
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
58   \-kerning value       set the space between two letters
59   \-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
66   \-orient type         image orientation
67   \-origin geometry     image origin
68   \-page geometry       size and location of an image canvas (setting)
69   \-ping                efficiently determine image attributes
70   \-pointsize value     font point size
71   \-preview type        image preview type
72   \-quality value       JPEG/MIFF/PNG compression level
73   \-quiet               suppress all warning messages
74   \-red-primary point   chromaticity red primary point
75   \-regard-warnings     pay attention to warning messages
76   \-repage geometry     size and location of an image canvas
77   \-sampling-factor geometry
78                        horizontal and vertical sampling factor
79   \-scene value         image scene number
80   \-seed value          seed a new sequence of pseudo-random numbers
81   \-size geometry       width and height of image
82   \-statistic type geometry
83                        replace each pixel with corresponding statistic from the neighborhood
84   \-stretch type        render text with this font stretch
85   \-stroke color        graphic primitive stroke color
86   \-strokewidth value   graphic primitive stroke width
87   \-style type          render text with this font style
88   \-support factor      resize support: > 1.0 is blurry, < 1.0 is sharp
89   \-synchronize         synchronize image to storage device
90   \-taint               declare the image as modified
91   \-texture filename    name of texture to tile onto the image background
92   \-tile-offset geometry
93                        tile offset
94   \-treedepth value     color tree depth
95   \-transparent-color color
96                        transparent color
97   \-undercolor color    annotation bounding box color
98   \-units type          the units of image resolution
99   \-verbose             print detailed information about the image
100   \-view                FlashPix viewing transforms
101   \-virtual-pixel method
102                        virtual pixel access method
103   \-weight type         render text with this font weight
104   \-white-point point   chromaticity white point
105
106 Image Operators:
107   \-adaptive-blur geometry
108                        adaptively blur pixels; decrease effect near edges
109   \-adaptive-resize geometry
110                        adaptively resize image with data dependent triangulation
111   \-adaptive-sharpen geometry
112                        adaptively sharpen pixels; increase effect near edges
113   \-annotate geometry text
114                        annotate the image with text
115   \-auto-orient         automatically orient image
116   \-black-threshold value
117                        force all pixels below the threshold into black
118   \-blur geometry       reduce image noise and reduce detail levels
119   \-border geometry     surround image with a border of color
120   \-channel mask        set the image channel mask
121   \-charcoal radius     simulate a charcoal drawing
122   \-chop geometry       remove pixels from the image interior
123   \-clip                clip along the first path from the 8BIM profile
124   \-clip-mask filename  associate a clip mask with the image
125   \-clip-path id        clip along a named path from the 8BIM profile
126   \-colorize value      colorize the image with the fill color
127   \-color-matrix matrix apply color correction to the image
128   \-contrast            enhance or reduce the image contrast
129   \-contrast-stretch geometry
130                        improve contrast by `stretching' the intensity range
131   \-convolve coefficients
132                        apply a convolution kernel to the image
133   \-cycle amount        cycle the image colormap
134   \-despeckle           reduce the speckles within an image
135   \-draw string         annotate the image with a graphic primitive
136   \-edge radius         apply a filter to detect edges in the image
137   \-emboss radius       emboss an image
138   \-enhance             apply a digital filter to enhance a noisy image
139   \-equalize            perform histogram equalization to an image
140   \-evaluate operator value
141                        evaluate an arithmetic, relational, or logical expression
142   \-extent geometry     set the image size
143   \-extract geometry    extract area from image
144   \-fft                 implements the discrete Fourier transform (DFT)
145   \-flip                flip image vertically
146   \-floodfill geometry color
147                        floodfill the image with color
148   \-flop                flop image horizontally
149   \-frame geometry      surround image with an ornamental border
150   \-function name       apply a function to the image
151   \-gamma value         level of gamma correction
152   \-gaussian-blur geometry
153                        reduce image noise and reduce detail levels
154   \-geometry geometry   preferred size or location of the image
155   \-identify            identify the format and characteristics of the image
156   \-ift                 implements the inverse discrete Fourier transform (DFT)
157   \-implode amount      implode image pixels about the center
158   \-lat geometry        local adaptive thresholding
159   \-layers method       optimize or compare image layers
160   \-level value         adjust the level of image contrast
161   \-linear-stretch geometry
162                        improve contrast by `stretching with saturation' the intensity range
163   \-median geometry     apply a median filter to the image
164   \-mode geometry       make each pixel the 'predominant color' of the neighborhood
165   \-modulate value      vary the brightness, saturation, and hue
166   \-monochrome          transform image to black and white
167   \-morphology method kernel
168                        apply a morphology method to the image
169   \-motion-blur geometry
170                        simulate motion blur
171   \-negate              replace each pixel with its complementary color 
172   \-noise geometry      add or reduce noise in an image
173   \-normalize           transform image to span the full range of colors
174   \-opaque color        change this color to the fill color
175   \-ordered-dither NxN
176                        add a noise pattern to the image with specific amplitudes
177   \-paint radius        simulate an oil painting
178   \-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
187   \-region geometry     apply options to a portion of the image
188   \-render              render vector graphics
189   \-resample geometry   change the resolution of an image
190   \-resize geometry     resize the image
191   \-roll geometry       roll an image vertically or horizontally
192   \-rotate degrees      apply Paeth rotation to the image
193   \-sample geometry     scale image with pixel sampling
194   \-scale geometry      scale the image
195   \-segment values      segment an image
196   \-selective-blur geometry
197                        selectively blur pixels within a contrast threshold
198   \-sepia-tone threshold
199                        simulate a sepia-toned photo
200   \-set property value  set an image property
201   \-shade degrees       shade the image using a distant light source
202   \-shadow geometry     simulate an image shadow
203   \-sharpen geometry    sharpen the image
204   \-shave geometry      shave pixels from the image edges
205   \-shear geometry      slide one edge of the image along the X or Y axis
206   \-sigmoidal-contrast geometry
207                        lightness rescaling using sigmoidal contrast enhancement
208   \-sketch geometry     simulate a pencil sketch
209   \-solarize threshold  negate all pixels above the threshold level
210   \-splice geometry     splice the background color into the image
211   \-spread amount       displace image pixels by a random amount
212   \-strip               strip image of all profiles and comments
213   \-swirl degrees       swirl image pixels about the center
214   \-threshold value     threshold the image
215   \-thumbnail geometry  create a thumbnail of the image
216   \-tile filename       tile image when filling a graphic primitive
217   \-tint value          tint the image with the fill color
218   \-transform           affine transform image
219   \-transparent color   make this color transparent within the image
220   \-transpose           flip image vertically and rotate 90 degrees
221   \-transverse          flop image horizontally and rotate 270 degrees
222   \-trim                trim image edges
223   \-type type           image type
224   \-unique-colors       discard all but one of any pixel color
225   \-unsharp geometry    sharpen the image
226   \-vignette geometry   soften the edges of the image in vignette style
227   \-wave geometry       alter an image along a sine wave
228   \-white-threshold value
229                        force all pixels above the threshold into white
230
231
232 Image Channel Operators:
233   \-channel-extract channel-list
234                         extract the channels in order
235   \-channel-inject channel-list
236                         inject the channels in order
237   \-channel-swap channel,channel
238                         swap the channels
239
240 Image Sequence Operators:
241   \-affinity filename   transform image colors to match this set of colors
242   \-append              append an image sequence top to bottom (use +append for left to right)
243   \-clut                apply a color lookup table to the image
244   \-coalesce            merge a sequence of images
245   \-combine             combine a sequence of images
246   \-composite           composite image
247   \-crop geometry       cut out a rectangular region of the image
248   \-deconstruct         break down an image sequence into constituent parts
249   \-evaluate-sequence operator
250                        evaluate an arithmetic, relational, or logical expression
251   \-flatten             flatten a sequence of images
252   \-fx expression       apply mathematical expression to an image channel(s)
253   \-hald-clut           apply a Hald color lookup table to the image
254   \-morph value         morph an image sequence
255   \-mosaic              create a mosaic from an image sequence
256   \-process arguments   process the image with a custom image filter
257   \-separate            separate an image channel into a grayscale image
258   \-smush geometry      smush an image sequence together
259   \-write filename      write images to this file
260
261 Image Stack Operators:
262   \-clone indexes       clone an image
263   \-delete indexes      delete the image from the image sequence
264   \-duplicate count,indexes
265                        duplicate an image one or more times
266   \-insert index        insert last image into the image sequence
267   \-swap indexes        swap two images in the image sequence
268
269 Miscellaneous Options:
270   \-debug events        display copious debugging information
271   \-help                print program options
272   \-log format          format of debugging information
273   \-list type           print a list of supported option arguments
274   \-version             print version information
275
276 Use 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.
277
278 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.
279 .SH SEE ALSO
280 ImageMagick(1)
281
282 .SH COPYRIGHT
283 \fBCopyright (C) 1999-2017 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