1gm(1)                       General Commands Manual                      gm(1)
2
3
4
5       NAME
6
7              gm  -  GraphicsMagick command-line utilities to create, edit, or
8              convert images
9
10

SYNOPSIS

12       gm animate [ options ... ] file [ [ options ... ] file ... ]
13
14       gm composite [ options ... ] change-image  base-image  [  mask-image  ]
15       output-image
16
17       gm conjure [ options ] script.msl [ [ options ] script.msl ]
18
19       gm convert [ [ options ... ] [ input-file ...  ] ... [ output-file ] ]
20
21       gm display [ options ... ] file ...  [ [options ... ]file ... ]
22
23       gm identify file [ file ... ]
24
25       gm import [ options ... ] file
26
27       gm mogrify [ options ... ] file ...
28
29       gm  montage  [  options ... ] file [ [ options ... ] file ... ] output-
30       file
31

DESCRIPTION

33        GraphicsMagick's gm provides a suite  of  command-line  utilities  for
34       creating, converting, editing, and displaying images:
35
36       Gm  display  is a machine architecture independent image processing and
37       display facility. It can display an image on  any  workstation  display
38       running an X server.
39
40       Gm  import  reads  an  image from any visible window on an X server and
41       outputs it as an image file. You  can  capture  a  single  window,  the
42       entire screen, or any rectangular portion of the screen.
43
44       Gm  montage  creates  a composite by combining several separate images.
45       The images are tiled on the composite image with the name of the  image
46       optionally appearing just below the individual tile.
47
48       Gm  convert  converts an input file using one image format to an output
49       file with the same or differing image format while  applying  an  arbi‐
50       trary number of image transformations.
51
52       Gm  mogrify  transforms  an image or a sequence of images. These trans‐
53       forms include image scaling, image rotation, color reduction, and  oth‐
54       ers. The transmogrified image overwrites the original image.
55
56       Gm  identify  describes  the  format and characteristics of one or more
57       image files. It will also report if an image is incomplete or corrupt.
58
59       Gm composite composites images (blends or merges  images  together)  to
60       create new images.
61
62       Gm conjure interprets and executes scripts in the Magick Scripting Lan‐
63       guage (MSL).
64
65       The GraphicsMagick utilities recognize the following image formats:
66
67
68       Name   Mode Description
69        o  8BIM      *rw- Photoshop resource format
70        o  AFM       *r-- TrueType font
71        o  APP1      *rw- Photoshop resource format
72        o  ART       *r-- PF1: 1st Publisher
73        o  AVI       *r-- Audio/Visual Interleaved
74        o  AVS       *rw+ AVS X image
75        o  BIE       *rw- Joint Bi-level Image experts Group
76                          interchange format
77        o  BMP       *rw+ Microsoft Windows bitmap image
78        o  CAPTION   *r+  Caption (requires separate size info)
79        o  CMYK      *rw- Raw cyan, magenta, yellow, and black
80                          samples (8 or 16 bits, depending on
81                          the image depth)
82        o  CMYKA     *rw- Raw cyan, magenta, yellow, black, and
83                          matte samples (8 or 16 bits, depending
84                          on the image depth)
85        o  CUT       *r-- DR Halo
86        o  DCM       *r-- Digital Imaging and Communications in
87                           Medicine image
88        o  DCX       *rw+ ZSoft IBM PC multi-page Paintbrush
89        o  DIB       *rw+ Microsoft Windows bitmap image
90        o  DPS       *r-- Display PostScript
91        o  DPX       *r-- Digital Moving Picture Exchange
92        o  EPDF      *rw- Encapsulated Portable Document Format
93        o  EPI       *rw- Adobe Encapsulated PostScript
94                          Interchange format
95        o  EPS       *rw- Adobe Encapsulated PostScript
96        o  EPS2      *-w- Adobe Level II Encapsulated PostScript
97        o  EPS3      *-w- Adobe Level III Encapsulated PostScript
98        o  EPSF      *rw- Adobe Encapsulated PostScript
99        o  EPSI      *rw- Adobe Encapsulated PostScript
100                          Interchange format
101        o  EPT       *rw- Adobe Encapsulated PostScript with TIFF
102                          preview
103        o  FAX       *rw+ Group 3 FAX
104        o  FILE      *r-- Uniform Resource Locator
105        o  FITS      *rw- Flexible Image Transport System
106        o  FPX       *rw- FlashPix Format
107        o  FTP       *r-- Uniform Resource Locator
108        o  G3        *rw- Group 3 FAX
109        o  GIF       *rw+ CompuServe graphics interchange format
110        o  GIF87     *rw- CompuServe graphics interchange format
111                          (version 87a)
112        o  GRADIENT  *r-- Gradual passing from one shade to
113                          another
114        o  GRANITE   *r-- Granite texture
115        o  GRAY      *rw+ Raw gray samples (8 or 16 bits,
116                          depending on the image depth)
117        o  H         *rw- Internal format
118        o  HDF       -rw+ Hierarchical Data Format
119        o  HISTOGRAM *-w- Histogram of the image
120        o  HTM       *-w- Hypertext Markup Language and a
121                          client-side image map
122        o  HTML      *-w- Hypertext Markup Language and a
123                          client-side image map
124        o  HTTP      *r-- Uniform Resource Locator
125        o  ICB       *rw+ Truevision Targa image
126        o  ICM       *rw- ICC Color Profile
127        o  ICO       *r-- Microsoft icon
128        o  ICON      *r-- Microsoft icon
129        o  IPTC      *rw- IPTC Newsphoto
130        o  JBG       *rw+ Joint Bi-level Image experts Group
131                          interchange format
132        o  JBIG      *rw+ Joint Bi-level Image experts Group
133                          interchange format
134        o  JP2       *rw- JPEG-2000 JP2 File Format Syntax
135        o  JPC       *rw- JPEG-2000 Code Stream Syntax
136        o  JPEG      *rw- Joint Photographic Experts Group
137                          JFIF format
138        o  JPG       *rw- Joint Photographic Experts Group
139                          JFIF format
140        o  LABEL     *r-- Text image format
141        o  LOGO      *rw- GraphicsMagick Logo
142        o  M2V       *rw+ MPEG-2 Video Stream
143        o  MAP       *rw- Colormap intensities (8 or 16 bits,
144                          depending on the image depth) and
145                          indices (8 or 16 bits, depending
146                          on whether colors exceeds 256).
147        o  MAT       *-w+ MATLAB image format
148        o  MATTE     *-w+ MATTE format
149        o  MIFF      *rw+ Magick image format
150        o  MNG       *rw+ Multiple-image Network Graphics
151        o  MONO      *rw- Bi-level bitmap in least-significant-
152                          -byte-first order
153        o  MPC       -rw- Magick Persistent Cache image format
154        o  MPEG      *rw+ MPEG-1 Video Stream
155        o  MPG       *rw+ MPEG-1 Video Stream
156        o  MPR       *r-- Magick Persistent Registry
157        o  MSL       *r-- Magick Scripting Language
158        o  MTV       *rw+ MTV Raytracing image format
159        o  MVG       *rw- Magick Vector Graphics
160        o  NETSCAPE  *r-- Netscape 216 color cube
161        o  NULL      *r-- Constant image of uniform color
162        o  OTB       *rw- On-the-air bitmap
163        o  P7        *rw+ Xv thumbnail format
164        o  PAL       *rw- 16bit/pixel interleaved YUV
165        o  PALM      *rw- Palm Pixmap format
166        o  PBM       *rw+ Portable bitmap format (black and white)
167        o  PCD       *rw- Photo CD
168        o  PCDS      *rw- Photo CD
169        o  PCL       *-w- Page Control Language
170        o  PCT       *rw- Apple Macintosh QuickDraw/PICT
171        o  PCX       *rw- ZSoft IBM PC Paintbrush
172        o  PDB       *r-- Pilot Image Format
173        o  PDF       *rw+ Portable Document Format
174        o  PFA       *r-- TrueType font
175        o  PFB       *r-- TrueType font
176        o  PFM       *r-- TrueType font
177        o  PGM       *rw+ Portable graymap format (gray scale)
178        o  PICON     *rw- Personal Icon
179        o  PICT      *rw- Apple Macintosh QuickDraw/PICT
180        o  PIX       *r-- Alias/Wavefront RLE image format
181        o  PLASMA    *r-- Plasma fractal image
182        o  PM        *rw- X Windows system pixmap (color)
183        o  PNG       *rw- Portable Network Graphics
184        o  PNM       *rw+ Portable anymap
185        o  PPM       *rw+ Portable pixmap format (color)
186        o  PREVIEW   *-w- Show a preview an image enhancement,
187                          effect, or f/x
188        o  PS        *rw+ Adobe PostScript
189        o  PS2       *-w+ Adobe Level II PostScript
190        o  PS3       *-w+ Adobe Level III PostScript
191        o  PSD       *rw- Adobe Photoshop bitmap
192        o  PTIF      *rw- Pyramid encoded TIFF
193        o  PWP       *r-- Seattle Film Works
194        o  RAS       *rw+ SUN Rasterfile
195        o  RGB       *rw+ Raw red, green, and blue samples (8 or
196                          16 bits, depending on the image depth)
197        o  RGBA      *rw+ Raw red, green, blue, and matte samples
198                          (8 or 16 bits, depending on the image
199                          depth)
200        o  RLA       *r-- Alias/Wavefront image
201        o  RLE       *r-- Utah Run length encoded image
202        o  ROSE      *rw- 70x46 Truecolor test image
203        o  SCT       *r-- Scitex HandShake
204        o  SFW       *r-- Seattle Film Works
205        o  SGI       *rw+ Irix RGB image
206        o  SHTML     *-w- Hypertext Markup Language and a
207                          client-side image map
208        o  STEGANO   *r-- Steganographic image
209        o  SUN       *rw+ SUN Rasterfile
210        o  SVG       *rw+ Scalable Vector Gaphics
211        o  TEXT      *rw+ Raw text
212        o  TGA       *rw+ Truevision Targa image
213        o  TIF       *rw+ Tagged Image File Format
214        o  TIFF      *rw+ Tagged Image File Format
215        o  TILE      *r-- Tile image with a texture
216        o  TIM       *r-- PSX TIM
217        o  TTF       *r-- TrueType font
218        o  TXT       *rw+ Raw text
219        o  UIL       *-w- X-Motif UIL table
220        o  UYVY      *rw- 16bit/pixel interleaved YUV
221        o  VDA       *rw+ Truevision Targa image
222        o  VICAR     *rw- VICAR rasterfile format
223        o  VID       *rw+ Visual Image Directory
224        o  VIFF      *rw+ Khoros Visualization image
225        o  VST       *rw+ Truevision Targa image
226        o  WBMP      *rw- Wireless Bitmap (level 0) image
227        o  WMF       *r-- Windows Metafile
228        o  WPG       *r-- Word Perfect Graphics
229        o  X         *rw- X Image
230        o  XBM       *rw- X Windows system bitmap (black
231                          and white)
232        o  XC        *r-- Constant image uniform color
233        o  XCF       *r-- GIMP image
234        o  XML       *r-- Scalable Vector Gaphics
235        o  XPM       *rw- X Windows system pixmap (color)
236        o  XV        *rw+ Khoros Visualization image
237        o  XWD       *rw- X Windows system window dump (color)
238        o  YUV       *rw- CCIR 601 4:1:1
239
240           Modes:
241                     *    Native blob support
242                     r    Read
243                     w    Write
244                     +    Multi-image
245
246
247       Support for some  of  these  formats  require  additional  programs  or
248       libraries.  README tells where to find this software.
249
250       Note,  a  format delineated with + means that if more than one image is
251       specified, it is composited into a single multi-image file. Use +adjoin
252       if you want a single image produced for each frame.
253
254       Your installation might not support all of the formats in the list.  To
255       get an up-to-date listing of the formats supported by  your  particular
256       configuration, run "convert -list format".
257
258       Raw  images  are  expected to have one byte per pixel unless gm is com‐
259       piled in 16-bit mode or in 32-bit mode. Here, the raw data is  expected
260       to be stored two or four bytes per pixel, respectively, in most-signif‐
261       icant-byte-first order.  You can tell if gm was compiled in 16-bit mode
262       by  typing  "gm version" without any options, and looking for "Q:16" in
263       the first line of output.
264

FILES AND FORMATS

266       By default, the image format is determined by its magic  number,  i.e.,
267       the  first few bytes of the file. To specify a particular image format,
268       precede  the  filename  with  an  image  format  name   and   a   colon
269       (i.e.ps:image)  or  specify the image type as the filename suffix.  The
270       magic number takes precedence over the filename suffix and  the  prefix
271       takes  precedence  over the magic number and the suffix in input files.
272       The prefix takes precedence over the filename suffix in  output  files.
273       To read the "built-in" formats (GRANITE, H, LOGO, NETSCAPE, PLASMA, and
274       ROSE) use a prefix (including the colon) without a filename or  suffix.
275       To read the XC format, follow the colon with a color specification.  To
276       read the CAPTION format, follow the colon with a text string or with  a
277       filename prefixed with the at symbol (@).
278
279
280       When  you  specify X as your image type, the filename has special mean‐
281       ing. It specifies an X window by id, name, or root. If no  filename  is
282       specified,  the window is selected by clicking the mouse in the desired
283       window.
284
285       Specify input_file as - for standard input, output_file as - for  stan‐
286       dard  output.   If  input_file has the extension .Z or .gz, the file is
287       uncompressed with uncompress or gunzip  respectively.   If  output_file
288       has the extension .Z or .gz, the file is compressed using with compress
289       or gzip respectively.
290
291       Finally, when running on platforms that allow  it,  precede  the  image
292       file  name  with | to pipe to or from a system command (this feature is
293       not available on VMS, Win32 and Macintosh platforms). Use  a  backslash
294       or quotation marks to prevent your shell from interpreting the |.
295
296       Use  an optional index enclosed in brackets after an input file name to
297       specify a desired subimage of  a  multi-resolution  image  format  like
298       Photo  CD  (e.g.  "img0001.pcd[4]")  or  a  range for MPEG images (e.g.
299       "video.mpg[50-75]"). A subimage specification  can  be  disjoint  (e.g.
300       "image.tiff[2,7,4]").  For raw images, specify a subimage with a geome‐
301       try (e.g.  -size  640x512  "image.rgb[320x256+50+50]").   Surround  the
302       image name with quotation marks to prevent your shell from interpreting
303       the square brackets.  Single images are written with the  filename  you
304       specify. However, multi-part images (e.g., a multi-page PostScript doc‐
305       ument with +adjoin specified) are written with the filename followed by
306       a  period  (.)   and  the scene number. You can change this behavior by
307       embedding a %d format specification in the file name. For example,
308
309           image%02d.miff
310
311       writes files image00.miff, image01.miff, etc. Only a single  specifica‐
312       tion  is allowed within an output filename. If more than one specifica‐
313       tion is present, it will be ignored.
314
315       When running a commandline utility, you can prepend an at sign @  to  a
316       filename to read a list of image filenames from that file. This is con‐
317       venient in the event you have too many image filenames to  fit  on  the
318       command line.
319

OPTIONS

