Options |
-
Options are processed in command line order. Any option you specify on
the command line remains in effect until it is explicitly changed by specifying
the option again with a different effect. For example, to montage two images,
the first with 32 colors and the second with only 16 colors, use:
montage -colors 32 cockatoo.1 -colors 16 cockatoo.2 cockatoo.miff
-adjoin |
-
join images into a single multi-image file.
-
This option is useful for creating a multi-frame animation sequence within
the same file (e.g. GIF).
-blur
<radius>x<sigma> |
- blur the image with a gaussian operator of the given radius and
standard deviation (sigma).
-cache
threshold |
-
megabytes of memory available to the pixel cache.
-
Image pixels are stored in memory until 80 megabytes of memory have been
consumed. Subsequent pixel operations are cached on disk. Operations to
memory are significantly faster but if your computer does not have a sufficient
amount of free memory you may want to adjust this threshold value.
-colors
value |
-
preferred number of colors in the image.
-
The actual number of colors in the image may be less than your request,
but never more. Note, this is a color reduction option. Images with less
unique colors than specified with this option will have any duplicate or
unused colors removed. Refer to quantize
for more details.
-
Note, options -dither, -colorspace, and -treedepth
affect the color reduction algorithm.
-colorspace
value |
-
the type of colorspace: GRAY, OHTA, RGB,
Transparent,
XYZ,
YCbCr, YIQ, YPbPr,
YUV, or CMYK.
-
Color reduction, by default, takes place in the RGB color space. Empirical
evidence suggests that distances in color spaces such as YUV or YIQ correspond
to perceptual color differences more closely than do distances in RGB space.
These color spaces may give better results when color reducing an image.
Refer to
quantize for more details.
The Transparent color space behaves uniquely in that it preserves
the matte channel of the image if it exists.
-
The -colors or -monochrome option is required for this option
to take effect.
-comment
string |
-
annotate an image with a comment.
-
By default, each image is commented with its file name. Use this option
to assign a specific comment to the image. Optionally you can include the
image filename, type, width, height, or other image attribute by embedding
special format characters:
%b file size
%c comment
%d directory
%e filename extention
%f filename
%h height
%i input filename
%l label
%m magick
%n number of scenes
%o output filename
%p page number
%q quantum depth
%s scene number
%t top of filename
%u unique temporary filename
%w width
%x x resolution
%y y resolution
\\n newline
\\r carriage return
For example,
-comment "%m:%f %wx%h"
-
produces an image comment of MIFF:bird.miff 512x480 for an
image titled bird.miff and whose width is 512 and height is 480.
-
If the first character of string is @, the image comment
is read from a file titled by the remaining characters in the string.
-compose
operator |
-
the type of image composition.
-
By default, each of the composite image pixels are replaced by the corresponding
image tile pixel. You can choose an alternate composite operation:
over
in
out
atop
xor
plus
minus
add
subtract
difference
multiply
bumpmap
replace
The operations behaves as follows:
over |
-
The result will be the union of the two image shapes, with
composite
image obscuring image in the region of overlap.
in |
-
The result is simply composite image cut by the shape of
image.
None of the image data of image will be in the result.
out |
-
The resulting image is image with the shape of
composite image
cut out.
atop |
-
The result is the same shape as image image, with
composite image
obscuring image where the image shapes overlap. Note this differs
from over because the portion of
composite image outside
image's
shape does not appear in the result.
xor |
-
The result is the image data from both composite image and
image
that is outside the overlap region. The overlap region will be blank.
plus |
-
The result is just the sum of the image data. Output values are cropped
to 255 (no overflow). This operation is independent of the matte channels.
minus |
-
The result of composite image - image, with underflow cropped
to zero. The matte channel is ignored (set to 255, full coverage).
add |
-
The result of composite image + image, with overflow wrapping
around (mod 256).
subtract |
-
The result of composite image - image, with underflow wrapping
around (mod 256). The add and subtract operators can
be used to perform reversible transformations.
difference |
-
The result of abs(composite image - image). This is useful
for comparing two very similar images.
multiply |
-
The result of composite image * image. This is useful
for the creation of drop-shadows.
bumpmap |
-
The result image shaded by composite image.
replace |
-
The resulting image is image replaced with composite image.
Here the matte information is ignored.
-
The image compositor requires a matte, or alpha channel in the image for
some operations. This extra channel usually defines a mask which represents
a sort of a cookie-cutter for the image. This is the case when matte is
255 (full coverage) for pixels inside the shape, zero outside, and between
zero and 255 on the boundary. If image does not have a matte channel,
it is initialized with 0 for any pixel matching in color to pixel location
(0,0), otherwise 255 (to work properly
borderwidth must be 0).
-compress
type |
-
the type of image compression: None, BZip, Fax,
Group4,
JPEG,
LZW, RunlengthEncoded or Zip.
-
This option specifies the type of image compression for the composite image.
See miff(5) for details.
-
Specify +compress to store the binary image in an uncompressed format.
The default is the compression type of the specified image file.
-crop
<width>x<height>{+-}<x
offset>{+-}< y offset>{%} |
-
preferred size and location of the cropped image. See
X(1) for details
about the geometry specification.
-
To specify a percentage width or height instead, append
%. For example
to crop the image by ten percent on all sides of the image, use -crop10%.
-
Use cropping to tile only a particular area of an image.
-
Omit the x and y offset to generate one or more subimages of a uniform
size.
-
Use cropping to crop a particular area of an image. Use -crop 0x0
to trim edges that are the background color. Add an x and y offset to leave
a portion of the trimmed edges with the image.
-
The equivalent X resource for this option is
cropGeometry (class
CropGeometry).
See X RESOURCES for details.
-density
<width>x<height> |
-
vertical and horizontal resolution in pixels of the image.
-
This option specifies an image density when decoding a Postscript or Portable
Document page. The default is 72 pixels per inch in the horizontal and
vertical direction. This option is used in concert with -page.
-display
host:display[.screen] |
-
specifies the X server to contact; see X(1).
-
Specify +display if an X server is not available. The label font
is obtained from the X server. If none is available, the composite image
will not have labels.
-dispose
method |
-
GIF disposal method.
-
Here are the valid methods:
0 No disposal specified.
1 Do not dispose between frames.
2 Overwrite frame with background color from header.
3 Overwrite with previous frame.
-dither |
-
apply Floyd/Steinberg error diffusion to the image.
-
The basic strategy of dithering is to trade intensity resolution for spatial
resolution by averaging the intensities of several neighboring pixels.
Images which suffer from severe contouring when reducing colors can be
improved with this option.
-
The -colors or -monochrome option is required for this option
to take effect.
-
Use +dither to render Postscript without text or graphic aliasing.
-draw
string |
-
annotate an image with one or more graphic primitives.
-
Use this option to annotate an image with one or more graphic primitives.
The primitives include
rectangle
circle
polygon
ellipse
color
matte
text
image
-
Rectangle, text, and image requires an upper left
and lower right coordinate. Circle requires the center coordinate
and a coordinate on the outer edge. Use Ellipse to draw a partial
ellipse centered at the given point with the x-axis and y-axis radius and start
and end of arc in degrees (e.g. 100,100 100,150 0,360). Finally, polygon
requires three or more coordinates defining its boundaries. Coordinates
are integers separated by an optional comma. For example, to define a
circle
centered at 100,100 that extends to 150,150 use:
-draw 'circle 100,100 150,150'
-
Use color to change the color of a pixel. Follow the pixel coordinate
with a method:
point
replace
floodfill
filltoborder
reset
-
Consider the target pixel as that specified by your coordinate. The
point
method recolors the target pixel. The replace method recolors any
pixel that matches the color of the target pixel.
Floodfill recolors
any pixel that matches the color of the target pixel and is a neighbor.
Whereas filltoborder recolors any neighbor pixel that is not the
border color. Finally, reset recolors all pixels.
-
Use matte to the change the pixel matte value to transparent. Follow
the pixel coordinate with a method (see the color primitive for
a description of methods). The point method changes the matte value
of the target pixel. The replace method changes the matte value
of any pixel that matches the color of the target pixel. Floodfill
changes the matte value of any pixel that matches the color of the target
pixel and is a neighbor. Whereas
filltoborder changes the matte
value of any neighbor pixel that is not the border color. Finally reset
changes the matte value of all pixels.
-
Use text to annotate an image with text. Follow the text coordinates
with a string. If the string has embedded spaces, enclose it in double
quotes. Optionally you can include the image filename, type, width, height,
or other image attribute by embedding special format character. See -comment
for details.
-
For example,
-draw 'text 100,100 "%m:%f %wx%h"'
annotates the image with MIFF:bird.miff 512x480 for an image titled
bird.miff
and whose width is 512 and height is 480. To generate a Unicode character
(TrueType fonts only), embed the code as an escaped hex string (e.g.
\0x30a3).
Use image to composite an image with another image. Follow the
image coordinates with the image size and filename:
-draw 'image 100,100 100,100 225,225 image.jpg'
-
If the first character of string is @, the text is read from
a file titled by the remaining characters in the string.
You can set the primitive color, font color, and font bounding box color
with
-fill, -font, and -box respectively. Options are
processed in command line order so be sure to use -fillbefore
the -draw option.
-fill
Color |
-
color to use when filling a graphic primitive.
-filter
type |
-
use this type of filter when resizing an image.
-
Use this option to affect the resizing operation of an image (see
-geometry).
Choose from these filters:
Point
Box
Triangle
Hermite
Hanning
Hamming
Blackman
Gaussian
Quadratic
Cubic
Catrom
Mitchell
Lanczos
Bessel
Sinc
-
The default filter is Lanczos.
-flip |
-
create a "mirror image" by reflecting the scanlines in the vertical direction.
-flop |
-
create a "mirror image" by reflecting the image scanlines in the horizontal
direction.
-frame |
-
surround the image with an ornamental border.
-
The color of the border is specified with the
-mattecolor command
line option. If no frame is desired, use
+frame.
-font
name |
-
use this font when annotating the image with text.
-
You can tag a font to specify whether it is a Postscript, Truetype, or X11
font. For example, Arial.ttf is a Truetype font, ps:helvetica
is Postscript, and x:fixed is X11.
-gamma
value |
-
level of gamma correction.
-
The same color image displayed on two different workstations may look different
due to differences in the display monitor. Use gamma correction to adjust
for this color difference. Reasonable values extend from 0.8 to 2.3.
-
You can apply separate gamma values to the red, green, and blue channels
of the image with a gamma value list delineated with slashes (i.e. 1.7/2.3/1.2).
-
Use +gamma to set the image gamma level without actually adjusting
the image pixels. This option is useful if the image is of a known gamma
but not set as an image attribute (e.g. PNG images).
-geometry
<width>x<height>{+-}<x
offset>{+-}< y offset>{%}{!}{<}{>} |
-
preferred tile and border size of each tile of the composite image.
-
By default, the width and height are maximum values. That is, the image
is expanded or contracted to fit the width and height value while maintaining
the aspect ratio of the image. Append an exclamation point to the geometry
to force the image size to exactly the size you specify. For example, if
you specify 640x480! the image width is set to 640 pixels and height
to 480. If only one factor is specified, both the width and height assume
the value.
-
Use > to change the dimensions of the image
only if its size
exceeds the geometry specification. < resizes the image only
if its dimensions is less than the geometry specification. For example,
if you specify 640x480> and the image size is 512x512, the image
size does not change. However, if the image is 1024x1024, it is resized
to 640x480.
-
Each image is surrounded by a border whose size in pixels is specified
as <border width> and <border height>
and whose color is the background color. By default, the tile size is 256x256
and there is no border.
-
The equivalent X resource for this option is
imageGeometry (class
ImageGeometry).
See X Resources for details.
-gravity
direction |
-
direction image gravitates to within a tile. See X(1) for details
about the gravity specification.
-
A tile of the composite image is a fixed width and height. However, the
image within the tile may not fill it completely (see -geometry).
The direction you choose specifies where to position the image within the
tile. For example Center gravity forces the image to be centered
within the tile. By default, the image gravity is Center.
-interlace
type |
-
the type of interlacing scheme: None, Line, Plane,
or Partition. The default is None.
-
This option is used to specify the type of interlacing scheme for raw image
formats such as RGB or YUV. None means do not interlace
(RGBRGBRGBRGBRGBRGB...), Line uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...),
and Plane uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).
Partition
is like plane except the different planes are saved to individual files
(e.g. image.R, image.G, and image.B).
-
Use Line, or Plane to create an interlaced GIF or
progressive
JPEG image.
-label
name |
-
assign a label to an image.
-
By default, each image is labeled with its file name. Use this option to
assign a specific label to the image. Optionally you can include the image
filename, type, width, height, or other image attribute by embedding special
format character. See -comment for details.
-
For example,
-label "%m:%f %wx%h"
-
produces an image label of MIFF:bird.miff 512x480 for an
image titled bird.miff and whose width is 512 and height is 480.
-
If the first character of string is @, the image label is
read from a file titled by the remaining characters in the string.
-matte |
-
store matte channel if the image has one otherwise create an opaque one.
-mode
type |
-
the type of montage: Frame, Unframe, or Concatenate.
The default is Unframe.
-
This option is for convenience. You can obtain the desired result by setting
individual options (e.g. Unframe is equivalent to
+frame+shadow
+borderwidth).
-monochrome |
-
transform the image to black and white.
-page
<width>x<height>{+-}<x
offset>{+-}< y offset>{%}{!}{<}{>} |
-
size and location of an image canvas.
-
Use this option to specify the dimensions of the
PostScript page
in dots per inch or a TEXT page in pixels. The choices for a Postscript
page are:
11x17 792 1224
Ledger 1224 792
Legal 612 1008
Letter 612 792
LetterSmall 612 792
ArchE 2592 3456
ArchD 1728 2592
ArchC 1296 1728
ArchB 864 1296
ArchA 648 864
A0 2380 3368
A1 1684 2380
A2 1190 1684
A3 842 1190
A4 595 842
A4Small 595 842
A5 421 595
A6 297 421
A7 210 297
A8 148 210
A9 105 148
A10 74 105
B0 2836 4008
B1 2004 2836
B2 1418 2004
B3 1002 1418
B4 709 1002
B5 501 709
C0 2600 3677
C1 1837 2600
C2 1298 1837
C3 918 1298
C4 649 918
C5 459 649
C6 323 459
Flsa 612 936
Flse 612 936
HalfLetter 396 612
-
For convenience you can specify the page size by media (e.g. A4, Ledger,
etc.). Otherwise, -page behaves much like
-geometry (e.g.
-page
letter+43+43>).
To position a GIF image, use -page +LEFT+TOP (e.g. -page "+1"00+200).
-
For a Postscript page, the image is sized as in -geometry and positioned
relative to the lower left hand corner of the page by {+-}<xoffset>{+-}<y
offset>. Use -page 612x792>, for example, to center the
image within the page. If the image size exceeds the Postscript page, it
is reduced to fit the page.
-
The default page dimensions for a TEXT image is 612x792.
-pointsize
value |
-
pointsize of the Postscript, X11, or TrueType font.
-quality
value |
-
JPEG/MIFF/PNG compression level.
-
For the JPEG image format, quality is 0 (worst) to 100 (best). The default
quality is 75.
-
Quality for the MIFF and PNG image format sets the amount of image compression
(quality / 10) and filter-type (quality % 10). Compression quality values
range from 0 (worst) to 100 (best). If filter-type is 4 or less, the specified
filter-type is used for all scanlines:
0: none
1: sub
2: up
3: average
4: Paeth
-
If filter-type is 5, adaptive filtering is used when quality is greater
than 50 and the image does not have a color map, otherwise no filtering
is used.
-
If filter-type is 6 or more, adaptive filtering with minimum-sum-of-absolute-values
is used.
-
The default is quality is 75. Which means nearly the best compression with
adaptive filtering.
-
For further information, see the PNG
specification.
-rotate
degrees{<}{>} |
-
apply Paeth image rotation to the image.
-
Use > to rotate the image only if its width exceeds the
height. < rotates the image only if its width is less
than the height. For example, if you specify -90> and the image
size is 480x640, the image is not rotated by the specified angle. However,
if the image is 640x480, it is rotated by -90 degrees.
-
Empty triangles left over from rotating the image are filled with the color
defined as bordercolor (class
borderColor). See X(1)
for details.
-scene
value |
-
image scene number.
-shadow |
-
add a shadow beneath a tile to simulate depth.
-sharpen
<radius>x<sigma> |
- sharpen the image with a gaussian operator of the given radius and
standard deviation (sigma).
-size
<width>x<height>{+offset} |
-
width and height of the image.
-
Use this option to specify the width and height of raw images whose dimensions
are unknown such as GRAY, RGB, or CMYK. In addition
to width and height, use -size to skip any header information in
the image or tell the number of colors in a MAP image file, (e.g.
-size 640x512+256).
-stroke
Color |
-
color to use when stroking a graphic primitive.
-texture
filename |
-
name of texture to tile onto the image background.
-tile
<width>x<height> |
-
specifies how many tiles are to appear in each row and column of the composite
image.
-
Specify the number of tiles per row with width and tiles per column with
height. For example if you want 1 tile in each row and a maximum of 10
tiles in the composite image, use -tile 1x10. The default is to have 5
tiles in each row and 4 tiles in each column of the composite.
-transparent
color |
-
make this color transparent within the image.
-treedepth
value |
-
Normally, this integer value is zero or one. A zero or one tells montage
to choose an optimal tree depth for the color reduction algorithm.
-
An optimal depth generally allows the best representation of the source
image with the fastest computational speed and the least amount of memory.
However, the default depth is inappropriate for some images. To assure
the best representation, try values between 2 and 8 for this parameter.
Refer to
quantize(9) for more details.
-
The -colors or -monochrome option is required for this option
to take effect.
-type
type |
-
the image type:
Bilevel, Grayscale, Palette,
PaletteMatte, TrueColor, TrueColorMatte,
or ColorSeparation.
-verbose |
-
print detailed information about the image.
-
This information is printed: image scene number; image name; image size;
the image class (DirectClass or
PseudoClass); the total number
of unique colors; and the number of seconds to read and write the image.
-
In addition to those listed above, you can specify these standard X resources
as command line options: -background,
-bordercolor, -borderwidth,
-font,
-foreground,
-mattecolor, or -title. See XResources
for details.
By default, the image format is determined by its magic number. To specify
a particular image format, precede the filename with an image format name
and a colon (i.e. ps:image) or specify the image type as the filename suffix
(e.g. image.ps). See convert(1) for a list of valid image
formats.
When you specify X as your image type, the filename has special
meaning. It specifies an X window by id, name, or
root. If no filename
is specified, the window is selected by clicking the mouse in the desired
window.
Specify file as - for standard input, output_file as -
for standard output. If file has the extension .Z or
.gz,
the file is uncompressed with uncompress or
gunzip respectively.
If output_file has the extension compress or gzip
respectively. Finally, precede the image file name with | to pipe to or
from a system command.
-
Use an optional index enclosed in brackets after a file name to specify
a desired subimage of a multi-resolution image format like Photo CD (e.g.
img0001.pcd[4]) or a range for MPEG images (e.g. video.mpg[50-75]). A subimage
specification can be disjoint (e.g. image.tiff[2,7,4]). For raw images,
specify a subimage with a geometry (e.g. -size 640x512 image.rgb[320x256+50+50]).
Single images are written with the filename you specify. However, multi-part
images (i.e. a multi-page PostScript document with +adjoin specified)
are written with the filename followed by a period (.) and the scene
number. You can change this behavior by embedding a printf format
specification in the file name. For example,
image%02d.miff
montages files image00.miff, image01.miff, etc.
Prepend an at sign @ to a filename to read a list of image
filenames from that file. This is convenient in the event you have too
many image filenames to fit on the command line.
Note, a composite MIFF image displayed to an X server with
display
behaves differently than other images. You can think of the composite as
a visual image directory. Choose a particular tile of the composite and
press a button to display it. See display(1) and miff(5)
for details.