> "I swear by my life and my love of it that I will never live for the sake of another man, nor ask another man to live for mine"

> John Galt in Atlas Shrugged, by Ayn Rand

Contents

- Author
- Availability
- WWW
- Mailing List
- UNIX Compilation
- Delegates
- How to Compile
- VMS Compilation
- Windows Win2K/95 VISUAL C++ 6.0 COMPILATION
- Macintosh Compilation
- Copyright

Author

  The author is magick@wizards.dupont.com. This software is NOT shareware. However, I am interested in who might be using it. Please consider sending me a picture postcard of the area where you live. Send postcards to

          John Cristy
          P.O. Box 40
          Landenberg, PA  19350
          USA

  I'm also interested in receiving coins or stamps from around the world for my collection.

Back to Contents

Availability

  ImageMagick, is available on ftp.cdrom.com. ImageMagick client executables are available for some platforms. Macintosh, Win2k, VMS, and Linux source and binaries are also available.

I want ImageMagick to be of high quality, so if you encounter a problem I will investigate. However, be sure you are using the most recent version from ftp.cdrom.com, or a mirror site, before submitting any bug reports or suggestions. Report any problems via the web-based reporting facility.

Back to Contents

WWW

  The official ImageMagick WWW page is at www.imagemagick.org.
  To use display as your external image viewer, edit the global mailcap file or your personal mailcap file .mailcap (located in your home directory) and put this entry:

          image/*; display %s

Back to Contents

Mailing List

  There is a mailing list for discussions and bug reports about ImageMagick. To subscribe send the message

          subscribe magick

to majordomo@imagemagick.org. You will receive a welcome message which tells you how to post messages to the list magick-users@imagemagick.org.

Back to Contents

UNIX Compilation

  Type:

          gzip -dc ImageMagick-5.2.2.tar.gz | tar xvf -
          cd ImageMagick-5.2.2

  If you do not have `gunzip`, it is available on prep.ai.mit.edu.

Use `configure` to automatically configure, build, and install ImageMagick.

If you are willing to accept configure's default options, type:

          ./configure

and watch the configure script output to verify that it finds everything that you think it should. If it does not, then adjust your environment so that it does.

If you are not happy with configure's choice of compiler, compilation flags, or libraries, you can give `configure` initial values for variables by setting them in the environment. Using a Bourne-compatible shell, you can do that on the command line like this:

        CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure

Or on systems that have the `env` program, you can do it like this

        env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure

The configure variables you should be aware of are:

            CC          Name of C compiler (e.g. 'cc -Xa') to use
            CFLAGS      Compiler flags (e.g. '-g -O2') to compile with
            CPPFLAGS    Include paths (-I/somedir) to look for header files
            LDFLAGS     Library paths (-L/somedir) to look for libraries
                        Systems that support the notion of a library
                        run-path may additionally require -R/somedir or
                        '-rpath /somedir' in order to find shared libraries
                        at run time.
            LIBS        Extra libraries (-lsomelib) required to link

Any variable (e.g. CPPFLAGS or LDFLAGS) which requires a directory path must specify an absolute path rather than a relative path.

By default, `make install` will install the package's files in `/usr/local/bin`, `/usr/local/man`, etc. You can specify an installation prefix other than `/usr/local` by giving configure the option `--prefix=PATH`.

Configure can usually find the X include and library files automatically, but if it doesn't, you can use the configure options `--x-includes=DIR` and `--x-libraries=DIR` to specify their locations.

The configure script provides a number of ImageMagick specific options. When disabling an option --disable-something is equivalent to specifying --enable-something=no and --without-something is equivalent to --with-something=no. The configure options are as follows (execute `configure --help` to see all options).

        --enable-shared[=PKGS]  build shared libraries [default=no]
        --enable-static[=PKGS]  build static libraries [default=yes]
        --enable-lzw            enable LZW support (default is no)
        --enable-16bit-pixel    enable 16 bit/quantum pixels (default is no)
        --with-threads          enable threads support
        --with-cache            set pixel cache threshhold (default 80MB)
        --without-frozenpaths   disable frozen delegate paths
        --without-largefiles    disable support for large (64 bit) file offsets
        --without-perl          disable build/install of PerlMagick
        --without-bzlib         disable BZLIB support
        --without-dps           disable Display Postscript support
        --without-fpx           disable FlashPIX support
        --without-hdf           disable HDF support
        --without-jbig          disable JBIG support
        --without-jpeg          disable JPEG support
        --without-png           disable PNG support
        --without-tiff          disable TIFF support
        --without-ttf           disable TrueType support
        --with-ttf-fontpath     set default TrueType font path (default none)
        --without-xml           disable XML support
        --without-zlib          disable ZLIB support
        --with-x                use the X Window System

ImageMagick options represent either features to be enabled, disabled, or packages to be included in the build. When a feature is enabled (via `--enable-something`), it enables code already present in ImageMagick. When a package is enabled (via `--with-something`), the configure script will search for it, and if is is properly installed and ready to use (headers and built libraries are found by compiler) it will be included in the build. The configure script is delivered with all features disabled and all packages enabled. In general, the only reason to disable a package is if a package exists but it is unsuitable for the build (perhaps an old version or not compiled with the right compilation flags).

Several configure options require special note:

- `--enable-shared` the shared libraries are built. Shared libraries are valuable because they are shared across more than one invocation of an ImageMagick or PerlMagick client. In addition, the clients take much less disk space and shared libraries are required in order for PERL to dynamically load the PerlMagick extension.

ImageMagick built with delegates (see MAGICK PLUG-INS below) can pose additional challenges. You can build all the delegates statically and link them into the ImageMagick shared library (i.e. libMagick.so) or alternatively you can build the delegates as shared libraries (some systems already have delegates installed as shared libraries). Shared libraries compilation flags differ from vendor to vendor (gcc's is -fPIC). However, you must compile all shared library source with the same flag (for gcc use -fPIC rather than -fpic).

- `--disable-static` static archive libraries (with extension .a) are not built. If you are building shared libraries, there is little value to building static libraries. Reasons to build static libraries include 1) they can be easier to debug; 2) the clients do not have external dependencies (i.e. libMagick.so); 3) building PIC versions of the delegate libraries may take additional expertise and effort; 4) you are unable to build shared libraries.
- `--with-modules` image format coders are built as loadable modules which are installed in [prefix]/lib/ImageMagick/modules/coders. Support for modules allows the formats supported by ImageMagick to be extended by simply adding additional modules to the module search path. The modules option is only available in conjunction with --enable-shared. If --enable-shared is not also specified, then support for modules is disabled.
- `--enable-lzw` Unisys reportedly claims a patent on the algorithm supporting LZW compression (e.g. used by GIF and TIFF). To avoid possibly infringing on this patent, support for LZW is disabled by default. With LZW support, GIF files written by ImageMagick will be much larger than expected.
- `--enable-16bit-pixel` By default ImageMagick represents images internally using an eight-bit pixel quantum (red, green, blue, and alpha component). Scientific applications, or other specialized applications, which must ensure that the full dynamic range of the image pixels is preserved across operations, or which must process an image format that can represent deep pixels, may want to enable support for sixteen-bit pixel quantums. When this option is specified, the definition QuantumLeap is applied when ImageMagick is built, allowing RGBA values to range from 0 to 65535 rather than 0 to 255. Enabling this option will cause ImageMagick to run about 30% slower.
- `--without-frozenpaths` By default, the configure script will determine the location of all delegates (external programs) and incorporate the full paths within the delegates.mgk file. This is the default because it is assumed that the installer's environment is appropriately configured and that the operation of ImageMagick should not be subject to the end-user's environment. However, if it is desireable to allow the end user to define their own environment or possible that the end user's environment does not match the installer's environment (e.g. for binary distributions), --without-frozenpaths may be specified so that only the delegate's name is included in the delegates.mgk file.
- `--with-threads` By default, the ImageMagick library is compiled without multi-thread support. This is fine for the utilities, and for use in single-threaded applications. When multi-threaded applications are to be used with the ImageMagick library, thread safety should be selected via --with-threads. Multi-thread support is disabled by default since a thread-safe ImageMagick may run slower (OS dependent) due to additional locking within the C library (e.g. in malloc()).
- `--with-cache` Specify a different image pixel cache threshold using the --with-cache option. When ImageMagick will have more image pixel data in memory than the cache threshold setting, additional images are cached on disk. Since memory is much faster than disk, it is usually better to use memory rather than disk for the pixel cache. On large memory machines, the cache threshold may be increased to a larger size than the default of 80MB. Small memory machines may want to decrease the threshold.
- `--without-largefiles` By default, ImageMagick is compiled with support for large (> 2GB on a 32-bit CPU) files if the operating system supports large files. All applications which use the ImageMagick library must then also include support for large files. By disabling support for large files via --without-largefiles, dependent applications do not require special compilation options for large files in order to use the library.
- `--without-perl` By default, PerlMagick is conveniently compiled and installed in one step. When --without-perl is specified, you must first install ImageMagick, change to the PerlMagick subdirectory, build, and finally install PerlMagick. Note, PerlMagick is configured even if --without-perl is specified. If --enable-shared is not specified, a new PERL interpreter (PerlMagick) is built which is statically linked against the PerlMagick extension. This new interpreter is installed alongside your existing PERL interpreter. If --enable-shared is specified, the PerlMagick extension is built as a dynamically loadable object which is loaded into your current PERL interpreter at run-time. Use of dynamically-loaded extensions is preferable over statically linked extensions so --enable-shared should be specified if possible. If the argument --with-perl=/path/tto/perl is supplied, then /path/to/perl will be taken as the PERL interpreter to use.
- `--without-x` By default, ImageMagick will use X11 libraries if they are available. When --without-x is specified, use of X11 is disabled. The display, animate, and import programs are not built or installed. The remaining programs have reduced functionality such as no access to X11 fonts (consider using Postscript or TrueType fonts instead).

Building under Cygwin:

ImageMagick may be built under the Windows Win2K/'9X Cygwin Unix-emulation environment which may be downloaded from Cygnus. Pre-compiled X11R6.4 libraries for Cygwin are available from NASA. Use the same procedure as for Unix except that building DLLs is not yet supported so do not specify `--enable-shared` option to configure.

Dealing with configuration failures:

While configure is designed to ease installation of ImageMagick, it often discovers problems that would otherwise be encountered later when compiling ImageMagick. The configure script tests for headers and libraries by executing the compiler (CC) with the specified compilation flags (CFLAGS), pre-processor flags (CPPFLAGS), and linker flags (LDFLAGS). Any errors are logged to the file `config.log`. If configure fails to discover a header or library please review this log file to determine why, however, please be aware that *errors in the config.log are normal* because configure works by trying something and seeing if it fails. An error in `config.log` is only a problem if the test should have worked on your system.. After taking corrective action, be sure to remove the `config.cache` file before running configure so that configure will re-inspect the environment rather than using cached values.

Common causes of configure falures are: 1) a delegate header is not in the header include path (CPPFLAGS -I option); 2) a delegate library is not in the linker search/run path (LDFLAGS -L/-R option); 3) a delegate library is missing a function (old version?); 4) compilation environment is faulty.

If all reasonable corrective actions have been tried and the problem appears to be due to a flaw in the configure script, please send a bug report to the configure script maintainer (currently bfriesen@simple.dallas.tx.us). All bug reports should contain the operating system type (as reported by `uname -a`) and the compiler/compiler-version. A copy of the configure script output and/or the `config.log` file may be valuable in order to find the problem. If you send a `config.log`, please also send a script of the configure output and a description of what you expected to see (and why) so the failure you are observing can be identified and resolved.

  To confirm your build of the ImageMagick distribution was successful, type:

          display

  If the program faults make sure that you may have inadvertingly linked to an older version of the libMagick library. In this case type

          cd ImageMagick/magick
          make install
          cd ..
          make

If the image colors are not correct use this command

          display -visual default

  You can find other example images in the images directory.

For additional information, see the manual pages for these ImageMagick utilities

  display
  convert
  montage
  identify
  animate
  import
  mogrify
  combine

Also read the ImageMagick Frequently Asked Questions This is a required reading. Most of the questions I get via electronic mail are answered in this document.
  Place display X application defaults in /usr/lib/X11/app-defaults/Display. Use the appropriate name for other clients (e.g. Animate, Montage, etc). To execute display from as a menu item of any window manager (olwm, mwm, twm, etc), use

        display logo:Untitled

Back to Contents

Delegates

  To further enhance the capabilities of ImageMagick, you may want to get these programs or libraries:

BZLIB

  ImageMagick requires the BZLIB library to read or write BZip compressed MIFF images.

LCMS

  ImageMagick requires the LCMS library to perform color management tasks.

RALCGM

  ImageMagick requires ralcgm to read Computer Graphic Metafile images (may not compile under linux). You also need Ghostscript (see below).

TransFig

  ImageMagick requires fig2dev to read TransFig images.

wget

  ImageMagick requires wget to read images specified with a World Wide Web (WWW) uniform resource locator (URL).

FreeType

  ImageMagick requires the FreeType software, version 2.0 or above, to annotate with TrueType fonts.

HDF

  ImageMagick requires the NCSA HDF library to read and write the HDF image format.

HTML2PS

  ImageMagick requires html2ps to read HyperText Markup Language (html) documents.

JBIG

  ImageMagick requires the JBIG-Kit software to read and write the JBIG image format.

JPEG

  ImageMagick requires the Independent JPEG Group's software to read and write the JPEG image format.
  Apply the lossless JPEG patch to Independent JPEG Group's source distribution to read lossless jpeg-encoded DICOM images:

Concerning iterative JPEG compression: see Kinoshita and Yamamuro, Journal of Imaging Science and Technology, Image Quality with Reiterative JPEG Compression, Volume 39, Number 4, July 1995, 306-312 who claim that (1) the iterative factor of the repetitive JPEG operation had no influence on image quality, and (2) the first compression determined base image quality.

MPEG

  ImageMagick requires the MPEG encoder / decoder to read or write the MPEG image format.

PNG

  ImageMagick requires the PNG library, version 1.0 or above, to read the PNG image format.

Postscript

  ImageMagick requires Ghostscript software to read the PostScript or the Portable Document format. It is used to annotate an image when an X server is not available. See the FreeType library above for another means to annotate an image. Note, Ghostscript must support the ppmraw device (type gs -h to verify). If Ghostscript is unavailable, the Display Postscript extension is used to rasterize a Postscript document (assuming you define HasDPS). The DPS extension is less robust than Ghostscript in that it will only rasterize one page of a multi-page document.

RA_PPM

  ImageMagick requires ra_ppm from Greg Ward's Radiance software to read the Radiance image format (may not compile under linux).

RAWTORLE

  ImageMagick requires rawtorle from the Utah Raster Toolkit to write the RLE image format (may not compile under linux)..

SANE

  ImageMagick requires scanimage to import images from a scanner device.

TIFF

  ImageMagick requires Sam Leffler's TIFF software to read and write the TIFF image format. It in turn optionally requires the JPEG and ZLIB libraries.

WMF

  ImageMagick requires wmftopng to read Windows Meta File images.

X Server

  ImageMagick requires an X server for display and animate to work properly. This free X server is available for Windows and Macintosh.

XML

  ImageMagick requires the XML library to read SVG images.

ZLIB

  ImageMagick requires the ZLIB library to read or write PNG or ZLIB compressed MIFF images.

Back to Contents

How to Compile

Back to Contents

VMS Compilation

  You might want to check the values of certain program definitions before compiling. Verify the definitions in `delegates.mgk` to suit your local requirements. Next, type:

          unzip ImageMagick-5.2.2.zip
          set default [.imagemagick]
          @make
          set display/create/node=node_name::

  where node_name is the DECNET X server to contact.
Finally type:

          display

  Alternatively, get a zipped distribution (with JPEG, PNG, TIFF, and TTF) from ftp.cdrom.com.
  The VMS JPEG, PNG, TIFF, and TTF source libraries are available on axp.psl.ku.dk in [anonymous.decwindows.lib].
  Thanks to pmoreau@cenaath.cena.dgac.fr for supplying invaluable help as well as the VMS versions of the JPEG, PNG, TIFF, and TTF libraries.

Back to Contents

Windows Win2K/95 Visual C++ 6.0 Compilation

  The Visual C++ distribution targeted at Windows Win2k or Windows 95 does not provide any stock workspace (DSW) or project files (DSP) except for those included with third party libraries. Instead, there is a `configure` program that must be built and run that creates an environment that meets your particular needs. The issue with the Visual C++ working environement is that there are a fairly large number of mutually exclusive options that must all be used in a coherent manner, or problems result. The Visual C++ system provides three different types of runtimes that must match across all application, library, and DLL code that is built. `Configure` creates a set of build files that are consistent for a specific runtime selection. The three options for runtime support are: 1) Multi-threaded DLL runtimes 2) Single-threaded library runtimes 3) Multi-threaded library runtimes In addition to these runtimes, the VisualMagick build environement allows you to select the way the ImageMagick components will be built. The three options for this are: 1) Everything as DLL's - using real X11 libraries 2) Everything as DLL's - using stubbed out X11 libraries 3) Everything as static libraries - always using stubbed out X11. This leads to five different possible build options, which should cover almost any particular situation. The default binary distribution is built using #1 from the first list and #1 from the second list. This results in an X11 compatible build using all DLL's for everything and multi-threaded support (the only option for DLL's). To do a build for your requirements, simply go to the configure sub- directory under VisualMagick and open the configure.dsw workspace. Set the build configuration to "Release" under the

        "Build..., Set Active Configuration..."  menu

Build and execute the configure program and follow the instructions. You should probably not change any of the defaults unless you have a specific reason to do so. After creating you build environment you can proceed to open the DSW file that was generated and build everything from there. In the final DSW file you will find a project call "All". In order to build everything in the distribution, select this project and make it the "active" project. Set the build configuration to the desired one (Debug, or Release) and do a "clean" followed by a "build". You should do the build in a specific way:

      1) Make the "All" prkect the active project (Bold)
         Right click on the All project and select "Set As Active Project"
      2) Select "Build..., Clean"
      3) Select "Build..., Build"
      4) Go get some coffee unless you have a very fast machine.

The Clean step is needed in order to make sure that all of the target support libraries are updated with any patches needed to get them to compile properly under Visual C++. All of the required files that are needed to run any of the command line tools will be found in the "bin" subdirectory of the VisualMagick subdirectory. This includes EXE, and DLL files. You should be able to test the build directly from this directory without having to move anything to any of the global SYSTEM or SYSTEM32 areas in the operating system installation. NOTE #1: The Visual C++ distribution of ImageMagick comes with the Magick++ C++ wrapper by default. This add-on layer has a large number of demo and test files that can be found in ImageMagick\Magick++\demos, and ImageMagick\Magick++\tests. None of these programs are configured to be built in the default workspace created by the configure program. You can have any of these programs added to your build configuration by simply dragging them into their corresponding folder from:

        ImageMagick\Magick++\demo, or ImageMagick\Magick++\tests

to:

        ImageMagick\demos, or ImageMagick\Magick++\tests

After running the configure program, you should see projects for all of the programs you have added which will now be part of the entire build procedure. You can also use this technique for your opwn development if you wish. When creating a new application, simply grab one of the demo or test programs that is close to what you wish to do, rename it, and drop it into the demos or tests folder to get an appropriate project file. NOTE #2: The two utilities "display" and "animate" will only be usable when the real X11 libraries are included. The other build environments uses the X11 stubs to supply non-functional stubs for the X-Window functionality. There is no support for a "static" build of the X11 support because the build procedures for the X11 libraries do not seem to support this. To view any image in a Microsoft window, type

        convert image.ext win:

Make sure gswin32 (Ghostscript) is in your execution path (see Autoexec.bat), otherwise, you will be unable to convert or view a Postscript document.

Make sure `iexplore` (Internet Explorer) is in your execution path (see `Autoexec.bat`), otherwise, you will be unable to browse the ImageMagick documentation.

The Win2K executables will work under Windows 95/98.

Back to Contents

Macintosh Compilation

  The Macintosh Macintosh distribution contains MetroWerks Codewarrior Professional projects for compilation. For those who do not have access to CodeWarrior, the binaries for the command line utilities are enclosed. I had to comment the inline intrinsic functions in `math.h` in order to compile. If you have a better solution, let me know. Display, animate, and import currently do not work on the Macintosh.

Back to Contents

Copyright

  Copyright (C) 2001 ImageMagick Studio
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files ("ImageMagick"), to deal in ImageMagick without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of ImageMagick, and to permit persons to whom the ImageMagick is furnished to do so, subject to the following conditions:
  The above copyright notice and this permission notice shall be included in all copies or substantial portions of ImageMagick.
  The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement.In no event shall ImageMagick Studio be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with ImageMagick or the use or other dealings in ImageMagick.
  Except as contained in this notice, the name of the E. I. du Pont de Nemours and Company shall not be used in advertising or otherwise to promote the sale, use or other dealings in ImageMagick without prior written authorization from the ImageMagick Studio.

Image manipulation software that works like magic.