321       Options  are processed in command line order. Any option you specify on
322       the command line remains in effect for the set of images that  follows,
323       until  the  set is terminated by the appearance of any option or -noop.
324       Some options only affect the decoding of images  and  others  only  the
325       encoding.  The latter can appear after the final group of input images.
326
327       This is a combined list of the commandline options used by the Graphic‐
328       sMagick utilities  (animate,  composite,  convert,  display,  identify,
329       import, mogrify and montage).
330
331
332       In  this  document,  angle  brackets ("<>") enclose variables and curly
333       brackets ("{}") enclose optional parameters. For example, "-fuzz  <dis‐
334       tance>{%}" means you can use the option "-fuzz 10" or "-fuzz 2%".
335
336
337       -adjoin
338              join images into a single multi-image file
339
340              By  default,  all  images of an image sequence are stored in the
341              same file. However, some formats (e.g. JPEG) do not support more
342              than  one  image and are saved to separate files. Use +adjoin to
343              force this behavior.
344
345       -affine <matrix>
346              drawing transform matrix
347
348              This option provides a transform matrix {sx,rx,ry,sy,tx,ty}  for
349              use by subsequent -draw or -transform options.
350
351       -antialias
352              remove pixel aliasing
353
354              By default antialiasing algorithms are used when drawing objects
355              (e.g. lines) or rendering vector formats  (e.g.  WMF  and  Post‐
356              script).  Use  +antialias  to  disable use of antialiasing algo‐
357              rithms.  Reasons  to  disable  antialiasing   include   avoiding
358              increasing colors in the image, or improving rendering speed.
359
360       -append
361              append a set of images
362
363              This option creates a single image where the images in the orig‐
364              inal set are stacked top-to-bottom.  If they are not of the same
365              width, any narrow images will be expanded to fit using the back‐
366              ground color.  Use +append to stack images  left-to-right.   The
367              set of images is terminated by the appearance of any option.  If
368              the -append option appears after all of the  input  images,  all
369              images are appended.
370
371       -authenticate <string>
372              decrypt image with this password
373
374              Use  this option to supply a password for decrypting an image or
375              an image sequence, if it is being read from a format such as PDF
376              that  supports  encryption.   Encrypting images being written is
377              not supported.
378
379       -average
380              average a set of images
381
382              The set of images is terminated by the appearance of any option.
383              If  the  -average  option appears after all of the input images,
384              all images are averaged.
385
386       -backdrop
387              display the image centered on a backdrop.
388
389              This backdrop covers the entire workstation screen and is useful
390              for  hiding other X window activity while viewing the image. The
391              color of the backdrop is specified as the foreground color  (X11
392              default is black).  Refer to "X Resources", below, for details.
393
394       -background <color>
395              the background color
396
397              The  color  is  specified  using  the format described under the
398              -fill option.
399
400       -blue-primary <x>,<y>
401              blue chromaticity primary point
402
403       -blur <radius>{x<sigma>}
404              blur the image with a Gaussian operator
405
406              Blur with the given radius and standard deviation (sigma).
407
408       -border <width>x<height>
409              surround the image with a border of color
410
411              See -geometry for details about the geometry specification.
412
413       -bordercolor <color>
414              the border color
415
416              The color is specified using  the  format  described  under  the
417              -fill option.
418
419       -borderwidth <geometry>
420              the border width
421
422       -box <color>
423              set the color of the annotation bounding box
424
425              The  color  is  specified  using  the format described under the
426              -fill option.
427
428              See -draw for further details.
429
430       -cache <threshold>
431              (This option has been replaced by the -limit option)
432
433       -channel <type>
434              the type of channel
435
436              Choose from: Red, Green, Blue, Opacity,  Matte,  Cyan,  Magenta,
437              Yellow, or Black.
438
439              Use  this option to extract a particular channel from the image.
440              Matte, for example, is useful for extracting the opacity  values
441              from an image.
442
443       -charcoal <factor>
444              simulate a charcoal drawing
445
446       -chop <width>x<height>{+-}<x>{+-}<y>{%}
447              remove pixels from the interior of an image
448
449              Width  and height give the number of columns and rows to remove,
450              and x and y are offsets that give the location of  the  leftmost
451              column and topmost row to remove.
452
453              The  x  offset normally specifies the leftmost column to remove.
454              If the -gravity option  is  present  with  NorthEast,  East,  or
455              SouthEast gravity, it gives the distance leftward from the right
456              edge of the image to the rightmost column to remove.  Similarly,
457              the  y  offset normally specifies the topmost row to remove, but
458              if the -gravity option is  present  with  SouthWest,  South,  or
459              SouthEast  gravity,  it  specifies  the distance upward from the
460              bottom edge of the image to the bottom row to remove.
461
462              The -chop option removes entire rows and columns, and moves  the
463              remaining corner blocks leftward and upward to close the gaps.
464
465       -clip  apply the clipping path, if one is present
466
467              If  a clipping path is present, it will be applied to subsequent
468              operations.
469
470              For example, if you type the following command:
471
472                   gm convert -clip -negate cockatoo.tif negated.tif
473
474              only the pixels within the clipping path are negated.
475
476              The -clip feature requires the XML library.  If the XML  library
477              is not present, the option is ignored.
478
479       -coalesce
480              merge a sequence of images
481
482              Each  image N in the sequence after Image 0 is replaced with the
483              image created by flattening images 0 through N.
484
485              The set of images is terminated by the appearance of any option.
486              If  the  -coalesce option appears after all of the input images,
487              all images are coalesced.
488
489       -colorize <value>
490              colorize the image with the pen color
491
492              Specify the amount of colorization  as  a  percentage.  You  can
493              apply  separate  colorization values to the red, green, and blue
494              channels of the image with a colorization value  list  delimited
495              with slashes (e.g. 0/0/50).
496
497       -colormap <type>
498              define the colormap type
499
500              Choose between shared or private.
501
502              This  option  only  applies  when the default X server visual is
503              PseudoColor or GRAYScale. Refer to -visual for more details.  By
504              default, a shared colormap is allocated. The image shares colors
505              with other X clients.  Some image colors could be  approximated,
506              therefore  your  image  may  look  very different than intended.
507              Choose Private and the image colors appear exactly as  they  are
508              defined.  However,  other  clients  may  go technicolor when the
509              image colormap is installed.
510
511       -colors <value>
512              preferred number of colors in the image
513
514              The actual number of colors in the image may be less  than  your
515              request, but never more. Note, this is a color reduction option.
516              Images with less unique colors than specified with  this  option
517              will  have  any duplicate or unused colors removed. The ordering
518              of an existing color palette may be altered. When converting  an
519              image  from  color  to  grayscale, convert the image to the gray
520              colorspace before reducing the number of colors since  doing  so
521              is most efficient. Refer to <a href="quantize.html">quantize for
522              more details.
523
524              Note, options -dither, -colorspace, and  -treedepth  affect  the
525              color reduction algorithm.
526
527       -colorspace <value>
528              the type of colorspace
529
530              Choices  are: CMYK, GRAY, HSL, HWB, OHTA, RGB, Transparent, XYZ,
531              YCbCr, YIQ, YPbPr, or YUV.
532
533              Color reduction, by default, takes place in the RGB color space.
534              Empirical  evidence suggests that distances in color spaces such
535              as YUV or YIQ correspond to perceptual  color  differences  more
536              closely  than do distances in RGB space.  These color spaces may
537              give better results when color  reducing  an  image.   Refer  to
538              quantize for more details.
539
540              The  Transparent  color  space  behaves uniquely in that it pre‐
541              serves the matte channel of the image if it exists.
542
543              The -colors or -monochrome option, or saving to  a  file  format
544              which  requires  color reduction, is required for this option to
545              take effect.
546
547       -comment <string>
548              annotate an image with a comment
549
550              Use this option to assign a specific comment to the image,  when
551              writing  to  an  image  format  that  supports comments. You can
552              include the image filename, type, width, height, or other  image
553              attribute  by  embedding  special format characters listed under
554              the -format option.  The comment is not drawn on the image,  but
555              is embedded in the image datastream via a "Comment" tag or simi‐
556              lar mechanism.  If you want the comment to  be  visible  on  the
557              image itself, use the -draw option.
558
559              For example,
560
561                   -comment "%m:%f %wx%h"
562
563              produces an image comment of MIFF:bird.miff 512x480 for an image
564              titled bird.miff and whose width is 512 and height is 480.
565
566              If the first character of string is @, the image comment is read
567              from a file titled by the remaining characters in the string.
568
569       -compose <operator>
570              the type of image composition
571
572              The  description  of  composition  uses  abstract terminology in
573              order to allow the the  description  to  be  more  clear,  while
574              avoiding  constant  values  which  are  specific to a particular
575              build configuration. Each image pixel  is  represented  by  red,
576              green,  and  blue  levels  (which  are  equal for a gray pixel).
577              MaxRGB is the maximum integral value which may be stored in  the
578              red,  green, or blue channels of the image. Each image pixel may
579              also optionally (if the image matte channel is enabled) have  an
580              associated  level  of  opacity (ranging from opaque to transpar‐
581              ent), which may be used to determine the influence of the  pixel
582              color  when  compositing  the pixel with another image pixel. If
583              the image matte channel is disabled,  then  all  pixels  in  the
584              image  are  treated  as opaque.  The color of an opaque pixel is
585              fully visible while the color of a transparent  pixel  color  is
586              entirely absent (pixel color is ignored).
587
588              By definition, raster images have a rectangular shape. All image
589              rows are of equal length, and all image columns  have  the  same
590              number  of  rows.  By  treating  the opacity channel as a visual
591              "mask" the rectangular image may be given a "shape" by  treating
592              the  opacity  channel  as  a cookie-cutter for the image. Pixels
593              within the shape are opaque, while pixels outside the shape  are
594              transparent.  Pixels on the boundary of the shape may be between
595              opaque and transparent in order to provide antialiasing (visual‐
596              ly  smooth  edges). The description of the composition operators
597              use this concept of image "shape" in order to make the  descrip‐
598              tion  of  the operators easier to understand. While it is conve‐
599              nient to describe the operators in terms of "shapes" they are by
600              no  means  limited to mask-style operations since they are based
601              on continuous  floating-point  mathematics  rather  than  simple
602              boolean operations.
603
604              By  default,  the Over composite operator is used. The following
605              composite operators are available:
606
607                   Over
608                   In
609                   Out
610                   Atop
611                   Xor
612                   Plus
613                   Minus
614                   Add
615                   Subtract
616                   Difference
617                   Multiply
618                   Bumpmap
619                   Copy
620                   CopyRed
621                   CopyGreen
622                   CopyBlue
623                   CopyOpacity
624
625              The behavior of each operator is described below.
626
627               Over
628
629                    The result will be the union of the two image shapes, with
630                    opaque  areas  of change-image obscuring base-image in the
631                    region of overlap.
632
633               In
634
635                    The result is simply change-image  cut  by  the  shape  of
636                    base-image.  None  of the image data of base-image will be
637                    in the result.
638
639               Out
640
641                    The resulting image is  change-image  with  the  shape  of
642                    base-image cut out.
643
644               Atop
645
646                    The  result  is the same shape as base-image, with change-
647                    image obscuring base-image where the image shapes overlap.
648                    Note this differs from over because the portion of change-
649                    image outside base-image's shape does not  appear  in  the
650                    result.
651
652               Xor
653
654                    The  result  is  the image data from both change-image and
655                    base-image that is outside the overlap region. The overlap
656                    region will be blank.
657
658               Plus
659
660                    The  result is just the sum of the image data. Output val‐
661                    ues are cropped to MaxRGB (no overflow). This operation is
662                    independent of the matte channels.
663
664               Minus
665
666                    The  result  of  change-image - base-image, with underflow
667                    cropped to zero. The matte  channel  is  ignored  (set  to
668                    opaque, full coverage).
669
670               Add
671
672                    The  result  of  change-image  + base-image, with overflow
673                    wrapping around (mod MaxRGB+1).
674
675               Subtract
676
677                    The result of change-image -  base-image,  with  underflow
678                    wrapping around (mod MaxRGB+1). The add and subtract oper‐
679                    ators can be used to perform reversible transformations.
680
681               Difference
682
683                    The result of abs(change-image - base-image). This is use‐
684                    ful for comparing two very similar images.
685
686               Multiply
687
688                    The  result  of  change-image * base-image. This is useful
689                    for the creation of drop-shadows.
690
691               Bumpmap
692
693                    The result base-image shaded by change-image.
694
695               Copy
696
697                    The resulting image is base-image  replaced  with  change-
698                    image. Here the matte information is ignored.
699
700               CopyRed
701
702                    The  resulting  image  is  the  red  channel in base-image
703                    replaced with the red channel in change-image.  The  other
704                    channels are copied untouched.
705
706               CopyGreen
707
708                    The  resulting  image  is  the green channel in base-image
709                    replaced with the green channel in change-image. The other
710                    channels are copied untouched.
711
712               CopyBlue
713
714                    The  resulting  image  is  the  blue channel in base-image
715                    replaced with the blue channel in change-image. The  other
716                    channels are copied untouched.
717
718               CopyOpacity
719
720                    The  resulting  image is the opacity channel in base-image
721                    replaced with the opacity  channel  in  change-image.  The
722                    other channels are copied untouched.
723
724
725
726       -compress <type>
727              the type of image compression
728
729              Choices  are:  None, BZip, Fax, Group4, JPEG, Lossless, LZW, RLE
730              or Zip.
731
732
733              Specify +compress to store the binary image in  an  uncompressed
734              format.   The  default  is the compression type of the specified
735              image file.
736
737              If LZW compression is specified but LZW compression has not been
738              enabled,  the  image data will be written in an uncompressed LZW
739              format that can be read by LZW decoders.   This  may  result  in
740              larger-than-expected GIF files.
741
742              "Lossless"  refers  to lossless JPEG, which is only available if
743              the JPEG library has been patched to support it. Use of lossless
744              JPEG is generally not recommended.
745
746              Use  the -quality option to set the compression level to be used
747              by JPEG, PNG, MIFF, and MPEG encoders.  Use the -sampling-factor
748              option  to set the sampling factor to be used by JPEG, MPEG, and
749              YUV encoders for downsampling the chroma channels.
750
751       -contrast
752              enhance or reduce the image contrast
753
754              This option  enhances  the  intensity  differences  between  the
755              lighter  and  darker  elements  of  the  image. Use -contrast to
756              enhance the image or +contrast to reduce the image contrast.
757
758
759              For a more pronounced effect you can repeat the option:
760
761                  gm convert rose: -contrast -contrast rose_c2.png
762
763       -convolve <kernel>
764              convolve image with the specified convolution kernel
765
766              The kernel is specified as a comma-separated list  of  integers,
767              ordered  left-to right, starting with the top row.  The order of
768              the kernel is determined by the square root  of  the  number  of
769              entries.  Presently only square kernels are supported.
770
771       -crop <width>x<height>{+-}<x>{+-}<y>{%}
772              preferred size and location of the cropped image
773
774              See -geometry for details about the geometry specification.
775
776              The  width  and  height  give the size of the image that remains
777              after cropping, and x and y are offsets that give  the  location
778              of  the top left corner of the cropped image with respect to the
779              original image.  To specify the amount to be removed, use -shave
780              instead.
781
782              If the x and y offsets are present, a single image is generated,
783              consisting of the pixels from the cropping region.  The  offsets
784              specify  the  location  of the upper left corner of the cropping
785              region measured downward and rightward with respect to the upper
786              left  corner  of  the  image.  If the -gravity option is present
787              with NorthEast, East, or SouthEast gravity, it  gives  the  dis‐
788              tance  leftward  from  the  right edge of the image to the right
789              edge of the cropping region.  Similarly, if the -gravity  option
790              is present with SouthWest, South, or SouthEast gravity, the dis‐
791              tance is measured upward between the bottom edges.
792
793              If the x and y offsets are omitted, a set of tiles of the speci‐
794              fied  geometry,  covering  the entire input image, is generated.
795              The rightmost tiles and the bottom  tiles  are  smaller  if  the
796              specified  geometry  extends  beyond the dimensions of the input
797              image.
798
799       -cycle <amount>
800              displace image colormap by amount
801
802              Amount defines the  number  of  positions  each  colormap  entry
803              isshifted.
804
805
806       -debug <events>
807              enable debug printout
808
809              The  events  parameter  specifies which events are to be logged.
810              It can be either None, All, or a comma-separated list consisting
811              of  one or more of the following domains: Annotate, Blob, Cache,
812              Coder, Configure,  Deprecate,  Error,  Exception,  Locale,  Ren‐
813              der,Resource,  TemporaryFile,  Transform, Warning, X11, or User.
814              For example, to log cache and blob events, use
815
816                  gm convert -debug "Cache,Blob" rose: rose.png
817
818              The "User" domain is normally  empty,  but  developers  can  log
819              "User" events in their private copy of GraphicsMagick.
820
821              Use the -log option to specify the format for debugging output.
822
823              Use +debug to turn off all logging.
824
825              An  alternative to using -debug is to use the MAGICK_DEBUG envi‐
826              ronment variable. The allowed values for the MAGICK_DEBUG  envi‐
827              ronment variable are the same as for the -debug option.
828
829       -deconstruct
830              break down an image sequence into constituent parts
831
832              This  option compares each image with the next in a sequence and
833              returns the maximum bounding region of any pixel differences  it
834              discovers.   This  method can undo a coalesced sequence returned
835              by the -coalesce option, and is useful  for  removing  redundant
836              information from a GIF or MNG animation.
837
838              The  sequence  of  images is terminated by the appearance of any
839              option.  If the -deconstruct option appears  after  all  of  the
840              input images, all images are deconstructed.
841
842       -define <key>{=<value>},...
843              add  coder/decoder  specific  options This option creates one or
844              more definitions for coders and decoders to  use  while  reading
845              and  writing image data. Definitions may be passed to coders and
846              decoders to control options that are specific to  certain  image
847              formats.  If  value is missing for a definition, an empty-valued
848              definition of a flag will be created with  that  name.  This  is
849              used  to control on/off options. Use +define <key>,... to remove
850              definitions previously created. Use +define "*"  to  remove  all
851              existing definitions.
852
853              The following definitions may be created:
854
855               jp2:rate=<value>
856
857
858                    Specify  the  compression  factor  to  use  while  writing
859                    JPEG-2000 files. The compression factor is the  reciprocal
860                    of  the  compression ratio. The valid range is 0.0 to 1.0,
861                    with 1.0 indicating lossless compression. If defined, this
862                    value  overrides the -quality setting. The default quality
863                    setting of 75 results in a rate value of 0.06641.
864
865               jpeg:preserve-settings
866
867
868                    If the jpeg:preserve-settings flag is  defined,  the  JPEG
869                    encoder  will use the same "quality" and "sampling-factor"
870                    settings that were found in the input file, if  the  input
871                    was  in  JPEG format. These settings are also preserved if
872                    the input is a JPEG file and the output is a JNG file.  If
873                    the colorspace of the output file differs from that of the
874                    input file, the quality setting is preserved but the  sam‐
875                    pling-factors are not.
876
877               ps:imagemask
878
879
880                    If  the  ps:imagemask  flag  is  defined, the PS3 and EPS3
881                    coders will create Postscript files  that  render  bilevel
882                    images  with  the Postscript imagemask operator instead of
883                    the image operator.
884
885               tiff:bits-per-sample=<value>
886
887
888                    If the tiff:bits-per-sample key is defined to a value less
889                    than the GraphicsMagick Quantum depth, the TIFF coder will
890                    write TIFF images with the defined bits per sample,  over‐
891                    riding any value stored in the image.
892
893               tiff:samples-per-pixel=<value>
894
895
896                    If  the  tiff:samples-per-pixel key is defined to a value,
897                    the TIFF coder will write TIFF  images  with  the  defined
898                    samples  per  pixel,  overriding  any  value stored in the
899                    image.
900
901
902
903               For example, to create a postscript file that will render  only
904               the black pixels of a bilevel image, use:
905
906                   gm convert bilevel.tif -define ps:imagemask eps3:stencil.ps
907
908       -delay <1/100ths of a second>
909              display the next image after pausing
910
911              This  option  is  useful  for  regulating the animation of image
912              sequences Delay/100 seconds must expire before  the  display  of
913              the  next image. The default is no delay between each showing of
914              the image sequence. The maximum delay is 65535.
915
916              You can specify a delay range (e.g. -delay  10-500)  which  sets
917              the minimum and maximum delay.
918
919       -density <width>x<height>
920              horizontal  and  vertical resolution in pixels of the image This
921              option specifies the image resolution to store while encoding  a
922              raster  image or the canvas resolution while rendering (reading)
923              vector formats such as Postscript, PDF,  WMF,  and  SVG  into  a
924              raster  image.  Image resolution provides the unit of measure to
925              apply when rendering to an output device or  raster  image.  The
926              default  unit  of  measure is in dots per inch (DPI). The -units
927              option may be used to select dots per centimeter instead.
928               The default resolution is 72 dots per inch, which is equivalent
929              to one point per pixel (Macintosh and Postscript standard). Com‐
930              puter screens are normally 72 or 96 dots per inch while printers
931              typically  support  150,  300,  600,  or  1200 dots per inch. To
932              determine the resolution of your display, use a ruler to measure
933              the  width of your screen in inches, and divide by the number of
934              horizontal pixels (1024 on a 1024x768  display).   If  the  file
935              format supports it, this option may be used to update the stored
936              image resolution. Note that Photoshop stores and  obtains  image
937              resolution  from a proprietary embedded profile. If this profile
938              is not stripped from the image, then Photoshop will continue  to
939              treat  the image using its former resolution, ignoring the image
940              resolution specified in the standard file header.   The  density
941              option  is an attribute and does not alter the underlying raster
942              image. It may be used to adjust the rendered  size  for  desktop
943              publishing  purposes  by adjusting the scale applied to the pix‐
944              els. To resize the image so that it is the same size at  a  dif‐
945              ferent resolution, use the -resample option.
946
947       -depth <value>
948              depth of the image
949
950              This is the number of bits in a color sample within a pixel. The
951              only acceptable values are 8 or 16.  Use this option to  specify
952              the  depth  of  raw  images whose depth is unknown such as GRAY,
953              RGB, or CMYK, or to change the depth of any image after  it  has
954              been read.
955
956       -descend
957              obtain image by descending window hierarchy
958
959       -despeckle
960              reduce the speckles within an image
961
962       -displace <horizontal scale>x<vertical scale>
963              shift image pixels as defined by a displacement map
964
965              With this option, composite image is used as a displacement map.
966              Black, within the displacement map, is a maximum  positive  dis‐
967              placement.   White is a maximum negative displacement and middle
968              gray is neutral.  The displacement is scaled  to  determine  the
969              pixel  shift.   By default, the displacement applies in both the
970              horizontal and vertical directions.   However,  if  you  specify
971              mask,  composite image is the horizontal X displacement and mask
972              the vertical Y displacement.
973
974       -display <host:display[.screen]>
975              specifies the X server to contact
976
977              This option is used with convert for  obtaining  image  or  font
978              from this X server.  See X(1).
979
980       -dispose <method>
981              GIF disposal method
982
983              The Disposal Method indicates the way in which the graphic is to
984              be treated after being displayed.
985
986              Here are the valid methods:
987
988                  Undefined       No disposal specified.
989                  None            Do not dispose between frames.
990                  Background      Overwrite the image area with
991                                  the background color.
992                  Previous        Overwrite the image area with
993                                  what was there prior to rendering
994                                  the image.
995
996       -dissolve <percent>
997              dissolve an image into another by the given percent
998
999              The opacity of the composite image is multiplied  by  the  given
1000              percent, then it is composited over the main image.
1001
1002       -dither
1003              apply Floyd/Steinberg error diffusion to the image
1004
1005              The basic strategy of dithering is to trade intensity resolution
1006              for spatial resolution by averaging the intensities  of  several
1007              neighboring  pixels.  Images which suffer from severe contouring
1008              when reducing colors can be improved with this option.
1009
1010              The -colors or -monochrome option is required for this option to
1011              take effect.
1012
1013              Use +dither to turn off dithering and to render PostScript with‐
1014              out text or graphic aliasing. Disabling dithering often (but not
1015              always) leads to decreased processing time.
1016
1017       -draw <string>
1018              annotate an image with one or more graphic primitives
1019
1020              Use  this  option  to annotate an image with one or more graphic
1021              primitives.  The primitives include  shapes,  text,  transforma‐
1022              tions, and pixel operations.  The shape primitives are
1023
1024                   point           x,y
1025                   line            x0,y0 x1,y1
1026                   rectangle       x0,y0 x1,y1
1027                   roundRectangle  x0,y0 x1,y1 wc,hc
1028                   arc             x0,y0 x1,y1 a0,a1
1029                   ellipse         x0,y0 rx,ry a0,a1
1030                   circle          x0,y0 x1,y1
1031                   polyline        x0,y0  ...  xn,yn
1032                   polygon         x0,y0  ...  xn,yn
1033                   Bezier          x0,y0  ...  xn,yn
1034                   path            path specification
1035                   image           operator x0,y0 w,h filename
1036
1037              The text primitive is
1038
1039                   text            x0,y0 string
1040
1041              The text gravity primitive is
1042
1043                   gravity         NorthWest, North, NorthEast, West, Center,
1044                                   East, SouthWest, South, or SouthEast
1045
1046              The  text  gravity  primitive only affects the placement of text
1047              and does not interact with the other primitives.  It is  equiva‐
1048              lent to using the -gravity commandline option, except that it is
1049              limited in scope to the -draw option in which it appears.
1050
1051              The transformation primitives are
1052
1053                   rotate          degrees
1054                   translate       dx,dy
1055                   scale           sx,sy
1056                   skewX           degrees
1057                   skewY           degrees
1058
1059              The pixel operation primitives are
1060
1061                   color           x0,y0 method
1062                   matte           x0,y0 method
1063
1064              The shape primitives are drawn in the  color  specified  in  the
1065              preceding  -stroke  option. Except for the line and point primi‐
1066              tives, they are filled with the color specified in the preceding
1067              -fill option.  For unfilled shapes, use -fill none.
1068
1069              Point requires a single coordinate.
1070
1071              Line requires a start and end coordinate.
1072
1073              Rectangle expects an upper left and lower right coordinate.
1074
1075              RoundRectangle  has  the  upper left and lower right coordinates
1076              and the width and height of the corners.
1077
1078              Circle has a center coordinate and a coordinate  for  the  outer
1079              edge.
1080
1081              Use  Arc to inscribe an elliptical arc within a rectangle.  Arcs
1082              require a start and end point as well as the degree of  rotation
1083              (e.g. 130,30 200,100 45,90).
1084
1085              Use  Ellipse  to  draw  a  partial ellipse centered at the given
1086              point with the x-axis and y-axis radius and start and end of arc
1087              in degrees (e.g. 100,100 100,150 0,360).
1088
1089              Finally,  polyline and polygon require three or more coordinates
1090              to define its boundaries.  Coordinates are integers separated by
1091              an  optional comma.  For example, to define a circle centered at
1092              100,100 that extends to 150,150 use:
1093
1094                   -draw 'circle 100,100 150,150'
1095
1096              Paths (See Paths) represent an outline of  an  object  which  is
1097              defined  in  terms  of  moveto (set a new current point), lineto
1098              (draw a straight line), curveto (draw  a  curve  using  a  cubic
1099              Bezier),  arc  (elliptical or circular arc) and closepath (close
1100              the current shape by drawing a line to  the  last  moveto)  ele‐
1101              ments. Compound paths (i.e., a path with subpaths, each consist‐
1102              ing of a single moveto followed by one or  more  line  or  curve
1103              operations)  are possible to allow effects such as "donut holes"
1104              in objects.
1105
1106              Use image to composite an image with another image.  Follow  the
1107              image keyword with the composite operator, image location, image
1108              size, and filename:
1109
1110                   -draw 'image Over 100,100 225,225 image.jpg'
1111
1112              You can use 0,0 for the image  size,  which  means  to  use  the
1113              actual  dimensions found in the image header. Otherwise, it will
1114              be scaled to the given dimensions.  See -compose for a  descrip‐
1115              tion of the composite operators.
1116
1117              Use text to annotate an image with text. Follow the text coordi‐
1118              nates with a string. If the string has embedded spaces,  enclose
1119              it  in  single  or double quotes. Optionally you can include the
1120              image filename, type, width, height, or other image attribute by
1121              embedding special format character. See -comment for details.
1122
1123              For example,
1124
1125
1126                   -draw 'text 100,100 "%m:%f %wx%h"'
1127
1128              annotates  the  image  with  MIFF:bird.miff 512x480 for an image
1129              titled bird.miff and whose width is 512 and height is 480.
1130
1131              If the first character of string is @, the text is read  from  a
1132              file titled by the remaining characters in the string.
1133
1134              Rotate  rotates  subsequent shape primitives and text primitives
1135              about the origin of the main image. If the -region  option  pre‐
1136              cedes  the  -draw  option, the origin for transformations is the
1137              upper left corner of the region.
1138
1139              Translate translates them.
1140
1141              Scale scales them.
1142
1143              SkewX and SkewY skew them with respect to the origin of the main
1144              image or the region.
1145
1146              The  transformations  modify the current affine matrix, which is
1147              initialized from  the  initial  affine  matrix  defined  by  the
1148              -affine option.  Transformations are cumulative within the -draw
1149              option.  The initial affine matrix is not affected; that  matrix
1150              is only changed by the appearance of another -affine option.  If
1151              another -draw option  appears,  the  current  affine  matrix  is
1152              reinitialized from the initial affine matrix.
1153
1154              Use  color to change the color of a pixel to the fill color (see
1155              -fill). Follow the pixel coordinate with a method:
1156
1157                   point
1158                   replace
1159                   floodfill
1160                   filltoborder
1161                   reset
1162
1163              Consider the target pixel as that specified by your  coordinate.
1164              The  point  method recolors the target pixel. The replace method
1165              recolors any pixel that matches the color of the  target  pixel.
1166              Floodfill  recolors any pixel that matches the color of the tar‐
1167              get pixel and is a neighbor, whereas filltoborder  recolors  any
1168              neighbor  pixel  that  is  not  the border color. Finally, reset
1169              recolors all pixels.
1170
1171              Use matte to the change the pixel matte  value  to  transparent.
1172              Follow  the pixel coordinate with a method (see the color primi‐
1173              tive for a description of methods). The point method changes the
1174              matte  value of the target pixel. The replace method changes the
1175              matte value of any pixel that matches the color  of  the  target
1176              pixel.  Floodfill  changes  the  matte  value  of any pixel that
1177              matches the color of the target pixel and is a neighbor, whereas
1178              filltoborder  changes the matte value of any neighbor pixel that
1179              is not the border color (-bordercolor).  Finally  reset  changes
1180              the matte value of all pixels.
1181
1182              You  can  set  the  primitive color, font, and font bounding box
1183              color with -fill, -font, and -box respectively. Options are pro‐
1184              cessed  in  command  line  order so be sure to use these options
1185              before the -draw option.
1186
1187       -edge <radius>
1188              detect edges within an image
1189
1190       -emboss <radius>
1191              emboss an image
1192
1193       -encoding <type>
1194              specify the text encoding
1195
1196              Choose from AdobeCustom, AdobeExpert, AdobeStandard, AppleRoman,
1197              BIG5, GB2312, Latin 2, None, SJIScode, Symbol, Unicode, Wansung.
1198
1199       -endian <type>
1200              specify endianness (MSB or LSB) of output image
1201
1202              Use +endian to revert to unspecified endianness.
1203
1204       -enhance
1205              apply a digital filter to enhance a noisy image
1206
1207       -equalize
1208              perform histogram equalization to the image
1209
1210       -fill <color>
1211              color to use when filling a graphic primitive
1212
1213              Colors  are  represented in GraphicsMagick in the same form used
1214              by SVG. Use "gm convert -list color" to list named colors:
1215
1216                  name               (named color)
1217                  #RGB               (hex numbers, 4 bits each)
1218                  #RRGGBB            (8 bits each)
1219                  #RRRGGGBBB         (12 bits each)
1220                  #RRRRGGGGBBBB      (16 bits each)
1221                  #RGBA              (4 bits each)
1222                  #RRGGBBAA          (8 bits each)
1223                  #RRRGGGBBBAAA      (12 bits each)
1224                  #RRRRGGGGBBBBAAAA  (16 bits each)
1225                  rgb(r,g,b)         (r,g,b are decimal numbers)
1226                  rgba(r,g,b,a)      (r,g,b,a are decimal numbers)
1227
1228              Enclose the color specification in quotation  marks  to  prevent
1229              the "#" or the parentheses from being interpreted by your shell.
1230
1231              For example,
1232
1233                  gm convert -fill blue ...
1234                  gm convert -fill "#ddddff" ...
1235                  gm convert -fill "rgb(65000,65000,65535)" ...
1236
1237              The  shorter  forms  are scaled up, if necessary by replication.
1238              For example, #3af, #33aaff, and #3333aaaaffff  are  all  equiva‐
1239              lent.
1240
1241              See -draw for further details.
1242
1243       -filter <type>
1244              use this type of filter when resizing an image
1245
1246              Use  this  option  to  affect the resizing operation of an image
1247              (see -geometry).  Choose from these filters:
1248
1249                   Point
1250                   Box
1251                   Triangle
1252                   Hermite
1253                   Hanning
1254                   Hamming
1255                   Blackman
1256                   Gaussian
1257                   Quadratic
1258                   Cubic
1259                   Catrom
1260                   Mitchell
1261                   Lanczos
1262                   Bessel
1263                   Sinc
1264
1265              The default filter is automatically selected to provide the best
1266              quality  while  consuming  a  reasonable  amount  of  time.  The
1267              Mitchell filter is used if the image supports  a  palette,  sup‐
1268              ports a matte channel, or is being enlarged, otherwise the Lanc‐
1269              zos filter is used.
1270
1271       -flatten
1272              flatten a sequence of images
1273
1274              The sequence of images is replaced by a single image created  by
1275              composing each image after the first over the first image.
1276
1277              The  sequence  of  images is terminated by the appearance of any
1278              option.  If the -flatten option appears after all of  the  input
1279              images, all images are flattened.
1280
1281       -flip  create a "mirror image"
1282
1283              reflect the scanlines in the vertical direction.
1284
1285       -flop  create a "mirror image"
1286
1287              reflect the scanlines in the horizontal direction.
1288
1289       -font <name>
1290              use this font when annotating the image with text
1291
1292              You  can tag a font to specify whether it is a PostScript, True‐
1293              Type, or OPTION1 font.  For example,  Arial.ttf  is  a  TrueType
1294              font, ps:helvetica is PostScript, and x:fixed is OPTION1.
1295
1296       -foreground <color>
1297              define the foreground color
1298
1299              The  color  is  specified  using  the format described under the
1300              -fill option.
1301
1302       -format <type>
1303              the image format type
1304
1305              When used with the mogrify utility, this option will convert any
1306              image  to  the  image format you specify.  See GraphicsMagick(1)
1307              for a list of image format types supported by GraphicsMagick, or
1308              see the output of 'gm -list format'.
1309
1310              By  default  the file is written to its original name.  However,
1311              if the filename extension matches a supported format, the exten‐
1312              sion is replaced with the image format type specified with -for‐
1313              mat.  For example, if you specify tiff as the  format  type  and
1314              the input image filename is image.gif, the output image filename
1315              becomes image.tiff.
1316
1317       -format <string>
1318              output formatted image characteristics
1319
1320              When used with the identify utility, use this  option  to  print
1321              information  about  the image in a format of your choosing.  You
1322              can include the image filename, type, width, height, Exif  data,
1323              or  other  image  attributes by embedding special format charac‐
1324              ters:
1325
1326                   %b   file size
1327                   %c   comment
1328                   %d   directory
1329                   %e   filename extension
1330                   %f   filename
1331                   %h   height
1332                   %i   input filename
1333                   %k   number of unique colors
1334                   %l   label
1335                   %m   magick
1336                   %n   number of scenes
1337                   %o   output filename
1338                   %p   page number
1339                   %q   quantum depth
1340                   %s   scene number
1341                   %t   top of filename
1342                   %u   unique temporary filename
1343                   %w   width
1344                   %x   x resolution
1345                   %y   y resolution
1346                   %#   signature
1347                   \n   newline
1348                   \r   carriage return
1349
1350              For example,
1351
1352                   -format "%m:%f %wx%h"
1353
1354              displays MIFF:bird.miff 512x480 for an  image  titled  bird.miff
1355              and whose width is 512 and height is 480.
1356
1357              If the first character of string is @, the format is read from a
1358              file titled by the remaining characters in the string.
1359
1360              You can also use the  following  special  formatting  syntax  to
1361              print Exif information contained in the file:
1362
1363                   %[EXIF:<tag>]
1364
1365              Where "<tag>" can be one of the following:
1366
1367                   *  (print all Exif tags, in keyword=data format)
1368                   !  (print all Exif tags, in tag_number data format)
1369                   #hhhh (print data for Exif tag #hhhh)
1370                   ImageWidth
1371                   ImageLength
1372                   BitsPerSample
1373                   Compression
1374                   PhotometricInterpretation
1375                   FillOrder
1376                   DocumentName
1377                   ImageDescription
1378                   Make
1379                   Model
1380                   StripOffsets
1381                   Orientation
1382                   SamplesPerPixel
1383                   RowsPerStrip
1384                   StripByteCounts
1385                   XResolution
1386                   YResolution
1387                   PlanarConfiguration
1388                   ResolutionUnit
1389                   TransferFunction
1390                   Software
1391                   DateTime
1392                   Artist
1393                   WhitePoint
1394                   PrimaryChromaticities
1395                   TransferRange
1396                   JPEGProc
1397                   JPEGInterchangeFormat
1398                   JPEGInterchangeFormatLength
1399                   YCbCrCoefficients
1400                   YCbCrSubSampling
1401                   YCbCrPositioning
1402                   ReferenceBlackWhite
1403                   CFARepeatPatternDim
1404                   CFAPattern
1405                   BatteryLevel
1406                   Copyright
1407                   ExposureTime
1408                   FNumber
1409                   IPTC/NAA
1410                   ExifOffset
1411                   InterColorProfile
1412                   ExposureProgram
1413                   SpectralSensitivity
1414                   GPSInfo
1415                   ISOSpeedRatings
1416                   OECF
1417                   ExifVersion
1418                   DateTimeOriginal
1419                   DateTimeDigitized
1420                   ComponentsConfiguration
1421                   CompressedBitsPerPixel
1422                   ShutterSpeedValue
1423                   ApertureValue
1424                   BrightnessValue
1425                   ExposureBiasValue
1426                   MaxApertureValue
1427                   SubjectDistance
1428                   MeteringMode
1429                   LightSource
1430                   Flash
1431                   FocalLength
1432                   MakerNote
1433                   UserComment
1434                   SubSecTime
1435                   SubSecTimeOriginal
1436                   SubSecTimeDigitized
1437                   FlashPixVersion
1438                   ColorSpace
1439                   ExifImageWidth
1440                   ExifImageLength
1441                   InteroperabilityOffset
1442                   FlashEnergy
1443                   SpatialFrequencyResponse
1444                   FocalPlaneXResolution
1445                   FocalPlaneYResolution
1446                   FocalPlaneResolutionUnit
1447                   SubjectLocation
1448                   ExposureIndex
1449                   SensingMethod
1450                   FileSource
1451                   SceneType
1452
1453              Surround  the  format specification with quotation marks to pre‐
1454              vent your shell  from  misinterpreting  any  spaces  and  square
1455              brackets.
1456
1457       -frame <width>x<height>+<outer bevel width>+<inner bevel width>
1458              surround the image with an ornamental border
1459
1460              See -geometry for details about the geometry specification.  The
1461              -frame option is not affected by the -gravity option.
1462
1463              The color of the border is specified with the  -mattecolor  com‐
1464              mand line option.
1465
1466       -frame include the X window frame in the imported image
1467
1468       -fuzz <distance>{%}
1469              colors within this distance are considered equal
1470
1471              A number of algorithms search for a target color. By default the
1472              color must be exact. Use this option to match  colors  that  are
1473              close to the target color in RGB space. For example, if you want
1474              to automatically trim the edges of an image with -trim  but  the
1475              image  was scanned and the target background color may differ by
1476              a small amount. This option can account for these differences.
1477
1478              The distance can be in absolute intensity units or, by appending
1479              "%",  as  a  percentage  of the maximum possible intensity (255,
1480              65535, or 4294967295).
1481
1482       -gamma <value>
1483              level of gamma correction
1484
1485              The same color image displayed on two different workstations may
1486              look  different  due  to differences in the display monitor. Use
1487              gamma correction to adjust for this color difference. Reasonable
1488              values  extend  from 0.8 to 2.3. Gamma less than 1.0 darkens the
1489              image and gamma greater than 1.0 lightens it. Large  adjustments
1490              to  image gamma may result in the loss of some image information
1491              if the pixel quantum size is only eight bits (quantum range 0 to
1492              255).
1493
1494              You  can apply separate gamma values to the red, green, and blue
1495              channels of the image with a gamma  value  list  delimited  with
1496              slashes (e.g., 1.7/2.3/1.2).
1497
1498              Use  +gamma  value to set the image gamma level without actually
1499              adjusting the image pixels. This option is useful if  the  image
1500              is  of a known gamma but not set as an image attribute (e.g. PNG
1501              images).
1502
1503       -Gaussian <radius>{x<sigma>}
1504              blur the image with a Gaussian operator
1505
1506              Use the given radius and standard deviation (sigma).
1507
1508       -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@} {!}{<}{>}
1509              preferred size and location of the Image window.
1510
1511              By default, the window size is the image size and  the  location
1512              is chosen by you when it is mapped.
1513
1514              By  default,  the  width and height are maximum values. That is,
1515              the image is expanded or contracted to fit the width and  height
1516              value while maintaining the aspect ratio of the image. Append an
1517              exclamation point to the geometry to force  the  image  size  to
1518              exactly  the  size  you  specify.  For  example,  if you specify
1519              640x480! the image width is set to 640 pixels and height to 480.
1520
1521              If only the width is specified, the width assumes the value  and
1522              the  height is chosen to maintain the aspect ratio of the image.
1523              Similarly, if only the  height  is  specified  (e.g.,  -geometry
1524              x256), the width is chosen to maintain the aspect ratio.
1525
1526              To  specify  a percentage width or height instead, append %. The
1527              image size is multiplied by the width and height percentages  to
1528              obtain  the  final  image dimensions. To increase the size of an
1529              image, use a value greater than 100 (e.g. 125%). To decrease  an
1530              image's size, use a percentage less than 100.
1531
1532              Use @ to specify the maximum area in pixels of an image.
1533
1534              Use > to change the dimensions of the image only if its width or
1535              height exceeds the geometry specification. < resizes  the  image
1536              only if both of its dimensions are less than the geometry speci‐
1537              fication. For example, if you specify '640x480>' and  the  image
1538              size is 256x256, the image size does not change. However, if the
1539              image is  512x512  or  1024x1024,  it  is  resized  to  480x480.
1540              Enclose the geometry specification in quotation marks to prevent
1541              the < or > from being interpreted by your shell as a file  redi‐
1542              rection.
1543
1544              When  used  with animate and display, offsets are handled in the
1545              same manner as in X(1) and the -gravity option is not used.   If
1546              the  x  is  negative,  the  offset is measured leftward from the
1547              right edge of the screen to the right edge of  the  image  being
1548              displayed.  Similarly, negative y is measured between the bottom
1549              edges.  The offsets are not affected by  "%";  they  are  always
1550              measured in pixels.
1551
1552              When  used as a composite option, -geometry gives the dimensions
1553              of the image and its location  with  respect  to  the  composite
1554              image.   If the -gravity option is present with NorthEast, East,
1555              or SouthEast gravity, the x represents  the  distance  from  the
1556              right  edge  of  the  image  to  the right edge of the composite
1557              image.  Similarly, if the -gravity option is present with South‐
1558              West,  South,  or  SouthEast  gravity, y is measured between the
1559              bottom edges. Accordingly, a positive offset will never point in
1560              the  direction  outside  of  the  image.   The  offsets  are not
1561              affected by "%"; they are always measured in pixels.  To specify
1562              the dimensions of the composite image, use the -resize option.
1563
1564              When  used  as a convert, import or mogrify option, -geometry is
1565              synonymous with -resize and specifies the  size  of  the  output
1566              image.  The offsets, if present, are ignored.
1567
1568              When  used  as  a  montage option, -geometry specifies the image
1569              size and border size for  each  tile;  default  is  256x256+0+0.
1570              Negative  offsets  (border  dimensions)  are  meaningless.   The
1571              -gravity option affects the placement of the  image  within  the
1572              tile;  the  default  gravity for this purpose is Center.  If the
1573              "%" sign appears in the geometry specification, the tile size is
1574              the specified percentage of the original dimensions of the first
1575              tile.  To specify the dimensions of the montage, use the -resize
1576              option.
1577
1578       -gravity <type>
1579              direction primitive  gravitates to when annotating the image.
1580
1581              Choices  are:  NorthWest,  North, NorthEast, West, Center, East,
1582              SouthWest, South, SouthEast.
1583
1584              The direction you choose specifies where to  position  the  text
1585              when annotating the image. For example Center gravity forces the
1586              text to be centered within the  image.  By  default,  the  image
1587              gravity  is NorthWest.  See -draw for more details about graphic
1588              primitives.  Only the text primitive is affected by the -gravity
1589              option.
1590
1591              The  -gravity  option is also used in concert with the -geometry
1592              option and other options that take <geometry>  as  a  parameter,
1593              such  as the -crop option.  See -geometry for details of how the
1594              -gravity option interacts with the <x> and <y> parameters  of  a
1595              geometry specification.
1596
1597              When  used  as an option to composite, -gravity gives the direc‐
1598              tion that the image gravitates within the composite.
1599
1600              When used as an option to montage, -gravity gives the  direction
1601              that  an image gravitates within a tile.  The default gravity is
1602              Center for this purpose.
1603
1604       -green-primary <x>,<y>
1605              green chromaticity primary point
1606
1607       -help  print usage instructions
1608
1609       -iconGeometry <geometry>
1610              specify the icon geometry
1611
1612              Offsets, if present in the geometry specification,  are  handled
1613              in  the  same manner as the -geometry option, using X11 style to
1614              handle negative offsets.
1615
1616       -iconic
1617              iconic animation
1618
1619       -immutable
1620              make image immutable
1621
1622       -implode <factor>
1623              implode image pixels about the center
1624
1625       -intent <type>
1626              use this type of rendering intent when managing the image color
1627
1628              Use this option to affect the the color management operation  of
1629              an  image  (see -profile).  Choose from these intents: Absolute,
1630              Perceptual, Relative, Saturation.
1631
1632              The default intent is undefined.
1633
1634       -interlace <type>
1635              the type of interlacing scheme
1636
1637              Choices are: None, Line, Plane, or  Partition.  The  default  is
1638              None.
1639
1640              This  option  is  used to specify the type of interlacing scheme
1641              for raw image formats such as RGB or YUV.   None  means  do  not
1642              interlace (RGBRGBRGBRGBRGBRGB...),
1643
1644              Line             uses            scanline            interlacing
1645              (RRR...GGG...BBB...RRR...GGG...BBB...),  and  Plane  uses  plane
1646              interlacing (RRRRRR...GGGGGG...BBBBBB...).
1647
1648              Partition is like plane except the different planes are saved to
1649              individual files (e.g. image.R, image.G, and image.B).
1650
1651              Use Line or Plane to create an interlaced PNG or   GIF  or  pro‐
1652              gressive JPEG image.
1653
1654       -label <name>
1655              assign a label to an image
1656
1657              Use  this  option  to assign a specific label to the image, when
1658              writing to an image format that supports labels, such  as  TIFF,
1659              PNG,  MIFF,  or  PostScript. You can include the the image file‐
1660              name, type, width, height, or other image attribute by embedding
1661              special  format  character.   A label is not drawn on the image,
1662              but is embedded in the image datastream via  a  "Label"  tag  or
1663              similar  mechanism.   If you want the label to be visible on the
1664              image itself, use the -draw option.  See -comment for details.
1665
1666              For example,
1667
1668                   -label "%m:%f %wx%h"
1669
1670              produces an image label of MIFF:bird.miff 512x480 for  an  image
1671              titled bird.miff and whose width is 512 and height is 480.
1672
1673              If  the  first character of string is @, the image label is read
1674              from a file titled by the remaining characters in the string.
1675
1676              When converting to PostScript, use  this  option  to  specify  a
1677              header  string  to print above the image. Specify the label font
1678              with -font.
1679
1680              When creating a montage, by default the label associated with an
1681              image  is  displayed with the corresponding tile in the montage.
1682              Use the +label option to suppress this behavior.
1683
1684       -lat <width>x<height>{+-}<offset>{%}
1685              perform local adaptive thresholding
1686
1687              Perform local adaptive thresholding using the  specified  width,
1688              height,  and  offset.   The offset is a distance in sample space
1689              from the mean, as an absolute integer ranging from 0 to the max‐
1690              imum sample value or as a percentage.
1691
1692       -level <black_point>{,<gamma>}{,<white_point>}{%}
1693              adjust the level of image contrast
1694
1695              Give  one,  two  or  three  values delimited with commas: black-
1696              point, gamma, white-point (e.g. 10,1.0,250 or  2%,0.5,98%).  The
1697              black and white points range from 0 to MaxRGB or from 0 to 100%;
1698              if the white point is omitted it is set  to  MaxRGB-black_point.
1699              If  a  "%" sign is present anywhere in the string, the black and
1700              white points are percentages of MaxRGB.  Gamma  is  an  exponent
1701              that  ranges  from  0.1 to 10.; if it is omitted, the default of
1702              1.0 (no gamma correction) is assumed. This interface works simi‐
1703              lar  to Photoshop's "Image->Adjustments->Levels..."  "Input Lev‐
1704              els" interface.
1705
1706       -limit <type> <value>
1707              Disk, File, Map, or Memory resource limit
1708
1709              The value for File is in number of files and the values for  the
1710              other resources are in Megabytes.  By default the limits are 256
1711              files, 1024MB memory, 4096MB map, and unlimited disk, but  these
1712              are  adjusted  at  startup  time  on  platforms that can provide
1713              information  about  available  resources.   When  the  limit  is
1714              reached,  GraphicsMagick will fail in some fashion, or take com‐
1715              pensating actions if possible.  For example,  -limit  memory  32
1716              -limit  map  64  limits  memory When the pixel cache reaches the
1717              memory limit it uses memory mapping.  When that limit is reached
1718              it  goes  to  disk.   If disk has a hard limit, the program will
1719              fail.
1720
1721              Resource limits may also be set using environment variables. The
1722              environment   variables  MAGICK_LIMIT_DISK,  MAGICK_LIMIT_FILES,
1723              MAGICK_LIMIT_MEMORY, and MAGICK_LIMIT_MAP, may be  used  to  set
1724              the  limits  for disk space, open files, heap memory, and memory
1725              map size, respectively.
1726
1727              You can use the option -list resource to find out the limits.
1728
1729       -linewidth
1730              the line width for subsequent draw operations
1731
1732       -list <type>
1733              the type of list
1734
1735              Choices are: Color, Delegate, Format, Magic,  Module,  Resource,
1736              or  Type.  The Module option is only available if GraphicsMagick
1737              was built to support loadable modules.
1738
1739              This option lists information about the GraphicsMagick  configu‐
1740              ration.
1741
1742       -log <string>
1743              Specify format for debug log
1744
1745              This  option  specifies  the format for the log printed when the
1746              -debug option is active.
1747
1748              You can display the following components  by  embedding  special
1749              format characters:
1750
1751                   %d   domain
1752                   %e   event
1753                   %f   function
1754                   %l   line
1755                   %m   module
1756                   %p   process ID
1757                   %r   real CPU time
1758                   %t   wall clock time
1759                   %u   user CPU time
1760                   %%   percent sign
1761                   \n   newline
1762                   \r   carriage return
1763
1764              For example:
1765
1766                  gm convert -debug coders -log "%u %m:%l %e" in.gif out.png
1767
1768              The default behavior is to print all of the components.
1769
1770       -loop <iterations>
1771              add Netscape loop extension to your GIF animation
1772
1773              A value other than zero forces the animation to repeat itself up
1774              to iterations times.
1775
1776       -magnify <factor>
1777              magnify the image
1778
1779       -map <filename>
1780              choose a particular set of colors from this image
1781
1782              [convert or mogrify]
1783
1784              By default, color reduction chooses an  optimal  set  of  colors
1785              that  best  represent the original image. Alternatively, you can
1786              choose a particular set of colors from an image file  with  this
1787              option.
1788
1789              Use +map to reduce all images in the image sequence that follows
1790              to a single optimal set of colors that best  represent  all  the
1791              images.   The sequence of images is terminated by the appearance
1792              of any option.  If the +map option  appears  after  all  of  the
1793              input images, all images are mapped.
1794
1795       -map <type>
1796              display image using this type.
1797
1798              [animate or display]
1799
1800              Choose from these Standard Colormap types:
1801
1802                   best
1803                   default
1804                   gray
1805                   red
1806                   green
1807                   blue
1808
1809              The X server must support the Standard Colormap you choose, oth‐
1810              erwise an error  occurs.  Use  list  as  the  type  and  display
1811              searches the list of colormap types in top-to-bottom order until
1812              one is located. See xstdcmap(1) for one way of creating Standard
1813              Colormaps.
1814
1815       -mask <filename>
1816              Specify a clipping mask
1817
1818              The  image  read  from  the file is used as a clipping mask.  It
1819              must have the same dimensions as the image being masked.
1820
1821              If the mask image contains an opacity channel,  the  opacity  of
1822              each pixel is used to define the mask.  Otherwise, the intensity
1823              (gray level) of each pixel is used.
1824
1825              Use +mask to remove the clipping mask.
1826
1827              It is not necessary to use -clip to activate the mask; -clip  is
1828              implied by -mask.
1829
1830       -matte store matte channel if the image has one
1831
1832              If  the  image  does  not have a matte channel, create an opaque
1833              one.
1834
1835              Use +matte to ignore the matte channel and to  avoid  writing  a
1836              matte channel in the output file.
1837
1838       -mattecolor <color>
1839              specify the color to be used with the -frame option
1840
1841              The  color  is  specified  using  the format described under the
1842              -fill option.
1843
1844       -median <radius>
1845              apply a median filter to the image
1846
1847       -mode <value>
1848              mode of operation
1849
1850       -modulate brightness[,saturation[,hue]]
1851              vary the brightness, saturation, and hue of an image
1852
1853              Specify the percent change in brightness, color saturation,  and
1854              hue  separated  by  commas. Default argument values are 100 per‐
1855              cent, resulting in no change. For example, to increase the color
1856              brightness  by  20% and decrease the color saturation by 10% and
1857              leave the hue unchanged, use: -modulate 120,90.
1858
1859              Hue is the percentage of  absolute  rotation  from  the  current
1860              position. For example 50 results in a counter-clockwise rotation
1861              of 90 degrees,  150  results  in  a  clockwise  rotation  of  90
1862              degrees,  with  0  and  200  both resulting in a rotation of 180
1863              degrees.
1864
1865       -monochrome
1866              transform the image to black and white
1867
1868       -morph <frames>
1869              morphs an image sequence
1870
1871              Both the image pixels and size are linearly interpolated to give
1872              the appearance of a meta-morphosis from one image to the next.
1873
1874              The  sequence  of  images is terminated by the appearance of any
1875              option.  If the -morph option appears after  all  of  the  input
1876              images, all images are morphed.
1877
1878       -mosaic
1879              create a mosaic from an image or an image sequence
1880
1881              The  -page option can be used to establish the dimensions of the
1882              mosaic and to locate the images within the mosaic.
1883
1884              The sequence of images is terminated by the  appearance  of  any
1885              option.   If  the  -mosaic option appears after all of the input
1886              images, all images are included in the mosaic.
1887
1888       -name  name an image
1889
1890       -negate
1891              replace every pixel with its complementary color
1892
1893              The red, green, and blue intensities of an  image  are  negated.
1894              White  becomes  black, yellow becomes blue, etc.  Use +negate to
1895              only negate the grayscale pixels of the image.
1896
1897       -noise <radius|type>
1898              add or reduce noise in an image
1899
1900              The principal function of noise peak elimination  filter  is  to
1901              smooth  the objects within an image without losing edge informa‐
1902              tion and without creating undesired structures. The central idea
1903              of the algorithm is to replace a pixel with its next neighbor in
1904              value within a pixel window, if this pixel has been found to  be
1905              noise.  A pixel is defined as noise if and only if this pixel is
1906              a maximum or minimum within the pixel window.
1907
1908              Use radius to specify the width of the neighborhood.
1909
1910              Use +noise followed by a noise type to add noise  to  an  image.
1911              Choose from these noise types:
1912
1913                   Uniform
1914                   Gaussian
1915                   Multiplicative
1916                   Impulse
1917                   Laplacian
1918                   Poisson
1919
1920       -noop  NOOP (no option)
1921
1922              The  -noop option can be used to terminate a group of images and
1923              reset all options to their default values, when no other  option
1924              is desired.
1925
1926       -normalize
1927              transform image to span the full range of color values
1928
1929              This is a contrast enhancement technique.
1930
1931       -opaque <color>
1932              change this color to the pen color within the image
1933
1934              The  color  is  specified  using  the format described under the
1935              -fill option.
1936
1937              See -fill for more details.
1938
1939       -operator channel operator rvalue[%]
1940              apply a mathematical or bitwise operator to an image channel
1941
1942              Apply a low-level mathematical or bitwise operator to a selected
1943              image  channel or all image channels. Operations which result in
1944              negative results are reset to zero, and operations  which  over‐
1945              flow  the  available  range  are  reset  to the maximum possible
1946              value.
1947
1948
1949              Select a channel from: Red, Green, Blue, Opacity,  Matte,  Cyan,
1950              Magenta, Yellow, Black, or All.
1951
1952              Select  an operator from Add, And, Divide, LShift, Multiply, Or,
1953              RShift, Subtract, Xor.
1954
1955              Rvalue may be any floating point value in  the  range  of  0  to
1956              MaxRGB,  where  MaxRGB is the largest quantum value supported by
1957              the GraphicsMagick build (255, 65535, or 4294967295). If a  per‐
1958              cent  (%)  symbol is appended to the argument, then the argument
1959              has a range of 0 to 100 percent.
1960
1961       -ordered-dither <channeltype> <NxN>
1962              ordered dither the image
1963
1964              The channel or channels specified in  the  channeltype  argument
1965              are  reduced  to  binary,  using  an ordered dither method.  The
1966              choices for channeltype are:
1967
1968                  all
1969                  intensity
1970                  opacity
1971                  matte
1972
1973              When channeltype is "all", the color samples are dithered into a
1974              graylevel  and  then that graylevel is stored in the three color
1975              channels.  Separately, the opacity channel is  dithered  into  a
1976              bilevel opacity value which is stored in the opacity channel.
1977
1978              When  channeltype  is  "intensity",  only  the color samples are
1979              dithered.  When channeltype is "opacity" or  "matte",  only  the
1980              opacity channel is dithered.
1981
1982              The  choices  for  N  are  2, 3, or 4. When N is 2, the image is
1983              divided into 2x2 pixel tiles.  In each tile, 0, 1, 2,  3,  or  4
1984              pixels are turned to white depending on their intensity.  When N
1985              is 3, there are 3x3 tiles and 10 levels of gray  can  be  repre‐
1986              sented.  When N is 4, there are 4x4 tiles and 17 levels of gray.
1987
1988       -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
1989              size and location of an image canvas
1990
1991              Use this option to specify the dimensions of the PostScript page
1992              in dots per inch or a TEXT page in pixels.  The  choices  for  a
1993              PostScript page are:
1994
1995                   11x17         792  1224
1996                   Ledger       1224   792
1997                   Legal         612  1008
1998                   Letter        612   792
1999                   LetterSmall   612   792
2000                   ArchE        2592  3456
2001                   ArchD        1728  2592
2002                   ArchC        1296  1728
2003                   ArchB         864  1296
2004                   ArchA         648   864
2005                   A0           2380  3368
2006                   A1           1684  2380
2007                   A2           1190  1684
2008                   A3            842  1190
2009                   A4            595   842
2010                   A4Small       595   842
2011                   A5            421   595
2012                   A6            297   421
2013                   A7            210   297
2014                   A8            148   210
2015                   A9            105   148
2016                   A10            74   105
2017                   B0           2836  4008
2018                   B1           2004  2836
2019                   B2           1418  2004
2020                   B3           1002  1418
2021                   B4            709  1002
2022                   B5            501   709
2023                   C0           2600  3677
2024                   C1           1837  2600
2025                   C2           1298  1837
2026                   C3            918  1298
2027                   C4            649   918
2028                   C5            459   649
2029                   C6            323   459
2030                   Flsa          612   936
2031                   Flse          612   936
2032                   HalfLetter    396   612
2033
2034              For convenience you can specify the page size by media (e.g. A4,
2035              Ledger, etc.). Otherwise,  -page  behaves  much  like  -geometry
2036              (e.g.  -page letter+43+43>).
2037
2038              This  option  is  also used to place subimages when writing to a
2039              multi-image format that supports offsets, such as GIF89 and MNG.
2040              When used for this purpose the offsets are always  measured from
2041              the top left corner of the canvas and are not  affected  by  the
2042              -gravity   option.    To  position  a  GIF  or  MNG  image,  use
2043              -page{+-}<x>{+-}<y> (e.g. -page +100+200).  When  writing  to  a
2044              MNG  file,  a -page option appearing ahead of the first image in
2045              the sequence with nonzero width and height defines the width and
2046              height  values  that  are written in the MHDR chunk.  Otherwise,
2047              the MNG width and height are computed from the bounding box that
2048              contains all images in the sequence.  When writing a GIF89 file,
2049              only the bounding box method is used  to  determine  its  dimen‐
2050              sions.
2051
2052              For  a  PostScript  page, the image is sized as in -geometry and
2053              positioned relative to the lower left hand corner of the page by
2054              {+-}<xoffset>{+-}<y offset>. Use -page 612x792>, for example, to
2055              center the image within the page. If the image size exceeds  the
2056              PostScript  page,  it  is  reduced to fit the page.  The default
2057              gravity for the -page option is NorthWest, i.e., positive x  and
2058              y  offset  are measured rightward and downward from the top left
2059              corner of the page, unless the -gravity option is present with a
2060              value other than NorthWest.
2061
2062              The default page dimensions for a TEXT image is 612x792.
2063
2064              This option is used in concert with -density.
2065
2066              Use +page to remove the page settings for an image.
2067
2068       -paint <radius>
2069              simulate an oil painting
2070
2071              Each  pixel is replaced by the most frequent color in a circular
2072              neighborhood whose width is specified with radius.
2073
2074       -pause <seconds>
2075              pause between animation loops [animate]
2076
2077              Pause for the specified number of seconds before  repeating  the
2078              animation.
2079
2080       -pause <seconds>
2081              pause between snapshots [import]
2082
2083              Pause for the specified number of seconds before taking the next
2084              snapshot.
2085
2086       -pen <color>
2087              (This option has been replaced by the -fill option)
2088
2089       -ping  efficiently determine image characteristics
2090
2091       -pointsize <value>
2092              pointsize of the PostScript, OPTION1, or TrueType font
2093
2094       -preview <type>
2095              image preview type
2096
2097              Use this option to affect the  preview  operation  of  an  image
2098              (e.g.    convert  file.png  -preview  Gamma  Preview:gamma.png).
2099              Choose from these previews:
2100
2101                   Rotate
2102                   Shear
2103                   Roll
2104                   Hue
2105                   Saturation
2106                   Brightness
2107                   Gamma
2108                   Spiff
2109                   Dull
2110                   Grayscale
2111                   Quantize
2112                   Despeckle
2113                   ReduceNoise
2114                   Add Noise
2115                   Sharpen
2116                   Blur
2117                   Threshold
2118                   EdgeDetect
2119                   Spread
2120                   Shade
2121                   Raise
2122                   Segment
2123                   Solarize
2124                   Swirl
2125                   Implode
2126                   Wave
2127                   OilPaint
2128                   CharcoalDrawing
2129                   JPEG
2130
2131              The default preview is JPEG.
2132
2133       -process <command>
2134              process a sequence of images using a process module
2135
2136              The command argument has the form module=arg1,arg2,arg3,...,argN
2137              where  module  is  the  name of the module to invoke (e.g. "ana‐
2138              lyze") and arg1,arg2,arg3,...,argN are an  arbitrary  number  of
2139              arguments to pass to the process module.  The sequence of images
2140              is terminated by the appearance of any option.
2141
2142              If the -process option appears after all of  the  input  images,
2143              all images are processed.
2144
2145       -profile <filename>
2146              add ICM, IPTC, or generic profile  to image
2147
2148              -profile  filename  adds  an  ICM  (ICC  color management), IPTC
2149              (newswire information), or a generic profile to the image.
2150
2151              Use +profile icm, +profile iptc,  or  +profile  profile_name  to
2152              remove  the  respective  profile.  Use identify -verbose to find
2153              out what profiles are in the image file.  Use  +profile  "*"  to
2154              remove all profiles.
2155
2156              To extract a profile, the -profile option is not used.  Instead,
2157              simply write the file to an image format  such  as  APP1,  8BIM,
2158              ICM, or IPTC.
2159
2160              For  example,  to extract the Exif data (which is stored in JPEG
2161              files in the APP1 profile), use
2162
2163
2164                  gm convert cockatoo.jpg exifdata.app1
2165
2166       +progress
2167              disable progress monitor and busy cursor
2168
2169              By default, when an image is displayed, a progress  monitor  bar
2170              is  shown  in  the  top left corner of an existing image display
2171              window, and the current cursor is  replaced  with  an  hourglass
2172              cursor.  Use  +progress to disable the progress monitor and busy
2173              cursor during display operations.  While the progress monitor is
2174              disabled  for  all  operations,  the busy cursor continues to be
2175              enabled for non-display operations  such  as  image  processing.
2176              This option is useful for non-interactive display operations, or
2177              when a "clean" look is desired.
2178
2179       -quality <value>
2180              JPEG/MIFF/PNG compression level
2181               For the JPEG and MPEG image formats, quality is 0 (lowest image
2182              quality  and highest compression) to 100 (best quality but least
2183              effective compression). The default  quality  is  75.   Use  the
2184              -sampling-factor  option to specify the factors for chroma down‐
2185              sampling.  To use the same quality value as that  found  by  the
2186              JPEG decoder, use the -define jpeg:preserve-settings flag.
2187
2188              For  the  MIFF  image format, quality/10 is the zlib compression
2189              level, which is 0 (worst but fastest compression) to 9 (best but
2190              slowest).   It  has no effect on the image appearance, since the
2191              compression is always lossless.
2192
2193              For the JPEG-2000 image format, quality is mapped using  a  non-
2194              linear  equation to the compression ratio required by the Jasper
2195              library. This non-linear equation is intended to loosely approx‐
2196              imate  the  quality  provided by the JPEG v1 format. The default
2197              quality value 75 results in a request for 16:1 compression.  The
2198              quality  value  100  results in a request for non-lossy compres‐
2199              sion.
2200
2201              For the MNG and PNG image formats, the quality  value  sets  the
2202              zlib compression level (quality / 10) and filter-type (quality %
2203              10). Compression levels range from 0  (fastest  compression)  to
2204              100  (best  but  slowest). For compression level 0, the Huffman-
2205              only strategy is used, which is fastest but not necessarily  the
2206              worst compression.
2207
2208              If  filter-type  is 4 or less, the specified filter-type is used
2209              for all scanlines:
2210
2211                   0: none
2212                   1: sub
2213                   2: up
2214                   3: average
2215                   4: Paeth
2216
2217              If filter-type is 5, adaptive filtering is used when quality  is
2218              greater  than 50 and the image does not have a color map, other‐
2219              wise no filtering is used.
2220
2221              If filter-type is 6,  adaptive  filtering  with  minimum-sum-of-
2222              absolute-values is used.
2223
2224              Only  if  the output is MNG, if filter-type is 7, the LOCO color
2225              transformation and adaptive filtering with  minimum-sum-of-abso‐
2226              lute-values are used.
2227
2228              The  default  is quality is 75, which means nearly the best com‐
2229              pression with adaptive filtering.  The quality  setting  has  no
2230              effect  on  the appearance of PNG and MNG images, since the com‐
2231              pression is always lossless.
2232
2233              For further information, see the PNG specification.
2234
2235              When writing a JNG image with transparency, two  quality  values
2236              are  required,  one for the main image and one for the grayscale
2237              image that conveys the opacity channel.  These are written as  a
2238              single  integer  equal to the main image quality plus 1000 times
2239              the opacity quality.  For example, if you want to use quality 75
2240              for  the main image and quality 90 to compress the opacity data,
2241              use -quality 90075.
2242
2243       -raise <width>x<height>
2244              lighten or darken image edges
2245
2246              This will create a 3-D effect. See -geometry for details details
2247              about the geometry specification. Offsets are not used.
2248
2249              Use -raise to create a raised effect, otherwise use +raise.
2250
2251       -random-threshold <channeltype> <LOWxHIGH>
2252              random threshold the image
2253
2254              The  channel or channels specified in the <channeltype> argument
2255              are reduced to binary, using an  random-threshold  method.   The
2256              choices for channeltype are:
2257
2258                  all
2259                  intensity
2260                  opacity
2261                  matte
2262
2263              When  channeltype  is  "all",  the color samples are thresholded
2264              into a graylevel and then that graylevel is stored in the  three
2265              color  channels.  Separately, the opacity channel is thresholded
2266              into a bilevel opacity value which  is  stored  in  the  opacity
2267              channel.   For each pixel, a new random number is used to estab‐
2268              lish the threshold to be used.  The threshold never exceeds  the
2269              specified  maximum  (HIGH)  and is never less than the specified
2270              minimum (LOW).
2271
2272              When channeltype is "intensity",  only  the  color  samples  are
2273              thresholded.  When channeltype is "opacity" or "matte", only the
2274              opacity channel is thresholded.
2275
2276       -red-primary <x>,<y>
2277              red chromaticity primary point
2278
2279       -region <width>x<height>{+-}<x>{+-}<y>
2280              apply options to a portion of the image
2281
2282              The x and y offsets are treated in the same manner as in -crop.
2283
2284       -remote
2285              perform a X11 remote operation
2286
2287              The -remote command sends a command to a  "gm  display"  or  "gm
2288              animate"  which  is already running. The only command recognized
2289              at this time is the name of an image file to load. This capabil‐
2290              ity is very useful to load new images without needing to restart
2291              GraphicsMagick (e.g. for a slide-show or to  use  GraphicsMagick
2292              as  the  display  engine  for  a  different  GUI).  Also see the
2293              +progress option for a way to disable progress indication for  a
2294              clean look while loading new images.
2295
2296       -render
2297              render vector operations
2298
2299              Use  +render  to  turn  off rendering vector operations. This is
2300              useful when saving the result to vector formats such as  MVG  or
2301              SVG.
2302
2303       -resample <horizontal>x<vertical>
2304              Resample image to specified horizontal and vertical resolution
2305
2306              Resize  the  image so that its rendered size remains the same as
2307              the original at the specified target resolution. Either the cur‐
2308              rent  image  resolution  units or the previously set with -units
2309              are used to interpret the argument. For example, if  a  300  DPI
2310              image  renders at 3 inches by 2 inches on a 300 DPI device, when
2311              the image has been resampled to 72 DPI,  it  will  render  at  3
2312              inches  by  2 inches on a 72 DPI device.  Note that only a small
2313              number of image formats (e.g. JPEG, PNG, and TIFF)  are  capable
2314              of  storing  the image resolution. For formats which do not sup‐
2315              port an image resolution, the original resolution of  the  image
2316              must  be  specified  via  -density  on the command line prior to
2317              specifying the resample resolution.
2318
2319              Note that Photoshop stores and obtains image resolution  from  a
2320              proprietary  embedded  profile.  If  this  profile exists in the
2321              image, then Photoshop will continue to treat the image using its
2322              former  resolution,  ignoring  the image resolution specified in
2323              the standard file header.
2324
2325              Some image formats (e.g. PNG) require use of metric  or  english
2326              units  so even if the original image used a particular unit sys‐
2327              tem, if it is saved to a different format prior  to  resampling,
2328              then it may be necessary to specify the desired resolution units
2329              using -units since the original units may  have  been  lost.  In
2330              other  words,  do  not  assume  that  the  resolution  units are
2331              restored if the image has been saved to a file.
2332
2333       -resize <width>x<height>{%}{@}{!}{<}{>}
2334              resize an image
2335
2336              This is an alias for the -geometry option and it behaves in  the
2337              same  manner. If the -filter option precedes the -resize option,
2338              the specified filter is used.
2339
2340              There are some exceptions:
2341
2342              When used as a composite option, -resize conveys  the  preferred
2343              size  of  the output image, while -geometry conveys the size and
2344              placement of the composite image within the main image.
2345
2346              When used as a montage option,  -resize  conveys  the  preferred
2347              size  of  the montage, while -geometry conveys information about
2348              the tiles.
2349
2350       -roll {+-}<x>{+-}<y>
2351              roll an image vertically or horizontally
2352
2353              See -geometry for details the geometry specification.  The x and
2354              y offsets are not affected by the -gravity option.
2355
2356              A  negative x offset rolls the image left-to-right. A negative y
2357              offset rolls the image top-to-bottom.
2358
2359       -rotate <degrees>{<}{>}
2360              apply Paeth image rotation to the image
2361
2362              Use > to rotate the image only if its width exceeds the  height.
2363              <  rotates  the image only if its width is less than the height.
2364              For example, if you specify -rotate "-90>" and the image size is
2365              480x640,  the  image  is  not rotated.  However, if the image is
2366              640x480, it is rotated by -90 degrees.   If  you  use  >  or  <,
2367              enclose it in quotation marks to prevent it from being misinter‐
2368              preted as a file redirection.
2369
2370              Empty triangles left over from rotating  the  image  are  filled
2371              with  the  color  defined as background (class backgroundColor).
2372              The color is specified using  the  format  described  under  the
2373              -fill option.
2374
2375       -sample <geometry>
2376              scale image using pixel sampling
2377
2378              See  -geometry  for  details  about  the geometry specification.
2379              -sample ignores the -filter selection if the -filter  option  is
2380              present.   Offsets,  if  present  in  the  geometry  string, are
2381              ignored, and the -gravity option has no effect.
2382
2383       -sampling-factor <horizontal_factor>x<vertical_factor>
2384              sampling  factors  used  by  JPEG  or  MPEG-2  encoder  and  YUV
2385              decoder/encoder.
2386
2387              This  option  specifies  the  sampling factors to be used by the
2388              JPEG encoder for chroma downsampling.  If this option  is  omit‐
2389              ted,  the  JPEG  library  will use its own default values.  When
2390              reading or writing the YUV  format  and  when  writing  the  M2V
2391              (MPEG-2)  format,  use -sampling-factor 2x1 to specify the 4:2:2
2392              downsampling method.
2393
2394              To use the same sampling factors as  those  found  by  the  JPEG
2395              decoder, use the -define jpeg:preserve-settings flag.
2396
2397       -scale <geometry>
2398              scale the image.
2399
2400              See  -geometry  for  details  about  the geometry specification.
2401              -scale uses a simpler, faster  algorithm,  and  it  ignores  the
2402              -filter selection if the -filter option is present.  Offsets, if
2403              present in the geometry string, are ignored,  and  the  -gravity
2404              option has no effect.
2405
2406       -scene <value>
2407              set scene number
2408
2409              This option sets the scene number of an image or the first image
2410              in an image sequence.
2411
2412       -scenes <value-value>
2413              range of image scene numbers to read
2414
2415              Each image in the range is read with the filename followed by  a
2416              period  (.)  and  the decimal scene number.  You can change this
2417              behavior by embedding a %d, %0Nd, %o, %0No, %x, or  %0Nx  printf
2418              format specification in the file name. For example,
2419
2420                  gm montage -scenes 5-7 image.miff
2421
2422              makes   a  montage  of  files  image.miff.5,  image.miff.6,  and
2423              image.miff.7, and
2424
2425                  gm animate -scenes 0-12 image%02d.miff
2426
2427              animates files image00.miff, image01.miff, through image12.miff.
2428
2429       -screen
2430              specify the screen to capture
2431
2432              This option indicates that the GetImage request used  to  obtain
2433              the  image  should  be  done  on  the  root  window, rather than
2434              directly on the specified window.  In this way, you  can  obtain
2435              pieces  of  other windows that overlap the specified window, and
2436              more importantly, you can capture menus or other popups that are
2437              independent windows but appear over the specified window.
2438
2439       -segment <cluster threshold>x<smoothing threshold>
2440              segment an image
2441
2442              Segment an image by analyzing the histograms of the color compo‐
2443              nents and identifying units that are homogeneous with the  fuzzy
2444              c-means technique.
2445
2446              Specify  cluster threshold as the number of pixels in each clus‐
2447              ter must exceed the  the  cluster  threshold  to  be  considered
2448              valid. Smoothing threshold eliminates noise in the second deriv‐
2449              ative of the histogram.  As the  value  is  increased,  you  can
2450              expect  a  smoother  second derivative.  The default is 1.5. See
2451              "Image Segmentation", below, for details.
2452
2453       -shade <azimuth>x<elevation>
2454              shade the image using a distant light source
2455
2456              Specify azimuth and elevation  as  the  position  of  the  light
2457              source.  Use +shade to return the shading results as a grayscale
2458              image.
2459
2460       -shadow <radius>{x<sigma>}
2461              shadow the montage
2462
2463       -shared-memory
2464              use shared memory
2465
2466              This option specifies whether the utility should attempt to  use
2467              shared memory for pixmaps.  GraphicsMagick must be compiled with
2468              shared memory support, and the display must support the  MIT-SHM
2469              extension.   Otherwise,  this option is ignored.  The default is
2470              True.
2471
2472       -sharpen <radius>{x<sigma>}
2473              sharpen the image
2474
2475              Use a Gaussian operator of the given radius and standard  devia‐
2476              tion (sigma).
2477
2478       -shave <width>x<height>{%}
2479              shave pixels from the image edges
2480
2481              Specify the width of the region to be removed from both sides of
2482              the image and the height of the regions to be removed  from  top
2483              and bottom.
2484
2485       -shear <x degrees>x<y degrees>
2486              shear the image along the X or Y axis
2487
2488              Use the specified positive or negative shear angle.
2489
2490              Shearing slides one edge of an image along the X or Y axis, cre‐
2491              ating a parallelogram. An X direction shear slides an edge along
2492              the X axis, while a Y direction shear slides an edge along the Y
2493              axis. The amount of the shear is controlled by  a  shear  angle.
2494              For  X direction shears, x degrees is measured relative to the Y
2495              axis, and similarly, for Y direction shears y  degrees  is  mea‐
2496              sured relative to the X axis.
2497
2498              Empty  triangles  left  over  from shearing the image are filled
2499              with the color defined as  background  (class  backgroundColor).
2500              The  color  is  specified  using  the format described under the
2501              -fill option.
2502
2503       -silent
2504              operate silently
2505
2506       -size <width>x<height>{+offset}
2507              width and height of the image
2508
2509              Use this option to specify the width and height  of  raw  images
2510              whose  dimensions  are  unknown  such  as GRAY, RGB, or CMYK. In
2511              addition to width and height, use -size with an offset  to  skip
2512              any header information in the image or tell the number of colors
2513              in a MAP image file, (e.g. -size 640x512+256).
2514
2515              For Photo CD images, choose from these sizes:
2516
2517                   192x128
2518                   384x256
2519                   768x512
2520                   1536x1024
2521                   3072x2048
2522
2523              Finally, use this option to choose a particular resolution layer
2524              of a JBIG or JPEG image (e.g. -size 1024x768).
2525
2526       -snaps <value>
2527              number of screen snapshots
2528
2529              Use  this  option  to grab more than one image from the X server
2530              screen, to create an animation sequence.
2531
2532       -solarize <factor>
2533              negate all pixels above the threshold level
2534
2535              Specify factor as the percent threshold of the  intensity  (0  -
2536              99.9%).
2537
2538              This  option produces a solarization effect seen when exposing a
2539              photographic film to light during the development process.
2540
2541       -spread <amount>
2542              displace image pixels by a random amount
2543
2544              Amount defines the size of the neighborhood around each pixel to
2545              choose a candidate pixel to swap.
2546
2547       -stegano <offset>
2548              hide watermark within an image
2549
2550              Use  an  offset  to start the image hiding some number of pixels
2551              from the beginning of the image.  Note this offset and the image
2552              size.   You  will  need this information to recover the stegano‐
2553              graphic image (e.g. display -size 320x256+35 stegano:image.png).
2554
2555       -stereo
2556              composite two images to create a stereo anaglyph
2557
2558              The left side of the stereo pair is saved as the red channel  of
2559              the output image.  The right side is saved as the green channel.
2560              Red-green stereo glasses  are  required  to  properly  view  the
2561              stereo image.
2562
2563       -stroke <color>
2564              color to use when stroking a graphic primitive
2565
2566              The  color  is  specified  using  the format described under the
2567              -fill option.
2568
2569              See -draw for further details.
2570
2571       -strokewidth <value>
2572              set the stroke width
2573
2574              See -draw for further details.
2575
2576       -swirl <degrees>
2577              swirl image pixels about the center
2578
2579              Degrees defines the tightness of the swirl.
2580
2581       -text-font <name>
2582              font for writing fixed-width text
2583
2584              Specifies the name of the preferred font to use in fixed  (type‐
2585              writer style) formatted text.  The default is 14 point Courier.
2586
2587              You  can tag a font to specify whether it is a PostScript, True‐
2588              Type, or OPTION1 font.  For example, Courier.ttf is  a  TrueType
2589              font and x:fixed is OPTION1.
2590
2591       -texture <filename>
2592              name of texture to tile onto the image background
2593
2594       -threshold <value>{<green>,<blue>,<opacity>}{%}
2595              threshold the image
2596
2597              Create  an image such that any pixel sample that is equal to, or
2598              exceeds the threshold, is reassigned the maximum intensity  oth‐
2599              erwise the minimum intensity.
2600
2601              If  the  green  or blue value is omitted, these channels use the
2602              same value as the first one provided.  If all three color values
2603              are  the  same,  the result is a bi-level image.  If the opacity
2604              threshold is omitted, OpaqueOpacity will be used  and  any  par‐
2605              tially transparent pixel will become fully transparent.  If only
2606              a single 0 is provided, auto-thresholding will be performed.
2607
2608              To generate an all-black or all-white image with the same dimen‐
2609              sions as the input image, you can use
2610
2611                  gm convert -threshold 65535 in.png black.png
2612                  gm convert -threshold 0,0 in.png white.png
2613
2614       -tile <filename>
2615              tile image when filling a graphic primitive
2616
2617       -tile <geometry>
2618              layout of images [montage]
2619
2620       -title <string>
2621              assign title to displayed image [animate, display, montage]
2622
2623              Use this option to assign a specific title to the image. This is
2624              assigned to the image window and is typically displayed  in  the
2625              window  title  bar.   Optionally you can include the image file‐
2626              name, type, width, height, Exif data, or other  image  attribute
2627              by embedding special format characters described under the -for‐
2628              mat option.
2629
2630              For example,
2631
2632                   -title "%m:%f %wx%h"
2633
2634              produces an image title of MIFF:bird.miff 512x480 for  an  image
2635              titled bird.miff and whose width is 512 and height is 480.
2636
2637       -transform
2638              transform the image
2639
2640              This  option  applies  the transformation matrix from a previous
2641              -affine option.
2642
2643                  gm convert -affine 2,2,-2,2,0,0 -transform bird.ppm bird.jpg
2644
2645       -transparent <color>
2646              make this color transparent within the image
2647
2648              The color is specified using  the  format  described  under  the
2649              -fill option.
2650
2651       -treedepth <value>
2652              tree depth for the color reduction algorithm
2653
2654              Normally,  this integer value is zero or one. A value of zero or
2655              one causes the use of an optimal tree depth for the color reduc‐
2656              tion algorithm
2657
2658              An optimal depth generally allows the best representation of the
2659              source image with the fastest computational speed and the  least
2660              amount  of  memory.  However, the default depth is inappropriate
2661              for some images. To assure the best representation,  try  values
2662              between  2 and 8 for this parameter.  Refer to quantize for more
2663              details.
2664
2665              The -colors or -monochrome option, or writing to an image format
2666              which  requires  color reduction, is required for this option to
2667              take effect.
2668
2669       -trim  trim an image
2670
2671              This option removes any edges that are exactly the same color as
2672              the  corner  pixels.   Use -fuzz to make -trim remove edges that
2673              are nearly the same color as the corner pixels.
2674
2675       -type <type>
2676              the image type
2677
2678              Choose from: Bilevel, Grayscale,  Palette,  PaletteMatte,  True‐
2679              Color, TrueColorMatte, ColorSeparation, ColorSeparationMatte, or
2680              Optimize.
2681
2682              Normally, when a format supports different  subformats  such  as
2683              grayscale and truecolor, the encoder will try to choose an effi‐
2684              cient subformat.  The -type option can be used to overrride this
2685              behavior.   For example, to prevent a JPEG from being written in
2686              grayscale format even though only gray pixels are present, use
2687
2688                  gm convert bird.pgm -type TrueColor bird.jpg
2689
2690              Similarly, using -type TrueColorMatte will force the encoder  to
2691              write  an  alpha channel even though the image is opaque, if the
2692              output format supports transparency.
2693
2694       -update <seconds>
2695               detect when image file is modified and redisplay.
2696
2697              Suppose that while you are displaying an image the file that  is
2698              currently displayed is over-written.  display will automatically
2699              detect that the input file has been changed and update the  dis‐
2700              played image accordingly.
2701
2702       -units <type>
2703              the units of image resolution
2704
2705              Choose  from:  Undefined, PixelsPerInch, or PixelsPerCentimeter.
2706              This option is normally used in conjunction  with  the  -density
2707              option.
2708
2709       -unsharp <radius>{x<sigma>}{+<amount>}{+<threshold>}
2710              sharpen the image with an unsharp mask operator
2711
2712              The  -unsharp  option  sharpens an image. The image is convolved
2713              with a Gaussian operator of the given radius and standard devia‐
2714              tion  (sigma).  For  reasonable results, radius should be larger
2715              than sigma. Use a radius of 0 to have the method select a  suit‐
2716              able radius.
2717
2718              The parameters are:
2719
2720               radius
2721
2722
2723                    The  radius  of  the Gaussian, in pixels, not counting the
2724                    center pixel (default 0).
2725
2726               sigma
2727
2728
2729                    The standard deviation of the Gaussian, in pixels (default
2730                    1.0).
2731
2732               amount
2733
2734
2735                    The  percentage of the difference between the original and
2736                    the blur image  that  is  added  back  into  the  original
2737                    (default 1.0).
2738
2739               threshold
2740
2741
2742                    The  threshold,  as  a fraction of MaxRGB, needed to apply
2743                    the difference amount (default 0.05).
2744
2745
2746
2747       -use-pixmap
2748              use the pixmap
2749
2750       -verbose
2751              print detailed information about the image
2752
2753              This information is printed: image  scene  number;  image  name;
2754              image  size;  the  image class (DirectClass or PseudoClass); the
2755              total number of unique colors; and the number of seconds to read
2756              and transform the image.  Refer to miff for a description of the
2757              image class.
2758
2759              If -colors is also specified, the total  unique  colors  in  the
2760              image  and  color  reduction  error values are printed. Refer to
2761              quantize for a description of these values.
2762
2763       -version
2764              print GraphicsMagick version string
2765
2766       -view <string>
2767              FlashPix viewing parameters
2768
2769       -virtual-pixel <method>
2770              specify contents of "virtual pixels"
2771
2772              This option defines "virtual pixels" for use in operations  that
2773              can access pixels outside the boundaries of an image.
2774
2775              Choose from these methods:
2776
2777               Constant
2778
2779
2780                    Use the image background color.
2781
2782               Edge
2783
2784
2785                    Extend the edge pixel toward infinity (default).
2786
2787               Mirror
2788
2789
2790                    Mirror the image.
2791
2792               Tile
2793
2794
2795                    Tile the image.
2796
2797
2798
2799               This  option affects operations that use virtual pixels such as
2800               -blur, -sharpen, -wave, etc.
2801
2802       -visual <type>
2803              animate images using this X visual type
2804
2805              Choose from these visual classes:
2806
2807                   StaticGray
2808                   GrayScale
2809                   StaticColor
2810                   PseudoColor
2811                   TrueColor
2812                   DirectColor
2813                   default
2814                   visual id
2815
2816              The X server must support the visual you  choose,  otherwise  an
2817              error  occurs.   If  a visual is not specified, the visual class
2818              that can display the most simultaneous  colors  on  the  default
2819              screen is chosen.
2820
2821       -watermark <brightness>x<saturation>
2822              percent brightness and saturation of a watermark
2823
2824       -wave <amplitude>x<wavelength>
2825              alter an image along a sine wave
2826
2827              Specify amplitude and wavelength of the wave.
2828
2829       -white-point <x>,<y>
2830              chromaticity white point
2831
2832       -window <id>
2833              make image the background of a window
2834
2835              id  can be a window id or name.  Specify root to select X's root
2836              window as the target window.
2837
2838              By default the image is tiled onto the background of the  target
2839              window.    If  backdrop or -geometry are specified, the image is
2840              surrounded by the background color.  Refer to  X  RESOURCES  for
2841              details.
2842
2843              The  image  will not display on the root window if the image has
2844              more unique colors than the target window colormap allows.   Use
2845              -colors to reduce the number of colors.
2846
2847       -window-group
2848              specify the window group
2849
2850       -write <filename>
2851              write  an image sequence [convert, composite]
2852
2853              The  image sequence following the -write filenameoption is writ‐
2854              ten out, and then processing continues with the  same  image  in
2855              its  current  state if there are additional options.  To restore
2856              the image to its original state after writing it, use the +write
2857              filename option.
2858
2859       -write <filename>
2860              write the image to a file [display]
2861
2862              If  filename  already exists, you will be prompted as to whether
2863              it should be overwritten.
2864
2865              By default, the image is written in the format that it was  read
2866              in  as.   To  specify a particular image format, prefix filename
2867              with the image type and a colon (e.g., ps:image) or specify  the
2868              image type as the filename suffix (e.g., image.ps). Specify file
2869              as - for standard output. If file has the extension .Z  or  .gz,
2870              the file size is compressed using compress or gzip respectively.
2871              Precede the image file name with | to pipe to a system command.
2872
2873              Use -compress to specify the type of image compression.
2874
2875              The equivalent X  resource  for  this  option  is  writeFilename
2876              (class WriteFilename).  See "X Resources", below, for details.
2877

GM ANIMATE

2879       Animate  displays  a sequence of images on any workstation display run‐
2880       ning an X server. animate first determines the hardware capabilities of
2881       the  workstation.  If  the  number of unique colors in an image is less
2882       than or equal to the number the workstation can support, the  image  is
2883       displayed  in  an X window. Otherwise the number of colors in the image
2884       is first reduced to match  the  color  resolution  of  the  workstation
2885       before it is displayed.
2886
2887       This  means  that a continuous-tone 24 bits-per-pixel image can display
2888       on a 8 bit pseudo-color device or monochrome device. In most  instances
2889       the  reduced color image closely resembles the original. Alternatively,
2890       a monochrome or pseudo-color image sequence can display on  a  continu‐
2891       ous-tone 24 bits-per-pixel device.
2892
2893       To help prevent color flashing on X server visuals that have colormaps,
2894       animate creates a single colormap from the image sequence. This can  be
2895       rather  time consuming. You can speed this operation up by reducing the
2896       colors in the image before you "animate" them.  Use  mogrify  to  color
2897       reduce  the  images  to  a single colormap. See mogrify(1) for details.
2898       Alternatively, you can use a Standard Colormap; or a static, direct, or
2899       true  color  visual.  You can define a Standard Colormap with xstdcmap.
2900       See xstdcmap(1) for details. This method is recommended for colormapped
2901       X server because it eliminates the need to compute a global colormap.
2902

EXAMPLES

2904       To animate a set of images of a cockatoo, use:
2905
2906           gm animate cockatoo.*
2907
2908       To  animate a cockatoo image sequence while using the Standard Colormap
2909       best, use:
2910
2911           xstdcmap -best
2912           gm animate -map best cockatoo.*
2913
2914       To animate an image of a cockatoo without a border centered on a  back‐
2915       drop, use:
2916
2917
2918           gm animate +borderwidth -backdrop cockatoo.*
2919

OPTIONS

2921       For a more detailed description of each option, see Options, above.
2922
2923
2924       -authenticate <string>
2925              decrypt image with this password
2926
2927       -backdrop
2928              display the image centered on a backdrop.
2929
2930       -background <color>
2931              the background color
2932
2933       -bordercolor <color>
2934              the border color
2935
2936       -borderwidth <geometry>
2937              the border width
2938
2939       -cache <threshold>
2940              (This option has been replaced by the -limit option)
2941
2942       -chop <width>x<height>{+-}<x>{+-}<y>{%}
2943              remove pixels from the interior of an image
2944
2945       -colormap <type>
2946              define the colormap type
2947
2948       -colors <value>
2949              preferred number of colors in the image
2950
2951       -colorspace <value>
2952              the type of colorspace
2953
2954       -crop <width>x<height>{+-}<x>{+-}<y>{%}
2955              preferred size and location of the cropped image
2956
2957       -debug <events>
2958              enable debug printout
2959
2960       -define <key>{=<value>},...
2961              add coder/decoder specific options
2962
2963       -delay <1/100ths of a second>
2964              display the next image after pausing
2965
2966       -density <width>x<height>
2967              horizontal and vertical resolution in pixels of the image
2968
2969       -depth <value>
2970              depth of the image
2971
2972       -display <host:display[.screen]>
2973              specifies the X server to contact
2974
2975       -dispose <method>
2976              GIF disposal method
2977
2978       -dither
2979              apply Floyd/Steinberg error diffusion to the image
2980
2981       -font <name>
2982              use this font when annotating the image with text
2983
2984       -foreground <color>
2985              define the foreground color
2986
2987       -gamma <value>
2988              level of gamma correction
2989
2990       -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@} {!}{<}{>}
2991              preferred size and location of the Image window.
2992
2993       -help  print usage instructions
2994
2995       -iconGeometry <geometry>
2996              specify the icon geometry
2997
2998       -iconic
2999              iconic animation
3000
3001       -interlace <type>
3002              the type of interlacing scheme
3003
3004       -limit <type> <value>
3005              Disk, File, Map, or Memory resource limit
3006
3007       -log <string>
3008              Specify format for debug log
3009
3010       -map <type>
3011              display image using this type.
3012
3013       -matte store matte channel if the image has one
3014
3015       -mattecolor <color>
3016              specify the color to be used with the -frame option
3017
3018       -monochrome
3019              transform the image to black and white
3020
3021       -name  name an image
3022
3023       -noop  NOOP (no option)
3024
3025       -pause <seconds>
3026              pause between animation loops [animate]
3027
3028       -remote
3029              perform a X11 remote operation
3030
3031       -rotate <degrees>{<}{>}
3032              apply Paeth image rotation to the image
3033
3034       -sampling-factor <horizontal_factor>x<vertical_factor>
3035              sampling  factors  used  by  JPEG  or  MPEG-2  encoder  and  YUV
3036              decoder/encoder.
3037
3038       -scenes <value-value>
3039              range of image scene numbers to read
3040
3041       -shared-memory
3042              use shared memory
3043
3044       -size <width>x<height>{+offset}
3045              width and height of the image
3046
3047       -text-font <name>
3048              font for writing fixed-width text
3049
3050       -title <string>
3051              assign title to displayed image [animate, display, montage]
3052
3053       -treedepth <value>
3054              tree depth for the color reduction algorithm
3055
3056       -trim  trim an image
3057
3058       -verbose
3059              print detailed information about the image
3060
3061       -version
3062              print GraphicsMagick version string
3063
3064       -visual <type>
3065              animate images using this X visual type
3066
3067       -window <id>
3068              make image the background of a window
3069
3070              For a more detailed description of  each  option,  see  Options,
3071              above.
3072
3073
3074              Any option you specify on the command line remains in effect for
3075              the group of images following it, until the group is  terminated
3076              by  the appearance of any option or -noop.  For example, to ani‐
3077              mate three images, the first with 32 colors, the second with  an
3078              unlimited  number  of colors, and the third with only 16 colors,
3079              use:
3080
3081
3082                   gm animate -colors 32 cockatoo.1 -noop cockatoo.2
3083                           -colors 16 cockatoo.3
3084
3085              Animate options can appear on the command  line  or  in  your  X
3086              resources  file. See X(1). Options on the command line supersede
3087              values specified in your X resources file.  Image filenames  may
3088              appear  in  any order on the command line if the image format is
3089              MIFF (refer to miff(5) and the scene keyword is specified in the
3090              image.  Otherwise  the  images  will  display  in the order they
3091              appear on the command line.
3092

MOUSE BUTTONS

3094       Press any button to map or unmap the Command widget. See the next  sec‐
3095       tion for more information about the Command widget.
3096

COMMAND WIDGET

3098       The Command widget lists a number of sub-menus and commands. They are
3099
3100           Animate
3101
3102               Open
3103               Play
3104               Step
3105               Repeat
3106               Auto Reverse
3107
3108           Speed
3109
3110               Faster
3111               Slower
3112
3113           Direction
3114
3115               Forward
3116               Reverse
3117
3118           Image Info
3119           Help
3120           Quit
3121
3122
3123       Menu  items  with  a indented triangle have a sub-menu. They are repre‐
3124       sented above as the indented items. To access a sub-menu item, move the
3125       pointer  to  the appropriate menu and press a button and drag. When you
3126       find the desired sub-menu item, release the button and the  command  is
3127       executed.  Move the pointer away from the sub-menu if you decide not to
3128       execute a particular command.
3129

KEYBOARD ACCELERATORS

3131               Ctl+O
3132
3133                    Press to load an image from a file.
3134               space
3135
3136                    Press to display the next image in the sequence.
3137               <
3138
3139                    Press to speed-up the display of  the  images.   Refer  to
3140                    -delay for more information.
3141               >
3142
3143                    Press  to slow the display of the images.  Refer to -delay
3144                    for more information.
3145               ?
3146
3147                    Press to display information about the image.   Press  any
3148                    key or button to erase the information.
3149                    This  information is printed: image name;  image size; and
3150                    the total number of unique colors in the image.
3151               F1
3152
3153                    Press to display helpful information about animate(1).
3154               Ctl-q
3155
3156                    Press to discard all images and exit program.
3157
3158

X RESOURCES

3160       Animate options can appear on the command line or in  your  X  resource
3161       file.  Options on the command line supersede values specified in your X
3162       resource file. See X(1) for more information on X resources.
3163
3164       All animate options have a corresponding X resource. In  addition,  the
3165       animate program uses the following X resources:
3166
3167               background (class Background)
3168
3169
3170                    Specifies  the preferred color to use for the Image window
3171                    background. The default is #ccc.
3172               borderColor (class BorderColor)
3173
3174
3175                    Specifies the preferred color to use for the Image  window
3176                    border. The default is #ccc.
3177               borderWidth (class BorderWidth)
3178
3179
3180                    Specifies  the width in pixels of the Image window border.
3181                    The default is 2.
3182               font (class Font or FontList)
3183
3184
3185                    Specifies the name of the preferred font to use in  normal
3186                    formatted text.  The default is 14 point Helvetica.
3187               foreground (class Foreground)
3188
3189
3190                    Specifies  the  preferred color to use for text within the
3191                    Image window.  The default is black.
3192               geometry (class geometry)
3193
3194
3195                    Specifies the preferred size and  position  of  the  image
3196                    window.  It  is  not necessarily obeyed by all window man‐
3197                    agers.  Offsets, if present, are handled in X(1) style.  A
3198                    negative  x  offset is measured from the right edge of the
3199                    screen to the right edge of the icon,  and  a  negative  y
3200                    offset  is  measured from the bottom edge of the screen to
3201                    the bottom edge of the icon.
3202               iconGeometry (class IconGeometry)
3203
3204
3205                    Specifies the preferred size and position of the  applica‐
3206                    tion  when iconified.  It is not necessarily obeyed by all
3207                    window managers.  Offsets, if present, are handled in  the
3208                    same manner as in class Geometry.
3209               iconic (class Iconic)
3210
3211
3212                    This  resource  indicates  that  you would prefer that the
3213                    application's windows initially not be visible as  if  the
3214                    windows  had  be immediately iconified by you. Window man‐
3215                    agers may choose not to honor the application's request.
3216               matteColor (class MatteColor)
3217
3218
3219                    Specify the color of windows. It is  used  for  the  back‐
3220                    grounds  of  windows,  menus,  and notices. A 3D effect is
3221                    achieved by using highlight and shadow colors derived from
3222                    this color. Default value: #ddd.
3223               name (class Name)
3224
3225
3226                    This resource specifies the name under which resources for
3227                    the application should be found. This resource  is  useful
3228                    in  shell aliases to distinguish between invocations of an
3229                    application, without resorting to creating links to  alter
3230                    the  executable  file name. The default is the application
3231                    name.
3232               sharedMemory (class SharedMemory)
3233
3234
3235                    This resource specifies whether animate should attempt use
3236                    shared  memory  for  pixmaps. ImageMagick must be compiled
3237                    with shared memory support, and the display  must  support
3238                    the   MIT-SHM   extension.  Otherwise,  this  resource  is
3239                    ignored. The default is True.
3240               text_font (class textFont)
3241
3242
3243                    Specifies the name of the preferred font to use  in  fixed
3244                    (typewriter style) formatted text. The default is 14 point
3245                    Courier.
3246               title (class Title)
3247
3248
3249                    This resource specifies the title to be used for the Image
3250                    window.  This  information  is  sometimes used by a window
3251                    manager to provide some sort  of  header  identifying  the
3252                    window. The default is the image file name.
3253
3254

GM COMPOSITE

3256       composite  composites  (combines)  images  to create new images.  base-
3257       image is the base image and change-image contains the changes.   ouput-
3258       image  is  the  result,  and  normally has the same dimensions as base-
3259       image.
3260
3261
3262       The optional mask-image can be used to provide opacity information  for
3263       change-image  when it has none or if you want a different mask.  A mask
3264       image is typically grayscale and the same size as base-image. If  mask-
3265       image  is not grayscale, it is converted to grayscale and the resulting
3266       intensities are used as opacity information.
3267

EXAMPLES

3269       To composite an image of a cockatoo with a perch, use:
3270
3271           gm composite cockatoo.miff perch.ras composite.miff
3272
3273       To compute the difference between images in a series, use:
3274
3275           gm composite -compose difference series.2 series.1
3276                     difference.miff
3277
3278       To composite an image of a cockatoo with a perch starting  at  location
3279       (100,150), use:
3280
3281           gm composite -geometry +100+150 cockatoo.miff
3282                     perch.ras composite.miff
3283
3284       To tile a logo across your image of a cockatoo, use
3285
3286           gm convert +shade 30x60 cockatoo.miff mask.miff
3287           gm composite -compose bumpmap -tile logo.png
3288                     cockatoo.miff mask.miff composite.miff
3289
3290       To composite a red, green, and blue color plane into a single composite
3291       image, try
3292
3293           gm composite -compose CopyGreen green.png red.png
3294                     red-green.png
3295           gm composite -compose CopyBlue blue.png red-green.png
3296                     gm composite.png
3297

OPTIONS

3299       Options are processed in command line order. Any option you specify  on
3300       the  command  line  remains  in effect only for the image that follows.
3301       All options are reset to their default values after each image is read.
3302
3303       For a more detailed description of each option, see Options, above.
3304
3305
3306       -authenticate <string>
3307              decrypt image with this password
3308
3309       -background <color>
3310              the background color
3311
3312       -blue-primary <x>,<y>
3313              blue chromaticity primary point
3314
3315       -cache <threshold>
3316              (This option has been replaced by the -limit option)
3317
3318       -colors <value>
3319              preferred number of colors in the image
3320
3321       -colorspace <value>
3322              the type of colorspace
3323
3324       -comment <string>
3325              annotate an image with a comment
3326
3327       -compose <operator>
3328              the type of image composition
3329
3330       -compress <type>
3331              the type of image compression
3332
3333       -debug <events>
3334              enable debug printout
3335
3336       -define <key>{=<value>},...
3337              add coder/decoder specific options
3338
3339       -density <width>x<height>
3340              horizontal and vertical resolution in pixels of the image
3341
3342       -depth <value>
3343              depth of the image
3344
3345       -displace <horizontal scale>x<vertical scale>
3346              shift image pixels as defined by a displacement map
3347
3348       -display <host:display[.screen]>
3349              specifies the X server to contact
3350
3351       -dispose <method>
3352              GIF disposal method
3353
3354       -dissolve <percent>
3355              dissolve an image into another by the given percent
3356
3357       -dither
3358              apply Floyd/Steinberg error diffusion to the image
3359
3360       -encoding <type>
3361              specify the text encoding
3362
3363       -endian <type>
3364              specify endianness (MSB or LSB) of output image
3365
3366       -filter <type>
3367              use this type of filter when resizing an image
3368
3369       -font <name>
3370              use this font when annotating the image with text
3371
3372       -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@} {!}{<}{>}
3373              preferred size and location of the Image window.
3374
3375       -gravity <type>
3376              direction primitive  gravitates to when annotating the image.
3377
3378       -green-primary <x>,<y>
3379              green chromaticity primary point
3380
3381       -help  print usage instructions
3382
3383       -interlace <type>
3384              the type of interlacing scheme
3385
3386       -label <name>
3387              assign a label to an image
3388
3389       -limit <type> <value>
3390              Disk, File, Map, or Memory resource limit
3391
3392       -log <string>
3393              Specify format for debug log
3394
3395       -matte store matte channel if the image has one
3396
3397       -monochrome
3398              transform the image to black and white
3399
3400       -negate
3401              replace every pixel with its complementary color
3402
3403       -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
3404              size and location of an image canvas
3405
3406       -profile <filename>
3407              add ICM, IPTC, or generic profile  to image
3408
3409       -quality <value>
3410              JPEG/MIFF/PNG compression level
3411
3412       -red-primary <x>,<y>
3413              red chromaticity primary point
3414
3415       -render
3416              render vector operations
3417
3418       -resize <width>x<height>{%}{@}{!}{<}{>}
3419              resize an image
3420
3421       -rotate <degrees>{<}{>}
3422              apply Paeth image rotation to the image
3423
3424       -sampling-factor <horizontal_factor>x<vertical_factor>
3425              sampling  factors  used  by  JPEG  or  MPEG-2  encoder  and  YUV
3426              decoder/encoder.
3427
3428       -scene <value>
3429              set scene number
3430
3431       -sharpen <radius>{x<sigma>}
3432              sharpen the image
3433
3434       -size <width>x<height>{+offset}
3435              width and height of the image
3436
3437       -stegano <offset>
3438              hide watermark within an image
3439
3440       -stereo
3441              composite two images to create a stereo anaglyph
3442
3443       -treedepth <value>
3444              tree depth for the color reduction algorithm
3445
3446       -trim  trim an image
3447
3448       -type <type>
3449              the image type
3450
3451       -units <type>
3452              the units of image resolution
3453
3454       -unsharp <radius>{x<sigma>}{+<amount>}{+<threshold>}
3455              sharpen the image with an unsharp mask operator
3456
3457       -verbose
3458              print detailed information about the image
3459
3460       -version
3461              print GraphicsMagick version string
3462
3463       -watermark <brightness>x<saturation>
3464              percent brightness and saturation of a watermark
3465
3466       -white-point <x>,<y>
3467              chromaticity white point
3468
3469       -write <filename>
3470              write  an image sequence [convert, composite]
3471
3472              For  a  more  detailed  description of each option, see Options,
3473              above.
3474
3475

