Bash Cures Cancer
Learn the UNIX/Linux command line

Home     Man Pages     SpamDefeator


animate(1)							   animate(1)



ANIMATE
NAME
       animate - animate a sequence of images

SYNOPSIS
       animate [ options ...] file [ [ options ...] file ...]


DESCRIPTION
       Animate	displays a sequence of images on any workstation display run-
       ning an X server. animate first determines the  hardware	 capabilities
       of the workstation. If the number of unique colors in an image is less
       than or equal to the number the workstation can support, the image  is
       displayed  in an X window. Otherwise the number of colors in the image
       is first reduced to match the  color  resolution	 of  the  workstation
       before it is displayed.

       This  means that a continuous-tone 24 bits-per-pixel image can display
       on a 8 bit pseudo-color device or monochrome device. In most instances
       the reduced color image closely resembles the original. Alternatively,
       a monochrome or pseudo-color image sequence can display on a  continu-
       ous-tone 24 bits-per-pixel device.

       To  help	 prevent  color	 flashing  on X server visuals that have col-
       ormaps, animate creates a single colormap  from	the  image  sequence.
       This  can be rather time consuming. You can speed this operation up by
       reducing the colors in  the  image  before  you	"animate"  them.  Use
       mogrify	to  color  reduce  the	images	to  a  single  colormap.  See
       mogrify(1) for details. Alternatively, you can  use  a  Standard	 Col-
       ormap;  or  a  static, direct, or true color visual.  You can define a
       Standard Colormap with xstdcmap. See  xstdcmap(1)  for  details.	 This
       method  is  recommended for colormapped X server because it eliminates
       the need to compute a global colormap.

EXAMPLES
       To animate a set of images of a cockatoo, use:


	   animate cockatoo.*

       To animate a cockatoo image sequence while using the Standard Colormap
       best, use:


	   xstdcmap -best
	   animate -map best cockatoo.*

       To animate an image of a cockatoo without a border centered on a back-
       drop, use:


	   animate +borderwidth -backdrop cockatoo.*

