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, com‐
46 paring, converting, editing, and displaying images. All of the utili‐
47 ties are provided as sub-commands of a single gm executable:
48 animate displays an animation (e.g. a GIF file) on any workstation dis‐
50 play running an X server.
51 batch executes an arbitary number of the utility commands (e.g. con‐
53 vert) in the form of a simple linear batch script in order to improve
54 execution efficiency, and/or to allow use as a subordinate co-process
55 under the control of an arbitrary script or program.
56 benchmark executes one of the other utility commands (e.g. convert) for
58 a specified number of iterations, or execution time, and reports execu‐
59 tion time and other profiling information such as CPU utilization.
60 Benchmark provides various operating modes including executing the com‐
61 mand with a varying number of threads, and alternate reporting formats
62 such as comma-separated value (CSV).
63 compare compares two images and reports difference statistics according
65 to specified metrics and/or outputs an image with a visual representa‐
66 tion of the differences. It may also be used to test if images are
67 similar within a particular range and specified metric, returning a
68 truth value to the executing environment.
69 composite composites images (blends or merges images together) to cre‐
71 ate new images.
72 conjure interprets and executes scripts in the Magick Scripting Lan‐
74 guage (MSL).
75 convert converts an input file using one image format to an output file
77 with the same or differing image format while applying an arbitrary
78 number of image transformations.
79 display is a machine architecture independent image processing and dis‐
81 play facility. It can display an image on any workstation display run‐
82 ning an X server.
83 identify describes the format and characteristics of one or more image
85 files. It will also report if an image is incomplete or corrupt.
86 import reads an image from any visible window on an X server and out‐
88 puts it as an image file. You can capture a single window, the entire
89 screen, or any rectangular portion of the screen.
90 mogrify transforms an image or a sequence of images. These transforms
92 include image scaling, image rotation, color reduction, and others. The
93 transmogrified image overwrites the original image.
94 montage creates a composite by combining several separate images. The
96 images are tiled on the composite image with the name of the image
97 optionally appearing just below the individual tile.
98 time executes a subcommand and reports the user, system, and total exe‐
100 cution time consumed.
101 version reports the GraphicsMagick release version, maximum sample-
103 depth, copyright notice, supported features, and the options used while
104 building the software.
105 The GraphicsMagick utilities recognize the following image formats:
107 Name Mode Description
110 o 3FR r-- Hasselblad Photo RAW
111 o 8BIM rw- Photoshop resource format
112 o 8BIMTEXT rw- Photoshop resource text format
113 o 8BIMWTEXT rw- Photoshop resource wide text format
114 o APP1 rw- Raw application information
115 o APP1JPEG rw- Raw JPEG binary data
116 o ART r-- PF1: 1st Publisher
117 o ARW r-- Sony Alpha DSLR RAW
118 o AVS rw+ AVS X image
119 o BIE rw- Joint Bi-level Image experts Group
120 interchange format
121 o BMP rw+ Microsoft Windows bitmap image
122 o BMP2 -w- Microsoft Windows bitmap image v2
123 o BMP3 -w- Microsoft Windows bitmap image v3
124 o CACHE --- Magick Persistent Cache image format
125 o CALS rw- Continuous Acquisition and Life-cycle
126 Support Type 1 image
127 o CAPTION r-- Caption (requires separate size info)
128 o CIN rw- Kodak Cineon Format
129 o CMYK rw- Raw cyan, magenta, yellow, and black
130 samples (8 or 16 bits, depending on
131 the image depth)
132 o CMYKA rw- Raw cyan, magenta, yellow, black, and
133 matte samples (8 or 16 bits, depending
134 on the image depth)
135 o CR2 r-- Canon Photo RAW
136 o CRW r-- Canon Photo RAW
137 o CUR r-- Microsoft Cursor Icon
138 o CUT r-- DR Halo
139 o DCM r-- Digital Imaging and Communications in
140 Medicine image
141 o DCR r-- Kodak Photo RAW
142 o DCX rw+ ZSoft IBM PC multi-page Paintbrush
143 o DNG r-- Adobe Digital Negative
144 o DPS r-- Display PostScript Interpreter
145 o DPX rw- Digital Moving Picture Exchange
146 o EPDF rw- Encapsulated Portable Document Format
147 o EPI rw- Adobe Encapsulated PostScript
148 Interchange format
149 o EPS rw- Adobe Encapsulated PostScript
150 o EPS2 -w- Adobe Level II Encapsulated PostScript
151 o EPS3 -w- Adobe Level III Encapsulated PostScript
152 o EPSF rw- Adobe Encapsulated PostScript
153 o EPSI rw- Adobe Encapsulated PostScript
154 Interchange format
155 o EPT rw- Adobe Encapsulated PostScript with MS-DOS
156 TIFF preview
157 o EPT2 rw- Adobe Level II Encapsulated PostScript
158 with MS-DOS TIFF preview
159 o EPT3 rw- Adobe Level III Encapsulated PostScript
160 with MS-DOS TIFF preview
161 o EXIF rw- Exif digital camera binary data
162 o FAX rw+ Group 3 FAX (Not TIFF Group3 FAX!)
163 o FITS rw- Flexible Image Transport System
164 o FRACTAL r-- Plasma fractal image
165 o FPX rw- FlashPix Format
166 o GIF rw+ CompuServe graphics interchange format
167 o GIF87 rw- CompuServe graphics interchange format
168 (version 87a)
169 o GRADIENT r-- Gradual passing from one shade to
170 another
171 o GRAY rw+ Raw gray samples (8/16/32 bits,
172 depending on the image depth)
173 o HISTOGRAM -w- Histogram of the image
174 o HRZ r-- HRZ: Slow scan TV
175 o HTML -w- Hypertext Markup Language and a
176 client-side image map
177 o ICB rw+ Truevision Targa image
178 o ICC rw- ICC Color Profile
179 o ICM rw- ICC Color Profile
180 o ICO r-- Microsoft icon
181 o ICON r-- Microsoft icon
182 o IDENTITY r-- Hald CLUT identity image
183 o IMAGE r-- GraphicsMagick Embedded Image
184 o INFO -w+ Image descriptive information and
185 statistics
186 o IPTC rw- IPTC Newsphoto
187 o IPTCTEXT rw- IPTC Newsphoto text format
188 o IPTCWTEXT rw- IPTC Newsphoto wide text format
189 o JBG rw+ Joint Bi-level Image experts Group
190 interchange format
191 o JBIG rw+ Joint Bi-level Image experts Group
192 interchange format
193 o JNG rw- JPEG Network Graphics
194 o JP2 rw- JPEG-2000 JP2 File Format Syntax
195 o JPC rw- JPEG-2000 Code Stream Syntax
196 o JPEG rw- Joint Photographic Experts Group
197 JFIF format
198 o JPG rw- Joint Photographic Experts Group
199 JFIF format
200 o K25 r-- Kodak Photo RAW
201 o KDC r-- Kodak Photo RAW
202 o LABEL r-- Text image format
203 o M2V rw+ MPEG-2 Video Stream
204 o MAP rw- Colormap intensities and indices
205 o MAT r-- MATLAB image format
206 o MATTE -w+ MATTE format
207 o MIFF rw+ Magick Image File Format
208 o MNG rw+ Multiple-image Network Graphics
209 o MONO rw- Bi-level bitmap in least-significant-
210 -byte-first order
211 o MPC rw+ Magick Persistent Cache image format
212 o MPEG rw+ MPEG-1 Video Stream
213 o MPG rw+ MPEG-1 Video Stream
214 o MRW r-- Minolta Photo Raw
215 o MSL r-- Magick Scripting Language
216 o MTV rw+ MTV Raytracing image format
217 o MVG rw- Magick Vector Graphics
218 o NEF r-- Nikon Electronic Format
219 o NULL r-- Constant image of uniform color
220 o OTB rw- On-the-air bitmap
221 o P7 rw+ Xv thumbnail format
222 o PAL rw- 16bit/pixel interleaved YUV
223 o PALM rw- Palm Pixmap
224 o PBM rw+ Portable bitmap format (black and white)
225 o PCD rw- Photo CD
226 o PCDS rw- Photo CD
227 o PCL -w- Page Control Language
228 o PCT rw- Apple Macintosh QuickDraw/PICT
229 o PCX rw- ZSoft IBM PC Paintbrush
230 o PDB rw+ Palm Database ImageViewer Format
231 o PDF rw+ Portable Document Format
232 o PEF r-- Pentax Electronic File
233 o PFA r-- TrueType font
234 o PFB r-- TrueType font
235 o PGM rw+ Portable graymap format (gray scale)
236 o PGX r-- JPEG-2000 VM Format
237 o PICON rw- Personal Icon
238 o PICT rw- Apple Macintosh QuickDraw/PICT
239 o PIX r-- Alias/Wavefront RLE image format
240 o PLASMA r-- Plasma fractal image
241 o PNG rw- Portable Network Graphics
242 o PNG24 rw- Portable Network Graphics, 24 bit RGB
243 opaque only
244 o PNG32 rw- Portable Network Graphics, 32 bit RGBA
245 semitransparency OK
246 o PNG8 rw- Portable Network Graphics, 8-bit
247 indexed, binary transparency only
248 o PNM rw+ Portable anymap
249 o PPM rw+ Portable pixmap format (color)
250 o PREVIEW -w- Show a preview an image enhancement,
251 effect, or f/x
252 o PS rw+ Adobe PostScript
253 o PS2 -w+ Adobe Level II PostScript
254 o PS3 -w+ Adobe Level III PostScript
255 o PSD rw- Adobe Photoshop bitmap
256 o PTIF rw- Pyramid encoded TIFF
257 o PWP r-- Seattle Film Works
258 o RAF r-- Fuji Photo RAW
259 o RAS rw+ SUN Rasterfile
260 o RGB rw+ Raw red, green, and blue samples
261 o RGBA rw+ Raw red, green, blue, and matte samples
262 o RLA r-- Alias/Wavefront image
263 o RLE r-- Utah Run length encoded image
264 o SCT r-- Scitex HandShake
265 o SFW r-- Seattle Film Works
266 o SGI rw+ Irix RGB image
267 o SHTML -w- Hypertext Markup Language and a
268 client-side image map
269 o STEGANO r-- Steganographic image
270 o SUN rw+ SUN Rasterfile
271 o SVG rw+ Scalable Vector Gaphics
272 o TEXT rw+ Raw text
273 o TGA rw+ Truevision Targa image
274 o TIFF rw+ Tagged Image File Format
275 o TILE r-- Tile image with a texture
276 o TIM r-- PSX TIM
277 o TOPOL r-- TOPOL X Image
278 o TTF r-- TrueType font
279 o TXT rw+ Raw text
280 o UIL -w- X-Motif UIL table
281 o UYVY rw- 16bit/pixel interleaved YUV
282 o VDA rw+ Truevision Targa image
283 o VICAR rw- VICAR rasterfile format
284 o VID rw+ Visual Image Directory
285 o VIFF rw+ Khoros Visualization image
286 o VST rw+ Truevision Targa image
287 o WBMP rw- Wireless Bitmap (level 0) image
288 o WMF r-- Windows Metafile
289 o WPG r-- Word Perfect Graphics
290 o X rw- X Image
291 o X3F r-- Foveon X3 (Sigma/Polaroid) RAW
292 o XBM rw- X Windows system bitmap (black
293 and white)
294 o XC r-- Constant image uniform color
295 o XCF r-- GIMP image
296 o XMP rw- Adobe XML metadata
297 o XPM rw- X Windows system pixmap (color)
298 o XV rw+ Khoros Visualization image
299 o XWD rw- X Windows system window dump (color)
300 o YUV rw- CCIR 601 4:1:1 or 4:2:2 (8-bit only)
301 Modes:
303 r Read
304 w Write
305 + Multi-image
306 Support for some of these formats require additional programs or
309 libraries. See README in the source package for where to find optional
310 additional software.
311 Note, a format delineated with + means that if more than one image is
313 specified, frames are combined into a single multi-image file. Use
314 +adjoin if you want a single image produced for each frame.
315 Your installation might not support all of the formats in the list. To
317 get an accurate listing of the formats supported by your particular
318 configuration, run "gm convert -list format".
319 Raw images are expected to have one byte per pixel unless gm is com‐
321 piled in 16-bit quantum mode or in 32-bit quantum mode. Here, the raw
322 data is expected to be stored two or four bytes per pixel, respec‐
323 tively, in most-significant-byte-first order. For example, you can
324 tell if gm was compiled in 16-bit mode by typing "gm version" without
325 any options, and looking for "Q:16" in the first line of output.
326
328 By default, the image format is determined by its magic number, i.e.,
329 the first few bytes of the file. To specify a particular image format,
330 precede the filename with an image format name and a colon
331 (i.e.ps:image) or specify the image type as the filename suffix
332 (i.e.image.ps). The magic number takes precedence over the filename
333 suffix and the prefix takes precedence over the magic number and the
334 suffix in input files. When a file is read, its magic number is stored
335 in the "image->magick" string. In output files, the prefix takes
336 precedence over the filename suffix, and the filename suffix takes
337 precedence over the "image->magick" string.
338 To read the "built-in" formats (GRANITE, H, LOGO, NETSCAPE, PLASMA, and
340 ROSE) use a prefix (including the colon) without a filename or suffix.
341 To read the XC format, follow the colon with a color specification. To
342 read the CAPTION format, follow the colon with a text string or with a
343 filename prefixed with the at symbol (@).
344 When you specify X as your image type, the filename has special mean‐
347 ing. It specifies an X window by id, name, or root. If no filename is
348 specified, the window is selected by clicking the mouse in the desired
349 window.
350 Specify input_file as - for standard input, output_file as - for stan‐
352 dard output. If input_file has the extension .Z or .gz, the file is
353 uncompressed with uncompress or gunzip respectively. If output_file
354 has the extension .Z or .gz, the file is compressed using with compress
355 or gzip respectively.
356 Use an optional index enclosed in brackets after an input file name to
358 specify a desired subimage of a multi-resolution image format like
359 Photo CD (e.g. "img0001.pcd[4]") or a range for MPEG images (e.g.
360 "video.mpg[50-75]"). A subimage specification can be disjoint (e.g.
361 "image.tiff[2,7,4]"). For raw images, specify a subimage with a geome‐
362 try (e.g. -size 640x512 "image.rgb[320x256+50+50]"). Surround the
363 image name with quotation marks to prevent your shell from interpreting
364 the square brackets. Single images are written with the filename you
365 specify. However, multi-part images (e.g., a multi-page PostScript doc‐
366 ument with +adjoin specified) may be written with the scene number
367 included as part of the filename. In order to include the scene number
368 in the filename, it is necessary to include a printf-style %d format
369 specification in the file name and use the +adjoin option. For example,
370 image%02d.miff
372 writes files image00.miff, image01.miff, etc. Only a single specifica‐
375 tion is allowed within an output filename. If more than one specifica‐
376 tion is present, it will be ignored. It is best to embed the scene num‐
377 ber in the base part of the file name, not in the extension, because
378 the extension will not be a recognizeable image type.
379 When running a commandline utility, you can prepend an at sign @ to a
381 filename to read a list of image filenames from that file. This is con‐
382 venient in the event you have too many image filenames to fit on the
383 command line.
384
386 Options are processed in command line order. Any option you specify on
387 the command line remains in effect for the set of images that follows,
388 until the set is terminated by the appearance of any option or -noop.
389 Some options only affect the decoding of images and others only the
390 encoding. The latter can appear after the final group of input images.
391 This is a combined list of the command-line options used by the Graph‐
393 icsMagick utilities (animate, compare, composite, convert, display,
394 identify, import, mogrify and montage).
395 In this document, angle brackets ("<>") enclose variables and curly
398 brackets ("{}") enclose optional parameters. For example, "-fuzz <dis‐
399 tance>{%}" means you can use the option "-fuzz 10" or "-fuzz 2%".
400 -adjoin
403 join images into a single multi-image file
404 By default, all images of an image sequence are stored in the
406 same file. However, some formats (e.g. JPEG) do not support
407 storing more than one image per file and only the first frame in
408 an image sequence will be saved unless the result is saved to
409 separate files. Use +adjoin to force saving multiple frames to
410 multiple numbered files. If +adjoin is used, then the output
411 filename must include a printf style formatting specification
412 for the numeric part of the filename. For example,
413 image%02d.miff
415 -affine <matrix>
418 drawing transform matrix
419 This option provides a transform matrix {sx,rx,ry,sy,tx,ty} for
421 use by subsequent -draw or -transform options.
422 -antialias
424 remove pixel aliasing
425 By default antialiasing algorithms are used when drawing objects
427 (e.g. lines) or rendering vector formats (e.g. WMF and Post‐
428 script). Use +antialias to disable use of antialiasing algo‐
429 rithms. Reasons to disable antialiasing include avoiding
430 increasing colors in the image, or improving rendering speed.
431 -append
433 append a set of images
434 This option creates a single image where the images in the orig‐
436 inal set are stacked top-to-bottom. If they are not of the same
437 width, any narrow images will be expanded to fit using the back‐
438 ground color. Use +append to stack images left-to-right. The
439 set of images is terminated by the appearance of any option. If
440 the -append option appears after all of the input images, all
441 images are appended.
442 -asc-cdl <spec>
444 apply ASC CDL color transform
445 Applies ("bakes in") the ASC CDL, which is a format for the
447 exchange of basic primary color grading information between
448 equipment and software from different manufacturers. The format
449 defines the math for three functions: slope, offset and power.
450 Each function uses a number for the red, green, and blue color
451 channels for a total of nine numbers comprising a single color
452 decision. The tenth number (optional) is for chromiance (satura‐
453 tion) as specified by ASC CDL 1.2.
454 The argument string is comma delimited and is in the following
456 form (but without invervening spaces or line breaks)
457 redslope,redoffset,redpower:
459 greenslope,greenoffset,greenpower:
460 blueslope,blueoffset,bluepower:
461 saturation
462 with the unity (no change) specification being:
465 "1.0,0.0,1.0:1.0,0.0,1.0:1.0,0.0,1.0:1.0"
467 -authenticate <string>
470 decrypt image with this password
471 Use this option to supply a password for decrypting an image or
473 an image sequence, if it is being read from a format such as PDF
474 that supports encryption. Encrypting images being written is
475 not supported.
476 -auto-orient
478 orient (rotate) image so it is upright
479 Adjusts the image orienation so that it is suitable for viewing.
481 Uses the orientation tag obtained from the image file or as sup‐
482 plied by the -orient option.
483 -average
485 average a set of images
486 The set of images is terminated by the appearance of any option.
488 If the -average option appears after all of the input images,
489 all images are averaged.
490 -backdrop
492 display the image centered on a backdrop.
493 This backdrop covers the entire workstation screen and is useful
495 for hiding other X window activity while viewing the image. The
496 color of the backdrop is specified as the foreground color (X11
497 default is black). Refer to "X Resources", below, for details.
498 -background <color>
500 the background color
501 The color is specified using the format described under the
503 -fill option.
504 -black-threshold red[,green][,blue][,opacity]
506 pixels below the threshold become black
507 Use -black-threshold to set pixels with values below the speci‐
509 fied threshold to minimum value (black). If only one value is
510 supplied, or the red, green, and blue values are identical, then
511 intensity thresholding is used. If the color threshold values
512 are not identical then channel-based thresholding is used, and
513 color distortion will occur. Specify a negative value (e.g. -1)
514 if you want a channel to be ignored but you do want to threshold
515 a channel later in the list. If a percent (%) symbol is
516 appended, then the values are treated as a percentage of maximum
517 range.
518 -blue-primary <x>,<y>
520 blue chromaticity primary point
521 -blur <radius>{x<sigma>}
523 blur the image with a Gaussian operator
524 Blur with the given radius and standard deviation (sigma).
526 -border <width>x<height>
528 surround the image with a border of color
529 See -geometry for details about the geometry specification.
531 -bordercolor <color>
533 the border color
534 The color is specified using the format described under the
536 -fill option.
537 -borderwidth <geometry>
539 the border width
540 -box <color>
542 set the color of the annotation bounding box
543 The color is specified using the format described under the
545 -fill option.
546 See -draw for further details.
548 -channel <type>
550 the type of channel
551 Choose from: Red, Green, Blue, Opacity, Matte, Cyan, Magenta,
553 Yellow, Black, or Gray.
554 Use this option to extract a particular channel from the image.
556 Opacity, for example, is useful for extracting the opacity val‐
557 ues from an image.
558 -charcoal <factor>
560 simulate a charcoal drawing
561 -chop <width>x<height>{+-}<x>{+-}<y>{%}
563 remove pixels from the interior of an image
564 Width and height give the number of columns and rows to remove,
566 and x and y are offsets that give the location of the leftmost
567 column and topmost row to remove.
568 The x offset normally specifies the leftmost column to remove.
570 If the -gravity option is present with NorthEast, East, or
571 SouthEast gravity, it gives the distance leftward from the right
572 edge of the image to the rightmost column to remove. Similarly,
573 the y offset normally specifies the topmost row to remove, but
574 if the -gravity option is present with SouthWest, South, or
575 SouthEast gravity, it specifies the distance upward from the
576 bottom edge of the image to the bottom row to remove.
577 The -chop option removes entire rows and columns, and moves the
579 remaining corner blocks leftward and upward to close the gaps.
580 -clip apply the clipping path, if one is present
582 If a clipping path is present, it will be applied to subsequent
584 operations.
585 For example, if you type the following command:
587 gm convert -clip -negate cockatoo.tif negated.tif
589 only the pixels within the clipping path are negated.
592 The -clip feature requires the XML library. If the XML library
594 is not present, the option is ignored.
595 -coalesce
597 merge a sequence of images
598 Each image N in the sequence after Image 0 is replaced with the
600 image created by flattening images 0 through N.
601 The set of images is terminated by the appearance of any option.
603 If the -coalesce option appears after all of the input images,
604 all images are coalesced.
605 -colorize <value>
607 colorize the image with the pen color
608 Specify the amount of colorization as a percentage. You can
610 apply separate colorization values to the red, green, and blue
611 channels of the image with a colorization value list delimited
612 with slashes (e.g. 0/0/50).
613 The -colorize option may be used in conjunction with -modulate
615 to produce a nice sepia toned image like:
616 gm convert input.ppm -modulate 115,0,100 \
618 -colorize 7,21,50 output.ppm.
619 -colormap <type>
622 define the colormap type
623 Choose between shared or private.
625 This option only applies when the default X server visual is
627 PseudoColor or GRAYScale. Refer to -visual for more details. By
628 default, a shared colormap is allocated. The image shares colors
629 with other X clients. Some image colors could be approximated,
630 therefore your image may look very different than intended.
631 Choose Private and the image colors appear exactly as they are
632 defined. However, other clients may go technicolor when the
633 image colormap is installed.
634 -colors <value>
636 preferred number of colors in the image
637 The actual number of colors in the image may be less than your
639 request, but never more. Note, this is a color reduction option.
640 Images with less unique colors than specified with this option
641 will have any duplicate or unused colors removed. The ordering
642 of an existing color palette may be altered. When converting an
643 image from color to grayscale, convert the image to the gray
644 colorspace before reducing the number of colors since doing so
645 is most efficient. Refer to <a href="quantize.html">quantize for
646 more details.
647 Note, options -dither, -colorspace, and -treedepth affect the
649 color reduction algorithm.
650 -colorspace <value>
652 the type of colorspace
653 Choices are: CineonLog, CMYK, GRAY, HSL, HWB, OHTA, RGB,
655 Rec601Luma, Rec709Luma, Rec601YCbCr, Rec709YCbCr, Transparent,
656 XYZ, YCbCr, YIQ, YPbPr, or YUV.
657 Color reduction, by default, takes place in the RGB color space.
659 Empirical evidence suggests that distances in color spaces such
660 as YUV or YIQ correspond to perceptual color differences more
661 closely than do distances in RGB space. These color spaces may
662 give better results when color reducing an image. Refer to
663 quantize for more details. Two gray colorspaces are supported.
664 The Rec601Luma space is based on the recommendations for legacy
665 NTSC television (ITU-R BT.601-5). The Rec709Luma space is based
666 on the recommendations for HDTV (Rec. ITU-R BT.709-5) and is
667 suitable for use with computer graphics, and for contemporary
668 CRT displays. The GRAY colorspace currently selects the
669 Rec601Luma colorspace by default for backwards compatibly rea‐
670 sons. This default may be re-considered in the future.
671 Two YCbCr colorspaces are supported. The Rec601YCbCr space is
673 based on the recommendations for legacy NTSC television (ITU-R
674 BT.601-5). The Rec709CbCr space is based on the recommendations
675 for HDTV (Rec. ITU-R BT.709-5) and is suitable for suitable for
676 use with computer graphics, and for contemporary CRT displays.
677 The YCbCr colorspace specification is equivalent toRec601YCbCr.
678 The Transparent color space behaves uniquely in that it pre‐
681 serves the matte channel of the image if it exists.
682 The -colors or -monochrome option, or saving to a file format
684 which requires color reduction, is required for this option to
685 take effect.
686 -comment <string>
688 annotate an image with a comment
689 Use this option to assign a specific comment to the image, when
691 writing to an image format that supports comments. You can
692 include the image filename, type, width, height, or other image
693 attribute by embedding special format characters listed under
694 the -format option. The comment is not drawn on the image, but
695 is embedded in the image datastream via a "Comment" tag or simi‐
696 lar mechanism. If you want the comment to be visible on the
697 image itself, use the -draw option instead.
698 For example,
700 -comment "%m:%f %wx%h"
702 produces an image comment of MIFF:bird.miff 512x480 for an image
705 titled bird.miff and whose width is 512 and height is 480.
706 If the first character of string is @, the image comment is read
708 from a file titled by the remaining characters in the string.
709 Please note that if the string comes from an untrusted source
710 that it should be sanitized before use since otherwise the con‐
711 tent of an arbitrary readable file could be incorporated in a
712 comment in the output file (a security risk).
713 If the -comment option appears multiple times, only the last
715 comment is stored.
716 In PNG images, the comment is stored in a tEXt or zTXt chunk
718 with the keyword "comment".
719 -compose <operator>
721 the type of image composition
722 The description of composition uses abstract terminology in
724 order to allow the the description to be more clear, while
725 avoiding constant values which are specific to a particular
726 build configuration. Each image pixel is represented by red,
727 green, and blue levels (which are equal for a gray pixel).
728 MaxRGB is the maximum integral value which may be stored in the
729 red, green, or blue channels of the image. Each image pixel may
730 also optionally (if the image matte channel is enabled) have an
731 associated level of opacity (ranging from opaque to transpar‐
732 ent), which may be used to determine the influence of the pixel
733 color when compositing the pixel with another image pixel. If
734 the image matte channel is disabled, then all pixels in the
735 image are treated as opaque. The color of an opaque pixel is
736 fully visible while the color of a transparent pixel color is
737 entirely absent (pixel color is ignored).
738 By definition, raster images have a rectangular shape. All image
740 rows are of equal length, and all image columns have the same
741 number of rows. By treating the opacity channel as a visual
742 "mask" the rectangular image may be given a "shape" by treating
743 the opacity channel as a cookie-cutter for the image. Pixels
744 within the shape are opaque, while pixels outside the shape are
745 transparent. Pixels on the boundary of the shape may be between
746 opaque and transparent in order to provide antialiasing (visual‐
747 ly smooth edges). The description of the composition operators
748 use this concept of image "shape" in order to make the descrip‐
749 tion of the operators easier to understand. While it is conve‐
750 nient to describe the operators in terms of "shapes" they are by
751 no means limited to mask-style operations since they are based
752 on continuous floating-point mathematics rather than simple
753 boolean operations.
754 By default, the Over composite operator is used. The following
756 composite operators are available:
757 Over
759 In
760 Out
761 Atop
762 Xor
763 Plus
764 Minus
765 Add
766 Subtract
767 Difference
768 Divide
769 Multiply
770 Bumpmap
771 Copy
772 CopyRed
773 CopyGreen
774 CopyBlue
775 CopyOpacity
776 CopyCyan
777 CopyMagenta
778 CopyYellow
779 CopyBlack
780 The behavior of each operator is described below.
783 Over
786 The result will be the union of the two image shapes, with
788 opaque areas of change-image obscuring base-image in the
789 region of overlap.
790 In
792 The result is simply change-image cut by the shape of
794 base-image. None of the image data of base-image will be
795 in the result.
796 Out
798 The resulting image is change-image with the shape of
800 base-image cut out.
801 Atop
803 The result is the same shape as base-image, with change-
805 image obscuring base-image where the image shapes overlap.
806 Note this differs from over because the portion of change-
807 image outside base-image's shape does not appear in the
808 result.
809 Xor
811 The result is the image data from both change-image and
813 base-image that is outside the overlap region. The overlap
814 region will be blank.
815 Plus
817 The result is just the sum of the image data. Output val‐
819 ues are cropped to MaxRGB (no overflow). This operation is
820 independent of the matte channels.
821 Minus
823 The result of change-image - base-image, with underflow
825 cropped to zero. The matte channel is ignored (set to
826 opaque, full coverage).
827 Add
829 The result of change-image + base-image, with overflow
831 wrapping around (mod MaxRGB+1).
832 Subtract
834 The result of change-image - base-image, with underflow
836 wrapping around (mod MaxRGB+1). The add and subtract oper‐
837 ators can be used to perform reversible transformations.
838 Difference
840 The result of abs(change-image - base-image). This is use‐
842 ful for comparing two very similar images.
843 Divide
845 The result of change-image / base-image. This is useful
847 for improving the readability of text on unevenly illumi‐
848 nated photos (by using a gaussian blurred copy of change-
849 image as base-image).
850 Multiply
852 The result of change-image * base-image. This is useful
854 for the creation of drop-shadows.
855 Bumpmap
857 The result base-image shaded by change-image.
859 Copy
861 The resulting image is base-image replaced with change-
863 image. Here the matte information is ignored.
864 CopyRed
866 The resulting image is the red channel in base-image
868 replaced with the red channel in change-image. The other
869 channels are copied untouched.
870 CopyGreen
872 The resulting image is the green channel in base-image
874 replaced with the green channel in change-image. The other
875 channels are copied untouched.
876 CopyBlue
878 The resulting image is the blue channel in base-image
880 replaced with the blue channel in change-image. The other
881 channels are copied untouched.
882 CopyOpacity
884 The resulting image is the opacity channel in base-image
886 replaced with the opacity channel in change-image. The
887 other channels are copied untouched.
888 CopyCyan
890 The resulting image is the cyan channel in base-image
892 replaced with the cyan channel in change-image. The other
893 channels are copied untouched. Use of this operator
894 requires that base-image be in CMYK(A) colorspace.
895 CopyMagenta
897 The resulting image is the magenta channel in base-image
899 replaced with the magenta channel in change-image. The
900 other channels are copied untouched. Use of this operator
901 requires that base-image be in CMYK(A) colorspace.
902 CopyYellow
904 The resulting image is the yellow channel in base-image
906 replaced with the yellow channel in change-image. The
907 other channels are copied untouched. Use of this operator
908 requires that base-image be in CMYK(A) colorspace.
909 CopyBlack
911 The resulting image is the black channel in base-image
913 replaced with the black channel in change-image. The other
914 channels are copied untouched. Use of this operator
915 requires that base-image be in CMYK(A) colorspace. If
916 change-image is not in CMYK space, then the change-image
917 pixel intensities are used.
918 -compress <type>
923 the type of image compression
924 Choices are: None, BZip, Fax, Group3, Group4, JPEG, Lossless,
926 LZW, RLE, Zip, LZMA, JPEG2000, JPEG2000, JBIG, JBIG2, WebP, or
927 ZSTD.
928 Specify +compress to store the binary image in an uncompressed
931 format. The default is the compression type of the specified
932 image file.
933 "Lossless" refers to lossless JPEG, which is only available if
935 the JPEG library has been patched to support it. Use of lossless
936 JPEG is generally not recommended.
937 Use the -quality option to set the compression level to be used
939 by the JPEG, JPEG-2000, PNG, MIFF, MPEG, and TIFF encoders. Use
940 the -sampling-factor option to set the sampling factor to be
941 used by the DPX, JPEG, MPEG, and YUV encoders for downsampling
942 the chroma channels.
943 -contrast
945 enhance or reduce the image contrast
946 This option enhances the intensity differences between the
948 lighter and darker elements of the image. Use -contrast to
949 enhance the image or +contrast to reduce the image contrast.
950 For a more pronounced effect you can repeat the option:
953 gm convert rose: -contrast -contrast rose_c2.png
955 -convolve <kernel>
958 convolve image with the specified convolution kernel
959 The kernel is specified as a comma-separated list of floating
961 point values, ordered left-to right, starting with the top row.
962 The order of the kernel is determined by the square root of the
963 number of entries. Presently only square kernels are supported.
964 -create-directories
966 create output directory if required
967 Use this option with -output-directory if the input paths con‐
969 tain subdirectories and it is desired to create similar subdi‐
970 rectories in the output directory. Without this option, mogrify
971 will fail if the required output directory does not exist.
972 -crop <width>x<height>{+-}<x>{+-}<y>{%}
974 preferred size and location of the cropped image
975 See -geometry for details about the geometry specification.
977 The width and height give the size of the image that remains
979 after cropping, and x and y are offsets that give the location
980 of the top left corner of the cropped image with respect to the
981 original image. To specify the amount to be removed, use -shave
982 instead.
983 If the x and y offsets are present, a single image is generated,
985 consisting of the pixels from the cropping region. The offsets
986 specify the location of the upper left corner of the cropping
987 region measured downward and rightward with respect to the upper
988 left corner of the image. If the -gravity option is present
989 with NorthEast, East, or SouthEast gravity, it gives the dis‐
990 tance leftward from the right edge of the image to the right
991 edge of the cropping region. Similarly, if the -gravity option
992 is present with SouthWest, South, or SouthEast gravity, the dis‐
993 tance is measured upward between the bottom edges.
994 If the x and y offsets are omitted, a set of tiles of the speci‐
996 fied geometry, covering the entire input image, is generated.
997 The rightmost tiles and the bottom tiles are smaller if the
998 specified geometry extends beyond the dimensions of the input
999 image.
1000 -cycle <amount>
1002 displace image colormap by amount
1003 Amount defines the number of positions each colormap entry
1005 isshifted.
1006 -debug <events>
1009 enable debug printout
1010 The events parameter specifies which events are to be logged.
1012 It can be either None, All, or a comma-separated list consisting
1013 of one or more of the following domains: Annotate, Blob, Cache,
1014 Coder, Configure, Deprecate, Error, Exception, FatalError,
1015 Information, Locale, Option, Render, Resource, TemporaryFile,
1016 Transform, User. Warning, or X11, For example, to log cache and
1017 blob events, use
1018 gm convert -debug "Cache,Blob" rose: rose.png
1020 The "User" domain is normally empty, but developers can log
1023 "User" events in their private copy of GraphicsMagick.
1024 Use the -log option to specify the format for debugging output.
1026 Use +debug to turn off all logging.
1028 An alternative to using -debug is to use the MAGICK_DEBUG envi‐
1030 ronment variable. The allowed values for the MAGICK_DEBUG envi‐
1031 ronment variable are the same as for the -debug option.
1032 -deconstruct
1034 break down an image sequence into constituent parts
1035 This option compares each image with the next in a sequence and
1037 returns the maximum bounding region of any pixel differences it
1038 discovers. This method can undo a coalesced sequence returned
1039 by the -coalesce option, and is useful for removing redundant
1040 information from a GIF or MNG animation.
1041 The sequence of images is terminated by the appearance of any
1043 option. If the -deconstruct option appears after all of the
1044 input images, all images are deconstructed.
1045 -define <key>{=<value>},...
1047 add coder/decoder specific options This option creates one or
1048 more definitions for coders and decoders to use while reading
1049 and writing image data. Definitions may be passed to coders and
1050 decoders to control options that are specific to certain image
1051 formats. If value is missing for a definition, an empty-valued
1052 definition of a flag will be created with that name. This is
1053 used to control on/off options. Use +define <key>,... to remove
1054 definitions previously created. Use +define "*" to remove all
1055 existing definitions.
1056 The following definitions may be created:
1058 cineon:colorspace={rgb|cineonlog}
1061 Use the cineon:colorspace option when reading a Cineon
1063 file to specify the colorspace the Cineon file uses. This
1064 overrides the colorspace type implied by the DPX header
1065 (if any).
1066 dpx:bits-per-sample=<value>
1068 If the dpx:bits-per-sample key is defined, GraphicsMagick
1070 will write DPX images with the specified bits per sample,
1071 overriding any existing depth value. If this option is not
1072 specified, then the value is based on the existing image
1073 depth value from the original image file. The DPX standard
1074 supports bits per sample values of 1, 8, 10, 12, and 16.
1075 Many DPX readers demand a sample size of 10 bits with type
1076 A padding (see below).
1077 dpx:colorspace={rgb|cineonlog}
1079 Use the dpx:colorspace option when reading a DPX file to
1081 specify the colorspace the DPX file uses. This overrides
1082 the colorspace type implied by the DPX header (if any).
1083 dpx:packing-method={packed|a|b|lsbpad|msbpad}
1085 DPX samples are output within 32-bit words. They may be
1087 tightly packed end-to-end within the words ("packed"),
1088 padded with null bits to the right of the sample ("a" or
1089 "lsbpad"), or padded with null bits to the left of the
1090 sample ("b" or "msbpad"). This option only has an effect
1091 for sample sizes of 10 or 12 bits. If samples are not
1092 packed, the DPX standard recommends type A padding. Many
1093 DPX readers demand a sample size of 10 bits with type A
1094 padding.
1095 dpx:pixel-endian={lsb|msb}
1097 Allows the user to specify the endian order of the pixels
1099 when reading or writing the DPX files. Sometimes this is
1100 useful if the file is (or must be) written incorrectly so
1101 that the file header and the pixels use different endian‐
1102 ness.
1103 dpx:swap-samples={true|false}
1105 GraphicsMagick strives to adhere to the DPX standard but
1107 certain aspects of the standard can be quite confusing. As
1108 a result, some 10-bit DPX files have Red and Blue inter‐
1109 changed, or Cb and Cr interchanged due to an different
1110 interpretation of the standard, or getting the wires
1111 crossed. The swap-samples option may be supplied when
1112 reading or writing in order to read or write using the
1113 necessary sample order.
1114 jp2:rate=<value>
1116 Specify the compression factor to use while writing
1118 JPEG-2000 files. The compression factor is the reciprocal
1119 of the compression ratio. The valid range is 0.0 to 1.0,
1120 with 1.0 indicating lossless compression. If defined, this
1121 value overrides the -quality setting. The default quality
1122 setting of 75 results in a rate value of 0.06641.
1123 jpeg:block-smoothing={true|false}
1125 Enables or disables block smoothing when reading a JPEG
1127 file (default enabled).
1128 jpeg:dct-method=<value>
1130 Selects the IJG JPEG library DCT implementation to use.
1132 The encoding implementations vary in speed and encoding
1133 error. The available choices for value are islow, ifast,
1134 float, default and fastest. Note that fastest might not
1135 necessarily be fastest on your CPU, depending on the
1136 choices made when the JPEG library was built and how your
1137 CPU behaves.
1138 jpeg:fancy-upsampling={true|false}
1140 Enables or disables fancy upsampling when reading a JPEG
1142 file (default enabled).
1143 jpeg:max-scan-number=<value>
1145 Specifies an integer value for the maximum number of pro‐
1147 gressive scans allowed in a JPEG file. The default maxi‐
1148 mum is 100 scans. This limit is imposed due to a weakness
1149 in the JPEG standard which allows small JPEG files to take
1150 many minutes or hours to be read.
1151 jpeg:max-warnings=<value>
1153 Specifies an integer value for how many warnings are
1155 allowed for any given error type before being promoted to
1156 a hard error. JPEG files producing excessive warnings
1157 indicate a problem with the file.
1158 jpeg:optimize-coding={true|false}
1160 Selects if huffman encoding should be used. Huffman encod‐
1162 ing is enabled by default, but may be disabled for very
1163 large images since it encoding requires that the entire
1164 image be buffered in memory. Huffman encoding produces
1165 smaller JPEG files at the expense of added compression
1166 time and memory consumption.
1167 jpeg:preserve-settings
1169 If the jpeg:preserve-settings flag is defined, the JPEG
1171 encoder will use the same "quality" and "sampling-factor"
1172 settings that were found in the input file, if the input
1173 was in JPEG format. These settings are also preserved if
1174 the input is a JPEG file and the output is a JNG file. If
1175 the colorspace of the output file differs from that of the
1176 input file, the quality setting is preserved but the sam‐
1177 pling-factors are not.
1178 pcl:fit-to-page
1180 If the pcl:fit-to-page flag is defined, then the printer
1182 is requested to scale the image to fit the page size
1183 (width and/or height).
1184 mng:maximum-loops=<value>
1185 mng:maximum-loops specifies the maximum number of loops
1187 allowed to be specified by a MNG LOOP chunk. Without an
1188 imposed limit, a MNG file could request up to 2147483647
1189 loops, which could run for a very long time. The current
1190 default limit is 512 loops.
1191 pdf:use-cropbox={true|false}
1193 If the pdf:use-cropbox flag is set to true, then Ghost‐
1195 script is requested to apply the PDF crop box.
1196 pdf:stop-on-error={true|false}
1198 If the pdf:stop-on-error flag is set to true, then Ghost‐
1200 script is requested to stop processing the PDF when the
1201 first error is encountered. Otherwise it will attempt to
1202 process all requested pages.
1203 ps:imagemask
1205 If the ps:imagemask flag is defined, the PS3 and EPS3
1207 coders will create Postscript files that render bilevel
1208 images with the Postscript imagemask operator instead of
1209 the image operator.
1210 ptif:minimum-geometry=<geometry>
1212 If the ptif:minimum-geometry key is defined, GraphicsMag‐
1214 ick will use it to determine the minimum frame size to
1215 output when writing a pyramid TIFF file (a TIFF file con‐
1216 taining a succession of reduced versions of the first
1217 frame). The default minimum geometry is 32x32.
1218 tiff:alpha={unspecified|associated|unassociated}
1220 Specify the TIFF alpha channel type when reading or writ‐
1222 ing TIFF files, overriding the normal value. The default
1223 alpha channel type for new files is unspecified alpha.
1224 Existing alpha settings are preserved when converting from
1225 one TIFF file to another. When a TIFF file uses associated
1226 alpha, the image pixels are pre-multiplied (i.e. altered)
1227 with the alpha channel. Files with "associated" alpha
1228 appear as if they were alpha composited on a black back‐
1229 ground when the matte channel is disabled. If the unasso‐
1230 ciated alpha type is selected, then the alpha channel is
1231 saved without altering the pixels. Photoshop recognizes
1232 associated alpha as transparency information, if the file
1233 is saved with unassociated alpha, the alpha information is
1234 loaded as an independent channel. Note that for many
1235 years, ImageMagick and GraphicsMagick marked TIFF files as
1236 using associated alpha, without properly pre-multiplying
1237 the pixels.
1238 tiff:fill-order={msb2lsb|lsb2msb}
1240 If the tiff:fill-order key is defined, GraphicsMagick will
1242 use it to determine the bit fill order used while writing
1243 TIFF files. The normal default is "msb2lsb", which matches
1244 the native bit order of all modern CPUs. The only excep‐
1245 tion to this is when Group3 or Group4 FAX compression is
1246 requested since FAX machines send data in bit-reversed
1247 order and therefore RFC 2301 recommends using reverse
1248 order.
1249 tiff:group-three-options=<value>
1251 If the tiff:group-three-options key is defined, Graphics‐
1253 Magick will use it to set the group3 options tag when
1254 writing group3-compressed TIFF. Please see the TIFF spec‐
1255 ification for the usage of this tag. The default value is
1256 4.
1257 tiff:ignore-tags=<tags>
1259 If the tiff:ignore-tags key is defined, then it is used as
1261 a list of comma-delimited integer TIFF tag values to
1262 ignore while reading the TIFF file. This is useful in
1263 order to be able to read files which which otherwise fail
1264 to read due to problems with TIFF tags. Note that some
1265 TIFF tags are required in order to be able to read the
1266 image data at all.
1267 tiff:report-warnings={false|true}
1269 If the tiff:report-warnings key is defined and set to
1271 true, then TIFF warnings are reported as a warning excep‐
1272 tion rather than as a coder log message. Such warnings
1273 are reported after the image has been read or written.
1274 Most TIFF warnings are benign but sometimes they may help
1275 deduce problems with the TIFF file, or help detect that
1276 the TIFF file requires a special application to read suc‐
1277 cessfully due to the use of proprietary or specialized
1278 extensions.
1279 tiff:sample-format={unsigned|ieeefp}
1281 If the tiff:sample-format key is defined, GraphicsMagick
1283 will use it to determine the sample format used while
1284 writing TIFF files. The default is "unsigned". Specify
1285 "ieeefp" in order to write floating-point TIFF files with
1286 float (32-bit) or double (64-bit) values. Use the
1287 tiff:bits-per-sample define to determine the type of
1288 floating-point value to use.
1289 tiff:max-sample-value=<value>
1291 If the tiff:max-sample-value key is defined, GraphicsMag‐
1293 ick will use the assigned value as the maximum floating
1294 point value while reading or writing IEEE floating point
1295 TIFFs. Otherwise the maximum value is 1.0 or the value
1296 obtained from the file's SMaxSampleValue tag (if present).
1297 The floating point data is currently not scanned in
1298 advance to determine a best maximum sample value so if the
1299 range is not 1.0, or the SMaxSampleValue tag is not
1300 present, it may be necessary to (intelligently) use this
1301 parameter to properly read a file.
1302 tiff:min-sample-value=<value>
1304 If the tiff:min-sample-value key is defined, GraphicsMag‐
1306 ick will use the assigned value as the minimum floating
1307 point value while reading or writing IEEE floating point
1308 TIFFs. Otherwise the minimum value is 0.0 or the value
1309 obtained from the file's SMinSampleValue tag (if present).
1310 tiff:bits-per-sample=<value>
1312 If the tiff:bits-per-sample key is defined, GraphicsMagick
1314 will write images with the specified bits per sample,
1315 overriding any existing depth value. Value may be any in
1316 the range of 1 to 32, or 64 when the default ´unsigned'
1317 format is written, or 16/32/24/64 if IEEEFP format is
1318 written. Please note that the baseline TIFF 6.0 specifi‐
1319 cation only requires readers to handle certain powers of
1320 two, and the values to be handled depend on the nature of
1321 the image (e.g. colormapped, grayscale, RGB, CMYK).
1322 tiff:samples-per-pixel=<value>
1324 If the tiff:samples-per-pixel key is defined to a value,
1326 the TIFF coder will write TIFF images with the defined
1327 samples per pixel, overriding any value stored in the
1328 image. This option should not normally be used.
1329 tiff:rows-per-strip=<value>
1331 Allows the user to specify the number of rows per TIFF
1333 strip. Rounded up to a multiple of 16 when using JPEG
1334 compression. Ignored when using tiles.
1335 tiff:strip-per-page=true
1337 Requests that the image is written in a single TIFF strip.
1339 This is normally the default when group3 or group4 com‐
1340 pression is requested within reasonable limits. Requesting
1341 a single strip for large images may result in failure due
1342 to resource consumption in the writer or reader.
1343 tiff:tile
1345 Enable writing tiled TIFF (rather than stripped) using the
1347 default tile size. Tiled TIFF organizes the image as an
1348 array of smaller images (tiles) in order to enable random
1349 access.
1350 tiff:tile-geometry=<width>x<height>
1352 Specify the tile size to use while writing tiled TIFF.
1354 Width and height should be a multiple of 16. If the value
1355 is not a multiple of 16, then it will be rounded down.
1356 Enables tiled TIFF if it has not already been enabled.
1357 GraphicsMagick does not use tiled storage internally so
1358 tiles need to be converted back and forth from the inter‐
1359 nal scanline-oriented storage to tile-oriented storage.
1360 Testing with typical RGB images shows that useful square
1361 tile size values range from 128x128 to 1024x1024. Large
1362 images which require using a disk-based pixel cache bene‐
1363 fit from large tile sizes while images which fit in memory
1364 work well with smaller tile sizes.
1365 tiff:tile-width=<width>
1367 Specify the tile width to use while writing tiled TIFF.
1369 The tile height is then defaulted to an appropriate size.
1370 Width should be a multiple of 16. If the value is not a
1371 multiple of 16, then it will be rounded down. Enables
1372 tiled TIFF if it has not already been enabled.
1373 tiff:tile-height=<height>
1375 Specify the tile height to use while writing tiled TIFF.
1377 The tile width is then defaulted to an appropriate size.
1378 Height should be a multiple of 16. If the value is not a
1379 multiple of 16, then it will be rounded down. Enables
1380 tiled TIFF if it has not already been enabled.
1381 tiff:webp-lossless={TRUE|FALSE}
1383 Specify a value of TRUE to enable lossless mode while
1385 writing WebP-compressed TIFF files. The WebP webp:lossless
1386 option may also be used. The quality factor set by the
1387 -quality option may be used to influence the level of
1388 effort expended while compressing.
1389 tiff:zstd-compress-level=<value>
1391 Specify the compression level to use while writing Zstd-
1393 compressed TIFF files. The valid range is 1 to 22. If this
1394 define is not specified, then the 'quality' value is used
1395 such that the default quality setting of 75 is translated
1396 to a compress level of 9 such that ´quality' has a useful
1397 range of 10-184 if used for this purpose.
1398 webp:lossless={true|false}
1400 Enable lossless encoding.
1402 webp:method={0-6}
1404 Quality/speed trade-off.
1406 webp:image-hint={default,graph,photo,picture}
1408 Hint for image type.
1410 webp:target-size=<integer>
1412 Target size in bytes.
1414 webp:target-psnr=<float>
1416 Minimal distortion to try to achieve.
1418 webp:segments={1-4}
1420 Maximum number of segments to use.
1422 webp:sns-strength={0-100}
1424 Spatial Noise Shaping.
1426 webp:filter-strength={0-100}
1428 Filter strength.
1430 webp:filter-sharpness={0-7}
1432 Filter sharpness.
1434 webp:filter-type={0,1}
1436 Filtering type. 0 = simple, 1 = strong (only used if fil‐
1438 ter-strength > 0 or autofilter is enabled).
1439 webp:auto-filter={true|false}
1441 Auto adjust filter's strength.
1443 webp:alpha-compression=<integer>
1445 Algorithm for encoding the alpha plane (0 = none, 1 = com‐
1447 pressed with WebP lossless). Default is 1.
1448 webp:alpha-filtering=<integer>
1450 Predictive filtering method for alpha plane. 0: none, 1:
1452 fast, 2: best. Default is 1.
1453 webp:alpha-quality={0-100}
1455 Between 0 (smallest size) and 100 (lossless). Default is
1457 100.
1458 webp:pass=[1..10]
1460 Number of entropy-analysis passes.
1462 webp:show-compressed={true|false}
1464 Export the compressed picture back. In-loop filtering is
1466 not applied.
1467 webp:preprocessing=[0,1,2]
1469 0=none, 1=segment-smooth, 2=pseudo-random dithering
1471 webp:partitions=[0-3]
1473 log2(number of token partitions) in [0..3]. Default is 0
1475 for easier progressive decoding.
1476 webp:partition-limit={0-100}
1478 Quality degradation allowed to fit the 512k limit on pre‐
1480 diction modes coding (0: no degradation, 100: maximum pos‐
1481 sible degradation).
1482 webp:emulate-jpeg-size={true|false}
1484 If true, compression parameters will be remapped to better
1486 match the expected output size from JPEG compression. Gen‐
1487 erally, the output size will be similar but the degrada‐
1488 tion will be lower.
1489 webp:thread-level=<integer>
1491 If non-zero, try and use multi-threaded encoding.
1493 webp:low-memory={true|false}
1495 If set, reduce memory usage (but increase CPU use)
1497 webp:use-sharp-yuv={true|false}
1499 If set, if needed, use sharp (and slow) RGB->YUV conver‐
1501 sion
1502 For example, to create a postscript file that will render only
1507 the black pixels of a bilevel image, use:
1508 gm convert bilevel.tif -define ps:imagemask eps3:stencil.ps
1510 -delay <1/100ths of a second>
1513 display the next image after pausing
1514 This option is useful for regulating the animation of image
1516 sequences Delay/100 seconds must expire before the display of
1517 the next image. The default is no delay between each showing of
1518 the image sequence. The maximum delay is 65535.
1519 You can specify a delay range (e.g. -delay 10-500) which sets
1521 the minimum and maximum delay.
1522 -density <width>x<height>
1524 horizontal and vertical resolution in pixels of the image This
1525 option specifies the image resolution to store while encoding a
1526 raster image or the canvas resolution while rendering (reading)
1527 vector formats such as Postscript, PDF, WMF, and SVG into a
1528 raster image. Image resolution provides the unit of measure to
1529 apply when rendering to an output device or raster image. The
1530 default unit of measure is in dots per inch (DPI). The -units
1531 option may be used to select dots per centimeter instead.
1532 The default resolution is 72 dots per inch, which is equivalent
1533 to one point per pixel (Macintosh and Postscript standard). Com‐
1534 puter screens are normally 72 or 96 dots per inch while printers
1535 typically support 150, 300, 600, or 1200 dots per inch. To
1536 determine the resolution of your display, use a ruler to measure
1537 the width of your screen in inches, and divide by the number of
1538 horizontal pixels (1024 on a 1024x768 display). If the file
1539 format supports it, this option may be used to update the stored
1540 image resolution. Note that Photoshop stores and obtains image
1541 resolution from a proprietary embedded profile. If this profile
1542 is not stripped from the image, then Photoshop will continue to
1543 treat the image using its former resolution, ignoring the image
1544 resolution specified in the standard file header. The density
1545 option is an attribute and does not alter the underlying raster
1546 image. It may be used to adjust the rendered size for desktop
1547 publishing purposes by adjusting the scale applied to the pix‐
1548 els. To resize the image so that it is the same size at a dif‐
1549 ferent resolution, use the -resample option.
1550 -depth <value>
1552 depth of the image
1553 This is the number of bits of color to preserve in the image.
1555 Any value between 1 and QuantumDepth (build option) may be spec‐
1556 ified, although 8 or 16 are the most common values. Use this
1557 option to specify the depth of raw images whose depth is unknown
1558 such as GRAY, RGB, or CMYK, or to change the depth of any image
1559 after it has been read. The depth option is applied to the pix‐
1560 els immediately so it may be used as a form of simple compres‐
1561 sion by discarding the least significant bits. Reducing the
1562 depth in advance may speed up color quantization, and help cre‐
1563 ate smaller file sizes when using a compression algorithm like
1564 LZW or ZIP.
1565 -descend
1567 obtain image by descending window hierarchy
1568 -despeckle
1570 reduce the speckles within an image
1571 -displace <horizontal scale>x<vertical scale>
1573 shift image pixels as defined by a displacement map
1574 With this option, composite image is used as a displacement map.
1576 Black, within the displacement map, is a maximum positive dis‐
1577 placement. White is a maximum negative displacement and middle
1578 gray is neutral. The displacement is scaled to determine the
1579 pixel shift. By default, the displacement applies in both the
1580 horizontal and vertical directions. However, if you specify
1581 mask, composite image is the horizontal X displacement and mask
1582 the vertical Y displacement.
1583 -display <host:display[.screen]>
1585 specifies the X server to contact
1586 This option is used with convert for obtaining image or font
1588 from this X server. See X(1).
1589 -dispose <method>
1591 GIF disposal method
1592 The Disposal Method indicates the way in which the graphic is to
1594 be treated after being displayed.
1595 Here are the valid methods:
1597 Undefined No disposal specified.
1599 None Do not dispose between frames.
1600 Background Overwrite the image area with
1601 the background color.
1602 Previous Overwrite the image area with
1603 what was there prior to rendering
1604 the image.
1605 -dissolve <percent>
1608 dissolve an image into another by the given percent
1609 The opacity of the composite image is multiplied by the given
1611 percent, then it is composited over the main image.
1612 -dither
1614 apply Floyd/Steinberg error diffusion to the image
1615 The basic strategy of dithering is to trade intensity resolution
1617 for spatial resolution by averaging the intensities of several
1618 neighboring pixels. Images which suffer from severe contouring
1619 when reducing colors can be improved with this option.
1620 The -colors or -monochrome option is required for this option to
1622 take effect.
1623 Use +dither to turn off dithering and to render PostScript with‐
1625 out text or graphic aliasing. Disabling dithering often (but not
1626 always) leads to decreased processing time.
1627 -draw <string>
1629 annotate an image with one or more graphic primitives
1630 Use this option to annotate an image with one or more graphic
1632 primitives. The primitives include shapes, text, transforma‐
1633 tions, and pixel operations. The shape primitives are
1634 point x,y
1636 line x0,y0 x1,y1
1637 rectangle x0,y0 x1,y1
1638 roundRectangle x0,y0 x1,y1 wc,hc
1639 arc x0,y0 x1,y1 a0,a1
1640 ellipse x0,y0 rx,ry a0,a1
1641 circle x0,y0 x1,y1
1642 polyline x0,y0 ... xn,yn
1643 polygon x0,y0 ... xn,yn
1644 Bezier x0,y0 ... xn,yn
1645 path path specification
1646 image operator x0,y0 w,h filename
1647 The text primitive is
1650 text x0,y0 string
1652 The text gravity primitive is
1655 gravity NorthWest, North, NorthEast, West, Center,
1657 East, SouthWest, South, or SouthEast
1658 The text gravity primitive only affects the placement of text
1661 and does not interact with the other primitives. It is equiva‐
1662 lent to using the -gravity commandline option, except that it is
1663 limited in scope to the -draw option in which it appears.
1664 The transformation primitives are
1666 rotate degrees
1668 translate dx,dy
1669 scale sx,sy
1670 skewX degrees
1671 skewY degrees
1672 The pixel operation primitives are
1675 color x0,y0 method
1677 matte x0,y0 method
1678 The shape primitives are drawn in the color specified in the
1681 preceding -stroke option. Except for the line and point primi‐
1682 tives, they are filled with the color specified in the preceding
1683 -fill option. For unfilled shapes, use -fill none.
1684 Point requires a single coordinate.
1686 Line requires a start and end coordinate.
1688 Rectangle expects an upper left and lower right coordinate.
1690 RoundRectangle has the upper left and lower right coordinates
1692 and the width and height of the corners.
1693 Circle has a center coordinate and a coordinate for the outer
1695 edge.
1696 Use Arc to inscribe an elliptical arc within a rectangle. Arcs
1698 require a start and end point as well as the degree of rotation
1699 (e.g. 130,30 200,100 45,90).
1700 Use Ellipse to draw a partial ellipse centered at the given
1702 point with the x-axis and y-axis radius and start and end of arc
1703 in degrees (e.g. 100,100 100,150 0,360).
1704 Finally, polyline and polygon require three or more coordinates
1706 to define its boundaries. Coordinates are integers separated by
1707 an optional comma. For example, to define a circle centered at
1708 100,100 that extends to 150,150 use:
1709 -draw 'circle 100,100 150,150'
1711 Paths (See Paths) represent an outline of an object which is
1714 defined in terms of moveto (set a new current point), lineto
1715 (draw a straight line), curveto (draw a curve using a cubic
1716 Bezier), arc (elliptical or circular arc) and closepath (close
1717 the current shape by drawing a line to the last moveto) ele‐
1718 ments. Compound paths (i.e., a path with subpaths, each consist‐
1719 ing of a single moveto followed by one or more line or curve
1720 operations) are possible to allow effects such as "donut holes"
1721 in objects.
1722 Use image to composite an image with another image. Follow the
1724 image keyword with the composite operator, image location, image
1725 size, and filename:
1726 -draw 'image Over 100,100 225,225 image.jpg'
1728 You can use 0,0 for the image size, which means to use the
1731 actual dimensions found in the image header. Otherwise, it will
1732 be scaled to the given dimensions. See -compose for a descrip‐
1733 tion of the composite operators.
1734 Use text to annotate an image with text. Follow the text coordi‐
1736 nates with a string. If the string has embedded spaces, enclose
1737 it in single or double quotes. Optionally you can include the
1738 image filename, type, width, height, or other image attribute by
1739 embedding special format character. See -comment for details.
1740 For example,
1742 -draw 'text 100,100 "%m:%f %wx%h"'
1745 annotates the image with MIFF:bird.miff 512x480 for an image
1748 titled bird.miff and whose width is 512 and height is 480.
1749 If the first character of string is @, the text is read from a
1751 file titled by the remaining characters in the string. Please
1752 note that if the string comes from an untrusted source that it
1753 should be sanitized before use (a security risk).
1754 Rotate rotates subsequent shape primitives and text primitives
1756 about the origin of the main image. If the -region option pre‐
1757 cedes the -draw option, the origin for transformations is the
1758 upper left corner of the region.
1759 Translate translates them.
1761 Scale scales them.
1763 SkewX and SkewY skew them with respect to the origin of the main
1765 image or the region.
1766 The transformations modify the current affine matrix, which is
1768 initialized from the initial affine matrix defined by the
1769 -affine option. Transformations are cumulative within the -draw
1770 option. The initial affine matrix is not affected; that matrix
1771 is only changed by the appearance of another -affine option. If
1772 another -draw option appears, the current affine matrix is
1773 reinitialized from the initial affine matrix.
1774 Use color to change the color of a pixel to the fill color (see
1776 -fill). Follow the pixel coordinate with a method:
1777 point
1779 replace
1780 floodfill
1781 filltoborder
1782 reset
1783 Consider the target pixel as that specified by your coordinate.
1786 The point method recolors the target pixel. The replace method
1787 recolors any pixel that matches the color of the target pixel.
1788 Floodfill recolors any pixel that matches the color of the tar‐
1789 get pixel and is a neighbor, whereas filltoborder recolors any
1790 neighbor pixel that is not the border color. Finally, reset
1791 recolors all pixels.
1792 Use matte to the change the pixel matte value to transparent.
1794 Follow the pixel coordinate with a method (see the color primi‐
1795 tive for a description of methods). The point method changes the
1796 matte value of the target pixel. The replace method changes the
1797 matte value of any pixel that matches the color of the target
1798 pixel. Floodfill changes the matte value of any pixel that
1799 matches the color of the target pixel and is a neighbor, whereas
1800 filltoborder changes the matte value of any neighbor pixel that
1801 is not the border color (-bordercolor). Finally reset changes
1802 the matte value of all pixels.
1803 You can set the primitive color, font, and font bounding box
1805 color with -fill, -font, and -box respectively. Options are pro‐
1806 cessed in command line order so be sure to use these options
1807 before the -draw option.
1808 -edge <radius>
1810 detect edges within an image
1811 -emboss <radius>
1813 emboss an image
1814 -encoding <type>
1816 specify the text encoding
1817 Choose from AdobeCustom, AdobeExpert, AdobeStandard, AppleRoman,
1819 BIG5, GB2312, Latin 2, None, SJIScode, Symbol, Unicode, Wansung.
1820 -endian <type>
1822 specify endianness (MSB, LSB, or Native) of image
1823 MSB indicates big-endian (e.g. SPARC, Motorola 68K) while LSB
1825 indicates little-endian (e.g. Intel 'x86, VAX) byte ordering.
1826 Native indicates to use the normal ordering for the current CPU.
1827 This option currently only influences the CMYK, DPX, GRAY, RGB,
1828 and TIFF, formats.
1829 Use +endian to revert to unspecified endianness.
1831 -enhance
1833 apply a digital filter to enhance a noisy image
1834 -equalize
1836 perform histogram equalization to the image
1837 -extent <width>x<height>{+-}<x>{+-}<y>
1839 composite image on background color canvas image
1840 This option composites the image on a new background color
1842 (-background) canvas image of size <width>x<height>. The exist‐
1843 ing image content is composited at the position specified by
1844 geometry x and y offset and/or desired gravity (-gravity) using
1845 the current image compose (-compose) method. Image content
1846 which falls outside the bounds of the new image dimensions is
1847 discarded.
1848 For example, this command creates a thumbnail of an image, and
1850 centers it on a red color backdrop image, offsetting the canvas
1851 ten pixels to the left and five pixels up, with respect to the
1852 thumbnail:
1853 gm convert infile.jpg -thumbnail 120x80 -background red
1855 -gravity center \
1856 -extent 140x100-10-5 outfile.jpg
1857 This command reduces or expands a JPEG image to fit on an
1860 800x600 display:
1861 gm convert -size 800x600 input.jpg \
1863 -resize 800x600 -background black \
1864 -compose Copy -gravity center \
1865 -extent 800x600 \
1866 -quality 92 output.jpg
1867 If the aspect ratio of the input image isn't exactly 4:3, then
1870 the image is centered on an 800x600 black canvas.
1871 -file <filename>
1873 write annotated difference image to file
1874 If -file is specified, then an annotated difference image is
1876 generated and written to the specified file. Pixels which differ
1877 between the reference and compare images are modified from those
1878 in the compare image so that the changed pixels become more
1879 obvious. Some images may require use of an alternative high‐
1880 light style (see -highlight-style) or highlight color (see
1881 -highlight-color) before the changes are obvious.
1882 -fill <color>
1884 color to use when filling a graphic primitive
1885 Colors are represented in GraphicsMagick in the same form used
1887 by SVG. Use "gm convert -list color" to list named colors:
1888 name (named color)
1890 #RGB (hex numbers, 4 bits each)
1891 #RRGGBB (8 bits each)
1892 #RRRGGGBBB (12 bits each)
1893 #RRRRGGGGBBBB (16 bits each)
1894 #RGBA (4 bits each)
1895 #RRGGBBAA (8 bits each)
1896 #RRRGGGBBBAAA (12 bits each)
1897 #RRRRGGGGBBBBAAAA (16 bits each)
1898 rgb(r,g,b) (r,g,b are decimal numbers)
1899 rgba(r,g,b,a) (r,g,b,a are decimal numbers)
1900 Enclose the color specification in quotation marks to prevent
1903 the "#" or the parentheses from being interpreted by your shell.
1904 For example,
1906 gm convert -fill blue ...
1908 gm convert -fill "#ddddff" ...
1909 gm convert -fill "rgb(65000,65000,65535)" ...
1910 The shorter forms are scaled up, if necessary by replication.
1913 For example, #3af, #33aaff, and #3333aaaaffff are all equiva‐
1914 lent.
1915 See -draw for further details.
1917 -filter <type>
1919 use this type of filter when resizing an image
1920 Use this option to affect the resizing operation of an image
1922 (see -geometry). Choose from these filters (ordered by approxi‐
1923 mate increasing CPU time):
1924 Point
1926 Box
1927 Triangle
1928 Hermite
1929 Hanning
1930 Hamming
1931 Blackman
1932 Gaussian
1933 Quadratic
1934 Cubic
1935 Catrom
1936 Mitchell
1937 Lanczos
1938 Bessel
1939 Sinc
1940 The default filter is automatically selected to provide the best
1943 quality while consuming a reasonable amount of time. The
1944 Mitchell filter is used if the image supports a palette, sup‐
1945 ports a matte channel, or is being enlarged, otherwise the Lanc‐
1946 zos filter is used.
1947 -flatten
1949 flatten a sequence of images
1950 In some file formats (e.g. Photoshop's PSD) complex images may
1952 be represented by "layers" (independent images) which must be
1953 composited in order to obtain the final rendition. The -flatten
1954 option accomplishes this composition. The sequence of images is
1955 replaced by a single image created by compositing each image in
1956 turn, while respecting composition operators and page offsets.
1957 While -flatten is immediately useful for eliminating layers, it
1958 is also useful as a general-purpose composition tool.
1959 The sequence of images is terminated by the appearance of any
1961 option. If the -flatten option appears after all of the input
1962 images, all images are flattened. Also see -mosaic which is
1963 similar to -flatten except that it adds a suitably-sized canvas
1964 base image.
1965 For example, this composites an image on top of a 640x400 trans‐
1967 parent black canvas image:
1968 gm convert -size 640x300 xc:transparent \
1970 -compose over -page +0-100 \
1971 frame.png -flatten output.png
1972 and this flattens a Photoshop PSD file:
1975 gm convert input.psd -flatten output.png
1977 -flip create a "mirror image"
1980 reflect the scanlines in the vertical direction.
1982 -flop create a "mirror image"
1984 reflect the scanlines in the horizontal direction.
1986 -font <name>
1988 use this font when annotating the image with text
1989 You can tag a font to specify whether it is a PostScript, True‐
1991 Type, or X11 font. For example, Arial.ttf is a TrueType font,
1992 ps:helvetica is PostScript, and x:fixed is X11.
1993 -foreground <color>
1995 define the foreground color
1996 The color is specified using the format described under the
1998 -fill option.
1999 -format <type>
2001 the image format type
2002 When used with the mogrify utility, this option will convert any
2004 image to the image format you specify. See GraphicsMagick(1)
2005 for a list of image format types supported by GraphicsMagick, or
2006 see the output of 'gm -list format'.
2007 By default the file is written to its original name. However,
2009 if the filename extension matches a supported format, the exten‐
2010 sion is replaced with the image format type specified with -for‐
2011 mat. For example, if you specify tiff as the format type and
2012 the input image filename is image.gif, the output image filename
2013 becomes image.tiff.
2014 -format <string>
2016 output formatted image characteristics
2017 When used with the identify utility, or the convert utility with
2019 output written to the 'info:-' file specification, use this
2020 option to print information about the image in a format of your
2021 choosing. You can include the image filename, type, width,
2022 height, Exif data, or other image attributes by embedding spe‐
2023 cial format characters:
2024 %b file size
2026 %c comment
2027 %d directory
2028 %e filename extension
2029 %f filename
2030 %g page dimensions and offsets
2031 %h height
2032 %i input filename
2033 %k number of unique colors
2034 %l label
2035 %m magick
2036 %n number of scenes
2037 %o output filename
2038 %p page number
2039 %q image bit depth
2040 %r image type description
2041 %s scene number
2042 %t top of filename
2043 %u unique temporary filename
2044 %w width
2045 %x horizontal resolution
2046 %y vertical resolution
2047 %A transparency supported
2048 %C compression type
2049 %D GIF disposal method
2050 %G Original width and height
2051 %H page height
2052 %M original filename specification
2053 %O page offset (x,y)
2054 %P page dimensions (width,height)
2055 %Q compression quality
2056 %T time delay (in centi-seconds)
2057 %U resolution units
2058 %W page width
2059 %X page horizontal offset (x)
2060 %Y page vertical offset (y)
2061 %@ trim bounding box
2062 %# signature
2063 \n newline
2064 \r carriage return
2065 %% %
2066 For example,
2069 -format "%m:%f %wx%h"
2071 displays MIFF:bird.miff 512x480 for an image titled bird.miff
2074 and whose width is 512 and height is 480.
2075 If the first character of string is @, the format is read from a
2077 file titled by the remaining characters in the string. Please
2078 note that if the string comes from an untrusted source that it
2079 should be sanitized before use since this may be used to incor‐
2080 porate any readable file on the system (a security risk).
2081 The values of image type (%r) which may be returned include:
2083 Bilevel
2085 Grayscale
2086 GrayscaleMatte
2087 Palette
2088 PaletteMatte
2089 TrueColor
2090 TrueColorMatte
2091 ColorSeparation
2092 ColorSeparationMatte
2093 Optimize
2094 You can also use the following special formatting syntax to
2097 print Exif information contained in the file:
2098 %[EXIF:<tag>]
2100 Where "<tag>" may be one of the following:
2103 * (print all Exif tags, in keyword=data format)
2105 ! (print all Exif tags, in tag_number format)
2106 #hhhh (print data for Exif tag #hhhh)
2107 ImageWidth
2108 ImageLength
2109 BitsPerSample
2110 Compression
2111 PhotometricInterpretation
2112 FillOrder
2113 DocumentName
2114 ImageDescription
2115 Make
2116 Model
2117 StripOffsets
2118 Orientation
2119 SamplesPerPixel
2120 RowsPerStrip
2121 StripByteCounts
2122 XResolution
2123 YResolution
2124 PlanarConfiguration
2125 ResolutionUnit
2126 TransferFunction
2127 Software
2128 DateTime
2129 Artist
2130 WhitePoint
2131 PrimaryChromaticities
2132 TransferRange
2133 JPEGProc
2134 JPEGInterchangeFormat
2135 JPEGInterchangeFormatLength
2136 YCbCrCoefficients
2137 YCbCrSubSampling
2138 YCbCrPositioning
2139 ReferenceBlackWhite
2140 CFARepeatPatternDim
2141 CFAPattern
2142 BatteryLevel
2143 Copyright
2144 ExposureTime
2145 FNumber
2146 IPTC/NAA
2147 ExifOffset
2148 InterColorProfile
2149 ExposureProgram
2150 SpectralSensitivity
2151 GPSInfo
2152 ISOSpeedRatings
2153 OECF
2154 ExifVersion
2155 DateTimeOriginal
2156 DateTimeDigitized
2157 ComponentsConfiguration
2158 CompressedBitsPerPixel
2159 ShutterSpeedValue
2160 ApertureValue
2161 BrightnessValue
2162 ExposureBiasValue
2163 MaxApertureValue
2164 SubjectDistance
2165 MeteringMode
2166 LightSource
2167 Flash
2168 FocalLength
2169 MakerNote
2170 UserComment
2171 SubSecTime
2172 SubSecTimeOriginal
2173 SubSecTimeDigitized
2174 FlashPixVersion
2175 ColorSpace
2176 ExifImageWidth
2177 ExifImageLength
2178 InteroperabilityOffset
2179 FlashEnergy
2180 SpatialFrequencyResponse
2181 FocalPlaneXResolution
2182 FocalPlaneYResolution
2183 FocalPlaneResolutionUnit
2184 SubjectLocation
2185 ExposureIndex
2186 SensingMethod
2187 FileSource
2188 SceneType
2189 JPEG specific information (from reading a JPEG file) may be
2192 obtained like this:
2193 %[JPEG-<tag>]
2195 Where "<tag>" may be one of the following:
2198 * (all JPEG-related tags, in
2200 keyword=data format)
2201 Quality IJG JPEG "quality" estimate
2202 Colorspace JPEG colorspace numeric ID
2203 Colorspace-Name JPEG colorspace name
2204 Sampling-factors JPEG sampling factors
2205 Please note that JPEG has no notion of "quality" and that the
2208 quality metric used by, and estimated by the software is based
2209 on the quality metric established by IJG JPEG 6b. Other
2210 encoders (e.g. that used by Adobe Photoshop) use different
2211 encoding metrics.
2212 Surround the format specification with quotation marks to pre‐
2214 vent your shell from misinterpreting any spaces and square
2215 brackets.
2216 -frame <width>x<height>+<outer bevel width>+<inner bevel width>
2218 surround the image with an ornamental border
2219 See -geometry for details about the geometry specification. The
2221 -frame option is not affected by the -gravity option.
2222 The color of the border is specified with the -mattecolor com‐
2224 mand line option.
2225 -frame include the X window frame in the imported image
2227 -fuzz <distance>{%}
2229 colors within this Euclidean distance are considered equal
2230 A number of algorithms search for a target color. By default the
2232 color must be exact. Use this option to match colors that are
2233 close (in Euclidean distance) to the target color in RGB 3D
2234 space. For example, if you want to automatically trim the edges
2235 of an image with -trim but the image was scanned and the target
2236 background color may differ by a small amount. This option can
2237 account for these differences.
2238 The distance can be in absolute intensity units or, by appending
2240 "%", as a percentage of the maximum possible intensity (255,
2241 65535, or 4294967295).
2242 -gamma <value>
2244 level of gamma correction
2245 The same color image displayed on two different workstations may
2247 look different due to differences in the display monitor. Use
2248 gamma correction to adjust for this color difference. Reasonable
2249 values extend from 0.8 to 2.3. Gamma less than 1.0 darkens the
2250 image and gamma greater than 1.0 lightens it. Large adjustments
2251 to image gamma may result in the loss of some image information
2252 if the pixel quantum size is only eight bits (quantum range 0 to
2253 255).
2254 You can apply separate gamma values to the red, green, and blue
2256 channels of the image with a gamma value list delimited with
2257 slashes (e.g., 1.7/2.3/1.2).
2258 Use +gamma value to set the image gamma level without actually
2260 adjusting the image pixels. This option is useful if the image
2261 is of a known gamma but not set as an image attribute (e.g. PNG
2262 images).
2263 -gaussian <radius>{x<sigma>}
2265 blur the image with a Gaussian operator
2266 Use the given radius and standard deviation (sigma).
2268 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
2270 Specify dimension, offset, and resize options.
2271 The -geometry option is used for a number of different purposes,
2273 depending on the utility it is used with.
2274 For the X11 commands ('animate', 'display', and 'import'), it
2276 specifies the preferred size and location of the Image window.
2277 By default, the window size is the image size and the location
2278 is chosen by you (or your window manager) when it is mapped.
2279 For the 'import', 'convert', 'mogrify' utility commands it may
2280 be used to specify the desired size when resizing an image. In
2281 this case, symbols representing resize options may be appended
2282 to the geometry string to influence how the resize request is
2283 treated.
2284 See later notes corresponding to usage by particular commands.
2286 The following notes apply to when -geometry is used to express a
2287 resize request, taking into account the current properties of
2288 the image.
2289 By default, the width and height are maximum values. That is,
2291 the image is expanded or contracted to fit the width and height
2292 value while maintaining the aspect ratio of the image.
2293 Append a ^ to the geometry so that the image aspect ratio is
2295 maintained when the image is resized, but the resulting width or
2296 height are treated as minimum values rather than maximum values.
2297 Append a ! (exclamation point) to the geometry to force the
2299 image size to exactly the size you specify. For example, if you
2300 specify 640x480! the image width is set to 640 pixels and height
2301 to 480.
2302 If only the width is specified, without the trailing 'x', then
2304 height is set to width (e.g., -geometry 100 is the same as
2305 -geometry 100x100). If only the width is specified but with the
2306 trailing 'x', then width assumes the value and the height is
2307 chosen to maintain the aspect ratio of the image. Similarly, if
2308 only the height is specified prefixed by 'x' (e.g., -geometry
2309 x256), the width is chosen to maintain the aspect ratio.
2310 To specify a percentage width or height instead, append %. The
2312 image size is multiplied by the width and height percentages to
2313 obtain the final image dimensions. To increase the size of an
2314 image, use a value greater than 100 (e.g. 125%). To decrease an
2315 image's size, use a percentage less than 100.
2316 Use @ to specify the maximum area in pixels of an image.
2318 Use > to change the dimensions of the image only if its width or
2320 height exceeds the geometry specification. < resizes the image
2321 only if both of its dimensions are less than the geometry speci‐
2322 fication. For example, if you specify '640x480>' and the image
2323 size is 256x256, the image size does not change. However, if the
2324 image is 512x512 or 1024x1024, it is resized to 480x480.
2325 Enclose the geometry specification in quotation marks to prevent
2326 the < or > from being interpreted by your shell as a file redi‐
2327 rection.
2328 When used with animate and display, offsets are handled in the
2330 same manner as in X(1) and the -gravity option is not used. If
2331 the x is negative, the offset is measured leftward from the
2332 right edge of the screen to the right edge of the image being
2333 displayed. Similarly, negative y is measured between the bottom
2334 edges. The offsets are not affected by "%"; they are always
2335 measured in pixels.
2336 When used as a composite option, -geometry gives the dimensions
2338 of the image and its location with respect to the composite
2339 image. If the -gravity option is present with NorthEast, East,
2340 or SouthEast gravity, the x represents the distance from the
2341 right edge of the image to the right edge of the composite
2342 image. Similarly, if the -gravity option is present with South‐
2343 West, South, or SouthEast gravity, y is measured between the
2344 bottom edges. Accordingly, a positive offset will never point in
2345 the direction outside of the image. The offsets are not
2346 affected by "%"; they are always measured in pixels. To specify
2347 the dimensions of the composite image, use the -resize option.
2348 When used as a convert, import or mogrify option, -geometry is
2350 synonymous with -resize and specifies the size of the output
2351 image. The offsets, if present, are ignored.
2352 When used as a montage option, -geometry specifies the image
2354 size and border size for each tile; default is 256x256+0+0.
2355 Negative offsets (border dimensions) are meaningless. The
2356 -gravity option affects the placement of the image within the
2357 tile; the default gravity for this purpose is Center. If the
2358 "%" sign appears in the geometry specification, the tile size is
2359 the specified percentage of the original dimensions of the first
2360 tile. To specify the dimensions of the montage, use the -resize
2361 option.
2362 -gravity <type>
2364 direction primitive gravitates to when annotating the image.
2365 Choices are: NorthWest, North, NorthEast, West, Center, East,
2367 SouthWest, South, SouthEast.
2368 The direction you choose specifies where to position the text
2370 when annotating the image. For example Center gravity forces the
2371 text to be centered within the image. By default, the image
2372 gravity is NorthWest. See -draw for more details about graphic
2373 primitives. Only the text primitive is affected by the -gravity
2374 option.
2375 The -gravity option is also used in concert with the -geometry
2377 option and other options that take <geometry> as a parameter,
2378 such as the -crop option. See -geometry for details of how the
2379 -gravity option interacts with the <x> and <y> parameters of a
2380 geometry specification.
2381 When used as an option to composite, -gravity gives the direc‐
2383 tion that the image gravitates within the composite.
2384 When used as an option to montage, -gravity gives the direction
2386 that an image gravitates within a tile. The default gravity is
2387 Center for this purpose.
2388 -green-primary <x>,<y>
2390 green chromaticity primary point
2391 -hald-clut <clut>
2393 apply a Hald CLUT to the image
2394 A Hald CLUT ("Color Look-Up Table") is a special square color
2396 image which contains a look-up table for red, green, and blue.
2397 The size of the Hald CLUT image is determined by its order. The
2398 width (and height) of a Hald CLUT is the cube of the order. For
2399 example, a Hald CLUT of order 8 is 512x512 pixels (262,144 col‐
2400 ors) and of order 16 is 4096x4096 (16,777,216 colors). A spe‐
2401 cial CLUT is the identity CLUT which which causes no change to
2402 the input image. In order to use the Hald CLUT, one takes an
2403 identity CLUT and adjusts its colors in some way. The modified
2404 CLUT can then be used to transform any number of images in an
2405 identical way.
2406 GraphicsMagick contains a built-in identity CLUT generator via
2408 the IDENTITY coder. For example reading from the file name
2409 IDENTITY:8 returns an identity CLUT of order 8. Typical Hald
2410 CLUT identity images have an order of between 8 and 16. The
2411 default order for the IDENTITY CLUT generator is 8. Interpola‐
2412 tion is used so it is not usually necessary for CLUT images to
2413 be very large. The PNG file format is ideal for storing Hald
2414 CLUT images because it compresses them very well.
2415 -help print usage instructions
2417 -highlight-color <color>
2419 pixel annotation color
2420 Specifies the color to use when annotating difference pixels.
2422 -highlight-style <style>
2424 pixel annotation style
2425 Specifies the pixel difference annotation style used to draw
2427 attention to changed pixels. May be one of Assign, Threshold,
2428 Tint, or XOR; where Assign replaces the pixel with the highlight
2429 color (see -highlight-color), Threshold replaces the pixel with
2430 black or white based on the difference in intensity, Tint alpha
2431 tints the pixel with the highlight color, and XOR does an XOR
2432 between the pixel and the highlight color.
2433 -iconGeometry <geometry>
2435 specify the icon geometry
2436 Offsets, if present in the geometry specification, are handled
2438 in the same manner as the -geometry option, using X11 style to
2439 handle negative offsets.
2440 -iconic
2442 iconic animation
2443 -immutable
2445 make image immutable
2446 -implode <factor>
2448 implode image pixels about the center
2449 -intent <type>
2451 use this type of rendering intent when managing the image color
2452 Use this option to affect the the color management operation of
2454 an image (see -profile). Choose from these intents: Absolute,
2455 Perceptual, Relative, Saturation.
2456 The default intent is undefined.
2458 -interlace <type>
2460 the type of interlacing scheme
2461 Choices are: None, Line, Plane, or Partition. The default is
2463 None.
2464 This option is used to specify the type of interlacing scheme
2466 for raw image formats such as RGB or YUV. None means do not
2467 interlace (RGBRGBRGBRGBRGBRGB...),
2468 Line uses scanline interlacing
2470 (RRR...GGG...BBB...RRR...GGG...BBB...), and Plane uses plane
2471 interlacing (RRRRRR...GGGGGG...BBBBBB...).
2472 Partition is like plane except the different planes are saved to
2474 individual files (e.g. image.R, image.G, and image.B).
2475 Use Line to create an interlaced PNG or GIF or progressive JPEG
2477 image.
2478 -label <name>
2480 assign a label to an image
2481 Use this option to assign a specific label to the image, when
2483 writing to an image format that supports labels, such as TIFF,
2484 PNG, MIFF, or PostScript. You can include the the image file‐
2485 name, type, width, height, or other image attribute by embedding
2486 special format character. A label is not drawn on the image,
2487 but is embedded in the image datastream via a "Label" tag or
2488 similar mechanism. If you want the label to be visible on the
2489 image itself, use the -draw option. See -comment for details.
2490 For example,
2492 -label "%m:%f %wx%h"
2494 produces an image label of MIFF:bird.miff 512x480 for an image
2497 titled bird.miff and whose width is 512 and height is 480.
2498 If the first character of string is @, the image label is read
2500 from a file titled by the remaining characters in the string.
2501 Please note that if the string comes from an untrusted source
2502 that it should be sanitized before use since otherwise the con‐
2503 tent of an arbitrary readable file might be incorporated into
2504 the image label (a security risk).
2505 If the -label option appears multiple times, only the last label
2507 is stored.
2508 In PNG images, the label is stored in a tEXt or zTXt chunk with
2510 the keyword "label".
2511 When converting to PostScript, use this option to specify a
2513 header string to print above the image. Specify the label font
2514 with -font.
2515 When creating a montage, by default the label associated with an
2517 image is displayed with the corresponding tile in the montage.
2518 Use the +label option to suppress this behavior.
2519 -lat <width>x<height>{+-}<offset>{%}
2523 perform local adaptive thresholding
2524 Perform local adaptive thresholding using the specified width,
2526 height, and offset. The offset is a distance in sample space
2527 from the mean, as an absolute integer ranging from 0 to the max‐
2528 imum sample value or as a percentage. If the percent option is
2529 supplied, then the offset is computed as a percentage of the
2530 quantum range. It is strongly recommended to use the percent
2531 option so that results are not sensitive to pixel quantum depth.
2532 For example,
2534 -colorspace gray -lat "10x10-5%"
2536 will help clarify a scanned grayscale or color document, produc‐
2539 ing a bi-level equivalent.
2540 -level <black_point>{,<gamma>}{,<white_point>}{%}
2542 adjust the level of image contrast
2543 Give one, two or three values delimited with commas: black-
2545 point, gamma, white-point (e.g. 10,1.0,250 or 2%,0.5,98%). The
2546 black and white points range from 0 to MaxRGB or from 0 to 100%;
2547 if the white point is omitted it is set to MaxRGB-black_point.
2548 If a "%" sign is present anywhere in the string, the black and
2549 white points are percentages of MaxRGB. Gamma is an exponent
2550 that ranges from 0.1 to 10.; if it is omitted, the default of
2551 1.0 (no gamma correction) is assumed. This interface works simi‐
2552 lar to Photoshop's "Image->Adjustments->Levels..." "Input Lev‐
2553 els" interface.
2554 -limit <type> <value>
2556 Disk, File, Map, Memory, Pixels, Width, Height or Threads
2557 resource limit
2558 By default, resource limits are estimated based on the available
2560 resources of the system. The resource limits are Disk, maximum
2561 total disk space consumed; File, maximum number of file descrip‐
2562 tors allowed to be open at once; Map, maximum total number of
2563 file bytes which may be memory mapped; Memory, maximum total
2564 number of bytes of heap memory used for image storage; Pixels,
2565 maximum absolute image size (per image); Width, maximum image
2566 pixels width; Height, maximum image pixels height; and Threads,
2567 the maximum number of worker threads to use per OpenMP thread
2568 team.
2569 These resource limits are used to decide if (for a given image)
2571 the decoded image ("pixel cache") should be stored in heap mem‐
2572 ory (RAM), in a memory-mapped disk file, or in a disk file
2573 accessed via read/write I/O. The number of total pixels in one
2574 image, and/or the width/height, may also be limited in order to
2575 force the reading, or creation of images larger than the limit
2576 (in pixels) to intentionally fail. The disk limit establishes an
2577 overall limit since using the disk is the means of last resort.
2578 When the disk limit has been reached, no more images may be
2579 read.
2580 The value argument is an absolute value, but may have standard
2582 binary suffix characters applied ('K', 'M', 'G', 'T', 'P', 'E')
2583 to apply a scaling to the value (based on a multiplier of 1024).
2584 Any additional characters are ignored. For example, '-limit Pix‐
2585 els 10MP' limits the maximum image size to 10 megapixels and
2586 '-limit memory 32MB -limit map 64MB' limits memory and memory
2587 mapped files to 32 megabytes and 64 megabytes respectively.
2588 Resource limits may also be set using environment variables. The
2590 environment variables MAGICK_LIMIT_DISK, MAGICK_LIMIT_FILES,
2591 MAGICK_LIMIT_MAP, MAGICK_LIMIT_MEMORY, MAGICK_LIMIT_PIXELS, MAG‐
2592 ICK_LIMIT_WIDTH, MAGICK_LIMIT_HEIGHT,and OMP_NUM_THREADS may be
2593 used to set the limits for disk space, open files, memory mapped
2594 size, heap memory, per-image pixels, image width, image height,
2595 and threads respectively.
2596 Use the option -list resource list the current limits.
2598 -linewidth
2600 the line width for subsequent draw operations
2601 -list <type>
2603 the type of list
2604 Choices are: Color, Delegate, Format, Magic, Module, Resource,
2606 or Type. The Module option is only available if GraphicsMagick
2607 was built to support loadable modules.
2608 This option lists information about the GraphicsMagick configu‐
2610 ration.
2611 -log <string>
2613 Specify format for debug log
2614 This option specifies the format for the log printed when the
2616 -debug option is active.
2617 You can display the following components by embedding special
2619 format characters:
2620 %d domain
2622 %e event
2623 %f function
2624 %l line
2625 %m module
2626 %p process ID
2627 %r real CPU time
2628 %t wall clock time
2629 %u user CPU time
2630 %% percent sign
2631 \n newline
2632 \r carriage return
2633 For example:
2636 gm convert -debug coders -log "%u %m:%l %e" in.gif out.png
2638 The default behavior is to print all of the components.
2641 -loop <iterations>
2643 add Netscape loop extension to your GIF animation
2644 A value other than zero forces the animation to repeat itself up
2646 to iterations times.
2647 -magnify
2649 magnify the image
2650 The image size is doubled using linear interpolation.
2652 -magnify <factor>
2654 magnify the image
2655 The displayed image is magnified by factor.
2657 -map <filename>
2659 choose a particular set of colors from this image
2660 [convert or mogrify]
2662 By default, color reduction chooses an optimal set of colors
2664 that best represent the original image. Alternatively, you can
2665 choose a particular set of colors from an image file with this
2666 option.
2667 Use +map to reduce all images in the image sequence that follows
2669 to a single optimal set of colors that best represent all the
2670 images. The sequence of images is terminated by the appearance
2671 of any option. If the +map option appears after all of the
2672 input images, all images are mapped.
2673 -map <type>
2675 display image using this type.
2676 [animate or display]
2678 Choose from these Standard Colormap types:
2680 best
2682 default
2683 gray
2684 red
2685 green
2686 blue
2687 The X server must support the Standard Colormap you choose, oth‐
2690 erwise an error occurs. Use list as the type and display
2691 searches the list of colormap types in top-to-bottom order until
2692 one is located. See xstdcmap(1) for one way of creating Standard
2693 Colormaps.
2694 -mask <filename>
2696 Specify a clipping mask
2697 The image read from the file is used as a clipping mask. It
2699 must have the same dimensions as the image being masked.
2700 If the mask image contains an opacity channel, the opacity of
2702 each pixel is used to define the mask. Otherwise, the intensity
2703 (gray level) of each pixel is used. Unmasked (black) pixels are
2704 modified while masked pixels (not black) are protected from
2705 alteration.
2706 Use +mask to remove the clipping mask.
2708 It is not necessary to use -clip to activate the mask; -clip is
2710 implied by -mask.
2711 -matte store matte channel if the image has one
2713 If the image does not have a matte channel, create an opaque
2715 one.
2716 Use +matte to ignore the matte channel and to avoid writing a
2718 matte channel in the output file.
2719 -mattecolor <color>
2721 specify the color to be used with the -frame option
2722 The color is specified using the format described under the
2724 -fill option.
2725 -maximum-error <limit>
2727 specifies the maximum amount of total image error
2728 Specifies the maximum amount of total image error (based on com‐
2730 parison using a specified metric) before an error ("image dif‐
2731 ference exceeds limit") is reported. The error is reported via
2732 a non-zero command execution return status.
2733 -median <radius>
2735 apply a median filter to the image
2736 -metric <metric>
2738 comparison metric (MAE, MSE, PAE, PSNR, RMSE)
2739 -minify <factor>
2741 minify the image
2742 The image size is halved using linear interpolation.
2744 -mode <value>
2746 mode of operation
2747 The available montage modes are frame to place the images in a
2749 rectangular grid while adding a decorative frame with drop‐
2750 shadow, unframe to place undecorated images in a rectangular
2751 grid, and concatenate to pack the images closely together with‐
2752 out any well-defined grid or decoration.
2753 -modulate brightness[,saturation[,hue]]
2755 vary the brightness, saturation, and hue of an image
2756 Specify the percent change in brightness, color saturation, and
2758 hue separated by commas. Default argument values are 100 per‐
2759 cent, resulting in no change. For example, to increase the color
2760 brightness by 20% and decrease the color saturation by 10% and
2761 leave the hue unchanged, use: -modulate 120,90.
2762 Hue is the percentage of absolute rotation from the current
2764 position. For example 50 results in a counter-clockwise rotation
2765 of 90 degrees, 150 results in a clockwise rotation of 90
2766 degrees, with 0 and 200 both resulting in a rotation of 180
2767 degrees.
2768 -monitor
2770 show progress indication
2771 A simple command-line progress indication is shown while the
2773 command is running. The process indication shows the operation
2774 currently being performed and the percent completed. Commands
2775 using X11 may replace the command line progress indication with
2776 a graphical one once an image has been displayed.
2777 -monochrome
2779 transform the image to black and white
2780 -morph <frames>
2782 morphs an image sequence
2783 Both the image pixels and size are linearly interpolated to give
2785 the appearance of a meta-morphosis from one image to the next.
2786 The sequence of images is terminated by the appearance of any
2788 option. If the -morph option appears after all of the input
2789 images, all images are morphed.
2790 -mosaic
2792 create a mosaic from an image or an image sequence
2793 The -mosaic option provides a flexible way to composite one or
2795 more images onto a solid-color canvas image. It works similar to
2796 -flatten except that a base canvas image is automatically cre‐
2797 ated with a suitable size given the image size, page dimensions,
2798 and page offsets of images to be composited. The color of the
2799 base canvas image may be set via the -background option. The
2800 default canvas color is 'white', but 'black' or 'transparent'
2801 may be more suitable depending on the composition algorithm
2802 requested.
2803 The -compose option may be used to specify the composition algo‐
2805 rithm to use when compositing the subsequent image on the base
2806 canvas.
2807 The -page option can be used to establish the dimensions of the
2809 mosaic and to position the subsequent image within the mosaic.
2810 If the -page argument does not specify width and height, then
2811 the canvas dimensions are evaluated based on the image sizes and
2812 offsets.
2813 The sequence of images is terminated by the appearance of any
2815 option. If the -mosaic option appears after all of the input
2816 images, all images are included in the mosaic.
2817 The following is an example of composing an image based on red,
2819 green, and blue layers extracted from a sequence of images and
2820 pasted on the canvas image at specified offsets:
2821 gm convert -background black \
2823 -compose CopyRed -page +0-100 red.png \
2824 -compose CopyGreen -page +0+40 green.png \
2825 -compose CopyBlue -page +0+180 blue.png \
2826 -mosaic output.png
2827 -motion-blur <radius>{x<sigma>}{+angle}
2830 Simulate motion blur
2831 Simulate motion blur by convolving the image with a Gaussian
2833 operator of the given radius and standard deviation (sigma). For
2834 reasonable results, radius should be larger than sigma. If
2835 radius is zero, then a suitable radius is automatically selected
2836 based on sigma. The angle specifies the angle that the object is
2837 coming from (side which is blurred).
2838 -name name an image
2840 -negate
2842 replace every pixel with its complementary color
2843 The red, green, and blue intensities of an image are negated.
2845 White becomes black, yellow becomes blue, etc. Use +negate to
2846 only negate the grayscale pixels of the image.
2847 -noise <radius|type>
2849 add or reduce noise in an image
2850 The principal function of noise peak elimination filter is to
2852 smooth the objects within an image without losing edge informa‐
2853 tion and without creating undesired structures. The central idea
2854 of the algorithm is to replace a pixel with its next neighbor in
2855 value within a pixel window, if this pixel has been found to be
2856 noise. A pixel is defined as noise if and only if this pixel is
2857 a maximum or minimum within the pixel window.
2858 Use radius to specify the width of the neighborhood.
2860 Use +noise followed by a noise type to add noise to an image.
2862 The noise added modulates the existing image pixels. Choose from
2863 these noise types:
2864 Uniform
2866 Gaussian
2867 Multiplicative
2868 Impulse
2869 Laplacian
2870 Poisson
2871 Random (uniform distribution)
2872 -noop NOOP (no option)
2875 The -noop option can be used to terminate a group of images and
2877 reset all options to their default values, when no other option
2878 is desired.
2879 -normalize
2881 transform image to span the full range of color values
2882 This is a contrast enhancement technique based on the image his‐
2884 togram.
2885 When computing the contrast enhancement values, the histogram
2887 edges are truncated so that the majority of the image pixels are
2888 considered in the constrast enhancement, and outliers (e.g. ran‐
2889 dom noise or minute details) are ignored. The default is that
2890 0.1 percent of the histogram entries are ignored. The percent‐
2891 age of the histogram to ignore may be specified by using the
2892 -set option with the histogram-threshold parameter similar to
2893 -set histogram-threshold 0.01 to specify 0.01 percent. Use 0
2894 percent to use the entire histogram, with possibly diminished
2895 contrast enhancement.
2896 -opaque <color>
2898 change this color to the pen color within the image
2899 The color is specified using the format described under the
2901 -fill option. The color is replaced if it is identical to the
2902 target color, or close enough to the target color in a 3D space
2903 as defined by the Euclidean distance specified by -fuzz.
2904 See -fill and -fuzz for more details.
2906 -operator channel operator rvalue[%]
2908 apply a mathematical, bitwise, or value operator to an image
2909 channel
2910 Apply a low-level mathematical, bitwise, or value operator to a
2912 selected image channel or all image channels. Operations which
2913 result in negative results are reset to zero, and operations
2914 which overflow the available range are reset to the maximum pos‐
2915 sible value.
2916 Select a channel from: Red, Green, Blue, Opacity, Matte, Cyan,
2918 Magenta, Yellow, Black, All, or Gray. All only modifies the
2919 color channels and does not modify the Opacity channel. Except
2920 for the threshold operators, All operates on each channel inde‐
2921 pendently so that operations are on a per-channel basis.
2922 Gray treats the color channels as a grayscale intensity and per‐
2924 forms the requested operation on the equivalent pixel intensity
2925 so the result is a gray image. Select an operator from Add,
2926 And, Assign, Depth, Divide, Gamma, Negate, LShift, Log, Max,
2927 Min, Multiply, Or, Pow RShift, Subtract, Threshold, Threshold-
2928 White, Threshold-White-Negate, Threshold-Black, Threshold-Black-
2929 Negate, Xor, Noise-Gaussian, Noise-Impulse, Noise-Laplacian,
2930 Noise-Multiplicative, Noise-Poisson, Noise-Random, and Noise-
2931 Uniform.
2932 Rvalue may be any floating point or integer value. Normally
2934 rvalue will be in the range of 0 to MaxRGB, where MaxRGB is the
2935 largest quantum value supported by the GraphicsMagick build
2936 (255, 65535, or 4294967295) but values outside this range are
2937 useful for some arithmetic operations. Arguments to logical or
2938 bit-wise operations are rounded to a positive integral value
2939 prior to use. If a percent (%) symbol is appended to the argu‐
2940 ment, then the argument has a range of 0 to 100 percent.
2941 The following is a description of the operators:
2943 Add
2946 Result is rvalue added to channel value.
2948 And
2950 Result is the logical AND of rvalue with channel value.
2952 Assign
2954 Result is rvalue.
2956 Depth
2958 Result is channel value adjusted so that it may be
2960 (approximately) stored in the specified number of bits
2961 without additional loss.
2962 Divide
2964 Result is channel value divided by rvalue.
2966 Gamma
2968 Result is channel value gamma adjusted by rvalue.
2970 LShift
2972 Result is channel value bitwise left shifted by rvalue
2974 bits.
2975 Log
2977 Result is computed as log(value*rvalue+1)/log(rvalue+1).
2979 Max
2981 Result is assigned to rvalue if rvalue is greater than
2983 value.
2984 Min
2986 Result is assigned to rvalue if rvalue is less than value.
2988 Multiply
2990 Result is channel value multiplied by rvalue.
2992 Negate
2994 Result is inverse of channel value (like a film negative).
2996 An rvalue must be supplied but is currently not used.
2997 Inverting the image twice results in the original image.
2998 Or
3000 Result is the logical OR of rvalue with channel value.
3002 Pow
3004 Result is computed as pow(value,rvalue). Similar to Gamma
3006 except that rvalue is not inverted.
3007 RShift
3009 Result is channel value bitwise right shifted by rvalue
3011 bits.
3012 Subtract
3014 Result is channel value minus rvalue.
3016 Threshold
3018 Result is maximum (white) if channel value is greater than
3020 rvalue, or minimum (black) if it is less than or equal to
3021 rvalue. If all channels are specified, then thresholding
3022 is done based on computed pixel intensity.
3023 Threshold-white
3025 Result is maximum (white) if channel value is greater than
3027 rvalue and is unchanged if it is less than or equal to
3028 rvalue. This can be used to remove apparent noise from the
3029 bright parts of an image. If all channels are specified,
3030 then thresholding is done based on computed pixel inten‐
3031 sity.
3032 Threshold-White-Negate
3034 Result is set to black if channel value is greater than
3036 rvalue and is unchanged if it is less than or equal to
3037 rvalue. If all channels are specified, then thresholding
3038 is done based on computed pixel intensity.
3039 Threshold-black
3041 Result is minimum (black) if channel value is less than
3043 than rvalue and is unchanged if it is greater than or
3044 equal to rvalue. This can be used to remove apparent noise
3045 from the dark parts of an image. If all channels are spec‐
3046 ified, then thresholding is done based on computed pixel
3047 intensity.
3048 Threshold-Black-Negate
3050 Result is set to white if channel value is less than than
3052 rvalue and is unchanged if it is greater than or equal to
3053 rvalue. If all channels are specified, then thresholding
3054 is done based on computed pixel intensity.
3055 Xor
3057 Result is the logical XOR of rvalue with channel value. An
3059 interesting property of XOR is that performing the same
3060 operation twice results in the original value.
3061 Noise-Gaussian
3063 Result is the current channel value modulated with gauss‐
3065 ian noise according to the intensity specified by rvalue.
3066 Noise-Impulse
3068 Result is the current channel value modulated with impulse
3070 noise according to the intensity specified by rvalue.
3071 Noise-Laplacian
3073 Result is the current channel value modulated with lapla‐
3075 cian noise according to the intensity specified by rvalue.
3076 Noise-Multiplicative
3078 Result is the current channel value modulated with multi‐
3080 plicative gaussian noise according to the intensity speci‐
3081 fied by rvalue.
3082 Noise-Poisson
3084 Result is the current channel value modulated with poisson
3086 noise according to the intensity specified by rvalue.
3087 Noise-Random
3089 Result is the current channel value modulated with random
3091 (uniform distribution) noise according to the intensity
3092 specified by rvalue. The initial noise intensity
3093 (rvalue=1.0) is the range of one pixel quantum span.
3094 Noise-Uniform
3096 Result is the channel value with uniform noise applied
3098 according to the intensity specified by rvalue.
3099 As an example, the Assign operator assigns a fixed value to a
3104 channel. For example, this command sets the red channel to the
3105 mid-range value:
3106 gm convert in.bmp -operator red assign "50%" out.bmp
3108 The following applies 50% thresholding to the image and returns
3111 a gray image:
3112 gm convert in.bmp -operator gray threshold "50%" out.bmp
3114 -ordered-dither <channeltype> <NxN>
3117 ordered dither the image
3118 The channel or channels specified in the channeltype argument
3120 are reduced to binary, using an ordered dither method. The
3121 choices for channeltype are All, Intensity, Red, Green, Blue,
3122 Cyan, Magenta, Yellow, Black, and Opacity
3123 When channeltype is "All", the color samples are dithered into a
3125 gray level and then that gray level is stored in the three color
3126 channels. Separately, the opacity channel is dithered into a
3127 bilevel opacity value which is stored in the opacity channel.
3128 When channeltype is "Intensity", only the color samples are
3130 dithered. When channeltype is "opacity" or "matte", only the
3131 opacity channel is dithered. When a color channel is specified,
3132 only that channel is dithered.
3133 The choices for N are 2 through 7. The image is divided into NxN
3135 pixel tiles. In each tile, some or all pixels are turned to
3136 white depending on their intensity. For each N, (N**2)+1 levels
3137 of gray can be represented. For N == 2, 3, or 4, the pixels are
3138 turned to white in an order that maximizes dispersion (i.e.,
3139 reduces granularity), while for N == 5, 6, and 7, they are
3140 turned to white in an order that creates a roughly circular
3141 black blob in the middle of each tile. An attractive "half-
3142 tone" looking image can be obtained by first rotating the image
3143 45 degrees, performing a 5x5 ordered-dither operation, then
3144 rotating it back to the original orientation and cropping to the
3145 original image dimensions. If the original image is gamma-
3146 encoded, it is adviseable to convert it to linear intensity
3147 first, e.g., with the "-gamma 0.45455" option.
3148 -output-directory <directory>
3150 output files to directory
3151 Use -output-directory to specify a directory under which to
3153 write the output files. Normally mogrify overwrites the input
3154 files, but with this option the output files may be written to a
3155 different directory tree so that the input files are preserved.
3156 The algorithm used preserves all of the input path specification
3157 in the output path so that the user-specified input path
3158 (including any sub-directory part) is appended to the output
3159 path. If the input file lacks an extension, then a suitable
3160 extension is automatically added to the output file. The user
3161 is responsible for creating the output directory specified as an
3162 argument, but subdirectories will be created as needed if the
3163 -create-directories option is supplied. This option may be used
3164 to apply transformations on files from one directory and write
3165 the transformed files to a different directory. In conjunction
3166 with -create-directories, this option is designed to support
3167 transforming whole directory trees of files provided that the
3168 relative path of the input file is included as part the list of
3169 filenames.
3170 -orient <orientation>
3172 Set the image orientation attribute
3173 Sets the image orientation attribute. The image orientation
3175 attribute is compatible with the TIFF orientation tag (and the
3176 EXIF orientation tag). Accepted values are undefined, TopLeft,
3177 TopRight, BottomRight, BottomLeft, LeftTop, RightTop, RightBot‐
3178 tom, LeftBottom, and hyphenated versions thereof (e.g. left-bot‐
3179 tom). Please note that GraphicsMagick does not include an EXIF
3180 editor so if an EXIF profile is written to the output image, the
3181 value in the EXIF profile might not match the image. It is pos‐
3182 sible for an image file to indicate its orientation in several
3183 different ways simultaneously.
3184 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
3186 size and location of an image canvas
3187 Use this option to specify the dimensions of the PostScript page
3189 in dots per inch or a TEXT page in pixels. The choices for a
3190 PostScript page are:
3191 11x17 792 1224
3193 Ledger 1224 792
3194 Legal 612 1008
3195 Letter 612 792
3196 LetterSmall 612 792
3197 ArchE 2592 3456
3198 ArchD 1728 2592
3199 ArchC 1296 1728
3200 ArchB 864 1296
3201 ArchA 648 864
3202 A0 2380 3368
3203 A1 1684 2380
3204 A2 1190 1684
3205 A3 842 1190
3206 A4 595 842
3207 A4Small 595 842
3208 A5 421 595
3209 A6 297 421
3210 A7 210 297
3211 A8 148 210
3212 A9 105 148
3213 A10 74 105
3214 B0 2836 4008
3215 B1 2004 2836
3216 B2 1418 2004
3217 B3 1002 1418
3218 B4 709 1002
3219 B5 501 709
3220 C0 2600 3677
3221 C1 1837 2600
3222 C2 1298 1837
3223 C3 918 1298
3224 C4 649 918
3225 C5 459 649
3226 C6 323 459
3227 Flsa 612 936
3228 Flse 612 936
3229 HalfLetter 396 612
3230 For convenience you can specify the page size by media (e.g. A4,
3233 Ledger, etc.). Otherwise, -page behaves much like -geometry
3234 (e.g. -page letter+43+43>).
3235 This option is also used to place subimages when writing to a
3237 multi-image format that supports offsets, such as GIF89 and MNG.
3238 When used for this purpose the offsets are always measured from
3239 the top left corner of the canvas and are not affected by the
3240 -gravity option. To position a GIF or MNG image, use
3241 -page{+-}<x>{+-}<y> (e.g. -page +100+200). When writing to a
3242 MNG file, a -page option appearing ahead of the first image in
3243 the sequence with nonzero width and height defines the width and
3244 height values that are written in the MHDR chunk. Otherwise,
3245 the MNG width and height are computed from the bounding box that
3246 contains all images in the sequence. When writing a GIF89 file,
3247 only the bounding box method is used to determine its dimen‐
3248 sions.
3249 For a PostScript page, the image is sized as in -geometry and
3251 positioned relative to the lower left hand corner of the page by
3252 {+-}<xoffset>{+-}<y offset>. Use -page 612x792>, for example, to
3253 center the image within the page. If the image size exceeds the
3254 PostScript page, it is reduced to fit the page. The default
3255 gravity for the -page option is NorthWest, i.e., positive x and
3256 y offset are measured rightward and downward from the top left
3257 corner of the page, unless the -gravity option is present with a
3258 value other than NorthWest.
3259 The default page dimensions for a TEXT image is 612x792.
3261 This option is used in concert with -density.
3263 Use +page to remove the page settings for an image.
3265 -paint <radius>
3267 simulate an oil painting
3268 Each pixel is replaced by the most frequent color in a circular
3270 neighborhood whose width is specified with radius.
3271 -pause <seconds>
3273 pause between animation loops [animate]
3274 Pause for the specified number of seconds before repeating the
3276 animation.
3277 -pause <seconds>
3279 pause between snapshots [import]
3280 Pause for the specified number of seconds before taking the next
3282 snapshot.
3283 -pen <color>
3285 (This option has been replaced by the -fill option)
3286 -ping efficiently determine image characteristics
3288 Use this option to disable reading the image pixels so that
3290 image characteristics such as the image dimensions may be
3291 obtained very quickly. For identify, use +ping to force reading
3292 the image pixels so that the pixel read rate may be included in
3293 the displayed information.
3294 -pointsize <value>
3296 pointsize of the PostScript, X11, or TrueType font
3297 -preview <type>
3299 image preview type
3300 Use this option to affect the preview operation of an image
3302 (e.g. convert file.png -preview Gamma Preview:gamma.png).
3303 Choose from these previews:
3304 Rotate
3306 Shear
3307 Roll
3308 Hue
3309 Saturation
3310 Brightness
3311 Gamma
3312 Spiff
3313 Dull
3314 Grayscale
3315 Quantize
3316 Despeckle
3317 ReduceNoise
3318 AddNoise
3319 Sharpen
3320 Blur
3321 Threshold
3322 EdgeDetect
3323 Spread
3324 Shade
3325 Raise
3326 Segment
3327 Solarize
3328 Swirl
3329 Implode
3330 Wave
3331 OilPaint
3332 CharcoalDrawing
3333 JPEG
3334 The default preview is JPEG.
3337 -process <command>
3339 process a sequence of images using a process module
3340 The command argument has the form module=arg1,arg2,arg3,...,argN
3342 where module is the name of the module to invoke (e.g. "ana‐
3343 lyze") and arg1,arg2,arg3,...,argN are an arbitrary number of
3344 arguments to pass to the process module. The sequence of images
3345 is terminated by the appearance of any option.
3346 If the -process option appears after all of the input images,
3348 all images are processed.
3349 -profile <filename>
3351 add ICM, IPTC, or generic profile to image
3352 -profile filename adds an ICM (ICC color management), IPTC
3354 (newswire information), or a generic (including Exif) profile to
3355 the image
3356 Use +profile icm, +profile iptc, or +profile profile_name to
3358 remove the respective profile. Multiple profiles may be listed,
3359 separated by commas. Profiles may be excluded from subsequent
3360 listed matches by preceding their name with an exclamation
3361 point. For example, +profile '!icm,*' strips all profiles
3362 except for the ICM profile. Use identify -verbose to find out
3363 what profiles are in the image file. Use +profile "*" to remove
3364 all profiles. Writing the image to a format that does not sup‐
3365 port profiles will of course also cause all profiles to be
3366 removed. The JPEG and PNG formats will store any profiles that
3367 have been read and not removed. In JPEG they are stored in APP1
3368 markers, and in PNG they are stored as hex-coded binary in com‐
3369 pressed zTXt chunks, except for the iCC chunk which is stored in
3370 the iCCP chunk.
3371 To extract a profile, the -profile option is not used. Instead,
3373 simply write the file to an image format such as APP1, 8BIM,
3374 ICM, or IPTC.
3375 For example, to extract the Exif data (which is stored in JPEG
3377 files in the APP1 profile), use
3378 gm convert cockatoo.jpg exifdata.app1
3381 Note that GraphicsMagick does not attempt to update any profile
3383 to reflect changes made to the image, e.g., rotation from por‐
3384 trait to landscape orientation, so it is possible that the pre‐
3385 served profile may contain invalid data.
3386 -preserve-timestamp
3388 preserve the original timestamps of the file
3389 Use this option to preserve the original modification and access
3391 timestamps of the file, even if it has been modified.
3392 +progress
3394 disable progress monitor and busy cursor
3395 By default, when an image is displayed, a progress monitor bar
3397 is shown in the top left corner of an existing image display
3398 window, and the current cursor is replaced with an hourglass
3399 cursor. Use +progress to disable the progress monitor and busy
3400 cursor during display operations. While the progress monitor is
3401 disabled for all operations, the busy cursor continues to be
3402 enabled for non-display operations such as image processing.
3403 This option is useful for non-interactive display operations, or
3404 when a "clean" look is desired.
3405 -quality <value>
3407 JPEG/MIFF/PNG/TIFF compression level
3408 For the JPEG and MPEG image formats, quality is 0 (lowest image
3409 quality and highest compression) to 100 (best quality but least
3410 effective compression). The default quality is 75. Use the
3411 -sampling-factor option to specify the factors for chroma down‐
3412 sampling. To use the same quality value as that found by the
3413 JPEG decoder, use the -define jpeg:preserve-settings flag.
3414 For the MIFF image format, and the TIFF format while using ZIP
3416 compression, quality/10 is the zlib compression level, which is
3417 0 (worst but fastest compression) to 9 (best but slowest). It
3418 has no effect on the image appearance, since the compression is
3419 always lossless.
3420 For the JPEG-2000 image format, quality is mapped using a non-
3422 linear equation to the compression ratio required by the Jasper
3423 library. This non-linear equation is intended to loosely approx‐
3424 imate the quality provided by the JPEG v1 format. The default
3425 quality value 75 results in a request for 16:1 compression. The
3426 quality value 100 results in a request for non-lossy compres‐
3427 sion.
3428 For the MNG and PNG image formats, the quality value sets the
3430 zlib compression level (quality / 10) and filter-type (quality %
3431 10). Compression levels range from 0 (fastest compression) to
3432 100 (best but slowest). For compression level 0, the Huffman-
3433 only strategy is used, which is fastest but not necessarily the
3434 worst compression.
3435 If filter-type is 4 or less, the specified filter-type is used
3437 for all scanlines:
3438 0: none
3440 1: sub
3441 2: up
3442 3: average
3443 4: Paeth
3444 If filter-type is 5, adaptive filtering is used when quality is
3447 greater than 50 and the image does not have a color map, other‐
3448 wise no filtering is used.
3449 If filter-type is 6, adaptive filtering with minimum-sum-of-
3451 absolute-values is used.
3452 Only if the output is MNG, if filter-type is 7, the LOCO color
3454 transformation and adaptive filtering with minimum-sum-of-abso‐
3455 lute-values are used.
3456 The default is quality is 75, which means nearly the best com‐
3458 pression with adaptive filtering. The quality setting has no
3459 effect on the appearance of PNG and MNG images, since the com‐
3460 pression is always lossless.
3461 For further information, see the PNG specification.
3463 When writing a JNG image with transparency, two quality values
3465 are required, one for the main image and one for the grayscale
3466 image that conveys the opacity channel. These are written as a
3467 single integer equal to the main image quality plus 1000 times
3468 the opacity quality. For example, if you want to use quality 75
3469 for the main image and quality 90 to compress the opacity data,
3470 use -quality 90075.
3471 For the PNM family of formats (PNM, PGM, and PPM) specify a
3473 quality factor of zero in order to obtain the ASCII variant of
3474 the format. Note that -compress none used to be used to trigger
3475 ASCII output but provided the opposite result of what was
3476 expected as compared with other formats.
3477 For the TIFF format, the JPEG, WebP, Zip, and Zstd compression
3479 algorithms are influenced by the quality value. JPEG and WebP
3480 provide lossy compression so higher quality produces a larger
3481 file with less degradation. The Zip and Zstd compression algo‐
3482 rithms (and WebP in lossless mode) are lossless and for these
3483 algorithms a higher ´quality' means to work harder to produce a
3484 smaller file, but with no difference in image quality.
3485 -raise <width>x<height>
3487 lighten or darken image edges
3488 This will create a 3-D effect. See -geometry for details details
3490 about the geometry specification. Offsets are not used.
3491 Use -raise to create a raised effect, otherwise use +raise.
3493 -random-threshold <channeltype> <LOWxHIGH>
3495 random threshold the image
3496 The channel or channels specified in the <channeltype> argument
3498 are reduced to binary, using an random-threshold method. The
3499 choices for channeltype are All, Intensity, Red, Green, Blue,
3500 Cyan, Magenta, Yellow, Black, and Opacity
3501 When channeltype is "All", the color samples are thresholded
3503 into a graylevel and then that gray level is stored in the three
3504 color channels. Separately, the opacity channel is thresholded
3505 into a bilevel opacity value which is stored in the opacity
3506 channel. For each pixel, a new random number is used to estab‐
3507 lish the threshold to be used. The threshold never exceeds the
3508 specified maximum (HIGH) and is never less than the specified
3509 minimum (LOW).
3510 When channeltype is "intensity", only the color samples are
3512 thresholded. When channeltype is "opacity" or "matte", only the
3513 opacity channel is thresholded. The other named channels only
3514 threshold the associated channel.
3515 -recolor <matrix>
3517 apply a color translation matrix to image channels
3518 A user supplied color translation matrix (expressed as a text
3520 string) is used to translate/blend the image channels based on
3521 weightings in a supplied matrix which may be of order 3 (color
3522 channels only), 4 (color channels plus opacity), or 5 (color
3523 channels plus opacity and offset). Values in the columns of the
3524 matrix (red, green, blue, opacity) are used as multipliers with
3525 the existing channel values and added together according to the
3526 rows of the matrix. Matrix values are floating point and may be
3527 negative. The offset column (column 5) is purely additive and
3528 is scaled such that 0.0 to 1.0 represents the maximum quantum
3529 range (but values are not limited to this range). The math for
3530 the color translation matrix is similar to that used by Adobe
3531 Flash except that the offset is scaled to 1.0 (divide Flash off‐
3532 set by 255 for use with GraphicsMagick) so that the results are
3533 independent of quantum depth.
3534 An identity matrix exists for each matrix order which results in
3536 no change to the image. The translation matrix should be based
3537 on an alteration of the identity matrix.
3538 Identity matrix of order 3
3540 1 0 0
3542 0 1 0
3543 0 0 1
3544 which may be formatted into a convenient matrix argument similar
3547 to (comma is treated as white space):
3548 -recolor "1 0 0, 0 1 0, 0 0 1"
3550 Identity matrix of order 4
3553 1 0 0 0
3555 0 1 0 0
3556 0 0 1 0
3557 0 0 0 1
3558 Identity matrix of order 5. The last row is required to exist
3561 for the purpose of parsing, but is otherwise not used.
3562 1 0 0 0 0
3564 0 1 0 0 0
3565 0 0 1 0 0
3566 0 0 0 1 0
3567 0 0 0 0 1
3568 As an example, an image wrongly in BGR channel order may be con‐
3571 verted to RGB using this matrix (blue->red, red->blue):
3572 0 0 1
3574 0 1 0
3575 1 0 0
3576 and an RGB image using standard Rec.709 primaries may be con‐
3579 verted to grayscale using this matrix of standard weighting fac‐
3580 tors:
3581 0.2126 0.7152 0.0722
3583 0.2126 0.7152 0.0722
3584 0.2126 0.7152 0.0722
3585 and contrast may be reduced by scaling down by 80% and adding a
3588 10% offset:
3589 0.8 0.0 0.0 0.0 0.1
3591 0.0 0.8 0.0 0.0 0.1
3592 0.0 0.0 0.8 0.0 0.1
3593 0.0 0.0 0.0 0.8 0.1
3594 0.0 0.0 0.0 0.0 1.0
3595 -red-primary <x>,<y>
3598 red chromaticity primary point
3599 -region <width>x<height>{+-}<x>{+-}<y>
3601 apply options to a portion of the image
3602 The x and y offsets are treated in the same manner as in -crop.
3604 -remote
3606 perform a X11 remote operation
3607 The -remote command sends a command to a "gm display" or "gm
3609 animate" which is already running. The only command recognized
3610 at this time is the name of an image file to load. This capabil‐
3611 ity is very useful to load new images without needing to restart
3612 GraphicsMagick (e.g. for a slide-show or to use GraphicsMagick
3613 as the display engine for a different GUI). Also see the
3614 +progress option for a way to disable progress indication for a
3615 clean look while loading new images.
3616 -render
3618 render vector operations
3619 Use +render to turn off rendering vector operations. This is
3621 useful when saving the result to vector formats such as MVG or
3622 SVG.
3623 -repage <width>x<height>+xoff+yoff[!]
3625 Adjust image page offsets
3626 Adjust the current image page canvas and position based on a
3628 relative page specification. This option may be used to change
3629 the location of a subframe (e.g. part of an animation) prior to
3630 composition. If the geometry specification is absolute
3631 (includes a '!'), then the offset adjustment is absolute and
3632 there is no adjustment to page width and height, otherwise the
3633 page width and height values are also adjusted based on the cur‐
3634 rent image dimensions. Use +repage to set the image page off‐
3635 sets to default.
3636 -resample <horizontal>x<vertical>
3638 Resample image to specified horizontal and vertical resolution
3639 Resize the image so that its rendered size remains the same as
3641 the original at the specified target resolution. Either the cur‐
3642 rent image resolution units or the previously set with -units
3643 are used to interpret the argument. For example, if a 300 DPI
3644 image renders at 3 inches by 2 inches on a 300 DPI device, when
3645 the image has been resampled to 72 DPI, it will render at 3
3646 inches by 2 inches on a 72 DPI device. Note that only a small
3647 number of image formats (e.g. JPEG, PNG, and TIFF) are capable
3648 of storing the image resolution. For formats which do not sup‐
3649 port an image resolution, the original resolution of the image
3650 must be specified via -density on the command line prior to
3651 specifying the resample resolution.
3652 Note that Photoshop stores and obtains image resolution from a
3654 proprietary embedded profile. If this profile exists in the
3655 image, then Photoshop will continue to treat the image using its
3656 former resolution, ignoring the image resolution specified in
3657 the standard file header.
3658 Some image formats (e.g. PNG) require use of metric or english
3660 units so even if the original image used a particular unit sys‐
3661 tem, if it is saved to a different format prior to resampling,
3662 then it may be necessary to specify the desired resolution units
3663 using -units since the original units may have been lost. In
3664 other words, do not assume that the resolution units are
3665 restored if the image has been saved to a file.
3666 -resize <width>x<height>{%}{@}{!}{<}{>}
3668 resize an image
3669 This is an alias for the -geometry option and it behaves in the
3671 same manner. If the -filter option precedes the -resize option,
3672 the specified filter is used.
3673 There are some exceptions:
3675 When used as a composite option, -resize conveys the preferred
3677 size of the output image, while -geometry conveys the size and
3678 placement of the composite image within the main image.
3679 When used as a montage option, -resize conveys the preferred
3681 size of the montage, while -geometry conveys information about
3682 the tiles.
3683 -roll {+-}<x>{+-}<y>
3685 roll an image vertically or horizontally
3686 See -geometry for details the geometry specification. The x and
3688 y offsets are not affected by the -gravity option.
3689 A negative x offset rolls the image left-to-right. A negative y
3691 offset rolls the image top-to-bottom.
3692 -rotate <degrees>{<}{>}
3694 rotate the image
3695 Positive angles rotate the image in a clockwise direction while
3697 negative angles rotate counter-clockwise.
3698 Use > to rotate the image only if its width exceeds the height.
3700 < rotates the image only if its width is less than the height.
3701 For example, if you specify -rotate "-90>" and the image size is
3702 480x640, the image is not rotated. However, if the image is
3703 640x480, it is rotated by -90 degrees. If you use > or <,
3704 enclose it in quotation marks to prevent it from being misinter‐
3705 preted as a file redirection.
3706 Empty triangles left over from rotating the image are filled
3708 with the color defined as background (class backgroundColor).
3709 The color is specified using the format described under the
3710 -fill option.
3711 -sample <geometry>
3713 scale image using pixel sampling
3714 See -geometry for details about the geometry specification.
3716 -sample ignores the -filter selection if the -filter option is
3717 present. Offsets, if present in the geometry string, are
3718 ignored, and the -gravity option has no effect.
3719 -sampling-factor <horizontal_factor>x<vertical_factor>
3721 chroma subsampling factors
3722 This option specifies the sampling factors to be used by the
3724 DPX, JPEG, MPEG, or YUV encoders for chroma downsampling. The
3725 sampling factor must be specified while reading the raw YUV for‐
3726 mat since it is not preserved in the file header. Industry-
3727 standard video subsampling notation such as "4:2:2" may also be
3728 used to specify the sampling factors. "4:2:2" is equivalent to a
3729 specification of "2x1"
3730 The JPEG decoder obtains the original sampling factors (and
3732 quality settings) when a JPEG file is read. To re-use the origi‐
3733 nal sampling factors (and quality setting) when JPEG is output,
3734 use the -define jpeg:preserve-settings flag.
3735 -scale <geometry>
3737 scale the image.
3738 See -geometry for details about the geometry specification.
3740 -scale uses a simpler, faster algorithm, and it ignores the
3741 -filter selection if the -filter option is present. Offsets, if
3742 present in the geometry string, are ignored, and the -gravity
3743 option has no effect.
3744 -scene <value>
3746 set scene number
3747 This option sets the scene number of an image or the first image
3749 in an image sequence.
3750 -scenes <value-value>
3752 range of image scene numbers to read
3753 Each image in the range is read with the filename followed by a
3755 period (.) and the decimal scene number. You can change this
3756 behavior by embedding a %d, %0Nd, %o, %0No, %x, or %0Nx printf
3757 format specification in the file name. For example,
3758 gm montage -scenes 5-7 image.miff montage.miff
3760 makes a montage of files image.miff.5, image.miff.6, and
3763 image.miff.7, and
3764 gm animate -scenes 0-12 image%02d.miff
3766 animates files image00.miff, image01.miff, through image12.miff.
3769 -screen
3771 specify the screen to capture
3772 This option indicates that the GetImage request used to obtain
3774 the image should be done on the root window, rather than
3775 directly on the specified window. In this way, you can obtain
3776 pieces of other windows that overlap the specified window, and
3777 more importantly, you can capture menus or other popups that are
3778 independent windows but appear over the specified window.
3779 -set <attribute> <value>
3781 set an image attribute
3782 Set a named image attribute. The attribute is set on the cur‐
3784 rent (previously specified on command line) image.
3785 +set <attribute>
3787 unset an image attribute
3788 Unset a named image attribute. The attribute is removed from
3790 the current (previously specified on command line) image.
3791 -segment <cluster threshold>x<smoothing threshold>
3793 segment an image
3794 Segment an image by analyzing the histograms of the color compo‐
3796 nents and identifying units that are homogeneous with the fuzzy
3797 c-means technique.
3798 Segmentation is a very useful fast and and approximate color
3800 quantization algorithm for scanned printed pages or scanned car‐
3801 toons. It may also be used as a special effect. Specify cluster
3802 threshold as the minimum percentage of total pixels in a cluster
3803 before it is considered valid. For huge images containing small
3804 detail, this may need to be a tiny fraction of a percent (e.g.
3805 0.015) so that important detail is not lost. Smoothing thresh‐
3806 old eliminates noise in the second derivative of the histogram.
3807 As the value is increased, you can expect a smoother second de‐
3808 rivative. The default is 1.5. Add the -verbose option to see a
3809 dump of cluster statistics given the parameters used. The sta‐
3810 tistics may be used as a guide to help fine tune the options.
3811 -shade <azimuth>x<elevation>
3813 shade the image using a distant light source
3814 Specify azimuth and elevation as the position of the light
3816 source. Use +shade to return the shading results as a grayscale
3817 image.
3818 -shadow <radius>{x<sigma>}
3820 shadow the montage
3821 -shared-memory
3823 use shared memory
3824 This option specifies whether the utility should attempt to use
3826 shared memory for pixmaps. GraphicsMagick must be compiled with
3827 shared memory support, and the display must support the MIT-SHM
3828 extension. Otherwise, this option is ignored. The default is
3829 True.
3830 -sharpen <radius>{x<sigma>}
3832 sharpen the image
3833 Use a Gaussian operator of the given radius and standard devia‐
3835 tion (sigma).
3836 -shave <width>x<height>{%}
3838 shave pixels from the image edges
3839 Specify the width of the region to be removed from both sides of
3841 the image and the height of the regions to be removed from top
3842 and bottom.
3843 -shear <x degrees>x<y degrees>
3845 shear the image along the X or Y axis
3846 Use the specified positive or negative shear angle.
3848 Shearing slides one edge of an image along the X or Y axis, cre‐
3850 ating a parallelogram. An X direction shear slides an edge along
3851 the X axis, while a Y direction shear slides an edge along the Y
3852 axis. The amount of the shear is controlled by a shear angle.
3853 For X direction shears, x degrees is measured relative to the Y
3854 axis, and similarly, for Y direction shears y degrees is mea‐
3855 sured relative to the X axis.
3856 Empty triangles left over from shearing the image are filled
3858 with the color defined as background (class backgroundColor).
3859 The color is specified using the format described under the
3860 -fill option.
3861 -silent
3863 operate silently
3864 -size <width>x<height>{+offset}
3866 width and height of the image
3867 Use this option to specify the width and height of raw images
3869 whose dimensions are unknown such as GRAY, RGB, or CMYK. In
3870 addition to width and height, use -size with an offset to skip
3871 any header information in the image or tell the number of colors
3872 in a MAP image file, (e.g. -size 640x512+256).
3873 For Photo CD images, choose from these sizes:
3875 192x128
3877 384x256
3878 768x512
3879 1536x1024
3880 3072x2048
3881 Finally, use this option to choose a particular resolution layer
3884 of a JBIG or JPEG image (e.g. -size 1024x768).
3885 -snaps <value>
3887 number of screen snapshots
3888 Use this option to grab more than one image from the X server
3890 screen, to create an animation sequence.
3891 -solarize <factor>
3893 negate all pixels above the threshold level
3894 Specify factor as the percent threshold of the intensity (0 -
3896 99.9%).
3897 This option produces a solarization effect seen when exposing a
3899 photographic film to light during the development process.
3900 -spread <amount>
3902 displace image pixels by a random amount
3903 Amount defines the size of the neighborhood around each pixel to
3905 choose a candidate pixel to swap.
3906 -stegano <offset>
3908 hide watermark within an image
3909 Use an offset to start the image hiding some number of pixels
3911 from the beginning of the image. Note this offset and the image
3912 size. You will need this information to recover the stegano‐
3913 graphic image (e.g. display -size 320x256+35 stegano:image.png).
3914 -stereo
3916 composite two images to create a stereo anaglyph
3917 The left side of the stereo pair is saved as the red channel of
3919 the output image. The right side is saved as the green channel.
3920 Red-green stereo glasses are required to properly view the
3921 stereo image.
3922 -strip remove all profiles and text attributes from the image
3924 All embedded profiles and text attributes are stripped from the
3926 image. This is useful for images used for the web, or when out‐
3927 put files need to be as small as possible
3928 Be careful not to use this option to remove author, copyright,
3930 and license information that you are required to retain when
3931 redistributing an image.
3932 -stroke <color>
3934 color to use when stroking a graphic primitive
3935 The color is specified using the format described under the
3937 -fill option.
3938 See -draw for further details.
3940 -strokewidth <value>
3942 set the stroke width
3943 See -draw for further details.
3945 -swirl <degrees>
3947 swirl image pixels about the center
3948 Degrees defines the tightness of the swirl.
3950 -text-font <name>
3952 font for writing fixed-width text
3953 Specifies the name of the preferred font to use in fixed (type‐
3955 writer style) formatted text. The default is 14 point Courier.
3956 You can tag a font to specify whether it is a PostScript, True‐
3958 Type, or X11 font. For example, Courier.ttf is a TrueType font
3959 and x:fixed is X11.
3960 -texture <filename>
3962 name of texture to tile onto the image background
3963 -threshold <value>{%}
3965 threshold the image
3966 Modify the image such that any pixel sample with an intensity
3968 value greater than the threshold is assigned the maximum inten‐
3969 sity (white), or otherwise is assigned the minimum intensity
3970 (black). If a percent prefix is applied, then the threshold is a
3971 percentage of the available range.
3972 To efficiently create a black and white image from a color
3974 image, use
3975 gm convert -threshold 50% in.png out.png
3977 The optimum threshold value depends on the nature of the image.
3980 In order to threshold individual channels, use the -operator
3981 subcommand with it's Threshold, Threshold-White, or Threshold-
3982 Black options.
3983 -thumbnail <width>x<height>{%}{@}{!}{<}{>}
3985 resize an image (quickly)
3986 The -thumbnail command resizes the image as quickly as possible,
3988 with more concern for speed than resulting image quality.
3989 Regardless, resulting image quality should be acceptable for
3990 many uses. It is primarily intended to be used to generate
3991 smaller versions of the image, but may also be used to enlarge
3992 the image. The -thumbnail geometry argument observes the same
3993 syntax and rules as it does for -resize.
3994 -tile <filename>
3996 tile image when filling a graphic primitive
3997 -tile <geometry>
3999 layout of images [montage]
4000 -title <string>
4002 assign title to displayed image [animate, display, montage]
4003 Use this option to assign a specific title to the image. This is
4005 assigned to the image window and is typically displayed in the
4006 window title bar. Optionally you can include the image file‐
4007 name, type, width, height, Exif data, or other image attribute
4008 by embedding special format characters described under the -for‐
4009 mat option.
4010 For example,
4012 -title "%m:%f %wx%h"
4014 produces an image title of MIFF:bird.miff 512x480 for an image
4017 titled bird.miff and whose width is 512 and height is 480.
4018 -transform
4020 transform the image
4021 This option applies the transformation matrix from a previous
4023 -affine option.
4024 gm convert -affine 2,2,-2,2,0,0 -transform bird.ppm bird.jpg
4026 -transparent <color>
4029 make this color transparent within the image
4030 The color is specified using the format described under the
4032 -fill option.
4033 -treedepth <value>
4035 tree depth for the color reduction algorithm
4036 Normally, this integer value is zero or one. A value of zero or
4038 one causes the use of an optimal tree depth for the color reduc‐
4039 tion algorithm
4040 An optimal depth generally allows the best representation of the
4042 source image with the fastest computational speed and the least
4043 amount of memory. However, the default depth is inappropriate
4044 for some images. To assure the best representation, try values
4045 between 2 and 8 for this parameter. Refer to quantize for more
4046 details.
4047 The -colors or -monochrome option, or writing to an image format
4049 which requires color reduction, is required for this option to
4050 take effect.
4051 -trim trim an image
4053 This option removes any edges that are exactly the same color as
4055 the corner pixels. Use -fuzz to make -trim remove edges that
4056 are nearly the same color as the corner pixels.
4057 -type <type>
4059 the image type
4060 Choose from: Bilevel, Grayscale, Palette, PaletteMatte, True‐
4062 Color, TrueColorMatte, ColorSeparation, ColorSeparationMatte, or
4063 Optimize.
4064 Normally, when a format supports different subformats such as
4066 bilevel, grayscale, palette, truecolor, and truecolor+alpha, the
4067 encoder will try to choose a suitable subformat based on the
4068 nature of the image. The -type option may be used to tailor the
4069 output subformat. By default the output subformat is based on
4070 readily available image information and is usually similar to
4071 the input format.
4072 Specify -type Optimize in order to enable inspecting all pixels
4074 (if necessary) in order to find the most efficient subformat.
4075 Inspecting all of the pixels may be slow for very large images,
4076 particularly if they are stored in a disk cache. If an RGB image
4077 contains only gray pixels, then every pixel in the image must be
4078 inspected in order to decide that the image is actually
4079 grayscale!
4080 Sometimes a specific subformat is desired. For example, to force
4082 a JPEG image to be written in TrueColor RGB format even though
4083 only gray pixels are present, use
4084 gm convert bird.pgm -type TrueColor bird.jpg
4086 Similarly, using -type TrueColorMatte will force the encoder to
4089 write an alpha channel even though the image is opaque, if the
4090 output format supports transparency.
4091 Some pseudo-formats (e.g. the XC format) will respect the
4093 requested type if it occurs previously on the command line. For
4094 example, to obtain a DirectClass solid color canvas image rather
4095 than PsuedoClass, use
4096 gm convert -size 640x480 -type TrueColor xc:red red.miff
4098 Likewise, specify -type Bilevel, Grayscale, TrueColor, or True‐
4101 ColorMatte prior to reading a Postscript (or PDF file) in order
4102 to influence the type of image that Ghostcript returns. Reading
4103 performance will be dramatically improved for black/white Post‐
4104 script if Bilevel is specified, and will be considerably faster
4105 if Grayscale is specified.
4106 -update <seconds>
4108 detect when image file is modified and redisplay.
4109 Suppose that while you are displaying an image the file that is
4111 currently displayed is over-written. display will automatically
4112 detect that the input file has been changed and update the dis‐
4113 played image accordingly.
4114 -units <type>
4116 the units of image resolution
4117 Choose from: Undefined, PixelsPerInch, or PixelsPerCentimeter.
4119 This option is normally used in conjunction with the -density
4120 option.
4121 -unsharp <radius>{x<sigma>}{+<amount>}{+<threshold>}
4123 sharpen the image with an unsharp mask operator
4124 The -unsharp option sharpens an image. The image is convolved
4126 with a Gaussian operator of the given radius and standard devia‐
4127 tion (sigma). For reasonable results, radius should be larger
4128 than sigma. Use a radius of 0 to have the method select a suit‐
4129 able radius.
4130 The parameters are:
4132 radius
4135 The radius of the Gaussian, in pixels, not counting the
4138 center pixel (default 0).
4139 sigma
4141 The standard deviation of the Gaussian, in pixels (default
4144 1.0).
4145 amount
4147 The percentage of the difference between the original and
4150 the blur image that is added back into the original
4151 (default 1.0).
4152 threshold
4154 The threshold, as a fraction of MaxRGB, needed to apply
4157 the difference amount (default 0.05).
4158 -use-pixmap
4163 use the pixmap
4164 -verbose
4166 print detailed information about the image
4167 This information is printed: image scene number; image name;
4169 image size; the image class (DirectClass or PseudoClass); the
4170 total number of unique colors; and the number of seconds to read
4171 and transform the image. If the image is DirectClass, the total
4172 number of unique colors is not displayed unless -verbose is
4173 specified twice since it may take quite a long time to compute,
4174 particularly for deep images. If the image is PseudoClass then
4175 its pixels are defined by indexes into a colormap. If the image
4176 is DirectClass then each pixel includes a complete and indepen‐
4177 dent color specification.
4178 If -colors is also specified, the total unique colors in the
4180 image and color reduction error values are printed. Refer to
4181 quantize for a description of these values.
4182 -version
4184 print GraphicsMagick version string
4185 -view <string>
4187 FlashPix viewing parameters
4188 -virtual-pixel <method>
4190 specify contents of "virtual pixels"
4191 This option defines "virtual pixels" for use in operations that
4193 can access pixels outside the boundaries of an image.
4194 Choose from these methods:
4196 Constant
4199 Use the image background color.
4202 Edge
4204 Extend the edge pixel toward infinity (default).
4207 Mirror
4209 Mirror the image.
4212 Tile
4214 Tile the image.
4217 This option affects operations that use virtual pixels such as
4222 -blur, -sharpen, -wave, etc.
4223 -visual <type>
4225 animate images using this X visual type
4226 Choose from these visual classes:
4228 StaticGray
4230 GrayScale
4231 StaticColor
4232 PseudoColor
4233 TrueColor
4234 DirectColor
4235 default
4236 visual id
4237 The X server must support the visual you choose, otherwise an
4240 error occurs. If a visual is not specified, the visual class
4241 that can display the most simultaneous colors on the default
4242 screen is chosen.
4243 -watermark <brightness>x<saturation>
4245 percent brightness and saturation of a watermark
4246 -wave <amplitude>x<wavelength>
4248 alter an image along a sine wave
4249 Specify amplitude and wavelength of the wave.
4251 -white-point <x>,<y>
4253 chromaticity white point
4254 -white-threshold red[,green][,blue][,opacity]
4256 pixels above the threshold become white
4257 Use -white-threshold to set pixels with values above the speci‐
4259 fied threshold to maximum value (white). If only one value is
4260 supplied, or the red, green, and blue values are identical, then
4261 intensity thresholding is used. If the color threshold values
4262 are not identical then channel-based thresholding is used, and
4263 color distortion will occur. Specify a negative value (e.g. -1)
4264 if you want a channel to be ignored but you do want to threshold
4265 a channel later in the list. If a percent (%) symbol is
4266 appended, then the values are treated as a percentage of maximum
4267 range.
4268 -window <id>
4270 make image the background of a window
4271 id can be a window id or name. Specify root to select X's root
4273 window as the target window.
4274 By default the image is tiled onto the background of the target
4276 window. If backdrop or -geometry are specified, the image is
4277 surrounded by the background color. Refer to X RESOURCES for
4278 details.
4279 The image will not display on the root window if the image has
4281 more unique colors than the target window colormap allows. Use
4282 -colors to reduce the number of colors.
4283 -window-group
4285 specify the window group
4286 -write <filename>
4288 write an intermediate image [convert, composite]
4289 The current image is written to the specified filename and then
4291 processing continues using that image. The following is an exam‐
4292 ple of how several sizes of an image may be generated in one
4293 command (repeat as often as needed):
4294 gm convert input.jpg -resize 50% -write input50.jpg \
4296 -resize 25% input25.jpg
4297 -write <filename>
4300 write the image to a file [display]
4301 If filename already exists, you will be prompted as to whether
4303 it should be overwritten.
4304 By default, the image is written in the format that it was read
4306 in as. To specify a particular image format, prefix filename
4307 with the image type and a colon (e.g., ps:image) or specify the
4308 image type as the filename suffix (e.g., image.ps). Specify file
4309 as - for standard output. If file has the extension .Z or .gz,
4310 the file size is compressed using compress or gzip respectively.
4311 Precede the image file name with | to pipe to a system command.
4312 Use -compress to specify the type of image compression.
4314 The equivalent X resource for this option is writeFilename
4316 (class WriteFilename). See "X Resources", below, for details.
4317
4319 COLUMNS
4320 Output screen width. Used when formatting text for the screen.
4321 Many Unix systems keep this shell variable up to date, but it
4322 may need to be explicitly exported in order for GraphicsMagick
4323 to see it.
4324 DISPLAY
4326 X11 display ID (host, display number, and screen in the form
4327 hostname:display.screen).
4328 HOME Location of user's home directory. GraphicsMagick searches for
4330 configuration files in $HOME/.magick if the directory exists.
4331 See MAGICK_CODER_MODULE_PATH, MAGICK_CONFIGURE_PATH, and MAG‐
4332 ICK_FILTER_MODULE_PATH if more flexibility is needed.
4333 MAGICK_ACCESS_MONITOR
4335 When set to TRUE, command line monitor mode (enabled by -moni‐
4336 tor) will also show files accessed (including temporary files)
4337 and any external commands which are executed. This is useful for
4338 debugging, but also illustrates arguments made available to an
4339 access handler registered by the MagickSetConfirmAccessHandler()
4340 C library function.
4341 MAGICK_CODER_STABILITY
4343 The minimum coder stability level before it will be used. The
4344 available levels are PRIMARY, STABLE, UNSTABLE, and BROKEN. The
4345 default minimum level is UNSTABLE, which means that all avail‐
4346 able working coders will be used. The purpose of this option is
4347 to reduce the security exposure (or apparent complexity) due to
4348 the huge number of formats supported. Coders at the PRIMARY
4349 level are commonly used formats with very well maintained imple‐
4350 mentations. Coders at the STABLE level are reasonably well main‐
4351 tained but represent less used formats. Coders at the UNSTABLE
4352 level either have weak implementations, the file format itself
4353 is weak, or the probability the coder will be needed is vanish‐
4354 ingly small. Coders at the BROKEN level are known to often not
4355 work properly or might not be useful in their current state at
4356 all.
4357 MAGICK_CODER_MODULE_PATH
4359 Search path to use when searching for image format coder mod‐
4360 ules. This path allows the user to arbitrarily extend the image
4361 formats supported by GraphicsMagick by adding loadable modules
4362 to an arbitrary location rather than copying them into the
4363 GraphicsMagick installation directory. The formatting of the
4364 search path is similar to operating system search paths (i.e.
4365 colon delimited for Unix, and semi-colon delimited for Microsoft
4366 Windows). This user specified search path is used before trying
4367 the default search path.
4368 MAGICK_CONFIGURE_PATH
4370 Search path to use when searching for configuration (.mgk)
4371 files. The formatting of the search path is similar to operat‐
4372 ing system search paths (i.e. colon delimited for Unix, and
4373 semi-colon delimited for Microsoft Windows). This user specified
4374 search path is used before trying the default search path.
4375 MAGICK_DEBUG
4377 Debug options (see -debug for details). Setting debug options
4378 via an environment variable is currently necessary to see the
4379 complete initialization process.
4380 MAGICK_FILTER_MODULE_PATH
4382 Search path to use when searching for filter process modules
4383 (invoked via -process). This path allows the user to arbitrarily
4384 extend GraphicsMagick's image processing functionality by adding
4385 loadable modules to an arbitrary location rather than copying
4386 them into the GraphicsMagick installation directory. The format‐
4387 ting of the search path is similar to operating system search
4388 paths (i.e. colon delimited for Unix, and semi-colon delimited
4389 for Microsoft Windows). This user specified search path is used
4390 before trying the default search path.
4391 MAGICK_GHOSTSCRIPT_PATH
4393 For Microsoft Windows, specify the path to the Ghostscript
4394 installation rather than searching for it via the Windows reg‐
4395 istry. This helps in case Ghostscript is not installed via the
4396 Ghostscript Windows installer or the user wants more control
4397 over the Ghostscript used.
4398 MAGICK_HOME
4400 Path to top of GraphicsMagick installation directory. Only
4401 observed by "uninstalled" builds of GraphicsMagick which do not
4402 have their location hard-coded or set by an installer.
4403 MAGICK_MMAP_READ
4405 If MAGICK_MMAP_READ is set to TRUE, GraphicsMagick will attempt
4406 to memory-map the input file for reading. This usually substan‐
4407 tially improves repeated read performance since the file is
4408 already in memory after the first time it has been read. How‐
4409 ever, testing shows that performance may be reduced for files
4410 accessed for the first time since data is accessed via page-
4411 faults (upon first access) and many operating systems fail to do
4412 sequential read-ahead of memory mapped files, and particularly
4413 if those files are accessed over a network. If many large input
4414 files are read, then enabling this option may harm performance
4415 by overloading the operating system's VM system as it then needs
4416 to free unmapped pages and map new ones.
4417 MAGICK_IO_FSYNC
4419 If MAGICK_IO_FSYNC is set to TRUE, then GraphicsMagick will
4420 request that the output file is fully flushed and synchronized
4421 to disk when it is closed. This incurs a performance penalty,
4422 but has the benefit that if the power fails or the system
4423 crashes, the file should be valid on disk. If image files are
4424 referenced from a database, then this option helps assure that
4425 the files referenced by the database are valid.
4426 MAGICK_IOBUF_SIZE
4428 The amount of I/O buffering (in bytes) to use when reading and
4429 writing encoded files. The default is 16384, which is observed
4430 to work well for many cases. The best value for a local filesys‐
4431 tem is usually the the native filesystem block size (e.g. 4096,
4432 8192, or even 131,072 for ZFS) in order to minimize the number
4433 of physical disk I/O operations. I/O performance to files
4434 accessed over a network may benefit significantly by tuning this
4435 option. Larger values are not necessarily better (they may be
4436 slower!), and there is rarely any benefit from using values
4437 larger than 32768. Use convert's -verbose option in order to
4438 evaluate read and write rates in pixels per second while keeping
4439 in mind that the operating system will try to cache files in
4440 RAM.
4441 MAGICK_LIMIT_DISK
4443 Maximum amount of disk space allowed for use by the pixel cache.
4444 MAGICK_LIMIT_FILES
4446 Maximum number of open files.
4447 MAGICK_LIMIT_MAP
4449 Maximum size of a memory mapped file allocation. A memory
4450 mapped file consumes memory when the file is accessed, although
4451 the system may reclaim such memory when needed.
4452 MAGICK_LIMIT_MEMORY
4454 Maximum amount of memory to allocate from the heap.
4455 MAGICK_LIMIT_PIXELS
4457 Maximum number of total pixels (image rows times image colums)
4458 to allow for any image which is requested to be created or read.
4459 This is useful to place a limit on how large an image may be.
4460 If the input image file has image dimensions larger than the
4461 pixel limit, then the image memory allocation is denied and an
4462 error is returned immediately. This is a per-image limit and
4463 does not limit the total number of pixels due to multiple image
4464 frames/pages (e.g. multi-page document or an animation).
4465 MAGICK_LIMIT_WIDTH
4467 Maximum pixel width of an image read, or created.
4468 MAGICK_LIMIT_HEIGHT
4470 Maximum pixel height of an image read, or created.
4471 MAGICK_TMPDIR
4473 Path to directory where GraphicsMagick should write temporary
4474 files. The default is to use the system default, or the location
4475 set by TMPDIR.
4476 TMPDIR For POSIX-compatible systems (Unix-compatible), the path to the
4478 directory where all applications should write temporary files.
4479 Overridden by MAGICK_TMPDIR if it is set.
4480 TMP or TEMP
4482 For Microsoft Windows, the path to the directory where applica‐
4483 tions should write temporary files. Overridden by MAGICK_TMPDIR
4484 if it is set.
4485 OMP_NUM_THREADS
4487 As per the OpenMP standard, this specifies the number of threads
4488 to use in parallel regions. Some compilers default the number of
4489 threads to use to the number of processor cores available while
4490 others default to just one thread. See the OpenMP specification
4491 for other standard adjustments and your compiler's manual for
4492 vendor-specific settings.
4493
4495 GraphicsMagick uses a number of XML format configuration files:
4496 colors.mgk
4498 colors configuration file
4499 <?xml version="1.0"?>
4501 <colormap>
4502 <color name="AliceBlue" red="240" green="248" blue="255"
4503 compliance="SVG, X11, XPM" />
4504 </colormap>
4505 delegates.mgk
4508 delegates configuration file
4509 log.mgk
4511 logging configuration file
4512 <?xml version="1.0"?>
4514 <magicklog>
4515 <log events="None" />
4516 <log output="stdout" />
4517 <log filename="Magick-%d.log" />
4518 <log generations="3" />
4519 <log limit="2000" />
4520 <log format="%t %r %u %p %m/%f/%l/%d:\n %e" />
4521 </magicklog>
4522 modules.mgk
4525 loadable modules configuration file
4526 <?xml version="1.0"?>
4528 <modulemap>
4529 <module magick="8BIM" name="META" />
4530 </modulemap>
4531 type.mgk
4534 master type (fonts) configuration file
4535 <?xml version="1.0"?>
4537 <typemap>
4538 <include file="type-windows.mgk" />
4539 <type
4540 name="AvantGarde-Book"
4541 fullname="AvantGarde Book"
4542 family="AvantGarde"
4543 foundry="URW"
4544 weight="400"
4545 style="normal"
4546 stretch="normal"
4547 format="type1"
4548 metrics="/usr/local/share/ghostscript/fonts/a010013l.afm"
4549 glyphs="/usr/local/share/ghostscript/fonts/a010013l.pfb"
4550 />
4551 </typemap>
4552
4555 Animate displays a sequence of images on any workstation display run‐
4556 ning an X server. animate first determines the hardware capabilities of
4557 the workstation. If the number of unique colors in an image is less
4558 than or equal to the number the workstation can support, the image is
4559 displayed in an X window. Otherwise the number of colors in the image
4560 is first reduced to match the color resolution of the workstation
4561 before it is displayed.
4562 This means that a continuous-tone 24 bits-per-pixel image can display
4564 on a 8 bit pseudo-color device or monochrome device. In most instances
4565 the reduced color image closely resembles the original. Alternatively,
4566 a monochrome or pseudo-color image sequence can display on a continu‐
4567 ous-tone 24 bits-per-pixel device.
4568 To help prevent color flashing on X server visuals that have colormaps,
4570 animate creates a single colormap from the image sequence. This can be
4571 rather time consuming. You can speed this operation up by reducing the
4572 colors in the image before you "animate" them. Use mogrify to color
4573 reduce the images to a single colormap. See mogrify(1) for details.
4574 Alternatively, you can use a Standard Colormap; or a static, direct, or
4575 true color visual. You can define a Standard Colormap with xstdcmap.
4576 See xstdcmap(1) for details. This method is recommended for colormapped
4577 X server because it eliminates the need to compute a global colormap.
4578
4580 To animate a set of images of a cockatoo, use:
4581 gm animate cockatoo.*
4583 To animate a cockatoo image sequence while using the Standard Colormap
4586 best, use:
4587 xstdcmap -best
4589 gm animate -map best cockatoo.*
4590 To animate an image of a cockatoo without a border centered on a back‐
4593 drop, use:
4594 gm animate +borderwidth -backdrop cockatoo.*
4597
4600 For a more detailed description of each option, see Options, above.
4601 -authenticate <string>
4604 decrypt image with this password
4605 -backdrop
4607 display the image centered on a backdrop.
4608 -background <color>
4610 the background color
4611 -bordercolor <color>
4613 the border color
4614 -borderwidth <geometry>
4616 the border width
4617 -chop <width>x<height>{+-}<x>{+-}<y>{%}
4619 remove pixels from the interior of an image
4620 -colormap <type>
4622 define the colormap type
4623 -colors <value>
4625 preferred number of colors in the image
4626 -colorspace <value>
4628 the type of colorspace
4629 -crop <width>x<height>{+-}<x>{+-}<y>{%}
4631 preferred size and location of the cropped image
4632 -debug <events>
4634 enable debug printout
4635 -define <key>{=<value>},...
4637 add coder/decoder specific options
4638 -delay <1/100ths of a second>
4640 display the next image after pausing
4641 -density <width>x<height>
4643 horizontal and vertical resolution in pixels of the image
4644 -depth <value>
4646 depth of the image
4647 -display <host:display[.screen]>
4649 specifies the X server to contact
4650 -dispose <method>
4652 GIF disposal method
4653 -dither
4655 apply Floyd/Steinberg error diffusion to the image
4656 -font <name>
4658 use this font when annotating the image with text
4659 -foreground <color>
4661 define the foreground color
4662 -gamma <value>
4664 level of gamma correction
4665 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
4667 Specify dimension, offset, and resize options.
4668 -help print usage instructions
4670 -iconGeometry <geometry>
4672 specify the icon geometry
4673 -iconic
4675 iconic animation
4676 -interlace <type>
4678 the type of interlacing scheme
4679 -limit <type> <value>
4681 Disk, File, Map, Memory, Pixels, Width, Height or Threads
4682 resource limit
4683 -log <string>
4685 Specify format for debug log
4686 -map <type>
4688 display image using this type.
4689 -matte store matte channel if the image has one
4691 -mattecolor <color>
4693 specify the color to be used with the -frame option
4694 -monitor
4696 show progress indication
4697 -monochrome
4699 transform the image to black and white
4700 -name name an image
4702 -noop NOOP (no option)
4704 -pause <seconds>
4706 pause between animation loops [animate]
4707 -remote
4709 perform a X11 remote operation
4710 -rotate <degrees>{<}{>}
4712 rotate the image
4713 -sampling-factor <horizontal_factor>x<vertical_factor>
4715 chroma subsampling factors
4716 -scenes <value-value>
4718 range of image scene numbers to read
4719 -shared-memory
4721 use shared memory
4722 -size <width>x<height>{+offset}
4724 width and height of the image
4725 -text-font <name>
4727 font for writing fixed-width text
4728 -title <string>
4730 assign title to displayed image [animate, display, montage]
4731 -treedepth <value>
4733 tree depth for the color reduction algorithm
4734 -trim trim an image
4736 -type <type>
4738 the image type
4739 -verbose
4741 print detailed information about the image
4742 -version
4744 print GraphicsMagick version string
4745 -visual <type>
4747 animate images using this X visual type
4748 -window <id>
4750 make image the background of a window
4751 For a more detailed description of each option, see Options,
4753 above.
4754 Any option you specify on the command line remains in effect for
4757 the group of images following it, until the group is terminated
4758 by the appearance of any option or -noop. For example, to ani‐
4759 mate three images, the first with 32 colors, the second with an
4760 unlimited number of colors, and the third with only 16 colors,
4761 use:
4762 gm animate -colors 32 cockatoo.1 -noop cockatoo.2
4765 -colors 16 cockatoo.3
4766 Animate options can appear on the command line or in your X
4769 resources file. See X(1). Options on the command line supersede
4770 values specified in your X resources file. Image filenames may
4771 appear in any order on the command line if the image format is
4772 MIFF (refer to miff(5) and the scene keyword is specified in the
4773 image. Otherwise the images will display in the order they
4774 appear on the command line.
4775
4777 Press any button to map or unmap the Command widget. See the next sec‐
4778 tion for more information about the Command widget.
4779
4781 The Command widget lists a number of sub-menus and commands. They are
4782 Animate
4784 Open
4786 Play
4787 Step
4788 Repeat
4789 Auto Reverse
4790 Speed
4792 Faster
4794 Slower
4795 Direction
4797 Forward
4799 Reverse
4800 Image Info
4802 Help
4803 Quit
4804 Menu items with a indented triangle have a sub-menu. They are repre‐
4807 sented above as the indented items. To access a sub-menu item, move the
4808 pointer to the appropriate menu and press a button and drag. When you
4809 find the desired sub-menu item, release the button and the command is
4810 executed. Move the pointer away from the sub-menu if you decide not to
4811 execute a particular command.
4812
4814 Ctl+O
4815 Press to load an image from a file.
4817 space
4818 Press to display the next image in the sequence.
4820 <
4821 Press to speed-up the display of the images. Refer to
4823 -delay for more information.
4824 >
4825 Press to slow the display of the images. Refer to -delay
4827 for more information.
4828 ?
4829 Press to display information about the image. Press any
4831 key or button to erase the information.
4832 This information is printed: image name; image size; and
4833 the total number of unique colors in the image.
4834 F1
4835 Press to display helpful information about animate(1).
4837 Ctl-q
4838 Press to discard all images and exit program.
4840
4843 Animate options can appear on the command line or in your X resource
4844 file. Options on the command line supersede values specified in your X
4845 resource file. See X(1) for more information on X resources.
4846 All animate options have a corresponding X resource. In addition, the
4848 animate program uses the following X resources:
4849 background (class Background)
4851 Specifies the preferred color to use for the Image window
4854 background. The default is #ccc.
4855 borderColor (class BorderColor)
4856 Specifies the preferred color to use for the Image window
4859 border. The default is #ccc.
4860 borderWidth (class BorderWidth)
4861 Specifies the width in pixels of the Image window border.
4864 The default is 2.
4865 font (class Font or FontList)
4866 Specifies the name of the preferred font to use in normal
4869 formatted text. The default is 14 point Helvetica.
4870 foreground (class Foreground)
4871 Specifies the preferred color to use for text within the
4874 Image window. The default is black.
4875 geometry (class geometry)
4876 Specifies the preferred size and position of the image
4879 window. It is not necessarily obeyed by all window man‐
4880 agers. Offsets, if present, are handled in X(1) style. A
4881 negative x offset is measured from the right edge of the
4882 screen to the right edge of the icon, and a negative y
4883 offset is measured from the bottom edge of the screen to
4884 the bottom edge of the icon.
4885 iconGeometry (class IconGeometry)
4886 Specifies the preferred size and position of the applica‐
4889 tion when iconified. It is not necessarily obeyed by all
4890 window managers. Offsets, if present, are handled in the
4891 same manner as in class Geometry.
4892 iconic (class Iconic)
4893 This resource indicates that you would prefer that the
4896 application's windows initially not be visible as if the
4897 windows had be immediately iconified by you. Window man‐
4898 agers may choose not to honor the application's request.
4899 matteColor (class MatteColor)
4900 Specify the color of windows. It is used for the back‐
4903 grounds of windows, menus, and notices. A 3D effect is
4904 achieved by using highlight and shadow colors derived from
4905 this color. Default value: #ddd.
4906 name (class Name)
4907 This resource specifies the name under which resources for
4910 the application should be found. This resource is useful
4911 in shell aliases to distinguish between invocations of an
4912 application, without resorting to creating links to alter
4913 the executable file name. The default is the application
4914 name.
4915 sharedMemory (class SharedMemory)
4916 This resource specifies whether animate should attempt use
4919 shared memory for pixmaps. ImageMagick must be compiled
4920 with shared memory support, and the display must support
4921 the MIT-SHM extension. Otherwise, this resource is
4922 ignored. The default is True.
4923 text_font (class textFont)
4924 Specifies the name of the preferred font to use in fixed
4927 (typewriter style) formatted text. The default is 14 point
4928 Courier.
4929 title (class Title)
4930 This resource specifies the title to be used for the Image
4933 window. This information is sometimes used by a window
4934 manager to provide some sort of header identifying the
4935 window. The default is the image file name.
4936
4940 batch executes an arbitary number of the utility commands (e.g. con‐
4941 vert) in the form of a simple linear batch script in order to improve
4942 execution efficiency, and/or to allow use as a subordinate co-process
4943 under the control of an arbitrary script or program.
4944
4946 To drive 'gm batch' using a shell script (or a program written in any
4947 language), have the script/program send commands to 'gm batch' via its
4948 standard input. Specify that standard input should be used by using
4949 '-' as the file name. The following example converts all files match‐
4950 ing '*.jpg' to TIFF format while rotating each file by 90 degrees and
4951 stripping all embedded profiles. The shell script syntax is standard
4952 Unix shell:
4953 for file in *.jpg
4955 do
4956 outfile=`basename $file .jpg`.tiff
4957 echo convert -verbose "'$file'" -rotate 90 \
4958 +profile "'*'" "'$outfile'"
4959 done | gm batch -echo on -feedback on -
4960 We can accomplish the same as the previous example by putting all the
4963 commands in a text file and then specifying the name of the text file
4964 as the script to execute:
4965 for file in *.jpg
4967 do
4968 outfile=`basename $file .jpg`.tiff
4969 echo convert -verbose "'$file'" -rotate 90 \
4970 +profile "'*'" "'$outfile'"
4971 done > script.txt
4972 gm batch -echo on -feedback on script.txt
4973
4976 Options are processed from left to right and must appear before any
4977 filename argument.
4978 -echo on|off
4980 command echo on or off
4981 Specify on to enable echoing commands to standard output as they
4983 are read or off to disable. The default is off.
4984 -escape unix|windows
4986 Parse using unix or windows syntax
4987 Commands must be parsed from the input stream and escaping needs
4989 to be used to protect spaces or quoting characters in the input.
4990 Specify unix to use unix-style command line parsing or windows
4991 for Microsoft Windows command shell style parsing. The default
4992 depends on if the software is compiled for Microsoft Windows or
4993 for a Unix-type system (including Cygwin on Microsoft Windows).
4994 It is recommended to use unix syntax because it is more powerful
4995 and more portable.
4996 -fail text
4998 text to print if a command fails
4999 When feedback is enabled, this specifies the text to print when
5001 the command fails. The default text is FAIL.
5002 -feedback on|off
5004 enable error feedback
5005 Print text (see -pass and -fail options) feedback after each
5007 command to indicate the result, the default is off.
5008 -help
5010 Prints batch command help.
5012 -pass text
5014 text to print if a command passes
5015 When feedback is enabled, this specifies the text to print when
5017 the command passes. The default text is PASS.
5018 -prompt text
5020 Prompt text to use for command line
5021 If no filename argument was specified, a simple command prompt
5023 appears where you may enter GraphicsMagick commands. The
5024 default prompt is GM>. Use this option to change the prompt to
5025 something else.
5026 -stop-on-error on|off
5028 Specify if command processing stops on error
5029 Normally command processing continues if a command encounters an
5031 error. Specify -stop-on-error on to cause processing to quit
5032 immediately on error.
5033
5036 benchmark executes an arbitrary gm utility command (e.g. convert) for
5037 one or more loops, and/or a specified execution time, and reports many
5038 execution metrics. For builds using OpenMP, a mode is provided to exe‐
5039 cute the benchmark with an increasing number of threads and provide a
5040 report of speedup and multi-thread execution efficiency. If benchmark
5041 is used to execute a command without any additional benchmark options,
5042 then the command is run once.
5043
5045 To obtain benchmark information for a single execution of a command:
5046 gm benchmark convert input.ppm -gaussian 0x1 output.ppm
5048 To obtain benchmark information from 100 iterations of the command:
5050 gm benchmark -iterations 100 convert input.ppm \
5052 -gaussian 0x1 output.ppm
5053 To obtain benchmark information by iterating the command until a speci‐
5055 fied amount of time (in seconds) has been consumed:
5056 gm benchmark -duration 30 convert input.ppm \
5058 -gaussian 0x1 output.ppm
5059 To obtain a full performance report with an increasing number of
5061 threads (1-32 threads, stepping the number of threads by four each
5062 time):
5063 gm benchmark -duration 3 -stepthreads 4 convert \
5065 input.ppm -gaussian 0x2 output.ppm
5066 Here is the interpretation of the output:
5068 threads - number of threads used.
5070 iter - number of command iterations executed.
5071 user - total user time consumed.
5072 total - total elapsed time consumed.
5073 iter/s - number of command iterations per second.
5074 iter/cpu - amount of CPU time consumed per iteration.
5075 speedup - speedup compared with one thread.
5076 karp-flatt - Karp-Flatt measure of speedup efficiency.
5077 Please note that the reported "speedup" is based on the execution time
5079 of just one thread. A preliminary warm-up pass is used before timing
5080 the first loop in order to ensure that the CPU is brought out of power-
5081 saving modes and that system caches are warmed up. Most modern CPUs
5082 provide a "turbo" mode where the CPU clock speed is increased (e.g. by
5083 a factor of two) when only one or two cores are active. If the CPU
5084 grows excessively hot (due to insufficient cooling), then it may dial
5085 back its clock rates as a form of thermal management. These factors
5086 result in an under-reporting of speedup compared to if "turbo" mode was
5087 disabled and the CPU does not need to worry about thermal management.
5088 The powertop utility available under Linux and Solaris provides a way
5089 to observe CPU core clock rates while a benchmark is running.
5090
5092 Options are processed from left to right and must appear before any
5093 argument.
5094 -duration duration
5096 duration to run benchmark Specify the number of seconds to run
5097 the benchmark. The command is executed repeatedly until the
5098 specified amount of time has elapsed.
5099 -help
5101 Prints benchmark command help.
5103 -iterations loops
5105 number of command iterations Specify the number of iterations to
5106 run the benchmark. The command is executed repeatedly until the
5107 specified number of iterations has been reached.
5108 -rawcsv
5110 Print results in CSV format Print results in a comma-separated
5111 value (CSV) format which is easy to parse for plotting or
5112 importing into a spreadsheet or database. The values reported
5113 are threads, iterations, user_time, and elapsed_time.
5114 -stepthreads step
5116 execute a per-thread benchmark ramp
5117 Execute a per-thread benchmark ramp, incrementing the number of
5118 threads at each step by the specified value. The maximum number
5119 of threads is taken from the standard OMP_NUM_THREADS environ‐
5120 ment variable.
5121
5123 compare compares two similar images using a specified statistical
5124 method (see -metric) and/or by writing a difference image (-file), with
5125 the altered pixels annotated using a specified method (see -highlight-
5126 style) and color (see -highlight-color). Reference-image is the origi‐
5127 nal image and compare-image is the (possibly) altered version, which
5128 should have the same dimensions as reference-image.
5129
5131 To compare two images using Mean Square Error (MSE) statistical analy‐
5132 sis use:
5133 gm compare -metric mse original.miff compare.miff
5135 To create an annotated difference image use:
5138 gm compare -highlight-style assign -highlight-color purple \
5140 -file diff.miff original.miff compare.miff
5141
5144 Options are processed in command line order. Any option you specify on
5145 the command line remains in effect only for the image that follows.
5146 All options are reset to their default values after each image is read.
5147 For a more detailed description of each option, see Options, above.
5149 -authenticate <string>
5152 decrypt image with this password
5153 -colorspace <value>
5155 the type of colorspace
5156 -debug <events>
5158 enable debug printout
5159 -define <key>{=<value>},...
5161 add coder/decoder specific options
5162 -density <width>x<height>
5164 horizontal and vertical resolution in pixels of the image
5165 -depth <value>
5167 depth of the image
5168 -display <host:display[.screen]>
5170 specifies the X server to contact
5171 -endian <type>
5173 specify endianness (MSB, LSB, or Native) of image
5174 -file <filename>
5176 write annotated difference image to file
5177 -help print usage instructions
5179 -highlight-color <color>
5181 pixel annotation color
5182 -highlight-style <style>
5184 pixel annotation style
5185 -interlace <type>
5187 the type of interlacing scheme
5188 -limit <type> <value>
5190 Disk, File, Map, Memory, Pixels, Width, Height or Threads
5191 resource limit
5192 -log <string>
5194 Specify format for debug log
5195 -matte store matte channel if the image has one
5197 -maximum-error <limit>
5199 specifies the maximum amount of total image error
5200 -metric <metric>
5202 comparison metric (MAE, MSE, PAE, PSNR, RMSE)
5203 -monitor
5205 show progress indication
5206 -sampling-factor <horizontal_factor>x<vertical_factor>
5208 chroma subsampling factors
5209 -size <width>x<height>{+offset}
5211 width and height of the image
5212 -type <type>
5214 the image type
5215 -verbose
5217 print detailed information about the image
5218 -version
5220 print GraphicsMagick version string
5221 For a more detailed description of each option, see Options,
5223 above.
5224
5227 composite composites (combines) images to create new images. base-
5228 image is the base image and change-image contains the changes. ouput-
5229 image is the result, and normally has the same dimensions as base-
5230 image.
5231 The optional mask-image can be used to provide opacity information for
5234 change-image when it has none or if you want a different mask. A mask
5235 image is typically grayscale and the same size as base-image. If mask-
5236 image is not grayscale, it is converted to grayscale and the resulting
5237 intensities are used as opacity information.
5238
5240 To composite an image of a cockatoo with a perch, use:
5241 gm composite cockatoo.miff perch.ras composite.miff
5243 To compute the difference between images in a series, use:
5246 gm composite -compose difference series.2 series.1
5248 difference.miff
5249 To composite an image of a cockatoo with a perch starting at location
5252 (100,150), use:
5253 gm composite -geometry +100+150 cockatoo.miff
5255 perch.ras composite.miff
5256 To tile a logo across your image of a cockatoo, use
5259 gm convert +shade 30x60 cockatoo.miff mask.miff
5261 gm composite -compose bumpmap -tile logo.png
5262 cockatoo.miff mask.miff composite.miff
5263 To composite a red, green, and blue color plane into a single composite
5266 image, try
5267 gm composite -compose CopyGreen green.png red.png
5269 red-green.png
5270 gm composite -compose CopyBlue blue.png red-green.png
5271 gm composite.png
5272
5275 Options are processed in command line order. Any option you specify on
5276 the command line remains in effect only for the image that follows.
5277 All options are reset to their default values after each image is read.
5278 For a more detailed description of each option, see Options, above.
5280 -authenticate <string>
5283 decrypt image with this password
5284 -background <color>
5286 the background color
5287 -blue-primary <x>,<y>
5289 blue chromaticity primary point
5290 -colors <value>
5292 preferred number of colors in the image
5293 -colorspace <value>
5295 the type of colorspace
5296 -comment <string>
5298 annotate an image with a comment
5299 -compose <operator>
5301 the type of image composition
5302 -compress <type>
5304 the type of image compression
5305 -debug <events>
5307 enable debug printout
5308 -define <key>{=<value>},...
5310 add coder/decoder specific options
5311 -density <width>x<height>
5313 horizontal and vertical resolution in pixels of the image
5314 -depth <value>
5316 depth of the image
5317 -displace <horizontal scale>x<vertical scale>
5319 shift image pixels as defined by a displacement map
5320 -display <host:display[.screen]>
5322 specifies the X server to contact
5323 -dispose <method>
5325 GIF disposal method
5326 -dissolve <percent>
5328 dissolve an image into another by the given percent
5329 -dither
5331 apply Floyd/Steinberg error diffusion to the image
5332 -encoding <type>
5334 specify the text encoding
5335 -endian <type>
5337 specify endianness (MSB, LSB, or Native) of image
5338 -filter <type>
5340 use this type of filter when resizing an image
5341 -font <name>
5343 use this font when annotating the image with text
5344 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
5346 Specify dimension, offset, and resize options.
5347 -gravity <type>
5349 direction primitive gravitates to when annotating the image.
5350 -green-primary <x>,<y>
5352 green chromaticity primary point
5353 -help print usage instructions
5355 -interlace <type>
5357 the type of interlacing scheme
5358 -label <name>
5360 assign a label to an image
5361 -limit <type> <value>
5363 Disk, File, Map, Memory, Pixels, Width, Height or Threads
5364 resource limit
5365 -log <string>
5367 Specify format for debug log
5368 -matte store matte channel if the image has one
5370 -monitor
5372 show progress indication
5373 -monochrome
5375 transform the image to black and white
5376 -negate
5378 replace every pixel with its complementary color
5379 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
5381 size and location of an image canvas
5382 -profile <filename>
5384 add ICM, IPTC, or generic profile to image
5385 -quality <value>
5387 JPEG/MIFF/PNG/TIFF compression level
5388 -recolor <matrix>
5390 apply a color translation matrix to image channels
5391 -red-primary <x>,<y>
5393 red chromaticity primary point
5394 -render
5396 render vector operations
5397 -repage <width>x<height>+xoff+yoff[!]
5399 Adjust image page offsets
5400 -resize <width>x<height>{%}{@}{!}{<}{>}
5402 resize an image
5403 -rotate <degrees>{<}{>}
5405 rotate the image
5406 -sampling-factor <horizontal_factor>x<vertical_factor>
5408 chroma subsampling factors
5409 -scene <value>
5411 set scene number
5412 -set <attribute> <value>
5414 set an image attribute
5415 +set <attribute>
5417 unset an image attribute
5418 -sharpen <radius>{x<sigma>}
5420 sharpen the image
5421 -size <width>x<height>{+offset}
5423 width and height of the image
5424 -stegano <offset>
5426 hide watermark within an image
5427 -stereo
5429 composite two images to create a stereo anaglyph
5430 -strip remove all profiles and text attributes from the image
5432 -thumbnail <width>x<height>{%}{@}{!}{<}{>}
5434 resize an image (quickly)
5435 -treedepth <value>
5437 tree depth for the color reduction algorithm
5438 -trim trim an image
5440 -type <type>
5442 the image type
5443 -units <type>
5445 the units of image resolution
5446 -unsharp <radius>{x<sigma>}{+<amount>}{+<threshold>}
5448 sharpen the image with an unsharp mask operator
5449 -verbose
5451 print detailed information about the image
5452 -version
5454 print GraphicsMagick version string
5455 -watermark <brightness>x<saturation>
5457 percent brightness and saturation of a watermark
5458 -white-point <x>,<y>
5460 chromaticity white point
5461 -write <filename>
5463 write an intermediate image [convert, composite]
5464 For a more detailed description of each option, see Options,
5466 above.
5467
5470 The Magick scripting language (MSL) will primarily benefit those that
5471 want to accomplish custom image processing tasks but do not wish to
5472 program, or those that do not have access to a Perl interpreter or a
5473 compiler. The interpreter is called conjure and here is an example
5474 script:
5475 <?xml version="1.0" encoding="UTF-8"?>
5477 <image size="400x400" >
5478 <read filename="image.gif" />
5479 <get width="base-width" height="base-height" />
5480 <resize geometry="%[dimensions]" />
5481 <get width="width" height="height" />
5482 <print output=
5483 "Image sized from %[base-width]x%[base-height]
5484 to %[width]x%[height].\n" />
5485 <write filename="image.png" />
5486 </image>
5487 invoked with
5490 gm conjure -dimensions 400x400 incantation.msl
5492 All operations will closely follow the key/value pairs defined in Perl‐
5495 Magick, unless otherwise noted.
5496
5498 Options are processed in command line order. Any option you specify on
5499 the command line remains in effect until it is explicitly changed by
5500 specifying the option again with a different effect, or if it is
5501 changed by a statement in the scripting language.
5502 You can define your own keyword/value pairs on the command line. The
5504 script can then use this information when setting values by including
5505 %[keyword] in the string. For example, if you included "-dimensions
5506 400x400" on the command line, as illustrated above, then any string
5507 containing "%[dimensions]" would have 400x400 substituted. The
5508 "%[string]" can be used either an entire string, such as geome‐
5509 try="%[dimensions]" or as a part of a string such as filename="%[base‐
5510 name].png".
5511 The keyword can be any string except for the following reserved strings
5513 (in any upper, lower, or mixed case variant): debug, help, and verbose,
5514 whose usage is described below.
5515 The value can be any string. If either the keyword or the value con‐
5517 tains white space or any symbols that have special meanings to your
5518 shell such as "#", "|", or "%", enclose the string in quotation marks
5519 or use "\" to escape the white space and special symbols.
5520 Keywords and values are case dependent. "Key", "key", and "KEY" would
5522 be three different keywords.
5523 For a more detailed description of each option, see Options, above.
5525 -debug <events>
5528 enable debug printout
5529 -define <key>{=<value>},...
5531 add coder/decoder specific options
5532 -help print usage instructions
5534 -log <string>
5536 Specify format for debug log
5537 -verbose
5539 print detailed information about the image
5540 -version
5542 print GraphicsMagick version string
5543
5545 The Magick Scripting Language (MSL) presently defines the following
5546 elements and their attributes:
5547 <image>
5549 background, color, id, size
5551 Define a new image object. </image> destroys it. Because
5553 of this, if you wish to reference multiple "subimages"
5554 (aka pages or layers), you can embed one image element
5555 inside of another. For example:
5556 <image>
5560 <read filename="input.png" />
5561 <get width="base-width" height="base-height" />
5562 <image height="base-height" width="base-width">
5563 <image />
5564 <write filename="output.mng" />
5565 </image>
5566 <image size="400x400" />
5571 <group>
5574 Define a new group of image objects. By default, images
5577 are only valid for the life of their <image>element.
5578 <image> -- creates the image
5582 ..... -- do stuff with it
5583 </image> -- dispose of the image
5584 However, in a group, all images in that group will stay
5588 around for the life of the group:
5589 <group> -- start a group
5593 <image> -- create an image
5594 .... -- do stuff
5595 </image> -- NOOP
5596 <image> -- create another
5597 image
5598 .... -- do more stuff
5599 </image> -- NOOP
5600 <write filename="image.mng" /> -- output
5601 </group> -- dispose of both
5602 images
5603 <read>
5606 filename
5608 Read a new image from a disk file.
5610 <read filename="image.gif" />
5614 To read two images use
5618 <read filename="image.gif" />
5622 <read filename="image.png />
5623 <write>
5626 filename
5628 Write the image(s) to disk, either as a single multiple-
5629 image file or multiple ones if necessary.
5630 <write filename=image.tiff" />
5634 <get>
5636 Get any attribute recognized by PerlMagick's GetAt‐
5638 tribute() and stores it as an image attribute for later
5639 use. Currently only width and height are supported.
5640 <get width="base-width" height="base-height" />
5643 <print output="Image size is %[base-width]x%[base-
5644 height].\n" />
5645 <set>
5648 background, bordercolor, clip-mask, colorspace, density,
5650 magick, mattecolor, opacity. Set an attribute recognized
5651 by PerlMagick's GetAttribute().
5652 <profile>
5653 [profilename]
5655 Read one or more IPTC, ICC or generic profiles from file
5657 and assign to image
5658 <profile iptc="profile.iptc" generic="generic.dat" />
5662 To remove a specified profile use "!" as the filename eg
5666 <profile icm="!" iptc="profile.iptc" />
5670 <border>
5673 fill, geometry, height, width
5675 <blur>
5676 radius, sigma
5678 <charcoal>
5679 radius, sigma
5681 <chop>
5682 geometry, height, width, x, y
5684 <crop>
5685 geometry, height, width, x, y
5687 <composite>
5688 compose, geometry, gravity, image, x, y
5690 <?xml version="1.0" encoding="UTF-8"?>
5693 <group>
5694 <image id="image_01">
5695 <read filename="cloud3.gif"/>
5696 <resize geometry="250x90"/>
5697 </image>
5698 <image id="image_02">
5699 <read filename="cloud4.gif"/>
5700 <resize geometry="190x100"/>
5701 </image>
5702 <image>
5703 <read filename="background.jpg"/>
5704 <composite image="image_01" geome‐
5705 try="+740+470"/>
5706 <composite image="image_02" geome‐
5707 try="+390+415"/>
5708 </image>
5709 <write filename="result.png"/>
5710 </group>
5711 <despeckle>
5714 <emboss>
5716 radius, sigma
5718 <enhance>
5719 <equalize>
5721 <edge>
5723 radius
5725 <flip>
5726 <flop>
5728 <frame>
5730 fill, geometry, height, width, x, y, inner, outer
5732 <flatten>
5733 <get>
5735 height, width
5737 <gamma>
5738 red, green, blue
5740 <image>
5741 background, color, id, size
5743 <implode>
5744 amount
5746 <magnify>
5747 <minify>
5749 <medianfilter>
5751 radius
5753 <normalize>
5754 <oilpaint>
5756 radius
5758 <print>
5759 output
5761 <profile>
5762 [profilename]
5764 <read>
5765 <resize>
5767 blur, filter, geometry, height, width
5769 <roll>
5770 geometry, x, y
5772 <rotate>
5773 degrees
5775 <reducenoise>
5776 radius
5778 <sample>
5779 geometry, height, width
5781 <scale>
5782 geometry, height, width
5784 <sharpen>
5785 radius, sigma
5787 <shave>
5788 geometry, height, width
5790 <shear>
5791 x, y
5793 <solarize>
5794 threshold
5796 <spread>
5797 radius
5799 <stegano>
5800 image
5802 <stereo>
5803 image
5805 <swirl>
5806 degrees
5808 <texture>
5809 image
5811 <threshold>
5812 threshold
5814 <transparent>
5815 color
5817 <trim>
5818
5822 Convert converts an input file using one image format to an output file
5823 with a differing image format. In addition, various types of image pro‐
5824 cessing can be performed on the converted image during the conversion
5825 process. Convert recognizes the image formats listed in GraphicsMag‐
5826 ick(1).
5827
5830 To make a thumbnail of a JPEG image, use:
5831 gm convert -size 120x120 cockatoo.jpg -resize 120x120
5833 +profile "*" thumbnail.jpg
5834 In this example, '-size 120x120' gives a hint to the JPEG decoder that
5837 the image is going to be downscaled to 120x120, allowing it to run
5838 faster by avoiding returning full-resolution images to GraphicsMagick
5839 for the subsequent resizing operation. The ´-resize 120x120' specifies
5840 the desired dimensions of the output image. It will be scaled so its
5841 largest dimension is 120 pixels. The ´+profile "*"' removes any ICM,
5842 EXIF, IPTC, or other profiles that might be present in the input and
5843 aren't needed in the thumbnail.
5844 To convert a MIFF image of a cockatoo to a SUN raster image, use:
5846 gm convert cockatoo.miff sun:cockatoo.ras
5848 To convert a multi-page PostScript document to individual FAX pages,
5851 use:
5852 gm convert -monochrome document.ps fax:page
5854 To convert a TIFF image to a PostScript A4 page with the image in the
5857 lower left-hand corner, use:
5858 gm convert -page A4+0+0 image.tiff document.ps
5860 To convert a raw Gray image with a 128 byte header to a portable
5863 graymap, use:
5864 gm convert -depth 8 -size 768x512+128 gray:raw
5866 image.pgm
5867 In this example, "raw" is the input file. Its format is "gray" and it
5870 has the dimensions and number of header bytes specified by the -size
5871 option and the sample depth specified by the -depth option. The output
5872 file is "image.pgm". The suffix ".pgm" specifies its format.
5873 To convert a Photo CD image to a TIFF image, use:
5875 gm convert -size 1536x1024 img0009.pcd image.tiff
5877 gm convert img0009.pcd[4] image.tiff
5878 To create a visual image directory of all your JPEG images, use:
5881 gm convert 'vid:*.jpg' directory.miff
5883 To annotate an image with blue text using font 12x24 at position
5886 (100,100), use:
5887 gm convert -font helvetica -fill blue
5889 -draw "text 100,100 Cockatoo"
5890 bird.jpg bird.miff
5891 To tile a 640x480 image with a JPEG texture with bumps use:
5894 gm convert -size 640x480 tile:bumps.jpg tiled.png
5896 To surround an icon with an ornamental border to use with Mosaic(1),
5899 use:
5900 gm convert -mattecolor "#697B8F" -frame 6x6 bird.jpg
5902 icon.png
5903 To create a MNG animation from a DNA molecule sequence, use:
5906 gm convert -delay 20 dna.* dna.mng
5908
5911 Options are processed in command line order. Any option you specify on
5912 the command line remains in effect for the set of images that follows,
5913 until the set is terminated by the appearance of any option or -noop.
5914 Some options only affect the decoding of images and others only the
5915 encoding. The latter can appear after the final group of input images.
5916 For a more detailed description of each option, see Options, above.
5918 -adjoin
5921 join images into a single multi-image file
5922 -affine <matrix>
5924 drawing transform matrix
5925 -antialias
5927 remove pixel aliasing
5928 -append
5930 append a set of images
5931 -asc-cdl <spec>
5933 apply ASC CDL color transform
5934 -authenticate <string>
5936 decrypt image with this password
5937 -auto-orient
5939 orient (rotate) image so it is upright
5940 -average
5942 average a set of images
5943 -background <color>
5945 the background color
5946 -black-threshold red[,green][,blue][,opacity]
5948 pixels below the threshold become black
5949 -blue-primary <x>,<y>
5951 blue chromaticity primary point
5952 -blur <radius>{x<sigma>}
5954 blur the image with a Gaussian operator
5955 -border <width>x<height>
5957 surround the image with a border of color
5958 -bordercolor <color>
5960 the border color
5961 -box <color>
5963 set the color of the annotation bounding box
5964 -channel <type>
5966 the type of channel
5967 -charcoal <factor>
5969 simulate a charcoal drawing
5970 -chop <width>x<height>{+-}<x>{+-}<y>{%}
5972 remove pixels from the interior of an image
5973 -clip apply the clipping path, if one is present
5975 -coalesce
5977 merge a sequence of images
5978 -colorize <value>
5980 colorize the image with the pen color
5981 -colors <value>
5983 preferred number of colors in the image
5984 -colorspace <value>
5986 the type of colorspace
5987 -comment <string>
5989 annotate an image with a comment
5990 -compose <operator>
5992 the type of image composition
5993 -compress <type>
5995 the type of image compression
5996 -contrast
5998 enhance or reduce the image contrast
5999 -convolve <kernel>
6001 convolve image with the specified convolution kernel
6002 -crop <width>x<height>{+-}<x>{+-}<y>{%}
6004 preferred size and location of the cropped image
6005 -cycle <amount>
6007 displace image colormap by amount
6008 -debug <events>
6010 enable debug printout
6011 -deconstruct
6013 break down an image sequence into constituent parts
6014 -define <key>{=<value>},...
6016 add coder/decoder specific options
6017 -delay <1/100ths of a second>
6019 display the next image after pausing
6020 -density <width>x<height>
6022 horizontal and vertical resolution in pixels of the image
6023 -depth <value>
6025 depth of the image
6026 -despeckle
6028 reduce the speckles within an image
6029 -display <host:display[.screen]>
6031 specifies the X server to contact
6032 -dispose <method>
6034 GIF disposal method
6035 -dither
6037 apply Floyd/Steinberg error diffusion to the image
6038 -draw <string>
6040 annotate an image with one or more graphic primitives
6041 -edge <radius>
6043 detect edges within an image
6044 -emboss <radius>
6046 emboss an image
6047 -encoding <type>
6049 specify the text encoding
6050 -endian <type>
6052 specify endianness (MSB, LSB, or Native) of image
6053 -enhance
6055 apply a digital filter to enhance a noisy image
6056 -equalize
6058 perform histogram equalization to the image
6059 -extent <width>x<height>{+-}<x>{+-}<y>
6061 composite image on background color canvas image
6062 -fill <color>
6064 color to use when filling a graphic primitive
6065 -filter <type>
6067 use this type of filter when resizing an image
6068 -flatten
6070 flatten a sequence of images
6071 -flip create a "mirror image"
6073 -flop create a "mirror image"
6075 -font <name>
6077 use this font when annotating the image with text
6078 -format <string>
6080 output formatted image characteristics
6081 -frame <width>x<height>+<outer bevel width>+<inner bevel width>
6083 surround the image with an ornamental border
6084 -fuzz <distance>{%}
6086 colors within this Euclidean distance are considered equal
6087 -gamma <value>
6089 level of gamma correction
6090 -gaussian <radius>{x<sigma>}
6092 blur the image with a Gaussian operator
6093 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
6095 Specify dimension, offset, and resize options.
6096 -gravity <type>
6098 direction primitive gravitates to when annotating the image.
6099 -green-primary <x>,<y>
6101 green chromaticity primary point
6102 -hald-clut <clut>
6104 apply a Hald CLUT to the image
6105 -help print usage instructions
6107 -implode <factor>
6109 implode image pixels about the center
6110 -intent <type>
6112 use this type of rendering intent when managing the image color
6113 -interlace <type>
6115 the type of interlacing scheme
6116 -label <name>
6118 assign a label to an image
6119 -lat <width>x<height>{+-}<offset>{%}
6121 perform local adaptive thresholding
6122 -level <black_point>{,<gamma>}{,<white_point>}{%}
6124 adjust the level of image contrast
6125 -limit <type> <value>
6127 Disk, File, Map, Memory, Pixels, Width, Height or Threads
6128 resource limit
6129 -list <type>
6131 the type of list
6132 -log <string>
6134 Specify format for debug log
6135 -loop <iterations>
6137 add Netscape loop extension to your GIF animation
6138 -magnify
6140 magnify the image
6141 -map <filename>
6143 choose a particular set of colors from this image
6144 -mask <filename>
6146 Specify a clipping mask
6147 -matte store matte channel if the image has one
6149 -mattecolor <color>
6151 specify the color to be used with the -frame option
6152 -median <radius>
6154 apply a median filter to the image
6155 -minify <factor>
6157 minify the image
6158 -modulate brightness[,saturation[,hue]]
6160 vary the brightness, saturation, and hue of an image
6161 -monitor
6163 show progress indication
6164 -monochrome
6166 transform the image to black and white
6167 -morph <frames>
6169 morphs an image sequence
6170 -mosaic
6172 create a mosaic from an image or an image sequence
6173 -motion-blur <radius>{x<sigma>}{+angle}
6175 Simulate motion blur
6176 -negate
6178 replace every pixel with its complementary color
6179 -noise <radius|type>
6181 add or reduce noise in an image
6182 -noop NOOP (no option)
6184 -normalize
6186 transform image to span the full range of color values
6187 -opaque <color>
6189 change this color to the pen color within the image
6190 -operator channel operator rvalue[%]
6192 apply a mathematical, bitwise, or value operator to an image
6193 channel
6194 -ordered-dither <channeltype> <NxN>
6196 ordered dither the image
6197 -orient <orientation>
6199 Set the image orientation attribute
6200 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
6202 size and location of an image canvas
6203 -paint <radius>
6205 simulate an oil painting
6206 -pen <color>
6208 (This option has been replaced by the -fill option)
6209 -ping efficiently determine image characteristics
6211 -pointsize <value>
6213 pointsize of the PostScript, X11, or TrueType font
6214 -preview <type>
6216 image preview type
6217 -process <command>
6219 process a sequence of images using a process module
6220 -profile <filename>
6222 add ICM, IPTC, or generic profile to image
6223 -quality <value>
6225 JPEG/MIFF/PNG/TIFF compression level
6226 -raise <width>x<height>
6228 lighten or darken image edges
6229 -random-threshold <channeltype> <LOWxHIGH>
6231 random threshold the image
6232 -recolor <matrix>
6234 apply a color translation matrix to image channels
6235 -red-primary <x>,<y>
6237 red chromaticity primary point
6238 -region <width>x<height>{+-}<x>{+-}<y>
6240 apply options to a portion of the image
6241 -render
6243 render vector operations
6244 -repage <width>x<height>+xoff+yoff[!]
6246 Adjust image page offsets
6247 -resample <horizontal>x<vertical>
6249 Resample image to specified horizontal and vertical resolution
6250 -resize <width>x<height>{%}{@}{!}{<}{>}
6252 resize an image
6253 -roll {+-}<x>{+-}<y>
6255 roll an image vertically or horizontally
6256 -rotate <degrees>{<}{>}
6258 rotate the image
6259 -sample <geometry>
6261 scale image using pixel sampling
6262 -sampling-factor <horizontal_factor>x<vertical_factor>
6264 chroma subsampling factors
6265 -scale <geometry>
6267 scale the image.
6268 -scene <value>
6270 set scene number
6271 -set <attribute> <value>
6273 set an image attribute
6274 +set <attribute>
6276 unset an image attribute
6277 -segment <cluster threshold>x<smoothing threshold>
6279 segment an image
6280 -shade <azimuth>x<elevation>
6282 shade the image using a distant light source
6283 -sharpen <radius>{x<sigma>}
6285 sharpen the image
6286 -shave <width>x<height>{%}
6288 shave pixels from the image edges
6289 -shear <x degrees>x<y degrees>
6291 shear the image along the X or Y axis
6292 -size <width>x<height>{+offset}
6294 width and height of the image
6295 -solarize <factor>
6297 negate all pixels above the threshold level
6298 -spread <amount>
6300 displace image pixels by a random amount
6301 -strip remove all profiles and text attributes from the image
6303 -stroke <color>
6305 color to use when stroking a graphic primitive
6306 -strokewidth <value>
6308 set the stroke width
6309 -swirl <degrees>
6311 swirl image pixels about the center
6312 -texture <filename>
6314 name of texture to tile onto the image background
6315 -threshold <value>{%}
6317 threshold the image
6318 -thumbnail <width>x<height>{%}{@}{!}{<}{>}
6320 resize an image (quickly)
6321 -tile <filename>
6323 tile image when filling a graphic primitive
6324 -transform
6326 transform the image
6327 -transparent <color>
6329 make this color transparent within the image
6330 -treedepth <value>
6332 tree depth for the color reduction algorithm
6333 -trim trim an image
6335 -type <type>
6337 the image type
6338 -units <type>
6340 the units of image resolution
6341 -unsharp <radius>{x<sigma>}{+<amount>}{+<threshold>}
6343 sharpen the image with an unsharp mask operator
6344 -use-pixmap
6346 use the pixmap
6347 -verbose
6349 print detailed information about the image
6350 -version
6352 print GraphicsMagick version string
6353 -view <string>
6355 FlashPix viewing parameters
6356 -virtual-pixel <method>
6358 specify contents of "virtual pixels"
6359 -wave <amplitude>x<wavelength>
6361 alter an image along a sine wave
6362 -white-point <x>,<y>
6364 chromaticity white point
6365 -white-threshold red[,green][,blue][,opacity]
6367 pixels above the threshold become white
6368 -write <filename>
6370 write an intermediate image [convert, composite]
6371 For a more detailed description of each option, see Options,
6373 above.
6374
6376 Display is a machine architecture independent image processing and dis‐
6377 play program. It can display an image on any workstation screen running
6378 an X server. Display can read and write many of the more popular image
6379 formats (e.g. JPEG, TIFF, PNM, Photo CD, etc.).
6380 With display, you can perform these functions on an image:
6382 o load an image from a file
6384 o display the next image
6385 o display the former image
6386 o display a sequence of images as a slide show
6387 o write the image to a file
6388 o print the image to a PostScript printer
6389 o delete the image file
6390 o create a Visual Image Directory
6391 o select the image to display by its thumbnail rather than
6392 name
6393 o undo last image transformation
6394 o copy a region of the image
6395 o paste a region to the image
6396 o restore the image to its original size
6397 o refresh the image
6398 o half the image size
6399 o double the image size
6400 o resize the image
6401 o crop the image
6402 o cut the image
6403 o flop image in the horizontal direction
6404 o flip image in the vertical direction
6405 o rotate the image 90 degrees clockwise
6406 o rotate the image 90 degrees counter-clockwise
6407 o rotate the image
6408 o shear the image
6409 o roll the image
6410 o trim the image edges
6411 o invert the colors of the image
6412 o vary the color brightness
6413 o vary the color saturation
6414 o vary the image hue
6415 o gamma correct the image
6416 o sharpen the image contrast
6417 o dull the image contrast
6418 o perform histogram equalization on the image
6419 o perform histogram normalization on the image
6420 o negate the image colors
6421 o convert the image to grayscale
6422 o set the maximum number of unique colors in the image
6423 o reduce the speckles within an image
6424 o eliminate peak noise from an image
6425 o detect edges within the image
6426 o emboss an image
6427 o segment the image by color
6428 o simulate an oil painting
6429 o simulate a charcoal drawing
6430 o annotate the image with text
6431 o draw on the image
6432 o edit an image pixel color
6433 o edit the image matte information
6434 o composite an image with another
6435 o add a border to the image
6436 o surround image with an ornamental border
6437 o apply image processing techniques to a region of interest
6438 o display information about the image
6439 o zoom a portion of the image
6440 o show a histogram of the image
6441 o display image to background of a window
6442 o set user preferences
6443 o display information about this program
6444 o discard all images and exit program
6445 o change the level of magnification
6446 o display images specified by a World Wide Web (WWW) uniform
6447 resource locator (URL)
6448
6451 To scale an image of a cockatoo to exactly 640 pixels in width and 480
6452 pixels in height and position the window at location (200,200), use:
6453 gm display -geometry 640x480+200+200! cockatoo.miff
6455 To display an image of a cockatoo without a border centered on a back‐
6458 drop, use:
6459 gm display +borderwidth -backdrop cockatoo.miff
6461 To tile a slate texture onto the root window, use:
6464 gm display -size 1280x1024 -window root slate.png
6466 To display a visual image directory of all your JPEG images, use:
6469 gm display 'vid:*.jpg'
6471 To display a MAP image that is 640 pixels in width and 480 pixels in
6474 height with 256 colors, use:
6475 gm display -size 640x480+256 cockatoo.map
6477 To display an image of a cockatoo specified with a World Wide Web (WWW)
6480 uniform resource locator (URL), use:
6481 gm display ftp://wizards.dupont.com/images/cockatoo.jpg
6483 To display histogram of an image, use:
6486 gm gm convert file.jpg HISTOGRAM:- | gm display -
6488
6491 Options are processed in command line order. Any option you specify on
6492 the command line remains in effect until it is explicitly changed by
6493 specifying the option again with a different effect. For example to
6494 display three images, the first with 32 colors, the second with an
6495 unlimited number of colors, and the third with only 16 colors, use:
6496 gm display -colors 32 cockatoo.miff -noop duck.miff
6498 -colors 16 macaw.miff
6499 Display options can appear on the command line or in your X resources
6502 file. See X(1). Options on the command line supersede values specified
6503 in your X resources file.
6504 For a more detailed description of each option, see Options, above.
6506 -authenticate <string>
6509 decrypt image with this password
6510 -backdrop
6512 display the image centered on a backdrop.
6513 -background <color>
6515 the background color
6516 -border <width>x<height>
6518 surround the image with a border of color
6519 -bordercolor <color>
6521 the border color
6522 -borderwidth <geometry>
6524 the border width
6525 -colormap <type>
6527 define the colormap type
6528 -colors <value>
6530 preferred number of colors in the image
6531 -colorspace <value>
6533 the type of colorspace
6534 -comment <string>
6536 annotate an image with a comment
6537 -compress <type>
6539 the type of image compression
6540 -contrast
6542 enhance or reduce the image contrast
6543 -crop <width>x<height>{+-}<x>{+-}<y>{%}
6545 preferred size and location of the cropped image
6546 -debug <events>
6548 enable debug printout
6549 -define <key>{=<value>},...
6551 add coder/decoder specific options
6552 -delay <1/100ths of a second>
6554 display the next image after pausing
6555 -density <width>x<height>
6557 horizontal and vertical resolution in pixels of the image
6558 -depth <value>
6560 depth of the image
6561 -despeckle
6563 reduce the speckles within an image
6564 -display <host:display[.screen]>
6566 specifies the X server to contact
6567 -dispose <method>
6569 GIF disposal method
6570 -dither
6572 apply Floyd/Steinberg error diffusion to the image
6573 -edge <radius>
6575 detect edges within an image
6576 -endian <type>
6578 specify endianness (MSB, LSB, or Native) of image
6579 -enhance
6581 apply a digital filter to enhance a noisy image
6582 -filter <type>
6584 use this type of filter when resizing an image
6585 -flip create a "mirror image"
6587 -flop create a "mirror image"
6589 -font <name>
6591 use this font when annotating the image with text
6592 -foreground <color>
6594 define the foreground color
6595 -frame <width>x<height>+<outer bevel width>+<inner bevel width>
6597 surround the image with an ornamental border
6598 -gamma <value>
6600 level of gamma correction
6601 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
6603 Specify dimension, offset, and resize options.
6604 -help print usage instructions
6606 -iconGeometry <geometry>
6608 specify the icon geometry
6609 -iconic
6611 iconic animation
6612 -immutable
6614 make image immutable
6615 -interlace <type>
6617 the type of interlacing scheme
6618 -label <name>
6620 assign a label to an image
6621 -limit <type> <value>
6623 Disk, File, Map, Memory, Pixels, Width, Height or Threads
6624 resource limit
6625 -log <string>
6627 Specify format for debug log
6628 -magnify <factor>
6630 magnify the image
6631 -map <type>
6633 display image using this type.
6634 -matte store matte channel if the image has one
6636 -mattecolor <color>
6638 specify the color to be used with the -frame option
6639 -monitor
6641 show progress indication
6642 -monochrome
6644 transform the image to black and white
6645 -name name an image
6647 -negate
6649 replace every pixel with its complementary color
6650 -noop NOOP (no option)
6652 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
6654 size and location of an image canvas
6655 +progress
6657 disable progress monitor and busy cursor
6658 -quality <value>
6660 JPEG/MIFF/PNG/TIFF compression level
6661 -raise <width>x<height>
6663 lighten or darken image edges
6664 -remote
6666 perform a X11 remote operation
6667 -roll {+-}<x>{+-}<y>
6669 roll an image vertically or horizontally
6670 -rotate <degrees>{<}{>}
6672 rotate the image
6673 -sample <geometry>
6675 scale image using pixel sampling
6676 -sampling-factor <horizontal_factor>x<vertical_factor>
6678 chroma subsampling factors
6679 -scenes <value-value>
6681 range of image scene numbers to read
6682 -set <attribute> <value>
6684 set an image attribute
6685 +set <attribute>
6687 unset an image attribute
6688 -segment <cluster threshold>x<smoothing threshold>
6690 segment an image
6691 -shared-memory
6693 use shared memory
6694 -sharpen <radius>{x<sigma>}
6696 sharpen the image
6697 -size <width>x<height>{+offset}
6699 width and height of the image
6700 -text-font <name>
6702 font for writing fixed-width text
6703 -texture <filename>
6705 name of texture to tile onto the image background
6706 -title <string>
6708 assign title to displayed image [animate, display, montage]
6709 -treedepth <value>
6711 tree depth for the color reduction algorithm
6712 -trim trim an image
6714 -type <type>
6716 the image type
6717 -update <seconds>
6719 detect when image file is modified and redisplay.
6720 -use-pixmap
6722 use the pixmap
6723 -verbose
6725 print detailed information about the image
6726 -version
6728 print GraphicsMagick version string
6729 -visual <type>
6731 animate images using this X visual type
6732 -window <id>
6734 make image the background of a window
6735 -window-group
6737 specify the window group
6738 -write <filename>
6740 write the image to a file [display]
6741 For a more detailed description of each option, see Options,
6743 above.
6744
6747 The effects of each button press is described below. Three buttons are
6748 required. If you have a two button mouse, button 1 and 3 are returned.
6749 Press ALT and button 3 to simulate button 2.
6750 1 Press this button to map or unmap the Command widget . See the
6752 next section for more information about the Command widget.
6753 2 Press and drag to define a region of the image to magnify.
6755 3 Press and drag to choose from a select set of display(1) com‐
6757 mands. This button behaves differently if the image being dis‐
6758 played is a visual image directory. Choose a particular tile of
6759 the directory and press this button and drag to select a command
6760 from a pop-up menu. Choose from these menu items:
6761 Open
6763 Next
6764 Former
6765 Delete
6766 Update
6767 If you choose Open, the image represented by the tile is dis‐
6770 played. To return to the visual image directory, choose Next
6771 from the Command widget (refer to Command Widget). Next and
6772 Former moves to the next or former image respectively. Choose
6773 Delete to delete a particular image tile. Finally, choose Update
6774 to synchronize all the image tiles with their respective images.
6775 See montage and miff for more details.
6776
6778 The Command widget lists a number of sub-menus and commands. They are
6779 File
6781 Open...
6783 Next
6784 Former
6785 Select...
6786 Save...
6787 Print...
6788 Delete...
6789 Canvas...
6790 Visual Directory...
6791 Quit
6792 Edit
6796 Undo
6798 Redo
6799 Cut
6800 Copy
6801 Paste
6802 View
6806 Half Size
6808 Original Size
6809 Double Size
6810 Resize...
6811 Apply
6812 Refresh
6813 Restore
6814 Transform
6818 Crop
6820 Chop
6821 Flop
6822 Flip
6823 Rotate Right
6824 Rotate Left
6825 Rotate...
6826 Shear...
6827 Roll...
6828 Trim Edges
6829 Enhance
6833 Hue...
6835 Saturation...
6836 Brightness...
6837 Gamma...
6838 Spiff...
6839 Dull
6840 Equalize
6841 Normalize
6842 Negate
6843 GRAYscale
6844 Quantize...
6845 Effects
6849 Despeckle
6851 Emboss
6852 Reduce Noise
6853 Add Noise
6854 Sharpen...
6855 Blur...
6856 Threshold...
6857 Edge Detect...
6858 Spread...
6859 Shade...
6860 Raise...
6861 Segment...
6862 F/X
6866 Solarize...
6868 Swirl...
6869 Implode...
6870 Wave...
6871 Oil Paint...
6872 Charcoal Draw...
6873 Image Edit
6877 Annotate...
6879 Draw...
6880 Color...
6881 Matte...
6882 Composite...
6883 Add Border...
6884 Add Frame...
6885 Comment...
6886 Launch...
6887 Region of Interest...
6888 Miscellany
6892 Image Info
6894 Zoom Image
6895 Show Preview...
6896 Show Histogram
6897 Show Matte
6898 Background...
6899 Slide Show
6900 Preferences...
6901 Help
6905 Overview
6907 Browse Documentation
6908 About Display
6909 Menu items with a indented triangle have a sub-menu. They are repre‐
6913 sented above as the indented items. To access a sub-menu item, move the
6914 pointer to the appropriate menu and press button 1 and drag. When you
6915 find the desired sub-menu item, release the button and the command is
6916 executed. Move the pointer away from the sub-menu if you decide not to
6917 execute a particular command.
6918
6920 Accelerators are one or two key presses that effect a particular com‐
6921 mand. The keyboard accelerators that display understands is:
6922 Ctl+O Press to load an image from a file.
6924 space Press to display the next image.
6925 If the image is a multi-paged document such as a PostScript document,
6928 you can skip ahead several pages by preceding this command with a num‐
6929 ber. For example to display the fourth page beyond the current page,
6930 press 4space.
6931 backspace Press to display the former image.
6933 If the image is a multi-paged document such as a PostScript document,
6936 you can skip behind several pages by preceding this command with a num‐
6937 ber. For example to display the fourth page preceding the current
6938 page, press 4n.
6939 Ctl-S Press to save the image to a file.
6941 Ctl-P Press to print the image to a
6942 PostScript printer.
6943 Ctl-D Press to delete an image file.
6944 Ctl-N Press to create a blank canvas.
6945 Ctl-Q Press to discard all images and exit program.
6946 Ctl+Z Press to undo last image transformation.
6947 Ctl+R Press to redo last image transformation.
6948 Ctl-X Press to cut a region of
6949 the image.
6950 Ctl-C Press to copy a region of
6951 the image.
6952 Ctl-V Press to paste a region to
6953 the image.
6954 < Press to halve the image size.
6955 . Press to return to the original image size.
6956 > Press to double the image size.
6957 % Press to resize the image to a width and height
6958 you specify.
6959 Cmd-A Press to make any image transformations
6960 permanent.
6961 By default, any image size transformations are
6962 applied to the original image to create the
6963 image displayed on the X server. However, the
6964 transformations are not permanent (i.e. the
6965 original image does not change size only the
6966 X image does). For example, if you press ">"
6967 the X image will appear to double in size, but
6968 the original image will in fact remain the same
6969 size. To force the original image to double in
6970 size, press ">" followed by "Cmd-A".
6971 @ Press to refresh the image window.
6972 C Press to crop the image.
6973 [ Press to chop the image.
6974 H Press to flop image in the horizontal direction.
6975 V Press to flip image in the vertical direction.
6976 / Press to rotate the image 90 degrees clockwise.
6977 \ Press to rotate the image 90 degrees
6978 counter-clockwise.
6979 * Press to rotate the image
6980 the number of degrees you specify.
6981 S Press to shear the image the number of degrees
6982 you specify.
6983 R Press to roll the image.
6984 T Press to trim the image edges.
6985 Shft-H Press to vary the color hue.
6986 Shft-S Press to vary the color saturation.
6987 Shft-L Press to vary the image brightness.
6988 Shft-G Press to gamma correct the image.
6989 Shft-C Press to spiff up the image contrast.
6990 Shft-Z Press to dull the image contrast.
6991 = Press to perform histogram equalization on
6992 the image.
6993 Shft-N Press to perform histogram normalization on
6994 the image.
6995 Shft-~ Press to negate the colors of the image.
6996 . Press to convert the image colors to gray.
6997 Shft-# Press to set the maximum number of unique
6998 colors in the image.
6999 F2 Press to reduce the speckles in an image.
7000 F2 Press to emboss an image.
7001 F4 Press to eliminate peak noise from an image.
7002 F5 Press to add noise to an image.
7003 F6 Press to sharpen an image.
7004 F7 Press to blur image an image.
7005 F8 Press to threshold the image.
7006 F9 Press to detect edges within an image.
7007 F10 Press to displace pixels by a random amount.
7008 F11 Press to shade the image using a distant light
7009 source.
7010 F12 Press to lighten or darken image edges to
7011 create a 3-D effect.
7012 F13 Press to segment the image by color.
7013 Meta-S Press to swirl image pixels about the center.
7014 Meta-I Press to implode image pixels about the center.
7015 Meta-W Press to alter an image along a sine wave.
7016 Meta-P Press to simulate an oil painting.
7017 Meta-C Press to simulate a charcoal drawing.
7018 Alt-X Press to composite the image
7019 with another.
7020 Alt-A Press to annotate the image with text.
7021 Alt-D Press to draw a line on the image.
7022 Alt-P Press to edit an image pixel color.
7023 Alt-M Press to edit the image matte information.
7024 Alt-X Press to composite the image with another.
7025 Alt-A Press to add a border to the image.
7026 Alt-F Press to add a ornamental frame to the image.
7027 Alt-Shft-! Press to add an image comment.
7028 Ctl-A Press to apply image processing techniques to a
7029 region of interest.
7030 Shft-? Press to display information about the image.
7031 Shft-+ Press to map the zoom image window.
7032 Shft-P Press to preview an image enhancement, effect,
7033 or f/x.
7034 F1 Press to display helpful information about
7035 the "display" utility.
7036 Find Press to browse documentation about
7037 GraphicsMagick.
7038 1-9 Press to change the level of magnification.
7039 Use the arrow keys to move the image one pixel up, down, left, or right
7042 within the magnify window. Be sure to first map the magnify window by
7043 pressing button 2.
7044 Press ALT and one of the arrow keys to trim off one pixel from any side
7046 of the image.
7047
7049 Display options can appear on the command line or in your X resource
7050 file. Options on the command line supersede values specified in your X
7051 resource file. See X(1) for more information on X resources.
7052 Most display options have a corresponding X resource. In addition, dis‐
7054 play uses the following X resources:
7055 background (class Background)
7057 Specifies the preferred color to use for the Image window back‐
7058 ground. The default is #ccc.
7059 borderColor (class BorderColor)
7061 Specifies the preferred color to use for the Image window bor‐
7062 der. The default is #ccc.
7063 borderWidth (class BorderWidth)
7065 Specifies the width in pixels of the image window border. The
7066 default is 2.
7067 browseCommand (class browseCommand)
7069 Specifies the name of the preferred browser when displaying
7070 GraphicsMagick documentation. The default is netscape %s.
7071 confirmExit (class ConfirmExit)
7073 Display pops up a dialog box to confirm exiting the program
7074 when exiting the program. Set this resource to False to exit
7075 without a confirmation.
7076 displayGamma (class DisplayGamma)
7078 Specifies the gamma of the X server. You can apply separate
7079 gamma values to the red, green, and blue channels of the image
7080 with a gamma value list delineated with slashes (i.e.
7081 1.7/2.3/1.2). The default is 2.2.
7082 displayWarnings (class DisplayWarnings)
7084 Display pops up a dialog box whenever a warning message occurs.
7085 Set this resource to False to ignore warning messages.
7086 font (class FontList)
7088 Specifies the name of the preferred font to use in normal for‐
7089 matted text. The default is 14 point Helvetica.
7090 font[1-9] (class Font[1-9])
7092 Specifies the name of the preferred font to use when annotating
7093 the image window with text. The default fonts are fixed, vari‐
7094 able, 5x8, 6x10, 7x13bold, 8x13bold, 9x15bold, 10x20, and 12x24.
7095 foreground (class Foreground)
7097 Specifies the preferred color to use for text within the image
7098 window. The default is black.
7099 gammaCorrect (class gammaCorrect)
7101 This resource, if true, will lighten or darken an image of
7102 known gamma to match the gamma of the display (see resource dis‐
7103 playGamma). The default is True.
7104 geometry (class Geometry)
7106 Specifies the preferred size and position of the image window.
7107 It is not necessarily obeyed by all window managers.
7108 Offsets, if present, are handled in X(1) style. A negative x
7110 offset is measured from the right edge of the screen to the
7111 right edge of the icon, and a negative y offset is measured from
7112 the bottom edge of the screen to the bottom edge of the icon.
7113 iconGeometry (class IconGeometry)
7115 Specifies the preferred size and position of the application
7116 when iconified. It is not necessarily obeyed by all window man‐
7117 agers.
7118 Offsets, if present, are handled in the same manner as in class
7120 Geometry.
7121 iconic (class Iconic)
7123 This resource indicates that you would prefer that the applica‐
7124 tion's windows initially not be visible as if the windows had be
7125 immediately iconified by you. Window managers may choose not to
7126 honor the application's request.
7127 magnify (class Magnify)
7129 specifies an integral factor by which the image should be
7130 enlarged. The default is 3. This value only affects the magni‐
7131 fication window which is invoked with button number 3 after the
7132 image is displayed.
7133 matteColor (class MatteColor)
7135 Specify the color of windows. It is used for the backgrounds of
7136 windows, menus, and notices. A 3D effect is achieved by using
7137 highlight and shadow colors derived from this color. Default
7138 value: #697B8F.
7139 name (class Name)
7141 This resource specifies the name under which resources for the
7142 application should be found. This resource is useful in shell
7143 aliases to distinguish between invocations of an application,
7144 without resorting to creating links to alter the executable file
7145 name. The default is the application name.
7146 pen[1-9] (class Pen[1-9])
7148 Specifies the color of the preferred font to use when annotat‐
7149 ing the image window with text. The default colors are black,
7150 blue, green, cyan, gray, red, magenta, yellow, and white.
7151 printCommand (class PrintCommand)
7153 This command is executed whenever Print is issued. In general,
7154 it is the command to print PostScript to your printer. Default
7155 value: lp -c -s %i.
7156 sharedMemory (class SharedMemory)
7158 This resource specifies whether display should attempt use
7159 shared memory for pixmaps. GraphicsMagick must be compiled with
7160 shared memory support, and the display must support the MIT-SHM
7161 extension. Otherwise, this resource is ignored. The default is
7162 True.
7163 textFont (class textFont)
7165 Specifies the name of the preferred font to use in fixed (type‐
7166 writer style) formatted text. The default is 14 point Courier.
7167 title (class Title)
7169 This resource specifies the title to be used for the image win‐
7170 dow. This information is sometimes used by a window manager to
7171 provide a header identifying the window. The default is the
7172 image file name.
7173 undoCache (class UndoCache)
7175 Specifies, in mega-bytes, the amount of memory in the undo edit
7176 cache. Each time you modify the image it is saved in the undo
7177 edit cache as long as memory is available. You can subsequently
7178 undo one or more of these transformations. The default is 16
7179 Megabytes.
7180 usePixmap (class UsePixmap)
7182 Images are maintained as a XImage by default. Set this resource
7183 to True to utilize a server Pixmap instead. This option is use‐
7184 ful if your image exceeds the dimensions of your server screen
7185 and you intend to pan the image. Panning is much faster with
7186 Pixmaps than with a XImage. Pixmaps are considered a precious
7187 resource, use them with discretion.
7188 To set the geometry of the Magnify or Pan or window, use the
7190 geometry resource. For example, to set the Pan window geometry
7191 to 256x256, use:
7192 gm display.pan.geometry: 256x256
7194
7197 To select an image to display, choose Open of the File sub-menu from
7198 the Command widget. A file browser is displayed. To choose a particu‐
7199 lar image file, move the pointer to the filename and press any button.
7200 The filename is copied to the text window. Next, press Open or press
7201 the RETURN key. Alternatively, you can type the image file name
7202 directly into the text window. To descend directories, choose a direc‐
7203 tory name and press the button twice quickly. A scrollbar allows a
7204 large list of filenames to be moved through the viewing area if it
7205 exceeds the size of the list area.
7206 You can trim the list of file names by using shell globbing characters.
7208 For example, type *.jpg to list only files that end with .jpg.
7209 To select your image from the X server screen instead of from a file,
7211 Choose Grab of the Open widget.
7212
7214 To create a Visual Image Directory, choose Visual Directory of the File
7215 sub-menu from the Command widget . A file browser is displayed. To cre‐
7216 ate a Visual Image Directory from all the images in the current direc‐
7217 tory, press Directory or press the RETURN key. Alternatively, you can
7218 select a set of image names by using shell globbing characters. For
7219 example, type *.jpg to include only files that end with .jpg. To
7220 descend directories, choose a directory name and press the button twice
7221 quickly. A scrollbar allows a large list of filenames to be moved
7222 through the viewing area if it exceeds the size of the list area.
7223 After you select a set of files, they are turned into thumbnails and
7225 tiled onto a single image. Now move the pointer to a particular thumb‐
7226 nail and press button 3 and drag. Finally, select Open. The image rep‐
7227 resented by the thumbnail is displayed at its full size. Choose Next
7228 from the File sub-menu of the Command widget to return to the Visual
7229 Image Directory.
7230
7232 Note that cut information for image window is not retained for col‐
7233 ormapped X server visuals (e.g. StaticColor, StaticColor, GRAYScale,
7234 PseudoColor). Correct cutting behavior may require a TrueColor or
7235 DirectColor visual or a Standard Colormap.
7236 To begin, press choose Cut of the Edit sub-menu from the Command wid‐
7238 get. Alternatively, press F3 in the image window.
7239 A small window appears showing the location of the cursor in the image
7241 window. You are now in cut mode. In cut mode, the Command widget has
7242 these options:
7243 Help
7245 Dismiss
7246 To define a cut region, press button 1 and drag. The cut region is
7249 defined by a highlighted rectangle that expands or contracts as it fol‐
7250 lows the pointer. Once you are satisfied with the cut region, release
7251 the button. You are now in rectify mode. In rectify mode, the Command
7252 widget has these options:
7253 Cut
7255 Help
7256 Dismiss
7257 You can make adjustments by moving the pointer to one of the cut rec‐
7260 tangle corners, pressing a button, and dragging. Finally, press Cut to
7261 commit your copy region. To exit without cutting the image, press Dis‐
7262 miss.
7263
7265 To begin, press choose Copy of the Edit sub-menu from the Command wid‐
7266 get. Alternatively, press F4 in the image window.
7267 A small window appears showing the location of the cursor in the image
7269 window. You are now in copy mode. In copy mode, the Command widget has
7270 these options:
7271 Help
7273 Dismiss
7274 To define a copy region, press button 1 and drag. The copy region is
7277 defined by a highlighted rectangle that expands or contracts as it fol‐
7278 lows the pointer. Once you are satisfied with the copy region, release
7279 the button. You are now in rectify mode. In rectify mode, the Command
7280 widget has these options:
7281 Copy
7283 Help
7284 Dismiss
7285 You can make adjustments by moving the pointer to one of the copy rec‐
7288 tangle corners, pressing a button, and dragging. Finally, press Copy to
7289 commit your copy region. To exit without copying the image, press Dis‐
7290 miss.
7291
7293 To begin, press choose Paste of the Edit sub-menu from the Command wid‐
7294 get. Alternatively, press F5 in the image window.
7295 A small window appears showing the location of the cursor in the image
7297 window. You are now in Paste mode. To exit immediately, press Dismiss.
7298 In Paste mode, the Command widget has these options:
7299 Operators
7301 over
7303 in
7304 out
7305 atop
7306 xor
7307 plus
7308 minus
7309 add
7310 subtract
7311 difference
7312 multiply
7313 bumpmap
7314 replace
7315 Help
7317 Dismiss
7318 Choose a composite operation from the Operators sub-menu of the Command
7321 widget. How each operator behaves is described below. image window is
7322 the image currently displayed on your X server and image is the image
7323 obtained with the File Browser widget.
7324 over The result is the union of the two image shapes, with image
7326 obscuring image window in the region of overlap.
7327 in The result is simply image cut by the shape of image window.
7329 None of the image data of image window is in the result.
7330 out The resulting image is image with the shape of image window cut
7332 out.
7333 atop The result is the same shape as image window, with image
7335 obscuring image window where the image shapes overlap. Note this
7336 differs from over because the portion of image outside image
7337 window's shape does not appear in the result.
7338 xor The result is the image data from both image and image window
7340 that is outside the overlap region. The overlap region is blank.
7341 plus The result is just the sum of the image data. Output values are
7343 cropped to the maximum value (no overflow). This operation is
7344 independent of the matte channels.
7345 minus The result of image - image window, with underflow cropped to
7347 zero. The matte channel is ignored (set to opaque, full cover‐
7348 age).
7349 add The result of image + image window, with overflow wrapping
7351 around (mod MaxRGB+1).
7352 subtract
7354 The result of image - image window, with underflow wrapping
7355 around (mod MaxRGB+1). The add and subtract operators can be
7356 used to perform reversible transformations.
7357 difference
7359 The result of abs(image - image window). This is useful for
7360 comparing two very similar images.
7361 multiply
7363 The result of image * image window. This is useful for the cre‐
7364 ation of drop-shadows.
7365 bumpmap
7367 The result of image window shaded by window.
7368 replace
7370 The resulting image is image window replaced with image. Here
7371 the matte information is ignored.
7372 The image compositor requires a matte, or alpha channel in the
7374 image for some operations. This extra channel usually defines a
7375 mask which represents a sort of a cookie-cutter for the image.
7376 This is the case when matte is 255 (full coverage) for pixels
7377 inside the shape, zero outside, and between zero and 255 on the
7378 boundary. If image does not have a matte channel, it is initial‐
7379 ized with 0 for any pixel matching in color to pixel location
7380 (0,0), otherwise 255. See Matte Editing for a method of defining
7381 a matte channel.
7382 Note that matte information for image window is not retained for
7384 colormapped X server visuals (e.g. StaticColor, StaticColor,
7385 GrayScale, PseudoColor). Correct compositing behavior may
7386 require a TrueColor or DirectColor visual or a Standard Col‐
7387 ormap.
7388 Choosing a composite operator is optional. The default operator
7390 is replace. However, you must choose a location to composite
7391 your image and press button 1. Press and hold the button before
7392 releasing and an outline of the image will appear to help you
7393 identify your location.
7394 The actual colors of the pasted image is saved. However, the
7396 color that appears in image window may be different. For exam‐
7397 ple, on a monochrome screen image window will appear black or
7398 white even though your pasted image may have many colors. If the
7399 image is saved to a file it is written with the correct colors.
7400 To assure the correct colors are saved in the final image, any
7401 PseudoClass image is promoted to DirectClass. To force a Pseu‐
7402 doClass image to remain PseudoClass, use -colors.
7403
7405 To begin, press choose Crop of the Transform submenu from the Command
7406 widget. Alternatively, press C in the image window.
7407 A small window appears showing the location of the cursor in the image
7409 window. You are now in crop mode. In crop mode, the Command widget has
7410 these options:
7411 Help
7413 Dismiss
7414 To define a cropping region, press button 1 and drag. The cropping
7417 region is defined by a highlighted rectangle that expands or contracts
7418 as it follows the pointer. Once you are satisfied with the cropping
7419 region, release the button. You are now in rectify mode. In rectify
7420 mode, the Command widget has these options:
7421 Crop
7423 Help
7424 Dismiss
7425 You can make adjustments by moving the pointer to one of the cropping
7428 rectangle corners, pressing a button, and dragging. Finally, press Crop
7429 to commit your cropping region. To exit without cropping the image,
7430 press Dismiss.
7431
7433 An image is chopped interactively. There is no command line argument to
7434 chop an image. To begin, choose Chop of the Transform sub-menu from the
7435 Command widget. Alternatively, press [ in the Image window.
7436 You are now in Chop mode. To exit immediately, press Dismiss. In Chop
7438 mode, the Command widget has these options:
7439 Direction
7441 horizontal
7443 vertical
7444 Help
7446 Dismiss
7447 If the you choose the horizontal direction (this is the default), the
7450 area of the image between the two horizontal endpoints of the chop line
7451 is removed. Otherwise, the area of the image between the two vertical
7452 endpoints of the chop line is removed.
7453 Select a location within the image window to begin your chop, press and
7455 hold any button. Next, move the pointer to another location in the
7456 image. As you move a line will connect the initial location and the
7457 pointer. When you release the button, the area within the image to chop
7458 is determined by which direction you choose from the Command widget.
7459 To cancel the image chopping, move the pointer back to the starting
7461 point of the line and release the button.
7462
7464 Press the / key to rotate the image 90 degrees or \ to rotate -90
7465 degrees. To interactively choose the degree of rotation, choose
7466 Rotate... of the Transform submenu from the Command Widget. Alterna‐
7467 tively, press * in the image window.
7468 A small horizontal line is drawn next to the pointer. You are now in
7470 rotate mode. To exit immediately, press Dismiss. In rotate mode, the
7471 Command widget has these options:
7472 Pixel Color
7474 black
7476 blue
7477 cyan
7478 green
7479 gray
7480 red
7481 magenta
7482 yellow
7483 white
7484 Browser...
7485 Direction
7487 horizontal
7489 vertical
7490 Help
7492 Dismiss
7493 Choose a background color from the Pixel Color sub-menu. Additional
7496 background colors can be specified with the color browser. You can
7497 change the menu colors by setting the X resources pen1 through pen9.
7498 If you choose the color browser and press Grab, you can select the
7500 background color by moving the pointer to the desired color on the
7501 screen and press any button.
7502 Choose a point in the image window and press this button and hold.
7504 Next, move the pointer to another location in the image. As you move a
7505 line connects the initial location and the pointer. When you release
7506 the button, the degree of image rotation is determined by the slope of
7507 the line you just drew. The slope is relative to the direction you
7508 choose from the Direction sub-menu of the Command widget.
7509 To cancel the image rotation, move the pointer back to the starting
7511 point of the line and release the button.
7512
7514 An image is annotated interactively. There is no command line argument
7515 to annotate an image. To begin, choose Annotate of the Image Edit sub-
7516 menu from the Command widget. Alternatively, press a in the image win‐
7517 dow.
7518 A small window appears showing the location of the cursor in the image
7520 window. You are now in annotate mode. To exit immediately, press Dis‐
7521 miss. In annotate mode, the Command widget has these options:
7522 Font Name
7525 fixed
7528 variable
7530 5x8
7532 6x10
7534 7x13bold
7536 8x13bold
7538 9x15bold
7540 10x20
7542 12x24
7544 Browser...
7546 Font Color
7549 black
7552 blue
7554 cyan
7556 green
7558 gray
7560 red
7562 magenta
7564 yellow
7566 white
7568 transparent
7570 Browser...
7572 Box Color
7575 black
7578 blue
7580 cyan
7582 green
7584 gray
7586 red
7588 magenta
7590 yellow
7592 white
7594 transparent
7596 Browser...
7598 Rotate Text
7601 -90
7604 -45
7606 -30
7608 0
7610 30
7612 45
7614 90
7616 180
7618 Dialog...
7620 Help
7623 Dismiss
7625 Choose a font name from the Font Name sub-menu. Additional font names
7628 can be specified with the font browser. You can change the menu names
7629 by setting the X resources font1 through font9.
7630 Choose a font color from the Font Color sub-menu. Additional font col‐
7632 ors can be specified with the color browser. You can change the menu
7633 colors by setting the X resources pen1 through pen9.
7634 If you select the color browser and press Grab, you can choose the font
7636 color by moving the pointer to the desired color on the screen and
7637 press any button.
7638 If you choose to rotate the text, choose Rotate Text from the menu and
7640 select an angle. Typically you will only want to rotate one line of
7641 text at a time. Depending on the angle you choose, subsequent lines may
7642 end up overwriting each other.
7643 Choosing a font and its color is optional. The default font is fixed
7645 and the default color is black. However, you must choose a location to
7646 begin entering text and press a button. An underscore character will
7647 appear at the location of the pointer. The cursor changes to a pencil
7648 to indicate you are in text mode. To exit immediately, press Dismiss.
7649 In text mode, any key presses will display the character at the loca‐
7651 tion of the underscore and advance the underscore cursor. Enter your
7652 text and once completed press Apply to finish your image annotation. To
7653 correct errors press BACK SPACE. To delete an entire line of text,
7654 press DELETE. Any text that exceeds the boundaries of the image window
7655 is automatically continued onto the next line.
7656 The actual color you request for the font is saved in the image. How‐
7658 ever, the color that appears in your Image window may be different. For
7659 example, on a monochrome screen the text will appear black or white
7660 even if you choose the color red as the font color. However, the image
7661 saved to a file with -write is written with red lettering. To assure
7662 the correct color text in the final image, any PseudoClass image is
7663 promoted to DirectClass (see miff(5)). To force a PseudoClass image to
7664 remain PseudoClass, use -colors.
7665
7667 An image composite is created interactively. There is no command line
7668 argument to composite an image. To begin, choose Composite of the Image
7669 Edit from the Command widget. Alternatively, press x in the Image win‐
7670 dow.
7671 First a popup window is displayed requesting you to enter an image
7673 name. Press Composite, Grab or type a file name. Press Cancel if you
7674 choose not to create a composite image. When you choose Grab, move the
7675 pointer to the desired window and press any button.
7676 If the Composite image does not have any matte information, you are
7678 informed and the file browser is displayed again. Enter the name of a
7679 mask image. The image is typically grayscale and the same size as the
7680 composite image. If the image is not grayscale, it is converted to
7681 grayscale and the resulting intensities are used as matte information.
7682 A small window appears showing the location of the cursor in the image
7684 window. You are now in composite mode. To exit immediately, press Dis‐
7685 miss. In composite mode, the Command widget has these options:
7686 Operators
7689 over
7692 in
7694 out
7696 atop
7698 xor
7700 plus
7702 minus
7704 add
7706 subtract
7708 difference
7710 bumpmap
7712 replace
7714 Blend
7717 Displace
7719 Help
7721 Dismiss
7723 Choose a composite operation from the Operators sub-menu of the Command
7726 widget. How each operator behaves is described below. image window is
7727 the image currently displayed on your X server and image is the image
7728 obtained
7729 over The result is the union of the two image shapes, with image
7731 obscuring image window in the region of overlap.
7732 in The result is simply image cut by the shape of image window.
7734 None of the image data of image window is in the result.
7735 out The resulting image is image with the shape of image window cut
7737 out.
7738 atop The result is the same shape as image window, with image
7740 obscuring image window where the image shapes overlap. Note this
7741 differs from over because the portion of image outside image
7742 window's shape does not appear in the result.
7743 xor The result is the image data from both image and image window
7745 that is outside the overlap region. The overlap region is blank.
7746 plus The result is just the sum of the image data. Output values are
7748 cropped to 255 (no overflow). This operation is independent of
7749 the matte channels.
7750 minus The result of image - image window, with underflow cropped to
7752 zero. The matte channel is ignored (set to 255, full coverage).
7753 add The result of image + image window, with overflow wrapping
7755 around (mod 256).
7756 subtract
7758 The result of image - image window, with underflow wrapping
7759 around (mod 256). The add and subtract operators can be used to
7760 perform reversible transformations.
7761 difference
7763 The result of abs(image - image window). This is useful for
7764 comparing two very similar images.
7765 bumpmap
7767 The result of image window shaded by window.
7768 replace
7770 The resulting image is image window replaced with image. Here
7771 the matte information is ignored.
7772 The image compositor requires a matte, or alpha channel in the
7774 image for some operations. This extra channel usually defines a
7775 mask which represents a sort of a cookie-cutter for the image.
7776 This is the case when matte is 255 (full coverage) for pixels
7777 inside the shape, zero outside, and between zero and 255 on the
7778 boundary. If image does not have a matte channel, it is initial‐
7779 ized with 0 for any pixel matching in color to pixel location
7780 (0,0), otherwise 255. See Matte Editing for a method of defining
7781 a matte channel.
7782 If you choose blend, the composite operator becomes over. The
7784 image matte channel percent transparency is initialized to fac‐
7785 tor. The image window is initialized to (100-factor). Where
7786 factor is the value you specify in the Dialog widget.
7787 Displace shifts the image pixels as defined by a displacement
7789 map. With this option, image is used as a displacement map.
7790 Black, within the displacement map, is a maximum positive dis‐
7791 placement. White is a maximum negative displacement and middle
7792 gray is neutral. The displacement is scaled to determine the
7793 pixel shift. By default, the displacement applies in both the
7794 horizontal and vertical directions. However, if you specify
7795 mask, image is the horizontal X displacement and mask the verti‐
7796 cal Y displacement.
7797 Note that matte information for image window is not retained for
7799 colormapped X server visuals (e.g. StaticColor, StaticColor,
7800 GrayScale, PseudoColor). Correct compositing behavior may
7801 require a TrueColor or DirectColor visual or a Standard Col‐
7802 ormap.
7803 Choosing a composite operator is optional. The default operator
7805 is replace. However, you must choose a location to composite
7806 your image and press button 1. Press and hold the button before
7807 releasing and an outline of the image will appear to help you
7808 identify your location.
7809 The actual colors of the composite image is saved. However, the
7811 color that appears in image window may be different. For exam‐
7812 ple, on a monochrome screen Image window will appear black or
7813 white even though your composited image may have many colors. If
7814 the image is saved to a file it is written with the correct col‐
7815 ors. To assure the correct colors are saved in the final image,
7816 any PseudoClass image is promoted to DirectClass (see miff). To
7817 force a PseudoClass image to remain PseudoClass, use -colors.
7818
7820 Changing the the color of a set of pixels is performed interactively.
7821 There is no command line argument to edit a pixel. To begin, choose
7822 Color from the Image Edit submenu of the Command widget. Alterna‐
7823 tively, press c in the image window.
7824 A small window appears showing the location of the cursor in the image
7826 window. You are now in color edit mode. To exit immediately, press Dis‐
7827 miss. In color edit mode, the Command widget has these options:
7828 Method
7831 point
7834 replace
7836 floodfill
7838 reset
7840 Pixel Color
7843 black
7846 blue
7848 cyan
7850 green
7852 gray
7854 red
7856 magenta
7858 yellow
7860 white
7862 Browser...
7864 Border Color
7867 black
7870 blue
7872 cyan
7874 green
7876 gray
7878 red
7880 magenta
7882 yellow
7884 white
7886 Browser...
7888 Fuzz
7891 0
7894 2
7896 4
7898 8
7900 16
7902 Dialog...
7903 Undo
7906 Help
7908 Dismiss
7910 Choose a color editing method from the Method sub-menu of the Command
7913 widget. The point method recolors any pixel selected with the pointer
7914 unless the button is released. The replace method recolors any pixel
7915 that matches the color of the pixel you select with a button press.
7916 Floodfill recolors any pixel that matches the color of the pixel you
7917 select with a button press and is a neighbor. Whereas filltoborder
7918 changes the matte value of any neighbor pixel that is not the border
7919 color. Finally reset changes the entire image to the designated color.
7920 Next, choose a pixel color from the Pixel Color sub-menu. Additional
7922 pixel colors can be specified with the color browser. You can change
7923 the menu colors by setting the X resources pen1 through pen9.
7924 Now press button 1 to select a pixel within the Image window to change
7926 its color. Additional pixels may be recolored as prescribed by the
7927 method you choose. additional pixels by increasing the Delta value.
7928 If the Magnify widget is mapped, it can be helpful in positioning your
7930 pointer within the image (refer to button 2). Alternatively you can
7931 select a pixel to recolor from within the Magnify widget. Move the
7932 pointer to the Magnify widget and position the pixel with the cursor
7933 control keys. Finally, press a button to recolor the selected pixel (or
7934 pixels).
7935 The actual color you request for the pixels is saved in the image. How‐
7937 ever, the color that appears in your Image window may be different. For
7938 example, on a monochrome screen the pixel will appear black or white
7939 even if you choose the color red as the pixel color. However, the image
7940 saved to a file with -write is written with red pixels. To assure the
7941 correct color text in the final image, any PseudoClass image is pro‐
7942 moted to DirectClass To force a PseudoClass image to remain Pseudo‐
7943 Class, use -colors.
7944
7946 Matte information within an image is useful for some operations such as
7947 image compositing. This extra channel usually defines a mask which rep‐
7948 resents a sort of a cookie-cutter for the image. This is the case when
7949 matte is 255 (full coverage) for pixels inside the shape, zero outside,
7950 and between zero and 255 on the boundary.
7951 Setting the matte information in an image is done interactively. There
7953 is no command line argument to edit a pixel. To begin, and choose Matte
7954 of the Image Edit sub-menu from the Command widget.
7955 Alternatively, press m in the image window.
7957 A small window appears showing the location of the cursor in the image
7959 window. You are now in matte edit mode. To exit immediately, press Dis‐
7960 miss. In matte edit mode, the Command widget has these options:
7961 Method
7964 point
7967 replace
7969 floodfill
7971 reset
7973 Border Color
7976 black
7979 blue
7981 cyan
7983 green
7985 gray
7987 red
7989 magenta
7991 yellow
7993 white
7995 Browser...
7997 Fuzz
8000 0
8003 2
8005 4
8007 8
8009 16
8011 Dialog...
8012 Matte
8015 Undo
8017 Help
8019 Dismiss
8021 Choose a matte editing method from the Method sub-menu of the Command
8023 widget. The point method changes the matte value of the any pixel
8024 selected with the pointer until the button is released. The replace
8025 method changes the matte value of any pixel that matches the color of
8026 the pixel you select with a button press. Floodfill changes the matte
8027 value of any pixel that matches the color of the pixel you select with
8028 a button press and is a neighbor. Whereas filltoborder recolors any
8029 neighbor pixel that is not the border color. Finally reset changes the
8030 entire image to the designated matte value. Choose Matte Value and a
8031 dialog appears requesting a matte value. Enter a value between 0 and
8032 255. This value is assigned as the matte value of the selected pixel or
8033 pixels. Now, press any button to select a pixel within the Image win‐
8034 dow to change its matte value. You can change the matte value of addi‐
8035 tional pixels by increasing the Delta value. The Delta value is first
8036 added then subtracted from the red, green, and blue of the target
8037 color. Any pixels within the range also have their matte value updated.
8038 If the Magnify widget is mapped, it can be helpful in positioning your
8039 pointer within the image (refer to button 2). Alternatively you can
8040 select a pixel to change the matte value from within the Magnify wid‐
8041 get. Move the pointer to the Magnify widget and position the pixel
8042 with the cursor control keys. Finally, press a button to change the
8043 matte value of the selected pixel (or pixels). Matte information is
8044 only valid in a DirectClass image. Therefore, any PseudoClass image is
8045 promoted to DirectClass. Note that matte information for PseudoClass is
8046 not retained for colormapped X server visuals (e.g. StaticColor, Stat‐
8047 icColor, GrayScale, PseudoColor) unless you immediately save your image
8048 to a file (refer to Write). Correct matte editing behavior may require
8049 a TrueColor or DirectColor visual or a Standard Colormap.
8050
8052 An image is drawn upon interactively. There is no command line argument
8053 to draw on an image. To begin, choose Draw of the Image Edit sub-menu
8054 from the Command widget. Alternatively, press d in the image window.
8055 The cursor changes to a crosshair to indicate you are in draw mode. To
8057 exit immediately, press Dismiss. In draw mode, the Command widget has
8058 these options:
8059 Primitive
8062 point
8065 line
8067 rectangle
8069 fill rectangle
8071 circle
8073 fill circle
8075 ellipse
8077 fill ellipse
8079 polygon
8081 fill polygon
8083 Color
8086 black
8089 blue
8091 cyan
8093 green
8095 gray
8097 red
8099 magenta
8101 yellow
8103 white
8105 transparent
8107 Browser...
8109 Stipple
8112 Brick
8115 Diagonal
8117 Scales
8119 Vertical
8121 Wavy
8123 Translucent
8125 Opaque
8127 Open...
8129 Width
8132 1
8135 2
8137 4
8139 8
8141 16
8143 Dialog...
8144 Undo
8147 Help
8149 Dismiss
8151 Choose a drawing primitive from the Primitive sub-menu.
8153 Next, choose a color from the Color sub-menu. Additional colors can be
8155 specified with the color browser. You can change the menu colors by
8156 setting the X resources pen1 through pen9. The transparent color
8157 updates the image matte channel and is useful for image compositing.
8158 If you choose the color browser and press Grab, you can select the
8160 primitive color by moving the pointer to the desired color on the
8161 screen and press any button. The transparent color updates the image
8162 matte channel and is useful for image compositing.
8163 Choose a stipple, if appropriate, from the Stipple sub-menu. Additional
8165 stipples can be specified with the file browser. Stipples obtained from
8166 the file browser must be on disk in the X11 bitmap format.
8167 Choose a line width, if appropriate, from the Width sub-menu. To choose
8169 a specific width select the Dialog widget.
8170 Choose a point in the image window and press button 1 and hold. Next,
8172 move the pointer to another location in the image. As you move, a line
8173 connects the initial location and the pointer. When you release the
8174 button, the image is updated with the primitive you just drew. For
8175 polygons, the image is updated when you press and release the button
8176 without moving the pointer.
8177 To cancel image drawing, move the pointer back to the starting point of
8179 the line and release the button.
8180
8182 To begin, press choose Region of Interest of the Pixel Transform sub-
8183 menu from the Command widget. Alternatively, press R in the image win‐
8184 dow.
8185 A small window appears showing the location of the cursor in the image
8187 window. You are now in region of interest mode. In region of interest
8188 mode, the Command widget has these options:
8189 Help
8192 Dismiss
8194 To define a region of interest, press button 1 and drag. The region of
8197 interest is defined by a highlighted rectangle that expands or con‐
8198 tracts as it follows the pointer. Once you are satisfied with the
8199 region of interest, release the button. You are now in apply mode. In
8200 apply mode the Command widget has these options:
8201 File
8204 Save...
8207 Print...
8209 Edit
8212 Undo
8215 Redo
8217 Transform
8220 Flip
8223 Flop
8225 Rotate Right
8227 Rotate Left
8229 Enhance
8232 Hue...
8235 Saturation...
8237 Brightness...
8239 Gamma...
8241 Spiff
8243 Dull
8245 Equalize
8247 Normalize
8249 Negate
8251 GRAYscale
8253 Quantize...
8255 Effects
8258 Despeckle
8261 Emboss
8263 Reduce Noise
8265 Add Noise
8267 Sharpen...
8269 Blur...
8271 Threshold...
8273 Edge Detect...
8275 Spread...
8277 Shade...
8279 Raise...
8281 Segment...
8283 F/X
8288 Solarize...
8291 Swirl...
8293 Implode...
8295 Wave...
8297 Oil Paint
8299 Charcoal Draw...
8301 Miscellany
8306 Image Info
8309 Zoom Image
8311 Show Preview...
8313 Show Histogram
8315 Show Matte
8317 Help
8320 Dismiss
8322 You can make adjustments to the region of interest by moving the
8325 pointer to one of the rectangle corners, pressing a button, and drag‐
8326 ging. Finally, choose an image processing technique from the Command
8327 widget. You can choose more than one image processing technique to
8328 apply to an area. Alternatively, you can move the region of interest
8329 before applying another image processing technique. To exit, press Dis‐
8330 miss.
8331
8333 When an image exceeds the width or height of the X server screen, dis‐
8334 play maps a small panning icon. The rectangle within the panning icon
8335 shows the area that is currently displayed in the the image window. To
8336 pan about the image, press any button and drag the pointer within the
8337 panning icon. The pan rectangle moves with the pointer and the image
8338 window is updated to reflect the location of the rectangle within the
8339 panning icon. When you have selected the area of the image you wish to
8340 view, release the button.
8341 Use the arrow keys to pan the image one pixel up, down, left, or right
8343 within the image window.
8344 The panning icon is withdrawn if the image becomes smaller than the
8346 dimensions of the X server screen.
8347
8349 Preferences affect the default behavior of display(1). The preferences
8350 are either true or false and are stored in your home directory as .dis‐
8351 playrc:
8352 display image centered on a backdrop"
8354 This backdrop covers the entire workstation screen and is
8357 useful for hiding other X window activity while viewing
8358 the image. The color of the backdrop is specified as the
8359 background color. Refer to X Resources for details.
8360 confirm on program exit"
8361 Ask for a confirmation before exiting the display(1) pro‐
8364 gram.
8365 correct image for display gamma"
8366 If the image has a known gamma, the gamma is corrected to
8369 match that of the X server (see the X Resource dis‐
8370 playGamma).
8371 display warning messages"
8372 Display any warning messages.
8375 apply Floyd/Steinberg error diffusion to image"
8376 The basic strategy of dithering is to trade intensity res‐
8379 olution for spatial resolution by averaging the intensi‐
8380 ties of several neighboring pixels. Images which suffer
8381 from severe contouring when reducing colors can be
8382 improved with this preference.
8383 use a shared colormap for colormapped X visuals"
8384 This option only applies when the default X server visual
8387 is PseudoColor or GRAYScale. Refer to -visual for more
8388 details. By default, a shared colormap is allocated. The
8389 image shares colors with other X clients. Some image col‐
8390 ors could be approximated, therefore your image may look
8391 very different than intended. Otherwise the image colors
8392 appear exactly as they are defined. However, other clients
8393 may go technicolor when the image colormap is installed.
8394 display images as an X server pixmap"
8395 Images are maintained as a XImage by default. Set this
8398 resource to True to utilize a server Pixmap instead. This
8399 option is useful if your image exceeds the dimensions of
8400 your server screen and you intend to pan the image. Pan‐
8401 ning is much faster with Pixmaps than with a XImage.
8402 Pixmaps are considered a precious resource, use them with
8403 discretion.
8404 GM IDENTIFY
8408 Identify describes the format and characteristics of one or more
8410 image files as internally supported by the software. It will
8411 also report if an image is incomplete or corrupt. The informa‐
8412 tion displayed includes the scene number, the file name, the
8413 width and height of the image, whether the image is colormapped
8414 or not, the number of colors in the image, the number of bytes
8415 in the image, the format of the image (JPEG, PNM, etc.), and
8416 finally the number of seconds in both user time and elapsed time
8417 it took to read and process the image. If -verbose or +ping are
8418 provided as an option, the pixel read rate is also displayed. An
8419 example line output from identify follows:
8420 images/aquarium.miff 640x480 PseudoClass 256c
8422 308135b MIFF 0.000u 0:01
8423 If -verbose is set, expect additional output including any image
8426 comment:
8427 Image: images/aquarium.miff
8430 class: PseudoClass
8431 colors: 256
8432 signature: eb5dca81dd93ae7e6ffae99a527eb5dca8...
8433 matte: False
8434 geometry: 640x480
8435 depth: 8
8436 bytes: 308135
8437 format: MIFF
8438 comments:
8439 Imported from MTV raster image: aquarium.mtv
8440 For some formats, additional format-specific information about
8443 the file will be written if the -debug coder or -debug all
8444 option is used.
8445
8447 Options are processed in command line order. Any option you specify on
8448 the command line remains in effect for the set of images immediately
8449 following, until the set is terminated by the appearance of any option
8450 or -noop.
8451 For a more detailed description of each option, see Options, above.
8453 -authenticate <string>
8456 decrypt image with this password
8457 -debug <events>
8459 enable debug printout
8460 -define <key>{=<value>},...
8462 add coder/decoder specific options
8463 -density <width>x<height>
8465 horizontal and vertical resolution in pixels of the image
8466 -depth <value>
8468 depth of the image
8469 -format <string>
8471 output formatted image characteristics
8472 -help print usage instructions
8474 -interlace <type>
8476 the type of interlacing scheme
8477 -limit <type> <value>
8479 Disk, File, Map, Memory, Pixels, Width, Height or Threads
8480 resource limit
8481 -log <string>
8483 Specify format for debug log
8484 -ping efficiently determine image characteristics
8486 -sampling-factor <horizontal_factor>x<vertical_factor>
8488 chroma subsampling factors
8489 -size <width>x<height>{+offset}
8491 width and height of the image
8492 -verbose
8494 print detailed information about the image
8495 -version
8497 print GraphicsMagick version string
8498 For a more detailed description of each option, see Options,
8500 above.
8501
8504 Import reads an image from any visible window on an X server and out‐
8505 puts it as an image file. You can capture a single window, the entire
8506 screen, or any rectangular portion of the screen. Use display for
8507 redisplay, printing, editing, formatting, archiving, image processing,
8508 etc. of the captured image.
8509 The target window can be specified by id, name, or may be selected by
8511 clicking the mouse in the desired window. If you press a button and
8512 then drag, a rectangle will form which expands and contracts as the
8513 mouse moves. To save the portion of the screen defined by the rectan‐
8514 gle, just release the button. The keyboard bell is rung once at the
8515 beginning of the screen capture and twice when it completes.
8516
8518 To select an X window or an area of the screen with the mouse and save
8519 it in the MIFF image format to a file entitled window.miff, use:
8520 gm import window.miff
8522 To select an X window or an area of the screen with the mouse and save
8525 it in the Encapsulated PostScript format to include in another docu‐
8526 ment, use:
8527 gm import figure.eps
8529 To capture the entire X server screen in the JPEG image format in a
8532 file entitled root.jpeg, without using the mouse, use:
8533 gm import -window root root.jpeg
8535 To capture the 512x256 area at the upper right corner of the X server
8538 screen in the PNG image format in a well-compressed file entitled cor‐
8539 ner.png, without using the mouse, use:
8540 gm import -window root -crop 512x256-0+0 -quality 90
8542 corner.png
8543
8546 Options are processed in command line order. Any option you specify on
8547 the command line remains in effect until it is explicitly changed by
8548 specifying the option again with a different effect.
8549 Import options can appear on the command line or in your X resources
8551 file. See X(1). Options on the command line supersede values specified
8552 in your X resources file.
8553 For a more detailed description of each option, see Options, above.
8555 -bordercolor <color>
8558 the border color
8559 -colors <value>
8561 preferred number of colors in the image
8562 -colorspace <value>
8564 the type of colorspace
8565 -comment <string>
8567 annotate an image with a comment
8568 -crop <width>x<height>{+-}<x>{+-}<y>{%}
8570 preferred size and location of the cropped image
8571 -debug <events>
8573 enable debug printout
8574 -define <key>{=<value>},...
8576 add coder/decoder specific options
8577 -delay <1/100ths of a second>
8579 display the next image after pausing
8580 -density <width>x<height>
8582 horizontal and vertical resolution in pixels of the image
8583 -depth <value>
8585 depth of the image
8586 -descend
8588 obtain image by descending window hierarchy
8589 -display <host:display[.screen]>
8591 specifies the X server to contact
8592 -dispose <method>
8594 GIF disposal method
8595 -dither
8597 apply Floyd/Steinberg error diffusion to the image
8598 -encoding <type>
8600 specify the text encoding
8601 -endian <type>
8603 specify endianness (MSB, LSB, or Native) of image
8604 -frame include the X window frame in the imported image
8606 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
8608 Specify dimension, offset, and resize options.
8609 -help print usage instructions
8611 -interlace <type>
8613 the type of interlacing scheme
8614 -label <name>
8616 assign a label to an image
8617 -limit <type> <value>
8619 Disk, File, Map, Memory, Pixels, Width, Height or Threads
8620 resource limit
8621 -log <string>
8623 Specify format for debug log
8624 -monitor
8626 show progress indication
8627 -monochrome
8629 transform the image to black and white
8630 -negate
8632 replace every pixel with its complementary color
8633 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
8635 size and location of an image canvas
8636 -pause <seconds>
8638 pause between snapshots [import]
8639 -ping efficiently determine image characteristics
8641 -pointsize <value>
8643 pointsize of the PostScript, X11, or TrueType font
8644 -quality <value>
8646 JPEG/MIFF/PNG/TIFF compression level
8647 -resize <width>x<height>{%}{@}{!}{<}{>}
8649 resize an image
8650 -rotate <degrees>{<}{>}
8652 rotate the image
8653 -sampling-factor <horizontal_factor>x<vertical_factor>
8655 chroma subsampling factors
8656 -scene <value>
8658 set scene number
8659 -screen
8661 specify the screen to capture
8662 -set <attribute> <value>
8664 set an image attribute
8665 +set <attribute>
8667 unset an image attribute
8668 -silent
8670 operate silently
8671 -snaps <value>
8673 number of screen snapshots
8674 -thumbnail <width>x<height>{%}{@}{!}{<}{>}
8676 resize an image (quickly)
8677 -transparent <color>
8679 make this color transparent within the image
8680 -trim trim an image
8682 -verbose
8684 print detailed information about the image
8685 -version
8687 print GraphicsMagick version string
8688 For a more detailed description of each option, see Options,
8690 above.
8691
8694 Mogrify transforms an image or a sequence of images. These transforms
8695 include image scaling, image rotation, color reduction, and others.
8696 Each transmogrified image overwrites the corresponding original image,
8697 unless an option such as -format causes the output filename to be dif‐
8698 ferent from the input filename.
8699 The graphics formats supported by mogrify are listed in GraphicsMag‐
8701 ick(1).
8702
8704 To convert all the TIFF files in a particular directory to JPEG, use:
8705 gm mogrify -format jpeg *.tiff
8707 To convert a directory full of JPEG images to thumbnails, use:
8710 gm mogrify -size 120x120 *.jpg -resize 120x120 +profile "*"
8712 In this example, '-size 120x120' gives a hint to the JPEG decoder that
8715 the images are going to be downscaled to 120x120, allowing it to run
8716 faster by avoiding returning full-resolution images to GraphicsMagick
8717 for the subsequent resizing operation. The ´-resize 120x120' specifies
8718 the desired dimensions of the output images. It will be scaled so its
8719 largest dimension is 120 pixels. The ´+profile "*"' removes any ICM,
8720 EXIF, IPTC, or other profiles that might be present in the input and
8721 aren't needed in the thumbnails.
8722 To scale an image of a cockatoo to exactly 640 pixels in width and 480
8724 pixels in height, use:
8725 gm mogrify -resize 640x480! cockatoo.miff
8727
8730 Options are processed in command line order. Any option you specify on
8731 the command line remains in effect for the set of images that follows,
8732 until the set is terminated by the appearance of any option or -noop.
8733 For a more detailed description of each option, see Options, above.
8735 -affine <matrix>
8738 drawing transform matrix
8739 -antialias
8741 remove pixel aliasing
8742 -asc-cdl <spec>
8744 apply ASC CDL color transform
8745 -authenticate <string>
8747 decrypt image with this password
8748 -auto-orient
8750 orient (rotate) image so it is upright
8751 -background <color>
8753 the background color
8754 -black-threshold red[,green][,blue][,opacity]
8756 pixels below the threshold become black
8757 -blue-primary <x>,<y>
8759 blue chromaticity primary point
8760 -blur <radius>{x<sigma>}
8762 blur the image with a Gaussian operator
8763 -border <width>x<height>
8765 surround the image with a border of color
8766 -bordercolor <color>
8768 the border color
8769 -channel <type>
8771 the type of channel
8772 -charcoal <factor>
8774 simulate a charcoal drawing
8775 -colorize <value>
8777 colorize the image with the pen color
8778 -colors <value>
8780 preferred number of colors in the image
8781 -colorspace <value>
8783 the type of colorspace
8784 -comment <string>
8786 annotate an image with a comment
8787 -compose <operator>
8789 the type of image composition
8790 -compress <type>
8792 the type of image compression
8793 -contrast
8795 enhance or reduce the image contrast
8796 -convolve <kernel>
8798 convolve image with the specified convolution kernel
8799 -create-directories
8801 create output directory if required
8802 -crop <width>x<height>{+-}<x>{+-}<y>{%}
8804 preferred size and location of the cropped image
8805 -cycle <amount>
8807 displace image colormap by amount
8808 -debug <events>
8810 enable debug printout
8811 -define <key>{=<value>},...
8813 add coder/decoder specific options
8814 -delay <1/100ths of a second>
8816 display the next image after pausing
8817 -density <width>x<height>
8819 horizontal and vertical resolution in pixels of the image
8820 -depth <value>
8822 depth of the image
8823 -despeckle
8825 reduce the speckles within an image
8826 -display <host:display[.screen]>
8828 specifies the X server to contact
8829 -dispose <method>
8831 GIF disposal method
8832 -dither
8834 apply Floyd/Steinberg error diffusion to the image
8835 -draw <string>
8837 annotate an image with one or more graphic primitives
8838 -edge <radius>
8840 detect edges within an image
8841 -emboss <radius>
8843 emboss an image
8844 -encoding <type>
8846 specify the text encoding
8847 -endian <type>
8849 specify endianness (MSB, LSB, or Native) of image
8850 -enhance
8852 apply a digital filter to enhance a noisy image
8853 -equalize
8855 perform histogram equalization to the image
8856 -extent <width>x<height>{+-}<x>{+-}<y>
8858 composite image on background color canvas image
8859 -fill <color>
8861 color to use when filling a graphic primitive
8862 -filter <type>
8864 use this type of filter when resizing an image
8865 -flip create a "mirror image"
8867 -flop create a "mirror image"
8869 -font <name>
8871 use this font when annotating the image with text
8872 -format <type>
8874 the image format type
8875 -frame <width>x<height>+<outer bevel width>+<inner bevel width>
8877 surround the image with an ornamental border
8878 -fuzz <distance>{%}
8880 colors within this Euclidean distance are considered equal
8881 -gamma <value>
8883 level of gamma correction
8884 -gaussian <radius>{x<sigma>}
8886 blur the image with a Gaussian operator
8887 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
8889 Specify dimension, offset, and resize options.
8890 -gravity <type>
8892 direction primitive gravitates to when annotating the image.
8893 -green-primary <x>,<y>
8895 green chromaticity primary point
8896 -hald-clut <clut>
8898 apply a Hald CLUT to the image
8899 -help print usage instructions
8901 -implode <factor>
8903 implode image pixels about the center
8904 -interlace <type>
8906 the type of interlacing scheme
8907 -label <name>
8909 assign a label to an image
8910 -lat <width>x<height>{+-}<offset>{%}
8912 perform local adaptive thresholding
8913 -level <black_point>{,<gamma>}{,<white_point>}{%}
8915 adjust the level of image contrast
8916 -limit <type> <value>
8918 Disk, File, Map, Memory, Pixels, Width, Height or Threads
8919 resource limit
8920 -linewidth
8922 the line width for subsequent draw operations
8923 -list <type>
8925 the type of list
8926 -log <string>
8928 Specify format for debug log
8929 -loop <iterations>
8931 add Netscape loop extension to your GIF animation
8932 -magnify
8934 magnify the image
8935 -map <filename>
8937 choose a particular set of colors from this image
8938 -mask <filename>
8940 Specify a clipping mask
8941 -matte store matte channel if the image has one
8943 -mattecolor <color>
8945 specify the color to be used with the -frame option
8946 -median <radius>
8948 apply a median filter to the image
8949 -minify <factor>
8951 minify the image
8952 -modulate brightness[,saturation[,hue]]
8954 vary the brightness, saturation, and hue of an image
8955 -monitor
8957 show progress indication
8958 -monochrome
8960 transform the image to black and white
8961 -motion-blur <radius>{x<sigma>}{+angle}
8963 Simulate motion blur
8964 -negate
8966 replace every pixel with its complementary color
8967 -noise <radius|type>
8969 add or reduce noise in an image
8970 -noop NOOP (no option)
8972 -normalize
8974 transform image to span the full range of color values
8975 -opaque <color>
8977 change this color to the pen color within the image
8978 -operator channel operator rvalue[%]
8980 apply a mathematical, bitwise, or value operator to an image
8981 channel
8982 -ordered-dither <channeltype> <NxN>
8984 ordered dither the image
8985 -output-directory <directory>
8987 output files to directory
8988 -orient <orientation>
8990 Set the image orientation attribute
8991 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
8993 size and location of an image canvas
8994 -paint <radius>
8996 simulate an oil painting
8997 -pen <color>
8999 (This option has been replaced by the -fill option)
9000 -pointsize <value>
9002 pointsize of the PostScript, X11, or TrueType font
9003 -profile <filename>
9005 add ICM, IPTC, or generic profile to image
9006 -preserve-timestamp
9008 preserve the original timestamps of the file
9009 -quality <value>
9011 JPEG/MIFF/PNG/TIFF compression level
9012 -raise <width>x<height>
9014 lighten or darken image edges
9015 -random-threshold <channeltype> <LOWxHIGH>
9017 random threshold the image
9018 -recolor <matrix>
9020 apply a color translation matrix to image channels
9021 -red-primary <x>,<y>
9023 red chromaticity primary point
9024 -region <width>x<height>{+-}<x>{+-}<y>
9026 apply options to a portion of the image
9027 -render
9029 render vector operations
9030 -repage <width>x<height>+xoff+yoff[!]
9032 Adjust image page offsets
9033 -resample <horizontal>x<vertical>
9035 Resample image to specified horizontal and vertical resolution
9036 -resize <width>x<height>{%}{@}{!}{<}{>}
9038 resize an image
9039 -roll {+-}<x>{+-}<y>
9041 roll an image vertically or horizontally
9042 -rotate <degrees>{<}{>}
9044 rotate the image
9045 -sample <geometry>
9047 scale image using pixel sampling
9048 -sampling-factor <horizontal_factor>x<vertical_factor>
9050 chroma subsampling factors
9051 -scale <geometry>
9053 scale the image.
9054 -scene <value>
9056 set scene number
9057 -set <attribute> <value>
9059 set an image attribute
9060 +set <attribute>
9062 unset an image attribute
9063 -segment <cluster threshold>x<smoothing threshold>
9065 segment an image
9066 -shade <azimuth>x<elevation>
9068 shade the image using a distant light source
9069 -sharpen <radius>{x<sigma>}
9071 sharpen the image
9072 -shave <width>x<height>{%}
9074 shave pixels from the image edges
9075 -shear <x degrees>x<y degrees>
9077 shear the image along the X or Y axis
9078 -size <width>x<height>{+offset}
9080 width and height of the image
9081 -solarize <factor>
9083 negate all pixels above the threshold level
9084 -spread <amount>
9086 displace image pixels by a random amount
9087 -strip remove all profiles and text attributes from the image
9089 -stroke <color>
9091 color to use when stroking a graphic primitive
9092 -strokewidth <value>
9094 set the stroke width
9095 -swirl <degrees>
9097 swirl image pixels about the center
9098 -texture <filename>
9100 name of texture to tile onto the image background
9101 -threshold <value>{%}
9103 threshold the image
9104 -thumbnail <width>x<height>{%}{@}{!}{<}{>}
9106 resize an image (quickly)
9107 -tile <filename>
9109 tile image when filling a graphic primitive
9110 -transform
9112 transform the image
9113 -transparent <color>
9115 make this color transparent within the image
9116 -treedepth <value>
9118 tree depth for the color reduction algorithm
9119 -trim trim an image
9121 -type <type>
9123 the image type
9124 -units <type>
9126 the units of image resolution
9127 -unsharp <radius>{x<sigma>}{+<amount>}{+<threshold>}
9129 sharpen the image with an unsharp mask operator
9130 -verbose
9132 print detailed information about the image
9133 -version
9135 print GraphicsMagick version string
9136 -view <string>
9138 FlashPix viewing parameters
9139 -virtual-pixel <method>
9141 specify contents of "virtual pixels"
9142 -wave <amplitude>x<wavelength>
9144 alter an image along a sine wave
9145 -white-point <x>,<y>
9147 chromaticity white point
9148 -white-threshold red[,green][,blue][,opacity]
9150 pixels above the threshold become white
9151 For a more detailed description of each option, see Options,
9153 above.
9154
9157 montage creates a composite image by combining several separate images.
9158 The images are tiled on the composite image with the name of the image
9159 optionally appearing just below the individual tile.
9160 The composite image is constructed in the following manner. First, each
9162 image specified on the command line, except for the last, is scaled to
9163 fit the maximum tile size. The maximum tile size by default is 120x120.
9164 It can be modified with the -geometry command line argument or X
9165 resource. See Options for more information on command line arguments.
9166 See X(1) for more information on X resources. Note that the maximum
9167 tile size need not be a square.
9168 Next the composite image is initialized with the color specified by the
9170 -background command line argument or X resource. The width and height
9171 of the composite image is determined by the title specified, the maxi‐
9172 mum tile size, the number of tiles per row, the tile border width and
9173 height, the image border width, and the label height. The number of
9174 tiles per row specifies how many images are to appear in each row of
9175 the composite image. The default is to have 5 tiles in each row and 4
9176 tiles in each column of the composite. A specific value is specified
9177 with -tile. The tile border width and height, and the image border
9178 width defaults to the value of the X resource -borderwidth. It can be
9179 changed with the -borderwidth or -geometry command line argument or X
9180 resource. The label height is determined by the font you specify with
9181 the -font command line argument or X resource. If you do not specify a
9182 font, a font is chosen that allows the name of the image to fit the
9183 maximum width of a tiled area. The label colors is determined by the
9184 -background and -fill command line argument or X resource. Note, that
9185 if the background and pen colors are the same, labels will not appear.
9186 Initially, the composite image title is placed at the top if one is
9188 specified (refer to -fill). Next, each image is set onto the composite
9189 image, surrounded by its border color, with its name centered just
9190 below it. The individual images are left-justified within the width of
9191 the tiled area. The order of the images is the same as they appear on
9192 the command line unless the images have a scene keyword. If a scene
9193 number is specified in each image, then the images are tiled onto the
9194 composite in the order of their scene number. Finally, the last argu‐
9195 ment on the command line is the name assigned to the composite image.
9196 By default, the image is written in the MIFF format and can be viewed
9197 or printed with display(1).
9198 Note, that if the number of tiles exceeds the default number of 20 (5
9201 per row, 4 per column), more than one composite image is created. To
9202 ensure a single image is produced, use -tile to increase the number of
9203 tiles to meet or exceed the number of input images.
9204 Finally, to create one or more empty spaces in the sequence of tiles,
9206 use the "NULL:" image format.
9207 Note, a composite MIFF image displayed to an X server with display
9209 behaves differently than other images. You can think of the composite
9210 as a visual image directory. Choose a particular tile of the composite
9211 and press a button to display it. See display(1) and miff(5)
9212
9214 To create a montage of a cockatoo, a parrot, and a hummingbird and
9215 write it to a file called birds, use:
9216 gm montage cockatoo.miff parrot.miff hummingbird.miff
9218 birds.miff
9219 To tile several bird images so that they are at most 256 pixels in
9222 width and 192 pixels in height, surrounded by a red border, and sepa‐
9223 rated by 10 pixels of background color, use:
9224 gm montage -geometry 256x192+10+10 -bordercolor red
9226 birds.* montage.miff
9227 To create an unlabeled parrot image, 640 by 480 pixels, and surrounded
9230 by a border of black, use:
9231 gm montage -geometry 640x480 -bordercolor black
9233 -label "" parrot.miff bird.miff
9234 To create an image of an eagle with a textured background, use:
9237 gm montage -texture bumps.jpg eagle.jpg eagle.png
9239 To join several GIF images together without any extraneous graphics
9242 (e.g. no label, no shadowing, no surrounding tile frame), use:
9243 gm montage +frame +shadow +label -tile 5x1
9245 -geometry 50x50+0+0 *.png joined.png
9246
9249 Any option you specify on the command line remains in effect for the
9250 group of images following it, until the group is terminated by the
9251 appearance of any option or -noop. For example, to make a montage of
9252 three images, the first with 32 colors, the second with an unlimited
9253 number of colors, and the third with only 16 colors, use:
9254 gm montage -colors 32 cockatoo.1 -noop cockatoo.2
9257 -colors 16 cockatoo.3 cockatoos.miff
9258 For a more detailed description of each option, see Options, above.
9261 -adjoin
9264 join images into a single multi-image file
9265 -affine <matrix>
9267 drawing transform matrix
9268 -authenticate <string>
9270 decrypt image with this password
9271 -background <color>
9273 the background color
9274 -blue-primary <x>,<y>
9276 blue chromaticity primary point
9277 -blur <radius>{x<sigma>}
9279 blur the image with a Gaussian operator
9280 -bordercolor <color>
9282 the border color
9283 -borderwidth <geometry>
9285 the border width
9286 -chop <width>x<height>{+-}<x>{+-}<y>{%}
9288 remove pixels from the interior of an image
9289 -colors <value>
9291 preferred number of colors in the image
9292 -colorspace <value>
9294 the type of colorspace
9295 -comment <string>
9297 annotate an image with a comment
9298 -compose <operator>
9300 the type of image composition
9301 -compress <type>
9303 the type of image compression
9304 -crop <width>x<height>{+-}<x>{+-}<y>{%}
9306 preferred size and location of the cropped image
9307 -debug <events>
9309 enable debug printout
9310 -define <key>{=<value>},...
9312 add coder/decoder specific options
9313 -density <width>x<height>
9315 horizontal and vertical resolution in pixels of the image
9316 -depth <value>
9318 depth of the image
9319 -display <host:display[.screen]>
9321 specifies the X server to contact
9322 -dispose <method>
9324 GIF disposal method
9325 -dither
9327 apply Floyd/Steinberg error diffusion to the image
9328 -draw <string>
9330 annotate an image with one or more graphic primitives
9331 -encoding <type>
9333 specify the text encoding
9334 -endian <type>
9336 specify endianness (MSB, LSB, or Native) of image
9337 -fill <color>
9339 color to use when filling a graphic primitive
9340 -filter <type>
9342 use this type of filter when resizing an image
9343 -font <name>
9345 use this font when annotating the image with text
9346 -frame <width>x<height>+<outer bevel width>+<inner bevel width>
9348 surround the image with an ornamental border
9349 -gamma <value>
9351 level of gamma correction
9352 -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@}{!}{^}{<}{>}
9354 Specify dimension, offset, and resize options.
9355 -gravity <type>
9357 direction primitive gravitates to when annotating the image.
9358 -green-primary <x>,<y>
9360 green chromaticity primary point
9361 -help print usage instructions
9363 -interlace <type>
9365 the type of interlacing scheme
9366 -label <name>
9368 assign a label to an image
9369 -limit <type> <value>
9371 Disk, File, Map, Memory, Pixels, Width, Height or Threads
9372 resource limit
9373 -log <string>
9375 Specify format for debug log
9376 -matte store matte channel if the image has one
9378 -mattecolor <color>
9380 specify the color to be used with the -frame option
9381 -mode <value>
9383 mode of operation
9384 -monitor
9386 show progress indication
9387 -monochrome
9389 transform the image to black and white
9390 -noop NOOP (no option)
9392 -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
9394 size and location of an image canvas
9395 -pen <color>
9397 (This option has been replaced by the -fill option)
9398 -pointsize <value>
9400 pointsize of the PostScript, X11, or TrueType font
9401 -quality <value>
9403 JPEG/MIFF/PNG/TIFF compression level
9404 -red-primary <x>,<y>
9406 red chromaticity primary point
9407 -render
9409 render vector operations
9410 -repage <width>x<height>+xoff+yoff[!]
9412 Adjust image page offsets
9413 -resize <width>x<height>{%}{@}{!}{<}{>}
9415 resize an image
9416 -rotate <degrees>{<}{>}
9418 rotate the image
9419 -sampling-factor <horizontal_factor>x<vertical_factor>
9421 chroma subsampling factors
9422 -scenes <value-value>
9424 range of image scene numbers to read
9425 -shadow <radius>{x<sigma>}
9427 shadow the montage
9428 -sharpen <radius>{x<sigma>}
9430 sharpen the image
9431 -size <width>x<height>{+offset}
9433 width and height of the image
9434 -strip remove all profiles and text attributes from the image
9436 -stroke <color>
9438 color to use when stroking a graphic primitive
9439 -strokewidth <value>
9441 set the stroke width
9442 -texture <filename>
9444 name of texture to tile onto the image background
9445 -thumbnail <width>x<height>{%}{@}{!}{<}{>}
9447 resize an image (quickly)
9448 -tile <geometry>
9450 layout of images [montage]
9451 -title <string>
9453 assign title to displayed image [animate, display, montage]
9454 -transform
9456 transform the image
9457 -transparent <color>
9459 make this color transparent within the image
9460 -treedepth <value>
9462 tree depth for the color reduction algorithm
9463 -trim trim an image
9465 -type <type>
9467 the image type
9468 -verbose
9470 print detailed information about the image
9471 -version
9473 print GraphicsMagick version string
9474 -white-point <x>,<y>
9476 chromaticity white point
9477 For a more detailed description of each option, see Options,
9479 above.
9480
9483 Montage options can appear on the command line or in your X resource
9484 file. Options on the command line supersede values specified in your X
9485 resource file. See X(1) for more information on X resources.
9486 All montage options have a corresponding X resource. In addition, mon‐
9488 tage uses the following X resources:
9489 background (class Background)
9491 background color
9492 Specifies the preferred color to use for the composite image
9494 background. The default is #ccc.
9495 borderColor (class BorderColor)
9497 border color
9498 Specifies the preferred color to use for the composite image
9500 border. The default is #ccc.
9501 borderWidth (class BorderWidth)
9503 border width
9504 Specifies the width in pixels of the composite image border. The
9506 default is 2.
9507 font (class Font)
9509 font to use
9510 Specifies the name of the preferred font to use when displaying
9512 text within the composite image. The default is 9x15, fixed, or
9513 5x8 determined by the composite image size.
9514 matteColor (class MatteColor)
9516 color of the frame
9517 Specify the color of an image frame. A 3D effect is achieved by
9519 using highlight and shadow colors derived from this color. The
9520 default value is #697B8F.
9521 pen (class Pen)
9523 text color
9524 Specifies the preferred color to use for text within the compos‐
9526 ite image. The default is black.
9527 title (class Title)
9529 composite image title
9530 This resource specifies the title to be placed at the top of the
9532 composite image. The default is not to place a title at the top
9533 of the composite image.
9534
9537 time executes an arbitrary gm utility command (e.g. convert) and
9538 reports the user and elapsed time. This provides way to measure com‐
9539 mand execution times similar to the Unix ´time' command but in a porta‐
9540 ble and consistent way.
9541
9543 To obtain time information for the execution of a command:
9544 % gm time convert input.ppm -gaussian 0x2 output.ppm convert input.ppm
9546 -gaussian 0x2 output.ppm 22.60s user 0.00s system 2354% cpu 0.960
9547 total
9548 Here is the interpretation of the above output:
9550 user - the total user time consumed.
9552 system - the total system time consumed.
9553 total - the total elapsed time consumed.
9554
9557 The time command reqires no options other than the gm command to exe‐
9558 cute.
9559
9562 version displays the software release version, build quantum (pixel
9563 sample) depth, web site URL, copyright notice, enabled features sup‐
9564 port, configuration parameters, and final build options used to build
9565 the software. The available information depends on how the software
9566 was configured and the host system.
9567
9569 To display the version information:
9570 GraphicsMagick 1.3.27a 2017-12-11 Q16 http://www.GraphicsMagick.org/
9572 Copyright (C) 2002-2017 GraphicsMagick Group.
9573 Additional copyrights and licenses apply to this software.
9574 See http://www.GraphicsMagick.org/www/Copyright.html for details.
9575 Feature Support:
9576 Native Thread Safe yes
9577 Large Files (> 32 bit) yes
9578 Large Memory (> 32 bit) yes
9579 BZIP yes
9580 DPS no
9581 FlashPix no
9582 FreeType yes
9583 Ghostscript (Library) no
9584 JBIG yes
9585 JPEG-2000 yes
9586 JPEG yes
9587 Little CMS yes
9588 Loadable Modules no
9589 OpenMP yes (201307)
9590 PNG yes
9591 TIFF yes
9592 TRIO no
9593 UMEM no
9594 WebP yes
9595 WMF yes
9596 X11 yes
9597 XML yes
9598 ZLIB yes
9599 Host type: x86_64-unknown-linux-gnu
9600 Configured using the command:
9601 ./configure ...
9602 Final Build Parameters:
9603 CC = ...
9604 CFLAGS = ...
9605 CPPFLAGS = ...
9606 CXX = ...
9607 CXXFLAGS = ...
9608 LDFLAGS = ...
9609 LIBS = ...
9610
9613 The version command does not currently support any options.
9614GraphicsMagick 2019/07/12 gm(1)