GM CONJURE

3477       The Magick scripting language (MSL) will primarily benefit  those  that
3478       want  to  accomplish  custom  image processing tasks but do not wish to
3479       program, or those that do not have access to a Perl  interpreter  or  a
3480       compiler.   The  interpreter  is  called conjure and here is an example
3481       script:
3482
3483           <?xml version="1.0" encoding="UTF-8"?>
3484           <image size="400x400" >
3485             <read filename="image.gif" />
3486             <get width="base-width" height="base-height" />
3487             <resize geometry="%[dimensions]" />
3488             <get width="width" height="height" />
3489             <print output=
3490               "Image sized from %[base-width]x%[base-height]
3491                to %[width]x%[height].\n" />
3492             <write filename="image.png" />
3493           </image>
3494
3495       invoked with
3496
3497           gm conjure -dimensions 400x400 incantation.msl
3498
3499       All operations will closely follow the key/value pairs defined in Perl‐
3500       Magick, unless otherwise noted.
3501
3502       Conjure is in the early stages of development as of April 2002.
3503
3504       This  early announcement is to allow GraphicsMagick users to contribute
3505       ideas early in the process so when the scripting language  is  released
3506       it  will  be  useful/stable  from the get-go! If you want to contribute
3507       suggestions about the Magick scripting language (MSL), post them to the
3508       GraphicsMagick  tools  list  at  graphicsmagick-tools  @  lists.source‐
3509       forge.net.
3510

