.TH composite 1 "Date: 2004/01/01 01:00:00" "ImageMagick"
.SH COMPOSITE
.SH NAME
composite - composite images together.
.SH SYNOPSIS

\fBcomposite\fP \fB[\fP \fIoptions\fP \fB... ]\fP \fIchange-image base-image\fP
\fB[\fP \fImask-image\fP \fB]\fP \fIoutput-image\fP

.SH DESCRIPTION

\fBcomposite\fP composites (combines) images to create new images.
\fIbase-image\fP is the base image and \fIchange-image\fP contains the changes.
\fIouput-image\fP is the result, and normally has the same dimensions
as \fIbase-image\fP.


The optional \fImask-image\fP can be used to provide opacity information
for \fIchange-image\fP when it has none or if you want a different mask.
A mask image is typically grayscale and the same size as
\fBbase-image\fP. If \fImask-image\fP is not grayscale, it is converted
to grayscale and the resulting intensities are used as opacity
information.
.SH EXAMPLES

To composite an image of a cockatoo with a perch, use:

    composite cockatoo.miff perch.ras composite.miff

To compute the difference between images in a series, use:

    composite -compose difference series.2 series.1
              difference.miff

To composite an image of a cockatoo with a perch starting at location (100,150),
use:

    composite -geometry +100+150 cockatoo.miff
              perch.ras composite.miff

To tile a logo across your image of a cockatoo, use

    convert +shade 30x60 cockatoo.miff mask.miff
    composite -compose bumpmap -tile logo.png
              cockatoo.miff mask.miff composite.miff

To composite a red, green, and blue color plane into a single composite image,
try

    composite -compose CopyGreen green.png red.png
              red-green.png
    composite -compose CopyBlue blue.png red-green.png 
              composite.png
.SH OPTIONS

Options are processed in command line order. Any option you specify on
the command line remains in effect only for the image that follows.  All
options are reset to their default values after each image is read.

For a more detailed description of each option, see
Options, above.
\fIImageMagick(1)\fP.