OPTIONS
       For a more detailed description of each option,	see  Options,  above.
       ImageMagick(1).


       -authenticate 
	      decrypt image with this password

       -backdrop 
	      display the image centered on a backdrop.

       -background 
	      the background color

       -bordercolor 
	      the border color

       -borderwidth 
	      the border width

       -cache 
	      (This option has been replaced by the -limit option)

       -chop x{+-}{+-}{%}
	      remove pixels from the interior of an image

       -colormap 
	      define the colormap type

       -colors 
	      preferred number of colors in the image

       -colorspace 
	      the type of colorspace

       -crop x{+-}{+-}{%}
	      preferred size and location of the cropped image

       -debug 
	      enable debug printout

       -define {=},...
	      add coder/decoder specific options

       -delay <1/100ths of a second>
	      display the next image after pausing

       -delete 
	      delete the image from the image sequence

       -density x
	      horizontal and vertical resolution in pixels of the image

       -depth 
	      depth of the image

       -display 
	      specifies the X server to contact

       -dispose 
	      GIF disposal method

       -dither
	      apply Floyd/Steinberg error diffusion to the image

       -font 
	      use this font when annotating the image with text

       -foreground 
	      define the foreground color

       -gamma 
	      level of gamma correction

       -geometry x{+-}{+-}{%}{@} {!}{<}{>}
	      preferred size and location of the Image window.

       -help  print usage instructions

       -iconGeometry 
	      specify the icon geometry

       -iconic
	      iconic animation

       -insert 
	      insert last image into the image sequence

       -interlace 
	      the type of interlacing scheme

       -limit  
	      Area, Disk, File, Map, or Memory resource limit

       -log 
	      Specify format for debug log

       -map 
	       display image using this type.

       -matte store matte channel if the image has one

       -mattecolor 
	      specify the color to be used with the -frame option

       -monochrome
	      transform the image to black and white

       -name  name an image

       -pause 
	      pause between animation loops [animate]

       -remote
	      perform a remote operation

       -rotate {<}{>}
	      apply Paeth image rotation to the image

       -sampling-factor x
	      sampling	factors	 used  by  JPEG	 or  MPEG-2  encoder  and YUV
	      decoder/encoder.

       -scenes 
	      range of image scene numbers to read

       -shared-memory
	      use shared memory

       -size x{+offset}
	      width and height of the image

       -strip strip the image of any profiles or comments

       -swap 
	      swap two images in the image sequence

       -text-font 
	      font for writing fixed-width text

       -title 
	      assign title to displayed image [animate, display, montage]

       -treedepth 
	      tree depth for the color reduction algorithm

       -trim  trim an image

       -verbose
	      print detailed information about the image

       -version
	      print ImageMagick version string

       -visual 
	      animate images using this X visual type

       -window 
	      make image the background of a window

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


	      Any  option  you	specify on the command line remains in effect
	      for the group of images following it, until the group is termi-
	      nated  by	 the appearance of any option or -noop.	 For example,
	      to animate three images, the first with 32 colors,  the  second
	      with  an unlimited number of colors, and the third with only 16
	      colors, use:


		   animate -colors 32 cockatoo.1 -noop cockatoo.2
			   -colors 16 cockatoo.3

	      Animate options can appear on the command line  or  in  your  X
	      resources file. See X(1). Options on the command line supersede
	      values specified in your X resources file.  Image filenames may
	      appear  in any order on the command line if the image format is
	      MIFF (refer to miff(5) and the scene keyword  is	specified  in
	      the  image. Otherwise the images will display in the order they
	      appear on the command line.

MOUSE BUTTONS
       Press any button to map or unmap the Command widget. See the next sec-
       tion for more information about the Command widget.

COMMAND WIDGET
       The Command widget lists a number of sub-menus and commands. They are

	   Animate

	       Open
	       Play
	       Step
	       Repeat
	       Auto Reverse

	   Speed

	       Faster
	       Slower

	   Direction

	       Forward
	       Reverse

	   Image Info
	   Help
	   Quit


       Menu  items  with a indented triangle have a sub-menu. They are repre-
       sented above as the indented items. To access a	sub-menu  item,	 move
       the  pointer to the appropriate menu and press a button and drag. When
       you find the desired sub-menu item, release the button and the command
       is  executed.   Move  the pointer away from the sub-menu if you decide
       not to execute a particular command.

KEYBOARD ACCELERATORS
	       Ctl+O

		    .in 20 Press to load an image from a file.
	       space

		    .in 20 Press to display the next image in the sequence.
	       <

		    .in 20 Press to  speed-up  the  display  of	 the  images.
		    Refer to -delay for more information.
	       >

		    .in 20 Press to slow the display of the images.  Refer to
		    -delay for more information.
	       ?

		    .in 20 Press to  display  information  about  the  image.
		    Press any key or button to erase the information.
		    This information is printed: image name;  image size; and
		    the total number of unique colors in the image.
	       F1

		    .in 20 Press to display helpful  information  about	 ani-
		    mate(1).
	       Ctl-q

		    .in 20 Press to discard all images and exit program.


X RESOURCES
       Animate	options	 can appear on the command line or in your X resource
       file. Options on the command line supersede values specified in your X
       resource file. See X(1) for more information on X resources.

       All  animate options have a corresponding X resource. In addition, the
       animate program uses the following X resources:

	       background (class Background)

		    .in 20

		    Specifies the preferred color to use for the Image window
		    background. The default is #ccc.
	       borderColor (class BorderColor)

		    .in 20

		    Specifies the preferred color to use for the Image window
		    border. The default is #ccc.
	       borderWidth (class BorderWidth)

		    .in 20

		    Specifies the width in pixels of the Image window border.
		    The default is 2.
	       font (class Font or FontList)

		    .in 20

		    Specifies the name of the preferred font to use in normal
		    formatted text.  The default is 14 point Helvetica.
	       foreground (class Foreground)

		    .in 20

		    Specifies the preferred color to use for text within  the
		    Image window.  The default is black.
	       geometry (class geometry)

		    .in 20

		    Specifies  the  preferred  size and position of the image
		    window. It is not necessarily obeyed by all	 window	 man-
		    agers.   Offsets,  if present, are handled in X(1) style.
		    A negative x offset is measured from the  right  edge  of
		    the	 screen to the right edge of the icon, and a negative
		    y offset is measured from the bottom edge of  the  screen
		    to the bottom edge of the icon.
	       iconGeometry (class IconGeometry)

		    .in 20

		    Specifies the preferred size and position of the applica-
		    tion when iconified.  It is not necessarily obeyed by all
		    window managers.  Offsets, if present, are handled in the
		    same manner as in class Geometry.
	       iconic (class Iconic)

		    .in 20

		    This resource indicates that you would  prefer  that  the
		    application's  windows initially not be visible as if the
		    windows had be immediately iconified by you. Window	 man-
		    agers  may choose not to honor the application's request.
	       matteColor (class MatteColor)

		    .in 20

		    Specify the color of windows. It is used  for  the	back-
		    grounds  of	 windows,  menus, and notices. A 3D effect is
		    achieved by using highlight	 and  shadow  colors  derived
		    from this color. Default value: #ddd.
	       name (class Name)

		    .in 20

		    This  resource  specifies  the name under which resources
		    for the application should be  found.  This	 resource  is
		    useful  in	shell  aliases to distinguish between invoca-
		    tions of an application, without  resorting	 to  creating
		    links  to  alter the executable file name. The default is
		    the application name.
	       sharedMemory (class SharedMemory)

		    .in 20

		    This resource specifies whether  animate  should  attempt
		    use	 shared	 memory for pixmaps. ImageMagick must be com-
		    piled with shared memory support, and  the	display	 must
		    support  the  MIT-SHM extension. Otherwise, this resource
		    is ignored. The default is True.
	       text_font (class textFont)

		    .in 20

		    Specifies the name of the preferred font to use in	fixed
		    (typewriter	 style)	 formatted  text.  The	default is 14
		    point Courier.
	       title (class Title)

		    .in 20

		    This resource specifies the title  to  be  used  for  the
		    Image  window.  This  information  is sometimes used by a
		    window manager to provide some sort of header identifying
		    the window. The default is the image file name.


ENVIRONMENT
       COLUMNS
	      Output  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.

       DISPLAY
	      X11 display ID (host, display number, and screen	in  the	 form
	      hostname:display.screen).

       HOME   Location	of  user's  home  directory. ImageMagick searches for
	      configuration files in $HOME/.magick if the  directory  exists.
	      See  MAGICK_CODER_MODULE_PATH,  MAGICK_CONFIGURE_PATH, and MAG-
	      ICK_FILTER_MODULE_PATH if more flexibility is needed.

       MAGICK_CODER_MODULE_PATH
	      Search path to use when searching for image format  coder	 mod-
	      ules.   This  path  allows  the  user to arbitrarily extend the
	      image formats supported by ImageMagick by adding loadable	 mod-
	      ules 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.

       MAGICK_CONFIGURE_PATH
	      Search path to use  when	searching  for	configuration  (.mgk)
	      files.  The formatting of the search path is similar to operat-
	      ing system search paths (i.e. colon  delimited  for  Unix,  and
	      semi-colon  delimited  for Microsoft Windows). This user speci-
	      fied search path is used before trying the default search path.

       MAGICK_DEBUG
	      Debug options (see -debug for details)

       MAGICK_FILTER_MODULE_PATH
	      Search  path  to	use when searching for filter process modules
	      (invoked via -process). This path allows the user to  arbitrar-
	      ily  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.

       MAGICK_FONT_PATH
	      Directory	 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 MAGICK_FONT_PATH.

       MAGICK_HOME
	      Path  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.

       MAGICK_DISK_LIMIT
	      Maximum amount of disk space  allowed  for  use  by  the	pixel
	      cache.

       MAGICK_FILES_LIMIT
	      Maximum number of open files.

       MAGICK_MAP_LIMIT
	      Maximum size of a memory map.

       MAGICK_MEMORY_LIMIT
	      Maximum amount of memory to allocate from the heap.

       MAGICK_TMPDIR
	      Path  to	directory  where  ImageMagick  should write temporary
	      files. The default is to use the system default, or  the	loca-
	      tion set by TMPDIR.

       TMPDIR For POSIX-compatible systems (Unix-compatible), the path to the
	      directory where all applications should write temporary  files.
	      Overridden by MAGICK_TMPDIR if it is set.

       TMP or TEMP
	      For Microsoft Windows, the path to the directory where applica-
	      tions should write temporary files. Overridden by MAGICK_TMPDIR
	      if it is set.

CONFIGURATION FILES
       ImageMagick uses a number of XML format configuration files:

       colors.mgk
	      colors configuration file

		
		
		  
		

       delegates.mgk
	      delegates configuration file

       log.mgk
	      logging configuration file

		
		
		  
		  
		  
		  
		  
		  
		

       magic.mgk
	      file header magic test configuration file

		
		
		  
		

       modules.mgk
	      loadable modules configuration file

		
		
		  
		

       type.mgk
	      master type (fonts) configuration file

		
		
		  
		  
		

ACKNOWLEDGEMENTS


		    The MIT  X	Consortium  for	 making	 network  transparent
		    graphics a reality.


		    Michael Halle, Spatial Imaging Group at MIT, for the ini-
		    tial implementation of Alan Paeth's image rotation	algo-
		    rithm.


		    David  Pensak, duPont, for providing a computing environ-
		    ment that made this program possible.
		     Paul Raveling, USC Information Sciences Institute.

		    The spatial	 subdivision  color  reduction	algorithm  is
		    based on his Img software.


SEE ALSO
       display(1),   composite(1),   conjure(1),   convert(1),	 identify(1),
       ImageMagick(1), import(1), mogrify(1), montage(1)


COPYRIGHT
       Copyright (C) 1999-2004 ImageMagick Studio LLC. Additional  copyrights
       and   licenses	apply  to  this	 software,  see	 http://www.imagemag-
       ick.org/www/Copyright.html



ImageMagick		  Date: 2004/01/01 01:00:00		   animate(1)


UNIX/Linux commands referenced on this page:
  1. file
  2. display
  3. time
  4. true
  5. xstdcmap
  6. more
  7. size
  8. enable
  9. last
  10. strip
  11. profiles
  12. make
  13. as
  14. find
  15. which
  16. links
  17. sort
  18. date
  19. look
  20. write
  21. test
  22. at