OPTIONS

3512       Options are processed in command line order. Any option you specify  on
3513       the  command  line  remains in effect until it is explicitly changed by
3514       specifying the option again with  a  different  effect,  or  if  it  is
3515       changed by a statement in the scripting language.
3516
3517       You  can  define your own keyword/value pairs on the command line.  The
3518       script can then use this information when setting values  by  including
3519       %[keyword]  in  the  string.  For example, if you included "-dimensions
3520       400x400" on the command line, as illustrated  above,  then  any  string
3521       containing   "%[dimensions]"   would  have  400x400  substituted.   The
3522       "%[string]" can be  used  either  an  entire  string,  such  as  geome‐
3523       try="%[dimensions]"  or as a part of a string such as filename="%[base‐
3524       name].png".
3525
3526       The keyword can be any string except for the following reserved strings
3527       (in any upper, lower, or mixed case variant): debug, help, and verbose,
3528       whose usage is described below.
3529
3530       The value can be any string.  If either the keyword or the  value  con‐
3531       tains  white  space  or  any symbols that have special meanings to your
3532       shell such as "#", "|", or "%", enclose the string in  quotation  marks
3533       or use "\" to escape the white space and special symbols.
3534
3535       Keywords  and values are case dependent.  "Key", "key", and "KEY" would
3536       be three different keywords.
3537
3538       For a more detailed description of each option, see Options, above.
3539
3540
3541       -debug <events>
3542              enable debug printout
3543
3544       -define <key>{=<value>},...
3545              add coder/decoder specific options
3546
3547       -help  print usage instructions
3548
3549       -log <string>
3550              Specify format for debug log
3551
3552       -verbose
3553              print detailed information about the image
3554
3555       -version
3556              print GraphicsMagick version string
3557