.TP
.B "-authenticate \fI<string>"\fP
\fRdecrypt image with this password
.TP
.B "-background \fI<color>"\fP
\fRthe background color
.TP
.B "-blue-primary \fI<x>,<y>"\fP
\fRblue chromaticity primary point
.TP
.B "-cache \fI<threshold>"\fP
\fR(This option has been replaced by the -limit option)
.TP
.B "-colors \fI<value>"\fP
\fRpreferred number of colors in the image
.TP
.B "-colorspace \fI<value>"\fP
\fRthe type of colorspace
.TP
.B "-comment \fI<string>"\fP
\fRannotate an image with a comment
.TP
.B "-compose \fI<operator>"\fP
\fRthe type of image composition
.TP
.B "-compress \fI<type>"\fP
\fRthe type of image compression
.TP
.B "-debug \fI<events>"\fP
\fRenable debug printout
.TP
.B "-define \fI<key>{=<value>},..."\fP
\fRadd coder/decoder specific options
.TP
.B "-density \fI<width>x<height>"\fP
\fRhorizontal and vertical resolution in pixels of the image
.TP
.B "-depth \fI<value>"\fP
\fRdepth of the image
.TP
.B "-displace \fI<horizontal scale>x<vertical scale>"\fP
\fRshift image pixels as defined by a displacement map
.TP
.B "-display \fI<host:display[.screen]>"\fP
\fRspecifies the X server to contact
.TP
.B "-dispose \fI<method>"\fP
\fRGIF disposal method
.TP
.B "-dissolve \fI<percent>"\fP
\fRdissolve an image into another by the given percent
.TP
.B "-dither"
\fRapply Floyd/Steinberg error diffusion to the image
.TP
.B "-encoding \fI<type>"\fP
\fRspecify the text encoding
.TP
.B "-endian \fI<type>"\fP
\fRspecify endianness (MSB or LSB) of the image
.TP
.B "-filter \fI<type>"\fP
\fRuse this type of filter when resizing an image
.TP
.B "-font \fI<name>"\fP
\fRuse this font when annotating the image with text
.TP
.B "-geometry \fI<width>x<height>{+-}<x>{+-}<y>{%}{@} {!}{<}{>}"\fP
\fRpreferred size and location of the Image window.
.TP
.B "-gravity \fI<type>"\fP
\fRdirection primitive  gravitates to when annotating the image.
.TP
.B "-green-primary \fI<x>,<y>"\fP
\fRgreen chromaticity primary point
.TP
.B "-help"
\fRprint usage instructions
.TP
.B "-interlace \fI<type>"\fP
\fRthe type of interlacing scheme
.TP
.B "-label \fI<name>"\fP
\fRassign a label to an image
.TP
.B "-limit \fI<type> <value>"\fP
\fRArea, Disk, File, Map, or Memory resource limit
.TP
.B "-log \fI<string>"\fP
\fRSpecify format for debug log
.TP
.B "-matte"
\fRstore matte channel if the image has one
.TP
.B "-monochrome"
\fRtransform the image to black and white
.TP
.B "-negate"
\fRreplace every pixel with its complementary color
.TP
.B "-page \fI<width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}"\fP
\fRsize and location of an image canvas
.TP
.B "-profile \fI<filename>"\fP
\fRadd ICM, IPTC, or generic profile  to image
.TP
.B "-quality \fI<value>"\fP
\fRJPEG/MIFF/PNG compression level
.TP
.B "-red-primary \fI<x>,<y>"\fP
\fRred chromaticity primary point
.TP
.B "-render"
\fRrender vector operations
.TP
.B "-repage \fI<width>x<height>{+-}<x>{+-}<y>{%}{!}{<}{>}"\fP
\fRsize and location of an image canvas.  This option is like -page but
act as an image operator rather than a setting.
.TP
.B "-resize \fI<width>x<height>{%}{@}{!}{<}{>}"\fP
\fRresize an image
.TP
.B "-rotate \fI<degrees>{<}{>}"\fP
\fRapply Paeth image rotation to the image
.TP
.B "-sampling-factor \fI<horizontal_factor>x<vertical_factor>"\fP
\fRsampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.
.TP
.B "-scene \fI<value>"\fP
\fRset scene number
.TP
.B "-sharpen \fI<radius>{x<sigma>}"\fP
\fRsharpen the image
.TP
.B "-size \fI<width>x<height>{+offset}"\fP
\fRwidth and height of the image
.TP
.B "-stegano \fI<offset>"\fP
\fRhide watermark within an image
.TP
.B "-stereo"
\fRcomposite two images to create a stereo anaglyph
.TP
.B "-strip \fI"\fP
\fRstrip the image of any profiles or comments
.TP
.B "-thumbnail \fI<width>x<height>{%}{@}{!}{<}{>}"\fP
\fRcreate a thumbnail of the image
.TP
.B "-treedepth \fI<value>"\fP
\fRtree depth for the color reduction algorithm
.TP
.B "-trim"
\fRtrim an image
.TP
.B "-type \fI<type>"\fP
\fRthe image type
.TP
.B "-units \fI<type>"\fP
\fRthe units of image resolution
.TP
.B "-unsharp \fI<radius>{x<sigma>}{+<amount>}{+<threshold>}"\fP
\fRsharpen the image with an unsharp mask operator
.TP
.B "-verbose"
\fRprint detailed information about the image
.TP
.B "-version"
\fRprint ImageMagick version string
.TP
.B "-watermark \fI<brightness>"\fP
\fRpercent brightness of a watermark
.TP
.B "-white-point \fI<x>,<y>"\fP
\fRchromaticity white point
.TP
.B "-write \fI<filename>"\fP
\fRwrite  an image sequence [\fIconvert, composite\fP]

For a more detailed description of each option, see
Options, above.
\fIImageMagick(1)\fP.

