1gm(1) General Commands Manual gm(1)
2 NAME
6 gm - command-line utility to create, edit, compare, convert, or
8 display images
9
12 gm animate [ options ... ] file [ [ options ... ] file ... ]
13 gm batch [ options ... ] [ script ]
15 gm benchmark [ options ... ] subcommand
17 gm compare [ options ... ] reference-image [ options ... ] compare-
19 image [ options ... ]
20 gm composite [ options ... ] change-image base-image [ mask-image ]
22 output-image
23 gm conjure [ options ] script.msl [ [ options ] script.msl ]
25 gm convert [ [ options ... ] [ input-file ... ] [ options ... ] ] out‐
27 put-file
28 gm display [ options ... ] file ... [ [options ... ]file ... ]
30 gm identify file [ file ... ]
32 gm import [ options ... ] file
34 gm mogrify [ options ... ] file ...
36 gm montage [ options ... ] file [ [ options ... ] file ... ] output-
38 file
39 gm time subcommand
41 gm version
43
45 GraphicsMagick's gm provides a suite of utilities for creating, compar‐
46 ing, converting, editing, and displaying images. All of the utilities
47 are provided as sub-commands of a single gm executable. The gm exe‐
48 cutable returns the exit code 0 to indicate success, or 1 to indicate
49 failure:
50 animate displays an animation (e.g. a GIF file) on any workstation dis‐
52 play running an X server.
53 batch executes an arbitary number of the utility commands (e.g. con‐
55 vert) in the form of a simple linear batch script in order to improve
56 execution efficiency, and/or to allow use as a subordinate co-process
57 under the control of an arbitrary script or program.
58 benchmark executes one of the other utility commands (e.g. convert) for
60 a specified number of iterations, or execution time, and reports execu‐
61 tion time and other profiling information such as CPU utilization.
62 Benchmark provides various operating modes including executing the com‐
63 mand with a varying number of threads, and alternate reporting formats
64 such as comma-separated value (CSV).
65 compare compares two images and reports difference statistics according
67 to specified metrics and/or outputs an image with a visual representa‐
68 tion of the differences. It may also be used to test if images are
69 similar within a particular range and specified metric, returning a
70 truth value to the executing environment.
71 composite composites images (blends or merges images together) to cre‐
73 ate new images.
74 conjure interprets and executes scripts in the Magick Scripting Lan‐
76 guage (MSL).
77 convert converts an input file using one image format to an output file
79 with the same or differing image format while applying an arbitrary
80 number of image transformations.
81 display is a machine architecture independent image processing and dis‐
83 play facility. It can display an image on any workstation display run‐
84 ning an X server.
85 identify describes the format and characteristics of one or more image
87 files. It will also report if an image is incomplete or corrupt.
88 import reads an image from any visible window on an X server and out‐
90 puts it as an image file. You can capture a single window, the entire
91 screen, or any rectangular portion of the screen.
92 mogrify transforms an image or a sequence of images. These transforms
94 include image scaling, image rotation, color reduction, and others. The
95 transmogrified image overwrites the original image.
96 montage creates a composite by combining several separate images. The
98 images are tiled on the composite image with the name of the image
99 optionally appearing just below the individual tile.
100 time executes a subcommand and reports the user, system, and total exe‐
102 cution time consumed.
103 version reports the GraphicsMagick release version, maximum sample-
105 depth, copyright notice, supported features, and the options used while
106 building the software.
107 The GraphicsMagick utilities recognize the following image formats:
109 Name Mode Description
112 o 3FR r-- Hasselblad Photo RAW
113 o 8BIM rw- Photoshop resource format
114 o 8BIMTEXT rw- Photoshop resource text format
115 o 8BIMWTEXT rw- Photoshop resource wide text format
116 o APP1 rw- Raw application information
117 o APP1JPEG rw- Raw JPEG binary data
118 o ART r-- PF1: 1st Publisher
119 o ARW r-- Sony Alpha DSLR RAW
120 o AVS rw+ AVS X image
121 o BIE rw- Joint Bi-level Image experts Group
122 interchange format
123 o BMP rw+ Microsoft Windows bitmap image
124 o BMP2 -w- Microsoft Windows bitmap image v2
125 o BMP3 -w- Microsoft Windows bitmap image v3
126 o CACHE --- Magick Persistent Cache image format
127 o CALS rw- Continuous Acquisition and Life-cycle
128 Support Type 1 image
129 o CAPTION r-- Caption (requires separate size info)
130 o CIN rw- Kodak Cineon Format
131 o CMYK rw- Raw cyan, magenta, yellow, and black
132 samples (8 or 16 bits, depending on
133 the image depth)
134 o CMYKA rw- Raw cyan, magenta, yellow, black, and
135 matte samples (8 or 16 bits, depending
136 on the image depth)
137 o CR2 r-- Canon Photo RAW
138 o CRW r-- Canon Photo RAW
139 o CUR r-- Microsoft Cursor Icon
140 o CUT r-- DR Halo
141 o DCM r-- Digital Imaging and Communications in
142 Medicine image
143 o DCR r-- Kodak Photo RAW
144 o DCX rw+ ZSoft IBM PC multi-page Paintbrush
145 o DNG r-- Adobe Digital Negative
146 o DPS r-- Display PostScript Interpreter
147 o DPX rw- Digital Moving Picture Exchange
148 o EPDF rw- Encapsulated Portable Document Format
149 o EPI rw- Adobe Encapsulated PostScript
150 Interchange format
151 o EPS rw- Adobe Encapsulated PostScript
152 o EPS2 -w- Adobe Level II Encapsulated PostScript
153 o EPS3 -w- Adobe Level III Encapsulated PostScript
154 o EPSF rw- Adobe Encapsulated PostScript
155 o EPSI rw- Adobe Encapsulated PostScript
156 Interchange format
157 o EPT rw- Adobe Encapsulated PostScript with MS-DOS
158 TIFF preview
159 o EPT2 rw- Adobe Level II Encapsulated PostScript
160 with MS-DOS TIFF preview
161 o EPT3 rw- Adobe Level III Encapsulated PostScript
162 with MS-DOS TIFF preview
163 o EXIF rw- Exif digital camera binary data
164 o FAX rw+ Group 3 FAX (Not TIFF Group3 FAX!)
165 o FITS rw- Flexible Image Transport System
166 o FRACTAL r-- Plasma fractal image
167 o FPX rw- FlashPix Format
168 o GIF rw+ CompuServe graphics interchange format
169 o GIF87 rw- CompuServe graphics interchange format
170 (version 87a)
171 o GRADIENT r-- Gradual passing from one shade to
172 another
173 o GRAY rw+ Raw gray samples (8/16/32 bits,
174 depending on the image depth)
175 o HISTOGRAM -w- Histogram of the image
176 o HRZ r-- HRZ: Slow scan TV
177 o HTML -w- Hypertext Markup Language and a
178 client-side image map
179 o ICB rw+ Truevision Targa image
180 o ICC rw- ICC Color Profile
181 o ICM rw- ICC Color Profile
182 o ICO r-- Microsoft icon
183 o ICON r-- Microsoft icon
184 o IDENTITY r-- Hald CLUT identity image
185 o IMAGE r-- GraphicsMagick Embedded Image
186 o INFO -w+ Image descriptive information and
187 statistics
188 o IPTC rw- IPTC Newsphoto
189 o IPTCTEXT rw- IPTC Newsphoto text format
190 o IPTCWTEXT rw- IPTC Newsphoto wide text format
191 o JBG rw+ Joint Bi-level Image experts Group
192 interchange format
193 o JBIG rw+ Joint Bi-level Image experts Group
194 interchange format
195 o JNG rw- JPEG Network Graphics
196 o JP2 rw- JPEG-2000 JP2 File Format Syntax
197 o JPC rw- JPEG-2000 Code Stream Syntax
198 o JPEG rw- Joint Photographic Experts Group
199 JFIF format
200 o JPG rw- Joint Photographic Experts Group
201 JFIF format
202 o K25 r-- Kodak Photo RAW
203 o KDC r-- Kodak Photo RAW
204 o LABEL r-- Text image format
205 o M2V rw+ MPEG-2 Video Stream
206 o MAP rw- Colormap intensities and indices
207 o MAT r-- MATLAB image format
208 o MATTE -w+ MATTE format
209 o MIFF rw+ Magick Image File Format
210 o MNG rw+ Multiple-image Network Graphics
211 o MONO rw- Bi-level bitmap in least-significant-
212 -byte-first order
213 o MPC rw+ Magick Persistent Cache image format
214 o MPEG rw+ MPEG-1 Video Stream
215 o MPG rw+ MPEG-1 Video Stream
216 o MRW r-- Minolta Photo Raw
217 o MSL r-- Magick Scripting Language
218 o MTV rw+ MTV Raytracing image format
219 o MVG rw- Magick Vector Graphics
220 o NEF r-- Nikon Electronic Format
221 o NULL r-- Constant image of uniform color
222 o OTB rw- On-the-air bitmap
223 o P7 rw+ Xv thumbnail format
224 o PAL rw- 16bit/pixel interleaved YUV
225 o PALM rw- Palm Pixmap
226 o PBM rw+ Portable bitmap format (black and white)
227 o PCD rw- Photo CD
228 o PCDS rw- Photo CD
229 o PCL -w- Page Control Language
230 o PCT rw- Apple Macintosh QuickDraw/PICT
231 o PCX rw- ZSoft IBM PC Paintbrush
232 o PDB rw+ Palm Database ImageViewer Format
233 o PDF rw+ Portable Document Format
234 o PEF r-- Pentax Electronic File
235 o PFA r-- TrueType font
236 o PFB r-- TrueType font
237 o PGM rw+ Portable graymap format (gray scale)
238 o PGX r-- JPEG-2000 VM Format
239 o PICON rw- Personal Icon
240 o PICT rw- Apple Macintosh QuickDraw/PICT
241 o PIX r-- Alias/Wavefront RLE image format
242 o PLASMA r-- Plasma fractal image
243 o PNG rw- Portable Network Graphics
244 o PNG24 rw- Portable Network Graphics, 24 bit RGB
245 opaque only
246 o PNG32 rw- Portable Network Graphics, 32 bit RGBA
247 semitransparency OK
248 o PNG8 rw- Portable Network Graphics, 8-bit
249 indexed, binary transparency only
250 o PNM rw+ Portable anymap
251 o PPM rw+ Portable pixmap format (color)
252 o PREVIEW -w- Show a preview an image enhancement,
253 effect, or f/x
254 o PS rw+ Adobe PostScript
255 o PS2 -w+ Adobe Level II PostScript
256 o PS3 -w+ Adobe Level III PostScript
257 o PSD rw- Adobe Photoshop bitmap
258 o PTIF rw- Pyramid encoded TIFF
259 o PWP r-- Seattle Film Works
260 o RAF r-- Fuji Photo RAW
261 o RAS rw+ SUN Rasterfile
262 o RGB rw+ Raw red, green, and blue samples
263 o RGBA rw+ Raw red, green, blue, and matte samples
264 o RLA r-- Alias/Wavefront image
265 o RLE r-- Utah Run length encoded image
266 o SCT r-- Scitex HandShake
267 o SFW r-- Seattle Film Works
268 o SGI rw+ Irix RGB image
269 o SHTML -w- Hypertext Markup Language and a
270 client-side image map
271 o STEGANO r-- Steganographic image
272 o SUN rw+ SUN Rasterfile
273 o SVG rw+ Scalable Vector Gaphics
274 o TEXT rw+ Raw text
275 o TGA rw+ Truevision Targa image
276 o TIFF rw+ Tagged Image File Format
277 o TILE r-- Tile image with a texture
278 o TIM r-- PSX TIM
279 o TOPOL r-- TOPOL X Image
280 o TTF r-- TrueType font
281 o TXT rw+ Raw text
282 o UIL -w- X-Motif UIL table
283 o UYVY rw- 16bit/pixel interleaved YUV
284 o VDA rw+ Truevision Targa image
285 o VICAR rw- VICAR rasterfile format
286 o VID rw+ Visual Image Directory
287 o VIFF rw+ Khoros Visualization image
288 o VST rw+ Truevision Targa image
289 o WBMP rw- Wireless Bitmap (level 0) image
290 o WMF r-- Windows Metafile
291 o WPG r-- Word Perfect Graphics
292 o X rw- X Image
293 o X3F r-- Foveon X3 (Sigma/Polaroid) RAW
294 o XBM rw- X Windows system bitmap (black
295 and white)
296 o XC r-- Constant image uniform color
297 o XCF r-- GIMP image
298 o XMP rw- Adobe XML metadata
299 o XPM rw- X Windows system pixmap (color)
300 o XV rw+ Khoros Visualization image
301 o XWD rw- X Windows system window dump (color)
302 o YUV rw- CCIR 601 4:1:1 or 4:2:2 (8-bit only)
303 Modes:
305 r Read
306 w Write
307 + Multi-image
308 Support for some of these formats require additional programs or
311 libraries. See README in the source package for where to find optional
312 additional software.
313 Note, a format delineated with + means that if more than one image is
315 specified, frames are combined into a single multi-image file. Use
316 +adjoin if you want a single image produced for each frame.
317 Your installation might not support all of the formats in the list. To
319 get an accurate listing of the formats supported by your particular
320 configuration, run "gm convert -list format".
321 Raw images are expected to have one byte per pixel unless gm is com‐
323 piled in 16-bit quantum mode or in 32-bit quantum mode. Here, the raw
324 data is expected to be stored two or four bytes per pixel, respec‐
325 tively, in most-significant-byte-first order. For example, you can
326 tell if gm was compiled in 16-bit mode by typing "gm version" without
327 any options, and looking for "Q:16" in the first line of output.
328
330 By default, the image format is determined by its magic number, i.e.,
331 the first few bytes of the file. To specify a particular image format,
332 precede the filename with an image format name and a colon
333 (i.e.ps:image) or specify the image type as the filename suffix
334 (i.e.image.ps). The magic number takes precedence over the filename
335 suffix and the prefix takes precedence over the magic number and the
336 suffix in input files. When a file is read, its magic number is stored
337 in the "image->magick" string. In output files, the prefix takes
338 precedence over the filename suffix, and the filename suffix takes
339 precedence over the "image->magick" string.
340 To read the "built-in" formats (GRANITE, H, LOGO, NETSCAPE, PLASMA, and
342 ROSE) use a prefix (including the colon) without a filename or suffix.
343 To read the XC format, follow the colon with a color specification. To
344 read the CAPTION format, follow the colon with a text string or with a
345 filename prefixed with the at symbol (@).
346 When you specify X as your image type, the filename has special mean‐
349 ing. It specifies an X window by id, name, or root. If no filename is
350 specified, the window is selected by clicking the mouse in the desired
351 window.
352 Specify input_file as - for standard input, output_file as - for stan‐
354 dard output. If input_file has the extension .Z or .gz, the file is
355 uncompressed with uncompress or gunzip respectively. If output_file
356 has the extension .Z or .gz, the file is compressed using with compress
357 or gzip respectively.
358 Use an optional index enclosed in brackets after an input file name to
360 specify a desired subimage of a multi-resolution image format like
361 Photo CD (e.g. "img0001.pcd[4]") or a range for MPEG images (e.g.
362 "video.mpg[50-75]"). A subimage specification can be disjoint (e.g.
363 "image.tiff[2,7,4]"). For raw images, specify a subimage with a geome‐
364 try (e.g. -size 640x512 "image.rgb[320x256+50+50]"). Surround the
365 image name with quotation marks to prevent your shell from interpreting
366 the square brackets. Single images are written with the filename you
367 specify. However, multi-part images (e.g., a multi-page PostScript doc‐
368 ument with +adjoin specified) may be written with the scene number
369 included as part of the filename. In order to include the scene number
370 in the filename, it is necessary to include a printf-style %d format
371 specification in the file name and use the +adjoin option. For example,
372 image%02d.miff
374 writes files image00.miff, image01.miff, etc. Only a single specifica‐
377 tion is allowed within an output filename. If more than one specifica‐
378 tion is present, it will be ignored. It is best to embed the scene num‐
379 ber in the base part of the file name, not in the extension, because
380 the extension will not be a recognizeable image type.
381 When running a commandline utility, you can prepend an at sign @ to a
383 filename to read a list of image filenames from that file. This is con‐
384 venient in the event you have too many image filenames to fit on the
385 command line.
386
388 Options are processed in command line order. Any option you specify on
389 the command line remains in effect for the set of images that follows,
390 until the set is terminated by the appearance of any option or -noop.
391 Some options only affect the decoding of images and others only the
392 encoding. The latter can appear after the final group of input images.
393 This is a combined list of the command-line options used by the Graph‐
395 icsMagick utilities (animate, compare, composite, convert, display,
396 identify, import, mogrify and montage).
397 In this document, angle brackets ("<>") enclose variables and curly
400 brackets ("{}") enclose optional parameters. For example, "-fuzz <dis‐
401 tance>{%}" means you can use the option "-fuzz 10" or "-fuzz 2%".
402 -adjoin
405 join images into a single multi-image file
406 By default, all images of an image sequence are stored in the
408 same file. However, some formats (e.g. JPEG) do not support
409 storing more than one image per file and only the first frame in
410 an image sequence will be saved unless the result is saved to
411 separate files. Use +adjoin to force saving multiple frames to
412 multiple numbered files. If +adjoin is used, then the output
413 filename must include a printf style formatting specification
414 for the numeric part of the filename. For example,
415 image%02d.miff
417 -affine <matrix>
420 drawing transform matrix
421 This option provides a transform matrix {sx,rx,ry,sy,tx,ty} for
423 use by subsequent -draw or -transform options.
424 -antialias
426 remove pixel aliasing
427 By default antialiasing algorithms are used when drawing objects
429 (e.g. lines) or rendering vector formats (e.g. WMF and Post‐
430 script). Use +antialias to disable use of antialiasing algo‐
431 rithms. Reasons to disable antialiasing include avoiding
432 increasing colors in the image, or improving rendering speed.
433 -append
435 append a set of images
436 This option creates a single image where the images in the orig‐
438 inal set are stacked top-to-bottom. If they are not of the same
439 width, any narrow images will be expanded to fit using the back‐
440 ground color. Use +append to stack images left-to-right. The
441 set of images is terminated by the appearance of any option. If
442 the -append option appears after all of the input images, all
443 images are appended.
444 -asc-cdl <spec>
446 apply ASC CDL color transform
447 Applies ("bakes in") the ASC CDL, which is a format for the
449 exchange of basic primary color grading information between
450 equipment and software from different manufacturers. The format
451 defines the math for three functions: slope, offset and power.
452 Each function uses a number for the red, green, and blue color
453 channels for a total of nine numbers comprising a single color
454 decision. The tenth number (optional) is for chromiance (satura‐
455 tion) as specified by ASC CDL 1.2.
456 The argument string is comma delimited and is in the following
458 form (but without invervening spaces or line breaks)
459 redslope,redoffset,redpower:
461 greenslope,greenoffset,greenpower:
462 blueslope,blueoffset,bluepower:
463 saturation
464 with the unity (no change) specification being:
467 "1.0,0.0,1.0:1.0,0.0,1.0:1.0,0.0,1.0:1.0"
469 -authenticate <string>
472 decrypt image with this password
473 Use this option to supply a password for decrypting an image or
475 an image sequence, if it is being read from a format such as PDF
476 that supports encryption. Encrypting images being written is
477 not supported.
478 -auto-orient
480 orient (rotate) image so it is upright
481 Adjusts the image orienation so that it is suitable for viewing.
483 Uses the orientation tag obtained from the image file or as sup‐
484 plied by the -orient option.
485 -average
487 average a set of images
488 The set of images is terminated by the appearance of any option.
490 If the -average option appears after all of the input images,
491 all images are averaged.
492 -backdrop
494 display the image centered on a backdrop.
495 This backdrop covers the entire workstation screen and is useful
497 for hiding other X window activity while viewing the image. The
498 color of the backdrop is specified as the foreground color (X11
499 default is black). Refer to "X Resources", below, for details.
500 -background <color>
502 the background color
503 The color is specified using the format described under the
505 -fill option.
506 -black-threshold red[,green][,blue][,opacity]
508 pixels below the threshold become black
509 Use -black-threshold to set pixels with values below the speci‐
511 fied threshold to minimum value (black). If only one value is
512 supplied, or the red, green, and blue values are identical, then
513 intensity thresholding is used. If the color threshold values
514 are not identical then channel-based thresholding is used, and
515 color distortion will occur. Specify a negative value (e.g. -1)
516 if you want a channel to be ignored but you do want to threshold
517 a channel later in the list. If a percent (%) symbol is
518 appended, then the values are treated as a percentage of maximum
519 range.
520 -blue-primary <x>,<y>
522 blue chromaticity primary point
523 -blur <radius>{x<sigma>}
525 blur the image with a Gaussian operator
526 Blur with the given radius and standard deviation (sigma).
528 -border <width>x<height>
530 surround the image with a border of color
531 See -geometry for details about the geometry specification.
533 -bordercolor <color>
535 the border color
536 The color is specified using the format described under the
538 -fill option.
539 -borderwidth <geometry>
541 the border width
542 -box <color>
544 set the color of the annotation bounding box
545 The color is specified using the format described under the
547 -fill option.
548 See -draw for further details.
550 -channel <type>
552 the type of channel
553 Choose from: Red, Green, Blue, Opacity, Matte, Cyan, Magenta,
555 Yellow, Black, or Gray.
556 Use this option to extract a particular channel from the image.
558 Opacity, for example, is useful for extracting the opacity val‐
559 ues from an image.
560 -charcoal <factor>
562 simulate a charcoal drawing
563 -chop <width>x<height>{+-}<x>{+-}<y>{%}
565 remove pixels from the interior of an image
566 Width and height give the number of columns and rows to remove,
568 and x and y are offsets that give the location of the leftmost
569 column and topmost row to remove.
570 The x offset normally specifies the leftmost column to remove.
572 If the -gravity option is present with NorthEast, East, or
573 SouthEast gravity, it gives the distance leftward from the right
574 edge of the image to the rightmost column to remove. Similarly,
575 the y offset normally specifies the topmost row to remove, but
576 if the -gravity option is present with SouthWest, South, or
577 SouthEast gravity, it specifies the distance upward from the
578 bottom edge of the image to the bottom row to remove.
579 The -chop option removes entire rows and columns, and moves the
581 remaining corner blocks leftward and upward to close the gaps.
582 -clip apply the clipping path, if one is present
584 If a clipping path is present, it will be applied to subsequent
586 operations.
587 For example, if you type the following command:
589 gm convert -clip -negate cockatoo.tif negated.tif
591 only the pixels within the clipping path are negated.
594 The -clip feature requires the XML library. If the XML library
596 is not present, the option is ignored.
597 -coalesce
599 merge a sequence of images
600 Each image N in the sequence after Image 0 is replaced with the
602 image created by flattening images 0 through N.
603 The set of images is terminated by the appearance of any option.
605 If the -coalesce option appears after all of the input images,
606 all images are coalesced.
607 -colorize <value>
609 colorize the image with the pen color
610 Specify the amount of colorization as a percentage. You can
612 apply separate colorization values to the red, green, and blue
613 channels of the image with a colorization value list delimited
614 with slashes (e.g. 0/0/50).
615 The -colorize option may be used in conjunction with -modulate
617 to produce a nice sepia toned image like:
618 gm convert input.ppm -modulate 115,0,100 \
620 -colorize 7,21,50 output.ppm.
621 -colormap <type>
624 define the colormap type
625 Choose between shared or private.
627 This option only applies when the default X server visual is
629 PseudoColor or GRAYScale. Refer to -visual for more details. By
630 default, a shared colormap is allocated. The image shares colors
631 with other X clients. Some image colors could be approximated,
632 therefore your image may look very different than intended.
633 Choose Private and the image colors appear exactly as they are
634 defined. However, other clients may go technicolor when the
635 image colormap is installed.
636 -colors <value>
638 preferred number of colors in the image
639 The actual number of colors in the image may be less than your
641 request, but never more. Note, this is a color reduction option.
642 Images with less unique colors than specified with this option
643 will have any duplicate or unused colors removed. The ordering
644 of an existing color palette may be altered. When converting an
645 image from color to grayscale, convert the image to the gray
646 colorspace before reducing the number of colors since doing so
647 is most efficient. Refer to <a href="quantize.html">quantize for
648 more details.
649 Note, options -dither, -colorspace, and -treedepth affect the
651 color reduction algorithm.
652 -colorspace <value>
654 the type of colorspace
655 Choices are: CineonLog, CMYK, GRAY, HSL, HWB, OHTA, RGB,
657 Rec601Luma, Rec709Luma, Rec601YCbCr, Rec709YCbCr, Transparent,
658 XYZ, YCbCr, YIQ, YPbPr, or YUV.
659 Color reduction, by default, takes place in the RGB color space.
661 Empirical evidence suggests that distances in color spaces such
662 as YUV or YIQ correspond to perceptual color differences more
663 closely than do distances in RGB space. These color spaces may
664 give better results when color reducing an image. Refer to
665 quantize for more details. Two gray colorspaces are supported.
666 The Rec601Luma space is based on the recommendations for legacy
667 NTSC television (ITU-R BT.601-5). The Rec709Luma space is based
668 on the recommendations for HDTV (Rec. ITU-R BT.709-5) and is
669 suitable for use with computer graphics, and for contemporary
670 CRT displays. The GRAY colorspace currently selects the
671 Rec601Luma colorspace by default for backwards compatibly rea‐
672 sons. This default may be re-considered in the future.
673 Two YCbCr colorspaces are supported. The Rec601YCbCr space is
675 based on the recommendations for legacy NTSC television (ITU-R
676 BT.601-5). The Rec709CbCr space is based on the recommendations
677 for HDTV (Rec. ITU-R BT.709-5) and is suitable for suitable for
678 use with computer graphics, and for contemporary CRT displays.
679 The YCbCr colorspace specification is equivalent toRec601YCbCr.
680 The Transparent color space behaves uniquely in that it pre‐
683 serves the matte channel of the image if it exists.
684 The -colors or -monochrome option, or saving to a file format
686 which requires color reduction, is required for this option to
687 take effect.
688 -comment <string>
690 annotate an image with a comment
691 Use this option to assign a specific comment to the image, when
693 writing to an image format that supports comments. You can
694 include the image filename, type, width, height, or other image
695 attribute by embedding special format characters listed under
696 the -format option. The comment is not drawn on the image, but
697 is embedded in the image datastream via a "Comment" tag or simi‐
698 lar mechanism. If you want the comment to be visible on the
699 image itself, use the -draw option instead.
700 For example,
702 -comment "%m:%f %wx%h"
704 produces an image comment of MIFF:bird.miff 512x480 for an image
707 titled bird.miff and whose width is 512 and height is 480.
708 If the first character of string is @, the image comment is read
710 from a file titled by the remaining characters in the string.
711 Please note that if the string comes from an untrusted source
712 that it should be sanitized before use since otherwise the con‐
713 tent of an arbitrary readable file could be incorporated in a
714 comment in the output file (a security risk).
715 If the -comment option appears multiple times, only the last
717 comment is stored.
718 In PNG images, the comment is stored in a tEXt or zTXt chunk
720 with the keyword "comment".
721 -compose <operator>
723 the type of image composition
724 The description of composition uses abstract terminology in
726 order to allow the the description to be more clear, while
727 avoiding constant values which are specific to a particular
728 build configuration. Each image pixel is represented by red,
729 green, and blue levels (which are equal for a gray pixel).
730 MaxRGB is the maximum integral value which may be stored in the
731 red, green, or blue channels of the image. Each image pixel may
732 also optionally (if the image matte channel is enabled) have an
733 associated level of opacity (ranging from opaque to transpar‐
734 ent), which may be used to determine the influence of the pixel
735 color when compositing the pixel with another image pixel. If
736 the image matte channel is disabled, then all pixels in the
737 image are treated as opaque. The color of an opaque pixel is
738 fully visible while the color of a transparent pixel color is
739 entirely absent (pixel color is ignored).
740 By definition, raster images have a rectangular shape. All image
742 rows are of equal length, and all image columns have the same
743 number of rows. By treating the opacity channel as a visual
744 "mask" the rectangular image may be given a "shape" by treating
745 the opacity channel as a cookie-cutter for the image. Pixels
746 within the shape are opaque, while pixels outside the shape are
747 transparent. Pixels on the boundary of the shape may be between
748 opaque and transparent in order to provide antialiasing (visual‐
749 ly smooth edges). The description of the composition operators
750 use this concept of image "shape" in order to make the descrip‐
751 tion of the operators easier to understand. While it is conve‐
752 nient to describe the operators in terms of "shapes" they are by
753 no means limited to mask-style operations since they are based
754 on continuous floating-point mathematics rather than simple
755 boolean operations.
756 By default, the Over composite operator is used. The following
758 composite operators are available:
759 Over
761 In
762 Out
763 Atop
764 Xor
765 Plus
766 Minus
767 Add
768 Subtract
769 Difference
770 Divide
771 Multiply
772 Bumpmap
773 Copy
774 CopyRed
775 CopyGreen
776 CopyBlue
777 CopyOpacity
778 CopyCyan
779 CopyMagenta
780 CopyYellow
781 CopyBlack
782 The behavior of each operator is described below.
785 Over
788 The result will be the union of the two image shapes, with
790 opaque areas of change-image obscuring base-image in the
791 region of overlap.
792 In
794 The result is simply change-image cut by the shape of
796 base-image. None of the image data of base-image will be
797 in the result.
798 Out
800 The resulting image is change-image with the shape of
802 base-image cut out.
803 Atop
805 The result is the same shape as base-image, with change-
807 image obscuring base-image where the image shapes overlap.
808 Note this differs from over because the portion of change-
809 image outside base-image's shape does not appear in the
810 result.
811 Xor
813 The result is the image data from both change-image and
815 base-image that is outside the overlap region. The overlap
816 region will be blank.
817 Plus
819 The result is just the sum of the image data. Output val‐
821 ues are cropped to MaxRGB (no overflow). This operation is
822 independent of the matte channels.
823 Minus
825 The result of change-image - base-image, with underflow
827 cropped to zero. The matte channel is ignored (set to
828 opaque, full coverage).
829 Add
831 The result of change-image + base-image, with overflow
833 wrapping around (mod MaxRGB+1).
834 Subtract
836 The result of change-image - base-image, with underflow
838 wrapping around (mod MaxRGB+1). The add and subtract oper‐
839 ators can be used to perform reversible transformations.
840 Difference
842 The result of abs(change-image - base-image). This is use‐
844 ful for comparing two very similar images.
845 Divide
847 The result of change-image / base-image. This is useful
849 for improving the readability of text on unevenly illumi‐
850 nated photos (by using a gaussian blurred copy of change-
851 image as base-image).
852 Multiply
854 The result of change-image * base-image. This is useful
856 for the creation of drop-shadows.
857 Bumpmap
859 The result base-image shaded by change-image.
861 Copy
863 The resulting image is base-image replaced with change-
865 image. Here the matte information is ignored.
866 CopyRed
868 The resulting image is the red channel in base-image
870 replaced with the red channel in change-image. The other
871 channels are copied untouched.
872 CopyGreen
874 The resulting image is the green channel in base-image
876 replaced with the green channel in change-image. The other
877 channels are copied untouched.
878 CopyBlue
880 The resulting image is the blue channel in base-image
882 replaced with the blue channel in change-image. The other
883 channels are copied untouched.
884 CopyOpacity
886 The resulting image is the opacity channel in base-image
888 replaced with the opacity channel in change-image. The
889 other channels are copied untouched.
890 CopyCyan
892 The resulting image is the cyan channel in base-image
894 replaced with the cyan channel in change-image. The other
895 channels are copied untouched. Use of this operator
896 requires that base-image be in CMYK(A) colorspace.
897 CopyMagenta
899 The resulting image is the magenta channel in base-image
901 replaced with the magenta channel in change-image. The
902 other channels are copied untouched. Use of this operator
903 requires that base-image be in CMYK(A) colorspace.
904 CopyYellow
906 The resulting image is the yellow channel in base-image
908 replaced with the yellow channel in change-image. The
909 other channels are copied untouched. Use of this operator
910 requires that base-image be in CMYK(A) colorspace.
911 CopyBlack
913 The resulting image is the black channel in base-image
915 replaced with the black channel in change-image. The other
916 channels are copied untouched. Use of this operator
917 requires that base-image be in CMYK(A) colorspace. If
918 change-image is not in CMYK space, then the change-image
919 pixel intensities are used.
920 -compress <type>
925 the type of image compression
926 Choices are: None, BZip, Fax, Group3, Group4, JPEG, Lossless,
928 LZW, RLE, Zip, LZMA, JPEG2000, JPEG2000, JBIG, JBIG2, WebP, or
929 ZSTD.
930 Specify +compress to store the binary image in an uncompressed
933 format. The default is the compression type of the specified
934 image file.
935 "Lossless" refers to lossless JPEG, which is only available if
937 the JPEG library has been patched to support it. Use of lossless
938 JPEG is generally not recommended.
939 Use the -quality option to set the compression level to be used
941 by the JPEG, JPEG-2000, PNG, MIFF, MPEG, and TIFF encoders. Use
942 the -sampling-factor option to set the sampling factor to be
943 used by the DPX, JPEG, MPEG, and YUV encoders for downsampling
944 the chroma channels.
945 -contrast
947 enhance or reduce the image contrast
948 This option enhances the intensity differences between the
950 lighter and darker elements of the image. Use -contrast to
951 enhance the image or +contrast to reduce the image contrast.
952 For a more pronounced effect you can repeat the option:
955 gm convert rose: -contrast -contrast rose_c2.png
957 -convolve <kernel>
960 convolve image with the specified convolution kernel
961 The kernel is specified as a comma-separated list of floating
963 point values, ordered left-to right, starting with the top row.
964 The order of the kernel is determined by the square root of the
965 number of entries. Presently only square kernels are supported.
966 -create-directories
968 create output directory if required
969 Use this option with -output-directory if the input paths con‐
971 tain subdirectories and it is desired to create similar subdi‐
972 rectories in the output directory. Without this option, mogrify
973 will fail if the required output directory does not exist.
974 -crop <width>x<height>{+-}<x>{+-}<y>{%}
976 preferred size and location of the cropped image
977 See -geometry for details about the geometry specification.
979 The width and height give the size of the image that remains
981 after cropping, and x and y are offsets that give the location
982 of the top left corner of the cropped image with respect to the
983 original image. To specify the amount to be removed, use -shave
984 instead.
985 If the x and y offsets are present, a single image is generated,
987 consisting of the pixels from the cropping region. The offsets
988 specify the location of the upper left corner of the cropping
989 region measured downward and rightward with respect to the upper
990 left corner of the image. If the -gravity option is present
991 with NorthEast, East, or SouthEast gravity, it gives the dis‐
992 tance leftward from the right edge of the image to the right
993 edge of the cropping region. Similarly, if the -gravity option
994 is present with SouthWest, South, or SouthEast gravity, the dis‐
995 tance is measured upward between the bottom edges.
996 If the x and y offsets are omitted, a set of tiles of the speci‐
998 fied geometry, covering the entire input image, is generated.
999 The rightmost tiles and the bottom tiles are smaller if the
1000 specified geometry extends beyond the dimensions of the input
1001 image.
1002 -cycle <amount>
1004 displace image colormap by amount
1005 Amount defines the number of positions each colormap entry
1007 isshifted.
1008 -debug <events>
1011 enable debug printout
1012 The events parameter specifies which events are to be logged.
1014 It can be either None, All, or a comma-separated list consisting
1015 of one or more of the following domains: Annotate, Blob, Cache,
1016 Coder, Configure, Deprecate, Error, Exception, FatalError,
1017 Information, Locale, Option, Render, Resource, TemporaryFile,
1018 Transform, User. Warning, or X11, For example, to log cache and
1019 blob events, use
1020 gm convert -debug "Cache,Blob" rose: rose.png
1022 The "User" domain is normally empty, but developers can log
1025 "User" events in their private copy of GraphicsMagick.
1026 Use the -log option to specify the format for debugging output.
1028 Use +debug to turn off all logging.
1030 An alternative to using -debug is to use the MAGICK_DEBUG envi‐
1032 ronment variable. The allowed values for the MAGICK_DEBUG envi‐
1033 ronment variable are the same as for the -debug option.
1034 -deconstruct
1036 break down an image sequence into constituent parts
1037 This option compares each image with the next in a sequence and
1039 returns the maximum bounding region of any pixel differences it
1040 discovers. This method can undo a coalesced sequence returned
1041 by the -coalesce option, and is useful for removing redundant
1042 information from a GIF or MNG animation.
1043 The sequence of images is terminated by the appearance of any
1045 option. If the -deconstruct option appears after all of the
1046 input images, all images are deconstructed.
1047 -define <key>{=<value>},...
1049 add coder/decoder specific options This option creates one or
1050 more definitions for coders and decoders to use while reading
1051 and writing image data. Definitions may be passed to coders and
1052 decoders to control options that are specific to certain image
1053 formats. If value is missing for a definition, an empty-valued
1054 definition of a flag will be created with that name. This is
1055 used to control on/off options. Use +define <key>,... to remove
1056 definitions previously created. Use +define "*" to remove all
1057 existing definitions.
1058 The following definitions may be created:
1060 cineon:colorspace={rgb|cineonlog}
1063 Use the cineon:colorspace option when reading a Cineon
1065 file to specify the colorspace the Cineon file uses. This
1066 overrides the colorspace type implied by the DPX header
1067 (if any).
1068 dpx:bits-per-sample=<value>
1070 If the dpx:bits-per-sample key is defined, GraphicsMagick
1072 will write DPX images with the specified bits per sample,
1073 overriding any existing depth value. If this option is not
1074 specified, then the value is based on the existing image
1075 depth value from the original image file. The DPX standard
1076 supports bits per sample values of 1, 8, 10, 12, and 16.
1077 Many DPX readers demand a sample size of 10 bits with type
1078 A padding (see below).
1079 dpx:colorspace={rgb|cineonlog}
1081 Use the dpx:colorspace option when reading a DPX file to
1083 specify the colorspace the DPX file uses. This overrides
1084 the colorspace type implied by the DPX header (if any).
1085 dpx:packing-method={packed|a|b|lsbpad|msbpad}
1087 DPX samples are output within 32-bit words. They may be
1089 tightly packed end-to-end within the words ("packed"),
1090 padded with null bits to the right of the sample ("a" or
1091 "lsbpad"), or padded with null bits to the left of the
1092 sample ("b" or "msbpad"). This option only has an effect
1093 for sample sizes of 10 or 12 bits. If samples are not
1094 packed, the DPX standard recommends type A padding. Many
1095 DPX readers demand a sample size of 10 bits with type A
1096 padding.
1097 dpx:pixel-endian={lsb|msb}
1099 Allows the user to specify the endian order of the pixels
1101 when reading or writing the DPX files. Sometimes this is
1102 useful if the file is (or must be) written incorrectly so
1103 that the file header and the pixels use different endian‐
1104 ness.
1105 dpx:swap-samples={true|false}
1107 dpx:swap-samples-read={true|false}
1109 dpx:swap-samples-write={true|false}
1111 GraphicsMagick strives to adhere to the DPX standard but
1113 certain aspects of the standard can be quite confusing. As
1114 a result, some 10-bit DPX files have Red and Blue inter‐
1115 changed, or Cb and Cr interchanged due to an different
1116 interpretation of the standard, or getting the wires
1117 crossed. The swap-samples option may be supplied when
1118 reading or writing in order to read or write using the
1119 necessary sample order. Use swap-samples-read when swap‐
1120 ping should only occur in the reader, or swap-samples-
1121 write when swapping should only occur in the writer.
1122 gradient:direction={South|North|West|East|NorthWest|North‐
1124 East|SouthWest|SouthEast}
1125 By default, the gradient coder produces a gradient from
1127 top to bottom ("South"). Since GraphicsMagick 1.3.35, the
1128 gradient direction may be specified to produce gradient
1129 vectors according to a gravity-like specification. The
1130 arguments are South (Top to Bottom), North (Bottom to
1131 Top), West (Right to Left), East (Left to Right), North‐
1132 West (Bottom-Right to Top-Left), NorthEast (Bottom-Left to
1133 Top-Right), SouthWest (Top-Right Bottom-Left), and South‐
1134 East (Top-Left to Bottom-Right).
1135 jp2:rate=<value>
1137 Specify the compression factor to use while writing
1139 JPEG-2000 files. The compression factor is the reciprocal
1140 of the compression ratio. The valid range is 0.0 to 1.0,
1141 with 1.0 indicating lossless compression. If defined, this
1142 value overrides the -quality setting. The default quality
1143 setting of 75 results in a rate value of 0.06641.
1144 jpeg:block-smoothing={true|false}
1146 Enables or disables block smoothing when reading a JPEG
1148 file (default enabled).
1149 jpeg:dct-method=<value>
1151 Selects the IJG JPEG library DCT implementation to use.
1153 The encoding implementations vary in speed and encoding
1154 error. The available choices for value are islow, ifast,
1155 float, default and fastest. Note that fastest might not
1156 necessarily be fastest on your CPU, depending on the
1157 choices made when the JPEG library was built and how your
1158 CPU behaves.
1159 jpeg:fancy-upsampling={true|false}
1161 Enables or disables fancy upsampling when reading a JPEG
1163 file (default enabled).
1164 jpeg:max-scan-number=<value>
1166 Specifies an integer value for the maximum number of pro‐
1168 gressive scans allowed in a JPEG file. The default maxi‐
1169 mum is 100 scans. This limit is imposed due to a weakness
1170 in the JPEG standard which allows small JPEG files to take
1171 many minutes or hours to be read.
1172 jpeg:max-warnings=<value>
1174 Specifies an integer value for how many warnings are
1176 allowed for any given error type before being promoted to
1177 a hard error. JPEG files producing excessive warnings
1178 indicate a problem with the file.
1179 jpeg:optimize-coding={true|false}
1181 Selects if huffman encoding should be used. Huffman encod‐
1183 ing is enabled by default, but may be disabled for very
1184 large images since it encoding requires that the entire
1185 image be buffered in memory. Huffman encoding produces
1186 smaller JPEG files at the expense of added compression
1187 time and memory consumption.
1188 jpeg:preserve-settings
1190 If the jpeg:preserve-settings flag is defined, the JPEG
1192 encoder will use the same "quality" and "sampling-factor"
1193 settings that were found in the input file, if the input
1194 was in JPEG format. These settings are also preserved if
1195 the input is a JPEG file and the output is a JNG file. If
1196 the colorspace of the output file differs from that of the
1197 input file, the quality setting is preserved but the sam‐
1198 pling-factors are not.
1199 pcl:fit-to-page
1201 If the pcl:fit-to-page flag is defined, then the printer
1203 is requested to scale the image to fit the page size
1204 (width and/or height).
1205 mng:maximum-loops=<value>
1206 mng:maximum-loops specifies the maximum number of loops
1208 allowed to be specified by a MNG LOOP chunk. Without an
1209 imposed limit, a MNG file could request up to 2147483647
1210 loops, which could run for a very long time. The current
1211 default limit is 512 loops.
1212 pdf:use-cropbox={true|false}
1214 If the pdf:use-cropbox flag is set to true, then Ghost‐
1216 script is requested to apply the PDF crop box.
1217 pdf:stop-on-error={true|false}
1219 If the pdf:stop-on-error flag is set to true, then Ghost‐
1221 script is requested to stop processing the PDF when the
1222 first error is encountered. Otherwise it will attempt to
1223 process all requested pages.
1224 ps:imagemask
1226 If the ps:imagemask flag is defined, the PS3 and EPS3
1228 coders will create Postscript files that render bilevel
1229 images with the Postscript imagemask operator instead of
1230 the image operator.
1231 ptif:minimum-geometry=<geometry>
1233 If the ptif:minimum-geometry key is defined, GraphicsMag‐
1235 ick will use it to determine the minimum frame size to
1236 output when writing a pyramid TIFF file (a TIFF file con‐
1237 taining a succession of reduced versions of the first
1238 frame). The default minimum geometry is 32x32.
1239 tiff:alpha={unspecified|associated|unassociated}
1241 Specify the TIFF alpha channel type when reading or writ‐
1243 ing TIFF files, overriding the normal value. The default
1244 alpha channel type for new files is unspecified alpha.
1245 Existing alpha settings are preserved when converting from
1246 one TIFF file to another. When a TIFF file uses associated
1247 alpha, the image pixels are pre-multiplied (i.e. altered)
1248 with the alpha channel. Files with "associated" alpha
1249 appear as if they were alpha composited on a black back‐
1250 ground when the matte channel is disabled. If the unasso‐
1251 ciated alpha type is selected, then the alpha channel is
1252 saved without altering the pixels. Photoshop recognizes
1253 associated alpha as transparency information, if the file
1254 is saved with unassociated alpha, the alpha information is
1255 loaded as an independent channel. Note that for many
1256 years, ImageMagick and GraphicsMagick marked TIFF files as
1257 using associated alpha, without properly pre-multiplying
1258 the pixels.
1259 tiff:fill-order={msb2lsb|lsb2msb}
1261 If the tiff:fill-order key is defined, GraphicsMagick will
1263 use it to determine the bit fill order used while writing
1264 TIFF files. The normal default is "msb2lsb", which matches
1265 the native bit order of all modern CPUs. The only excep‐
1266 tion to this is when Group3 or Group4 FAX compression is
1267 requested since FAX machines send data in bit-reversed
1268 order and therefore RFC 2301 recommends using reverse
1269 order.
1270 tiff:group-three-options=<value>
1272 If the tiff:group-three-options key is defined, Graphics‐
1274 Magick will use it to set the group3 options tag when
1275 writing group3-compressed TIFF. Please see the TIFF spec‐
1276 ification for the usage of this tag. The default value is
1277 4.
1278 tiff:ignore-tags=<tags>
1280 If the tiff:ignore-tags key is defined, then it is used as
1282 a list of comma-delimited integer TIFF tag values to
1283 ignore while reading the TIFF file. This is useful in
1284 order to be able to read files which which otherwise fail
1285 to read due to problems with TIFF tags. Note that some
1286 TIFF tags are required in order to be able to read the
1287 image data at all.
1288 tiff:report-warnings={false|true}
1290 If the tiff:report-warnings key is defined and set to
1292 true, then TIFF warnings are reported as a warning excep‐
1293 tion rather than as a coder log message. Such warnings
1294 are reported after the image has been read or written.
1295 Most TIFF warnings are benign but sometimes they may help
1296 deduce problems with the TIFF file, or help detect that
1297 the TIFF file requires a special application to read suc‐
1298 cessfully due to the use of proprietary or specialized
1299 extensions.
1300 tiff:sample-format={unsigned|ieeefp}
1302 If the tiff:sample-format key is defined, GraphicsMagick
1304 will use it to determine the sample format used while
1305 writing TIFF files. The default is "unsigned". Specify
1306 "ieeefp" in order to write floating-point TIFF files with
1307 float (32-bit) or double (64-bit) values. Use the
1308 tiff:bits-per-sample define to determine the type of
1309 floating-point value to use.
1310 tiff:max-sample-value=<value>
1312 If the tiff:max-sample-value key is defined, GraphicsMag‐
1314 ick will use the assigned value as the maximum floating
1315 point value while reading or writing IEEE floating point
1316 TIFFs. Otherwise the maximum value is 1.0 or the value
1317 obtained from the file's SMaxSampleValue tag (if present).
1318 The floating point data is currently not scanned in
1319 advance to determine a best maximum sample value so if the
1320 range is not 1.0, or the SMaxSampleValue tag is not
1321 present, it may be necessary to (intelligently) use this
1322 parameter to properly read a file.
1323 tiff:min-sample-value=<value>
1325 If the tiff:min-sample-value key is defined, GraphicsMag‐
1327 ick will use the assigned value as the minimum floating
1328 point value while reading or writing IEEE floating point
1329 TIFFs. Otherwise the minimum value is 0.0 or the value
1330 obtained from the file's SMinSampleValue tag (if present).
1331 tiff:bits-per-sample=<value>
1333 If the tiff:bits-per-sample key is defined, GraphicsMagick
1335 will write images with the specified bits per sample,
1336 overriding any existing depth value. Value may be any in
1337 the range of 1 to 32, or 64 when the default ´unsigned'
1338 format is written, or 16/32/24/64 if IEEEFP format is
1339 written. Please note that the baseline TIFF 6.0 specifi‐
1340 cation only requires readers to handle certain powers of
1341 two, and the values to be handled depend on the nature of
1342 the image (e.g. colormapped, grayscale, RGB, CMYK).
1343 tiff:samples-per-pixel=<value>
1345 If the tiff:samples-per-pixel key is defined to a value,
1347 the TIFF coder will write TIFF images with the defined
1348 samples per pixel, overriding any value stored in the
1349 image. This option should not normally be used.
1350 tiff:rows-per-strip=<value>
1352 Allows the user to specify the number of rows per TIFF
1354 strip. Rounded up to a multiple of 16 when using JPEG
1355 compression. Ignored when using tiles.
1356 tiff:strip-per-page=true
1358 Requests that the image is written in a single TIFF strip.
1360 This is normally the default when group3 or group4 com‐
1361 pression is requested within reasonable limits. Requesting
1362 a single strip for large images may result in failure due
1363 to resource consumption in the writer or reader.
1364 tiff:tile
1366 Enable writing tiled TIFF (rather than stripped) using the
1368 default tile size. Tiled TIFF organizes the image as an
1369 array of smaller images (tiles) in order to enable random
1370 access.
1371 tiff:tile-geometry=<width>x<height>
1373 Specify the tile size to use while writing tiled TIFF.
1375 Width and height should be a multiple of 16. If the value
1376 is not a multiple of 16, then it will be rounded down.
1377 Enables tiled TIFF if it has not already been enabled.
1378 GraphicsMagick does not use tiled storage internally so
1379 tiles need to be converted back and forth from the inter‐
1380 nal scanline-oriented storage to tile-oriented storage.
1381 Testing with typical RGB images shows that useful square
1382 tile size values range from 128x128 to 1024x1024. Large
1383 images which require using a disk-based pixel cache bene‐
1384 fit from large tile sizes while images which fit in memory
1385 work well with smaller tile sizes.
1386 tiff:tile-width=<width>
1388 Specify the tile width to use while writing tiled TIFF.
1390 The tile height is then defaulted to an appropriate size.
1391 Width should be a multiple of 16. If the value is not a
1392 multiple of 16, then it will be rounded down. Enables
1393 tiled TIFF if it has not already been enabled.
1394 tiff:tile-height=<height>
1396 Specify the tile height to use while writing tiled TIFF.
1398 The tile width is then defaulted to an appropriate size.
1399 Height should be a multiple of 16. If the value is not a
1400 multiple of 16, then it will be rounded down. Enables
1401 tiled TIFF if it has not already been enabled.
1402 tiff:webp-lossless={TRUE|FALSE}
1404 Specify a value of TRUE to enable lossless mode while
1406 writing WebP-compressed TIFF files. The WebP webp:lossless
1407 option may also be used. The quality factor set by the
1408 -quality option may be used to influence the level of
1409 effort expended while compressing.
1410 tiff:zstd-compress-level=<value>
1412 Specify the compression level to use while writing Zstd-
1414 compressed TIFF files. The valid range is 1 to 22. If this
1415 define is not specified, then the 'quality' value is used
1416 such that the default quality setting of 75 is translated
1417 to a compress level of 9 such that ´quality' has a useful
1418 range of 10-184 if used for this purpose.
1419 webp:lossless={true|false}
1421 Enable lossless encoding.
1423 webp:method={0-6}
1425 Quality/speed trade-off.
1427 webp:image-hint={default,graph,photo,picture}
1429 Hint for image type.
1431 webp:target-size=<integer>
1433 Target size in bytes.
1435 webp:target-psnr=<float>
1437 Minimal distortion to try to achieve.
1439 webp:segments={1-4}
1441 Maximum number of segments to use.
1443 webp:sns-strength={0-100}
1445 Spatial Noise Shaping.
1447 webp:filter-strength={0-100}
1449 Filter strength.
1451 webp:filter-sharpness={0-7}
1453 Filter sharpness.
1455 webp:filter-type={0,1}
1457 Filtering type. 0 = simple, 1 = strong (only used if fil‐
1459 ter-strength > 0 or autofilter is enabled).
1460 webp:auto-filter={true|false}
1462 Auto adjust filter's strength.
1464 webp:alpha-compression=<integer>
1466 Algorithm for encoding the alpha plane (0 = none, 1 = com‐
1468 pressed with WebP lossless). Default is 1.
1469 webp:alpha-filtering=<integer>
1471 Predictive filtering method for alpha plane. 0: none, 1:
1473 fast, 2: best. Default is 1.
1474 webp:alpha-quality={0-100}
1476 Between 0 (smallest size) and 100 (lossless). Default is
1478 100.
1479 webp:pass=[1..10]
1481 Number of entropy-analysis passes.
1483 webp:show-compressed={true|false}
1485 Export the compressed picture back. In-loop filtering is
1487 not applied.
1488 webp:preprocessing=[0,1,2]
1490 0=none, 1=segment-smooth, 2=pseudo-random dithering
1492 webp:partitions=[0-3]
1494 log2(number of token partitions) in [0..3]. Default is 0
1496 for easier progressive decoding.
1497 webp:partition-limit={0-100}
1499 Quality degradation allowed to fit the 512k limit on pre‐
1501 diction modes coding (0: no degradation, 100: maximum pos‐
1502 sible degradation).
1503 webp:emulate-jpeg-size={true|false}
1505 If true, compression parameters will be remapped to better
1507 match the expected output size from JPEG compression. Gen‐
1508 erally, the output size will be similar but the degrada‐
1509 tion will be lower.
1510 webp:thread-level=<integer>
1512 If non-zero, try and use multi-threaded encoding.
1514 webp:low-memory={true|false}
1516 If set, reduce memory usage (but increase CPU use)
1518 webp:use-sharp-yuv={true|false}
1520 If set, if needed, use sharp (and slow) RGB->YUV conver‐
1522 sion
1523 For example, to create a postscript file that will render only
1528 the black pixels of a bilevel image, use:
1529 gm convert bilevel.tif -define ps:imagemask eps3:stencil.ps
1531 -delay <1/100ths of a second>
1534 display the next image after pausing
1535 This option is useful for regulating the animation of image
1537 sequences Delay/100 seconds must expire before the display of
1538 the next image. The default is no delay between each showing of
1539 the image sequence. The maximum delay is 65535.
1540 You can specify a delay range (e.g. -delay 10-500) which sets
1542 the minimum and maximum delay.
1543 -density <width>x<height>
1545 horizontal and vertical resolution in pixels of the image This
1546 option specifies the image resolution to store while encoding a
1547 raster image or the canvas resolution while rendering (reading)
1548 vector formats such as Postscript, PDF, WMF, and SVG into a
1549 raster image. Image resolution provides the unit of measure to
1550 apply when rendering to an output device or raster image. The
1551 default unit of measure is in dots per inch (DPI). The -units
1552 option may be used to select dots per centimeter instead.
1553 The default resolution is 72 dots per inch, which is equivalent
1554 to one point per pixel (Macintosh and Postscript standard). Com‐
1555 puter screens are normally 72 or 96 dots per inch while printers
1556 typically support 150, 300, 600, or 1200 dots per inch. To
1557 determine the resolution of your display, use a ruler to measure
1558 the width of your screen in inches, and divide by the number of
1559 horizontal pixels (1024 on a 1024x768 display). If the file
1560 format supports it, this option may be used to update the stored
1561 image resolution. Note that Photoshop stores and obtains image
1562 resolution from a proprietary embedded profile. If this profile
1563 is not stripped from the image, then Photoshop will continue to
1564 treat the image using its former resolution, ignoring the image
1565 resolution specified in the standard file header. The density
1566 option is an attribute and does not alter the underlying raster
1567 image. It may be used to adjust the rendered size for desktop
1568 publishing purposes by adjusting the scale applied to the pix‐
1569 els. To resize the image so that it is the same size at a dif‐
1570 ferent resolution, use the -resample option.
1571 -depth <value>
1573 depth of the image
1574 This is the number of bits of color to preserve in the image.
1576 Any value between 1 and QuantumDepth (build option) may be spec‐
1577 ified, although 8 or 16 are the most common values. Use this
1578 option to specify the depth of raw images whose depth is unknown
1579 such as GRAY, RGB, or CMYK, or to change the depth of any image
1580 after it has been read. The depth option is applied to the pix‐
1581 els immediately so it may be used as a form of simple compres‐
1582 sion by discarding the least significant bits. Reducing the
1583 depth in advance may speed up color quantization, and help cre‐
1584 ate smaller file sizes when using a compression algorithm like
1585 LZW or ZIP.
1586 -descend
1588 obtain image by descending window hierarchy
1589 -despeckle
1591 reduce the speckles within an image
1592 -displace <horizontal scale>x<vertical scale>
1594 shift image pixels as defined by a displacement map
1595 With this option, composite image is used as a displacement map.
1597 Black, within the displacement map, is a maximum positive dis‐
1598 placement. White is a maximum negative displacement and middle
1599 gray is neutral. The displacement is scaled to determine the
1600 pixel shift. By default, the displacement applies in both the
1601 horizontal and vertical directions. However, if you specify
1602 mask, composite image is the horizontal X displacement and mask
1603 the vertical Y displacement.
1604 -display <host:display[.screen]>
1606 specifies the X server to contact
1607 This option is used with convert for obtaining image or font
1609 from this X server. See X(1).
1610 -dispose <method>
1612 GIF disposal method
1613 The Disposal Method indicates the way in which the graphic is to
1615 be treated after being displayed.
1616 Here are the valid methods:
1618 Undefined No disposal specified.
1620 None Do not dispose between frames.
1621 Background Overwrite the image area with
1622 the background color.
1623 Previous Overwrite the image area with
1624 what was there prior to rendering
1625 the image.
1626 -dissolve <percent>
1629 dissolve an image into another by the given percent
1630 The opacity of the composite image is multiplied by the given
1632 percent, then it is composited over the main image.
1633 -dither
1635 apply Floyd/Steinberg error diffusion to the image
1636 The basic strategy of dithering is to trade intensity resolution
1638 for spatial resolution by averaging the intensities of several
1639 neighboring pixels. Images which suffer from severe contouring
1640 when reducing colors can be improved with this option.
1641 The -colors or -monochrome option is required for this option to
1643 take effect.
1644 Use +dither to turn off dithering and to render PostScript with‐
1646 out text or graphic aliasing. Disabling dithering often (but not
1647 always) leads to decreased processing time.
1648 -draw <string>
1650 annotate an image with one or more graphic primitives
1651 Use this option to annotate an image with one or more graphic
1653 primitives. The primitives include shapes, text, transforma‐
1654 tions, and pixel operations. The shape primitives are
1655 point x,y
1657 line x0,y0 x1,y1
1658 rectangle x0,y0 x1,y1
1659 roundRectangle x0,y0 x1,y1 wc,hc
1660 arc x0,y0 x1,y1 a0,a1
1661 ellipse x0,y0 rx,ry a0,a1
1662 circle x0,y0 x1,y1
1663 polyline x0,y0 ... xn,yn
1664 polygon x0,y0 ... xn,yn
1665 Bezier x0,y0 ... xn,yn
1666 path path specification
1667 image operator x0,y0 w,h filename
1668 The text primitive is
1671 text x0,y0 string
1673 The text gravity primitive is
1676 gravity NorthWest, North, NorthEast, West, Center,
1678 East, SouthWest, South, or SouthEast
1679 The text gravity primitive only affects the placement of text
1682 and does not interact with the other primitives. It is equiva‐
1683 lent to using the -gravity commandline option, except that it is
1684 limited in scope to the -draw option in which it appears.
1685 The transformation primitives are
1687 rotate degrees
1689 translate dx,dy
1690 scale sx,sy
1691 skewX degrees
1692 skewY degrees
1693 The pixel operation primitives are
1696 color x0,y0 method
1698 matte x0,y0 method
1699 The shape primitives are drawn in the color specified in the
1702 preceding -stroke option. Except for the line and point primi‐
1703 tives, they are filled with the color specified in the preceding
1704 -fill option. For unfilled shapes, use -fill none.
1705 Point requires a single coordinate.
1707 Line requires a start and end coordinate.
1709 Rectangle expects an upper left and lower right coordinate.
1711 RoundRectangle has the upper left and lower right coordinates
1713 and the width and height of the corners.
1714 Circle has a center coordinate and a coordinate for the outer
1716 edge.
1717 Use Arc to inscribe an elliptical arc within a rectangle. Arcs
1719 require a start and end point as well as the degree of rotation
1720 (e.g. 130,30 200,100 45,90).
1721 Use Ellipse to draw a partial ellipse centered at the given
1723 point with the x-axis and y-axis radius and start and end of arc
1724 in degrees (e.g. 100,100 100,150 0,360).
1725 Finally, polyline and polygon require three or more coordinates
1727 to define its boundaries. Coordinates are integers separated by
1728 an optional comma. For example, to define a circle centered at
1729 100,100 that extends to 150,150 use:
1730 -draw 'circle 100,100 150,150'
1732 Paths (See Paths) represent an outline of an object which is
1735 defined in terms of moveto (set a new current point), lineto
1736 (draw a straight line), curveto (draw a curve using a cubic
1737 Bezier), arc (elliptical or circular arc) and closepath (close
1738 the current shape by drawing a line to the last moveto) ele‐
1739 ments. Compound paths (i.e., a path with subpaths, each consist‐
1740 ing of a single moveto followed by one or more line or curve
1741 operations) are possible to allow effects such as "donut holes"
1742 in objects.
1743 Use image to composite an image with another image. Follow the
1745 image keyword with the composite operator, image location, image
1746 size, and filename:
1747 -draw 'image Over 100,100 225,225 image.jpg'
1749 You can use 0,0 for the image size, which means to use the
1752 actual dimensions found in the image header. Otherwise, it will
1753 be scaled to the given dimensions. See -compose for a descrip‐
1754 tion of the composite operators.
1755 Use text to annotate an image with text. Follow the text coordi‐
1757 nates with a string. If the string has embedded spaces, enclose
1758 it in single or double quotes. Optionally you can include the
1759 image filename, type, width, height, or other image attribute by
1760 embedding special format character. See -comment for details.
1761 For example,
1763 -draw 'text 100,100 "%m:%f %wx%h"'
1766 annotates the image with MIFF:bird.miff 512x480 for an image
1769 titled bird.miff and whose width is 512 and height is 480.
1770 If the first character of string is @, the text is read from a
1772 file titled by the remaining characters in the string. Please
1773 note that if the string comes from an untrusted source that it
1774 should be sanitized before use (a security risk).
1775 Rotate rotates subsequent shape primitives and text primitives
1777 about the origin of the main image. If the -region option pre‐
1778 cedes the -draw option, the origin for transformations is the
1779 upper left corner of the region.
1780 Translate translates them.
1782 Scale scales them.
1784 SkewX and SkewY skew them with respect to the origin of the main
1786 image or the region.
1787 The transformations modify the current affine matrix, which is
1789 initialized from the initial affine matrix defined by the
1790 -affine option. Transformations are cumulative within the -draw
1791 option. The initial affine matrix is not affected; that matrix
1792 is only changed by the appearance of another -affine option. If
1793 another -draw option appears, the current affine matrix is
1794 reinitialized from the initial affine matrix.
1795 Use color to change the color of a pixel to the fill color (see
1797 -fill). Follow the pixel coordinate with a method:
1798 point
1800 replace
1801 floodfill
1802 filltoborder
1803 reset
1804 Consider the target pixel as that specified by your coordinate.
1807 The point method recolors the target pixel. The replace method
1808 recolors any pixel that matches the color of the target pixel.
1809 Floodfill recolors any pixel that matches the color of the tar‐
1810 get pixel and is a neighbor, whereas filltoborder recolors any
1811 neighbor pixel that is not the border color. Finally, reset
1812 recolors all pixels.
1813 Use matte to the change the pixel matte value to transparent.
1815 Follow the pixel coordinate with a method (see the color primi‐
1816 tive for a description of methods). The point method changes the
1817 matte value of the target pixel. The replace method changes the
1818 matte value of any pixel that matches the color of the target
1819 pixel. Floodfill changes the matte value of any pixel that
1820 matches the color of the target pixel and is a neighbor, whereas
1821 filltoborder changes the matte value of any neighbor pixel that
1822 is not the border color (-bordercolor). Finally reset changes
1823 the matte value of all pixels.
1824 You can set the primitive color, font, and font bounding box
1826 color with -fill, -font, and -box respectively. Options are pro‐
1827 cessed in command line order so be sure to use these options
1828 before the -draw option.
1829 -edge <radius>
1831 detect edges within an image
1832 -emboss <radius>
1834 emboss an image
1835 -encoding <type>
1837 specify the text encoding
1838 Choose from AdobeCustom, AdobeExpert, AdobeStandard, AppleRoman,
1840 BIG5, GB2312, Latin 2, None, SJIScode, Symbol, Unicode, Wansung.
1841 -endian <type>
1843 specify endianness (MSB, LSB, or Native) of image
1844 MSB indicates big-endian (e.g. SPARC, Motorola 68K) while LSB
1846 indicates little-endian (e.g. Intel 'x86, VAX) byte ordering.
1847 Native indicates to use the normal ordering for the current CPU.
1848 This option currently only influences the CMYK, DPX, GRAY, RGB,
1849 and TIFF, formats.
1850 Use +endian to revert to unspecified endianness.
1852 -enhance
1854 apply a digital filter to enhance a noisy image
1855 -equalize
1857 perform histogram equalization to the image
1858 -extent <width>x<height>{+-}<x>{+-}<y>
1860 composite image on background color canvas image
1861 This option composites the image on a new background color
1863 (-background) canvas image of size <width>x<height>. The exist‐
1864 ing image content is composited at the position specified by
1865 geometry x and y offset and/or desired gravity (-gravity) using
1866 the current image compose (-compose) method. Image content
1867 which falls outside the bounds of the new image dimensions is
1868 discarded.
1869 For example, this command creates a thumbnail of an image, and
1871 centers it on a red color backdrop image, offsetting the canvas
1872 ten pixels to the left and five pixels up, with respect to the
1873 thumbnail:
1874 gm convert infile.jpg -thumbnail 120x80 -background red
1876 -gravity center \
1877 -extent 140x100-10-5 outfile.jpg
1878 This command reduces or expands a JPEG image to fit on an
1881 800x600 display:
1882 gm convert -size 800x600 input.jpg \
1884 -resize 800x600 -background black \
1885 -compose Copy -gravity center \
1886 -extent 800x600 \
1887 -quality 92 output.jpg
1888 If the aspect ratio of the input image isn't exactly 4:3, then
1891 the image is centered on an 800x600 black canvas.
1892 -file <filename>
1894 write annotated difference image to file
1895 If -file is specified, then an annotated difference image is
1897 generated and written to the specified file. Pixels which differ
1898 between the reference and compare images are modified from those
1899 in the compare image so that the changed pixels become more
1900 obvious. Some images may require use of an alternative high‐
1901 light style (see -highlight-style) or highlight color (see
1902 -highlight-color) before the changes are obvious.
1903 -fill <color>
1905 color to use when filling a graphic primitive
1906 Colors are represented in GraphicsMagick in the same form used
1908 by SVG. Use "gm convert -list color" to list named colors:
1909 name (named color)
1911 #RGB (hex numbers, 4 bits each)
1912 #RRGGBB (8 bits each)
1913 #RRRGGGBBB (12 bits each)
1914 #RRRRGGGGBBBB (16 bits each)
1915 #RGBA (4 bits each)
1916 #RRGGBBAA (8 bits each)
1917 #RRRGGGBBBAAA (12 bits each)
1918 #RRRRGGGGBBBBAAAA (16 bits each)
1919 rgb(r,g,b) (r,g,b are decimal numbers)
1920 rgba(r,g,b,a) (r,g,b,a are decimal numbers)
1921 Enclose the color specification in quotation marks to prevent
1924 the "#" or the parentheses from being interpreted by your shell.
1925 For example,
1927 gm convert -fill blue ...
1929 gm convert -fill "#ddddff" ...
1930 gm convert -fill "rgb(65000,65000,65535)" ...
1931 The shorter forms are scaled up, if necessary by replication.
1934 For example, #3af, #33aaff, and #3333aaaaffff are all equiva‐
1935 lent.
1936 See -draw for further details.
1938 -filter <type>
1940 use this type of filter when resizing an image
1941 Use this option to affect the resizing operation of an image
1943 (see -geometry). Choose from these filters (ordered by approxi‐
1944 mate increasing CPU time):
1945 Point
1947 Box
1948 Triangle
1949 Hermite
1950 Hanning
1951 Hamming
1952 Blackman
1953 Gaussian
1954 Quadratic
1955 Cubic
1956 Catrom
1957 Mitchell
1958 Lanczos
1959 Bessel
1960 Sinc
1961 The default filter is automatically selected to provide the best
1964 quality while consuming a reasonable amount of time. The
1965 Mitchell filter is used if the image supports a palette, sup‐
1966 ports a matte channel, or is being enlarged, otherwise the Lanc‐
1967 zos filter is used.
1968 -flatten
1970 flatten a sequence of images
1971 In some file formats (e.g. Photoshop's PSD) complex images may
1973 be represented by "layers" (independent images) which must be
1974 composited in order to obtain the final rendition. The -flatten
1975 option accomplishes this composition. The sequence of images is
1976 replaced by a single image created by compositing each image in
1977 turn, while respecting composition operators and page offsets.
1978 While -flatten is immediately useful for eliminating layers, it
1979 is also useful as a general-purpose composition tool.
1980 The sequence of images is terminated by the appearance of any
1982 option. If the -flatten option appears after all of the input
1983 images, all images are flattened. Also see -mosaic which is
1984 similar to -flatten except that it adds a suitably-sized canvas
1985 base image.
1986 For example, this composites an image on top of a 640x400 trans‐
1988 parent black canvas image:
1989 gm convert -size 640x300 xc:transparent \
1991 -compose over -page +0-100 \
1992 frame.png -flatten output.png
1993 and this flattens a Photoshop PSD file:
1996 gm convert input.psd -flatten output.png
1998 -flip create a "mirror image"
2001 reflect the scanlines in the vertical direction.
2003 -flop create a "mirror image"
2005 reflect the scanlines in the horizontal direction.
2007 -font <name>
2009 use this font when annotating the image with text
2010 You can tag a font to specify whether it is a PostScript, True‐
2012 Type, or X11 font. For example, Arial.ttf is a TrueType font,
2013 ps:helvetica is PostScript, and x:fixed is X11.
2014 -foreground <color>
2016 define the foreground color
2017 The color is specified using the format described under the
2019 -fill option.
2020 -format <type>
2022 the image format type
2023 When used with the mogrify utility, this option will convert any
2025 image to the image format you specify. See GraphicsMagick(1)
2026 for a list of image format types supported by GraphicsMagick, or
2027 see the output of 'gm -list format'.
2028 By default the file is written to its original name. However,
2030 if the filename extension matches a supported format, the exten‐
2031 sion is replaced with the image format type specified with -for‐
2032 mat. For example, if you specify tiff as the format type and
2033 the input image filename is image.gif, the output image filename
2034 becomes image.tiff.
2035 -format <string>
2037 output formatted image characteristics
2038 When used with the identify utility, or the convert utility with
2040 output written to the 'info:-' file specification, use this
2041 option to print information about the image in a format of your
2042 choosing. You can include the image filename, type, width,
2043 height, Exif data, or other image attributes by embedding spe‐
2044 cial format characters:
2045 %b file size
2047 %c comment
2048 %d directory
2049 %e filename extension
2050 %f filename
2051 %g page dimensions and offsets
2052 %h height
2053 %i input filename
2054 %k number of unique colors
2055 %l label
2056 %m magick
2057 %n number of scenes
2058 %o output filename
2059 %p page number
2060 %q image bit depth
2061 %r image type description
2062 %s scene number
2063 %t top of filename
2064 %u unique temporary filename
2065 %w width
2066 %x horizontal resolution
2067 %y vertical resolution
2068 %A transparency supported
2069 %C compression type
2070 %D GIF disposal method
2071 %G Original width and height
2072 %H page height
2073 %M original filename specification
2074 %O page offset (x,y)
2075 %P page dimensions (width,height)
2076 %Q compression quality
2077 %T time delay (in centi-seconds)
2078 %U resolution units
2079 %W page width
2080 %X page horizontal offset (x)
2081 %Y page vertical offset (y)
2082 %@ trim bounding box
2083 %# signature
2084 \n newline
2085 \r carriage return
2086 %% %
2087 For example,
2090 -format "%m:%f %wx%h"
2092 displays MIFF:bird.miff 512x480 for an image titled bird.miff
2095 and whose width is 512 and height is 480.
2096 If the first character of string is @, the format is read from a
2098 file titled by the remaining characters in the string. Please
2099 note that if the string comes from an untrusted source that it
2100 should be sanitized before use since this may be used to incor‐
2101 porate any readable file on the system (a security risk).
2102 The values of image type (%r) which may be returned include:
2104 Bilevel
2106 Grayscale
2107 GrayscaleMatte
2108 Palette
2109 PaletteMatte
2110 TrueColor
2111 TrueColorMatte
2112 ColorSeparation
2113 ColorSeparationMatte
2114 Optimize
2115 You can also use the following special formatting syntax to
2118 print Exif information contained in the file:
2119 %[EXIF:<tag>]
2121 Where "<tag>" may be one of the following:
2124 * (print all Exif tags, in keyword=data format)
2126 ! (print all Exif tags, in tag_number format)
2127 #hhhh (print data for Exif tag #hhhh)
2128 ImageWidth
2129 ImageLength
2130 BitsPerSample
2131 Compression
2132 PhotometricInterpretation
2133 FillOrder
2134 DocumentName
2135 ImageDescription
2136 Make
2137 Model
2138 StripOffsets
2139 Orientation
2140 SamplesPerPixel
2141 RowsPerStrip
2142 StripByteCounts
2143 XResolution
2144 YResolution
2145 PlanarConfiguration
2146 ResolutionUnit
2147 TransferFunction
2148 Software
2149 DateTime
2150 Artist
2151 WhitePoint
2152 PrimaryChromaticities
2153 TransferRange
2154 JPEGProc
2155 JPEGInterchangeFormat
2156 JPEGInterchangeFormatLength
2157 YCbCrCoefficients
2158 YCbCrSubSampling
2159 YCbCrPositioning
2160 ReferenceBlackWhite
2161 CFARepeatPatternDim
2162 CFAPattern
2163 BatteryLevel
2164 Copyright
2165 ExposureTime
2166 FNumber
2167 IPTC/NAA
2168 ExifOffset
2169 InterColorProfile
2170 ExposureProgram
2171 SpectralSensitivity
2172 GPSInfo
2173 ISOSpeedRatings
2174 OECF
2175 ExifVersion
2176 DateTimeOriginal
2177 DateTimeDigitized
2178 ComponentsConfiguration
2179 CompressedBitsPerPixel
2180 ShutterSpeedValue
2181 ApertureValue
2182 BrightnessValue
2183 ExposureBiasValue
2184 MaxApertureValue
2185 SubjectDistance
2186 MeteringMode
2187 LightSource
2188 Flash
2189 FocalLength
2190 MakerNote
2191 UserComment
2192 SubSecTime
2193 SubSecTimeOriginal
2194 SubSecTimeDigitized
2195 FlashPixVersion
2196 ColorSpace
2197 ExifImageWidth
2198 ExifImageLength
2199 InteroperabilityOffset
2200 FlashEnergy
2201 SpatialFrequencyResponse
2202 FocalPlaneXResolution
2203 FocalPlaneYResolution
2204 FocalPlaneResolutionUnit
2205 SubjectLocation
2206 ExposureIndex
2207 SensingMethod
2208 FileSource
2209 SceneType
2210 JPEG specific information (from reading a JPEG file) may be
2213 obtained like this:
2214 %[JPEG-<tag>]
2216 Where "<tag>" may be one of the following:
2219 * (all JPEG-related tags, in
2221 keyword=data format)
2222 Quality IJG JPEG "quality" estimate
2223 Colorspace JPEG colorspace numeric ID
2224 Colorspace-Name JPEG colorspace name
2225 Sampling-factors JPEG sampling factors
2226 Please note that JPEG has no notion of "quality" and that the
2229 quality metric used by, and estimated by the software is based
2230 on the quality metric established by IJG JPEG 6b. Other
2231 encoders (e.g. that used by Adobe Photoshop) use different
2232 encoding metrics.
2233 Surround the format specification with quotation marks to pre‐
2235 vent your shell from misinterpreting any spaces and square
2236 brackets.
2237 -frame <width>x<height>+<outer bevel width>+<inner bevel width>
2239 surround the image with an ornamental border
2240 See -geometry for details about the geometry specification. The
2242 -frame option is not affected by the -gravity option.
2243 The color of the border is specified with the -mattecolor com‐
2245 mand line option.
2246 -frame include the X window frame in the imported image
2248 -fuzz <distance>{%}
2250 colors within this Euclidean distance are considered equal
2251 A number of algorithms search for a target color. By default the
2253 color must be exact. Use this option to match colors that are
2254 close (in Euclidean distance) to the target color in RGB 3D
2255 space. For example, if you want to automatically trim the edges
2256 of an image with -trim but the image was scanned and the target
2257 background color may differ by a small amount. This option can
2258 account for these differences.
2259 The distance can be in absolute intensity units or, by appending
2261 "%", as a percentage of the maximum possible intensity (255,
2262 65535, or 4294967295).
2263 -gamma <value>
2265 level of gamma correction
2266 The same color image displayed on two different workstations may
2268 look different due to differences in the display monitor. Use
2269 gamma correction to adjust for this color difference. Reasonable
2270 values extend from 0.8 to 2.3. Gamma less than 1.0 darkens the
2271 image and gamma greater than 1.0 lightens it. Large adjustments
2272 to image gamma may result in the loss of some image information
2273 if the pixel quantum size is only eight bits (quantum range 0 to
2274 255).
2275 You can apply separate gamma values to the red, green, and blue
2277 channels of the image with a gamma value list delimited with
2278 slashes (e.g., 1.7/2.3/1.2).
2279 Use +gamma value to set the image gamma level without actually
2281 adjusting the image pixels. This option is useful if the image
2282 is of a known gamma but not set as an image attribute (e.g. PNG
2283 images).
2284 -gaussian <radius>{x<sigma>}
2286 blur the image with a Gaussian operator
2287 Use the given radius and standard deviation (sigma).
2289 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
2291 Specify dimension, offset, and resize options.
2292 The -geometry option is used for a number of different purposes,
2294 depending on the utility it is used with.
2295 For the X11 commands ('animate', 'display', and 'import'), it
2297 specifies the preferred size and location of the Image window.
2298 By default, the window size is the image size and the location
2299 is chosen by you (or your window manager) when it is mapped.
2300 For the 'import', 'convert', 'mogrify' utility commands it may
2301 be used to specify the desired size when resizing an image. In
2302 this case, symbols representing resize options may be appended
2303 to the geometry string to influence how the resize request is
2304 treated.
2305 See later notes corresponding to usage by particular commands.
2307 The following notes apply to when -geometry is used to express a
2308 resize request, taking into account the current properties of
2309 the image.
2310 By default, the width and height are maximum values. That is,
2312 the image is expanded or contracted to fit the width and height
2313 value while maintaining the aspect ratio of the image.
2314 Append a ^ to the geometry so that the image aspect ratio is
2316 maintained when the image is resized, but the resulting width or
2317 height are treated as minimum values rather than maximum values.
2318 Append a ! (exclamation point) to the geometry to force the
2320 image size to exactly the size you specify. For example, if you
2321 specify 640x480! the image width is set to 640 pixels and height
2322 to 480.
2323 If only the width is specified, without the trailing 'x', then
2325 height is set to width (e.g., -geometry 100 is the same as
2326 -geometry 100x100). If only the width is specified but with the
2327 trailing 'x', then width assumes the value and the height is
2328 chosen to maintain the aspect ratio of the image. Similarly, if
2329 only the height is specified prefixed by 'x' (e.g., -geometry
2330 x256), the width is chosen to maintain the aspect ratio.
2331 To specify a percentage width or height instead, append %. The
2333 image size is multiplied by the width and height percentages to
2334 obtain the final image dimensions. To increase the size of an
2335 image, use a value greater than 100 (e.g. 125%). To decrease an
2336 image's size, use a percentage less than 100.
2337 Use @ to specify the maximum area in pixels of an image.
2339 Use > to change the dimensions of the image only if its width or
2341 height exceeds the geometry specification. < resizes the image
2342 only if both of its dimensions are less than the geometry speci‐
2343 fication. For example, if you specify '640x480>' and the image
2344 size is 256x256, the image size does not change. However, if the
2345 image is 512x512 or 1024x1024, it is resized to 480x480.
2346 Enclose the geometry specification in quotation marks to prevent
2347 the < or > from being interpreted by your shell as a file redi‐
2348 rection.
2349 When used with animate and display, offsets are handled in the
2351 same manner as in X(1) and the -gravity option is not used. If
2352 the x is negative, the offset is measured leftward from the
2353 right edge of the screen to the right edge of the image being
2354 displayed. Similarly, negative y is measured between the bottom
2355 edges. The offsets are not affected by "%"; they are always
2356 measured in pixels.
2357 When used as a composite option, -geometry gives the dimensions
2359 of the image and its location with respect to the composite
2360 image. If the -gravity option is present with NorthEast, East,
2361 or SouthEast gravity, the x represents the distance from the
2362 right edge of the image to the right edge of the composite
2363 image. Similarly, if the -gravity option is present with South‐
2364 West, South, or SouthEast gravity, y is measured between the
2365 bottom edges. Accordingly, a positive offset will never point in
2366 the direction outside of the image. The offsets are not
2367 affected by "%"; they are always measured in pixels. To specify
2368 the dimensions of the composite image, use the -resize option.
2369 When used as a convert, import or mogrify option, -geometry is
2371 synonymous with -resize and specifies the size of the output
2372 image. The offsets, if present, are ignored.
2373 When used as a montage option, -geometry specifies the image
2375 size and border size for each tile; default is 256x256+0+0.
2376 Negative offsets (border dimensions) are meaningless. The
2377 -gravity option affects the placement of the image within the
2378 tile; the default gravity for this purpose is Center. If the
2379 "%" sign appears in the geometry specification, the tile size is
2380 the specified percentage of the original dimensions of the first
2381 tile. To specify the dimensions of the montage, use the -resize
2382 option.
2383 -gravity <type>
2385 direction primitive gravitates to when annotating the image.
2386 Choices are: NorthWest, North, NorthEast, West, Center, East,
2388 SouthWest, South, SouthEast.
2389 The direction you choose specifies where to position the text
2391 when annotating the image. For example Center gravity forces the
2392 text to be centered within the image. By default, the image
2393 gravity is NorthWest. See -draw for more details about graphic
2394 primitives. Only the text primitive is affected by the -gravity
2395 option.
2396 The -gravity option is also used in concert with the -geometry
2398 option and other options that take <geometry> as a parameter,
2399 such as the -crop option. See -geometry for details of how the
2400 -gravity option interacts with the <x> and <y> parameters of a
2401 geometry specification.
2402 When used as an option to composite, -gravity gives the direc‐
2404 tion that the image gravitates within the composite.
2405 When used as an option to montage, -gravity gives the direction
2407 that an image gravitates within a tile. The default gravity is
2408 Center for this purpose.
2409 -green-primary <x>,<y>
2411 green chromaticity primary point
2412 -hald-clut <clut>
2414 apply a Hald CLUT to the image
2415 A Hald CLUT ("Color Look-Up Table") is a special square color
2417 image which contains a look-up table for red, green, and blue.
2418 The size of the Hald CLUT image is determined by its order. The
2419 width (and height) of a Hald CLUT is the cube of the order. For
2420 example, a Hald CLUT of order 8 is 512x512 pixels (262,144 col‐
2421 ors) and of order 16 is 4096x4096 (16,777,216 colors). A spe‐
2422 cial CLUT is the identity CLUT which which causes no change to
2423 the input image. In order to use the Hald CLUT, one takes an
2424 identity CLUT and adjusts its colors in some way. The modified
2425 CLUT can then be used to transform any number of images in an
2426 identical way.
2427 GraphicsMagick contains a built-in identity CLUT generator via
2429 the IDENTITY coder. For example reading from the file name
2430 IDENTITY:8 returns an identity CLUT of order 8. Typical Hald
2431 CLUT identity images have an order of between 8 and 16. The
2432 default order for the IDENTITY CLUT generator is 8. Interpola‐
2433 tion is used so it is not usually necessary for CLUT images to
2434 be very large. The PNG file format is ideal for storing Hald
2435 CLUT images because it compresses them very well.
2436 -help print usage instructions
2438 -highlight-color <color>
2440 pixel annotation color
2441 Specifies the color to use when annotating difference pixels.
2443 -highlight-style <style>
2445 pixel annotation style
2446 Specifies the pixel difference annotation style used to draw
2448 attention to changed pixels. May be one of Assign, Threshold,
2449 Tint, or XOR; where Assign replaces the pixel with the highlight
2450 color (see -highlight-color), Threshold replaces the pixel with
2451 black or white based on the difference in intensity, Tint alpha
2452 tints the pixel with the highlight color, and XOR does an XOR
2453 between the pixel and the highlight color.
2454 -iconGeometry <geometry>
2456 specify the icon geometry
2457 Offsets, if present in the geometry specification, are handled
2459 in the same manner as the -geometry option, using X11 style to
2460 handle negative offsets.
2461 -iconic
2463 iconic animation
2464 -immutable
2466 make image immutable
2467 -implode <factor>
2469 implode image pixels about the center
2470 -intent <type>
2472 use this type of rendering intent when managing the image color
2473 Use this option to affect the the color management operation of
2475 an image (see -profile). Choose from these intents: Absolute,
2476 Perceptual, Relative, Saturation.
2477 The default intent is undefined.
2479 -interlace <type>
2481 the type of interlacing scheme
2482 Choices are: None, Line, Plane, or Partition. The default is
2484 None.
2485 This option is used to specify the type of interlacing scheme
2487 for raw image formats such as RGB or YUV. None means do not
2488 interlace (RGBRGBRGBRGBRGBRGB...),
2489 Line uses scanline interlacing
2491 (RRR...GGG...BBB...RRR...GGG...BBB...), and Plane uses plane
2492 interlacing (RRRRRR...GGGGGG...BBBBBB...).
2493 Partition is like plane except the different planes are saved to
2495 individual files (e.g. image.R, image.G, and image.B).
2496 Use Line to create an interlaced PNG or GIF or progressive JPEG
2498 image.
2499 -label <name>
2501 assign a label to an image
2502 Use this option to assign a specific label to the image, when
2504 writing to an image format that supports labels, such as TIFF,
2505 PNG, MIFF, or PostScript. You can include the the image file‐
2506 name, type, width, height, or other image attribute by embedding
2507 special format character. A label is not drawn on the image,
2508 but is embedded in the image datastream via a "Label" tag or
2509 similar mechanism. If you want the label to be visible on the
2510 image itself, use the -draw option. See -comment for details.
2511 For example,
2513 -label "%m:%f %wx%h"
2515 produces an image label of MIFF:bird.miff 512x480 for an image
2518 titled bird.miff and whose width is 512 and height is 480.
2519 If the first character of string is @, the image label is read
2521 from a file titled by the remaining characters in the string.
2522 Please note that if the string comes from an untrusted source
2523 that it should be sanitized before use since otherwise the con‐
2524 tent of an arbitrary readable file might be incorporated into
2525 the image label (a security risk).
2526 If the -label option appears multiple times, only the last label
2528 is stored.
2529 In PNG images, the label is stored in a tEXt or zTXt chunk with
2531 the keyword "label".
2532 When converting to PostScript, use this option to specify a
2534 header string to print above the image. Specify the label font
2535 with -font.
2536 When creating a montage, by default the label associated with an
2538 image is displayed with the corresponding tile in the montage.
2539 Use the +label option to suppress this behavior.
2540 -lat <width>x<height>{+-}<offset>{%}
2544 perform local adaptive thresholding
2545 Perform local adaptive thresholding using the specified width,
2547 height, and offset. The offset is a distance in sample space
2548 from the mean, as an absolute integer ranging from 0 to the max‐
2549 imum sample value or as a percentage. If the percent option is
2550 supplied, then the offset is computed as a percentage of the
2551 quantum range. It is strongly recommended to use the percent
2552 option so that results are not sensitive to pixel quantum depth.
2553 For example,
2555 -colorspace gray -lat "10x10-5%"
2557 will help clarify a scanned grayscale or color document, produc‐
2560 ing a bi-level equivalent.
2561 -level <black_point>{,<gamma>}{,<white_point>}{%}
2563 adjust the level of image contrast
2564 Give one, two or three values delimited with commas: black-
2566 point, gamma, white-point (e.g. 10,1.0,250 or 2%,0.5,98%). The
2567 black and white points range from 0 to MaxRGB or from 0 to 100%;
2568 if the white point is omitted it is set to MaxRGB-black_point.
2569 If a "%" sign is present anywhere in the string, the black and
2570 white points are percentages of MaxRGB. Gamma is an exponent
2571 that ranges from 0.1 to 10.; if it is omitted, the default of
2572 1.0 (no gamma correction) is assumed. This interface works simi‐
2573 lar to Photoshop's "Image->Adjustments->Levels..." "Input Lev‐
2574 els" interface.
2575 -limit <type> <value>
2577 Disk, File, Map, Memory, Pixels, Width, Height or Threads
2578 resource limit
2579 By default, resource limits are estimated based on the available
2581 resources of the system. The resource limits are Disk, maximum
2582 total disk space consumed; File, maximum number of file descrip‐
2583 tors allowed to be open at once; Map, maximum total number of
2584 file bytes which may be memory mapped; Memory, maximum total
2585 number of bytes of heap memory used for image storage; Pixels,
2586 maximum absolute image size (per image); Width, maximum image
2587 pixels width; Height, maximum image pixels height; and Threads,
2588 the maximum number of worker threads to use per OpenMP thread
2589 team.
2590 These resource limits are used to decide if (for a given image)
2592 the decoded image ("pixel cache") should be stored in heap mem‐
2593 ory (RAM), in a memory-mapped disk file, or in a disk file
2594 accessed via read/write I/O. The number of total pixels in one
2595 image, and/or the width/height, may also be limited in order to
2596 force the reading, or creation of images larger than the limit
2597 (in pixels) to intentionally fail. The disk limit establishes an
2598 overall limit since using the disk is the means of last resort.
2599 When the disk limit has been reached, no more images may be
2600 read.
2601 The value argument is an absolute value, but may have standard
2603 binary suffix characters applied ('K', 'M', 'G', 'T', 'P', 'E')
2604 to apply a scaling to the value (based on a multiplier of 1024).
2605 Any additional characters are ignored. For example, '-limit Pix‐
2606 els 10MP' limits the maximum image size to 10 megapixels and
2607 '-limit memory 32MB -limit map 64MB' limits memory and memory
2608 mapped files to 32 megabytes and 64 megabytes respectively.
2609 Resource limits may also be set using environment variables. The
2611 environment variables MAGICK_LIMIT_DISK, MAGICK_LIMIT_FILES,
2612 MAGICK_LIMIT_MAP, MAGICK_LIMIT_MEMORY, MAGICK_LIMIT_PIXELS, MAG‐
2613 ICK_LIMIT_WIDTH, MAGICK_LIMIT_HEIGHT,and OMP_NUM_THREADS may be
2614 used to set the limits for disk space, open files, memory mapped
2615 size, heap memory, per-image pixels, image width, image height,
2616 and threads respectively.
2617 Use the option -list resource list the current limits.
2619 -linewidth
2621 the line width for subsequent draw operations
2622 -list <type>
2624 the type of list
2625 Choices are: Color, Delegate, Format, Magic, Module, Resource,
2627 or Type. The Module option is only available if GraphicsMagick
2628 was built to support loadable modules.
2629 This option lists information about the GraphicsMagick configu‐
2631 ration.
2632 -log <string>
2634 Specify format for debug log
2635 This option specifies the format for the log printed when the
2637 -debug option is active.
2638 You can display the following components by embedding special
2640 format characters:
2641 %d domain
2643 %e event
2644 %f function
2645 %l line
2646 %m module
2647 %p process ID
2648 %r real CPU time
2649 %t wall clock time
2650 %u user CPU time
2651 %% percent sign
2652 \n newline
2653 \r carriage return
2654 For example:
2657 gm convert -debug coders -log "%u %m:%l %e" in.gif out.png
2659 The default behavior is to print all of the components.
2662 -loop <iterations>
2664 add Netscape loop extension to your GIF animation
2665 A value other than zero forces the animation to repeat itself up
2667 to iterations times.
2668 -magnify
2670 magnify the image
2671 The image size is doubled using linear interpolation.
2673 -magnify <factor>
2675 magnify the image
2676 The displayed image is magnified by factor.
2678 -map <filename>
2680 choose a particular set of colors from this image
2681 [convert or mogrify]
2683 By default, color reduction chooses an optimal set of colors
2685 that best represent the original image. Alternatively, you can
2686 choose a particular set of colors from an image file with this
2687 option.
2688 Use +map to reduce all images in the image sequence that follows
2690 to a single optimal set of colors that best represent all the
2691 images. The sequence of images is terminated by the appearance
2692 of any option. If the +map option appears after all of the
2693 input images, all images are mapped.
2694 -map <type>
2696 display image using this type.
2697 [animate or display]
2699 Choose from these Standard Colormap types:
2701 best
2703 default
2704 gray
2705 red
2706 green
2707 blue
2708 The X server must support the Standard Colormap you choose, oth‐
2711 erwise an error occurs. Use list as the type and display
2712 searches the list of colormap types in top-to-bottom order until
2713 one is located. See xstdcmap(1) for one way of creating Standard
2714 Colormaps.
2715 -mask <filename>
2717 Specify a clipping mask
2718 The image read from the file is used as a clipping mask. It
2720 must have the same dimensions as the image being masked.
2721 If the mask image contains an opacity channel, the opacity of
2723 each pixel is used to define the mask. Otherwise, the intensity
2724 (gray level) of each pixel is used. Unmasked (black) pixels are
2725 modified while masked pixels (not black) are protected from
2726 alteration.
2727 Use +mask to remove the clipping mask.
2729 It is not necessary to use -clip to activate the mask; -clip is
2731 implied by -mask.
2732 -matte store matte channel if the image has one
2734 If the image does not have a matte channel, create an opaque
2736 one.
2737 Use +matte to ignore the matte channel (treats it as opaque) and
2739 to avoid writing a matte channel in the output file.
2740 For the compare command, -matte will add an opaque matte channel
2742 to images if they do not already have a matte channel, and matte
2743 will be enabled for both images. Likewise, if +matte is used,
2744 the matte channel is disabled for both images. This makes it
2745 easier to compare images regardless of if they already have a
2746 matte channel.
2747 -mattecolor <color>
2749 specify the color to be used with the -frame option
2750 The color is specified using the format described under the
2752 -fill option.
2753 -maximum-error <limit>
2755 specifies the maximum amount of total image error
2756 Specifies the maximum amount of total image error (based on com‐
2758 parison using a specified metric) before an error ("image dif‐
2759 ference exceeds limit") is reported. The error is reported via
2760 a non-zero command execution return status.
2761 -median <radius>
2763 apply a median filter to the image
2764 -metric <metric>
2766 comparison metric (MAE, MSE, PAE, PSNR, RMSE)
2767 -minify <factor>
2769 minify the image
2770 The image size is halved using linear interpolation.
2772 -mode <value>
2774 mode of operation
2775 The available montage modes are frame to place the images in a
2777 rectangular grid while adding a decorative frame with drop‐
2778 shadow, unframe to place undecorated images in a rectangular
2779 grid, and concatenate to pack the images closely together with‐
2780 out any well-defined grid or decoration.
2781 -modulate brightness[,saturation[,hue]]
2783 vary the brightness, saturation, and hue of an image
2784 Specify the percent change in brightness, color saturation, and
2786 hue separated by commas. Default argument values are 100 per‐
2787 cent, resulting in no change. For example, to increase the color
2788 brightness by 20% and decrease the color saturation by 10% and
2789 leave the hue unchanged, use: -modulate 120,90.
2790 Hue is the percentage of absolute rotation from the current
2792 position. For example 50 results in a counter-clockwise rotation
2793 of 90 degrees, 150 results in a clockwise rotation of 90
2794 degrees, with 0 and 200 both resulting in a rotation of 180
2795 degrees.
2796 -monitor
2798 show progress indication
2799 A simple command-line progress indication is shown while the
2801 command is running. The process indication shows the operation
2802 currently being performed and the percent completed. Commands
2803 using X11 may replace the command line progress indication with
2804 a graphical one once an image has been displayed.
2805 -monochrome
2807 transform the image to black and white
2808 -morph <frames>
2810 morphs an image sequence
2811 Both the image pixels and size are linearly interpolated to give
2813 the appearance of a meta-morphosis from one image to the next.
2814 The sequence of images is terminated by the appearance of any
2816 option. If the -morph option appears after all of the input
2817 images, all images are morphed.
2818 -mosaic
2820 create a mosaic from an image or an image sequence
2821 The -mosaic option provides a flexible way to composite one or
2823 more images onto a solid-color canvas image. It works similar to
2824 -flatten except that a base canvas image is automatically cre‐
2825 ated with a suitable size given the image size, page dimensions,
2826 and page offsets of images to be composited. The color of the
2827 base canvas image may be set via the -background option. The
2828 default canvas color is 'white', but 'black' or 'transparent'
2829 may be more suitable depending on the composition algorithm
2830 requested.
2831 The -compose option may be used to specify the composition algo‐
2833 rithm to use when compositing the subsequent image on the base
2834 canvas.
2835 The -page option can be used to establish the dimensions of the
2837 mosaic and to position the subsequent image within the mosaic.
2838 If the -page argument does not specify width and height, then
2839 the canvas dimensions are evaluated based on the image sizes and
2840 offsets.
2841 The sequence of images is terminated by the appearance of any
2843 option. If the -mosaic option appears after all of the input
2844 images, all images are included in the mosaic.
2845 The following is an example of composing an image based on red,
2847 green, and blue layers extracted from a sequence of images and
2848 pasted on the canvas image at specified offsets:
2849 gm convert -background black \
2851 -compose CopyRed -page +0-100 red.png \
2852 -compose CopyGreen -page +0+40 green.png \
2853 -compose CopyBlue -page +0+180 blue.png \
2854 -mosaic output.png
2855 -motion-blur <radius>{x<sigma>}{+angle}
2858 Simulate motion blur
2859 Simulate motion blur by convolving the image with a Gaussian
2861 operator of the given radius and standard deviation (sigma). For
2862 reasonable results, radius should be larger than sigma. If
2863 radius is zero, then a suitable radius is automatically selected
2864 based on sigma. The angle specifies the angle that the object is
2865 coming from (side which is blurred).
2866 -name name an image
2868 -negate
2870 replace every pixel with its complementary color
2871 The red, green, and blue intensities of an image are negated.
2873 White becomes black, yellow becomes blue, etc. Use +negate to
2874 only negate the grayscale pixels of the image.
2875 -noise <radius|type>
2877 add or reduce noise in an image
2878 The principal function of noise peak elimination filter is to
2880 smooth the objects within an image without losing edge informa‐
2881 tion and without creating undesired structures. The central idea
2882 of the algorithm is to replace a pixel with its next neighbor in
2883 value within a pixel window, if this pixel has been found to be
2884 noise. A pixel is defined as noise if and only if this pixel is
2885 a maximum or minimum within the pixel window.
2886 Use radius to specify the width of the neighborhood.
2888 Use +noise followed by a noise type to add noise to an image.
2890 The noise added modulates the existing image pixels. Choose from
2891 these noise types:
2892 Uniform
2894 Gaussian
2895 Multiplicative
2896 Impulse
2897 Laplacian
2898 Poisson
2899 Random (uniform distribution)
2900 -noop NOOP (no option)
2903 The -noop option can be used to terminate a group of images and
2905 reset all options to their default values, when no other option
2906 is desired.
2907 -normalize
2909 transform image to span the full range of color values
2910 This is a contrast enhancement technique based on the image his‐
2912 togram.
2913 When computing the contrast enhancement values, the histogram
2915 edges are truncated so that the majority of the image pixels are
2916 considered in the constrast enhancement, and outliers (e.g. ran‐
2917 dom noise or minute details) are ignored. The default is that
2918 0.1 percent of the histogram entries are ignored. The percent‐
2919 age of the histogram to ignore may be specified by using the
2920 -set option with the histogram-threshold parameter similar to
2921 -set histogram-threshold 0.01 to specify 0.01 percent. Use 0
2922 percent to use the entire histogram, with possibly diminished
2923 contrast enhancement.
2924 -opaque <color>
2926 change this color to the pen color within the image
2927 The color is specified using the format described under the
2929 -fill option. The color is replaced if it is identical to the
2930 target color, or close enough to the target color in a 3D space
2931 as defined by the Euclidean distance specified by -fuzz.
2932 See -fill and -fuzz for more details.
2934 -operator channel operator rvalue[%]
2936 apply a mathematical, bitwise, or value operator to an image
2937 channel
2938 Apply a low-level mathematical, bitwise, or value operator to a
2940 selected image channel or all image channels. Operations which
2941 result in negative results are reset to zero, and operations
2942 which overflow the available range are reset to the maximum pos‐
2943 sible value.
2944 Select a channel from: Red, Green, Blue, Opacity, Matte, Cyan,
2946 Magenta, Yellow, Black, All, or Gray. All only modifies the
2947 color channels and does not modify the Opacity channel. Except
2948 for the threshold operators, All operates on each channel inde‐
2949 pendently so that operations are on a per-channel basis.
2950 Gray treats the color channels as a grayscale intensity and per‐
2952 forms the requested operation on the equivalent pixel intensity
2953 so the result is a gray image. Select an operator from Add,
2954 And, Assign, Depth, Divide, Gamma, Negate, LShift, Log, Max,
2955 Min, Multiply, Or, Pow, RShift, Subtract, Threshold, Threshold-
2956 White, Threshold-White-Negate, Threshold-Black, Threshold-Black-
2957 Negate, Xor, Noise-Gaussian, Noise-Impulse, Noise-Laplacian,
2958 Noise-Multiplicative, Noise-Poisson, Noise-Random, and Noise-
2959 Uniform.
2960 Rvalue may be any floating point or integer value. Normally
2962 rvalue will be in the range of 0 to MaxRGB, where MaxRGB is the
2963 largest quantum value supported by the GraphicsMagick build
2964 (255, 65535, or 4294967295) but values outside this range are
2965 useful for some arithmetic operations. Arguments to logical or
2966 bit-wise operations are rounded to a positive integral value
2967 prior to use. If a percent (%) symbol is appended to the argu‐
2968 ment, then the argument has a range of 0 to 100 percent.
2969 The following is a description of the operators:
2971 Add
2974 Result is rvalue added to channel value.
2976 And
2978 Result is the logical AND of rvalue with channel value.
2980 Assign
2982 Result is rvalue.
2984 Depth
2986 Result is channel value adjusted so that it may be
2988 (approximately) stored in the specified number of bits
2989 without additional loss.
2990 Divide
2992 Result is channel value divided by rvalue.
2994 Gamma
2996 Result is channel value gamma adjusted by rvalue.
2998 LShift
3000 Result is channel value bitwise left shifted by rvalue
3002 bits.
3003 Log
3005 Result is computed as log(value*rvalue+1)/log(rvalue+1).
3007 Max
3009 Result is assigned to rvalue if rvalue is greater than
3011 value.
3012 Min
3014 Result is assigned to rvalue if rvalue is less than value.
3016 Multiply
3018 Result is channel value multiplied by rvalue.
3020 Negate
3022 Result is inverse of channel value (like a film negative).
3024 An rvalue must be supplied but is currently not used.
3025 Inverting the image twice results in the original image.
3026 Or
3028 Result is the logical OR of rvalue with channel value.
3030 Pow
3032 Result is computed as pow(value,rvalue). Similar to Gamma
3034 except that rvalue is not inverted.
3035 RShift
3037 Result is channel value bitwise right shifted by rvalue
3039 bits.
3040 Subtract
3042 Result is channel value minus rvalue.
3044 Threshold
3046 Result is maximum (white) if channel value is greater than
3048 rvalue, or minimum (black) if it is less than or equal to
3049 rvalue. If all channels are specified, then thresholding
3050 is done based on computed pixel intensity.
3051 Threshold-white
3053 Result is maximum (white) if channel value is greater than
3055 rvalue and is unchanged if it is less than or equal to
3056 rvalue. This can be used to remove apparent noise from the
3057 bright parts of an image. If all channels are specified,
3058 then thresholding is done based on computed pixel inten‐
3059 sity.
3060 Threshold-White-Negate
3062 Result is set to black if channel value is greater than
3064 rvalue and is unchanged if it is less than or equal to
3065 rvalue. If all channels are specified, then thresholding
3066 is done based on computed pixel intensity.
3067 Threshold-black
3069 Result is minimum (black) if channel value is less than
3071 than rvalue and is unchanged if it is greater than or
3072 equal to rvalue. This can be used to remove apparent noise
3073 from the dark parts of an image. If all channels are spec‐
3074 ified, then thresholding is done based on computed pixel
3075 intensity.
3076 Threshold-Black-Negate
3078 Result is set to white if channel value is less than than
3080 rvalue and is unchanged if it is greater than or equal to
3081 rvalue. If all channels are specified, then thresholding
3082 is done based on computed pixel intensity.
3083 Xor
3085 Result is the logical XOR of rvalue with channel value. An
3087 interesting property of XOR is that performing the same
3088 operation twice results in the original value.
3089 Noise-Gaussian
3091 Result is the current channel value modulated with gauss‐
3093 ian noise according to the intensity specified by rvalue.
3094 Noise-Impulse
3096 Result is the current channel value modulated with impulse
3098 noise according to the intensity specified by rvalue.
3099 Noise-Laplacian
3101 Result is the current channel value modulated with lapla‐
3103 cian noise according to the intensity specified by rvalue.
3104 Noise-Multiplicative
3106 Result is the current channel value modulated with multi‐
3108 plicative gaussian noise according to the intensity speci‐
3109 fied by rvalue.
3110 Noise-Poisson
3112 Result is the current channel value modulated with poisson
3114 noise according to the intensity specified by rvalue.
3115 Noise-Random
3117 Result is the current channel value modulated with random
3119 (uniform distribution) noise according to the intensity
3120 specified by rvalue. The initial noise intensity
3121 (rvalue=1.0) is the range of one pixel quantum span.
3122 Noise-Uniform
3124 Result is the channel value with uniform noise applied
3126 according to the intensity specified by rvalue.
3127 As an example, the Assign operator assigns a fixed value to a
3132 channel. For example, this command sets the red channel to the
3133 mid-range value:
3134 gm convert in.bmp -operator red assign "50%" out.bmp
3136 The following applies 50% thresholding to the image and returns
3139 a gray image:
3140 gm convert in.bmp -operator gray threshold "50%" out.bmp
3142 -ordered-dither <channeltype> <NxN>
3145 ordered dither the image
3146 The channel or channels specified in the channeltype argument
3148 are reduced to binary, using an ordered dither method. The
3149 choices for channeltype are All, Intensity, Red, Green, Blue,
3150 Cyan, Magenta, Yellow, Black, and Opacity
3151 When channeltype is "All", the color samples are dithered into a
3153 gray level and then that gray level is stored in the three color
3154 channels. Separately, the opacity channel is dithered into a
3155 bilevel opacity value which is stored in the opacity channel.
3156 When channeltype is "Intensity", only the color samples are
3158 dithered. When channeltype is "opacity" or "matte", only the
3159 opacity channel is dithered. When a color channel is specified,
3160 only that channel is dithered.
3161 The choices for N are 2 through 7. The image is divided into NxN
3163 pixel tiles. In each tile, some or all pixels are turned to
3164 white depending on their intensity. For each N, (N**2)+1 levels
3165 of gray can be represented. For N == 2, 3, or 4, the pixels are
3166 turned to white in an order that maximizes dispersion (i.e.,
3167 reduces granularity), while for N == 5, 6, and 7, they are
3168 turned to white in an order that creates a roughly circular
3169 black blob in the middle of each tile. An attractive "half-
3170 tone" looking image can be obtained by first rotating the image
3171 45 degrees, performing a 5x5 ordered-dither operation, then
3172 rotating it back to the original orientation and cropping to the
3173 original image dimensions. If the original image is gamma-
3174 encoded, it is adviseable to convert it to linear intensity
3175 first, e.g., with the "-gamma 0.45455" option.
3176 -output-directory <directory>
3178 output files to directory
3179 Use -output-directory to specify a directory under which to
3181 write the output files. Normally mogrify overwrites the input
3182 files, but with this option the output files may be written to a
3183 different directory tree so that the input files are preserved.
3184 The algorithm used preserves all of the input path specification
3185 in the output path so that the user-specified input path
3186 (including any sub-directory part) is appended to the output
3187 path. If the input file lacks an extension, then a suitable
3188 extension is automatically added to the output file. The user
3189 is responsible for creating the output directory specified as an
3190 argument, but subdirectories will be created as needed if the
3191 -create-directories option is supplied. This option may be used
3192 to apply transformations on files from one directory and write
3193 the transformed files to a different directory. In conjunction
3194 with -create-directories, this option is designed to support
3195 transforming whole directory trees of files provided that the
3196 relative path of the input file is included as part the list of
3197 filenames.
3198 -orient <orientation>
3200 Set the image orientation attribute
3201 Sets the image orientation attribute. The image orientation
3203 attribute is compatible with the TIFF orientation tag (and the
3204 EXIF orientation tag). Accepted values are undefined, TopLeft,
3205 TopRight, BottomRight, BottomLeft, LeftTop, RightTop, RightBot‐
3206 tom, LeftBottom, and hyphenated versions thereof (e.g. left-bot‐
3207 tom). Please note that GraphicsMagick does not include an EXIF
3208 editor so if an EXIF profile is written to the output image, the
3209 value in the EXIF profile might not match the image. It is pos‐
3210 sible for an image file to indicate its orientation in several
3211 different ways simultaneously.
3212 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
3214 size and location of an image canvas
3215 Use this option to specify the dimensions of the PostScript page
3217 in dots per inch or a TEXT page in pixels. The choices for a
3218 PostScript page are:
3219 11x17 792 1224
3221 Ledger 1224 792
3222 Legal 612 1008
3223 Letter 612 792
3224 LetterSmall 612 792
3225 ArchE 2592 3456
3226 ArchD 1728 2592
3227 ArchC 1296 1728
3228 ArchB 864 1296
3229 ArchA 648 864
3230 A0 2380 3368
3231 A1 1684 2380
3232 A2 1190 1684
3233 A3 842 1190
3234 A4 595 842
3235 A4Small 595 842
3236 A5 421 595
3237 A6 297 421
3238 A7 210 297
3239 A8 148 210
3240 A9 105 148
3241 A10 74 105
3242 B0 2836 4008
3243 B1 2004 2836
3244 B2 1418 2004
3245 B3 1002 1418
3246 B4 709 1002
3247 B5 501 709
3248 C0 2600 3677
3249 C1 1837 2600
3250 C2 1298 1837
3251 C3 918 1298
3252 C4 649 918
3253 C5 459 649
3254 C6 323 459
3255 Flsa 612 936
3256 Flse 612 936
3257 HalfLetter 396 612
3258 For convenience you can specify the page size by media (e.g. A4,
3261 Ledger, etc.). Otherwise, -page behaves much like -geometry
3262 (e.g. -page letter+43+43>).
3263 This option is also used to place subimages when writing to a
3265 multi-image format that supports offsets, such as GIF89 and MNG.
3266 When used for this purpose the offsets are always measured from
3267 the top left corner of the canvas and are not affected by the
3268 -gravity option. To position a GIF or MNG image, use
3269 -page{+-}<x>{+-}<y> (e.g. -page +100+200). When writing to a
3270 MNG file, a -page option appearing ahead of the first image in
3271 the sequence with nonzero width and height defines the width and
3272 height values that are written in the MHDR chunk. Otherwise,
3273 the MNG width and height are computed from the bounding box that
3274 contains all images in the sequence. When writing a GIF89 file,
3275 only the bounding box method is used to determine its dimen‐
3276 sions.
3277 For a PostScript page, the image is sized as in -geometry and
3279 positioned relative to the lower left hand corner of the page by
3280 {+-}<xoffset>{+-}<y offset>. Use -page 612x792>, for example, to
3281 center the image within the page. If the image size exceeds the
3282 PostScript page, it is reduced to fit the page. The default
3283 gravity for the -page option is NorthWest, i.e., positive x and
3284 y offset are measured rightward and downward from the top left
3285 corner of the page, unless the -gravity option is present with a
3286 value other than NorthWest.
3287 The default page dimensions for a TEXT image is 612x792.
3289 This option is used in concert with -density.
3291 Use +page to remove the page settings for an image.
3293 -paint <radius>
3295 simulate an oil painting
3296 Each pixel is replaced by the most frequent color in a circular
3298 neighborhood whose width is specified with radius.
3299 -pause <seconds>
3301 pause between animation loops [animate]
3302 Pause for the specified number of seconds before repeating the
3304 animation.
3305 -pause <seconds>
3307 pause between snapshots [import]
3308 Pause for the specified number of seconds before taking the next
3310 snapshot.
3311 -pen <color>
3313 (This option has been replaced by the -fill option)
3314 -ping efficiently determine image characteristics
3316 Use this option to disable reading the image pixels so that
3318 image characteristics such as the image dimensions may be
3319 obtained very quickly. For identify, use +ping to force reading
3320 the image pixels so that the pixel read rate may be included in
3321 the displayed information.
3322 -pointsize <value>
3324 pointsize of the PostScript, X11, or TrueType font
3325 -preview <type>
3327 image preview type
3328 Use this option to affect the preview operation of an image
3330 (e.g. convert file.png -preview Gamma Preview:gamma.png).
3331 Choose from these previews:
3332 Rotate
3334 Shear
3335 Roll
3336 Hue
3337 Saturation
3338 Brightness
3339 Gamma
3340 Spiff
3341 Dull
3342 Grayscale
3343 Quantize
3344 Despeckle
3345 ReduceNoise
3346 AddNoise
3347 Sharpen
3348 Blur
3349 Threshold
3350 EdgeDetect
3351 Spread
3352 Shade
3353 Raise
3354 Segment
3355 Solarize
3356 Swirl
3357 Implode
3358 Wave
3359 OilPaint
3360 CharcoalDrawing
3361 JPEG
3362 The default preview is JPEG.
3365 -process <command>
3367 process a sequence of images using a process module
3368 The command argument has the form module=arg1,arg2,arg3,...,argN
3370 where module is the name of the module to invoke (e.g. "ana‐
3371 lyze") and arg1,arg2,arg3,...,argN are an arbitrary number of
3372 arguments to pass to the process module. The sequence of images
3373 is terminated by the appearance of any option.
3374 If the -process option appears after all of the input images,
3376 all images are processed.
3377 -profile <filename>
3379 add ICM, IPTC, or generic profile to image
3380 -profile filename adds an ICM (ICC color management), IPTC
3382 (newswire information), or a generic (including Exif) profile to
3383 the image
3384 Use +profile icm, +profile iptc, or +profile profile_name to
3386 remove the respective profile. Multiple profiles may be listed,
3387 separated by commas. Profiles may be excluded from subsequent
3388 listed matches by preceding their name with an exclamation
3389 point. For example, +profile '!icm,*' strips all profiles
3390 except for the ICM profile. Use identify -verbose to find out
3391 what profiles are in the image file. Use +profile "*" to remove
3392 all profiles. Writing the image to a format that does not sup‐
3393 port profiles will of course also cause all profiles to be
3394 removed. The JPEG and PNG formats will store any profiles that
3395 have been read and not removed. In JPEG they are stored in APP1
3396 markers, and in PNG they are stored as hex-coded binary in com‐
3397 pressed zTXt chunks, except for the iCC chunk which is stored in
3398 the iCCP chunk.
3399 To extract a profile, the -profile option is not used. Instead,
3401 simply write the file to an image format such as APP1, 8BIM,
3402 ICM, or IPTC.
3403 For example, to extract the Exif data (which is stored in JPEG
3405 files in the APP1 profile), use
3406 gm convert cockatoo.jpg exifdata.app1
3409 Note that GraphicsMagick does not attempt to update any profile
3411 to reflect changes made to the image, e.g., rotation from por‐
3412 trait to landscape orientation, so it is possible that the pre‐
3413 served profile may contain invalid data.
3414 -preserve-timestamp
3416 preserve the original timestamps of the file
3417 Use this option to preserve the original modification and access
3419 timestamps of the file, even if it has been modified.
3420 +progress
3422 disable progress monitor and busy cursor
3423 By default, when an image is displayed, a progress monitor bar
3425 is shown in the top left corner of an existing image display
3426 window, and the current cursor is replaced with an hourglass
3427 cursor. Use +progress to disable the progress monitor and busy
3428 cursor during display operations. While the progress monitor is
3429 disabled for all operations, the busy cursor continues to be
3430 enabled for non-display operations such as image processing.
3431 This option is useful for non-interactive display operations, or
3432 when a "clean" look is desired.
3433 -quality <value>
3435 JPEG/MIFF/PNG/TIFF compression level
3436 For the JPEG and MPEG image formats, quality is 0 (lowest image
3437 quality and highest compression) to 100 (best quality but least
3438 effective compression). The default quality is 75. Use the
3439 -sampling-factor option to specify the factors for chroma down‐
3440 sampling. To use the same quality value as that found by the
3441 JPEG decoder, use the -define jpeg:preserve-settings flag.
3442 For the MIFF image format, and the TIFF format while using ZIP
3444 compression, quality/10 is the zlib compression level, which is
3445 0 (worst but fastest compression) to 9 (best but slowest). It
3446 has no effect on the image appearance, since the compression is
3447 always lossless.
3448 For the JPEG-2000 image format, quality is mapped using a non-
3450 linear equation to the compression ratio required by the Jasper
3451 library. This non-linear equation is intended to loosely approx‐
3452 imate the quality provided by the JPEG v1 format. The default
3453 quality value 75 results in a request for 16:1 compression. The
3454 quality value 100 results in a request for non-lossy compres‐
3455 sion.
3456 For the MNG and PNG image formats, the quality value sets the
3458 zlib compression level (quality / 10) and filter-type (quality %
3459 10). Compression levels range from 0 (fastest compression) to
3460 100 (best but slowest). For compression level 0, the Huffman-
3461 only strategy is used, which is fastest but not necessarily the
3462 worst compression.
3463 If filter-type is 4 or less, the specified filter-type is used
3465 for all scanlines:
3466 0: none
3468 1: sub
3469 2: up
3470 3: average
3471 4: Paeth
3472 If filter-type is 5, adaptive filtering is used when quality is
3475 greater than 50 and the image does not have a color map, other‐
3476 wise no filtering is used.
3477 If filter-type is 6, adaptive filtering with minimum-sum-of-
3479 absolute-values is used.
3480 Only if the output is MNG, if filter-type is 7, the LOCO color
3482 transformation and adaptive filtering with minimum-sum-of-abso‐
3483 lute-values are used.
3484 The default is quality is 75, which means nearly the best com‐
3486 pression with adaptive filtering. The quality setting has no
3487 effect on the appearance of PNG and MNG images, since the com‐
3488 pression is always lossless.
3489 For further information, see the PNG specification.
3491 When writing a JNG image with transparency, two quality values
3493 are required, one for the main image and one for the grayscale
3494 image that conveys the opacity channel. These are written as a
3495 single integer equal to the main image quality plus 1000 times
3496 the opacity quality. For example, if you want to use quality 75
3497 for the main image and quality 90 to compress the opacity data,
3498 use -quality 90075.
3499 For the PNM family of formats (PNM, PGM, and PPM) specify a
3501 quality factor of zero in order to obtain the ASCII variant of
3502 the format. Note that -compress none used to be used to trigger
3503 ASCII output but provided the opposite result of what was
3504 expected as compared with other formats.
3505 For the TIFF format, the JPEG, WebP, Zip, and Zstd compression
3507 algorithms are influenced by the quality value. JPEG and WebP
3508 provide lossy compression so higher quality produces a larger
3509 file with less degradation. The Zip and Zstd compression algo‐
3510 rithms (and WebP in lossless mode) are lossless and for these
3511 algorithms a higher ´quality' means to work harder to produce a
3512 smaller file, but with no difference in image quality.
3513 -raise <width>x<height>
3515 lighten or darken image edges
3516 This will create a 3-D effect. See -geometry for details details
3518 about the geometry specification. Offsets are not used.
3519 Use -raise to create a raised effect, otherwise use +raise.
3521 -random-threshold <channeltype> <LOWxHIGH>
3523 random threshold the image
3524 The channel or channels specified in the <channeltype> argument
3526 are reduced to binary, using an random-threshold method. The
3527 choices for channeltype are All, Intensity, Red, Green, Blue,
3528 Cyan, Magenta, Yellow, Black, and Opacity
3529 When channeltype is "All", the color samples are thresholded
3531 into a graylevel and then that gray level is stored in the three
3532 color channels. Separately, the opacity channel is thresholded
3533 into a bilevel opacity value which is stored in the opacity
3534 channel. For each pixel, a new random number is used to estab‐
3535 lish the threshold to be used. The threshold never exceeds the
3536 specified maximum (HIGH) and is never less than the specified
3537 minimum (LOW).
3538 When channeltype is "intensity", only the color samples are
3540 thresholded. When channeltype is "opacity" or "matte", only the
3541 opacity channel is thresholded. The other named channels only
3542 threshold the associated channel.
3543 -recolor <matrix>
3545 apply a color translation matrix to image channels
3546 A user supplied color translation matrix (expressed as a text
3548 string) is used to translate/blend the image channels based on
3549 weightings in a supplied matrix which may be of order 3 (color
3550 channels only), 4 (color channels plus opacity), or 5 (color
3551 channels plus opacity and offset). Values in the columns of the
3552 matrix (red, green, blue, opacity) are used as multipliers with
3553 the existing channel values and added together according to the
3554 rows of the matrix. Matrix values are floating point and may be
3555 negative. The offset column (column 5) is purely additive and
3556 is scaled such that 0.0 to 1.0 represents the maximum quantum
3557 range (but values are not limited to this range). The math for
3558 the color translation matrix is similar to that used by Adobe
3559 Flash except that the offset is scaled to 1.0 (divide Flash off‐
3560 set by 255 for use with GraphicsMagick) so that the results are
3561 independent of quantum depth.
3562 An identity matrix exists for each matrix order which results in
3564 no change to the image. The translation matrix should be based
3565 on an alteration of the identity matrix.
3566 Identity matrix of order 3
3568 1 0 0
3570 0 1 0
3571 0 0 1
3572 which may be formatted into a convenient matrix argument similar
3575 to (comma is treated as white space):
3576 -recolor "1 0 0, 0 1 0, 0 0 1"
3578 Identity matrix of order 4
3581 1 0 0 0
3583 0 1 0 0
3584 0 0 1 0
3585 0 0 0 1
3586 Identity matrix of order 5. The last row is required to exist
3589 for the purpose of parsing, but is otherwise not used.
3590 1 0 0 0 0
3592 0 1 0 0 0
3593 0 0 1 0 0
3594 0 0 0 1 0
3595 0 0 0 0 1
3596 As an example, an image wrongly in BGR channel order may be con‐
3599 verted to RGB using this matrix (blue->red, red->blue):
3600 0 0 1
3602 0 1 0
3603 1 0 0
3604 and an RGB image using standard Rec.709 primaries may be con‐
3607 verted to grayscale using this matrix of standard weighting fac‐
3608 tors:
3609 0.2126 0.7152 0.0722
3611 0.2126 0.7152 0.0722
3612 0.2126 0.7152 0.0722
3613 and contrast may be reduced by scaling down by 80% and adding a
3616 10% offset:
3617 0.8 0.0 0.0 0.0 0.1
3619 0.0 0.8 0.0 0.0 0.1
3620 0.0 0.0 0.8 0.0 0.1
3621 0.0 0.0 0.0 0.8 0.1
3622 0.0 0.0 0.0 0.0 1.0
3623 -red-primary <x>,<y>
3626 red chromaticity primary point
3627 -region <width>x<height>{+-}<x>{+-}<y>
3629 apply options to a portion of the image
3630 The x and y offsets are treated in the same manner as in -crop.
3632 -remote
3634 perform a X11 remote operation
3635 The -remote command sends a command to a "gm display" or "gm
3637 animate" which is already running. The only command recognized
3638 at this time is the name of an image file to load. This capabil‐
3639 ity is very useful to load new images without needing to restart
3640 GraphicsMagick (e.g. for a slide-show or to use GraphicsMagick
3641 as the display engine for a different GUI). Also see the
3642 +progress option for a way to disable progress indication for a
3643 clean look while loading new images.
3644 -render
3646 render vector operations
3647 Use +render to turn off rendering vector operations. This is
3649 useful when saving the result to vector formats such as MVG or
3650 SVG.
3651 -repage <width>x<height>+xoff+yoff[!]
3653 Adjust image page offsets
3654 Adjust the current image page canvas and position based on a
3656 relative page specification. This option may be used to change
3657 the location of a subframe (e.g. part of an animation) prior to
3658 composition. If the geometry specification is absolute
3659 (includes a '!'), then the offset adjustment is absolute and
3660 there is no adjustment to page width and height, otherwise the
3661 page width and height values are also adjusted based on the cur‐
3662 rent image dimensions. Use +repage to set the image page off‐
3663 sets to default.
3664 -resample <horizontal>x<vertical>
3666 Resample image to specified horizontal and vertical resolution
3667 Resize the image so that its rendered size remains the same as
3669 the original at the specified target resolution. Either the cur‐
3670 rent image resolution units or the previously set with -units
3671 are used to interpret the argument. For example, if a 300 DPI
3672 image renders at 3 inches by 2 inches on a 300 DPI device, when
3673 the image has been resampled to 72 DPI, it will render at 3
3674 inches by 2 inches on a 72 DPI device. Note that only a small
3675 number of image formats (e.g. JPEG, PNG, and TIFF) are capable
3676 of storing the image resolution. For formats which do not sup‐
3677 port an image resolution, the original resolution of the image
3678 must be specified via -density on the command line prior to
3679 specifying the resample resolution.
3680 Note that Photoshop stores and obtains image resolution from a
3682 proprietary embedded profile. If this profile exists in the
3683 image, then Photoshop will continue to treat the image using its
3684 former resolution, ignoring the image resolution specified in
3685 the standard file header.
3686 Some image formats (e.g. PNG) require use of metric or english
3688 units so even if the original image used a particular unit sys‐
3689 tem, if it is saved to a different format prior to resampling,
3690 then it may be necessary to specify the desired resolution units
3691 using -units since the original units may have been lost. In
3692 other words, do not assume that the resolution units are
3693 restored if the image has been saved to a file.
3694 -resize <width>x<height>{%}{@}{!}{<}{>}
3696 resize an image
3697 This is an alias for the -geometry option and it behaves in the
3699 same manner. If the -filter option precedes the -resize option,
3700 the specified filter is used.
3701 There are some exceptions:
3703 When used as a composite option, -resize conveys the preferred
3705 size of the output image, while -geometry conveys the size and
3706 placement of the composite image within the main image.
3707 When used as a montage option, -resize conveys the preferred
3709 size of the montage, while -geometry conveys information about
3710 the tiles.
3711 -roll {+-}<x>{+-}<y>
3713 roll an image vertically or horizontally
3714 See -geometry for details the geometry specification. The x and
3716 y offsets are not affected by the -gravity option.
3717 A negative x offset rolls the image left-to-right. A negative y
3719 offset rolls the image top-to-bottom.
3720 -rotate <degrees>{<}{>}
3722 rotate the image
3723 Positive angles rotate the image in a clockwise direction while
3725 negative angles rotate counter-clockwise.
3726 Use > to rotate the image only if its width exceeds the height.
3728 < rotates the image only if its width is less than the height.
3729 For example, if you specify -rotate "-90>" and the image size is
3730 480x640, the image is not rotated. However, if the image is
3731 640x480, it is rotated by -90 degrees. If you use > or <,
3732 enclose it in quotation marks to prevent it from being misinter‐
3733 preted as a file redirection.
3734 Empty triangles left over from rotating the image are filled
3736 with the color defined as background (class backgroundColor).
3737 The color is specified using the format described under the
3738 -fill option.
3739 -sample <geometry>
3741 scale image using pixel sampling
3742 See -geometry for details about the geometry specification.
3744 -sample ignores the -filter selection if the -filter option is
3745 present. Offsets, if present in the geometry string, are
3746 ignored, and the -gravity option has no effect.
3747 -sampling-factor <horizontal_factor>x<vertical_factor>
3749 chroma subsampling factors
3750 This option specifies the sampling factors to be used by the
3752 DPX, JPEG, MPEG, or YUV encoders for chroma downsampling. The
3753 sampling factor must be specified while reading the raw YUV for‐
3754 mat since it is not preserved in the file header. Industry-
3755 standard video subsampling notation such as "4:2:2" may also be
3756 used to specify the sampling factors. "4:2:2" is equivalent to a
3757 specification of "2x1"
3758 The JPEG decoder obtains the original sampling factors (and
3760 quality settings) when a JPEG file is read. To re-use the origi‐
3761 nal sampling factors (and quality setting) when JPEG is output,
3762 use the -define jpeg:preserve-settings flag.
3763 -scale <geometry>
3765 scale the image.
3766 See -geometry for details about the geometry specification.
3768 -scale uses a simpler, faster algorithm, and it ignores the
3769 -filter selection if the -filter option is present. Offsets, if
3770 present in the geometry string, are ignored, and the -gravity
3771 option has no effect.
3772 -scene <value>
3774 set scene number
3775 This option sets the scene number of an image or the first image
3777 in an image sequence.
3778 -scenes <value-value>
3780 range of image scene numbers to read
3781 Each image in the range is read with the filename followed by a
3783 period (.) and the decimal scene number. You can change this
3784 behavior by embedding a %d, %0Nd, %o, %0No, %x, or %0Nx printf
3785 format specification in the file name. For example,
3786 gm montage -scenes 5-7 image.miff montage.miff
3788 makes a montage of files image.miff.5, image.miff.6, and
3791 image.miff.7, and
3792 gm animate -scenes 0-12 image%02d.miff
3794 animates files image00.miff, image01.miff, through image12.miff.
3797 -screen
3799 specify the screen to capture
3800 This option indicates that the GetImage request used to obtain
3802 the image should be done on the root window, rather than
3803 directly on the specified window. In this way, you can obtain
3804 pieces of other windows that overlap the specified window, and
3805 more importantly, you can capture menus or other popups that are
3806 independent windows but appear over the specified window.
3807 -set <attribute> <value>
3809 set an image attribute
3810 Set a named image attribute. The attribute is set on the cur‐
3812 rent (previously specified on command line) image.
3813 +set <attribute>
3815 unset an image attribute
3816 Unset a named image attribute. The attribute is removed from
3818 the current (previously specified on command line) image.
3819 -segment <cluster threshold>x<smoothing threshold>
3821 segment an image
3822 Segment an image by analyzing the histograms of the color compo‐
3824 nents and identifying units that are homogeneous with the fuzzy
3825 c-means technique.
3826 Segmentation is a very useful fast and and approximate color
3828 quantization algorithm for scanned printed pages or scanned car‐
3829 toons. It may also be used as a special effect. Specify cluster
3830 threshold as the minimum percentage of total pixels in a cluster
3831 before it is considered valid. For huge images containing small
3832 detail, this may need to be a tiny fraction of a percent (e.g.
3833 0.015) so that important detail is not lost. Smoothing thresh‐
3834 old eliminates noise in the second derivative of the histogram.
3835 As the value is increased, you can expect a smoother second de‐
3836 rivative. The default is 1.5. Add the -verbose option to see a
3837 dump of cluster statistics given the parameters used. The sta‐
3838 tistics may be used as a guide to help fine tune the options.
3839 -shade <azimuth>x<elevation>
3841 shade the image using a distant light source
3842 Specify azimuth and elevation as the position of the light
3844 source. Use +shade to return the shading results as a grayscale
3845 image.
3846 -shadow <radius>{x<sigma>}
3848 shadow the montage
3849 -shared-memory
3851 use shared memory
3852 This option specifies whether the utility should attempt to use
3854 shared memory for pixmaps. GraphicsMagick must be compiled with
3855 shared memory support, and the display must support the MIT-SHM
3856 extension. Otherwise, this option is ignored. The default is
3857 True.
3858 -sharpen <radius>{x<sigma>}
3860 sharpen the image
3861 Use a Gaussian operator of the given radius and standard devia‐
3863 tion (sigma).
3864 -shave <width>x<height>{%}
3866 shave pixels from the image edges
3867 Specify the width of the region to be removed from both sides of
3869 the image and the height of the regions to be removed from top
3870 and bottom.
3871 -shear <x degrees>x<y degrees>
3873 shear the image along the X or Y axis
3874 Use the specified positive or negative shear angle.
3876 Shearing slides one edge of an image along the X or Y axis, cre‐
3878 ating a parallelogram. An X direction shear slides an edge along
3879 the X axis, while a Y direction shear slides an edge along the Y
3880 axis. The amount of the shear is controlled by a shear angle.
3881 For X direction shears, x degrees is measured relative to the Y
3882 axis, and similarly, for Y direction shears y degrees is mea‐
3883 sured relative to the X axis.
3884 Empty triangles left over from shearing the image are filled
3886 with the color defined as background (class backgroundColor).
3887 The color is specified using the format described under the
3888 -fill option.
3889 -silent
3891 operate silently
3892 -size <width>x<height>{+offset}
3894 width and height of the image
3895 Use this option to specify the width and height of raw images
3897 whose dimensions are unknown such as GRAY, RGB, or CMYK. In
3898 addition to width and height, use -size with an offset to skip
3899 any header information in the image or tell the number of colors
3900 in a MAP image file, (e.g. -size 640x512+256).
3901 For Photo CD images, choose from these sizes:
3903 192x128
3905 384x256
3906 768x512
3907 1536x1024
3908 3072x2048
3909 Finally, use this option to choose a particular resolution layer
3912 of a JBIG or JPEG image (e.g. -size 1024x768).
3913 -snaps <value>
3915 number of screen snapshots
3916 Use this option to grab more than one image from the X server
3918 screen, to create an animation sequence.
3919 -solarize <factor>
3921 negate all pixels above the threshold level
3922 Specify factor as the percent threshold of the intensity (0 -
3924 99.9%).
3925 This option produces a solarization effect seen when exposing a
3927 photographic film to light during the development process.
3928 -spread <amount>
3930 displace image pixels by a random amount
3931 Amount defines the size of the neighborhood around each pixel to
3933 choose a candidate pixel to swap.
3934 -stegano <offset>
3936 hide watermark within an image
3937 Use an offset to start the image hiding some number of pixels
3939 from the beginning of the image. Note this offset and the image
3940 size. You will need this information to recover the stegano‐
3941 graphic image (e.g. display -size 320x256+35 stegano:image.png).
3942 -stereo
3944 composite two images to create a stereo anaglyph
3945 The left side of the stereo pair is saved as the red channel of
3947 the output image. The right side is saved as the green channel.
3948 Red-green stereo glasses are required to properly view the
3949 stereo image.
3950 -strip remove all profiles and text attributes from the image
3952 All embedded profiles and text attributes are stripped from the
3954 image. This is useful for images used for the web, or when out‐
3955 put files need to be as small as possible
3956 Be careful not to use this option to remove author, copyright,
3958 and license information that you are required to retain when
3959 redistributing an image.
3960 -stroke <color>
3962 color to use when stroking a graphic primitive
3963 The color is specified using the format described under the
3965 -fill option.
3966 See -draw for further details.
3968 -strokewidth <value>
3970 set the stroke width
3971 See -draw for further details.
3973 -swirl <degrees>
3975 swirl image pixels about the center
3976 Degrees defines the tightness of the swirl.
3978 -text-font <name>
3980 font for writing fixed-width text
3981 Specifies the name of the preferred font to use in fixed (type‐
3983 writer style) formatted text. The default is 14 point Courier.
3984 You can tag a font to specify whether it is a PostScript, True‐
3986 Type, or X11 font. For example, Courier.ttf is a TrueType font
3987 and x:fixed is X11.
3988 -texture <filename>
3990 name of texture to tile onto the image background
3991 -threshold <value>{%}
3993 threshold the image
3994 Modify the image such that any pixel sample with an intensity
3996 value greater than the threshold is assigned the maximum inten‐
3997 sity (white), or otherwise is assigned the minimum intensity
3998 (black). If a percent prefix is applied, then the threshold is a
3999 percentage of the available range.
4000 To efficiently create a black and white image from a color
4002 image, use
4003 gm convert -threshold 50% in.png out.png
4005 The optimum threshold value depends on the nature of the image.
4008 In order to threshold individual channels, use the -operator
4009 subcommand with it's Threshold, Threshold-White, or Threshold-
4010 Black options.
4011 -thumbnail <width>x<height>{%}{@}{!}{<}{>}
4013 resize an image (quickly)
4014 The -thumbnail command resizes the image as quickly as possible,
4016 with more concern for speed than resulting image quality.
4017 Regardless, resulting image quality should be acceptable for
4018 many uses. It is primarily intended to be used to generate
4019 smaller versions of the image, but may also be used to enlarge
4020 the image. The -thumbnail geometry argument observes the same
4021 syntax and rules as it does for -resize.
4022 -tile <filename>
4024 tile image when filling a graphic primitive
4025 -tile <geometry>
4027 layout of images [montage]
4028 -title <string>
4030 assign title to displayed image [animate, display, montage]
4031 Use this option to assign a specific title to the image. This is
4033 assigned to the image window and is typically displayed in the
4034 window title bar. Optionally you can include the image file‐
4035 name, type, width, height, Exif data, or other image attribute
4036 by embedding special format characters described under the -for‐
4037 mat option.
4038 For example,
4040 -title "%m:%f %wx%h"
4042 produces an image title of MIFF:bird.miff 512x480 for an image
4045 titled bird.miff and whose width is 512 and height is 480.
4046 -transform
4048 transform the image
4049 This option applies the transformation matrix from a previous
4051 -affine option.
4052 gm convert -affine 2,2,-2,2,0,0 -transform bird.ppm bird.jpg
4054 -transparent <color>
4057 make this color transparent within the image
4058 The color is specified using the format described under the
4060 -fill option.
4061 -treedepth <value>
4063 tree depth for the color reduction algorithm
4064 Normally, this integer value is zero or one. A value of zero or
4066 one causes the use of an optimal tree depth for the color reduc‐
4067 tion algorithm
4068 An optimal depth generally allows the best representation of the
4070 source image with the fastest computational speed and the least
4071 amount of memory. However, the default depth is inappropriate
4072 for some images. To assure the best representation, try values
4073 between 2 and 8 for this parameter. Refer to quantize for more
4074 details.
4075 The -colors or -monochrome option, or writing to an image format
4077 which requires color reduction, is required for this option to
4078 take effect.
4079 -trim trim an image
4081 This option removes any edges that are exactly the same color as
4083 the corner pixels. Use -fuzz to make -trim remove edges that
4084 are nearly the same color as the corner pixels.
4085 -type <type>
4087 the image type
4088 Choose from: Bilevel, Grayscale, Palette, PaletteMatte, True‐
4090 Color, TrueColorMatte, ColorSeparation, ColorSeparationMatte, or
4091 Optimize.
4092 Normally, when a format supports different subformats such as
4094 bilevel, grayscale, palette, truecolor, and truecolor+alpha, the
4095 encoder will try to choose a suitable subformat based on the
4096 nature of the image. The -type option may be used to tailor the
4097 output subformat. By default the output subformat is based on
4098 readily available image information and is usually similar to
4099 the input format.
4100 Specify -type Optimize in order to enable inspecting all pixels
4102 (if necessary) in order to find the most efficient subformat.
4103 Inspecting all of the pixels may be slow for very large images,
4104 particularly if they are stored in a disk cache. If an RGB image
4105 contains only gray pixels, then every pixel in the image must be
4106 inspected in order to decide that the image is actually
4107 grayscale!
4108 Sometimes a specific subformat is desired. For example, to force
4110 a JPEG image to be written in TrueColor RGB format even though
4111 only gray pixels are present, use
4112 gm convert bird.pgm -type TrueColor bird.jpg
4114 Similarly, using -type TrueColorMatte will force the encoder to
4117 write an alpha channel even though the image is opaque, if the
4118 output format supports transparency.
4119 Some pseudo-formats (e.g. the XC format) will respect the
4121 requested type if it occurs previously on the command line. For
4122 example, to obtain a DirectClass solid color canvas image rather
4123 than PsuedoClass, use
4124 gm convert -size 640x480 -type TrueColor xc:red red.miff
4126 Likewise, specify -type Bilevel, Grayscale, TrueColor, or True‐
4129 ColorMatte prior to reading a Postscript (or PDF file) in order
4130 to influence the type of image that Ghostcript returns. Reading
4131 performance will be dramatically improved for black/white Post‐
4132 script if Bilevel is specified, and will be considerably faster
4133 if Grayscale is specified.
4134 -update <seconds>
4136 detect when image file is modified and redisplay.
4137 Suppose that while you are displaying an image the file that is
4139 currently displayed is over-written. display will automatically
4140 detect that the input file has been changed and update the dis‐
4141 played image accordingly.
4142 -units <type>
4144 the units of image resolution
4145 Choose from: Undefined, PixelsPerInch, or PixelsPerCentimeter.
4147 This option is normally used in conjunction with the -density
4148 option.
4149 -unsharp <radius>{x<sigma>}{+<amount>}{+<threshold>}
4151 sharpen the image with an unsharp mask operator
4152 The -unsharp option sharpens an image. The image is convolved
4154 with a Gaussian operator of the given radius and standard devia‐
4155 tion (sigma). For reasonable results, radius should be larger
4156 than sigma. Use a radius of 0 to have the method select a suit‐
4157 able radius.
4158 The parameters are:
4160 radius
4163 The radius of the Gaussian, in pixels, not counting the
4166 center pixel (default 0).
4167 sigma
4169 The standard deviation of the Gaussian, in pixels (default
4172 1.0).
4173 amount
4175 The percentage of the difference between the original and
4178 the blur image that is added back into the original
4179 (default 1.0).
4180 threshold
4182 The threshold, as a fraction of MaxRGB, needed to apply
4185 the difference amount (default 0.05).
4186 -use-pixmap
4191 use the pixmap
4192 -verbose
4194 print detailed information about the image
4195 This information is printed: image scene number; image name;
4197 image size; the image class (DirectClass or PseudoClass); the
4198 total number of unique colors; and the number of seconds to read
4199 and transform the image. If the image is DirectClass, the total
4200 number of unique colors is not displayed unless -verbose is
4201 specified twice since it may take quite a long time to compute,
4202 particularly for deep images. If the image is PseudoClass then
4203 its pixels are defined by indexes into a colormap. If the image
4204 is DirectClass then each pixel includes a complete and indepen‐
4205 dent color specification.
4206 If -colors is also specified, the total unique colors in the
4208 image and color reduction error values are printed. Refer to
4209 quantize for a description of these values.
4210 -version
4212 print GraphicsMagick version string
4213 -view <string>
4215 FlashPix viewing parameters
4216 -virtual-pixel <method>
4218 specify contents of "virtual pixels"
4219 This option defines "virtual pixels" for use in operations that
4221 can access pixels outside the boundaries of an image.
4222 Choose from these methods:
4224 Constant
4227 Use the image background color.
4230 Edge
4232 Extend the edge pixel toward infinity (default).
4235 Mirror
4237 Mirror the image.
4240 Tile
4242 Tile the image.
4245 This option affects operations that use virtual pixels such as
4250 -blur, -sharpen, -wave, etc.
4251 -visual <type>
4253 animate images using this X visual type
4254 Choose from these visual classes:
4256 StaticGray
4258 GrayScale
4259 StaticColor
4260 PseudoColor
4261 TrueColor
4262 DirectColor
4263 default
4264 visual id
4265 The X server must support the visual you choose, otherwise an
4268 error occurs. If a visual is not specified, the visual class
4269 that can display the most simultaneous colors on the default
4270 screen is chosen.
4271 -watermark <brightness>x<saturation>
4273 percent brightness and saturation of a watermark
4274 -wave <amplitude>x<wavelength>
4276 alter an image along a sine wave
4277 Specify amplitude and wavelength of the wave.
4279 -white-point <x>,<y>
4281 chromaticity white point
4282 -white-threshold red[,green][,blue][,opacity]
4284 pixels above the threshold become white
4285 Use -white-threshold to set pixels with values above the speci‐
4287 fied threshold to maximum value (white). If only one value is
4288 supplied, or the red, green, and blue values are identical, then
4289 intensity thresholding is used. If the color threshold values
4290 are not identical then channel-based thresholding is used, and
4291 color distortion will occur. Specify a negative value (e.g. -1)
4292 if you want a channel to be ignored but you do want to threshold
4293 a channel later in the list. If a percent (%) symbol is
4294 appended, then the values are treated as a percentage of maximum
4295 range.
4296 -window <id>
4298 make image the background of a window
4299 id can be a window id or name. Specify root to select X's root
4301 window as the target window.
4302 By default the image is tiled onto the background of the target
4304 window. If backdrop or -geometry are specified, the image is
4305 surrounded by the background color. Refer to X RESOURCES for
4306 details.
4307 The image will not display on the root window if the image has
4309 more unique colors than the target window colormap allows. Use
4310 -colors to reduce the number of colors.
4311 -window-group
4313 specify the window group
4314 -write <filename>
4316 write an intermediate image [convert, composite]
4317 The current image is written to the specified filename and then
4319 processing continues using that image. The following is an exam‐
4320 ple of how several sizes of an image may be generated in one
4321 command (repeat as often as needed):
4322 gm convert input.jpg -resize 50% -write input50.jpg \
4324 -resize 25% input25.jpg
4325 -write <filename>
4328 write the image to a file [display]
4329 If filename already exists, you will be prompted as to whether
4331 it should be overwritten.
4332 By default, the image is written in the format that it was read
4334 in as. To specify a particular image format, prefix filename
4335 with the image type and a colon (e.g., ps:image) or specify the
4336 image type as the filename suffix (e.g., image.ps). Specify file
4337 as - for standard output. If file has the extension .Z or .gz,
4338 the file size is compressed using compress or gzip respectively.
4339 Precede the image file name with | to pipe to a system command.
4340 Use -compress to specify the type of image compression.
4342 The equivalent X resource for this option is writeFilename
4344 (class WriteFilename). See "X Resources", below, for details.
4345
4347 COLUMNS
4348 Output screen width. Used when formatting text for the screen.
4349 Many Unix systems keep this shell variable up to date, but it
4350 may need to be explicitly exported in order for GraphicsMagick
4351 to see it.
4352 DISPLAY
4354 X11 display ID (host, display number, and screen in the form
4355 hostname:display.screen).
4356 HOME Location of user's home directory. For security reasons, now
4358 only observed by "uninstalled" builds of GraphicsMagick which do
4359 not have their location hard-coded or set by an installer. When
4360 supported, GraphicsMagick searches for configuration files in
4361 $HOME/.magick if the directory exists. See MAGICK_CODER_MOD‐
4362 ULE_PATH, MAGICK_CONFIGURE_PATH, and MAGICK_FILTER_MODULE_PATH
4363 if more flexibility is needed.
4364 MAGICK_ACCESS_MONITOR
4366 When set to TRUE, command line monitor mode (enabled by -moni‐
4367 tor) will also show files accessed (including temporary files)
4368 and any external commands which are executed. This is useful for
4369 debugging, but also illustrates arguments made available to an
4370 access handler registered by the MagickSetConfirmAccessHandler()
4371 C library function.
4372 MAGICK_CODER_STABILITY
4374 The minimum coder stability level before it will be used. The
4375 available levels are PRIMARY, STABLE, UNSTABLE, and BROKEN. The
4376 default minimum level is UNSTABLE, which means that all avail‐
4377 able working coders will be used. The purpose of this option is
4378 to reduce the security exposure (or apparent complexity) due to
4379 the huge number of formats supported. Coders at the PRIMARY
4380 level are commonly used formats with very well maintained imple‐
4381 mentations. Coders at the STABLE level are reasonably well main‐
4382 tained but represent less used formats. Coders at the UNSTABLE
4383 level either have weak implementations, the file format itself
4384 is weak, or the probability the coder will be needed is vanish‐
4385 ingly small. Coders at the BROKEN level are known to often not
4386 work properly or might not be useful in their current state at
4387 all.
4388 MAGICK_CODER_MODULE_PATH
4390 Search path to use when searching for image format coder mod‐
4391 ules. This path allows the user to arbitrarily extend the image
4392 formats supported by GraphicsMagick by adding loadable modules
4393 to an arbitrary location rather than copying them into the
4394 GraphicsMagick installation directory. The formatting of the
4395 search path is similar to operating system search paths (i.e.
4396 colon delimited for Unix, and semi-colon delimited for Microsoft
4397 Windows). This user specified search path is used before trying
4398 the default search path.
4399 MAGICK_CONFIGURE_PATH
4401 Search path to use when searching for configuration (.mgk)
4402 files. The formatting of the search path is similar to operat‐
4403 ing system search paths (i.e. colon delimited for Unix, and
4404 semi-colon delimited for Microsoft Windows). This user specified
4405 search path is used before trying the default search path.
4406 MAGICK_DEBUG
4408 Debug options (see -debug for details). Setting the configure
4409 debug option via an environment variable (e.g. MAGICK_DEBUG=con‐
4410 figure) is necessary to see the complete initialization process,
4411 which includes searching for configuration files.
4412 MAGICK_FILTER_MODULE_PATH
4414 Search path to use when searching for filter process modules
4415 (invoked via -process). This path allows the user to arbitrarily
4416 extend GraphicsMagick's image processing functionality by adding
4417 loadable modules to an arbitrary location rather than copying
4418 them into the GraphicsMagick installation directory. The format‐
4419 ting of the search path is similar to operating system search
4420 paths (i.e. colon delimited for Unix, and semi-colon delimited
4421 for Microsoft Windows). This user specified search path is used
4422 before trying the default search path.
4423 MAGICK_GHOSTSCRIPT_PATH
4425 For Microsoft Windows, specify the path to the Ghostscript
4426 installation rather than searching for it via the Windows reg‐
4427 istry. This helps in case Ghostscript is not installed via the
4428 Ghostscript Windows installer or the user wants more control
4429 over the Ghostscript used.
4430 MAGICK_HOME
4432 Path to top of GraphicsMagick installation directory. Only
4433 observed by "uninstalled" builds of GraphicsMagick which do not
4434 have their location hard-coded or set by an installer.
4435 MAGICK_MMAP_READ
4437 If MAGICK_MMAP_READ is set to TRUE, GraphicsMagick will attempt
4438 to memory-map the input file for reading. This usually substan‐
4439 tially improves repeated read performance since the file is
4440 already in memory after the first time it has been read. How‐
4441 ever, testing shows that performance may be reduced for files
4442 accessed for the first time since data is accessed via page-
4443 faults (upon first access) and many operating systems fail to do
4444 sequential read-ahead of memory mapped files, and particularly
4445 if those files are accessed over a network. If many large input
4446 files are read, then enabling this option may harm performance
4447 by overloading the operating system's VM system as it then needs
4448 to free unmapped pages and map new ones.
4449 MAGICK_IO_FSYNC
4451 If MAGICK_IO_FSYNC is set to TRUE, then GraphicsMagick will
4452 request that the output file is fully flushed and synchronized
4453 to disk when it is closed. This incurs a performance penalty,
4454 but has the benefit that if the power fails or the system
4455 crashes, the file should be valid on disk. If image files are
4456 referenced from a database, then this option helps assure that
4457 the files referenced by the database are valid.
4458 MAGICK_IOBUF_SIZE
4460 The amount of I/O buffering (in bytes) to use when reading and
4461 writing encoded files. The default is 16384, which is observed
4462 to work well for many cases. The best value for a local filesys‐
4463 tem is usually the the native filesystem block size (e.g. 4096,
4464 8192, or even 131,072 for ZFS) in order to minimize the number
4465 of physical disk I/O operations. I/O performance to files
4466 accessed over a network may benefit significantly by tuning this
4467 option. Larger values are not necessarily better (they may be
4468 slower!), and there is rarely any benefit from using values
4469 larger than 32768. Use convert's -verbose option in order to
4470 evaluate read and write rates in pixels per second while keeping
4471 in mind that the operating system will try to cache files in
4472 RAM.
4473 MAGICK_LIMIT_DISK
4475 Maximum amount of disk space allowed for use by the pixel cache.
4476 MAGICK_LIMIT_FILES
4478 Maximum number of open files.
4479 MAGICK_LIMIT_MAP
4481 Maximum size of a memory mapped file allocation. A memory
4482 mapped file consumes memory when the file is accessed, although
4483 the system may reclaim such memory when needed.
4484 MAGICK_LIMIT_MEMORY
4486 Maximum amount of memory to allocate from the heap.
4487 MAGICK_LIMIT_PIXELS
4489 Maximum number of total pixels (image rows times image colums)
4490 to allow for any image which is requested to be created or read.
4491 This is useful to place a limit on how large an image may be.
4492 If the input image file has image dimensions larger than the
4493 pixel limit, then the image memory allocation is denied and an
4494 error is returned immediately. This is a per-image limit and
4495 does not limit the total number of pixels due to multiple image
4496 frames/pages (e.g. multi-page document or an animation).
4497 MAGICK_LIMIT_WIDTH
4499 Maximum pixel width of an image read, or created.
4500 MAGICK_LIMIT_HEIGHT
4502 Maximum pixel height of an image read, or created.
4503 MAGICK_TMPDIR
4505 Path to directory where GraphicsMagick should write temporary
4506 files. The default is to use the system default, or the location
4507 set by TMPDIR.
4508 TMPDIR For POSIX-compatible systems (Unix-compatible), the path to the
4510 directory where all applications should write temporary files.
4511 Overridden by MAGICK_TMPDIR if it is set.
4512 TMP or TEMP
4514 For Microsoft Windows, the path to the directory where applica‐
4515 tions should write temporary files. Overridden by MAGICK_TMPDIR
4516 if it is set.
4517 OMP_NUM_THREADS
4519 As per the OpenMP standard, this specifies the number of threads
4520 to use in parallel regions. Some compilers default the number of
4521 threads to use to the number of processor cores available while
4522 others default to just one thread. See the OpenMP specification
4523 for other standard adjustments and your compiler's manual for
4524 vendor-specific settings.
4525
4527 GraphicsMagick uses a number of XML format configuration files:
4528 colors.mgk
4530 colors configuration file
4531 <?xml version="1.0"?>
4533 <colormap>
4534 <color name="AliceBlue" red="240" green="248" blue="255"
4535 compliance="SVG, X11, XPM" />
4536 </colormap>
4537 delegates.mgk
4540 delegates configuration file
4541 log.mgk
4543 logging configuration file
4544 <?xml version="1.0"?>
4546 <magicklog>
4547 <log events="None" />
4548 <log output="stdout" />
4549 <log filename="Magick-%d.log" />
4550 <log generations="3" />
4551 <log limit="2000" />
4552 <log format="%t %r %u %p %m/%f/%l/%d:\n %e" />
4553 </magicklog>
4554 modules.mgk
4557 loadable modules configuration file
4558 <?xml version="1.0"?>
4560 <modulemap>
4561 <module magick="8BIM" name="META" />
4562 </modulemap>
4563 type.mgk
4566 master type (fonts) configuration file
4567 <?xml version="1.0"?>
4569 <typemap>
4570 <include file="type-windows.mgk" />
4571 <type
4572 name="AvantGarde-Book"
4573 fullname="AvantGarde Book"
4574 family="AvantGarde"
4575 foundry="URW"
4576 weight="400"
4577 style="normal"
4578 stretch="normal"
4579 format="type1"
4580 metrics="/usr/local/share/ghostscript/fonts/a010013l.afm"
4581 glyphs="/usr/local/share/ghostscript/fonts/a010013l.pfb"
4582 />
4583 </typemap>
4584
4587 Animate displays a sequence of images on any workstation display run‐
4588 ning an X server. animate first determines the hardware capabilities of
4589 the workstation. If the number of unique colors in an image is less
4590 than or equal to the number the workstation can support, the image is
4591 displayed in an X window. Otherwise the number of colors in the image
4592 is first reduced to match the color resolution of the workstation
4593 before it is displayed.
4594 This means that a continuous-tone 24 bits-per-pixel image can display
4596 on a 8 bit pseudo-color device or monochrome device. In most instances
4597 the reduced color image closely resembles the original. Alternatively,
4598 a monochrome or pseudo-color image sequence can display on a continu‐
4599 ous-tone 24 bits-per-pixel device.
4600 To help prevent color flashing on X server visuals that have colormaps,
4602 animate creates a single colormap from the image sequence. This can be
4603 rather time consuming. You can speed this operation up by reducing the
4604 colors in the image before you "animate" them. Use mogrify to color
4605 reduce the images to a single colormap. See mogrify(1) for details.
4606 Alternatively, you can use a Standard Colormap; or a static, direct, or
4607 true color visual. You can define a Standard Colormap with xstdcmap.
4608 See xstdcmap(1) for details. This method is recommended for colormapped
4609 X server because it eliminates the need to compute a global colormap.
4610
4612 To animate a set of images of a cockatoo, use:
4613 gm animate cockatoo.*
4615 To animate a cockatoo image sequence while using the Standard Colormap
4618 best, use:
4619 xstdcmap -best
4621 gm animate -map best cockatoo.*
4622 To animate an image of a cockatoo without a border centered on a back‐
4625 drop, use:
4626 gm animate +borderwidth -backdrop cockatoo.*
4629
4632 For a more detailed description of each option, see Options, above.
4633 -authenticate <string>
4636 decrypt image with this password
4637 -backdrop
4639 display the image centered on a backdrop.
4640 -background <color>
4642 the background color
4643 -bordercolor <color>
4645 the border color
4646 -borderwidth <geometry>
4648 the border width
4649 -chop <width>x<height>{+-}<x>{+-}<y>{%}
4651 remove pixels from the interior of an image
4652 -colormap <type>
4654 define the colormap type
4655 -colors <value>
4657 preferred number of colors in the image
4658 -colorspace <value>
4660 the type of colorspace
4661 -crop <width>x<height>{+-}<x>{+-}<y>{%}
4663 preferred size and location of the cropped image
4664 -debug <events>
4666 enable debug printout
4667 -define <key>{=<value>},...
4669 add coder/decoder specific options
4670 -delay <1/100ths of a second>
4672 display the next image after pausing
4673 -density <width>x<height>
4675 horizontal and vertical resolution in pixels of the image
4676 -depth <value>
4678 depth of the image
4679 -display <host:display[.screen]>
4681 specifies the X server to contact
4682 -dispose <method>
4684 GIF disposal method
4685 -dither
4687 apply Floyd/Steinberg error diffusion to the image
4688 -font <name>
4690 use this font when annotating the image with text
4691 -foreground <color>
4693 define the foreground color
4694 -gamma <value>
4696 level of gamma correction
4697 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
4699 Specify dimension, offset, and resize options.
4700 -help print usage instructions
4702 -iconGeometry <geometry>
4704 specify the icon geometry
4705 -iconic
4707 iconic animation
4708 -interlace <type>
4710 the type of interlacing scheme
4711 -limit <type> <value>
4713 Disk, File, Map, Memory, Pixels, Width, Height or Threads
4714 resource limit
4715 -log <string>
4717 Specify format for debug log
4718 -map <type>
4720 display image using this type.
4721 -matte store matte channel if the image has one
4723 -mattecolor <color>
4725 specify the color to be used with the -frame option
4726 -monitor
4728 show progress indication
4729 -monochrome
4731 transform the image to black and white
4732 -name name an image
4734 -noop NOOP (no option)
4736 -pause <seconds>
4738 pause between animation loops [animate]
4739 -remote
4741 perform a X11 remote operation
4742 -rotate <degrees>{<}{>}
4744 rotate the image
4745 -sampling-factor <horizontal_factor>x<vertical_factor>
4747 chroma subsampling factors
4748 -scenes <value-value>
4750 range of image scene numbers to read
4751 -shared-memory
4753 use shared memory
4754 -size <width>x<height>{+offset}
4756 width and height of the image
4757 -text-font <name>
4759 font for writing fixed-width text
4760 -title <string>
4762 assign title to displayed image [animate, display, montage]
4763 -treedepth <value>
4765 tree depth for the color reduction algorithm
4766 -trim trim an image
4768 -type <type>
4770 the image type
4771 -verbose
4773 print detailed information about the image
4774 -version
4776 print GraphicsMagick version string
4777 -visual <type>
4779 animate images using this X visual type
4780 -window <id>
4782 make image the background of a window
4783 For a more detailed description of each option, see Options,
4785 above.
4786 Any option you specify on the command line remains in effect for
4789 the group of images following it, until the group is terminated
4790 by the appearance of any option or -noop. For example, to ani‐
4791 mate three images, the first with 32 colors, the second with an
4792 unlimited number of colors, and the third with only 16 colors,
4793 use:
4794 gm animate -colors 32 cockatoo.1 -noop cockatoo.2
4797 -colors 16 cockatoo.3
4798 Animate options can appear on the command line or in your X
4801 resources file. See X(1). Options on the command line supersede
4802 values specified in your X resources file. Image filenames may
4803 appear in any order on the command line if the image format is
4804 MIFF (refer to miff(5) and the scene keyword is specified in the
4805 image. Otherwise the images will display in the order they
4806 appear on the command line.
4807
4809 Press any button to map or unmap the Command widget. See the next sec‐
4810 tion for more information about the Command widget.
4811
4813 The Command widget lists a number of sub-menus and commands. They are
4814 Animate
4816 Open
4818 Play
4819 Step
4820 Repeat
4821 Auto Reverse
4822 Speed
4824 Faster
4826 Slower
4827 Direction
4829 Forward
4831 Reverse
4832 Image Info
4834 Help
4835 Quit
4836 Menu items with a indented triangle have a sub-menu. They are repre‐
4839 sented above as the indented items. To access a sub-menu item, move the
4840 pointer to the appropriate menu and press a button and drag. When you
4841 find the desired sub-menu item, release the button and the command is
4842 executed. Move the pointer away from the sub-menu if you decide not to
4843 execute a particular command.
4844
4846 Ctl+O
4847 Press to load an image from a file.
4849 space
4850 Press to display the next image in the sequence.
4852 <
4853 Press to speed-up the display of the images. Refer to
4855 -delay for more information.
4856 >
4857 Press to slow the display of the images. Refer to -delay
4859 for more information.
4860 ?
4861 Press to display information about the image. Press any
4863 key or button to erase the information.
4864 This information is printed: image name; image size; and
4865 the total number of unique colors in the image.
4866 F1
4867 Press to display helpful information about animate(1).
4869 Ctl-q
4870 Press to discard all images and exit program.
4872
4875 Animate options can appear on the command line or in your X resource
4876 file. Options on the command line supersede values specified in your X
4877 resource file. See X(1) for more information on X resources.
4878 All animate options have a corresponding X resource. In addition, the
4880 animate program uses the following X resources:
4881 background (class Background)
4883 Specifies the preferred color to use for the Image window
4886 background. The default is #ccc.
4887 borderColor (class BorderColor)
4888 Specifies the preferred color to use for the Image window
4891 border. The default is #ccc.
4892 borderWidth (class BorderWidth)
4893 Specifies the width in pixels of the Image window border.
4896 The default is 2.
4897 font (class Font or FontList)
4898 Specifies the name of the preferred font to use in normal
4901 formatted text. The default is 14 point Helvetica.
4902 foreground (class Foreground)
4903 Specifies the preferred color to use for text within the
4906 Image window. The default is black.
4907 geometry (class geometry)
4908 Specifies the preferred size and position of the image
4911 window. It is not necessarily obeyed by all window man‐
4912 agers. Offsets, if present, are handled in X(1) style. A
4913 negative x offset is measured from the right edge of the
4914 screen to the right edge of the icon, and a negative y
4915 offset is measured from the bottom edge of the screen to
4916 the bottom edge of the icon.
4917 iconGeometry (class IconGeometry)
4918 Specifies the preferred size and position of the applica‐
4921 tion when iconified. It is not necessarily obeyed by all
4922 window managers. Offsets, if present, are handled in the
4923 same manner as in class Geometry.
4924 iconic (class Iconic)
4925 This resource indicates that you would prefer that the
4928 application's windows initially not be visible as if the
4929 windows had be immediately iconified by you. Window man‐
4930 agers may choose not to honor the application's request.
4931 matteColor (class MatteColor)
4932 Specify the color of windows. It is used for the back‐
4935 grounds of windows, menus, and notices. A 3D effect is
4936 achieved by using highlight and shadow colors derived from
4937 this color. Default value: #ddd.
4938 name (class Name)
4939 This resource specifies the name under which resources for
4942 the application should be found. This resource is useful
4943 in shell aliases to distinguish between invocations of an
4944 application, without resorting to creating links to alter
4945 the executable file name. The default is the application
4946 name.
4947 sharedMemory (class SharedMemory)
4948 This resource specifies whether animate should attempt use
4951 shared memory for pixmaps. ImageMagick must be compiled
4952 with shared memory support, and the display must support
4953 the MIT-SHM extension. Otherwise, this resource is
4954 ignored. The default is True.
4955 text_font (class textFont)
4956 Specifies the name of the preferred font to use in fixed
4959 (typewriter style) formatted text. The default is 14 point
4960 Courier.
4961 title (class Title)
4962 This resource specifies the title to be used for the Image
4965 window. This information is sometimes used by a window
4966 manager to provide some sort of header identifying the
4967 window. The default is the image file name.
4968
4972 batch executes an arbitary number of the utility commands (e.g. con‐
4973 vert) in the form of a simple linear batch script in order to improve
4974 execution efficiency, and/or to allow use as a subordinate co-process
4975 under the control of an arbitrary script or program.
4976
4978 To drive 'gm batch' using a shell script (or a program written in any
4979 language), have the script/program send commands to 'gm batch' via its
4980 standard input. Specify that standard input should be used by using
4981 '-' as the file name. The following example converts all files match‐
4982 ing '*.jpg' to TIFF format while rotating each file by 90 degrees and
4983 stripping all embedded profiles. The shell script syntax is standard
4984 Unix shell:
4985 for file in *.jpg
4987 do
4988 outfile=`basename $file .jpg`.tiff
4989 echo convert -verbose "'$file'" -rotate 90 \
4990 +profile "'*'" "'$outfile'"
4991 done | gm batch -echo on -feedback on -
4992 We can accomplish the same as the previous example by putting all the
4995 commands in a text file and then specifying the name of the text file
4996 as the script to execute:
4997 for file in *.jpg
4999 do
5000 outfile=`basename $file .jpg`.tiff
5001 echo convert -verbose "'$file'" -rotate 90 \
5002 +profile "'*'" "'$outfile'"
5003 done > script.txt
5004 gm batch -echo on -feedback on script.txt
5005
5008 Options are processed from left to right and must appear before any
5009 filename argument.
5010 -echo on|off
5012 command echo on or off
5013 Specify on to enable echoing commands to standard output as they
5015 are read or off to disable. The default is off.
5016 -escape unix|windows
5018 Parse using unix or windows syntax
5019 Commands must be parsed from the input stream and escaping needs
5021 to be used to protect spaces or quoting characters in the input.
5022 Specify unix to use unix-style command line parsing or windows
5023 for Microsoft Windows command shell style parsing. The default
5024 depends on if the software is compiled for Microsoft Windows or
5025 for a Unix-type system (including Cygwin on Microsoft Windows).
5026 It is recommended to use unix syntax because it is more powerful
5027 and more portable.
5028 -fail text
5030 text to print if a command fails
5031 When feedback is enabled, this specifies the text to print when
5033 the command fails. The default text is FAIL.
5034 -feedback on|off
5036 enable error feedback
5037 Print text (see -pass and -fail options) feedback after each
5039 command to indicate the result, the default is off.
5040 -help
5042 Prints batch command help.
5044 -pass text
5046 text to print if a command passes
5047 When feedback is enabled, this specifies the text to print when
5049 the command passes. The default text is PASS.
5050 -prompt text
5052 Prompt text to use for command line
5053 If no filename argument was specified, a simple command prompt
5055 appears where you may enter GraphicsMagick commands. The
5056 default prompt is GM>. Use this option to change the prompt to
5057 something else.
5058 -stop-on-error on|off
5060 Specify if command processing stops on error
5061 Normally command processing continues if a command encounters an
5063 error. Specify -stop-on-error on to cause processing to quit
5064 immediately on error.
5065
5068 benchmark executes an arbitrary gm utility command (e.g. convert) for
5069 one or more loops, and/or a specified execution time, and reports many
5070 execution metrics. For builds using OpenMP, a mode is provided to exe‐
5071 cute the benchmark with an increasing number of threads and provide a
5072 report of speedup and multi-thread execution efficiency. If benchmark
5073 is used to execute a command without any additional benchmark options,
5074 then the command is run once.
5075
5077 To obtain benchmark information for a single execution of a command:
5078 gm benchmark convert input.ppm -gaussian 0x1 output.ppm
5080 To obtain benchmark information from 100 iterations of the command:
5082 gm benchmark -iterations 100 convert input.ppm \
5084 -gaussian 0x1 output.ppm
5085 To obtain benchmark information by iterating the command until a speci‐
5087 fied amount of time (in seconds) has been consumed:
5088 gm benchmark -duration 30 convert input.ppm \
5090 -gaussian 0x1 output.ppm
5091 To obtain a full performance report with an increasing number of
5093 threads (1-32 threads, stepping the number of threads by four each
5094 time):
5095 gm benchmark -duration 3 -stepthreads 4 convert \
5097 input.ppm -gaussian 0x2 output.ppm
5098 Here is the interpretation of the output:
5100 threads - number of threads used.
5102 iter - number of command iterations executed.
5103 user - total user time consumed.
5104 total - total elapsed time consumed.
5105 iter/s - number of command iterations per second.
5106 iter/cpu - amount of CPU time consumed per iteration.
5107 speedup - speedup compared with one thread.
5108 karp-flatt - Karp-Flatt measure of speedup efficiency.
5109 Please note that the reported "speedup" is based on the execution time
5111 of just one thread. A preliminary warm-up pass is used before timing
5112 the first loop in order to ensure that the CPU is brought out of power-
5113 saving modes and that system caches are warmed up. Most modern CPUs
5114 provide a "turbo" mode where the CPU clock speed is increased (e.g. by
5115 a factor of two) when only one or two cores are active. If the CPU
5116 grows excessively hot (due to insufficient cooling), then it may dial
5117 back its clock rates as a form of thermal management. These factors
5118 result in an under-reporting of speedup compared to if "turbo" mode was
5119 disabled and the CPU does not need to worry about thermal management.
5120 The powertop utility available under Linux and Solaris provides a way
5121 to observe CPU core clock rates while a benchmark is running.
5122
5124 Options are processed from left to right and must appear before any
5125 argument.
5126 -duration duration
5128 duration to run benchmark Specify the number of seconds to run
5129 the benchmark. The command is executed repeatedly until the
5130 specified amount of time has elapsed.
5131 -help
5133 Prints benchmark command help.
5135 -iterations loops
5137 number of command iterations Specify the number of iterations to
5138 run the benchmark. The command is executed repeatedly until the
5139 specified number of iterations has been reached.
5140 -rawcsv
5142 Print results in CSV format Print results in a comma-separated
5143 value (CSV) format which is easy to parse for plotting or
5144 importing into a spreadsheet or database. The values reported
5145 are threads, iterations, user_time, and elapsed_time.
5146 -stepthreads step
5148 execute a per-thread benchmark ramp
5149 Execute a per-thread benchmark ramp, incrementing the number of
5150 threads at each step by the specified value. The maximum number
5151 of threads is taken from the standard OMP_NUM_THREADS environ‐
5152 ment variable.
5153
5155 compare compares two similar images using a specified statistical
5156 method (see -metric) and/or by writing a difference image (-file), with
5157 the altered pixels annotated using a specified method (see -highlight-
5158 style) and color (see -highlight-color). Reference-image is the origi‐
5159 nal image and compare-image is the (possibly) altered version, which
5160 should have the same dimensions as reference-image.
5161
5163 To compare two images using Mean Square Error (MSE) statistical analy‐
5164 sis use:
5165 gm compare -metric mse original.miff compare.miff
5167 To create an annotated difference image use:
5170 gm compare -highlight-style assign -highlight-color purple \
5172 -file diff.miff original.miff compare.miff
5173
5176 Options are processed in command line order. Any option you specify on
5177 the command line remains in effect only for the image that follows.
5178 All options are reset to their default values after each image is read.
5179 For a more detailed description of each option, see Options, above.
5181 -authenticate <string>
5184 decrypt image with this password
5185 -colorspace <value>
5187 the type of colorspace
5188 -debug <events>
5190 enable debug printout
5191 -define <key>{=<value>},...
5193 add coder/decoder specific options
5194 -density <width>x<height>
5196 horizontal and vertical resolution in pixels of the image
5197 -depth <value>
5199 depth of the image
5200 -display <host:display[.screen]>
5202 specifies the X server to contact
5203 -endian <type>
5205 specify endianness (MSB, LSB, or Native) of image
5206 -file <filename>
5208 write annotated difference image to file
5209 -help print usage instructions
5211 -highlight-color <color>
5213 pixel annotation color
5214 -highlight-style <style>
5216 pixel annotation style
5217 -interlace <type>
5219 the type of interlacing scheme
5220 -limit <type> <value>
5222 Disk, File, Map, Memory, Pixels, Width, Height or Threads
5223 resource limit
5224 -log <string>
5226 Specify format for debug log
5227 -matte store matte channel if the image has one
5229 -maximum-error <limit>
5231 specifies the maximum amount of total image error
5232 -metric <metric>
5234 comparison metric (MAE, MSE, PAE, PSNR, RMSE)
5235 -monitor
5237 show progress indication
5238 -sampling-factor <horizontal_factor>x<vertical_factor>
5240 chroma subsampling factors
5241 -size <width>x<height>{+offset}
5243 width and height of the image
5244 -type <type>
5246 the image type
5247 -verbose
5249 print detailed information about the image
5250 -version
5252 print GraphicsMagick version string
5253 For a more detailed description of each option, see Options,
5255 above.
5256
5259 composite composites (combines) images to create new images. base-
5260 image is the base image and change-image contains the changes. ouput-
5261 image is the result, and normally has the same dimensions as base-
5262 image.
5263 The optional mask-image can be used to provide opacity information for
5266 change-image when it has none or if you want a different mask. A mask
5267 image is typically grayscale and the same size as base-image. If mask-
5268 image is not grayscale, it is converted to grayscale and the resulting
5269 intensities are used as opacity information.
5270
5272 To composite an image of a cockatoo with a perch, use:
5273 gm composite cockatoo.miff perch.ras composite.miff
5275 To compute the difference between images in a series, use:
5278 gm composite -compose difference series.2 series.1
5280 difference.miff
5281 To composite an image of a cockatoo with a perch starting at location
5284 (100,150), use:
5285 gm composite -geometry +100+150 cockatoo.miff
5287 perch.ras composite.miff
5288 To tile a logo across your image of a cockatoo, use
5291 gm convert +shade 30x60 cockatoo.miff mask.miff
5293 gm composite -compose bumpmap -tile logo.png
5294 cockatoo.miff mask.miff composite.miff
5295 To composite a red, green, and blue color plane into a single composite
5298 image, try
5299 gm composite -compose CopyGreen green.png red.png
5301 red-green.png
5302 gm composite -compose CopyBlue blue.png red-green.png
5303 gm composite.png
5304
5307 Options are processed in command line order. Any option you specify on
5308 the command line remains in effect only for the image that follows.
5309 All options are reset to their default values after each image is read.
5310 For a more detailed description of each option, see Options, above.
5312 -authenticate <string>
5315 decrypt image with this password
5316 -background <color>
5318 the background color
5319 -blue-primary <x>,<y>
5321 blue chromaticity primary point
5322 -colors <value>
5324 preferred number of colors in the image
5325 -colorspace <value>
5327 the type of colorspace
5328 -comment <string>
5330 annotate an image with a comment
5331 -compose <operator>
5333 the type of image composition
5334 -compress <type>
5336 the type of image compression
5337 -debug <events>
5339 enable debug printout
5340 -define <key>{=<value>},...
5342 add coder/decoder specific options
5343 -density <width>x<height>
5345 horizontal and vertical resolution in pixels of the image
5346 -depth <value>
5348 depth of the image
5349 -displace <horizontal scale>x<vertical scale>
5351 shift image pixels as defined by a displacement map
5352 -display <host:display[.screen]>
5354 specifies the X server to contact
5355 -dispose <method>
5357 GIF disposal method
5358 -dissolve <percent>
5360 dissolve an image into another by the given percent
5361 -dither
5363 apply Floyd/Steinberg error diffusion to the image
5364 -encoding <type>
5366 specify the text encoding
5367 -endian <type>
5369 specify endianness (MSB, LSB, or Native) of image
5370 -filter <type>
5372 use this type of filter when resizing an image
5373 -font <name>
5375 use this font when annotating the image with text
5376 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
5378 Specify dimension, offset, and resize options.
5379 -gravity <type>
5381 direction primitive gravitates to when annotating the image.
5382 -green-primary <x>,<y>
5384 green chromaticity primary point
5385 -help print usage instructions
5387 -interlace <type>
5389 the type of interlacing scheme
5390 -label <name>
5392 assign a label to an image
5393 -limit <type> <value>
5395 Disk, File, Map, Memory, Pixels, Width, Height or Threads
5396 resource limit
5397 -log <string>
5399 Specify format for debug log
5400 -matte store matte channel if the image has one
5402 -monitor
5404 show progress indication
5405 -monochrome
5407 transform the image to black and white
5408 -negate
5410 replace every pixel with its complementary color
5411 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
5413 size and location of an image canvas
5414 -profile <filename>
5416 add ICM, IPTC, or generic profile to image
5417 -quality <value>
5419 JPEG/MIFF/PNG/TIFF compression level
5420 -recolor <matrix>
5422 apply a color translation matrix to image channels
5423 -red-primary <x>,<y>
5425 red chromaticity primary point
5426 -render
5428 render vector operations
5429 -repage <width>x<height>+xoff+yoff[!]
5431 Adjust image page offsets
5432 -resize <width>x<height>{%}{@}{!}{<}{>}
5434 resize an image
5435 -rotate <degrees>{<}{>}
5437 rotate the image
5438 -sampling-factor <horizontal_factor>x<vertical_factor>
5440 chroma subsampling factors
5441 -scene <value>
5443 set scene number
5444 -set <attribute> <value>
5446 set an image attribute
5447 +set <attribute>
5449 unset an image attribute
5450 -sharpen <radius>{x<sigma>}
5452 sharpen the image
5453 -size <width>x<height>{+offset}
5455 width and height of the image
5456 -stegano <offset>
5458 hide watermark within an image
5459 -stereo
5461 composite two images to create a stereo anaglyph
5462 -strip remove all profiles and text attributes from the image
5464 -thumbnail <width>x<height>{%}{@}{!}{<}{>}
5466 resize an image (quickly)
5467 -treedepth <value>
5469 tree depth for the color reduction algorithm
5470 -trim trim an image
5472 -type <type>
5474 the image type
5475 -units <type>
5477 the units of image resolution
5478 -unsharp <radius>{x<sigma>}{+<amount>}{+<threshold>}
5480 sharpen the image with an unsharp mask operator
5481 -verbose
5483 print detailed information about the image
5484 -version
5486 print GraphicsMagick version string
5487 -watermark <brightness>x<saturation>
5489 percent brightness and saturation of a watermark
5490 -white-point <x>,<y>
5492 chromaticity white point
5493 -write <filename>
5495 write an intermediate image [convert, composite]
5496 For a more detailed description of each option, see Options,
5498 above.
5499
5502 The Magick scripting language (MSL) will primarily benefit those that
5503 want to accomplish custom image processing tasks but do not wish to
5504 program, or those that do not have access to a Perl interpreter or a
5505 compiler. The interpreter is called conjure and here is an example
5506 script:
5507 <?xml version="1.0" encoding="UTF-8"?>
5509 <image size="400x400" >
5510 <read filename="image.gif" />
5511 <get width="base-width" height="base-height" />
5512 <resize geometry="%[dimensions]" />
5513 <get width="width" height="height" />
5514 <print output=
5515 "Image sized from %[base-width]x%[base-height]
5516 to %[width]x%[height].\n" />
5517 <write filename="image.png" />
5518 </image>
5519 invoked with
5522 gm conjure -dimensions 400x400 incantation.msl
5524 All operations will closely follow the key/value pairs defined in Perl‐
5527 Magick, unless otherwise noted.
5528
5530 Options are processed in command line order. Any option you specify on
5531 the command line remains in effect until it is explicitly changed by
5532 specifying the option again with a different effect, or if it is
5533 changed by a statement in the scripting language.
5534 You can define your own keyword/value pairs on the command line. The
5536 script can then use this information when setting values by including
5537 %[keyword] in the string. For example, if you included "-dimensions
5538 400x400" on the command line, as illustrated above, then any string
5539 containing "%[dimensions]" would have 400x400 substituted. The
5540 "%[string]" can be used either an entire string, such as geome‐
5541 try="%[dimensions]" or as a part of a string such as filename="%[base‐
5542 name].png".
5543 The keyword can be any string except for the following reserved strings
5545 (in any upper, lower, or mixed case variant): debug, help, and verbose,
5546 whose usage is described below.
5547 The value can be any string. If either the keyword or the value con‐
5549 tains white space or any symbols that have special meanings to your
5550 shell such as "#", "|", or "%", enclose the string in quotation marks
5551 or use "\" to escape the white space and special symbols.
5552 Keywords and values are case dependent. "Key", "key", and "KEY" would
5554 be three different keywords.
5555 For a more detailed description of each option, see Options, above.
5557 -debug <events>
5560 enable debug printout
5561 -define <key>{=<value>},...
5563 add coder/decoder specific options
5564 -help print usage instructions
5566 -log <string>
5568 Specify format for debug log
5569 -verbose
5571 print detailed information about the image
5572 -version
5574 print GraphicsMagick version string
5575
5577 The Magick Scripting Language (MSL) presently defines the following
5578 elements and their attributes:
5579 <image>
5581 background, color, id, size
5583 Define a new image object. </image> destroys it. Because
5585 of this, if you wish to reference multiple "subimages"
5586 (aka pages or layers), you can embed one image element
5587 inside of another. For example:
5588 <image>
5592 <read filename="input.png" />
5593 <get width="base-width" height="base-height" />
5594 <image height="base-height" width="base-width">
5595 <image />
5596 <write filename="output.mng" />
5597 </image>
5598 <image size="400x400" />
5603 <group>
5606 Define a new group of image objects. By default, images
5609 are only valid for the life of their <image>element.
5610 <image> -- creates the image
5614 ..... -- do stuff with it
5615 </image> -- dispose of the image
5616 However, in a group, all images in that group will stay
5620 around for the life of the group:
5621 <group> -- start a group
5625 <image> -- create an image
5626 .... -- do stuff
5627 </image> -- NOOP
5628 <image> -- create another
5629 image
5630 .... -- do more stuff
5631 </image> -- NOOP
5632 <write filename="image.mng" /> -- output
5633 </group> -- dispose of both
5634 images
5635 <read>
5638 filename
5640 Read a new image from a disk file.
5642 <read filename="image.gif" />
5646 To read two images use
5650 <read filename="image.gif" />
5654 <read filename="image.png />
5655 <write>
5658 filename
5660 Write the image(s) to disk, either as a single multiple-
5661 image file or multiple ones if necessary.
5662 <write filename=image.tiff" />
5666 <get>
5668 Get any attribute recognized by PerlMagick's GetAt‐
5670 tribute() and stores it as an image attribute for later
5671 use. Currently only width and height are supported.
5672 <get width="base-width" height="base-height" />
5675 <print output="Image size is %[base-width]x%[base-
5676 height].\n" />
5677 <set>
5680 background, bordercolor, clip-mask, colorspace, density,
5682 magick, mattecolor, opacity. Set an attribute recognized
5683 by PerlMagick's GetAttribute().
5684 <profile>
5685 [profilename]
5687 Read one or more IPTC, ICC or generic profiles from file
5689 and assign to image
5690 <profile iptc="profile.iptc" generic="generic.dat" />
5694 To remove a specified profile use "!" as the filename eg
5698 <profile icm="!" iptc="profile.iptc" />
5702 <border>
5705 fill, geometry, height, width
5707 <blur>
5708 radius, sigma
5710 <charcoal>
5711 radius, sigma
5713 <chop>
5714 geometry, height, width, x, y
5716 <crop>
5717 geometry, height, width, x, y
5719 <composite>
5720 compose, geometry, gravity, image, x, y
5722 <?xml version="1.0" encoding="UTF-8"?>
5725 <group>
5726 <image id="image_01">
5727 <read filename="cloud3.gif"/>
5728 <resize geometry="250x90"/>
5729 </image>
5730 <image id="image_02">
5731 <read filename="cloud4.gif"/>
5732 <resize geometry="190x100"/>
5733 </image>
5734 <image>
5735 <read filename="background.jpg"/>
5736 <composite image="image_01" geome‐
5737 try="+740+470"/>
5738 <composite image="image_02" geome‐
5739 try="+390+415"/>
5740 </image>
5741 <write filename="result.png"/>
5742 </group>
5743 <despeckle>
5746 <emboss>
5748 radius, sigma
5750 <enhance>
5751 <equalize>
5753 <edge>
5755 radius
5757 <flip>
5758 <flop>
5760 <frame>
5762 fill, geometry, height, width, x, y, inner, outer
5764 <flatten>
5765 <get>
5767 height, width
5769 <gamma>
5770 red, green, blue
5772 <image>
5773 background, color, id, size
5775 <implode>
5776 amount
5778 <magnify>
5779 <minify>
5781 <medianfilter>
5783 radius
5785 <normalize>
5786 <oilpaint>
5788 radius
5790 <print>
5791 output
5793 <profile>
5794 [profilename]
5796 <read>
5797 <resize>
5799 blur, filter, geometry, height, width
5801 <roll>
5802 geometry, x, y
5804 <rotate>
5805 degrees
5807 <reducenoise>
5808 radius
5810 <sample>
5811 geometry, height, width
5813 <scale>
5814 geometry, height, width
5816 <sharpen>
5817 radius, sigma
5819 <shave>
5820 geometry, height, width
5822 <shear>
5823 x, y
5825 <solarize>
5826 threshold
5828 <spread>
5829 radius
5831 <stegano>
5832 image
5834 <stereo>
5835 image
5837 <swirl>
5838 degrees
5840 <texture>
5841 image
5843 <threshold>
5844 threshold
5846 <transparent>
5847 color
5849 <trim>
5850
5854 Convert converts an input file using one image format to an output file
5855 with a differing image format. In addition, various types of image pro‐
5856 cessing can be performed on the converted image during the conversion
5857 process. Convert recognizes the image formats listed in GraphicsMag‐
5858 ick(1).
5859
5862 To make a thumbnail of a JPEG image, use:
5863 gm convert -size 120x120 cockatoo.jpg -resize 120x120
5865 +profile "*" thumbnail.jpg
5866 In this example, '-size 120x120' gives a hint to the JPEG decoder that
5869 the image is going to be downscaled to 120x120, allowing it to run
5870 faster by avoiding returning full-resolution images to GraphicsMagick
5871 for the subsequent resizing operation. The ´-resize 120x120' specifies
5872 the desired dimensions of the output image. It will be scaled so its
5873 largest dimension is 120 pixels. The ´+profile "*"' removes any ICM,
5874 EXIF, IPTC, or other profiles that might be present in the input and
5875 aren't needed in the thumbnail.
5876 To convert a MIFF image of a cockatoo to a SUN raster image, use:
5878 gm convert cockatoo.miff sun:cockatoo.ras
5880 To convert a multi-page PostScript document to individual FAX pages,
5883 use:
5884 gm convert -monochrome document.ps fax:page
5886 To convert a TIFF image to a PostScript A4 page with the image in the
5889 lower left-hand corner, use:
5890 gm convert -page A4+0+0 image.tiff document.ps
5892 To convert a raw Gray image with a 128 byte header to a portable
5895 graymap, use:
5896 gm convert -depth 8 -size 768x512+128 gray:raw
5898 image.pgm
5899 In this example, "raw" is the input file. Its format is "gray" and it
5902 has the dimensions and number of header bytes specified by the -size
5903 option and the sample depth specified by the -depth option. The output
5904 file is "image.pgm". The suffix ".pgm" specifies its format.
5905 To convert a Photo CD image to a TIFF image, use:
5907 gm convert -size 1536x1024 img0009.pcd image.tiff
5909 gm convert img0009.pcd[4] image.tiff
5910 To create a visual image directory of all your JPEG images, use:
5913 gm convert 'vid:*.jpg' directory.miff
5915 To annotate an image with blue text using font 12x24 at position
5918 (100,100), use:
5919 gm convert -font helvetica -fill blue
5921 -draw "text 100,100 Cockatoo"
5922 bird.jpg bird.miff
5923 To tile a 640x480 image with a JPEG texture with bumps use:
5926 gm convert -size 640x480 tile:bumps.jpg tiled.png
5928 To surround an icon with an ornamental border to use with Mosaic(1),
5931 use:
5932 gm convert -mattecolor "#697B8F" -frame 6x6 bird.jpg
5934 icon.png
5935 To create a MNG animation from a DNA molecule sequence, use:
5938 gm convert -delay 20 dna.* dna.mng
5940
5943 Options are processed in command line order. Any option you specify on
5944 the command line remains in effect for the set of images that follows,
5945 until the set is terminated by the appearance of any option or -noop.
5946 Some options only affect the decoding of images and others only the
5947 encoding. The latter can appear after the final group of input images.
5948 For a more detailed description of each option, see Options, above.
5950 -adjoin
5953 join images into a single multi-image file
5954 -affine <matrix>
5956 drawing transform matrix
5957 -antialias
5959 remove pixel aliasing
5960 -append
5962 append a set of images
5963 -asc-cdl <spec>
5965 apply ASC CDL color transform
5966 -authenticate <string>
5968 decrypt image with this password
5969 -auto-orient
5971 orient (rotate) image so it is upright
5972 -average
5974 average a set of images
5975 -background <color>
5977 the background color
5978 -black-threshold red[,green][,blue][,opacity]
5980 pixels below the threshold become black
5981 -blue-primary <x>,<y>
5983 blue chromaticity primary point
5984 -blur <radius>{x<sigma>}
5986 blur the image with a Gaussian operator
5987 -border <width>x<height>
5989 surround the image with a border of color
5990 -bordercolor <color>
5992 the border color
5993 -box <color>
5995 set the color of the annotation bounding box
5996 -channel <type>
5998 the type of channel
5999 -charcoal <factor>
6001 simulate a charcoal drawing
6002 -chop <width>x<height>{+-}<x>{+-}<y>{%}
6004 remove pixels from the interior of an image
6005 -clip apply the clipping path, if one is present
6007 -coalesce
6009 merge a sequence of images
6010 -colorize <value>
6012 colorize the image with the pen color
6013 -colors <value>
6015 preferred number of colors in the image
6016 -colorspace <value>
6018 the type of colorspace
6019 -comment <string>
6021 annotate an image with a comment
6022 -compose <operator>
6024 the type of image composition
6025 -compress <type>
6027 the type of image compression
6028 -contrast
6030 enhance or reduce the image contrast
6031 -convolve <kernel>
6033 convolve image with the specified convolution kernel
6034 -crop <width>x<height>{+-}<x>{+-}<y>{%}
6036 preferred size and location of the cropped image
6037 -cycle <amount>
6039 displace image colormap by amount
6040 -debug <events>
6042 enable debug printout
6043 -deconstruct
6045 break down an image sequence into constituent parts
6046 -define <key>{=<value>},...
6048 add coder/decoder specific options
6049 -delay <1/100ths of a second>
6051 display the next image after pausing
6052 -density <width>x<height>
6054 horizontal and vertical resolution in pixels of the image
6055 -depth <value>
6057 depth of the image
6058 -despeckle
6060 reduce the speckles within an image
6061 -display <host:display[.screen]>
6063 specifies the X server to contact
6064 -dispose <method>
6066 GIF disposal method
6067 -dither
6069 apply Floyd/Steinberg error diffusion to the image
6070 -draw <string>
6072 annotate an image with one or more graphic primitives
6073 -edge <radius>
6075 detect edges within an image
6076 -emboss <radius>
6078 emboss an image
6079 -encoding <type>
6081 specify the text encoding
6082 -endian <type>
6084 specify endianness (MSB, LSB, or Native) of image
6085 -enhance
6087 apply a digital filter to enhance a noisy image
6088 -equalize
6090 perform histogram equalization to the image
6091 -extent <width>x<height>{+-}<x>{+-}<y>
6093 composite image on background color canvas image
6094 -fill <color>
6096 color to use when filling a graphic primitive
6097 -filter <type>
6099 use this type of filter when resizing an image
6100 -flatten
6102 flatten a sequence of images
6103 -flip create a "mirror image"
6105 -flop create a "mirror image"
6107 -font <name>
6109 use this font when annotating the image with text
6110 -format <string>
6112 output formatted image characteristics
6113 -frame <width>x<height>+<outer bevel width>+<inner bevel width>
6115 surround the image with an ornamental border
6116 -fuzz <distance>{%}
6118 colors within this Euclidean distance are considered equal
6119 -gamma <value>
6121 level of gamma correction
6122 -gaussian <radius>{x<sigma>}
6124 blur the image with a Gaussian operator
6125 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
6127 Specify dimension, offset, and resize options.
6128 -gravity <type>
6130 direction primitive gravitates to when annotating the image.
6131 -green-primary <x>,<y>
6133 green chromaticity primary point
6134 -hald-clut <clut>
6136 apply a Hald CLUT to the image
6137 -help print usage instructions
6139 -implode <factor>
6141 implode image pixels about the center
6142 -intent <type>
6144 use this type of rendering intent when managing the image color
6145 -interlace <type>
6147 the type of interlacing scheme
6148 -label <name>
6150 assign a label to an image
6151 -lat <width>x<height>{+-}<offset>{%}
6153 perform local adaptive thresholding
6154 -level <black_point>{,<gamma>}{,<white_point>}{%}
6156 adjust the level of image contrast
6157 -limit <type> <value>
6159 Disk, File, Map, Memory, Pixels, Width, Height or Threads
6160 resource limit
6161 -list <type>
6163 the type of list
6164 -log <string>
6166 Specify format for debug log
6167 -loop <iterations>
6169 add Netscape loop extension to your GIF animation
6170 -magnify
6172 magnify the image
6173 -map <filename>
6175 choose a particular set of colors from this image
6176 -mask <filename>
6178 Specify a clipping mask
6179 -matte store matte channel if the image has one
6181 -mattecolor <color>
6183 specify the color to be used with the -frame option
6184 -median <radius>
6186 apply a median filter to the image
6187 -minify <factor>
6189 minify the image
6190 -modulate brightness[,saturation[,hue]]
6192 vary the brightness, saturation, and hue of an image
6193 -monitor
6195 show progress indication
6196 -monochrome
6198 transform the image to black and white
6199 -morph <frames>
6201 morphs an image sequence
6202 -mosaic
6204 create a mosaic from an image or an image sequence
6205 -motion-blur <radius>{x<sigma>}{+angle}
6207 Simulate motion blur
6208 -negate
6210 replace every pixel with its complementary color
6211 -noise <radius|type>
6213 add or reduce noise in an image
6214 -noop NOOP (no option)
6216 -normalize
6218 transform image to span the full range of color values
6219 -opaque <color>
6221 change this color to the pen color within the image
6222 -operator channel operator rvalue[%]
6224 apply a mathematical, bitwise, or value operator to an image
6225 channel
6226 -ordered-dither <channeltype> <NxN>
6228 ordered dither the image
6229 -orient <orientation>
6231 Set the image orientation attribute
6232 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
6234 size and location of an image canvas
6235 -paint <radius>
6237 simulate an oil painting
6238 -pen <color>
6240 (This option has been replaced by the -fill option)
6241 -ping efficiently determine image characteristics
6243 -pointsize <value>
6245 pointsize of the PostScript, X11, or TrueType font
6246 -preview <type>
6248 image preview type
6249 -process <command>
6251 process a sequence of images using a process module
6252 -profile <filename>
6254 add ICM, IPTC, or generic profile to image
6255 -quality <value>
6257 JPEG/MIFF/PNG/TIFF compression level
6258 -raise <width>x<height>
6260 lighten or darken image edges
6261 -random-threshold <channeltype> <LOWxHIGH>
6263 random threshold the image
6264 -recolor <matrix>
6266 apply a color translation matrix to image channels
6267 -red-primary <x>,<y>
6269 red chromaticity primary point
6270 -region <width>x<height>{+-}<x>{+-}<y>
6272 apply options to a portion of the image
6273 -render
6275 render vector operations
6276 -repage <width>x<height>+xoff+yoff[!]
6278 Adjust image page offsets
6279 -resample <horizontal>x<vertical>
6281 Resample image to specified horizontal and vertical resolution
6282 -resize <width>x<height>{%}{@}{!}{<}{>}
6284 resize an image
6285 -roll {+-}<x>{+-}<y>
6287 roll an image vertically or horizontally
6288 -rotate <degrees>{<}{>}
6290 rotate the image
6291 -sample <geometry>
6293 scale image using pixel sampling
6294 -sampling-factor <horizontal_factor>x<vertical_factor>
6296 chroma subsampling factors
6297 -scale <geometry>
6299 scale the image.
6300 -scene <value>
6302 set scene number
6303 -set <attribute> <value>
6305 set an image attribute
6306 +set <attribute>
6308 unset an image attribute
6309 -segment <cluster threshold>x<smoothing threshold>
6311 segment an image
6312 -shade <azimuth>x<elevation>
6314 shade the image using a distant light source
6315 -sharpen <radius>{x<sigma>}
6317 sharpen the image
6318 -shave <width>x<height>{%}
6320 shave pixels from the image edges
6321 -shear <x degrees>x<y degrees>
6323 shear the image along the X or Y axis
6324 -size <width>x<height>{+offset}
6326 width and height of the image
6327 -solarize <factor>
6329 negate all pixels above the threshold level
6330 -spread <amount>
6332 displace image pixels by a random amount
6333 -strip remove all profiles and text attributes from the image
6335 -stroke <color>
6337 color to use when stroking a graphic primitive
6338 -strokewidth <value>
6340 set the stroke width
6341 -swirl <degrees>
6343 swirl image pixels about the center
6344 -texture <filename>
6346 name of texture to tile onto the image background
6347 -threshold <value>{%}
6349 threshold the image
6350 -thumbnail <width>x<height>{%}{@}{!}{<}{>}
6352 resize an image (quickly)
6353 -tile <filename>
6355 tile image when filling a graphic primitive
6356 -transform
6358 transform the image
6359 -transparent <color>
6361 make this color transparent within the image
6362 -treedepth <value>
6364 tree depth for the color reduction algorithm
6365 -trim trim an image
6367 -type <type>
6369 the image type
6370 -units <type>
6372 the units of image resolution
6373 -unsharp <radius>{x<sigma>}{+<amount>}{+<threshold>}
6375 sharpen the image with an unsharp mask operator
6376 -use-pixmap
6378 use the pixmap
6379 -verbose
6381 print detailed information about the image
6382 -version
6384 print GraphicsMagick version string
6385 -view <string>
6387 FlashPix viewing parameters
6388 -virtual-pixel <method>
6390 specify contents of "virtual pixels"
6391 -wave <amplitude>x<wavelength>
6393 alter an image along a sine wave
6394 -white-point <x>,<y>
6396 chromaticity white point
6397 -white-threshold red[,green][,blue][,opacity]
6399 pixels above the threshold become white
6400 -write <filename>
6402 write an intermediate image [convert, composite]
6403 For a more detailed description of each option, see Options,
6405 above.
6406
6408 Display is a machine architecture independent image processing and dis‐
6409 play program. It can display an image on any workstation screen running
6410 an X server. Display can read and write many of the more popular image
6411 formats (e.g. JPEG, TIFF, PNM, Photo CD, etc.).
6412 With display, you can perform these functions on an image:
6414 o load an image from a file
6416 o display the next image
6417 o display the former image
6418 o display a sequence of images as a slide show
6419 o write the image to a file
6420 o print the image to a PostScript printer
6421 o delete the image file
6422 o create a Visual Image Directory
6423 o select the image to display by its thumbnail rather than
6424 name
6425 o undo last image transformation
6426 o copy a region of the image
6427 o paste a region to the image
6428 o restore the image to its original size
6429 o refresh the image
6430 o half the image size
6431 o double the image size
6432 o resize the image
6433 o crop the image
6434 o cut the image
6435 o flop image in the horizontal direction
6436 o flip image in the vertical direction
6437 o rotate the image 90 degrees clockwise
6438 o rotate the image 90 degrees counter-clockwise
6439 o rotate the image
6440 o shear the image
6441 o roll the image
6442 o trim the image edges
6443 o invert the colors of the image
6444 o vary the color brightness
6445 o vary the color saturation
6446 o vary the image hue
6447 o gamma correct the image
6448 o sharpen the image contrast
6449 o dull the image contrast
6450 o perform histogram equalization on the image
6451 o perform histogram normalization on the image
6452 o negate the image colors
6453 o convert the image to grayscale
6454 o set the maximum number of unique colors in the image
6455 o reduce the speckles within an image
6456 o eliminate peak noise from an image
6457 o detect edges within the image
6458 o emboss an image
6459 o segment the image by color
6460 o simulate an oil painting
6461 o simulate a charcoal drawing
6462 o annotate the image with text
6463 o draw on the image
6464 o edit an image pixel color
6465 o edit the image matte information
6466 o composite an image with another
6467 o add a border to the image
6468 o surround image with an ornamental border
6469 o apply image processing techniques to a region of interest
6470 o display information about the image
6471 o zoom a portion of the image
6472 o show a histogram of the image
6473 o display image to background of a window
6474 o set user preferences
6475 o display information about this program
6476 o discard all images and exit program
6477 o change the level of magnification
6478 o display images specified by a World Wide Web (WWW) uniform
6479 resource locator (URL)
6480
6483 To scale an image of a cockatoo to exactly 640 pixels in width and 480
6484 pixels in height and position the window at location (200,200), use:
6485 gm display -geometry 640x480+200+200! cockatoo.miff
6487 To display an image of a cockatoo without a border centered on a back‐
6490 drop, use:
6491 gm display +borderwidth -backdrop cockatoo.miff
6493 To tile a slate texture onto the root window, use:
6496 gm display -size 1280x1024 -window root slate.png
6498 To display a visual image directory of all your JPEG images, use:
6501 gm display 'vid:*.jpg'
6503 To display a MAP image that is 640 pixels in width and 480 pixels in
6506 height with 256 colors, use:
6507 gm display -size 640x480+256 cockatoo.map
6509 To display an image of a cockatoo specified with a World Wide Web (WWW)
6512 uniform resource locator (URL), use:
6513 gm display ftp://wizards.dupont.com/images/cockatoo.jpg
6515 To display histogram of an image, use:
6518 gm gm convert file.jpg HISTOGRAM:- | gm display -
6520
6523 Options are processed in command line order. Any option you specify on
6524 the command line remains in effect until it is explicitly changed by
6525 specifying the option again with a different effect. For example to
6526 display three images, the first with 32 colors, the second with an
6527 unlimited number of colors, and the third with only 16 colors, use:
6528 gm display -colors 32 cockatoo.miff -noop duck.miff
6530 -colors 16 macaw.miff
6531 Display options can appear on the command line or in your X resources
6534 file. See X(1). Options on the command line supersede values specified
6535 in your X resources file.
6536 For a more detailed description of each option, see Options, above.
6538 -authenticate <string>
6541 decrypt image with this password
6542 -backdrop
6544 display the image centered on a backdrop.
6545 -background <color>
6547 the background color
6548 -border <width>x<height>
6550 surround the image with a border of color
6551 -bordercolor <color>
6553 the border color
6554 -borderwidth <geometry>
6556 the border width
6557 -colormap <type>
6559 define the colormap type
6560 -colors <value>
6562 preferred number of colors in the image
6563 -colorspace <value>
6565 the type of colorspace
6566 -comment <string>
6568 annotate an image with a comment
6569 -compress <type>
6571 the type of image compression
6572 -contrast
6574 enhance or reduce the image contrast
6575 -crop <width>x<height>{+-}<x>{+-}<y>{%}
6577 preferred size and location of the cropped image
6578 -debug <events>
6580 enable debug printout
6581 -define <key>{=<value>},...
6583 add coder/decoder specific options
6584 -delay <1/100ths of a second>
6586 display the next image after pausing
6587 -density <width>x<height>
6589 horizontal and vertical resolution in pixels of the image
6590 -depth <value>
6592 depth of the image
6593 -despeckle
6595 reduce the speckles within an image
6596 -display <host:display[.screen]>
6598 specifies the X server to contact
6599 -dispose <method>
6601 GIF disposal method
6602 -dither
6604 apply Floyd/Steinberg error diffusion to the image
6605 -edge <radius>
6607 detect edges within an image
6608 -endian <type>
6610 specify endianness (MSB, LSB, or Native) of image
6611 -enhance
6613 apply a digital filter to enhance a noisy image
6614 -filter <type>
6616 use this type of filter when resizing an image
6617 -flip create a "mirror image"
6619 -flop create a "mirror image"
6621 -font <name>
6623 use this font when annotating the image with text
6624 -foreground <color>
6626 define the foreground color
6627 -frame <width>x<height>+<outer bevel width>+<inner bevel width>
6629 surround the image with an ornamental border
6630 -gamma <value>
6632 level of gamma correction
6633 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
6635 Specify dimension, offset, and resize options.
6636 -help print usage instructions
6638 -iconGeometry <geometry>
6640 specify the icon geometry
6641 -iconic
6643 iconic animation
6644 -immutable
6646 make image immutable
6647 -interlace <type>
6649 the type of interlacing scheme
6650 -label <name>
6652 assign a label to an image
6653 -limit <type> <value>
6655 Disk, File, Map, Memory, Pixels, Width, Height or Threads
6656 resource limit
6657 -log <string>
6659 Specify format for debug log
6660 -magnify <factor>
6662 magnify the image
6663 -map <type>
6665 display image using this type.
6666 -matte store matte channel if the image has one
6668 -mattecolor <color>
6670 specify the color to be used with the -frame option
6671 -monitor
6673 show progress indication
6674 -monochrome
6676 transform the image to black and white
6677 -name name an image
6679 -negate
6681 replace every pixel with its complementary color
6682 -noop NOOP (no option)
6684 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
6686 size and location of an image canvas
6687 +progress
6689 disable progress monitor and busy cursor
6690 -quality <value>
6692 JPEG/MIFF/PNG/TIFF compression level
6693 -raise <width>x<height>
6695 lighten or darken image edges
6696 -remote
6698 perform a X11 remote operation
6699 -roll {+-}<x>{+-}<y>
6701 roll an image vertically or horizontally
6702 -rotate <degrees>{<}{>}
6704 rotate the image
6705 -sample <geometry>
6707 scale image using pixel sampling
6708 -sampling-factor <horizontal_factor>x<vertical_factor>
6710 chroma subsampling factors
6711 -scenes <value-value>
6713 range of image scene numbers to read
6714 -set <attribute> <value>
6716 set an image attribute
6717 +set <attribute>
6719 unset an image attribute
6720 -segment <cluster threshold>x<smoothing threshold>
6722 segment an image
6723 -shared-memory
6725 use shared memory
6726 -sharpen <radius>{x<sigma>}
6728 sharpen the image
6729 -size <width>x<height>{+offset}
6731 width and height of the image
6732 -text-font <name>
6734 font for writing fixed-width text
6735 -texture <filename>
6737 name of texture to tile onto the image background
6738 -title <string>
6740 assign title to displayed image [animate, display, montage]
6741 -treedepth <value>
6743 tree depth for the color reduction algorithm
6744 -trim trim an image
6746 -type <type>
6748 the image type
6749 -update <seconds>
6751 detect when image file is modified and redisplay.
6752 -use-pixmap
6754 use the pixmap
6755 -verbose
6757 print detailed information about the image
6758 -version
6760 print GraphicsMagick version string
6761 -visual <type>
6763 animate images using this X visual type
6764 -window <id>
6766 make image the background of a window
6767 -window-group
6769 specify the window group
6770 -write <filename>
6772 write the image to a file [display]
6773 For a more detailed description of each option, see Options,
6775 above.
6776
6779 The effects of each button press is described below. Three buttons are
6780 required. If you have a two button mouse, button 1 and 3 are returned.
6781 Press ALT and button 3 to simulate button 2.
6782 1 Press this button to map or unmap the Command widget . See the
6784 next section for more information about the Command widget.
6785 2 Press and drag to define a region of the image to magnify.
6787 3 Press and drag to choose from a select set of display(1) com‐
6789 mands. This button behaves differently if the image being dis‐
6790 played is a visual image directory. Choose a particular tile of
6791 the directory and press this button and drag to select a command
6792 from a pop-up menu. Choose from these menu items:
6793 Open
6795 Next
6796 Former
6797 Delete
6798 Update
6799 If you choose Open, the image represented by the tile is dis‐
6802 played. To return to the visual image directory, choose Next
6803 from the Command widget (refer to Command Widget). Next and
6804 Former moves to the next or former image respectively. Choose
6805 Delete to delete a particular image tile. Finally, choose Update
6806 to synchronize all the image tiles with their respective images.
6807 See montage and miff for more details.
6808
6810 The Command widget lists a number of sub-menus and commands. They are
6811 File
6813 Open...
6815 Next
6816 Former
6817 Select...
6818 Save...
6819 Print...
6820 Delete...
6821 Canvas...
6822 Visual Directory...
6823 Quit
6824 Edit
6828 Undo
6830 Redo
6831 Cut
6832 Copy
6833 Paste
6834 View
6838 Half Size
6840 Original Size
6841 Double Size
6842 Resize...
6843 Apply
6844 Refresh
6845 Restore
6846 Transform
6850 Crop
6852 Chop
6853 Flop
6854 Flip
6855 Rotate Right
6856 Rotate Left
6857 Rotate...
6858 Shear...
6859 Roll...
6860 Trim Edges
6861 Enhance
6865 Hue...
6867 Saturation...
6868 Brightness...
6869 Gamma...
6870 Spiff...
6871 Dull
6872 Equalize
6873 Normalize
6874 Negate
6875 GRAYscale
6876 Quantize...
6877 Effects
6881 Despeckle
6883 Emboss
6884 Reduce Noise
6885 Add Noise
6886 Sharpen...
6887 Blur...
6888 Threshold...
6889 Edge Detect...
6890 Spread...
6891 Shade...
6892 Raise...
6893 Segment...
6894 F/X
6898 Solarize...
6900 Swirl...
6901 Implode...
6902 Wave...
6903 Oil Paint...
6904 Charcoal Draw...
6905 Image Edit
6909 Annotate...
6911 Draw...
6912 Color...
6913 Matte...
6914 Composite...
6915 Add Border...
6916 Add Frame...
6917 Comment...
6918 Launch...
6919 Region of Interest...
6920 Miscellany
6924 Image Info
6926 Zoom Image
6927 Show Preview...
6928 Show Histogram
6929 Show Matte
6930 Background...
6931 Slide Show
6932 Preferences...
6933 Help
6937 Overview
6939 Browse Documentation
6940 About Display
6941 Menu items with a indented triangle have a sub-menu. They are repre‐
6945 sented above as the indented items. To access a sub-menu item, move the
6946 pointer to the appropriate menu and press button 1 and drag. When you
6947 find the desired sub-menu item, release the button and the command is
6948 executed. Move the pointer away from the sub-menu if you decide not to
6949 execute a particular command.
6950
6952 Accelerators are one or two key presses that effect a particular com‐
6953 mand. The keyboard accelerators that display understands is:
6954 Ctl+O Press to load an image from a file.
6956 space Press to display the next image.
6957 If the image is a multi-paged document such as a PostScript document,
6960 you can skip ahead several pages by preceding this command with a num‐
6961 ber. For example to display the fourth page beyond the current page,
6962 press 4space.
6963 backspace Press to display the former image.
6965 If the image is a multi-paged document such as a PostScript document,
6968 you can skip behind several pages by preceding this command with a num‐
6969 ber. For example to display the fourth page preceding the current
6970 page, press 4n.
6971 Ctl-S Press to save the image to a file.
6973 Ctl-P Press to print the image to a
6974 PostScript printer.
6975 Ctl-D Press to delete an image file.
6976 Ctl-N Press to create a blank canvas.
6977 Ctl-Q Press to discard all images and exit program.
6978 Ctl+Z Press to undo last image transformation.
6979 Ctl+R Press to redo last image transformation.
6980 Ctl-X Press to cut a region of
6981 the image.
6982 Ctl-C Press to copy a region of
6983 the image.
6984 Ctl-V Press to paste a region to
6985 the image.
6986 < Press to halve the image size.
6987 . Press to return to the original image size.
6988 > Press to double the image size.
6989 % Press to resize the image to a width and height
6990 you specify.
6991 Cmd-A Press to make any image transformations
6992 permanent.
6993 By default, any image size transformations are
6994 applied to the original image to create the
6995 image displayed on the X server. However, the
6996 transformations are not permanent (i.e. the
6997 original image does not change size only the
6998 X image does). For example, if you press ">"
6999 the X image will appear to double in size, but
7000 the original image will in fact remain the same
7001 size. To force the original image to double in
7002 size, press ">" followed by "Cmd-A".
7003 @ Press to refresh the image window.
7004 C Press to crop the image.
7005 [ Press to chop the image.
7006 H Press to flop image in the horizontal direction.
7007 V Press to flip image in the vertical direction.
7008 / Press to rotate the image 90 degrees clockwise.
7009 \ Press to rotate the image 90 degrees
7010 counter-clockwise.
7011 * Press to rotate the image
7012 the number of degrees you specify.
7013 S Press to shear the image the number of degrees
7014 you specify.
7015 R Press to roll the image.
7016 T Press to trim the image edges.
7017 Shft-H Press to vary the color hue.
7018 Shft-S Press to vary the color saturation.
7019 Shft-L Press to vary the image brightness.
7020 Shft-G Press to gamma correct the image.
7021 Shft-C Press to spiff up the image contrast.
7022 Shft-Z Press to dull the image contrast.
7023 = Press to perform histogram equalization on
7024 the image.
7025 Shft-N Press to perform histogram normalization on
7026 the image.
7027 Shft-~ Press to negate the colors of the image.
7028 . Press to convert the image colors to gray.
7029 Shft-# Press to set the maximum number of unique
7030 colors in the image.
7031 F2 Press to reduce the speckles in an image.
7032 F2 Press to emboss an image.
7033 F4 Press to eliminate peak noise from an image.
7034 F5 Press to add noise to an image.
7035 F6 Press to sharpen an image.
7036 F7 Press to blur image an image.
7037 F8 Press to threshold the image.
7038 F9 Press to detect edges within an image.
7039 F10 Press to displace pixels by a random amount.
7040 F11 Press to shade the image using a distant light
7041 source.
7042 F12 Press to lighten or darken image edges to
7043 create a 3-D effect.
7044 F13 Press to segment the image by color.
7045 Meta-S Press to swirl image pixels about the center.
7046 Meta-I Press to implode image pixels about the center.
7047 Meta-W Press to alter an image along a sine wave.
7048 Meta-P Press to simulate an oil painting.
7049 Meta-C Press to simulate a charcoal drawing.
7050 Alt-X Press to composite the image
7051 with another.
7052 Alt-A Press to annotate the image with text.
7053 Alt-D Press to draw a line on the image.
7054 Alt-P Press to edit an image pixel color.
7055 Alt-M Press to edit the image matte information.
7056 Alt-X Press to composite the image with another.
7057 Alt-A Press to add a border to the image.
7058 Alt-F Press to add a ornamental frame to the image.
7059 Alt-Shft-! Press to add an image comment.
7060 Ctl-A Press to apply image processing techniques to a
7061 region of interest.
7062 Shft-? Press to display information about the image.
7063 Shft-+ Press to map the zoom image window.
7064 Shft-P Press to preview an image enhancement, effect,
7065 or f/x.
7066 F1 Press to display helpful information about
7067 the "display" utility.
7068 Find Press to browse documentation about
7069 GraphicsMagick.
7070 1-9 Press to change the level of magnification.
7071 Use the arrow keys to move the image one pixel up, down, left, or right
7074 within the magnify window. Be sure to first map the magnify window by
7075 pressing button 2.
7076 Press ALT and one of the arrow keys to trim off one pixel from any side
7078 of the image.
7079
7081 Display options can appear on the command line or in your X resource
7082 file. Options on the command line supersede values specified in your X
7083 resource file. See X(1) for more information on X resources.
7084 Most display options have a corresponding X resource. In addition, dis‐
7086 play uses the following X resources:
7087 background (class Background)
7089 Specifies the preferred color to use for the Image window back‐
7090 ground. The default is #ccc.
7091 borderColor (class BorderColor)
7093 Specifies the preferred color to use for the Image window bor‐
7094 der. The default is #ccc.
7095 borderWidth (class BorderWidth)
7097 Specifies the width in pixels of the image window border. The
7098 default is 2.
7099 browseCommand (class browseCommand)
7101 Specifies the name of the preferred browser when displaying
7102 GraphicsMagick documentation. The default is netscape %s.
7103 confirmExit (class ConfirmExit)
7105 Display pops up a dialog box to confirm exiting the program
7106 when exiting the program. Set this resource to False to exit
7107 without a confirmation.
7108 displayGamma (class DisplayGamma)
7110 Specifies the gamma of the X server. You can apply separate
7111 gamma values to the red, green, and blue channels of the image
7112 with a gamma value list delineated with slashes (i.e.
7113 1.7/2.3/1.2). The default is 2.2.
7114 displayWarnings (class DisplayWarnings)
7116 Display pops up a dialog box whenever a warning message occurs.
7117 Set this resource to False to ignore warning messages.
7118 font (class FontList)
7120 Specifies the name of the preferred font to use in normal for‐
7121 matted text. The default is 14 point Helvetica.
7122 font[1-9] (class Font[1-9])
7124 Specifies the name of the preferred font to use when annotating
7125 the image window with text. The default fonts are fixed, vari‐
7126 able, 5x8, 6x10, 7x13bold, 8x13bold, 9x15bold, 10x20, and 12x24.
7127 foreground (class Foreground)
7129 Specifies the preferred color to use for text within the image
7130 window. The default is black.
7131 gammaCorrect (class gammaCorrect)
7133 This resource, if true, will lighten or darken an image of
7134 known gamma to match the gamma of the display (see resource dis‐
7135 playGamma). The default is True.
7136 geometry (class Geometry)
7138 Specifies the preferred size and position of the image window.
7139 It is not necessarily obeyed by all window managers.
7140 Offsets, if present, are handled in X(1) style. A negative x
7142 offset is measured from the right edge of the screen to the
7143 right edge of the icon, and a negative y offset is measured from
7144 the bottom edge of the screen to the bottom edge of the icon.
7145 iconGeometry (class IconGeometry)
7147 Specifies the preferred size and position of the application
7148 when iconified. It is not necessarily obeyed by all window man‐
7149 agers.
7150 Offsets, if present, are handled in the same manner as in class
7152 Geometry.
7153 iconic (class Iconic)
7155 This resource indicates that you would prefer that the applica‐
7156 tion's windows initially not be visible as if the windows had be
7157 immediately iconified by you. Window managers may choose not to
7158 honor the application's request.
7159 magnify (class Magnify)
7161 specifies an integral factor by which the image should be
7162 enlarged. The default is 3. This value only affects the magni‐
7163 fication window which is invoked with button number 3 after the
7164 image is displayed.
7165 matteColor (class MatteColor)
7167 Specify the color of windows. It is used for the backgrounds of
7168 windows, menus, and notices. A 3D effect is achieved by using
7169 highlight and shadow colors derived from this color. Default
7170 value: #697B8F.
7171 name (class Name)
7173 This resource specifies the name under which resources for the
7174 application should be found. This resource is useful in shell
7175 aliases to distinguish between invocations of an application,
7176 without resorting to creating links to alter the executable file
7177 name. The default is the application name.
7178 pen[1-9] (class Pen[1-9])
7180 Specifies the color of the preferred font to use when annotat‐
7181 ing the image window with text. The default colors are black,
7182 blue, green, cyan, gray, red, magenta, yellow, and white.
7183 printCommand (class PrintCommand)
7185 This command is executed whenever Print is issued. In general,
7186 it is the command to print PostScript to your printer. Default
7187 value: lp -c -s %i.
7188 sharedMemory (class SharedMemory)
7190 This resource specifies whether display should attempt use
7191 shared memory for pixmaps. GraphicsMagick must be compiled with
7192 shared memory support, and the display must support the MIT-SHM
7193 extension. Otherwise, this resource is ignored. The default is
7194 True.
7195 textFont (class textFont)
7197 Specifies the name of the preferred font to use in fixed (type‐
7198 writer style) formatted text. The default is 14 point Courier.
7199 title (class Title)
7201 This resource specifies the title to be used for the image win‐
7202 dow. This information is sometimes used by a window manager to
7203 provide a header identifying the window. The default is the
7204 image file name.
7205 undoCache (class UndoCache)
7207 Specifies, in mega-bytes, the amount of memory in the undo edit
7208 cache. Each time you modify the image it is saved in the undo
7209 edit cache as long as memory is available. You can subsequently
7210 undo one or more of these transformations. The default is 16
7211 Megabytes.
7212 usePixmap (class UsePixmap)
7214 Images are maintained as a XImage by default. Set this resource
7215 to True to utilize a server Pixmap instead. This option is use‐
7216 ful if your image exceeds the dimensions of your server screen
7217 and you intend to pan the image. Panning is much faster with
7218 Pixmaps than with a XImage. Pixmaps are considered a precious
7219 resource, use them with discretion.
7220 To set the geometry of the Magnify or Pan or window, use the
7222 geometry resource. For example, to set the Pan window geometry
7223 to 256x256, use:
7224 gm display.pan.geometry: 256x256
7226
7229 To select an image to display, choose Open of the File sub-menu from
7230 the Command widget. A file browser is displayed. To choose a particu‐
7231 lar image file, move the pointer to the filename and press any button.
7232 The filename is copied to the text window. Next, press Open or press
7233 the RETURN key. Alternatively, you can type the image file name
7234 directly into the text window. To descend directories, choose a direc‐
7235 tory name and press the button twice quickly. A scrollbar allows a
7236 large list of filenames to be moved through the viewing area if it
7237 exceeds the size of the list area.
7238 You can trim the list of file names by using shell globbing characters.
7240 For example, type *.jpg to list only files that end with .jpg.
7241 To select your image from the X server screen instead of from a file,
7243 Choose Grab of the Open widget.
7244
7246 To create a Visual Image Directory, choose Visual Directory of the File
7247 sub-menu from the Command widget . A file browser is displayed. To cre‐
7248 ate a Visual Image Directory from all the images in the current direc‐
7249 tory, press Directory or press the RETURN key. Alternatively, you can
7250 select a set of image names by using shell globbing characters. For
7251 example, type *.jpg to include only files that end with .jpg. To
7252 descend directories, choose a directory name and press the button twice
7253 quickly. A scrollbar allows a large list of filenames to be moved
7254 through the viewing area if it exceeds the size of the list area.
7255 After you select a set of files, they are turned into thumbnails and
7257 tiled onto a single image. Now move the pointer to a particular thumb‐
7258 nail and press button 3 and drag. Finally, select Open. The image rep‐
7259 resented by the thumbnail is displayed at its full size. Choose Next
7260 from the File sub-menu of the Command widget to return to the Visual
7261 Image Directory.
7262
7264 Note that cut information for image window is not retained for col‐
7265 ormapped X server visuals (e.g. StaticColor, StaticColor, GRAYScale,
7266 PseudoColor). Correct cutting behavior may require a TrueColor or
7267 DirectColor visual or a Standard Colormap.
7268 To begin, press choose Cut of the Edit sub-menu from the Command wid‐
7270 get. Alternatively, press F3 in the image window.
7271 A small window appears showing the location of the cursor in the image
7273 window. You are now in cut mode. In cut mode, the Command widget has
7274 these options:
7275 Help
7277 Dismiss
7278 To define a cut region, press button 1 and drag. The cut region is
7281 defined by a highlighted rectangle that expands or contracts as it fol‐
7282 lows the pointer. Once you are satisfied with the cut region, release
7283 the button. You are now in rectify mode. In rectify mode, the Command
7284 widget has these options:
7285 Cut
7287 Help
7288 Dismiss
7289 You can make adjustments by moving the pointer to one of the cut rec‐
7292 tangle corners, pressing a button, and dragging. Finally, press Cut to
7293 commit your copy region. To exit without cutting the image, press Dis‐
7294 miss.
7295
7297 To begin, press choose Copy of the Edit sub-menu from the Command wid‐
7298 get. Alternatively, press F4 in the image window.
7299 A small window appears showing the location of the cursor in the image
7301 window. You are now in copy mode. In copy mode, the Command widget has
7302 these options:
7303 Help
7305 Dismiss
7306 To define a copy region, press button 1 and drag. The copy region is
7309 defined by a highlighted rectangle that expands or contracts as it fol‐
7310 lows the pointer. Once you are satisfied with the copy region, release
7311 the button. You are now in rectify mode. In rectify mode, the Command
7312 widget has these options:
7313 Copy
7315 Help
7316 Dismiss
7317 You can make adjustments by moving the pointer to one of the copy rec‐
7320 tangle corners, pressing a button, and dragging. Finally, press Copy to
7321 commit your copy region. To exit without copying the image, press Dis‐
7322 miss.
7323
7325 To begin, press choose Paste of the Edit sub-menu from the Command wid‐
7326 get. Alternatively, press F5 in the image window.
7327 A small window appears showing the location of the cursor in the image
7329 window. You are now in Paste mode. To exit immediately, press Dismiss.
7330 In Paste mode, the Command widget has these options:
7331 Operators
7333 over
7335 in
7336 out
7337 atop
7338 xor
7339 plus
7340 minus
7341 add
7342 subtract
7343 difference
7344 multiply
7345 bumpmap
7346 replace
7347 Help
7349 Dismiss
7350 Choose a composite operation from the Operators sub-menu of the Command
7353 widget. How each operator behaves is described below. image window is
7354 the image currently displayed on your X server and image is the image
7355 obtained with the File Browser widget.
7356 over The result is the union of the two image shapes, with image
7358 obscuring image window in the region of overlap.
7359 in The result is simply image cut by the shape of image window.
7361 None of the image data of image window is in the result.
7362 out The resulting image is image with the shape of image window cut
7364 out.
7365 atop The result is the same shape as image window, with image
7367 obscuring image window where the image shapes overlap. Note this
7368 differs from over because the portion of image outside image
7369 window's shape does not appear in the result.
7370 xor The result is the image data from both image and image window
7372 that is outside the overlap region. The overlap region is blank.
7373 plus The result is just the sum of the image data. Output values are
7375 cropped to the maximum value (no overflow). This operation is
7376 independent of the matte channels.
7377 minus The result of image - image window, with underflow cropped to
7379 zero. The matte channel is ignored (set to opaque, full cover‐
7380 age).
7381 add The result of image + image window, with overflow wrapping
7383 around (mod MaxRGB+1).
7384 subtract
7386 The result of image - image window, with underflow wrapping
7387 around (mod MaxRGB+1). The add and subtract operators can be
7388 used to perform reversible transformations.
7389 difference
7391 The result of abs(image - image window). This is useful for
7392 comparing two very similar images.
7393 multiply
7395 The result of image * image window. This is useful for the cre‐
7396 ation of drop-shadows.
7397 bumpmap
7399 The result of image window shaded by window.
7400 replace
7402 The resulting image is image window replaced with image. Here
7403 the matte information is ignored.
7404 The image compositor requires a matte, or alpha channel in the
7406 image for some operations. This extra channel usually defines a
7407 mask which represents a sort of a cookie-cutter for the image.
7408 This is the case when matte is 255 (full coverage) for pixels
7409 inside the shape, zero outside, and between zero and 255 on the
7410 boundary. If image does not have a matte channel, it is initial‐
7411 ized with 0 for any pixel matching in color to pixel location
7412 (0,0), otherwise 255. See Matte Editing for a method of defining
7413 a matte channel.
7414 Note that matte information for image window is not retained for
7416 colormapped X server visuals (e.g. StaticColor, StaticColor,
7417 GrayScale, PseudoColor). Correct compositing behavior may
7418 require a TrueColor or DirectColor visual or a Standard Col‐
7419 ormap.
7420 Choosing a composite operator is optional. The default operator
7422 is replace. However, you must choose a location to composite
7423 your image and press button 1. Press and hold the button before
7424 releasing and an outline of the image will appear to help you
7425 identify your location.
7426 The actual colors of the pasted image is saved. However, the
7428 color that appears in image window may be different. For exam‐
7429 ple, on a monochrome screen image window will appear black or
7430 white even though your pasted image may have many colors. If the
7431 image is saved to a file it is written with the correct colors.
7432 To assure the correct colors are saved in the final image, any
7433 PseudoClass image is promoted to DirectClass. To force a Pseu‐
7434 doClass image to remain PseudoClass, use -colors.
7435
7437 To begin, press choose Crop of the Transform submenu from the Command
7438 widget. Alternatively, press C in the image window.
7439 A small window appears showing the location of the cursor in the image
7441 window. You are now in crop mode. In crop mode, the Command widget has
7442 these options:
7443 Help
7445 Dismiss
7446 To define a cropping region, press button 1 and drag. The cropping
7449 region is defined by a highlighted rectangle that expands or contracts
7450 as it follows the pointer. Once you are satisfied with the cropping
7451 region, release the button. You are now in rectify mode. In rectify
7452 mode, the Command widget has these options:
7453 Crop
7455 Help
7456 Dismiss
7457 You can make adjustments by moving the pointer to one of the cropping
7460 rectangle corners, pressing a button, and dragging. Finally, press Crop
7461 to commit your cropping region. To exit without cropping the image,
7462 press Dismiss.
7463
7465 An image is chopped interactively. There is no command line argument to
7466 chop an image. To begin, choose Chop of the Transform sub-menu from the
7467 Command widget. Alternatively, press [ in the Image window.
7468 You are now in Chop mode. To exit immediately, press Dismiss. In Chop
7470 mode, the Command widget has these options:
7471 Direction
7473 horizontal
7475 vertical
7476 Help
7478 Dismiss
7479 If the you choose the horizontal direction (this is the default), the
7482 area of the image between the two horizontal endpoints of the chop line
7483 is removed. Otherwise, the area of the image between the two vertical
7484 endpoints of the chop line is removed.
7485 Select a location within the image window to begin your chop, press and
7487 hold any button. Next, move the pointer to another location in the
7488 image. As you move a line will connect the initial location and the
7489 pointer. When you release the button, the area within the image to chop
7490 is determined by which direction you choose from the Command widget.
7491 To cancel the image chopping, move the pointer back to the starting
7493 point of the line and release the button.
7494
7496 Press the / key to rotate the image 90 degrees or \ to rotate -90
7497 degrees. To interactively choose the degree of rotation, choose
7498 Rotate... of the Transform submenu from the Command Widget. Alterna‐
7499 tively, press * in the image window.
7500 A small horizontal line is drawn next to the pointer. You are now in
7502 rotate mode. To exit immediately, press Dismiss. In rotate mode, the
7503 Command widget has these options:
7504 Pixel Color
7506 black
7508 blue
7509 cyan
7510 green
7511 gray
7512 red
7513 magenta
7514 yellow
7515 white
7516 Browser...
7517 Direction
7519 horizontal
7521 vertical
7522 Help
7524 Dismiss
7525 Choose a background color from the Pixel Color sub-menu. Additional
7528 background colors can be specified with the color browser. You can
7529 change the menu colors by setting the X resources pen1 through pen9.
7530 If you choose the color browser and press Grab, you can select the
7532 background color by moving the pointer to the desired color on the
7533 screen and press any button.
7534 Choose a point in the image window and press this button and hold.
7536 Next, move the pointer to another location in the image. As you move a
7537 line connects the initial location and the pointer. When you release
7538 the button, the degree of image rotation is determined by the slope of
7539 the line you just drew. The slope is relative to the direction you
7540 choose from the Direction sub-menu of the Command widget.
7541 To cancel the image rotation, move the pointer back to the starting
7543 point of the line and release the button.
7544
7546 An image is annotated interactively. There is no command line argument
7547 to annotate an image. To begin, choose Annotate of the Image Edit sub-
7548 menu from the Command widget. Alternatively, press a in the image win‐
7549 dow.
7550 A small window appears showing the location of the cursor in the image
7552 window. You are now in annotate mode. To exit immediately, press Dis‐
7553 miss. In annotate mode, the Command widget has these options:
7554 Font Name
7557 fixed
7560 variable
7562 5x8
7564 6x10
7566 7x13bold
7568 8x13bold
7570 9x15bold
7572 10x20
7574 12x24
7576 Browser...
7578 Font Color
7581 black
7584 blue
7586 cyan
7588 green
7590 gray
7592 red
7594 magenta
7596 yellow
7598 white
7600 transparent
7602 Browser...
7604 Box Color
7607 black
7610 blue
7612 cyan
7614 green
7616 gray
7618 red
7620 magenta
7622 yellow
7624 white
7626 transparent
7628 Browser...
7630 Rotate Text
7633 -90
7636 -45
7638 -30
7640 0
7642 30
7644 45
7646 90
7648 180
7650 Dialog...
7652 Help
7655 Dismiss
7657 Choose a font name from the Font Name sub-menu. Additional font names
7660 can be specified with the font browser. You can change the menu names
7661 by setting the X resources font1 through font9.
7662 Choose a font color from the Font Color sub-menu. Additional font col‐
7664 ors can be specified with the color browser. You can change the menu
7665 colors by setting the X resources pen1 through pen9.
7666 If you select the color browser and press Grab, you can choose the font
7668 color by moving the pointer to the desired color on the screen and
7669 press any button.
7670 If you choose to rotate the text, choose Rotate Text from the menu and
7672 select an angle. Typically you will only want to rotate one line of
7673 text at a time. Depending on the angle you choose, subsequent lines may
7674 end up overwriting each other.
7675 Choosing a font and its color is optional. The default font is fixed
7677 and the default color is black. However, you must choose a location to
7678 begin entering text and press a button. An underscore character will
7679 appear at the location of the pointer. The cursor changes to a pencil
7680 to indicate you are in text mode. To exit immediately, press Dismiss.
7681 In text mode, any key presses will display the character at the loca‐
7683 tion of the underscore and advance the underscore cursor. Enter your
7684 text and once completed press Apply to finish your image annotation. To
7685 correct errors press BACK SPACE. To delete an entire line of text,
7686 press DELETE. Any text that exceeds the boundaries of the image window
7687 is automatically continued onto the next line.
7688 The actual color you request for the font is saved in the image. How‐
7690 ever, the color that appears in your Image window may be different. For
7691 example, on a monochrome screen the text will appear black or white
7692 even if you choose the color red as the font color. However, the image
7693 saved to a file with -write is written with red lettering. To assure
7694 the correct color text in the final image, any PseudoClass image is
7695 promoted to DirectClass (see miff(5)). To force a PseudoClass image to
7696 remain PseudoClass, use -colors.
7697
7699 An image composite is created interactively. There is no command line
7700 argument to composite an image. To begin, choose Composite of the Image
7701 Edit from the Command widget. Alternatively, press x in the Image win‐
7702 dow.
7703 First a popup window is displayed requesting you to enter an image
7705 name. Press Composite, Grab or type a file name. Press Cancel if you
7706 choose not to create a composite image. When you choose Grab, move the
7707 pointer to the desired window and press any button.
7708 If the Composite image does not have any matte information, you are
7710 informed and the file browser is displayed again. Enter the name of a
7711 mask image. The image is typically grayscale and the same size as the
7712 composite image. If the image is not grayscale, it is converted to
7713 grayscale and the resulting intensities are used as matte information.
7714 A small window appears showing the location of the cursor in the image
7716 window. You are now in composite mode. To exit immediately, press Dis‐
7717 miss. In composite mode, the Command widget has these options:
7718 Operators
7721 over
7724 in
7726 out
7728 atop
7730 xor
7732 plus
7734 minus
7736 add
7738 subtract
7740 difference
7742 bumpmap
7744 replace
7746 Blend
7749 Displace
7751 Help
7753 Dismiss
7755 Choose a composite operation from the Operators sub-menu of the Command
7758 widget. How each operator behaves is described below. image window is
7759 the image currently displayed on your X server and image is the image
7760 obtained
7761 over The result is the union of the two image shapes, with image
7763 obscuring image window in the region of overlap.
7764 in The result is simply image cut by the shape of image window.
7766 None of the image data of image window is in the result.
7767 out The resulting image is image with the shape of image window cut
7769 out.
7770 atop The result is the same shape as image window, with image
7772 obscuring image window where the image shapes overlap. Note this
7773 differs from over because the portion of image outside image
7774 window's shape does not appear in the result.
7775 xor The result is the image data from both image and image window
7777 that is outside the overlap region. The overlap region is blank.
7778 plus The result is just the sum of the image data. Output values are
7780 cropped to 255 (no overflow). This operation is independent of
7781 the matte channels.
7782 minus The result of image - image window, with underflow cropped to
7784 zero. The matte channel is ignored (set to 255, full coverage).
7785 add The result of image + image window, with overflow wrapping
7787 around (mod 256).
7788 subtract
7790 The result of image - image window, with underflow wrapping
7791 around (mod 256). The add and subtract operators can be used to
7792 perform reversible transformations.
7793 difference
7795 The result of abs(image - image window). This is useful for
7796 comparing two very similar images.
7797 bumpmap
7799 The result of image window shaded by window.
7800 replace
7802 The resulting image is image window replaced with image. Here
7803 the matte information is ignored.
7804 The image compositor requires a matte, or alpha channel in the
7806 image for some operations. This extra channel usually defines a
7807 mask which represents a sort of a cookie-cutter for the image.
7808 This is the case when matte is 255 (full coverage) for pixels
7809 inside the shape, zero outside, and between zero and 255 on the
7810 boundary. If image does not have a matte channel, it is initial‐
7811 ized with 0 for any pixel matching in color to pixel location
7812 (0,0), otherwise 255. See Matte Editing for a method of defining
7813 a matte channel.
7814 If you choose blend, the composite operator becomes over. The
7816 image matte channel percent transparency is initialized to fac‐
7817 tor. The image window is initialized to (100-factor). Where
7818 factor is the value you specify in the Dialog widget.
7819 Displace shifts the image pixels as defined by a displacement
7821 map. With this option, image is used as a displacement map.
7822 Black, within the displacement map, is a maximum positive dis‐
7823 placement. White is a maximum negative displacement and middle
7824 gray is neutral. The displacement is scaled to determine the
7825 pixel shift. By default, the displacement applies in both the
7826 horizontal and vertical directions. However, if you specify
7827 mask, image is the horizontal X displacement and mask the verti‐
7828 cal Y displacement.
7829 Note that matte information for image window is not retained for
7831 colormapped X server visuals (e.g. StaticColor, StaticColor,
7832 GrayScale, PseudoColor). Correct compositing behavior may
7833 require a TrueColor or DirectColor visual or a Standard Col‐
7834 ormap.
7835 Choosing a composite operator is optional. The default operator
7837 is replace. However, you must choose a location to composite
7838 your image and press button 1. Press and hold the button before
7839 releasing and an outline of the image will appear to help you
7840 identify your location.
7841 The actual colors of the composite image is saved. However, the
7843 color that appears in image window may be different. For exam‐
7844 ple, on a monochrome screen Image window will appear black or
7845 white even though your composited image may have many colors. If
7846 the image is saved to a file it is written with the correct col‐
7847 ors. To assure the correct colors are saved in the final image,
7848 any PseudoClass image is promoted to DirectClass (see miff). To
7849 force a PseudoClass image to remain PseudoClass, use -colors.
7850
7852 Changing the the color of a set of pixels is performed interactively.
7853 There is no command line argument to edit a pixel. To begin, choose
7854 Color from the Image Edit submenu of the Command widget. Alterna‐
7855 tively, press c in the image window.
7856 A small window appears showing the location of the cursor in the image
7858 window. You are now in color edit mode. To exit immediately, press Dis‐
7859 miss. In color edit mode, the Command widget has these options:
7860 Method
7863 point
7866 replace
7868 floodfill
7870 reset
7872 Pixel Color
7875 black
7878 blue
7880 cyan
7882 green
7884 gray
7886 red
7888 magenta
7890 yellow
7892 white
7894 Browser...
7896 Border Color
7899 black
7902 blue
7904 cyan
7906 green
7908 gray
7910 red
7912 magenta
7914 yellow
7916 white
7918 Browser...
7920 Fuzz
7923 0
7926 2
7928 4
7930 8
7932 16
7934 Dialog...
7935 Undo
7938 Help
7940 Dismiss
7942 Choose a color editing method from the Method sub-menu of the Command
7945 widget. The point method recolors any pixel selected with the pointer
7946 unless the button is released. The replace method recolors any pixel
7947 that matches the color of the pixel you select with a button press.
7948 Floodfill recolors any pixel that matches the color of the pixel you
7949 select with a button press and is a neighbor. Whereas filltoborder
7950 changes the matte value of any neighbor pixel that is not the border
7951 color. Finally reset changes the entire image to the designated color.
7952 Next, choose a pixel color from the Pixel Color sub-menu. Additional
7954 pixel colors can be specified with the color browser. You can change
7955 the menu colors by setting the X resources pen1 through pen9.
7956 Now press button 1 to select a pixel within the Image window to change
7958 its color. Additional pixels may be recolored as prescribed by the
7959 method you choose. additional pixels by increasing the Delta value.
7960 If the Magnify widget is mapped, it can be helpful in positioning your
7962 pointer within the image (refer to button 2). Alternatively you can
7963 select a pixel to recolor from within the Magnify widget. Move the
7964 pointer to the Magnify widget and position the pixel with the cursor
7965 control keys. Finally, press a button to recolor the selected pixel (or
7966 pixels).
7967 The actual color you request for the pixels is saved in the image. How‐
7969 ever, the color that appears in your Image window may be different. For
7970 example, on a monochrome screen the pixel will appear black or white
7971 even if you choose the color red as the pixel color. However, the image
7972 saved to a file with -write is written with red pixels. To assure the
7973 correct color text in the final image, any PseudoClass image is pro‐
7974 moted to DirectClass To force a PseudoClass image to remain Pseudo‐
7975 Class, use -colors.
7976
7978 Matte information within an image is useful for some operations such as
7979 image compositing. This extra channel usually defines a mask which rep‐
7980 resents a sort of a cookie-cutter for the image. This is the case when
7981 matte is 255 (full coverage) for pixels inside the shape, zero outside,
7982 and between zero and 255 on the boundary.
7983 Setting the matte information in an image is done interactively. There
7985 is no command line argument to edit a pixel. To begin, and choose Matte
7986 of the Image Edit sub-menu from the Command widget.
7987 Alternatively, press m in the image window.
7989 A small window appears showing the location of the cursor in the image
7991 window. You are now in matte edit mode. To exit immediately, press Dis‐
7992 miss. In matte edit mode, the Command widget has these options:
7993 Method
7996 point
7999 replace
8001 floodfill
8003 reset
8005 Border Color
8008 black
8011 blue
8013 cyan
8015 green
8017 gray
8019 red
8021 magenta
8023 yellow
8025 white
8027 Browser...
8029 Fuzz
8032 0
8035 2
8037 4
8039 8
8041 16
8043 Dialog...
8044 Matte
8047 Undo
8049 Help
8051 Dismiss
8053 Choose a matte editing method from the Method sub-menu of the Command
8055 widget. The point method changes the matte value of the any pixel
8056 selected with the pointer until the button is released. The replace
8057 method changes the matte value of any pixel that matches the color of
8058 the pixel you select with a button press. Floodfill changes the matte
8059 value of any pixel that matches the color of the pixel you select with
8060 a button press and is a neighbor. Whereas filltoborder recolors any
8061 neighbor pixel that is not the border color. Finally reset changes the
8062 entire image to the designated matte value. Choose Matte Value and a
8063 dialog appears requesting a matte value. Enter a value between 0 and
8064 255. This value is assigned as the matte value of the selected pixel or
8065 pixels. Now, press any button to select a pixel within the Image win‐
8066 dow to change its matte value. You can change the matte value of addi‐
8067 tional pixels by increasing the Delta value. The Delta value is first
8068 added then subtracted from the red, green, and blue of the target
8069 color. Any pixels within the range also have their matte value updated.
8070 If the Magnify widget is mapped, it can be helpful in positioning your
8071 pointer within the image (refer to button 2). Alternatively you can
8072 select a pixel to change the matte value from within the Magnify wid‐
8073 get. Move the pointer to the Magnify widget and position the pixel
8074 with the cursor control keys. Finally, press a button to change the
8075 matte value of the selected pixel (or pixels). Matte information is
8076 only valid in a DirectClass image. Therefore, any PseudoClass image is
8077 promoted to DirectClass. Note that matte information for PseudoClass is
8078 not retained for colormapped X server visuals (e.g. StaticColor, Stat‐
8079 icColor, GrayScale, PseudoColor) unless you immediately save your image
8080 to a file (refer to Write). Correct matte editing behavior may require
8081 a TrueColor or DirectColor visual or a Standard Colormap.
8082
8084 An image is drawn upon interactively. There is no command line argument
8085 to draw on an image. To begin, choose Draw of the Image Edit sub-menu
8086 from the Command widget. Alternatively, press d in the image window.
8087 The cursor changes to a crosshair to indicate you are in draw mode. To
8089 exit immediately, press Dismiss. In draw mode, the Command widget has
8090 these options:
8091 Primitive
8094 point
8097 line
8099 rectangle
8101 fill rectangle
8103 circle
8105 fill circle
8107 ellipse
8109 fill ellipse
8111 polygon
8113 fill polygon
8115 Color
8118 black
8121 blue
8123 cyan
8125 green
8127 gray
8129 red
8131 magenta
8133 yellow
8135 white
8137 transparent
8139 Browser...
8141 Stipple
8144 Brick
8147 Diagonal
8149 Scales
8151 Vertical
8153 Wavy
8155 Translucent
8157 Opaque
8159 Open...
8161 Width
8164 1
8167 2
8169 4
8171 8
8173 16
8175 Dialog...
8176 Undo
8179 Help
8181 Dismiss
8183 Choose a drawing primitive from the Primitive sub-menu.
8185 Next, choose a color from the Color sub-menu. Additional colors can be
8187 specified with the color browser. You can change the menu colors by
8188 setting the X resources pen1 through pen9. The transparent color
8189 updates the image matte channel and is useful for image compositing.
8190 If you choose the color browser and press Grab, you can select the
8192 primitive color by moving the pointer to the desired color on the
8193 screen and press any button. The transparent color updates the image
8194 matte channel and is useful for image compositing.
8195 Choose a stipple, if appropriate, from the Stipple sub-menu. Additional
8197 stipples can be specified with the file browser. Stipples obtained from
8198 the file browser must be on disk in the X11 bitmap format.
8199 Choose a line width, if appropriate, from the Width sub-menu. To choose
8201 a specific width select the Dialog widget.
8202 Choose a point in the image window and press button 1 and hold. Next,
8204 move the pointer to another location in the image. As you move, a line
8205 connects the initial location and the pointer. When you release the
8206 button, the image is updated with the primitive you just drew. For
8207 polygons, the image is updated when you press and release the button
8208 without moving the pointer.
8209 To cancel image drawing, move the pointer back to the starting point of
8211 the line and release the button.
8212
8214 To begin, press choose Region of Interest of the Pixel Transform sub-
8215 menu from the Command widget. Alternatively, press R in the image win‐
8216 dow.
8217 A small window appears showing the location of the cursor in the image
8219 window. You are now in region of interest mode. In region of interest
8220 mode, the Command widget has these options:
8221 Help
8224 Dismiss
8226 To define a region of interest, press button 1 and drag. The region of
8229 interest is defined by a highlighted rectangle that expands or con‐
8230 tracts as it follows the pointer. Once you are satisfied with the
8231 region of interest, release the button. You are now in apply mode. In
8232 apply mode the Command widget has these options:
8233 File
8236 Save...
8239 Print...
8241 Edit
8244 Undo
8247 Redo
8249 Transform
8252 Flip
8255 Flop
8257 Rotate Right
8259 Rotate Left
8261 Enhance
8264 Hue...
8267 Saturation...
8269 Brightness...
8271 Gamma...
8273 Spiff
8275 Dull
8277 Equalize
8279 Normalize
8281 Negate
8283 GRAYscale
8285 Quantize...
8287 Effects
8290 Despeckle
8293 Emboss
8295 Reduce Noise
8297 Add Noise
8299 Sharpen...
8301 Blur...
8303 Threshold...
8305 Edge Detect...
8307 Spread...
8309 Shade...
8311 Raise...
8313 Segment...
8315 F/X
8320 Solarize...
8323 Swirl...
8325 Implode...
8327 Wave...
8329 Oil Paint
8331 Charcoal Draw...
8333 Miscellany
8338 Image Info
8341 Zoom Image
8343 Show Preview...
8345 Show Histogram
8347 Show Matte
8349 Help
8352 Dismiss
8354 You can make adjustments to the region of interest by moving the
8357 pointer to one of the rectangle corners, pressing a button, and drag‐
8358 ging. Finally, choose an image processing technique from the Command
8359 widget. You can choose more than one image processing technique to
8360 apply to an area. Alternatively, you can move the region of interest
8361 before applying another image processing technique. To exit, press Dis‐
8362 miss.
8363
8365 When an image exceeds the width or height of the X server screen, dis‐
8366 play maps a small panning icon. The rectangle within the panning icon
8367 shows the area that is currently displayed in the the image window. To
8368 pan about the image, press any button and drag the pointer within the
8369 panning icon. The pan rectangle moves with the pointer and the image
8370 window is updated to reflect the location of the rectangle within the
8371 panning icon. When you have selected the area of the image you wish to
8372 view, release the button.
8373 Use the arrow keys to pan the image one pixel up, down, left, or right
8375 within the image window.
8376 The panning icon is withdrawn if the image becomes smaller than the
8378 dimensions of the X server screen.
8379
8381 Preferences affect the default behavior of display(1). The preferences
8382 are either true or false and are stored in your home directory as .dis‐
8383 playrc:
8384 display image centered on a backdrop"
8386 This backdrop covers the entire workstation screen and is
8389 useful for hiding other X window activity while viewing
8390 the image. The color of the backdrop is specified as the
8391 background color. Refer to X Resources for details.
8392 confirm on program exit"
8393 Ask for a confirmation before exiting the display(1) pro‐
8396 gram.
8397 correct image for display gamma"
8398 If the image has a known gamma, the gamma is corrected to
8401 match that of the X server (see the X Resource dis‐
8402 playGamma).
8403 display warning messages"
8404 Display any warning messages.
8407 apply Floyd/Steinberg error diffusion to image"
8408 The basic strategy of dithering is to trade intensity res‐
8411 olution for spatial resolution by averaging the intensi‐
8412 ties of several neighboring pixels. Images which suffer
8413 from severe contouring when reducing colors can be
8414 improved with this preference.
8415 use a shared colormap for colormapped X visuals"
8416 This option only applies when the default X server visual
8419 is PseudoColor or GRAYScale. Refer to -visual for more
8420 details. By default, a shared colormap is allocated. The
8421 image shares colors with other X clients. Some image col‐
8422 ors could be approximated, therefore your image may look
8423 very different than intended. Otherwise the image colors
8424 appear exactly as they are defined. However, other clients
8425 may go technicolor when the image colormap is installed.
8426 display images as an X server pixmap"
8427 Images are maintained as a XImage by default. Set this
8430 resource to True to utilize a server Pixmap instead. This
8431 option is useful if your image exceeds the dimensions of
8432 your server screen and you intend to pan the image. Pan‐
8433 ning is much faster with Pixmaps than with a XImage.
8434 Pixmaps are considered a precious resource, use them with
8435 discretion.
8436 GM IDENTIFY
8440 Identify describes the format and characteristics of one or more
8442 image files as internally supported by the software. It will
8443 also report if an image is incomplete or corrupt. The informa‐
8444 tion displayed includes the scene number, the file name, the
8445 width and height of the image, whether the image is colormapped
8446 or not, the number of colors in the image, the number of bytes
8447 in the image, the format of the image (JPEG, PNM, etc.), and
8448 finally the number of seconds in both user time and elapsed time
8449 it took to read and process the image. If -verbose or +ping are
8450 provided as an option, the pixel read rate is also displayed. An
8451 example line output from identify follows:
8452 images/aquarium.miff 640x480 PseudoClass 256c
8454 308135b MIFF 0.000u 0:01
8455 If -verbose is set, expect additional output including any image
8458 comment:
8459 Image: images/aquarium.miff
8462 class: PseudoClass
8463 colors: 256
8464 signature: eb5dca81dd93ae7e6ffae99a527eb5dca8...
8465 matte: False
8466 geometry: 640x480
8467 depth: 8
8468 bytes: 308135
8469 format: MIFF
8470 comments:
8471 Imported from MTV raster image: aquarium.mtv
8472 For some formats, additional format-specific information about
8475 the file will be written if the -debug coder or -debug all
8476 option is used.
8477
8479 Options are processed in command line order. Any option you specify on
8480 the command line remains in effect for the set of images immediately
8481 following, until the set is terminated by the appearance of any option
8482 or -noop.
8483 For a more detailed description of each option, see Options, above.
8485 -authenticate <string>
8488 decrypt image with this password
8489 -debug <events>
8491 enable debug printout
8492 -define <key>{=<value>},...
8494 add coder/decoder specific options
8495 -density <width>x<height>
8497 horizontal and vertical resolution in pixels of the image
8498 -depth <value>
8500 depth of the image
8501 -format <string>
8503 output formatted image characteristics
8504 -help print usage instructions
8506 -interlace <type>
8508 the type of interlacing scheme
8509 -limit <type> <value>
8511 Disk, File, Map, Memory, Pixels, Width, Height or Threads
8512 resource limit
8513 -log <string>
8515 Specify format for debug log
8516 -ping efficiently determine image characteristics
8518 -sampling-factor <horizontal_factor>x<vertical_factor>
8520 chroma subsampling factors
8521 -size <width>x<height>{+offset}
8523 width and height of the image
8524 -verbose
8526 print detailed information about the image
8527 -version
8529 print GraphicsMagick version string
8530 For a more detailed description of each option, see Options,
8532 above.
8533
8536 Import reads an image from any visible window on an X server and out‐
8537 puts it as an image file. You can capture a single window, the entire
8538 screen, or any rectangular portion of the screen. Use display for
8539 redisplay, printing, editing, formatting, archiving, image processing,
8540 etc. of the captured image.
8541 The target window can be specified by id, name, or may be selected by
8543 clicking the mouse in the desired window. If you press a button and
8544 then drag, a rectangle will form which expands and contracts as the
8545 mouse moves. To save the portion of the screen defined by the rectan‐
8546 gle, just release the button. The keyboard bell is rung once at the
8547 beginning of the screen capture and twice when it completes.
8548
8550 To select an X window or an area of the screen with the mouse and save
8551 it in the MIFF image format to a file entitled window.miff, use:
8552 gm import window.miff
8554 To select an X window or an area of the screen with the mouse and save
8557 it in the Encapsulated PostScript format to include in another docu‐
8558 ment, use:
8559 gm import figure.eps
8561 To capture the entire X server screen in the JPEG image format in a
8564 file entitled root.jpeg, without using the mouse, use:
8565 gm import -window root root.jpeg
8567 To capture the 512x256 area at the upper right corner of the X server
8570 screen in the PNG image format in a well-compressed file entitled cor‐
8571 ner.png, without using the mouse, use:
8572 gm import -window root -crop 512x256-0+0 -quality 90
8574 corner.png
8575
8578 Options are processed in command line order. Any option you specify on
8579 the command line remains in effect until it is explicitly changed by
8580 specifying the option again with a different effect.
8581 Import options can appear on the command line or in your X resources
8583 file. See X(1). Options on the command line supersede values specified
8584 in your X resources file.
8585 For a more detailed description of each option, see Options, above.
8587 -bordercolor <color>
8590 the border color
8591 -colors <value>
8593 preferred number of colors in the image
8594 -colorspace <value>
8596 the type of colorspace
8597 -comment <string>
8599 annotate an image with a comment
8600 -crop <width>x<height>{+-}<x>{+-}<y>{%}
8602 preferred size and location of the cropped image
8603 -debug <events>
8605 enable debug printout
8606 -define <key>{=<value>},...
8608 add coder/decoder specific options
8609 -delay <1/100ths of a second>
8611 display the next image after pausing
8612 -density <width>x<height>
8614 horizontal and vertical resolution in pixels of the image
8615 -depth <value>
8617 depth of the image
8618 -descend
8620 obtain image by descending window hierarchy
8621 -display <host:display[.screen]>
8623 specifies the X server to contact
8624 -dispose <method>
8626 GIF disposal method
8627 -dither
8629 apply Floyd/Steinberg error diffusion to the image
8630 -encoding <type>
8632 specify the text encoding
8633 -endian <type>
8635 specify endianness (MSB, LSB, or Native) of image
8636 -frame include the X window frame in the imported image
8638 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
8640 Specify dimension, offset, and resize options.
8641 -help print usage instructions
8643 -interlace <type>
8645 the type of interlacing scheme
8646 -label <name>
8648 assign a label to an image
8649 -limit <type> <value>
8651 Disk, File, Map, Memory, Pixels, Width, Height or Threads
8652 resource limit
8653 -log <string>
8655 Specify format for debug log
8656 -monitor
8658 show progress indication
8659 -monochrome
8661 transform the image to black and white
8662 -negate
8664 replace every pixel with its complementary color
8665 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
8667 size and location of an image canvas
8668 -pause <seconds>
8670 pause between snapshots [import]
8671 -ping efficiently determine image characteristics
8673 -pointsize <value>
8675 pointsize of the PostScript, X11, or TrueType font
8676 -quality <value>
8678 JPEG/MIFF/PNG/TIFF compression level
8679 -resize <width>x<height>{%}{@}{!}{<}{>}
8681 resize an image
8682 -rotate <degrees>{<}{>}
8684 rotate the image
8685 -sampling-factor <horizontal_factor>x<vertical_factor>
8687 chroma subsampling factors
8688 -scene <value>
8690 set scene number
8691 -screen
8693 specify the screen to capture
8694 -set <attribute> <value>
8696 set an image attribute
8697 +set <attribute>
8699 unset an image attribute
8700 -silent
8702 operate silently
8703 -snaps <value>
8705 number of screen snapshots
8706 -thumbnail <width>x<height>{%}{@}{!}{<}{>}
8708 resize an image (quickly)
8709 -transparent <color>
8711 make this color transparent within the image
8712 -trim trim an image
8714 -verbose
8716 print detailed information about the image
8717 -version
8719 print GraphicsMagick version string
8720 For a more detailed description of each option, see Options,
8722 above.
8723
8726 Mogrify transforms an image or a sequence of images. These transforms
8727 include image scaling, image rotation, color reduction, and others.
8728 Each transmogrified image overwrites the corresponding original image,
8729 unless an option such as -format causes the output filename to be dif‐
8730 ferent from the input filename.
8731 The graphics formats supported by mogrify are listed in GraphicsMag‐
8733 ick(1).
8734
8736 To convert all the TIFF files in a particular directory to JPEG, use:
8737 gm mogrify -format jpeg *.tiff
8739 To convert a directory full of JPEG images to thumbnails, use:
8742 gm mogrify -size 120x120 *.jpg -resize 120x120 +profile "*"
8744 In this example, '-size 120x120' gives a hint to the JPEG decoder that
8747 the images are going to be downscaled to 120x120, allowing it to run
8748 faster by avoiding returning full-resolution images to GraphicsMagick
8749 for the subsequent resizing operation. The ´-resize 120x120' specifies
8750 the desired dimensions of the output images. It will be scaled so its
8751 largest dimension is 120 pixels. The ´+profile "*"' removes any ICM,
8752 EXIF, IPTC, or other profiles that might be present in the input and
8753 aren't needed in the thumbnails.
8754 To scale an image of a cockatoo to exactly 640 pixels in width and 480
8756 pixels in height, use:
8757 gm mogrify -resize 640x480! cockatoo.miff
8759
8762 Options are processed in command line order. Any option you specify on
8763 the command line remains in effect for the set of images that follows,
8764 until the set is terminated by the appearance of any option or -noop.
8765 For a more detailed description of each option, see Options, above.
8767 -affine <matrix>
8770 drawing transform matrix
8771 -antialias
8773 remove pixel aliasing
8774 -asc-cdl <spec>
8776 apply ASC CDL color transform
8777 -authenticate <string>
8779 decrypt image with this password
8780 -auto-orient
8782 orient (rotate) image so it is upright
8783 -background <color>
8785 the background color
8786 -black-threshold red[,green][,blue][,opacity]
8788 pixels below the threshold become black
8789 -blue-primary <x>,<y>
8791 blue chromaticity primary point
8792 -blur <radius>{x<sigma>}
8794 blur the image with a Gaussian operator
8795 -border <width>x<height>
8797 surround the image with a border of color
8798 -bordercolor <color>
8800 the border color
8801 -channel <type>
8803 the type of channel
8804 -charcoal <factor>
8806 simulate a charcoal drawing
8807 -colorize <value>
8809 colorize the image with the pen color
8810 -colors <value>
8812 preferred number of colors in the image
8813 -colorspace <value>
8815 the type of colorspace
8816 -comment <string>
8818 annotate an image with a comment
8819 -compose <operator>
8821 the type of image composition
8822 -compress <type>
8824 the type of image compression
8825 -contrast
8827 enhance or reduce the image contrast
8828 -convolve <kernel>
8830 convolve image with the specified convolution kernel
8831 -create-directories
8833 create output directory if required
8834 -crop <width>x<height>{+-}<x>{+-}<y>{%}
8836 preferred size and location of the cropped image
8837 -cycle <amount>
8839 displace image colormap by amount
8840 -debug <events>
8842 enable debug printout
8843 -define <key>{=<value>},...
8845 add coder/decoder specific options
8846 -delay <1/100ths of a second>
8848 display the next image after pausing
8849 -density <width>x<height>
8851 horizontal and vertical resolution in pixels of the image
8852 -depth <value>
8854 depth of the image
8855 -despeckle
8857 reduce the speckles within an image
8858 -display <host:display[.screen]>
8860 specifies the X server to contact
8861 -dispose <method>
8863 GIF disposal method
8864 -dither
8866 apply Floyd/Steinberg error diffusion to the image
8867 -draw <string>
8869 annotate an image with one or more graphic primitives
8870 -edge <radius>
8872 detect edges within an image
8873 -emboss <radius>
8875 emboss an image
8876 -encoding <type>
8878 specify the text encoding
8879 -endian <type>
8881 specify endianness (MSB, LSB, or Native) of image
8882 -enhance
8884 apply a digital filter to enhance a noisy image
8885 -equalize
8887 perform histogram equalization to the image
8888 -extent <width>x<height>{+-}<x>{+-}<y>
8890 composite image on background color canvas image
8891 -fill <color>
8893 color to use when filling a graphic primitive
8894 -filter <type>
8896 use this type of filter when resizing an image
8897 -flip create a "mirror image"
8899 -flop create a "mirror image"
8901 -font <name>
8903 use this font when annotating the image with text
8904 -format <type>
8906 the image format type
8907 -frame <width>x<height>+<outer bevel width>+<inner bevel width>
8909 surround the image with an ornamental border
8910 -fuzz <distance>{%}
8912 colors within this Euclidean distance are considered equal
8913 -gamma <value>
8915 level of gamma correction
8916 -gaussian <radius>{x<sigma>}
8918 blur the image with a Gaussian operator
8919 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
8921 Specify dimension, offset, and resize options.
8922 -gravity <type>
8924 direction primitive gravitates to when annotating the image.
8925 -green-primary <x>,<y>
8927 green chromaticity primary point
8928 -hald-clut <clut>
8930 apply a Hald CLUT to the image
8931 -help print usage instructions
8933 -implode <factor>
8935 implode image pixels about the center
8936 -interlace <type>
8938 the type of interlacing scheme
8939 -label <name>
8941 assign a label to an image
8942 -lat <width>x<height>{+-}<offset>{%}
8944 perform local adaptive thresholding
8945 -level <black_point>{,<gamma>}{,<white_point>}{%}
8947 adjust the level of image contrast
8948 -limit <type> <value>
8950 Disk, File, Map, Memory, Pixels, Width, Height or Threads
8951 resource limit
8952 -linewidth
8954 the line width for subsequent draw operations
8955 -list <type>
8957 the type of list
8958 -log <string>
8960 Specify format for debug log
8961 -loop <iterations>
8963 add Netscape loop extension to your GIF animation
8964 -magnify
8966 magnify the image
8967 -map <filename>
8969 choose a particular set of colors from this image
8970 -mask <filename>
8972 Specify a clipping mask
8973 -matte store matte channel if the image has one
8975 -mattecolor <color>
8977 specify the color to be used with the -frame option
8978 -median <radius>
8980 apply a median filter to the image
8981 -minify <factor>
8983 minify the image
8984 -modulate brightness[,saturation[,hue]]
8986 vary the brightness, saturation, and hue of an image
8987 -monitor
8989 show progress indication
8990 -monochrome
8992 transform the image to black and white
8993 -motion-blur <radius>{x<sigma>}{+angle}
8995 Simulate motion blur
8996 -negate
8998 replace every pixel with its complementary color
8999 -noise <radius|type>
9001 add or reduce noise in an image
9002 -noop NOOP (no option)
9004 -normalize
9006 transform image to span the full range of color values
9007 -opaque <color>
9009 change this color to the pen color within the image
9010 -operator channel operator rvalue[%]
9012 apply a mathematical, bitwise, or value operator to an image
9013 channel
9014 -ordered-dither <channeltype> <NxN>
9016 ordered dither the image
9017 -output-directory <directory>
9019 output files to directory
9020 -orient <orientation>
9022 Set the image orientation attribute
9023 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
9025 size and location of an image canvas
9026 -paint <radius>
9028 simulate an oil painting
9029 -pen <color>
9031 (This option has been replaced by the -fill option)
9032 -pointsize <value>
9034 pointsize of the PostScript, X11, or TrueType font
9035 -profile <filename>
9037 add ICM, IPTC, or generic profile to image
9038 -preserve-timestamp
9040 preserve the original timestamps of the file
9041 -quality <value>
9043 JPEG/MIFF/PNG/TIFF compression level
9044 -raise <width>x<height>
9046 lighten or darken image edges
9047 -random-threshold <channeltype> <LOWxHIGH>
9049 random threshold the image
9050 -recolor <matrix>
9052 apply a color translation matrix to image channels
9053 -red-primary <x>,<y>
9055 red chromaticity primary point
9056 -region <width>x<height>{+-}<x>{+-}<y>
9058 apply options to a portion of the image
9059 -render
9061 render vector operations
9062 -repage <width>x<height>+xoff+yoff[!]
9064 Adjust image page offsets
9065 -resample <horizontal>x<vertical>
9067 Resample image to specified horizontal and vertical resolution
9068 -resize <width>x<height>{%}{@}{!}{<}{>}
9070 resize an image
9071 -roll {+-}<x>{+-}<y>
9073 roll an image vertically or horizontally
9074 -rotate <degrees>{<}{>}
9076 rotate the image
9077 -sample <geometry>
9079 scale image using pixel sampling
9080 -sampling-factor <horizontal_factor>x<vertical_factor>
9082 chroma subsampling factors
9083 -scale <geometry>
9085 scale the image.
9086 -scene <value>
9088 set scene number
9089 -set <attribute> <value>
9091 set an image attribute
9092 +set <attribute>
9094 unset an image attribute
9095 -segment <cluster threshold>x<smoothing threshold>
9097 segment an image
9098 -shade <azimuth>x<elevation>
9100 shade the image using a distant light source
9101 -sharpen <radius>{x<sigma>}
9103 sharpen the image
9104 -shave <width>x<height>{%}
9106 shave pixels from the image edges
9107 -shear <x degrees>x<y degrees>
9109 shear the image along the X or Y axis
9110 -size <width>x<height>{+offset}
9112 width and height of the image
9113 -solarize <factor>
9115 negate all pixels above the threshold level
9116 -spread <amount>
9118 displace image pixels by a random amount
9119 -strip remove all profiles and text attributes from the image
9121 -stroke <color>
9123 color to use when stroking a graphic primitive
9124 -strokewidth <value>
9126 set the stroke width
9127 -swirl <degrees>
9129 swirl image pixels about the center
9130 -texture <filename>
9132 name of texture to tile onto the image background
9133 -threshold <value>{%}
9135 threshold the image
9136 -thumbnail <width>x<height>{%}{@}{!}{<}{>}
9138 resize an image (quickly)
9139 -tile <filename>
9141 tile image when filling a graphic primitive
9142 -transform
9144 transform the image
9145 -transparent <color>
9147 make this color transparent within the image
9148 -treedepth <value>
9150 tree depth for the color reduction algorithm
9151 -trim trim an image
9153 -type <type>
9155 the image type
9156 -units <type>
9158 the units of image resolution
9159 -unsharp <radius>{x<sigma>}{+<amount>}{+<threshold>}
9161 sharpen the image with an unsharp mask operator
9162 -verbose
9164 print detailed information about the image
9165 -version
9167 print GraphicsMagick version string
9168 -view <string>
9170 FlashPix viewing parameters
9171 -virtual-pixel <method>
9173 specify contents of "virtual pixels"
9174 -wave <amplitude>x<wavelength>
9176 alter an image along a sine wave
9177 -white-point <x>,<y>
9179 chromaticity white point
9180 -white-threshold red[,green][,blue][,opacity]
9182 pixels above the threshold become white
9183 For a more detailed description of each option, see Options,
9185 above.
9186
9189 montage creates a composite image by combining several separate images.
9190 The images are tiled on the composite image with the name of the image
9191 optionally appearing just below the individual tile.
9192 The composite image is constructed in the following manner. First, each
9194 image specified on the command line, except for the last, is scaled to
9195 fit the maximum tile size. The maximum tile size by default is 120x120.
9196 It can be modified with the -geometry command line argument or X
9197 resource. See Options for more information on command line arguments.
9198 See X(1) for more information on X resources. Note that the maximum
9199 tile size need not be a square.
9200 Next the composite image is initialized with the color specified by the
9202 -background command line argument or X resource. The width and height
9203 of the composite image is determined by the title specified, the maxi‐
9204 mum tile size, the number of tiles per row, the tile border width and
9205 height, the image border width, and the label height. The number of
9206 tiles per row specifies how many images are to appear in each row of
9207 the composite image. The default is to have 5 tiles in each row and 4
9208 tiles in each column of the composite. A specific value is specified
9209 with -tile. The tile border width and height, and the image border
9210 width defaults to the value of the X resource -borderwidth. It can be
9211 changed with the -borderwidth or -geometry command line argument or X
9212 resource. The label height is determined by the font you specify with
9213 the -font command line argument or X resource. If you do not specify a
9214 font, a font is chosen that allows the name of the image to fit the
9215 maximum width of a tiled area. The label colors is determined by the
9216 -background and -fill command line argument or X resource. Note, that
9217 if the background and pen colors are the same, labels will not appear.
9218 Initially, the composite image title is placed at the top if one is
9220 specified (refer to -fill). Next, each image is set onto the composite
9221 image, surrounded by its border color, with its name centered just
9222 below it. The individual images are left-justified within the width of
9223 the tiled area. The order of the images is the same as they appear on
9224 the command line unless the images have a scene keyword. If a scene
9225 number is specified in each image, then the images are tiled onto the
9226 composite in the order of their scene number. Finally, the last argu‐
9227 ment on the command line is the name assigned to the composite image.
9228 By default, the image is written in the MIFF format and can be viewed
9229 or printed with display(1).
9230 Note, that if the number of tiles exceeds the default number of 20 (5
9233 per row, 4 per column), more than one composite image is created. To
9234 ensure a single image is produced, use -tile to increase the number of
9235 tiles to meet or exceed the number of input images.
9236 Finally, to create one or more empty spaces in the sequence of tiles,
9238 use the "NULL:" image format.
9239 Note, a composite MIFF image displayed to an X server with display
9241 behaves differently than other images. You can think of the composite
9242 as a visual image directory. Choose a particular tile of the composite
9243 and press a button to display it. See display(1) and miff(5)
9244
9246 To create a montage of a cockatoo, a parrot, and a hummingbird and
9247 write it to a file called birds, use:
9248 gm montage cockatoo.miff parrot.miff hummingbird.miff
9250 birds.miff
9251 To tile several bird images so that they are at most 256 pixels in
9254 width and 192 pixels in height, surrounded by a red border, and sepa‐
9255 rated by 10 pixels of background color, use:
9256 gm montage -geometry 256x192+10+10 -bordercolor red
9258 birds.* montage.miff
9259 To create an unlabeled parrot image, 640 by 480 pixels, and surrounded
9262 by a border of black, use:
9263 gm montage -geometry 640x480 -bordercolor black
9265 -label "" parrot.miff bird.miff
9266 To create an image of an eagle with a textured background, use:
9269 gm montage -texture bumps.jpg eagle.jpg eagle.png
9271 To join several GIF images together without any extraneous graphics
9274 (e.g. no label, no shadowing, no surrounding tile frame), use:
9275 gm montage +frame +shadow +label -tile 5x1
9277 -geometry 50x50+0+0 *.png joined.png
9278
9281 Any option you specify on the command line remains in effect for the
9282 group of images following it, until the group is terminated by the
9283 appearance of any option or -noop. For example, to make a montage of
9284 three images, the first with 32 colors, the second with an unlimited
9285 number of colors, and the third with only 16 colors, use:
9286 gm montage -colors 32 cockatoo.1 -noop cockatoo.2
9289 -colors 16 cockatoo.3 cockatoos.miff
9290 For a more detailed description of each option, see Options, above.
9293 -adjoin
9296 join images into a single multi-image file
9297 -affine <matrix>
9299 drawing transform matrix
9300 -authenticate <string>
9302 decrypt image with this password
9303 -background <color>
9305 the background color
9306 -blue-primary <x>,<y>
9308 blue chromaticity primary point
9309 -blur <radius>{x<sigma>}
9311 blur the image with a Gaussian operator
9312 -bordercolor <color>
9314 the border color
9315 -borderwidth <geometry>
9317 the border width
9318 -chop <width>x<height>{+-}<x>{+-}<y>{%}
9320 remove pixels from the interior of an image
9321 -colors <value>
9323 preferred number of colors in the image
9324 -colorspace <value>
9326 the type of colorspace
9327 -comment <string>
9329 annotate an image with a comment
9330 -compose <operator>
9332 the type of image composition
9333 -compress <type>
9335 the type of image compression
9336 -crop <width>x<height>{+-}<x>{+-}<y>{%}
9338 preferred size and location of the cropped image
9339 -debug <events>
9341 enable debug printout
9342 -define <key>{=<value>},...
9344 add coder/decoder specific options
9345 -density <width>x<height>
9347 horizontal and vertical resolution in pixels of the image
9348 -depth <value>
9350 depth of the image
9351 -display <host:display[.screen]>
9353 specifies the X server to contact
9354 -dispose <method>
9356 GIF disposal method
9357 -dither
9359 apply Floyd/Steinberg error diffusion to the image
9360 -draw <string>
9362 annotate an image with one or more graphic primitives
9363 -encoding <type>
9365 specify the text encoding
9366 -endian <type>
9368 specify endianness (MSB, LSB, or Native) of image
9369 -fill <color>
9371 color to use when filling a graphic primitive
9372 -filter <type>
9374 use this type of filter when resizing an image
9375 -font <name>
9377 use this font when annotating the image with text
9378 -frame <width>x<height>+<outer bevel width>+<inner bevel width>
9380 surround the image with an ornamental border
9381 -gamma <value>
9383 level of gamma correction
9384 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
9386 Specify dimension, offset, and resize options.
9387 -gravity <type>
9389 direction primitive gravitates to when annotating the image.
9390 -green-primary <x>,<y>
9392 green chromaticity primary point
9393 -help print usage instructions
9395 -interlace <type>
9397 the type of interlacing scheme
9398 -label <name>
9400 assign a label to an image
9401 -limit <type> <value>
9403 Disk, File, Map, Memory, Pixels, Width, Height or Threads
9404 resource limit
9405 -log <string>
9407 Specify format for debug log
9408 -matte store matte channel if the image has one
9410 -mattecolor <color>
9412 specify the color to be used with the -frame option
9413 -mode <value>
9415 mode of operation
9416 -monitor
9418 show progress indication
9419 -monochrome
9421 transform the image to black and white
9422 -noop NOOP (no option)
9424 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
9426 size and location of an image canvas
9427 -pen <color>
9429 (This option has been replaced by the -fill option)
9430 -pointsize <value>
9432 pointsize of the PostScript, X11, or TrueType font
9433 -quality <value>
9435 JPEG/MIFF/PNG/TIFF compression level
9436 -red-primary <x>,<y>
9438 red chromaticity primary point
9439 -render
9441 render vector operations
9442 -repage <width>x<height>+xoff+yoff[!]
9444 Adjust image page offsets
9445 -resize <width>x<height>{%}{@}{!}{<}{>}
9447 resize an image
9448 -rotate <degrees>{<}{>}
9450 rotate the image
9451 -sampling-factor <horizontal_factor>x<vertical_factor>
9453 chroma subsampling factors
9454 -scenes <value-value>
9456 range of image scene numbers to read
9457 -shadow <radius>{x<sigma>}
9459 shadow the montage
9460 -sharpen <radius>{x<sigma>}
9462 sharpen the image
9463 -size <width>x<height>{+offset}
9465 width and height of the image
9466 -strip remove all profiles and text attributes from the image
9468 -stroke <color>
9470 color to use when stroking a graphic primitive
9471 -strokewidth <value>
9473 set the stroke width
9474 -texture <filename>
9476 name of texture to tile onto the image background
9477 -thumbnail <width>x<height>{%}{@}{!}{<}{>}
9479 resize an image (quickly)
9480 -tile <geometry>
9482 layout of images [montage]
9483 -title <string>
9485 assign title to displayed image [animate, display, montage]
9486 -transform
9488 transform the image
9489 -transparent <color>
9491 make this color transparent within the image
9492 -treedepth <value>
9494 tree depth for the color reduction algorithm
9495 -trim trim an image
9497 -type <type>
9499 the image type
9500 -verbose
9502 print detailed information about the image
9503 -version
9505 print GraphicsMagick version string
9506 -white-point <x>,<y>
9508 chromaticity white point
9509 For a more detailed description of each option, see Options,
9511 above.
9512
9515 Montage options can appear on the command line or in your X resource
9516 file. Options on the command line supersede values specified in your X
9517 resource file. See X(1) for more information on X resources.
9518 All montage options have a corresponding X resource. In addition, mon‐
9520 tage uses the following X resources:
9521 background (class Background)
9523 background color
9524 Specifies the preferred color to use for the composite image
9526 background. The default is #ccc.
9527 borderColor (class BorderColor)
9529 border color
9530 Specifies the preferred color to use for the composite image
9532 border. The default is #ccc.
9533 borderWidth (class BorderWidth)
9535 border width
9536 Specifies the width in pixels of the composite image border. The
9538 default is 2.
9539 font (class Font)
9541 font to use
9542 Specifies the name of the preferred font to use when displaying
9544 text within the composite image. The default is 9x15, fixed, or
9545 5x8 determined by the composite image size.
9546 matteColor (class MatteColor)
9548 color of the frame
9549 Specify the color of an image frame. A 3D effect is achieved by
9551 using highlight and shadow colors derived from this color. The
9552 default value is #697B8F.
9553 pen (class Pen)
9555 text color
9556 Specifies the preferred color to use for text within the compos‐
9558 ite image. The default is black.
9559 title (class Title)
9561 composite image title
9562 This resource specifies the title to be placed at the top of the
9564 composite image. The default is not to place a title at the top
9565 of the composite image.
9566
9569 time executes an arbitrary gm utility command (e.g. convert) and
9570 reports the user and elapsed time. This provides way to measure com‐
9571 mand execution times similar to the Unix ´time' command but in a porta‐
9572 ble and consistent way.
9573
9575 To obtain time information for the execution of a command:
9576 % gm time convert input.ppm -gaussian 0x2 output.ppm convert input.ppm
9578 -gaussian 0x2 output.ppm 22.60s user 0.00s system 2354% cpu 0.960
9579 total
9580 Here is the interpretation of the above output:
9582 user - the total user time consumed.
9584 system - the total system time consumed.
9585 total - the total elapsed time consumed.
9586
9589 The time command reqires no options other than the gm command to exe‐
9590 cute.
9591
9594 version displays the software release version, build quantum (pixel
9595 sample) depth, web site URL, copyright notice, enabled features sup‐
9596 port, configuration parameters, and final build options used to build
9597 the software. The available information depends on how the software
9598 was configured and the host system.
9599
9601 To display the version information:
9602 GraphicsMagick 1.3.27a 2017-12-11 Q16 http://www.GraphicsMagick.org/
9604 Copyright (C) 2002-2020 GraphicsMagick Group.
9605 Additional copyrights and licenses apply to this software.
9606 See http://www.GraphicsMagick.org/www/Copyright.html for details.
9607 Feature Support:
9608 Native Thread Safe yes
9609 Large Files (> 32 bit) yes
9610 Large Memory (> 32 bit) yes
9611 BZIP yes
9612 DPS no
9613 FlashPix no
9614 FreeType yes
9615 Ghostscript (Library) no
9616 JBIG yes
9617 JPEG-2000 yes
9618 JPEG yes
9619 Little CMS yes
9620 Loadable Modules no
9621 OpenMP yes (201307)
9622 PNG yes
9623 TIFF yes
9624 TRIO no
9625 UMEM no
9626 WebP yes
9627 WMF yes
9628 X11 yes
9629 XML yes
9630 ZLIB yes
9631 Host type: x86_64-unknown-linux-gnu
9632 Configured using the command:
9633 ./configure ...
9634 Final Build Parameters:
9635 CC = ...
9636 CFLAGS = ...
9637 CPPFLAGS = ...
9638 CXX = ...
9639 CXXFLAGS = ...
9640 LDFLAGS = ...
9641 LIBS = ...
9642
9645 The version command does not currently support any options.
9646GraphicsMagick 2020/07/19 gm(1)