MAGICK SCRIPTING LANGUAGE

3559       The Magick Scripting Language (MSL)  presently  defines  the  following
3560       elements and their attributes:
3561
3562               <image>
3563
3564
3565                    Define  a new image object.  </image> destroys it. Because
3566                    of this, if you wish  to  reference  multiple  "subimages"
3567                    (aka  pages  or  layers),  you can embed one image element
3568                    inside of another. For example:
3569
3570
3571
3572                        <image>
3573                        <read filename="input.png" />
3574                        <get width="base-width" height="base-height" />
3575                        <image height="base-height" width="base-width">
3576                        <image />
3577                        <write filename="output.mng" />
3578                        </image>
3579
3580
3581
3582                        <image size="400x400" />
3583
3584               <group>
3585
3586
3587                    Define a new group of image objects.  By  default,  images
3588                    are only valid for the life of their <image>element.
3589
3590
3591
3592                        <image>   -- creates the image
3593                        .....     -- do stuff with it
3594                        </image>  -- dispose of the image
3595
3596
3597                    However,  in  a  group, all images in that group will stay
3598                    around for the life of the group:
3599
3600
3601
3602                        <group>                           -- start a group
3603                            <image>                       -- create an image
3604                            ....                          -- do stuff
3605                            </image>                      -- NOOP
3606                            <image>                        --  create  another
3607                    image
3608                            ....                          -- do more stuff
3609                            </image>                      -- NOOP
3610                            <write filename="image.mng" />  -- output
3611                        </group>                           --  dispose of both
3612                    images
3613
3614               <read>
3615
3616
3617                    Read a new image from a disk file.
3618
3619
3620
3621                        <read filename="image.gif" />
3622
3623
3624                    To read two images use
3625
3626
3627
3628                        <read filename="image.gif" />
3629                        <read filename="image.png />
3630
3631               <write>
3632
3633                    Write the image(s) to disk, either as a  single  multiple-
3634                    image file or multiple ones if necessary.
3635
3636
3637
3638                         <write filename=image.tiff" />
3639               <get>
3640
3641                    Get   any  attribute  recognized  by  PerlMagick's  GetAt‐
3642                    tribute() and stores it as an image  attribute  for  later
3643                    use. Currently only width and height are supported.
3644
3645
3646                        <get width="base-width" height="base-height" />
3647                        <print  output="Image  size  is  %[base-width]x%[base-
3648                    height].\n" />
3649
3650               <set>
3651
3652                    background, bordercolor, clip-mask,  colorspace,  density,
3653                    magick,  mattecolor, opacity.  Set an attribute recognized
3654                    by PerlMagick's GetAttribute().
3655               <border>
3656
3657                        fill, geometry, height, width
3658               <blur>
3659
3660                        radius, sigma
3661               <charcoal>
3662
3663                        radius, sigma
3664               <chop>
3665
3666                        geometry, height, width, x, y
3667               <crop>
3668
3669                        geometry, height, width, x, y
3670               <despeckle>
3671
3672               <emboss>
3673
3674                        radius, sigma
3675               <enhance>
3676
3677               <equalize>
3678
3679               <flip>
3680
3681               <flop>
3682
3683               <frame>
3684
3685                        fill, geometry, height, width, x, y, inner, outer
3686               <get>
3687
3688                        height, width
3689               <image>
3690
3691                        background, color, id, size
3692               <magnify>
3693
3694               <minify>
3695
3696               <normalize>
3697
3698               <print>
3699
3700                        output
3701               <read>
3702
3703               <resize>
3704
3705                        blur, filter, geometry, height, width
3706               <roll>
3707
3708                        geometry, x, y
3709               <rotate>
3710
3711                        degrees
3712               <sample>
3713
3714                        geometry, height, width
3715               <scale>
3716
3717                        geometry, height, width
3718               <sharpen>
3719
3720                        radius, sigma
3721               <shave>
3722
3723                        geometry, height, width
3724               <shear>
3725
3726                        x, y
3727               <solarize>
3728
3729                        threshold
3730               <spread>
3731
3732                        radius
3733               <stegano>
3734
3735                        image
3736               <stereo>
3737
3738                        image
3739               <swirl>
3740
3741                        degrees
3742               <texture>
3743
3744                        image
3745               <threshold>
3746
3747                        threshold
3748               <transparent>
3749
3750                        color
3751               <trim>
3752
3753
3754
3755
3756       GM CONVERT
3757
3758              Convert converts an input file using one image format to an out‐
3759              put  file  with  a  differing image format. In addition, various
3760              types of image processing can  be  performed  on  the  converted
3761              image  during  the  conversion  process.  Convert recognizes the
3762              image formats listed in GraphicsMagick(1).
3763
3764

EXAMPLES

3766       To make a thumbnail of a JPEG image, use:
3767
3768           gm convert -size 120x120 cockatoo.jpg -resize 120x120
3769                   +profile "*" thumbnail.jpg
3770
3771       In this example, '-size 120x120' gives a hint to the JPEG decoder  that
3772       the  image  is  going  to  be downscaled to 120x120, allowing it to run
3773       faster by avoiding returning full-resolution images  to  GraphicsMagick
3774       for  the  subsequent resizing operation.  The output image.  It will be
3775       scaled so its largest dimension is  120  pixels.   The  that  might  be
3776       present in the input and aren't needed in the thumbnail.
3777
3778       To convert a MIFF image of a cockatoo to a SUN raster image, use:
3779
3780           gm convert cockatoo.miff sun:cockatoo.ras
3781
3782       To  convert  a  multi-page PostScript document to individual FAX pages,
3783       use:
3784
3785           gm convert -monochrome document.ps fax:page
3786
3787       To convert a TIFF image to a PostScript A4 page with the image  in  the
3788       lower left-hand corner, use:
3789
3790           gm convert -page A4+0+0 image.tiff document.ps
3791
3792       To  convert  a  raw  Gray  image  with  a 128 byte header to a portable
3793       graymap, use:
3794
3795           gm convert -depth 8 -size 768x512+128 gray:raw
3796                   image.pgm
3797
3798       In this example, "raw" is the input file.  Its format is "gray" and  it
3799       has  the  dimensions  and number of header bytes specified by the -size
3800       option and the sample depth specified by the -depth option.  The output
3801       file is "image.pgm".  The suffix ".pgm" specifies its format.
3802
3803       To convert a Photo CD image to a TIFF image, use:
3804
3805           gm convert -size 1536x1024 img0009.pcd image.tiff
3806           gm convert img0009.pcd[4] image.tiff
3807
3808       To create a visual image directory of all your JPEG images, use:
3809
3810           gm convert 'vid:*.jpg' directory.miff
3811
3812       To  annotate  an  image  with  blue  text  using font 12x24 at position
3813       (100,100), use:
3814
3815           gm convert -font helvetica -fill blue
3816                   -draw "text 100,100 Cockatoo"
3817                   bird.jpg bird.miff
3818
3819       To tile a 640x480 image with a JPEG texture with bumps use:
3820
3821           gm convert -size 640x480 tile:bumps.jpg tiled.png
3822
3823       To surround an icon with an ornamental border to  use  with  Mosaic(1),
3824       use:
3825
3826           gm convert -mattecolor "#697B8F" -frame 6x6 bird.jpg
3827                   icon.png
3828
3829       To create a MNG animation from a DNA molecule sequence, use:
3830
3831           gm convert -delay 20 dna.* dna.mng
3832

OPTIONS

3834       Options  are processed in command line order. Any option you specify on
3835       the command line remains in effect for the set of images that  follows,
3836       until  the  set is terminated by the appearance of any option or -noop.
3837       Some options only affect the decoding of images  and  others  only  the
3838       encoding.  The latter can appear after the final group of input images.
3839
3840       For a more detailed description of each option, see Options, above.
3841
3842
3843       -adjoin
3844              join images into a single multi-image file
3845
3846       -affine <matrix>
3847              drawing transform matrix
3848
3849       -antialias
3850              remove pixel aliasing
3851
3852       -append
3853              append a set of images
3854
3855       -authenticate <string>
3856              decrypt image with this password
3857
3858       -average
3859              average a set of images
3860
3861       -background <color>
3862              the background color
3863
3864       -blue-primary <x>,<y>
3865              blue chromaticity primary point
3866
3867       -blur <radius>{x<sigma>}
3868              blur the image with a Gaussian operator
3869
3870       -border <width>x<height>
3871              surround the image with a border of color
3872
3873       -bordercolor <color>
3874              the border color
3875
3876       -box <color>
3877              set the color of the annotation bounding box
3878
3879       -cache <threshold>
3880              (This option has been replaced by the -limit option)
3881
3882       -channel <type>
3883              the type of channel
3884
3885       -charcoal <factor>
3886              simulate a charcoal drawing
3887
3888       -chop <width>x<height>{+-}<x>{+-}<y>{%}
3889              remove pixels from the interior of an image
3890
3891       -clip  apply the clipping path, if one is present
3892
3893       -coalesce
3894              merge a sequence of images
3895
3896       -colorize <value>
3897              colorize the image with the pen color
3898
3899       -colors <value>
3900              preferred number of colors in the image
3901
3902       -colorspace <value>
3903              the type of colorspace
3904
3905       -comment <string>
3906              annotate an image with a comment
3907
3908       -compose <operator>
3909              the type of image composition
3910
3911       -compress <type>
3912              the type of image compression
3913
3914       -contrast
3915              enhance or reduce the image contrast
3916
3917       -convolve <kernel>
3918              convolve image with the specified convolution kernel
3919
3920       -crop <width>x<height>{+-}<x>{+-}<y>{%}
3921              preferred size and location of the cropped image
3922
3923       -cycle <amount>
3924              displace image colormap by amount
3925
3926       -debug <events>
3927              enable debug printout
3928
3929       -deconstruct
3930              break down an image sequence into constituent parts
3931
3932       -define <key>{=<value>},...
3933              add coder/decoder specific options
3934
3935       -delay <1/100ths of a second>
3936              display the next image after pausing
3937
3938       -density <width>x<height>
3939              horizontal and vertical resolution in pixels of the image
3940
3941       -depth <value>
3942              depth of the image
3943
3944       -despeckle
3945              reduce the speckles within an image
3946
3947       -display <host:display[.screen]>
3948              specifies the X server to contact
3949
3950       -dispose <method>
3951              GIF disposal method
3952
3953       -dither
3954              apply Floyd/Steinberg error diffusion to the image
3955
3956       -draw <string>
3957              annotate an image with one or more graphic primitives
3958
3959       -edge <radius>
3960              detect edges within an image
3961
3962       -emboss <radius>
3963              emboss an image
3964
3965       -encoding <type>
3966              specify the text encoding
3967
3968       -endian <type>
3969              specify endianness (MSB or LSB) of output image
3970
3971       -enhance
3972              apply a digital filter to enhance a noisy image
3973
3974       -equalize
3975              perform histogram equalization to the image
3976
3977       -fill <color>
3978              color to use when filling a graphic primitive
3979
3980       -filter <type>
3981              use this type of filter when resizing an image
3982
3983       -flatten
3984              flatten a sequence of images
3985
3986       -flip  create a "mirror image"
3987
3988       -flop  create a "mirror image"
3989
3990       -font <name>
3991              use this font when annotating the image with text
3992
3993       -frame <width>x<height>+<outer bevel width>+<inner bevel width>
3994              surround the image with an ornamental border
3995
3996       -fuzz <distance>{%}
3997              colors within this distance are considered equal
3998
3999       -gamma <value>
4000              level of gamma correction
4001
4002       -Gaussian <radius>{x<sigma>}
4003              blur the image with a Gaussian operator
4004
4005       -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@} {!}{<}{>}
4006              preferred size and location of the Image window.
4007
4008       -gravity <type>
4009              direction primitive  gravitates to when annotating the image.
4010
4011       -green-primary <x>,<y>
4012              green chromaticity primary point
4013
4014       -help  print usage instructions
4015
4016       -implode <factor>
4017              implode image pixels about the center
4018
4019       -intent <type>
4020              use this type of rendering intent when managing the image color
4021
4022       -interlace <type>
4023              the type of interlacing scheme
4024
4025       -label <name>
4026              assign a label to an image
4027
4028       -lat <width>x<height>{+-}<offset>{%}
4029              perform local adaptive thresholding
4030
4031       -level <black_point>{,<gamma>}{,<white_point>}{%}
4032              adjust the level of image contrast
4033
4034       -limit <type> <value>
4035              Disk, File, Map, or Memory resource limit
4036
4037       -list <type>
4038              the type of list
4039
4040       -log <string>
4041              Specify format for debug log
4042
4043       -loop <iterations>
4044              add Netscape loop extension to your GIF animation
4045
4046       -map <filename>
4047              choose a particular set of colors from this image
4048
4049       -mask <filename>
4050              Specify a clipping mask
4051
4052       -matte store matte channel if the image has one
4053
4054       -mattecolor <color>
4055              specify the color to be used with the -frame option
4056
4057       -median <radius>
4058              apply a median filter to the image
4059
4060       -modulate brightness[,saturation[,hue]]
4061              vary the brightness, saturation, and hue of an image
4062
4063       -monochrome
4064              transform the image to black and white
4065
4066       -morph <frames>
4067              morphs an image sequence
4068
4069       -mosaic
4070              create a mosaic from an image or an image sequence
4071
4072       -negate
4073              replace every pixel with its complementary color
4074
4075       -noise <radius|type>
4076              add or reduce noise in an image
4077
4078       -noop  NOOP (no option)
4079
4080       -normalize
4081              transform image to span the full range of color values
4082
4083       -opaque <color>
4084              change this color to the pen color within the image
4085
4086       -operator channel operator rvalue[%]
4087              apply a mathematical or bitwise operator to an image channel
4088
4089       -ordered-dither <channeltype> <NxN>
4090              ordered dither the image
4091
4092       -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
4093              size and location of an image canvas
4094
4095       -paint <radius>
4096              simulate an oil painting
4097
4098       -pen <color>
4099              (This option has been replaced by the -fill option)
4100
4101       -ping  efficiently determine image characteristics
4102
4103       -pointsize <value>
4104              pointsize of the PostScript, OPTION1, or TrueType font
4105
4106       -preview <type>
4107              image preview type
4108
4109       -process <command>
4110              process a sequence of images using a process module
4111
4112       -profile <filename>
4113              add ICM, IPTC, or generic profile  to image
4114
4115       -quality <value>
4116              JPEG/MIFF/PNG compression level
4117
4118       -raise <width>x<height>
4119              lighten or darken image edges
4120
4121       -random-threshold <channeltype> <LOWxHIGH>
4122              random threshold the image
4123
4124       -red-primary <x>,<y>
4125              red chromaticity primary point
4126
4127       -region <width>x<height>{+-}<x>{+-}<y>
4128              apply options to a portion of the image
4129
4130       -render
4131              render vector operations
4132
4133       -resample <horizontal>x<vertical>
4134              Resample image to specified horizontal and vertical resolution
4135
4136       -resize <width>x<height>{%}{@}{!}{<}{>}
4137              resize an image
4138
4139       -roll {+-}<x>{+-}<y>
4140              roll an image vertically or horizontally
4141
4142       -rotate <degrees>{<}{>}
4143              apply Paeth image rotation to the image
4144
4145       -sample <geometry>
4146              scale image using pixel sampling
4147
4148       -sampling-factor <horizontal_factor>x<vertical_factor>
4149              sampling  factors  used  by  JPEG  or  MPEG-2  encoder  and  YUV
4150              decoder/encoder.
4151
4152       -scale <geometry>
4153              scale the image.
4154
4155       -scene <value>
4156              set scene number
4157
4158       -segment <cluster threshold>x<smoothing threshold>
4159              segment an image
4160
4161       -shade <azimuth>x<elevation>
4162              shade the image using a distant light source
4163
4164       -sharpen <radius>{x<sigma>}
4165              sharpen the image
4166
4167       -shave <width>x<height>{%}
4168              shave pixels from the image edges
4169
4170       -shear <x degrees>x<y degrees>
4171              shear the image along the X or Y axis
4172
4173       -size <width>x<height>{+offset}
4174              width and height of the image
4175
4176       -solarize <factor>
4177              negate all pixels above the threshold level
4178
4179       -spread <amount>
4180              displace image pixels by a random amount
4181
4182       -stroke <color>
4183              color to use when stroking a graphic primitive
4184
4185       -strokewidth <value>
4186              set the stroke width
4187
4188       -swirl <degrees>
4189              swirl image pixels about the center
4190
4191       -texture <filename>
4192              name of texture to tile onto the image background
4193
4194       -threshold <value>{<green>,<blue>,<opacity>}{%}
4195              threshold the image
4196
4197       -tile <filename>
4198              tile image when filling a graphic primitive
4199
4200       -transform
4201              transform the image
4202
4203       -transparent <color>
4204              make this color transparent within the image
4205
4206       -treedepth <value>
4207              tree depth for the color reduction algorithm
4208
4209       -trim  trim an image
4210
4211       -type <type>
4212              the image type
4213
4214       -units <type>
4215              the units of image resolution
4216
4217       -unsharp <radius>{x<sigma>}{+<amount>}{+<threshold>}
4218              sharpen the image with an unsharp mask operator
4219
4220       -use-pixmap
4221              use the pixmap
4222
4223       -verbose
4224              print detailed information about the image
4225
4226       -version
4227              print GraphicsMagick version string
4228
4229       -view <string>
4230              FlashPix viewing parameters
4231
4232       -virtual-pixel <method>
4233              specify contents of "virtual pixels"
4234
4235       -wave <amplitude>x<wavelength>
4236              alter an image along a sine wave
4237
4238       -white-point <x>,<y>
4239              chromaticity white point
4240
4241       -write <filename>
4242              write  an image sequence [convert, composite]
4243
4244              For a more detailed description of  each  option,  see  Options,
4245              above.
4246

GM DISPLAY

4248       Display is a machine architecture independent image processing and dis‐
4249       play program. It can display an image on any workstation screen running
4250       an  X server. Display can read and write many of the more popular image
4251       formats (e.g. JPEG, TIFF, PNM, Photo CD, etc.).
4252
4253       With display, you can perform these functions on an image:
4254
4255                o  load an image from a file
4256                o  display the next image
4257                o  display the former image
4258                o  display a sequence of images as a slide show
4259                o  write the image to a file
4260                o  print the image to a PostScript printer
4261                o  delete the image file
4262                o  create a Visual Image Directory
4263                o  select the image to display by its  thumbnail  rather  than
4264               name
4265                o  undo last image transformation
4266                o  copy a region of the image
4267                o  paste a region to the image
4268                o  restore the image to its original size
4269                o  refresh the image
4270                o  half the image size
4271                o  double the image size
4272                o  resize the image
4273                o  crop the image
4274                o  cut the image
4275                o  flop image in the horizontal direction
4276                o  flip image in the vertical direction
4277                o  rotate the image 90 degrees clockwise
4278                o  rotate the image 90 degrees counter-clockwise
4279                o  rotate the image
4280                o  shear the image
4281                o  roll the image
4282                o  trim the image edges
4283                o  invert the colors of the image
4284                o  vary the color brightness
4285                o  vary the color saturation
4286                o  vary the image hue
4287                o  gamma correct the image
4288                o  sharpen the image contrast
4289                o  dull the image contrast
4290                o  perform histogram equalization on the image
4291                o  perform histogram normalization on the image
4292                o  negate the image colors
4293                o  convert the image to grayscale
4294                o  set the maximum number of unique colors in the image
4295                o  reduce the speckles within an image
4296                o  eliminate peak noise from an image
4297                o  detect edges within the image
4298                o  emboss an image
4299                o  segment the image by color
4300                o  simulate an oil painting
4301                o  simulate a charcoal drawing
4302                o  annotate the image with text
4303                o  draw on the image
4304                o  edit an image pixel color
4305                o  edit the image matte information
4306                o  composite an image with another
4307                o  add a border to the image
4308                o  surround image with an ornamental border
4309                o  apply image processing techniques to a region of interest
4310                o  display information about the image
4311                o  zoom a portion of the image
4312                o  show a histogram of the image
4313                o  display image to background of a window
4314                o  set user preferences
4315                o  display information about this program
4316                o  discard all images and exit program
4317                o  change the level of magnification
4318                o   display images specified by a World Wide Web (WWW) uniform
4319               resource locator (URL)
4320
4321

EXAMPLES

4323       To scale an image of a cockatoo to exactly 640 pixels in width and  480
4324       pixels in height and position the window at location (200,200), use:
4325
4326           gm display -geometry 640x480+200+200! cockatoo.miff
4327
4328       To  display an image of a cockatoo without a border centered on a back‐
4329       drop, use:
4330
4331           gm display +borderwidth -backdrop cockatoo.miff
4332
4333       To tile a slate texture onto the root window, use:
4334
4335           gm display -size 1280x1024 -window root slate.png
4336
4337       To display a visual image directory of all your JPEG images, use:
4338
4339           gm display 'vid:*.jpg'
4340
4341       To display a MAP image that is 640 pixels in width and  480  pixels  in
4342       height with 256 colors, use:
4343
4344           gm display -size 640x480+256 cockatoo.map
4345
4346       To display an image of a cockatoo specified with a World Wide Web (WWW)
4347       uniform resource locator (URL), use:
4348
4349           gm display ftp://wizards.dupont.com/images/cockatoo.jpg
4350
4351       To display histogram of an image, use:
4352
4353           gm convert file.jpg HISTOGRAM:- | display -
4354

OPTIONS

4356       Options are processed in command line order. Any option you specify  on
4357       the  command  line  remains in effect until it is explicitly changed by
4358       specifying the option again with a different  effect.  For  example  to
4359       display  three  images,  the  first  with 32 colors, the second with an
4360       unlimited number of colors, and the third with only 16 colors, use:
4361
4362             gm display -colors 32 cockatoo.miff -noop duck.miff
4363                     -colors 16 macaw.miff
4364
4365       Display options can appear on the command line or in your  X  resources
4366       file.  See X(1). Options on the command line supersede values specified
4367       in your X resources file.
4368
4369       For a more detailed description of each option, see Options, above.
4370
4371
4372       -authenticate <string>
4373              decrypt image with this password
4374
4375       -backdrop
4376              display the image centered on a backdrop.
4377
4378       -background <color>
4379              the background color
4380
4381       -border <width>x<height>
4382              surround the image with a border of color
4383
4384       -bordercolor <color>
4385              the border color
4386
4387       -borderwidth <geometry>
4388              the border width
4389
4390       -cache <threshold>
4391              (This option has been replaced by the -limit option)
4392
4393       -colormap <type>
4394              define the colormap type
4395
4396       -colors <value>
4397              preferred number of colors in the image
4398
4399       -colorspace <value>
4400              the type of colorspace
4401
4402       -comment <string>
4403              annotate an image with a comment
4404
4405       -compress <type>
4406              the type of image compression
4407
4408       -contrast
4409              enhance or reduce the image contrast
4410
4411       -crop <width>x<height>{+-}<x>{+-}<y>{%}
4412              preferred size and location of the cropped image
4413
4414       -debug <events>
4415              enable debug printout
4416
4417       -define <key>{=<value>},...
4418              add coder/decoder specific options
4419
4420       -delay <1/100ths of a second>
4421              display the next image after pausing
4422
4423       -density <width>x<height>
4424              horizontal and vertical resolution in pixels of the image
4425
4426       -depth <value>
4427              depth of the image
4428
4429       -despeckle
4430              reduce the speckles within an image
4431
4432       -display <host:display[.screen]>
4433              specifies the X server to contact
4434
4435       -dispose <method>
4436              GIF disposal method
4437
4438       -dither
4439              apply Floyd/Steinberg error diffusion to the image
4440
4441       -edge <radius>
4442              detect edges within an image
4443
4444       -endian <type>
4445              specify endianness (MSB or LSB) of output image
4446
4447       -enhance
4448              apply a digital filter to enhance a noisy image
4449
4450       -filter <type>
4451              use this type of filter when resizing an image
4452
4453       -flip  create a "mirror image"
4454
4455       -flop  create a "mirror image"
4456
4457       -font <name>
4458              use this font when annotating the image with text
4459
4460       -foreground <color>
4461              define the foreground color
4462
4463       -frame <width>x<height>+<outer bevel width>+<inner bevel width>
4464              surround the image with an ornamental border
4465
4466       -gamma <value>
4467              level of gamma correction
4468
4469       -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@} {!}{<}{>}
4470              preferred size and location of the Image window.
4471
4472       -help  print usage instructions
4473
4474       -iconGeometry <geometry>
4475              specify the icon geometry
4476
4477       -iconic
4478              iconic animation
4479
4480       -immutable
4481              make image immutable
4482
4483       -interlace <type>
4484              the type of interlacing scheme
4485
4486       -label <name>
4487              assign a label to an image
4488
4489       -limit <type> <value>
4490              Disk, File, Map, or Memory resource limit
4491
4492       -log <string>
4493              Specify format for debug log
4494
4495       -magnify <factor>
4496              magnify the image
4497
4498       -map <type>
4499              display image using this type.
4500
4501       -matte store matte channel if the image has one
4502
4503       -mattecolor <color>
4504              specify the color to be used with the -frame option
4505
4506       -monochrome
4507              transform the image to black and white
4508
4509       -name  name an image
4510
4511       -negate
4512              replace every pixel with its complementary color
4513
4514       -noop  NOOP (no option)
4515
4516       -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
4517              size and location of an image canvas
4518
4519       +progress
4520              disable progress monitor and busy cursor
4521
4522       -quality <value>
4523              JPEG/MIFF/PNG compression level
4524
4525       -raise <width>x<height>
4526              lighten or darken image edges
4527
4528       -remote
4529              perform a X11 remote operation
4530
4531       -roll {+-}<x>{+-}<y>
4532              roll an image vertically or horizontally
4533
4534       -rotate <degrees>{<}{>}
4535              apply Paeth image rotation to the image
4536
4537       -sample <geometry>
4538              scale image using pixel sampling
4539
4540       -sampling-factor <horizontal_factor>x<vertical_factor>
4541              sampling  factors  used  by  JPEG  or  MPEG-2  encoder  and  YUV
4542              decoder/encoder.
4543
4544       -scenes <value-value>
4545              range of image scene numbers to read
4546
4547       -segment <cluster threshold>x<smoothing threshold>
4548              segment an image
4549
4550       -shared-memory
4551              use shared memory
4552
4553       -sharpen <radius>{x<sigma>}
4554              sharpen the image
4555
4556       -size <width>x<height>{+offset}
4557              width and height of the image
4558
4559       -text-font <name>
4560              font for writing fixed-width text
4561
4562       -texture <filename>
4563              name of texture to tile onto the image background
4564
4565       -title <string>
4566              assign title to displayed image [animate, display, montage]
4567
4568       -treedepth <value>
4569              tree depth for the color reduction algorithm
4570
4571       -trim  trim an image
4572
4573       -update <seconds>
4574               detect when image file is modified and redisplay.
4575
4576       -use-pixmap
4577              use the pixmap
4578
4579       -verbose
4580              print detailed information about the image
4581
4582       -version
4583              print GraphicsMagick version string
4584
4585       -visual <type>
4586              animate images using this X visual type
4587
4588       -window <id>
4589              make image the background of a window
4590
4591       -window-group
4592              specify the window group
4593
4594       -write <filename>
4595              write the image to a file [display]
4596
4597              For  a  more  detailed  description of each option, see Options,
4598              above.
4599
4600