.SH ENVIRONMENT
.TP
.B "COLUMNS"
\fROutput screen width. Used when formatting text for the screen. Many
Unix systems keep this shell variable up to date, but it may need to be
explicitly exported in order for ImageMagick to see it.
.TP
.B "DISPLAY"
\fRX11 display ID (host, display number, and screen in the form
hostname:display.screen).
.TP
.B "HOME"
\fRLocation of user's home directory. ImageMagick searches for
configuration files in $HOME/.magick if the directory exists. See
\fBMAGICK_CODER_MODULE_PATH\fP, \fBMAGICK_CONFIGURE_PATH\fP, and
\fBMAGICK_FILTER_MODULE_PATH\fP if more flexibility is needed.
.TP
.B "MAGICK_CODER_MODULE_PATH"
\fRSearch path to use when searching for image format coder modules.
This path allows the user to arbitrarily extend the image formats
supported by ImageMagick by adding loadable modules to an arbitrary
location rather than copying them into the ImageMagick installation
directory. The formatting of the search path is similar to operating
system search paths (i.e. colon delimited for Unix, and semi-colon
delimited for Microsoft Windows). This user specified search path is used
before trying the default search path.
.TP
.B "MAGICK_CONFIGURE_PATH"
\fRSearch path to use when searching for configuration (.mgk) files.
The formatting of the search path is similar to operating system search
paths (i.e. colon delimited for Unix, and semi-colon delimited for
Microsoft Windows). This user specified search path is used before trying
the default search path.
.TP
.B "MAGICK_DEBUG"
\fRDebug options (see \fB-debug\fP for details)
.TP
.B "MAGICK_FILTER_MODULE_PATH"
\fRSearch path to use when searching for filter process modules
(invoked via \fB-process\fP). This path allows the user to arbitrarily
extend ImageMagick's image processing functionality by adding loadable
modules to an arbitrary location rather than copying them into the
ImageMagick installation directory. The formatting of the search path
is similar to operating system search paths (i.e. colon delimited for
Unix, and semi-colon delimited for Microsoft Windows). This user
specified search path is used before trying the default search path.
.TP
.B "MAGICK_FONT_PATH"
\fRDirectory where ImageMagick should look for TrueType and
Postscript Type1 font files if the font file is not found in the current
directory. It is preferred to define the available fonts via type.mgk
rather than use \fBMAGICK_FONT_PATH\fP.
.TP
.B "MAGICK_HOME"
\fRPath to top of ImageMagick installation directory. Only observed
by "uninstalled" builds of ImageMagick which do not have their location
hard-coded or set by an installer.
.TP
.B "MAGICK_DISK_LIMIT"
\fRMaximum amount of disk space allowed for use by the pixel cache.
.TP
.B "MAGICK_FILES_LIMIT"
\fRMaximum number of open files.
.TP
.B "MAGICK_MAP_LIMIT"
\fRMaximum size of a memory map.
.TP
.B "MAGICK_MEMORY_LIMIT"
\fRMaximum amount of memory to allocate from the heap.
.TP
.B "MAGICK_TMPDIR"
\fRPath to directory where ImageMagick should write temporary
files. The default is to use the system default, or the location set by
\fBTMPDIR\fP.
.TP
.B "TMPDIR"
\fRFor POSIX-compatible systems (Unix-compatible), the path to the
directory where all applications should write temporary files.
Overridden by \fBMAGICK_TMPDIR\fP if it is set.
.TP
.B "TMP \fIor TEMP"\fP
\fRFor Microsoft Windows, the path to the directory where applications
should write temporary files. Overridden by \fBMAGICK_TMPDIR\fP if it
is set.
.SH CONFIGURATION FILES
ImageMagick uses a number of XML format configuration files:
.TP
.B "colors.mgk"
\fRcolors configuration file

  <?xml version="1.0"?>
  <colormap>
    <color name="AliceBlue" red="240" green="248" blue="255"
           compliance="SVG, X11, XPM" />
  </colormap>
.TP
.B "delegates.mgk"
\fRdelegates configuration file
.TP
.B "log.mgk"
\fRlogging configuration file

  <?xml version="1.0"?>
  <magicklog>
    <log events="None" />
    <log output="stdout" />
    <log filename="Magick-%d.log" />
    <log generations="3" />
    <log limit="2000" />
    <log format="%t %r %u %p %m/%f/%l/%d:\\n  %e"  />
  </magicklog>
.TP
.B "magic.mgk"
\fRfile header magic test configuration file

  <?xml version="1.0"?>
  <magicmap>
    <magic name="AVI" offset="0" target="RIFF" />
  </magicmap>
.TP
.B "modules.mgk"
\fRloadable modules configuration file

  <?xml version="1.0"?>
  <modulemap>
    <module magick="8BIM" name="META" />
  </modulemap>
.TP
.B "type.mgk"
\fRmaster type (fonts) configuration file

  <?xml version="1.0"?>
  <typemap>
    <\fB\fPinclude file="type-windows.mgk" />
    <type
      name="AvantGarde-Book"
      fullname="AvantGarde Book"
      family="AvantGarde"
      foundry="URW"
      weight="400"
      style="normal"
      stretch="normal"
      format="type1"
      metrics="/usr/local/share/ghostscript/fonts/a010013l.afm"
      glyphs="/usr/local/share/ghostscript/fonts/a010013l.pfb"
    />
  </typemap>
.SH SEE ALSO

animate(1), display(1), conjure(1), convert(1), identify(1), ImageMagick(1),
import(1), mogrify(1), montage(1)

.SH COPYRIGHT

\fBCopyright (C) 1999-2004 ImageMagick Studio LLC. Additional copyrights and
licenses apply to this software, see
http://www.imagemagick.org/www/Copyright.html\fP