MOUSE BUTTONS

4602       The effects of each button press is described below. Three buttons  are
4603       required.  If you have a two button mouse, button 1 and 3 are returned.
4604       Press ALT and button 3 to simulate button 2.
4605
4606       1       Press this button to map or unmap the Command widget . See  the
4607              next section for more information about the Command widget.
4608
4609       2       Press and drag to define a region of the image to magnify.
4610
4611       3        Press  and drag to choose from a select set of display(1) com‐
4612              mands. This button behaves differently if the image  being  dis‐
4613              played  is a visual image directory. Choose a particular tile of
4614              the directory and press this button and drag to select a command
4615              from a pop-up menu.  Choose from these menu items:
4616
4617                  Open
4618                  Next
4619                  Former
4620                  Delete
4621                  Update
4622
4623
4624              If  you  choose  Open, the image represented by the tile is dis‐
4625              played.  To return to the visual image  directory,  choose  Next
4626              from  the  Command  widget  (refer to Command Widget).  Next and
4627              Former moves to the next or former  image  respectively.  Choose
4628              Delete to delete a particular image tile. Finally, choose Update
4629              to synchronize all the image tiles with their respective images.
4630              See montage and miff for more details.
4631

COMMAND WIDGET

4633       The Command widget lists a number of sub-menus and commands. They are
4634
4635           File
4636
4637           Open...
4638           Next
4639           Former
4640           Select...
4641           Save...
4642           Print...
4643           Delete...
4644           Canvas...
4645           Visual Directory...
4646           Quit
4647
4648
4649
4650           Edit
4651
4652           Undo
4653           Redo
4654           Cut
4655           Copy
4656           Paste
4657
4658
4659
4660           View
4661
4662           Half Size
4663           Original Size
4664           Double Size
4665           Resize...
4666           Apply
4667           Refresh
4668           Restore
4669
4670
4671
4672           Transform
4673
4674           Crop
4675           Chop
4676           Flop
4677           Flip
4678           Rotate Right
4679           Rotate Left
4680           Rotate...
4681           Shear...
4682           Roll...
4683           Trim Edges
4684
4685
4686
4687           Enhance
4688
4689           Hue...
4690           Saturation...
4691           Brightness...
4692           Gamma...
4693           Spiff...
4694           Dull
4695           Equalize
4696           Normalize
4697           Negate
4698           GRAYscale
4699           Quantize...
4700
4701
4702
4703           Effects
4704
4705           Despeckle
4706           Emboss
4707           Reduce Noise
4708           Add Noise
4709           Sharpen...
4710           Blur...
4711           Threshold...
4712           Edge Detect...
4713           Spread...
4714           Shade...
4715           Raise...
4716           Segment...
4717
4718
4719
4720           F/X
4721
4722           Solarize...
4723           Swirl...
4724           Implode...
4725           Wave...
4726           Oil Paint...
4727           Charcoal Draw...
4728
4729
4730
4731           Image Edit
4732
4733           Annotate...
4734           Draw...
4735           Color...
4736           Matte...
4737           Composite...
4738           Add Border...
4739           Add Frame...
4740           Comment...
4741           Launch...
4742           Region of Interest...
4743
4744
4745
4746           Miscellany
4747
4748           Image Info
4749           Zoom Image
4750           Show Preview...
4751           Show Histogram
4752           Show Matte
4753           Background...
4754           Slide Show
4755           Preferences...
4756
4757
4758
4759           Help
4760
4761           Overview
4762           Browse Documentation
4763           About Display
4764
4765
4766
4767       Menu  items  with  a indented triangle have a sub-menu. They are repre‐
4768       sented above as the indented items. To access a sub-menu item, move the
4769       pointer  to  the appropriate menu and press button 1 and drag. When you
4770       find the desired sub-menu item, release the button and the  command  is
4771       executed.  Move the pointer away from the sub-menu if you decide not to
4772       execute a particular command.
4773

KEYBOARD ACCELERATORS

4775       Accelerators are one or two key presses that effect a  particular  com‐
4776       mand.  The keyboard accelerators that display understands is:
4777
4778           Ctl+O     Press to load an image from a file.
4779           space     Press to display the next image.
4780
4781       If  the  image is a multi-paged document such as a PostScript document,
4782       you can skip ahead several pages by preceding this command with a  num‐
4783       ber.   For  example to display the fourth page beyond the current page,
4784       press 4space.
4785
4786           backspace Press to display the former image.
4787
4788       If the image is a multi-paged document such as a  PostScript  document,
4789       you can skip behind several pages by preceding this command with a num‐
4790       ber.  For example to display the  fourth  page  preceding  the  current
4791       page, press 4n.
4792
4793           Ctl-S    Press to save the image to a file.
4794           Ctl-P    Press to print the image to a
4795                    PostScript printer.
4796           Ctl-D    Press to delete an image file.
4797           Ctl-N    Press to create a blank canvas.
4798           Ctl-Q    Press to discard all images and exit program.
4799           Ctl+Z    Press to undo last image transformation.
4800           Ctl+R    Press to redo last image transformation.
4801           Ctl-X    Press to cut a region of
4802                    the image.
4803           Ctl-C    Press to copy a region of
4804                    the image.
4805           Ctl-V    Press to paste a region to
4806                    the image.
4807           <        Press to halve the image size.
4808           .        Press to return to the original image size.
4809           >        Press to double the image size.
4810           %        Press to resize the image to a width and height
4811                    you specify.
4812           Cmd-A    Press to make any image transformations
4813                    permanent.
4814                    By default, any image size transformations are
4815                    applied to the original image to create the
4816                    image displayed on the X server.  However, the
4817                    transformations are not permanent (i.e. the
4818                    original image does not change size only the
4819                    X image does). For example, if you press ">"
4820                    the X image will appear to double in size, but
4821                    the original image will in fact remain the same
4822                    size.  To force the original image to double in
4823                    size, press ">" followed by "Cmd-A".
4824           @        Press to refresh the image window.
4825           C        Press to crop the image.
4826           [        Press to chop the image.
4827           H        Press to flop image in the horizontal direction.
4828           V        Press to flip image in the vertical direction.
4829           /        Press to rotate the image 90 degrees clockwise.
4830           \        Press to rotate the image 90 degrees
4831                    counter-clockwise.
4832           *        Press to rotate the image
4833                    the number of degrees you specify.
4834           S        Press to shear the image the number of degrees
4835                    you specify.
4836           R        Press to roll the image.
4837           T        Press to trim the image edges.
4838           Shft-H   Press to vary the color hue.
4839           Shft-S   Press to vary the color saturation.
4840           Shft-L   Press to vary the image brightness.
4841           Shft-G   Press to gamma correct the image.
4842           Shft-C   Press to spiff up the image contrast.
4843           Shft-Z   Press to dull the image contrast.
4844           =        Press to perform histogram equalization on
4845                    the image.
4846           Shft-N   Press to perform histogram normalization on
4847                    the image.
4848           Shft-~   Press to negate the colors of the image.
4849           .        Press to convert the image colors to gray.
4850           Shft-#   Press to set the maximum number of unique
4851                    colors in the image.
4852           F2       Press to reduce the speckles in an image.
4853           F2       Press to emboss an image.
4854           F4       Press to eliminate peak noise from an image.
4855           F5       Press to add noise to an image.
4856           F6       Press to sharpen an image.
4857           F7       Press to blur image an image.
4858           F8       Press to threshold the image.
4859           F9       Press to detect edges within an image.
4860           F10      Press to displace pixels by a random amount.
4861           F11      Press to shade the image using a distant light
4862                    source.
4863           F12      Press to lighten or darken image edges to
4864                    create a 3-D effect.
4865           F13      Press to segment the image by color.
4866           Meta-S   Press to swirl image pixels about the center.
4867           Meta-I   Press to implode image pixels about the center.
4868           Meta-W   Press to alter an image along a sine wave.
4869           Meta-P   Press to simulate an oil painting.
4870           Meta-C   Press to simulate a charcoal drawing.
4871           Alt-X    Press to composite the image
4872                    with another.
4873           Alt-A    Press to annotate the image with text.
4874           Alt-D    Press to draw a line on the image.
4875           Alt-P    Press to edit an image pixel color.
4876           Alt-M    Press to edit the image matte information.
4877           Alt-X    Press to composite the image with another.
4878           Alt-A    Press to add a border to the image.
4879           Alt-F    Press to add a ornamental frame to the image.
4880           Alt-Shft-!   Press to add an image comment.
4881           Ctl-A    Press to apply image processing techniques to a
4882                    region of interest.
4883           Shft-?   Press to display information about the image.
4884           Shft-+   Press to map the zoom image window.
4885           Shft-P   Press to preview an image enhancement, effect,
4886                    or f/x.
4887           F1       Press to display helpful information about
4888                    the "display" utility.
4889           Find     Press to browse documentation about
4890                    GraphicsMagick.
4891           1-9      Press to change the level of magnification.
4892
4893       Use the arrow keys to move the image one pixel up, down, left, or right
4894       within the magnify window. Be sure to first map the magnify  window  by
4895       pressing button 2.
4896
4897       Press ALT and one of the arrow keys to trim off one pixel from any side
4898       of the image.
4899

X RESOURCES

4901       Display options can appear on the command line or in  your  X  resource
4902       file.  Options on the command line supersede values specified in your X
4903       resource file. See X(1) for more information on X resources.
4904
4905       Most display options have a corresponding X resource. In addition, dis‐
4906       play uses the following X resources:
4907
4908       background (class Background)
4909               Specifies the preferred color to use for the Image window back‐
4910              ground. The default is #ccc.
4911
4912       borderColor (class BorderColor)
4913               Specifies the preferred color to use for the Image window  bor‐
4914              der. The default is #ccc.
4915
4916       borderWidth (class BorderWidth)
4917                Specifies  the width in pixels of the image window border. The
4918              default is 2.
4919
4920       browseCommand (class browseCommand)
4921               Specifies the name of the  preferred  browser  when  displaying
4922              GraphicsMagick documentation. The default is netscape %s.
4923
4924       confirmExit (class ConfirmExit)
4925                Display  pops  up  a dialog box to confirm exiting the program
4926              when exiting the program. Set this resource  to  False  to  exit
4927              without a confirmation.
4928
4929       displayGamma (class DisplayGamma)
4930                Specifies  the  gamma of the X server.  You can apply separate
4931              gamma values to the red, green, and blue channels of  the  image
4932              with   a   gamma   value  list  delineated  with  slashes  (i.e.
4933              1.7/2.3/1.2).  The default is 2.2.
4934
4935       displayWarnings (class DisplayWarnings)
4936               Display pops up a dialog box whenever a warning message occurs.
4937              Set this resource to False to ignore warning messages.
4938
4939       font (class FontList)
4940                Specifies the name of the preferred font to use in normal for‐
4941              matted text.  The default is 14 point Helvetica.
4942
4943       font[1-9] (class Font[1-9])
4944               Specifies the name of the preferred font to use when annotating
4945              the  image  window with text. The default fonts are fixed, vari‐
4946              able, 5x8, 6x10, 7x13bold, 8x13bold, 9x15bold, 10x20, and 12x24.
4947
4948       foreground (class Foreground)
4949               Specifies the preferred color to use for text within the  image
4950              window.  The default is black.
4951
4952       gammaCorrect (class gammaCorrect)
4953                This  resource,  if  true,  will lighten or darken an image of
4954              known gamma to match the gamma of the display (see resource dis‐
4955              playGamma). The default is True.
4956
4957       geometry (class Geometry)
4958                Specifies the preferred size and position of the image window.
4959              It is not necessarily obeyed by all window managers.
4960
4961              Offsets, if present, are handled in X(1) style.   A  negative  x
4962              offset  is  measured  from  the  right edge of the screen to the
4963              right edge of the icon, and a negative y offset is measured from
4964              the bottom edge of the screen to the bottom edge of the icon.
4965
4966       iconGeometry (class IconGeometry)
4967                Specifies  the  preferred size and position of the application
4968              when iconified.  It is not necessarily obeyed by all window man‐
4969              agers.
4970
4971              Offsets,  if present, are handled in the same manner as in class
4972              Geometry.
4973
4974       iconic (class Iconic)
4975               This resource indicates that you would prefer that the applica‐
4976              tion's windows initially not be visible as if the windows had be
4977              immediately iconified by you. Window managers may choose not  to
4978              honor the application's request.
4979
4980       magnify (class Magnify)
4981                specifies  an  integral  factor  by  which the image should be
4982              enlarged. The default is 3.  This value only affects the  magni‐
4983              fication  window which is invoked with button number 3 after the
4984              image is displayed.
4985
4986       matteColor (class MatteColor)
4987               Specify the color of windows. It is used for the backgrounds of
4988              windows,  menus,  and  notices. A 3D effect is achieved by using
4989              highlight and shadow colors derived  from  this  color.  Default
4990              value: #697B8F.
4991
4992       name (class Name)
4993                This resource specifies the name under which resources for the
4994              application should be found. This resource is  useful  in  shell
4995              aliases  to  distinguish  between invocations of an application,
4996              without resorting to creating links to alter the executable file
4997              name. The default is the application name.
4998
4999       pen[1-9] (class Pen[1-9])
5000                Specifies the color of the preferred font to use when annotat‐
5001              ing the image window with text. The default  colors  are  black,
5002              blue, green, cyan, gray, red, magenta, yellow, and white.
5003
5004       printCommand (class PrintCommand)
5005               This command is executed whenever Print is issued.  In general,
5006              it is the command to print PostScript to your  printer.  Default
5007              value: lp -c -s %i.
5008
5009       sharedMemory (class SharedMemory)
5010                This  resource  specifies  whether  display should attempt use
5011              shared memory for pixmaps. GraphicsMagick must be compiled  with
5012              shared  memory support, and the display must support the MIT-SHM
5013              extension. Otherwise, this resource is ignored. The  default  is
5014              True.
5015
5016       textFont (class textFont)
5017               Specifies the name of the preferred font to use in fixed (type‐
5018              writer style) formatted text. The default is 14 point Courier.
5019
5020       title (class Title)
5021               This resource specifies the title to be used for the image win‐
5022              dow.  This  information is sometimes used by a window manager to
5023              provide a header identifying the  window.  The  default  is  the
5024              image file name.
5025
5026       undoCache (class UndoCache)
5027               Specifies, in mega-bytes, the amount of memory in the undo edit
5028              cache.  Each time you modify the image it is saved in  the  undo
5029              edit  cache as long as memory is available. You can subsequently
5030              undo one or more of these transformations.  The  default  is  16
5031              Megabytes.
5032
5033       usePixmap (class UsePixmap)
5034               Images are maintained as a XImage by default. Set this resource
5035              to True to utilize a server Pixmap instead. This option is  use‐
5036              ful  if  your image exceeds the dimensions of your server screen
5037              and you intend to pan the image. Panning  is  much  faster  with
5038              Pixmaps  than  with  a XImage. Pixmaps are considered a precious
5039              resource, use them with discretion.
5040
5041              To set the geometry of the Magnify or Pan  or  window,  use  the
5042              geometry  resource.  For example, to set the Pan window geometry
5043              to 256x256, use:
5044
5045                  gm display.pan.geometry: 256x256
5046

IMAGE LOADING

5048       To select an image to display, choose Open of the  File  sub-menu  from
5049       the  Command widget. A file browser is displayed.  To choose a particu‐
5050       lar image file, move the pointer to the filename and press any  button.
5051       The  filename  is  copied to the text window. Next, press Open or press
5052       the RETURN key.  Alternatively,  you  can  type  the  image  file  name
5053       directly  into the text window. To descend directories, choose a direc‐
5054       tory name and press the button twice  quickly.  A  scrollbar  allows  a
5055       large  list  of  filenames  to  be moved through the viewing area if it
5056       exceeds the size of the list area.
5057
5058       You can trim the list of file names by using shell globbing characters.
5059       For example, type *.jpg to list only files that end with .jpg.
5060
5061       To  select  your image from the X server screen instead of from a file,
5062       Choose Grab of the Open widget.
5063

VISUAL IMAGE DIRECTORY

5065       To create a Visual Image Directory, choose Visual Directory of the File
5066       sub-menu from the Command widget . A file browser is displayed. To cre‐
5067       ate a Visual Image Directory from all the images in the current  direc‐
5068       tory,  press Directory or press the RETURN key.  Alternatively, you can
5069       select a set of image names by using  shell  globbing  characters.  For
5070       example,  type  *.jpg  to  include  only  files  that end with .jpg. To
5071       descend directories, choose a directory name and press the button twice
5072       quickly.  A  scrollbar  allows  a  large  list of filenames to be moved
5073       through the viewing area if it exceeds the size of the list area.
5074
5075       After you select a set of files, they are turned  into  thumbnails  and
5076       tiled  onto a single image. Now move the pointer to a particular thumb‐
5077       nail and press button 3 and drag. Finally, select Open. The image  rep‐
5078       resented  by  the  thumbnail is displayed at its full size. Choose Next
5079       from the File sub-menu of the Command widget to return  to  the  Visual
5080       Image Directory.
5081

IMAGE CUTTING

5083       Note  that  cut  information  for image window is not retained for col‐
5084       ormapped X server visuals (e.g.  StaticColor,  StaticColor,  GRAYScale,
5085       PseudoColor).   Correct  cutting  behavior  may  require a TrueColor or
5086       DirectColor visual or a Standard Colormap.
5087
5088       To begin, press choose Cut of the Edit sub-menu from the  Command  wid‐
5089       get. Alternatively, press F3 in the image window.
5090
5091       A  small window appears showing the location of the cursor in the image
5092       window. You are now in cut mode. In cut mode, the  Command  widget  has
5093       these options:
5094
5095           Help
5096           Dismiss
5097
5098
5099       To  define  a  cut  region,  press button 1 and drag. The cut region is
5100       defined by a highlighted rectangle that expands or contracts as it fol‐
5101       lows  the  pointer. Once you are satisfied with the cut region, release
5102       the button.  You are now in rectify mode. In rectify mode, the  Command
5103       widget has these options:
5104
5105           Cut
5106           Help
5107           Dismiss
5108
5109
5110       You  can  make adjustments by moving the pointer to one of the cut rec‐
5111       tangle corners, pressing a button, and dragging. Finally, press Cut  to
5112       commit  your copy region. To exit without cutting the image, press Dis‐
5113       miss.
5114

IMAGE COPYING

5116       To begin, press choose Copy of the Edit sub-menu from the Command  wid‐
5117       get. Alternatively, press F4 in the image window.
5118
5119       A  small window appears showing the location of the cursor in the image
5120       window. You are now in copy mode. In copy mode, the Command widget  has
5121       these options:
5122
5123           Help
5124           Dismiss
5125
5126
5127       To  define  a  copy region, press button 1 and drag. The copy region is
5128       defined by a highlighted rectangle that expands or contracts as it fol‐
5129       lows  the pointer. Once you are satisfied with the copy region, release
5130       the button.  You are now in rectify mode. In rectify mode, the  Command
5131       widget has these options:
5132
5133           Copy
5134           Help
5135           Dismiss
5136
5137
5138       You  can make adjustments by moving the pointer to one of the copy rec‐
5139       tangle corners, pressing a button, and dragging. Finally, press Copy to
5140       commit  your copy region. To exit without copying the image, press Dis‐
5141       miss.
5142

IMAGE PASTING

5144       To begin, press choose Paste of the Edit sub-menu from the Command wid‐
5145       get. Alternatively, press F5 in the image window.
5146
5147       A  small window appears showing the location of the cursor in the image
5148       window. You are now in Paste mode. To exit immediately, press  Dismiss.
5149       In Paste mode, the Command widget has these options:
5150
5151           Operators
5152
5153           over
5154           in
5155           out
5156           atop
5157           xor
5158           plus
5159           minus
5160           add
5161           subtract
5162           difference
5163           multiply
5164           bumpmap
5165           replace
5166
5167           Help
5168           Dismiss
5169
5170
5171       Choose a composite operation from the Operators sub-menu of the Command
5172       widget. How each operator behaves is described below. image  window  is
5173       the  image  currently displayed on your X server and image is the image
5174       obtained with the File Browser widget.
5175
5176       over    The result is the union of the two  image  shapes,  with  image
5177              obscuring image window in the region of overlap.
5178
5179       in       The  result  is simply image cut by the shape of image window.
5180              None of the image data of image window is in the result.
5181
5182       out     The resulting image is image with the shape of image window cut
5183              out.
5184
5185       atop     The  result  is  the  same  shape  as image window, with image
5186              obscuring image window where the image shapes overlap. Note this
5187              differs  from  over  because  the portion of image outside image
5188              window's shape does not appear in the result.
5189
5190       xor     The result is the image data from both image and  image  window
5191              that is outside the overlap region. The overlap region is blank.
5192
5193       plus    The result is just the sum of the image data. Output values are
5194              cropped to the maximum value (no overflow).  This  operation  is
5195              independent of the matte channels.
5196
5197       minus    The  result of image - image window, with underflow cropped to
5198              zero. The matte channel is ignored (set to opaque,  full  cover‐
5199              age).
5200
5201       add      The  result  of  image  + image window, with overflow wrapping
5202              around (mod MaxRGB+1).
5203
5204       subtract
5205               The result of image - image  window,  with  underflow  wrapping
5206              around  (mod  MaxRGB+1).  The  add and subtract operators can be
5207              used to perform reversible transformations.
5208
5209       difference
5210               The result of abs(image - image window).  This  is  useful  for
5211              comparing two very similar images.
5212
5213       multiply
5214               The result of image * image window. This is useful for the cre‐
5215              ation of drop-shadows.
5216
5217       bumpmap
5218               The result of image window shaded by window.
5219
5220       replace
5221              The resulting image is image window replaced with  image.   Here
5222              the matte information is ignored.
5223
5224              The  image  compositor requires a matte, or alpha channel in the
5225              image for some operations. This extra channel usually defines  a
5226              mask  which  represents a sort of a cookie-cutter for the image.
5227              This is the case when matte is 255 (full  coverage)  for  pixels
5228              inside  the shape, zero outside, and between zero and 255 on the
5229              boundary. If image does not have a matte channel, it is initial‐
5230              ized  with  0  for any pixel matching in color to pixel location
5231              (0,0), otherwise 255. See Matte Editing for a method of defining
5232              a matte channel.
5233
5234              Note that matte information for image window is not retained for
5235              colormapped X server  visuals  (e.g.  StaticColor,  StaticColor,
5236              GrayScale,   PseudoColor).   Correct  compositing  behavior  may
5237              require a TrueColor or DirectColor visual  or  a  Standard  Col‐
5238              ormap.
5239
5240              Choosing  a composite operator is optional. The default operator
5241              is replace.  However, you must choose a  location  to  composite
5242              your  image and press button 1. Press and hold the button before
5243              releasing and an outline of the image will appear  to  help  you
5244              identify your location.
5245
5246              The  actual  colors  of  the pasted image is saved. However, the
5247              color that appears in image window may be different.  For  exam‐
5248              ple,  on  a  monochrome screen image window will appear black or
5249              white even though your pasted image may have many colors. If the
5250              image  is saved to a file it is written with the correct colors.
5251              To assure the correct colors are saved in the final  image,  any
5252              PseudoClass  image is promoted to DirectClass.  To force a Pseu‐
5253              doClass image to remain PseudoClass, use -colors.
5254

IMAGE CROPPING

5256       To begin, press choose Crop of the Transform submenu from  the  Command
5257       widget. Alternatively, press [ in the image window.
5258
5259       A  small window appears showing the location of the cursor in the image
5260       window. You are now in crop mode. In crop mode, the Command widget  has
5261       these options:
5262
5263           Help
5264           Dismiss
5265
5266
5267       To  define  a  cropping  region,  press button 1 and drag. The cropping
5268       region is defined by a highlighted rectangle that expands or  contracts
5269       as  it  follows  the  pointer. Once you are satisfied with the cropping
5270       region, release the button. You are now in  rectify  mode.  In  rectify
5271       mode, the Command widget has these options:
5272
5273           Crop
5274           Help
5275           Dismiss
5276
5277
5278       You  can  make adjustments by moving the pointer to one of the cropping
5279       rectangle corners, pressing a button, and dragging. Finally, press Crop
5280       to  commit  your  cropping  region. To exit without cropping the image,
5281       press Dismiss.
5282

IMAGE CHOPPING

5284       An image is chopped interactively. There is no command line argument to
5285       chop an image. To begin, choose Chop of the Transform sub-menu from the
5286       Command widget. Alternatively, press ] in the Image window.
5287
5288       You are now in Chop mode. To exit immediately, press Dismiss.  In  Chop
5289       mode, the Command widget has these options:
5290
5291           Direction
5292
5293           horizontal
5294           vertical
5295
5296           Help
5297           Dismiss
5298
5299
5300       If  the  you choose the horizontal direction (this is the default), the
5301       area of the image between the two horizontal endpoints of the chop line
5302       is  removed.  Otherwise, the area of the image between the two vertical
5303       endpoints of the chop line is removed.
5304
5305       Select a location within the image window to begin your chop, press and
5306       hold  any  button.  Next,  move  the pointer to another location in the
5307       image.  As you move a line will connect the initial  location  and  the
5308       pointer. When you release the button, the area within the image to chop
5309       is determined by which direction you choose from the Command widget.
5310
5311       To cancel the image chopping, move the pointer  back  to  the  starting
5312       point of the line and release the button.
5313

IMAGE ROTATION

5315       Press  the  /  key  to  rotate  the image 90 degrees or \ to rotate -90
5316       degrees.  To  interactively  choose  the  degree  of  rotation,  choose
5317       Rotate...   of the Transform submenu from the Command Widget.  Alterna‐
5318       tively, press * in the image window.
5319
5320       A small horizontal line is drawn next to the pointer. You  are  now  in
5321       rotate  mode.  To  exit immediately, press Dismiss. In rotate mode, the
5322       Command widget has these options:
5323
5324           Pixel Color
5325
5326           black
5327           blue
5328           cyan
5329           green
5330           gray
5331           red
5332           magenta
5333           yellow
5334           white
5335           Browser...
5336
5337           Direction
5338
5339           horizontal
5340           vertical
5341
5342           Help
5343           Dismiss
5344
5345
5346       Choose a background color from the  Pixel  Color  sub-menu.  Additional
5347       background  colors  can  be  specified  with the color browser. You can
5348       change the menu colors by setting the X resources pen1 through pen9.
5349
5350       If you choose the color browser and press  Grab,  you  can  select  the
5351       background  color  by  moving  the  pointer to the desired color on the
5352       screen and press any button.
5353
5354       Choose a point in the image window and  press  this  button  and  hold.
5355       Next,  move the pointer to another location in the image. As you move a
5356       line connects the initial location and the pointer.  When  you  release
5357       the  button, the degree of image rotation is determined by the slope of
5358       the line you just drew. The slope is  relative  to  the  direction  you
5359       choose from the Direction sub-menu of the Command widget.
5360
5361       To  cancel  the  image  rotation, move the pointer back to the starting
5362       point of the line and release the button.
5363

IMAGE ANNOTATION

5365       An image is annotated interactively. There is no command line  argument
5366       to  annotate an image. To begin, choose Annotate of the Image Edit sub-
5367       menu from the Command widget. Alternatively, press a in the image  win‐
5368       dow.
5369
5370       A  small window appears showing the location of the cursor in the image
5371       window. You are now in annotate mode. To exit immediately,  press  Dis‐
5372       miss.  In annotate mode, the Command widget has these options:
5373
5374
5375       Font Name
5376
5377
5378       fixed
5379
5380       variable
5381
5382       5x8
5383
5384       6x10
5385
5386       7x13bold
5387
5388       8x13bold
5389
5390       9x15bold
5391
5392       10x20
5393
5394       12x24
5395
5396       Browser...
5397
5398
5399       Font Color
5400
5401
5402       black
5403
5404       blue
5405
5406       cyan
5407
5408       green
5409
5410       gray
5411
5412       red
5413
5414       magenta
5415
5416       yellow
5417
5418       white
5419
5420       transparent
5421
5422       Browser...
5423
5424
5425       Box Color
5426
5427
5428       black
5429
5430       blue
5431
5432       cyan
5433
5434       green
5435
5436       gray
5437
5438       red
5439
5440       magenta
5441
5442       yellow
5443
5444       white
5445
5446       transparent
5447
5448       Browser...
5449
5450
5451       Rotate Text
5452
5453
5454       -90
5455
5456       -45
5457
5458       -30
5459
5460       0
5461
5462       30
5463
5464       45
5465
5466       90
5467
5468       180
5469
5470       Dialog...
5471
5472
5473       Help
5474
5475       Dismiss
5476
5477
5478       Choose  a  font name from the Font Name sub-menu. Additional font names
5479       can be specified with the font browser. You can change the  menu  names
5480       by setting the X resources font1 through font9.
5481
5482       Choose  a font color from the Font Color sub-menu. Additional font col‐
5483       ors can be specified with the color browser. You can  change  the  menu
5484       colors by setting the X resources pen1 through pen9.
5485
5486       If you select the color browser and press Grab, you can choose the font
5487       color by moving the pointer to the desired  color  on  the  screen  and
5488       press any button.
5489
5490       If  you choose to rotate the text, choose Rotate Text from the menu and
5491       select an angle. Typically you will only want to  rotate  one  line  of
5492       text at a time. Depending on the angle you choose, subsequent lines may
5493       end up overwriting each other.
5494
5495       Choosing a font and its color is optional. The default  font  is  fixed
5496       and  the default color is black. However, you must choose a location to
5497       begin entering text and press a button. An  underscore  character  will
5498       appear  at  the location of the pointer. The cursor changes to a pencil
5499       to indicate you are in text mode. To exit immediately, press Dismiss.
5500
5501       In text mode, any key presses will display the character at  the  loca‐
5502       tion  of  the  underscore and advance the underscore cursor. Enter your
5503       text and once completed press Apply to finish your image annotation. To
5504       correct  errors  press  BACK  SPACE.  To delete an entire line of text,
5505       press DELETE.  Any text that exceeds the boundaries of the image window
5506       is automatically continued onto the next line.
5507
5508       The  actual  color you request for the font is saved in the image. How‐
5509       ever, the color that appears in your Image window may be different. For
5510       example,  on  a  monochrome  screen the text will appear black or white
5511       even if you choose the color red as the font color. However, the  image
5512       saved  to  a  file with -write is written with red lettering. To assure
5513       the correct color text in the final image,  any  PseudoClass  image  is
5514       promoted  to DirectClass (see miff(5)). To force a PseudoClass image to
5515       remain PseudoClass, use -colors.
5516

IMAGE COMPOSITING

5518       An image composite is created interactively. There is no  command  line
5519       argument to composite an image. To begin, choose Composite of the Image
5520       Edit from the Command widget. Alternatively, press x in the Image  win‐
5521       dow.
5522
5523       First  a  popup  window  is  displayed requesting you to enter an image
5524       name.  Press Composite, Grab or type a file name. Press Cancel  if  you
5525       choose  not to create a composite image. When you choose Grab, move the
5526       pointer to the desired window and press any button.
5527
5528       If the Composite image does not have any  matte  information,  you  are
5529       informed  and  the file browser is displayed again. Enter the name of a
5530       mask image. The image is typically grayscale and the same size  as  the
5531       composite  image.  If  the  image  is not grayscale, it is converted to
5532       grayscale and the resulting intensities are used as matte information.
5533
5534       A small window appears showing the location of the cursor in the  image
5535       window.  You are now in composite mode. To exit immediately, press Dis‐
5536       miss.  In composite mode, the Command widget has these options:
5537
5538
5539       Operators
5540
5541
5542       over
5543
5544       in
5545
5546       out
5547
5548       atop
5549
5550       xor
5551
5552       plus
5553
5554       minus
5555
5556       add
5557
5558       subtract
5559
5560       difference
5561
5562       bumpmap
5563
5564       replace
5565
5566
5567       Blend
5568
5569       Displace
5570
5571       Help
5572
5573       Dismiss
5574
5575
5576       Choose a composite operation from the Operators sub-menu of the Command
5577       widget.  How  each operator behaves is described below. image window is
5578       the image currently displayed on your X server and image is  the  image
5579       obtained
5580
5581       over     The  result  is  the union of the two image shapes, with image
5582              obscuring image window in the region of overlap.
5583
5584       in      The result is simply image cut by the shape  of  image  window.
5585              None of the image data of image window is in the result.
5586
5587       out     The resulting image is image with the shape of image window cut
5588              out.
5589
5590       atop    The result is the  same  shape  as  image  window,  with  image
5591              obscuring image window where the image shapes overlap. Note this
5592              differs from over because the portion  of  image  outside  image
5593              window's shape does not appear in the result.
5594
5595       xor      The  result is the image data from both image and image window
5596              that is outside the overlap region. The overlap region is blank.
5597
5598       plus    The result is just the sum of the image data. Output values are
5599              cropped  to  255 (no overflow). This operation is independent of
5600              the matte channels.
5601
5602       minus   The result of image - image window, with underflow  cropped  to
5603              zero. The matte channel is ignored (set to 255, full coverage).
5604
5605       add      The  result  of  image  + image window, with overflow wrapping
5606              around (mod 256).
5607
5608       subtract
5609               The result of image - image  window,  with  underflow  wrapping
5610              around  (mod 256). The add and subtract operators can be used to
5611              perform reversible transformations.
5612
5613       difference
5614               The result of abs(image - image window).  This  is  useful  for
5615              comparing two very similar images.
5616
5617       bumpmap
5618               The result of image window shaded by window.
5619
5620       replace
5621                The resulting image is image window replaced with image.  Here
5622              the matte information is ignored.
5623
5624              The image compositor requires a matte, or alpha channel  in  the
5625              image  for some operations. This extra channel usually defines a
5626              mask which represents a sort of a cookie-cutter for  the  image.
5627              This  is  the  case when matte is 255 (full coverage) for pixels
5628              inside the shape, zero outside, and between zero and 255 on  the
5629              boundary. If image does not have a matte channel, it is initial‐
5630              ized with 0 for any pixel matching in color  to  pixel  location
5631              (0,0), otherwise 255. See Matte Editing for a method of defining
5632              a matte channel.
5633
5634              If you choose blend, the composite operator becomes  over.   The
5635              image  matte channel percent transparency is initialized to fac‐
5636              tor.  The image window is  initialized  to  (100-factor).  Where
5637              factor is the value you specify in the Dialog widget.
5638
5639              Displace  shifts  the  image pixels as defined by a displacement
5640              map.  With this option, image is used  as  a  displacement  map.
5641              Black,  within  the displacement map, is a maximum positive dis‐
5642              placement. White is a maximum negative displacement  and  middle
5643              gray  is  neutral.  The  displacement is scaled to determine the
5644              pixel shift. By default, the displacement applies  in  both  the
5645              horizontal  and  vertical  directions.  However,  if you specify
5646              mask, image is the horizontal X displacement and mask the verti‐
5647              cal Y displacement.
5648
5649              Note that matte information for image window is not retained for
5650              colormapped X server visuals  (e.g.   StaticColor,  StaticColor,
5651              GrayScale,   PseudoColor).   Correct  compositing  behavior  may
5652              require a TrueColor or DirectColor visual  or  a  Standard  Col‐
5653              ormap.
5654
5655              Choosing  a composite operator is optional. The default operator
5656              is replace.  However, you must choose a  location  to  composite
5657              your  image and press button 1. Press and hold the button before
5658              releasing and an outline of the image will appear  to  help  you
5659              identify your location.
5660
5661              The  actual colors of the composite image is saved. However, the
5662              color that appears in image window may be different.  For  exam‐
5663              ple,  on  a  monochrome screen Image window will appear black or
5664              white even though your composited image may have many colors. If
5665              the image is saved to a file it is written with the correct col‐
5666              ors. To assure the correct colors are saved in the final  image,
5667              any PseudoClass image is promoted to DirectClass (see miff).  To
5668              force a PseudoClass image to remain PseudoClass, use -colors.
5669

COLOR EDITING

5671       Changing the the color of a set of pixels is  performed  interactively.
5672       There  is  no  command  line argument to edit a pixel. To begin, choose
5673       Color from the Image Edit submenu  of  the  Command  widget.   Alterna‐
5674       tively, press c in the image window.
5675
5676       A  small window appears showing the location of the cursor in the image
5677       window. You are now in color edit mode. To exit immediately, press Dis‐
5678       miss.  In color edit mode, the Command widget has these options:
5679
5680
5681       Method
5682
5683
5684       point
5685
5686       replace
5687
5688       floodfill
5689
5690       reset
5691
5692
5693       Pixel Color
5694
5695
5696       black
5697
5698       blue
5699
5700       cyan
5701
5702       green
5703
5704       gray
5705
5706       red
5707
5708       magenta
5709
5710       yellow
5711
5712       white
5713
5714       Browser...
5715
5716
5717       Border Color
5718
5719
5720       black
5721
5722       blue
5723
5724       cyan
5725
5726       green
5727
5728       gray
5729
5730       red
5731
5732       magenta
5733
5734       yellow
5735
5736       white
5737
5738       Browser...
5739
5740
5741       Fuzz
5742
5743
5744       0
5745
5746       2
5747
5748       4
5749
5750       8
5751
5752       16
5753           Dialog...
5754
5755
5756       Undo
5757
5758       Help
5759
5760       Dismiss
5761
5762
5763       Choose  a  color editing method from the Method sub-menu of the Command
5764       widget. The point method recolors any pixel selected with  the  pointer
5765       unless  the  button  is released. The replace method recolors any pixel
5766       that matches the color of the pixel you select  with  a  button  press.
5767       Floodfill  recolors  any  pixel that matches the color of the pixel you
5768       select with a button press and is  a  neighbor.   Whereas  filltoborder
5769       changes  the  matte  value of any neighbor pixel that is not the border
5770       color.  Finally reset changes the entire image to the designated color.
5771
5772       Next, choose a pixel color from the Pixel  Color  sub-menu.  Additional
5773       pixel  colors  can  be specified with the color browser. You can change
5774       the menu colors by setting the X resources pen1 through pen9.
5775
5776       Now press button 1 to select a pixel within the Image window to  change
5777       its  color.  Additional  pixels  may  be recolored as prescribed by the
5778       method you choose. additional pixels by increasing the Delta value.
5779
5780       If the Magnify widget is mapped, it can be helpful in positioning  your
5781       pointer  within  the  image  (refer to button 2). Alternatively you can
5782       select a pixel to recolor from within  the  Magnify  widget.  Move  the
5783       pointer  to  the  Magnify widget and position the pixel with the cursor
5784       control keys. Finally, press a button to recolor the selected pixel (or
5785       pixels).
5786
5787       The actual color you request for the pixels is saved in the image. How‐
5788       ever, the color that appears in your Image window may be different. For
5789       example,  on  a  monochrome screen the pixel will appear black or white
5790       even if you choose the color red as the pixel color. However, the image
5791       saved  to  a file with -write is written with red pixels. To assure the
5792       correct color text in the final image, any PseudoClass  image  is  pro‐
5793       moted  to  DirectClass  To  force a PseudoClass image to remain Pseudo‐
5794       Class, use -colors.
5795

MATTE EDITING

5797       Matte information within an image is useful for some operations such as
5798       image compositing. This extra channel usually defines a mask which rep‐
5799       resents a sort of a cookie-cutter for the image. This is the case  when
5800       matte is 255 (full coverage) for pixels inside the shape, zero outside,
5801       and between zero and 255 on the boundary.
5802
5803       Setting the matte information in an image is done interactively.  There
5804       is no command line argument to edit a pixel. To begin, and choose Matte
5805       of the Image Edit sub-menu from the Command widget.
5806
5807       Alternatively, press m in the image window.
5808
5809       A small window appears showing the location of the cursor in the  image
5810       window. You are now in matte edit mode. To exit immediately, press Dis‐
5811       miss.  In matte edit mode, the Command widget has these options:
5812
5813
5814       Method
5815
5816
5817       point
5818
5819       replace
5820
5821       floodfill
5822
5823       reset
5824
5825
5826       Border Color
5827
5828
5829       black
5830
5831       blue
5832
5833       cyan
5834
5835       green
5836
5837       gray
5838
5839       red
5840
5841       magenta
5842
5843       yellow
5844
5845       white
5846
5847       Browser...
5848
5849
5850       Fuzz
5851
5852
5853       0
5854
5855       2
5856
5857       4
5858
5859       8
5860
5861       16
5862           Dialog...
5863
5864
5865       Matte
5866
5867       Undo
5868
5869       Help
5870
5871       Dismiss
5872
5873       Choose a matte editing method from the Method sub-menu of  the  Command
5874       widget.  The  point  method  changes  the  matte value of the any pixel
5875       selected with the pointer until the button  is  released.  The  replace
5876       method  changes  the matte value of any pixel that matches the color of
5877       the pixel you select with a button press. Floodfill changes  the  matte
5878       value  of any pixel that matches the color of the pixel you select with
5879       a button press and is a neighbor.  Whereas  filltoborder  recolors  any
5880       neighbor  pixel that is not the border color. Finally reset changes the
5881       entire image to the designated matte value.  Choose Matte Value  and  a
5882       dialog  appears  requesting a matte value.  Enter a value between 0 and
5883       255. This value is assigned as the matte value of the selected pixel or
5884       pixels.   Now, press any button to select a pixel within the Image win‐
5885       dow to change its matte value. You can change the matte value of  addi‐
5886       tional  pixels  by increasing the Delta value. The Delta value is first
5887       added then subtracted from the red,  green,  and  blue  of  the  target
5888       color. Any pixels within the range also have their matte value updated.
5889       If the Magnify widget is mapped, it can be helpful in positioning  your
5890       pointer  within  the  image  (refer to button 2). Alternatively you can
5891       select a pixel to change the matte value from within the  Magnify  wid‐
5892       get.   Move  the  pointer  to the Magnify widget and position the pixel
5893       with the cursor control keys. Finally, press a  button  to  change  the
5894       matte  value  of  the selected pixel (or pixels).  Matte information is
5895       only valid in a DirectClass image. Therefore, any PseudoClass image  is
5896       promoted to DirectClass. Note that matte information for PseudoClass is
5897       not retained for colormapped X server visuals (e.g. StaticColor,  Stat‐
5898       icColor, GrayScale, PseudoColor) unless you immediately save your image
5899       to a file (refer to Write). Correct matte editing behavior may  require
5900       a TrueColor or DirectColor visual or a Standard Colormap.
5901

IMAGE DRAWING

5903       An image is drawn upon interactively. There is no command line argument
5904       to draw on an image. To begin, choose Draw of the Image  Edit  sub-menu
5905       from the Command widget.  Alternatively, press d in the image window.
5906
5907       The  cursor changes to a crosshair to indicate you are in draw mode. To
5908       exit immediately, press Dismiss. In draw mode, the Command  widget  has
5909       these options:
5910
5911
5912       Primitive
5913
5914
5915       point
5916
5917       line
5918
5919       rectangle
5920
5921       fill rectangle
5922
5923       circle
5924
5925       fill circle
5926
5927       ellipse
5928
5929       fill ellipse
5930
5931       polygon
5932
5933       fill polygon
5934
5935
5936       Color
5937
5938
5939       black
5940
5941       blue
5942
5943       cyan
5944
5945       green
5946
5947       gray
5948
5949       red
5950
5951       magenta
5952
5953       yellow
5954
5955       white
5956
5957       transparent
5958
5959       Browser...
5960
5961
5962       Stipple
5963
5964
5965       Brick
5966
5967       Diagonal
5968
5969       Scales
5970
5971       Vertical
5972
5973       Wavy
5974
5975       Translucent
5976
5977       Opaque
5978
5979       Open...
5980
5981
5982       Width
5983
5984
5985       1
5986
5987       2
5988
5989       4
5990
5991       8
5992
5993       16
5994           Dialog...
5995
5996
5997       Undo
5998
5999       Help
6000
6001       Dismiss
6002
6003       Choose a drawing primitive from the Primitive sub-menu.
6004
6005       Next,  choose a color from the Color sub-menu. Additional colors can be
6006       specified with the color browser. You can change  the  menu  colors  by
6007       setting  the  X  resources  pen1  through  pen9.  The transparent color
6008       updates the image matte channel and is useful for image compositing.
6009
6010       If you choose the color browser and press  Grab,  you  can  select  the
6011       primitive  color  by  moving  the  pointer  to the desired color on the
6012       screen and press any button. The transparent color  updates  the  image
6013       matte channel and is useful for image compositing.
6014
6015       Choose a stipple, if appropriate, from the Stipple sub-menu. Additional
6016       stipples can be specified with the file browser. Stipples obtained from
6017       the file browser must be on disk in the X11 bitmap format.
6018
6019       Choose a line width, if appropriate, from the Width sub-menu. To choose
6020       a specific width select the Dialog widget.
6021
6022       Choose a point in the image window and press button 1 and  hold.  Next,
6023       move  the pointer to another location in the image. As you move, a line
6024       connects the initial location and the pointer.  When  you  release  the
6025       button,  the  image  is  updated  with the primitive you just drew. For
6026       polygons, the image is updated when you press and  release  the  button
6027       without moving the pointer.
6028
6029       To cancel image drawing, move the pointer back to the starting point of
6030       the line and release the button.
6031

REGION OF INTEREST

6033       To begin, press choose Region of Interest of the Pixel  Transform  sub-
6034       menu from the Command widget.  Alternatively, press R in the image win‐
6035       dow.
6036
6037       A small window appears showing the location of the cursor in the  image
6038       window.  You  are now in region of interest mode. In region of interest
6039       mode, the Command widget has these options:
6040
6041
6042       Help
6043
6044       Dismiss
6045
6046
6047       To define a region of interest, press button 1 and drag. The region  of
6048       interest  is  defined  by  a highlighted rectangle that expands or con‐
6049       tracts as it follows the pointer.  Once  you  are  satisfied  with  the
6050       region  of  interest, release the button. You are now in apply mode. In
6051       apply mode the Command widget has these options:
6052
6053
6054       File
6055
6056
6057       Save...
6058
6059       Print...
6060
6061
6062       Edit
6063
6064
6065       Undo
6066
6067       Redo
6068
6069
6070       Transform
6071
6072
6073       Flip
6074
6075       Flop
6076
6077       Rotate Right
6078
6079       Rotate Left
6080
6081
6082       Enhance
6083
6084
6085       Hue...
6086
6087       Saturation...
6088
6089       Brightness...
6090
6091       Gamma...
6092
6093       Spiff
6094
6095       Dull
6096
6097       Equalize
6098
6099       Normalize
6100
6101       Negate
6102
6103       GRAYscale
6104
6105       Quantize...
6106
6107
6108       Effects
6109
6110
6111       Despeckle
6112
6113       Emboss
6114
6115       Reduce Noise
6116
6117       Add Noise
6118
6119       Sharpen...
6120
6121       Blur...
6122
6123       Threshold...
6124
6125       Edge Detect...
6126
6127       Spread...
6128
6129       Shade...
6130
6131       Raise...
6132
6133       Segment...
6134
6135
6136
6137
6138       F/X
6139
6140
6141       Solarize...
6142
6143       Swirl...
6144
6145       Implode...
6146
6147       Wave...
6148
6149       Oil Paint
6150
6151       Charcoal Draw...
6152
6153
6154
6155
6156       Miscellany
6157
6158
6159       Image Info
6160
6161       Zoom Image
6162
6163       Show Preview...
6164
6165       Show Histogram
6166
6167       Show Matte
6168
6169
6170       Help
6171
6172       Dismiss
6173
6174
6175       You can make adjustments to  the  region  of  interest  by  moving  the
6176       pointer  to  one of the rectangle corners, pressing a button, and drag‐
6177       ging. Finally, choose an image processing technique  from  the  Command
6178       widget.  You  can  choose  more  than one image processing technique to
6179       apply to an area. Alternatively, you can move the  region  of  interest
6180       before applying another image processing technique. To exit, press Dis‐
6181       miss.
6182

IMAGE PANNING

6184       When an image exceeds the width or height of the X server screen,  dis‐
6185       play  maps  a small panning icon. The rectangle within the panning icon
6186       shows the area that is currently displayed in the the image window.  To
6187       pan  about  the image, press any button and drag the pointer within the
6188       panning icon.  The pan rectangle moves with the pointer and  the  image
6189       window  is  updated to reflect the location of the rectangle within the
6190       panning icon. When you have selected the area of the image you wish  to
6191       view, release the button.
6192
6193       Use  the arrow keys to pan the image one pixel up, down, left, or right
6194       within the image window.
6195
6196       The panning icon is withdrawn if the image  becomes  smaller  than  the
6197       dimensions of the X server screen.
6198

USER PREFERENCES

6200       Preferences  affect the default behavior of display(1). The preferences
6201       are either true or false and are stored in your home directory as .dis‐
6202       playrc:
6203
6204                display image centered on a backdrop"
6205
6206
6207                    This  backdrop covers the entire workstation screen and is
6208                    useful for hiding other X window  activity  while  viewing
6209                    the  image.  The color of the backdrop is specified as the
6210                    background color. Refer to X Resources for details.
6211                confirm on program exit"
6212
6213
6214                    Ask for a confirmation before exiting the display(1)  pro‐
6215                    gram.
6216                correct image for display gamma"
6217
6218
6219                    If  the image has a known gamma, the gamma is corrected to
6220                    match that of the  X  server  (see  the  X  Resource  dis‐
6221                    playGamma).
6222                display warning messages"
6223
6224
6225                    Display any warning messages.
6226                apply Floyd/Steinberg error diffusion to image"
6227
6228
6229                    The basic strategy of dithering is to trade intensity res‐
6230                    olution for spatial resolution by averaging  the  intensi‐
6231                    ties  of  several neighboring pixels.  Images which suffer
6232                    from  severe  contouring  when  reducing  colors  can   be
6233                    improved with this preference.
6234                use a shared colormap for colormapped X visuals"
6235
6236
6237                    This  option only applies when the default X server visual
6238                    is PseudoColor or GRAYScale. Refer  to  -visual  for  more
6239                    details.  By  default, a shared colormap is allocated. The
6240                    image shares colors with other X clients.  Some image col‐
6241                    ors  could  be approximated, therefore your image may look
6242                    very different than intended. Otherwise the  image  colors
6243                    appear exactly as they are defined. However, other clients
6244                    may go technicolor when the image colormap is installed.
6245                display images as an X server pixmap"
6246
6247
6248                    Images are maintained as a XImage  by  default.  Set  this
6249                    resource  to True to utilize a server Pixmap instead. This
6250                    option is useful if your image exceeds the  dimensions  of
6251                    your  server  screen and you intend to pan the image. Pan‐
6252                    ning is much faster  with  Pixmaps  than  with  a  XImage.
6253                    Pixmaps  are considered a precious resource, use them with
6254                    discretion.
6255
6256

GM IDENTIFY

6258       Identify describes the format and characteristics of one or more  image
6259       files.  It  will also report if an image is incomplete or corrupt.  The
6260       information displayed includes the scene number,  the  file  name,  the
6261       width and height of the image, whether the image is colormapped or not,
6262       the number of colors in the image, the number of bytes  in  the  image,
6263       the  format  of  the image (JPEG, PNM, etc.), and finally the number of
6264       seconds it took to read and process the image. An example  line  output
6265       from identify follows:
6266
6267           images/aquarium.miff 640x480 PseudoClass 256c
6268                  308135b MIFF 1s
6269
6270       If  -verbose  is set, expect additional output including any image com‐
6271       ment:
6272
6273
6274           Image: images/aquarium.miff
6275           class: PseudoClass
6276           colors: 256
6277           signature: eb5dca81dd93ae7e6ffae99a527eb5dca8...
6278           matte: False
6279           geometry: 640x480
6280              depth: 8
6281           bytes: 308135
6282           format: MIFF
6283           comments:
6284           Imported from MTV raster image: aquarium.mtv
6285
6286       For some formats, additional format-specific information about the file
6287       will be written if the -debug coder or -debug all option is used.
6288

IDENTIFY OPTIONS

6290       Options  are processed in command line order. Any option you specify on
6291       the command line remains in effect for the set  of  images  immediately
6292       following,  until the set is terminated by the appearance of any option
6293       or -noop.
6294
6295       For a more detailed description of each option, see Options, above.
6296
6297
6298       -authenticate <string>
6299              decrypt image with this password
6300
6301       -cache <threshold>
6302              (This option has been replaced by the -limit option)
6303
6304       -debug <events>
6305              enable debug printout
6306
6307       -define <key>{=<value>},...
6308              add coder/decoder specific options
6309
6310       -density <width>x<height>
6311              horizontal and vertical resolution in pixels of the image
6312
6313       -depth <value>
6314              depth of the image
6315
6316       -format <string>
6317              output formatted image characteristics
6318
6319       -help  print usage instructions
6320
6321       -interlace <type>
6322              the type of interlacing scheme
6323
6324       -limit <type> <value>
6325              Disk, File, Map, or Memory resource limit
6326
6327       -log <string>
6328              Specify format for debug log
6329
6330       -ping  efficiently determine image characteristics
6331
6332       -sampling-factor <horizontal_factor>x<vertical_factor>
6333              sampling  factors  used  by  JPEG  or  MPEG-2  encoder  and  YUV
6334              decoder/encoder.
6335
6336       -size <width>x<height>{+offset}
6337              width and height of the image
6338
6339       -verbose
6340              print detailed information about the image
6341
6342       -version
6343              print GraphicsMagick version string
6344
6345              For  a  more  detailed  description of each option, see Options,
6346              above.
6347
6348

GM IMPORT

6350       Import reads an image from any visible window on an X server  and  out‐
6351       puts  it  as an image file. You can capture a single window, the entire
6352       screen, or any rectangular portion of  the  screen.   Use  display  for
6353       redisplay,  printing, editing, formatting, archiving, image processing,
6354       etc. of the captured image.
6355
6356       The target window can be specified by id, name, or may be  selected  by
6357       clicking  the  mouse  in  the desired window. If you press a button and
6358       then drag, a rectangle will form which expands  and  contracts  as  the
6359       mouse  moves.  To save the portion of the screen defined by the rectan‐
6360       gle, just release the button. The keyboard bell is  rung  once  at  the
6361       beginning of the screen capture and twice when it completes.
6362

EXAMPLES

6364       To  select an X window or an area of the screen with the mouse and save
6365       it in the MIFF image format to a file entitled window.miff, use:
6366
6367           gm import window.miff
6368
6369       To select an X window or an area of the screen with the mouse and  save
6370       it  in  the  Encapsulated PostScript format to include in another docu‐
6371       ment, use:
6372
6373           gm import figure.eps
6374
6375       To capture the entire X server screen in the JPEG  image  format  in  a
6376       file entitled root.jpeg, without using the mouse, use:
6377
6378           gm import -window root root.jpeg
6379
6380       To  capture  the 512x256 area at the upper right corner of the X server
6381       screen in the PNG image format in a well-compressed file entitled  cor‐
6382       ner.png, without using the mouse,  use:
6383
6384           gm import -window root -crop 512x256-0+0 -quality 90
6385                  corner.png
6386

OPTIONS

6388       Options  are processed in command line order. Any option you specify on
6389       the command line remains in effect until it is  explicitly  changed  by
6390       specifying the option again with a different effect.
6391
6392       Import  options  can  appear on the command line or in your X resources
6393       file. See X(1). Options on the command line supersede values  specified
6394       in your X resources file.
6395
6396       For a more detailed description of each option, see Options, above.
6397
6398
6399       -bordercolor <color>
6400              the border color
6401
6402       -cache <threshold>
6403              (This option has been replaced by the -limit option)
6404
6405       -colors <value>
6406              preferred number of colors in the image
6407
6408       -colorspace <value>
6409              the type of colorspace
6410
6411       -comment <string>
6412              annotate an image with a comment
6413
6414       -crop <width>x<height>{+-}<x>{+-}<y>{%}
6415              preferred size and location of the cropped image
6416
6417       -debug <events>
6418              enable debug printout
6419
6420       -define <key>{=<value>},...
6421              add coder/decoder specific options
6422
6423       -delay <1/100ths of a second>
6424              display the next image after pausing
6425
6426       -density <width>x<height>
6427              horizontal and vertical resolution in pixels of the image
6428
6429       -depth <value>
6430              depth of the image
6431
6432       -descend
6433              obtain image by descending window hierarchy
6434
6435       -display <host:display[.screen]>
6436              specifies the X server to contact
6437
6438       -dispose <method>
6439              GIF disposal method
6440
6441       -dither
6442              apply Floyd/Steinberg error diffusion to the image
6443
6444       -encoding <type>
6445              specify the text encoding
6446
6447       -endian <type>
6448              specify endianness (MSB or LSB) of output image
6449
6450       -frame include the X window frame in the imported image
6451
6452       -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@} {!}{<}{>}
6453              preferred size and location of the Image window.
6454
6455       -help  print usage instructions
6456
6457       -interlace <type>
6458              the type of interlacing scheme
6459
6460       -label <name>
6461              assign a label to an image
6462
6463       -limit <type> <value>
6464              Disk, File, Map, or Memory resource limit
6465
6466       -log <string>
6467              Specify format for debug log
6468
6469       -monochrome
6470              transform the image to black and white
6471
6472       -negate
6473              replace every pixel with its complementary color
6474
6475       -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
6476              size and location of an image canvas
6477
6478       -pause <seconds>
6479              pause between snapshots [import]
6480
6481       -ping  efficiently determine image characteristics
6482
6483       -pointsize <value>
6484              pointsize of the PostScript, OPTION1, or TrueType font
6485
6486       -quality <value>
6487              JPEG/MIFF/PNG compression level
6488
6489       -resize <width>x<height>{%}{@}{!}{<}{>}
6490              resize an image
6491
6492       -rotate <degrees>{<}{>}
6493              apply Paeth image rotation to the image
6494
6495       -sampling-factor <horizontal_factor>x<vertical_factor>
6496              sampling  factors  used  by  JPEG  or  MPEG-2  encoder  and  YUV
6497              decoder/encoder.
6498
6499       -scene <value>
6500              set scene number
6501
6502       -screen
6503              specify the screen to capture
6504
6505       -silent
6506              operate silently
6507
6508       -snaps <value>
6509              number of screen snapshots
6510
6511       -transparent <color>
6512              make this color transparent within the image
6513
6514       -trim  trim an image
6515
6516       -verbose
6517              print detailed information about the image
6518
6519       -version
6520              print GraphicsMagick version string
6521
6522              For a more detailed description of  each  option,  see  Options,
6523              above.
6524
6525

GM MOGRIFY

6527       Mogrify  transforms  an image or a sequence of images. These transforms
6528       include image scaling, image rotation,  color  reduction,  and  others.
6529       Each  transmogrified image overwrites the corresponding original image,
6530       unless an option such as -format causes the output filename to be  dif‐
6531       ferent from the input filename.
6532
6533       The  graphics  formats  supported by mogrify are listed in GraphicsMag‐
6534       ick(1).
6535

EXAMPLES

6537       To convert all the TIFF files in a particular directory to JPEG, use:
6538
6539           gm mogrify -format jpeg *.tiff
6540
6541       To convert a directory full of JPEG images to thumbnails, use:
6542
6543           gm mogrify -size 120x120 *.jpg -resize 120x120 +profile "*"
6544
6545       In this example, '-size 120x120' gives a hint to the JPEG decoder  that
6546       the  images  are  going to be downscaled to 120x120, allowing it to run
6547       faster by avoiding returning full-resolution images  to  GraphicsMagick
6548       for  the subsequent resizing operation.  The output images.  It will be
6549       scaled so its largest dimension is  120  pixels.   The  that  might  be
6550       present in the input and aren't needed in the thumbnails.
6551
6552       To  scale an image of a cockatoo to exactly 640 pixels in width and 480
6553       pixels in height, use:
6554
6555           gm mogrify -resize 640x480! cockatoo.miff
6556

OPTIONS

6558       Options are processed in command line order. Any option you specify  on
6559       the  command line remains in effect for the set of images that follows,
6560       until the set is terminated by the appearance of any option or -noop.
6561
6562       For a more detailed description of each option, see Options, above.
6563
6564
6565       -affine <matrix>
6566              drawing transform matrix
6567
6568       -antialias
6569              remove pixel aliasing
6570
6571       -authenticate <string>
6572              decrypt image with this password
6573
6574       -background <color>
6575              the background color
6576
6577       -blue-primary <x>,<y>
6578              blue chromaticity primary point
6579
6580       -blur <radius>{x<sigma>}
6581              blur the image with a Gaussian operator
6582
6583       -border <width>x<height>
6584              surround the image with a border of color
6585
6586       -bordercolor <color>
6587              the border color
6588
6589       -cache <threshold>
6590              (This option has been replaced by the -limit option)
6591
6592       -channel <type>
6593              the type of channel
6594
6595       -charcoal <factor>
6596              simulate a charcoal drawing
6597
6598       -colorize <value>
6599              colorize the image with the pen color
6600
6601       -colors <value>
6602              preferred number of colors in the image
6603
6604       -colorspace <value>
6605              the type of colorspace
6606
6607       -comment <string>
6608              annotate an image with a comment
6609
6610       -compose <operator>
6611              the type of image composition
6612
6613       -compress <type>
6614              the type of image compression
6615
6616       -contrast
6617              enhance or reduce the image contrast
6618
6619       -convolve <kernel>
6620              convolve image with the specified convolution kernel
6621
6622       -crop <width>x<height>{+-}<x>{+-}<y>{%}
6623              preferred size and location of the cropped image
6624
6625       -cycle <amount>
6626              displace image colormap by amount
6627
6628       -debug <events>
6629              enable debug printout
6630
6631       -define <key>{=<value>},...
6632              add coder/decoder specific options
6633
6634       -delay <1/100ths of a second>
6635              display the next image after pausing
6636
6637       -density <width>x<height>
6638              horizontal and vertical resolution in pixels of the image
6639
6640       -depth <value>
6641              depth of the image
6642
6643       -despeckle
6644              reduce the speckles within an image
6645
6646       -display <host:display[.screen]>
6647              specifies the X server to contact
6648
6649       -dispose <method>
6650              GIF disposal method
6651
6652       -dither
6653              apply Floyd/Steinberg error diffusion to the image
6654
6655       -draw <string>
6656              annotate an image with one or more graphic primitives
6657
6658       -edge <radius>
6659              detect edges within an image
6660
6661       -emboss <radius>
6662              emboss an image
6663
6664       -encoding <type>
6665              specify the text encoding
6666
6667       -endian <type>
6668              specify endianness (MSB or LSB) of output image
6669
6670       -enhance
6671              apply a digital filter to enhance a noisy image
6672
6673       -equalize
6674              perform histogram equalization to the image
6675
6676       -fill <color>
6677              color to use when filling a graphic primitive
6678
6679       -filter <type>
6680              use this type of filter when resizing an image
6681
6682       -flip  create a "mirror image"
6683
6684       -flop  create a "mirror image"
6685
6686       -font <name>
6687              use this font when annotating the image with text
6688
6689       -format <type>
6690              the image format type
6691
6692       -frame <width>x<height>+<outer bevel width>+<inner bevel width>
6693              surround the image with an ornamental border
6694
6695       -fuzz <distance>{%}
6696              colors within this distance are considered equal
6697
6698       -gamma <value>
6699              level of gamma correction
6700
6701       -Gaussian <radius>{x<sigma>}
6702              blur the image with a Gaussian operator
6703
6704       -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@} {!}{<}{>}
6705              preferred size and location of the Image window.
6706
6707       -gravity <type>
6708              direction primitive  gravitates to when annotating the image.
6709
6710       -green-primary <x>,<y>
6711              green chromaticity primary point
6712
6713       -help  print usage instructions
6714
6715       -implode <factor>
6716              implode image pixels about the center
6717
6718       -interlace <type>
6719              the type of interlacing scheme
6720
6721       -label <name>
6722              assign a label to an image
6723
6724       -lat <width>x<height>{+-}<offset>{%}
6725              perform local adaptive thresholding
6726
6727       -level <black_point>{,<gamma>}{,<white_point>}{%}
6728              adjust the level of image contrast
6729
6730       -limit <type> <value>
6731              Disk, File, Map, or Memory resource limit
6732
6733       -linewidth
6734              the line width for subsequent draw operations
6735
6736       -list <type>
6737              the type of list
6738
6739       -log <string>
6740              Specify format for debug log
6741
6742       -loop <iterations>
6743              add Netscape loop extension to your GIF animation
6744
6745       -map <filename>
6746              choose a particular set of colors from this image
6747
6748       -mask <filename>
6749              Specify a clipping mask
6750
6751       -matte store matte channel if the image has one
6752
6753       -mattecolor <color>
6754              specify the color to be used with the -frame option
6755
6756       -median <radius>
6757              apply a median filter to the image
6758
6759       -modulate brightness[,saturation[,hue]]
6760              vary the brightness, saturation, and hue of an image
6761
6762       -monochrome
6763              transform the image to black and white
6764
6765       -negate
6766              replace every pixel with its complementary color
6767
6768       -noise <radius|type>
6769              add or reduce noise in an image
6770
6771       -noop  NOOP (no option)
6772
6773       -normalize
6774              transform image to span the full range of color values
6775
6776       -opaque <color>
6777              change this color to the pen color within the image
6778
6779       -operator channel operator rvalue[%]
6780              apply a mathematical or bitwise operator to an image channel
6781
6782       -ordered-dither <channeltype> <NxN>
6783              ordered dither the image
6784
6785       -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
6786              size and location of an image canvas
6787
6788       -paint <radius>
6789              simulate an oil painting
6790
6791       -pen <color>
6792              (This option has been replaced by the -fill option)
6793
6794       -pointsize <value>
6795              pointsize of the PostScript, OPTION1, or TrueType font
6796
6797       -profile <filename>
6798              add ICM, IPTC, or generic profile  to image
6799
6800       -quality <value>
6801              JPEG/MIFF/PNG compression level
6802
6803       -raise <width>x<height>
6804              lighten or darken image edges
6805
6806       -random-threshold <channeltype> <LOWxHIGH>
6807              random threshold the image
6808
6809       -red-primary <x>,<y>
6810              red chromaticity primary point
6811
6812       -region <width>x<height>{+-}<x>{+-}<y>
6813              apply options to a portion of the image
6814
6815       -render
6816              render vector operations
6817
6818       -resample <horizontal>x<vertical>
6819              Resample image to specified horizontal and vertical resolution
6820
6821       -resize <width>x<height>{%}{@}{!}{<}{>}
6822              resize an image
6823
6824       -roll {+-}<x>{+-}<y>
6825              roll an image vertically or horizontally
6826
6827       -rotate <degrees>{<}{>}
6828              apply Paeth image rotation to the image
6829
6830       -sample <geometry>
6831              scale image using pixel sampling
6832
6833       -sampling-factor <horizontal_factor>x<vertical_factor>
6834              sampling  factors  used  by  JPEG  or  MPEG-2  encoder  and  YUV
6835              decoder/encoder.
6836
6837       -scale <geometry>
6838              scale the image.
6839
6840       -scene <value>
6841              set scene number
6842
6843       -segment <cluster threshold>x<smoothing threshold>
6844              segment an image
6845
6846       -shade <azimuth>x<elevation>
6847              shade the image using a distant light source
6848
6849       -sharpen <radius>{x<sigma>}
6850              sharpen the image
6851
6852       -shave <width>x<height>{%}
6853              shave pixels from the image edges
6854
6855       -shear <x degrees>x<y degrees>
6856              shear the image along the X or Y axis
6857
6858       -size <width>x<height>{+offset}
6859              width and height of the image
6860
6861       -solarize <factor>
6862              negate all pixels above the threshold level
6863
6864       -spread <amount>
6865              displace image pixels by a random amount
6866
6867       -stroke <color>
6868              color to use when stroking a graphic primitive
6869
6870       -strokewidth <value>
6871              set the stroke width
6872
6873       -swirl <degrees>
6874              swirl image pixels about the center
6875
6876       -texture <filename>
6877              name of texture to tile onto the image background
6878
6879       -threshold <value>{<green>,<blue>,<opacity>}{%}
6880              threshold the image
6881
6882       -tile <filename>
6883              tile image when filling a graphic primitive
6884
6885       -transform
6886              transform the image
6887
6888       -transparent <color>
6889              make this color transparent within the image
6890
6891       -treedepth <value>
6892              tree depth for the color reduction algorithm
6893
6894       -trim  trim an image
6895
6896       -type <type>
6897              the image type
6898
6899       -units <type>
6900              the units of image resolution
6901
6902       -unsharp <radius>{x<sigma>}{+<amount>}{+<threshold>}
6903              sharpen the image with an unsharp mask operator
6904
6905       -verbose
6906              print detailed information about the image
6907
6908       -version
6909              print GraphicsMagick version string
6910
6911       -view <string>
6912              FlashPix viewing parameters
6913
6914       -virtual-pixel <method>
6915              specify contents of "virtual pixels"
6916
6917       -wave <amplitude>x<wavelength>
6918              alter an image along a sine wave
6919
6920       -white-point <x>,<y>
6921              chromaticity white point
6922
6923              For  a  more  detailed  description of each option, see Options,
6924              above.
6925
6926

GM MONTAGE

6928       montage creates a composite image by combining several separate images.
6929       The  images are tiled on the composite image with the name of the image
6930       optionally appearing just below the individual tile.
6931
6932       The composite image is constructed in the following manner. First, each
6933       image  specified on the command line, except for the last, is scaled to
6934       fit the maximum tile size. The maximum tile size by default is 120x120.
6935       It  can  be  modified  with  the  -geometry  command line argument or X
6936       resource. See Options for more information on command  line  arguments.
6937       See  X(1)  for  more information on X resources.  Note that the maximum
6938       tile size need not be a square.
6939
6940       Next the composite image is initialized with the color specified by the
6941       -background  command  line argument or X resource. The width and height
6942       of the composite image is determined by the title specified, the  maxi‐
6943       mum  tile  size, the number of tiles per row, the tile border width and
6944       height, the image border width, and the label  height.  The  number  of
6945       tiles  per  row  specifies how many images are to appear in each row of
6946       the composite image. The default is to have 5 tiles in each row  and  4
6947       tiles  in  each column of the composite.  A specific value is specified
6948       with -tile. The tile border width and  height,  and  the  image  border
6949       width  defaults  to the value of the X resource -borderwidth. It can be
6950       changed with the -borderwidth or -geometry command line argument  or  X
6951       resource.  The  label height is determined by the font you specify with
6952       the -font command line argument or X resource. If you do not specify  a
6953       font,  a  font  is  chosen that allows the name of the image to fit the
6954       maximum width of a tiled area.  The label colors is determined  by  the
6955       -background  and  -fill command line argument or X resource. Note, that
6956       if the background and pen colors are the same, labels will not appear.
6957
6958       Initially, the composite image title is placed at the  top  if  one  is
6959       specified  (refer to -fill). Next, each image is set onto the composite
6960       image, surrounded by its border color,  with  its  name  centered  just
6961       below  it. The individual images are left-justified within the width of
6962       the tiled area.  The order of the images is the same as they appear  on
6963       the  command  line  unless  the images have a scene keyword. If a scene
6964       number is specified in each image, then the images are tiled  onto  the
6965       composite  in  the order of their scene number. Finally, the last argu‐
6966       ment on the command line is the name assigned to the  composite  image.
6967       By  default,  the image is written in the MIFF format and can be viewed
6968       or printed with display(1).
6969
6970
6971       Note, that if the number of tiles exceeds the default number of  20  (5
6972       per  row,  4  per column), more than one composite image is created. To
6973       ensure a single image is produced, use -tile to increase the number  of
6974       tiles to meet or exceed the number of input images.
6975
6976       Finally,  to  create one or more empty spaces in the sequence of tiles,
6977       use the "NULL:" image format.
6978
6979       Note, a composite MIFF image displayed to  an  X  server  with  display
6980       behaves  differently  than other images. You can think of the composite
6981       as a visual image directory. Choose a particular tile of the  composite
6982       and press a button to display it. See display(1) and miff(5)
6983

EXAMPLES

6985       To  create  a  montage  of  a cockatoo, a parrot, and a hummingbird and
6986       write it to a file called birds, use:
6987
6988           gm montage cockatoo.miff parrot.miff hummingbird.miff
6989                   birds.miff
6990
6991       To tile several bird images so that they are  at  most  256  pixels  in
6992       width  and  192 pixels in height, surrounded by a red border, and sepa‐
6993       rated by 10 pixels of background color, use:
6994
6995           gm montage -geometry 256x192+10+10 -bordercolor red
6996                   birds.* montage.miff
6997
6998       To create an unlabeled parrot image, 640 by 480 pixels, and  surrounded
6999       by a border of black, use:
7000
7001           gm montage -geometry 640x480 -bordercolor black
7002                   -label "" parrot.miff bird.miff
7003
7004       To create an image of an eagle with a textured background, use:
7005
7006           gm montage -texture bumps.jpg eagle.jpg eagle.png
7007
7008       To  join  several  GIF  images together without any extraneous graphics
7009       (e.g.  no label, no shadowing, no surrounding tile frame), use:
7010
7011           gm montage +frame +shadow +label -tile 5x1
7012                   -geometry 50x50+0+0 *.png joined.png
7013

OPTIONS

7015       Any option you specify on the command line remains in  effect  for  the
7016       group  of  images  following  it,  until the group is terminated by the
7017       appearance of any option or -noop.  For example, to make a  montage  of
7018       three  images,  the  first with 32 colors, the second with an unlimited
7019       number of colors, and the third with only 16 colors, use:
7020
7021
7022            gm montage -colors 32 cockatoo.1 -noop cockatoo.2
7023                    -colors 16 cockatoo.3 cockatoos.miff
7024
7025       For a more detailed description of each option, see Options, above.
7026
7027
7028       -adjoin
7029              join images into a single multi-image file
7030
7031       -authenticate <string>
7032              decrypt image with this password
7033
7034       -background <color>
7035              the background color
7036
7037       -blue-primary <x>,<y>
7038              blue chromaticity primary point
7039
7040       -blur <radius>{x<sigma>}
7041              blur the image with a Gaussian operator
7042
7043       -bordercolor <color>
7044              the border color
7045
7046       -borderwidth <geometry>
7047              the border width
7048
7049       -cache <threshold>
7050              (This option has been replaced by the -limit option)
7051
7052       -chop <width>x<height>{+-}<x>{+-}<y>{%}
7053              remove pixels from the interior of an image
7054
7055       -colors <value>
7056              preferred number of colors in the image
7057
7058       -colorspace <value>
7059              the type of colorspace
7060
7061       -comment <string>
7062              annotate an image with a comment
7063
7064       -compose <operator>
7065              the type of image composition
7066
7067       -compress <type>
7068              the type of image compression
7069
7070       -crop <width>x<height>{+-}<x>{+-}<y>{%}
7071              preferred size and location of the cropped image
7072
7073       -debug <events>
7074              enable debug printout
7075
7076       -define <key>{=<value>},...
7077              add coder/decoder specific options
7078
7079       -density <width>x<height>
7080              horizontal and vertical resolution in pixels of the image
7081
7082       -depth <value>
7083              depth of the image
7084
7085       -display <host:display[.screen]>
7086              specifies the X server to contact
7087
7088       -dispose <method>
7089              GIF disposal method
7090
7091       -dither
7092              apply Floyd/Steinberg error diffusion to the image
7093
7094       -draw <string>
7095              annotate an image with one or more graphic primitives
7096
7097       -encoding <type>
7098              specify the text encoding
7099
7100       -endian <type>
7101              specify endianness (MSB or LSB) of output image
7102
7103       -fill <color>
7104              color to use when filling a graphic primitive
7105
7106       -filter <type>
7107              use this type of filter when resizing an image
7108
7109       -font <name>
7110              use this font when annotating the image with text
7111
7112       -frame <width>x<height>+<outer bevel width>+<inner bevel width>
7113              surround the image with an ornamental border
7114
7115       -gamma <value>
7116              level of gamma correction
7117
7118       -geometry <width>x<height>{+-}<x>{+-}<y>{%}{@} {!}{<}{>}
7119              preferred size and location of the Image window.
7120
7121       -gravity <type>
7122              direction primitive  gravitates to when annotating the image.
7123
7124       -green-primary <x>,<y>
7125              green chromaticity primary point
7126
7127       -help  print usage instructions
7128
7129       -interlace <type>
7130              the type of interlacing scheme
7131
7132       -label <name>
7133              assign a label to an image
7134
7135       -limit <type> <value>
7136              Disk, File, Map, or Memory resource limit
7137
7138       -log <string>
7139              Specify format for debug log
7140
7141       -matte store matte channel if the image has one
7142
7143       -mattecolor <color>
7144              specify the color to be used with the -frame option
7145
7146       -mode <value>
7147              mode of operation
7148
7149       -monochrome
7150              transform the image to black and white
7151
7152       -noop  NOOP (no option)
7153
7154       -page <width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}
7155              size and location of an image canvas
7156
7157       -pen <color>
7158              (This option has been replaced by the -fill option)
7159
7160       -pointsize <value>
7161              pointsize of the PostScript, OPTION1, or TrueType font
7162
7163       -quality <value>
7164              JPEG/MIFF/PNG compression level
7165
7166       -red-primary <x>,<y>
7167              red chromaticity primary point
7168
7169       -render
7170              render vector operations
7171
7172       -resize <width>x<height>{%}{@}{!}{<}{>}
7173              resize an image
7174
7175       -rotate <degrees>{<}{>}
7176              apply Paeth image rotation to the image
7177
7178       -sampling-factor <horizontal_factor>x<vertical_factor>
7179              sampling  factors  used  by  JPEG  or  MPEG-2  encoder  and  YUV
7180              decoder/encoder.
7181
7182       -scenes <value-value>
7183              range of image scene numbers to read
7184
7185       -shadow <radius>{x<sigma>}
7186              shadow the montage
7187
7188       -sharpen <radius>{x<sigma>}
7189              sharpen the image
7190
7191       -size <width>x<height>{+offset}
7192              width and height of the image
7193
7194       -stroke <color>
7195              color to use when stroking a graphic primitive
7196
7197       -strokewidth <value>
7198              set the stroke width
7199
7200       -texture <filename>
7201              name of texture to tile onto the image background
7202
7203       -tile <geometry>
7204              layout of images [montage]
7205
7206       -title <string>
7207              assign title to displayed image [animate, display, montage]
7208
7209       -transparent <color>
7210              make this color transparent within the image
7211
7212       -treedepth <value>
7213              tree depth for the color reduction algorithm
7214
7215       -trim  trim an image
7216
7217       -type <type>
7218              the image type
7219
7220       -verbose
7221              print detailed information about the image
7222
7223       -version
7224              print GraphicsMagick version string
7225
7226       -white-point <x>,<y>
7227              chromaticity white point
7228
7229              For  a  more  detailed  description of each option, see Options,
7230              above.
7231
7232

X RESOURCES

7234       Montage options can appear on the command line or in  your  X  resource
7235       file.  Options on the command line supersede values specified in your X
7236       resource file. See X(1) for more information on X resources.
7237
7238       All montage options have a corresponding X resource. In addition,  mon‐
7239       tage uses the following X resources:
7240
7241       background (class Background)
7242              background color
7243
7244              Specifies  the  preferred  color  to use for the composite image
7245              background.  The default is #ccc.
7246
7247       borderColor (class BorderColor)
7248              border color
7249
7250              Specifies the preferred color to use  for  the  composite  image
7251              border. The default is #ccc.
7252
7253       borderWidth (class BorderWidth)
7254              border width
7255
7256              Specifies the width in pixels of the composite image border. The
7257              default is 2.
7258
7259       font (class Font)
7260              font to use
7261
7262              Specifies the name of the preferred font to use when  displaying
7263              text  within the composite image. The default is 9x15, fixed, or
7264              5x8 determined by the composite image size.
7265
7266       matteColor (class MatteColor)
7267              color of the frame
7268
7269              Specify the color of an image frame. A 3D effect is achieved  by
7270              using  highlight  and shadow colors derived from this color. The
7271              default value is #697B8F.
7272
7273       pen (class Pen)
7274              text color
7275
7276              Specifies the preferred color to use for text within the compos‐
7277              ite image.  The default is black.
7278
7279       title (class Title)
7280              composite image title
7281
7282              This resource specifies the title to be placed at the top of the
7283              composite image. The default is not to place a title at the  top
7284              of the composite image.
7285

ENVIRONMENT

7287       COLUMNS
7288              Output  screen  width. Used when formatting text for the screen.
7289              Many Unix systems keep this shell variable up to  date,  but  it
7290              may  need  to be explicitly exported in order for GraphicsMagick
7291              to see it.
7292
7293       DISPLAY
7294              X11 display ID (host, display number, and  screen  in  the  form
7295              hostname:display.screen).
7296
7297       HOME   Location  of  user's home directory. GraphicsMagick searches for
7298              configuration files in $HOME/.magick if  the  directory  exists.
7299              See  MAGICK_CODER_MODULE_PATH,  MAGICK_CONFIGURE_PATH,  and MAG‐
7300              ICK_FILTER_MODULE_PATH if more flexibility is needed.
7301
7302       MAGICK_CODER_MODULE_PATH
7303              Search path to use when searching for image  format  coder  mod‐
7304              ules.  This path allows the user to arbitrarily extend the image
7305              formats supported by GraphicsMagick by adding  loadable  modules
7306              to  an  arbitrary  location  rather  than  copying them into the
7307              GraphicsMagick installation directory.  The  formatting  of  the
7308              search  path  is  similar to operating system search paths (i.e.
7309              colon delimited for Unix, and semi-colon delimited for Microsoft
7310              Windows).  This user specified search path is used before trying
7311              the default search path.
7312
7313       MAGICK_CONFIGURE_PATH
7314              Search path to  use  when  searching  for  configuration  (.mgk)
7315              files.   The formatting of the search path is similar to operat‐
7316              ing system search paths (i.e.  colon  delimited  for  Unix,  and
7317              semi-colon delimited for Microsoft Windows). This user specified
7318              search path is used before trying the default search path.
7319
7320       MAGICK_DEBUG
7321              Debug options (see -debug for details)
7322
7323       MAGICK_FILTER_MODULE_PATH
7324              Search path to use when searching  for  filter  process  modules
7325              (invoked via -process). This path allows the user to arbitrarily
7326              extend GraphicsMagick's image processing functionality by adding
7327              loadable  modules  to  an arbitrary location rather than copying
7328              them into the GraphicsMagick installation directory. The format‐
7329              ting  of  the  search path is similar to operating system search
7330              paths (i.e. colon delimited for Unix, and  semi-colon  delimited
7331              for  Microsoft Windows). This user specified search path is used
7332              before trying the default search path.
7333
7334       MAGICK_HOME
7335              Path to  top  of  GraphicsMagick  installation  directory.  Only
7336              observed  by "uninstalled" builds of GraphicsMagick which do not
7337              have their location hard-coded or set by an installer.
7338
7339       MAGICK_LIMIT_DISK
7340              Maximum amount of disk space allowed for use by the pixel cache.
7341
7342       MAGICK_LIMIT_FILES
7343              Maximum number of open files.
7344
7345       MAGICK_LIMIT_MAP
7346              Maximum size of a memory map.
7347
7348       MAGICK_LIMIT_MEMORY
7349              Maximum amount of memory to allocate from the heap.
7350
7351       MAGICK_TMPDIR
7352              Path to directory where GraphicsMagick  should  write  temporary
7353              files. The default is to use the system default, or the location
7354              set by TMPDIR.
7355
7356       TMPDIR For POSIX-compatible systems (Unix-compatible), the path to  the
7357              directory  where  all applications should write temporary files.
7358              Overridden by MAGICK_TMPDIR if it is set.
7359
7360       TMP or TEMP
7361              For Microsoft Windows, the path to the directory where  applica‐
7362              tions  should write temporary files. Overridden by MAGICK_TMPDIR
7363              if it is set.
7364

CONFIGURATION FILES

7366       GraphicsMagick uses a number of XML format configuration files:
7367
7368       colors.mgk
7369              colors configuration file
7370
7371                <?xml version="1.0"?>
7372                <colormap>
7373                  <color name="AliceBlue" red="240" green="248" blue="255"
7374                         compliance="SVG, X11, XPM" />
7375                </colormap>
7376
7377       delegates.mgk
7378              delegates configuration file
7379
7380       log.mgk
7381              logging configuration file
7382
7383                <?xml version="1.0"?>
7384                <magicklog>
7385                  <log events="None" />
7386                  <log output="stdout" />
7387                  <log filename="Magick-%d.log" />
7388                  <log generations="3" />
7389                  <log limit="2000" />
7390                  <log format="%t %r %u %p %m/%f/%l/%d:\n  %e"  />
7391                </magicklog>
7392
7393       magic.mgk
7394              file header magic test configuration file
7395
7396                <?xml version="1.0"?>
7397                <magicmap>
7398                  <magic name="AVI" offset="0" target="RIFF" />
7399                </magicmap>
7400
7401       modules.mgk
7402              loadable modules configuration file
7403
7404                <?xml version="1.0"?>
7405                <modulemap>
7406                  <module magick="8BIM" name="META" />
7407                </modulemap>
7408
7409       type.mgk
7410              master type (fonts) configuration file
7411
7412                <?xml version="1.0"?>
7413                <typemap>
7414                  <include file="type-windows.mgk" />
7415                  <type
7416                    name="AvantGarde-Book"
7417                    fullname="AvantGarde Book"
7418                    family="AvantGarde"
7419                    foundry="URW"
7420                    weight="400"
7421                    style="normal"
7422                    stretch="normal"
7423                    format="type1"
7424                    metrics="/usr/local/share/ghostscript/fonts/a010013l.afm"
7425                    glyphs="/usr/local/share/ghostscript/fonts/a010013l.pfb"
7426                  />
7427                </typemap>
7428

ACKNOWLEDGEMENTS

7430       The MIT X Consortium for making network transparent graphics a reality.
7431
7432
7433       Michael Halle, Spatial Imaging Group at MIT, for the initial  implemen‐
7434       tation of Alan Paeth's image rotation algorithm.
7435
7436
7437       David  Pensak,  E.  I.  du Pont de Nemours and Company, for providing a
7438       computing environment that made this program possible.
7439
7440
7441       Peder Langlo, Hewlett Packard, Norway, made hundreds of suggestions and
7442       bug reports. Without Peder, this software would not be nearly as useful
7443       as it is today.
7444
7445       Rod Bogart and John W. Peterson, University of Utah.  Image compositing
7446       is loosely based on rlecomp of the Utah Raster Toolkit.
7447
7448       Paul  Heckbert,  Carnegie Mellon University. Image resizing is based on
7449       his Zoom program.
7450
7451       Paul Raveling, USC Information Sciences Institute. The spatial subdivi‐
7452       sion color reduction algorithm is based on his Img software.
7453
7455       Copyright  (C)  2002,  2003 GraphicsMagick Group, an organization dedi‐
7456       cated to making software imaging solutions freely available.
7457
7458       Permission is hereby granted, free of charge, to any person obtaining a
7459       copy of this software and associated documentation files ("GraphicsMag‐
7460       ick"), to deal in GraphicsMagick without restriction, including without
7461       limitation the rights to use, copy, modify, merge, publish, distribute,
7462       sublicense, and/or sell copies of GraphicsMagick, and to permit persons
7463       to  whom GraphicsMagick is furnished to do so, subject to the following
7464       conditions:
7465
7466       The above copyright notice and this permission notice shall be included
7467       in all copies or substantial portions of GraphicsMagick.
7468
7469       The software is provided "as is", without warranty of any kind, express
7470       or implied, including  but  not  limited  to  the  warranties  of  mer‐
7471       chantability, fitness for a particular purpose and noninfringement.  In
7472       no event shall GraphicsMagick Group be liable for any claim, damages or
7473       other  liability,  whether in an action of contract, tort or otherwise,
7474       arising from, out of or in connection with GraphicsMagick or the use or
7475       other dealings in GraphicsMagick.
7476
7477       Except  as  contained  in  this  notice, the name of the GraphicsMagick
7478       Group shall not be used in advertising  or  otherwise  to  promote  the
7479       sale,  use  or  other  dealings in GraphicsMagick without prior written
7480       authorization from the GraphicsMagick Group.
7481
7482       Additional copyrights and licenses apply to this software.  You  should
7483       have  received  a  copy  of  Copyright.txt  with  this  package,  which
7484       describes additional copyrights and licenses which apply to this  soft‐
7485       ware; otherwise see http://www.graphicsmagick.org/www/Copyright.html.
7486
7487
7488
7489GraphicsMagick                    2007/08/02                             gm(1)
Impressum