3 ImageMagick builds on a variety of Unix and Unix-like operating systems
4 including Linux, Solaris, FreeBSD, Mac OS X, and others. A compiler is
5 required and fortunately almost all modern Unix systems have one. Download
6 ImageMagick.tar.gz from ftp.imagemagick.org or its mirrors and verify the
7 distribution against its message digest.
9 Unpack the distribution it with this command:
11 $magick> tar xvfz ImageMagick.tar.gz
13 Now that you have the ImageMagick Unix/Linux source distribution unpacked,
18 The configure script looks at your environment and decides what it can cobble
19 together to get ImageMagick compiled and installed on your system. This
20 includes finding a compiler, where your compiler header files are located
21 (e.g. stdlib.h), and if any delegate libraries are available for ImageMagick
22 to use (e.g. JPEG, PNG, TIFF, etc.). If you are willing to accept configure's
23 default options, and build from within the source directory, you can simply
26 $magick> cd ImageMagick-6.5.9
29 Watch the configure script output to verify that it finds everything that
30 you think it should. Pay particular attention to the last lines of the script
31 output. For example, here is a recent report from our system:
33 ImageMagick is configured as follows. Please verify that this configuration
34 matches your expectations.
36 Host system type: x86_64-unknown-linux-gnu
37 Build system type: x86_64-unknown-linux-gnu
40 ----------------------------------------------------------------------------
41 Shared libraries --enable-shared=yes yes
42 Static libraries --enable-static=yes yes
43 Module support --with-modules=yes yes
44 GNU ld --with-gnu-ld=yes yes
45 Quantum depth --with-quantum-depth=16 16
46 High Dynamic Range Imagery
49 Delegate Configuration:
50 BZLIB --with-bzlib=yes yes
51 Autotrace --with-autotrace=yes yes
52 DJVU --with-djvu=yes no
54 FlashPIX --with-fpx=yes no
55 FontConfig --with-fontconfig=yes yes
56 FreeType --with-freetype=yes yes
57 GhostPCL None pcl6 (unknown)
58 GhostXPS None gxps (unknown)
59 Ghostscript None gs (8.63)
60 result_ghostscript_font_dir='none'
61 Ghostscript fonts --with-gs-font-dir=default
62 Ghostscript lib --with-gslib=yes no (failed tests)
63 Graphviz --with-gvc=yes yes
65 JPEG v1 --with-jpeg=yes yes
66 JPEG-2000 --with-jp2=yes yes
67 LCMS --with-lcms=yes yes
69 Magick++ --with-magick-plus-plus=yes yes
70 OpenEXR --with-openexr=yes yes
71 PERL --with-perl=yes /usr/bin/perl
72 PNG --with-png=yes yes
73 RSVG --with-rsvg=yes yes
74 TIFF --with-tiff=yes yes
75 result_windows_font_dir='none'
76 Windows fonts --with-windows-font-dir=
77 WMF --with-wmf=yes yes
79 XML --with-xml=yes yes
80 ZLIB --with-zlib=yes yes
84 X_PRE_LIBS = -lSM -lICE
88 Options used to compile and link:
90 EXEC-PREFIX = /usr/local
93 CFLAGS = -fopenmp -g -O2 -Wall -W -pthread
94 MAGICK_CFLAGS = -fopenmp -g -O2 -Wall -W -pthread
95 CPPFLAGS = -I/usr/local/include/ImageMagick
97 DEFS = -DHAVE_CONFIG_H
99 MAGICK_LDFLAGS = -L/usr/local/lib -lfreetype
100 LIBS = -lMagickCore -llcms -ltiff -lfreetype -ljpeg
101 -lfontconfig -lXext -lSM -lICE -lX11 -lXt -lbz2 -lz
102 -lm -lgomp -lpthread -lltdl
104 CXXFLAGS = -g -O2 -Wall -W -pthread
106 You can influence choice of compiler, compilation flags, or libraries of the
107 configure script by setting initial values for variables in the configure
108 command line. These include, among others:
111 Name of C compiler (e.g. cc -Xa) to use.
114 Name of C++ compiler to use (e.g. CC).
117 Compiler flags (e.g. -g -O2) to compile C code.
120 Compiler flags (e.g. -g -O2) to compile C++ code.
123 Include paths (.e.g. -I/usr/local) to look for header files.
126 Library paths (.e.g. -L/usr/local) to look for libraries systems that
127 support the notion of a library run-path may require an additional
128 argument in order to find shared libraries at run time. For example,
129 the Solaris linker requires an argument of the form -R/path. Some
130 Linux systems will work with -rpath /usr/local/lib, while some other
131 Linux systems who's gcc does not pass -rpath to the linker, require
132 an argument of the form -Wl,-rpath,/usr/local/lib.
135 Extra libraries (.e.g. -l/usr/local/lib) required to link.
137 Here is an example of setting configure variables from the command line:
139 $magick> ./configure CC=c99 CFLAGS=-O2 LIBS=-lposix
141 Any variable (e.g. CPPFLAGS or LDFLAGS) which requires a directory path must
142 specify an absolute path rather than a relative path.
144 Configure can usually find the X include and library files automagically,
145 but if it doesn't, you can use the --x-includes=path and --x-libraries=path
146 options to specify their locations.
148 The configure script provides a number of ImageMagick specific
149 options. When disabling an option --disable-something is equivalent to
150 specifying --enable-something=no and --without-something is equivalent to
151 --with-something=no. The configure options are as follows (execute configure
152 --help to see all options).
154 ImageMagick options represent either features to be enabled, disabled,
155 or packages to be included in the build. When a feature is enabled (via
156 --enable-something), it enables code already present in ImageMagick. When a
157 package is enabled (via --with-something), the configure script will search
158 for it, and if is properly installed and ready to use (headers and built
159 libraries are found by compiler) it will be included in the build. The
160 configure script is delivered with all features disabled and all packages
161 enabled. In general, the only reason to disable a package is if a package
162 exists but it is unsuitable for the build (perhaps an old version or not
163 compiled with the right compilation flags).
165 Here are the optional features you can configure:
168 build the shared libraries and support for loading coder and process
169 modules. Shared libraries are preferred because they allow programs
170 to share common code, making the individual programs much smaller. In
171 addition shared libraries are required in order for PerlMagick to be
172 dynamically loaded by an installed PERL (otherwise an additional PERL
173 (PerlMagick) must be installed.
175 ImageMagick built with delegates (see MAGICK PLUG-INS below) can pose
176 additional challenges. If ImageMagick is built using static libraries (the
177 default without --enable-shared) then delegate libraries may be built as
178 either static libraries or shared libraries. However, if ImageMagick is
179 built using shared libraries, then all delegate libraries must also be
180 built as shared libraries. Static libraries usually have the extension
181 .a, while shared libraries typically have extensions like .so, .sa, or
182 .dll. Code in shared libraries normally must compiled using a special
183 compiler option to produce Position Independent Code (PIC). The only
184 time this not necessary is if the platform compiles code as PIC by
187 PIC compilation flags differ from vendor to vendor (gcc's is
188 -fPIC). However, you must compile all shared library source with the
189 same flag (for gcc use -fPIC rather than -fpic). While static libraries
190 are normally created using an archive tool like ar, shared libraries
191 are built using special linker or compiler options (e.g. -shared for gcc).
193 If --enable-shared is not specified, a new PERL interpreter (PerlMagick)
194 is built which is statically linked against the PerlMagick extension. This
195 new interpreter is installed into the same directory as the ImageMagick
196 utilities. If --enable-shared is specified, the PerlMagick extension is
197 built as a dynamically loadable object which is loaded into your current
198 PERL interpreter at run-time. Use of dynamically-loaded extensions is
199 preferable over statically linked extensions so use --enable-shared if
200 possible (note that all libraries used with ImageMagick must be shared
204 static archive libraries (with extension .a) are not built. If you
205 are building shared libraries, there is little value to building static
206 libraries. Reasons to build static libraries include: 1) they can be
207 easier to debug; 2) clients do not have external dependencies (i.e.
208 libMagick.so); 3) building PIC versions of the delegate libraries may
209 take additional expertise and effort; 4) you are unable to build shared
213 disable building an installed ImageMagick (default enabled).
215 By default the ImageMagick build is configured to formally install
216 into a directory tree. This the most secure and reliable way to install
217 ImageMagick. Use this option to configure ImageMagick so that it doesn't
218 use hard-coded paths and locates support files by computing an offset path
219 from the executable (or from the location specified by the MAGICK_HOME
220 environment variable. The uninstalled configuration is ideal for binary
221 distributions which are expected to extract and run in any location.
224 enable 'ccmalloc' memory debug support (default disabled).
227 enable 'prof' profiling support (default disabled).
230 enable 'gprof' profiling support (default disabled).
234 enable 'gcov' profiling support (default disabled).
236 disable OpenMP (default enabled).
238 Certain ImageMagick algorithms, for example convolution, can achieve
239 a significant speed-up with the assistance of the OpenMP API when
240 running on modern dual and quad-core processors.
243 disable support for large (64 bit) file offsets.
245 By default, ImageMagick is compiled with support for large files (>
246 2GB on a 32-bit CPU) if the operating system supports large files. Some
247 applications which use the ImageMagick library may also require support
248 for large files. By disabling support for large files via
249 --disable-largefile, dependent applications do not require special
250 compilation options for large files in order to use the library.
252 Here are the optional packages you can configure:
255 number of bits in a pixel quantum (default 16).
257 Use this option to specify the number of bits to use per pixel quantum
258 (the size of the red, green, blue, and alpha pixel components). For
259 example, --with-quantum-depth=8 builds ImageMagick using 8-bit quantums.
260 Most computer display adapters use 8-bit quantums. Currently supported
261 arguments are 8, 16, or 32. We recommend the default of 16 because
262 some image formats support 16 bits-per-pixel. However, this option is
263 important in determining the overall run-time performance of ImageMagick.
265 The number of bits in a quantum determines how many values it may
266 contain. Each quantum level supports 256 times as many values as the
267 previous level. The following table shows the range available for various
270 Quantum Depth Valid Range (Decimal) Valid Range (Hex)
273 32 0-4294967295 00000000-FFFFFFFF
275 Larger pixel quantums can cause ImageMagick to run more slowly and to
276 require more memory. For example, using sixteen-bit pixel quantums can
277 cause ImageMagick to run 15% to 50% slower (and take twice as much memory)
278 than when it is built to support eight-bit pixel quantums.
280 The amount of virtual memory consumed by an image can be computed by
281 the equation (5 * Quantum Depth * Rows * Columns) / 8. This an important
282 consideration when resources are limited, particularly since processing
283 an image may require several images to be in memory at one time. The
284 following table shows memory consumption values for a 1024x768 image:
286 Quantum Depth Virtual Memory
292 accurately represent the wide range of intensity levels (experimental).
294 --enable-osx-universal-binary
295 build a universal binary on OS X.
298 disable support for dynamically loadable modules.
300 Image coders and process modules are built as loadable modules which are
301 installed under the directory [prefix]/lib/ImageMagick-X.X.X/modules-QN
302 (where 'N' equals 8, 16, or 32 depending on the quantum depth) in the
303 subdirectories coders and filters respectively. The modules build option
304 is only available in conjunction with --enable-shared. If --enable-shared
305 is not also specified, support for building modules is disabled. Note that
306 if --enable-shared and --disable-modules are specified, the module loader
307 is active (allowing extending an installed ImageMagick by simply copying
308 a module into place) but ImageMagick itself is not built using modules.
311 set pixel cache threshold (defaults to available memory).
313 Specify a different image pixel cache threshold with this option. This
314 sets the maximum amount of heap memory that ImageMagick is allowed to
315 consume before switching to using memory-mapped temporary files to store
319 disable threads support.
321 By default, the ImageMagick library is compiled with multi-thread
322 support. If this undesirable, specify --without-threads.
325 enable frozen delegate paths.
327 Normally, external program names are substituted into the delegates.xml
328 configuration file without full paths. Specify this option to enable
329 saving full paths to programs using locations determined by configure.
330 This useful for environments where programs are stored under multiple
331 paths, and users may use different PATH settings than the person who
334 --without-magick-plus-plus
335 disable build/install of Magick++.
337 Disable building Magick++, the C++ application programming interface
338 to ImageMagick. A suitable C++ compiler is required in order to build
339 Magick++. Specify the CXX configure variable to select the C++ compiler
340 to use (default g++), and CXXFLAGS to select the desired compiler
341 optimization and debug flags (default -g -O2). Antique C++ compilers
342 will normally be rejected by configure tests so specifying this option
343 should only be necessary if Magick++ fails to compile.
346 disable build/install of PerlMagick, or
348 By default, PerlMagick is conveniently compiled and installed as part
349 of ImageMagick's normal configure, make, sudo make install process. When
350 --without-perl is specified, you must first install ImageMagick, change to
351 the PerlMagick subdirectory, build, and finally install PerlMagick. Note,
352 PerlMagick is configured even if --without-perl is specified. If the
353 argument --with-perl=/path/to/perl is supplied, /../path/to/perl is be
354 taken as the PERL interpreter to use. This important in case the perl
355 executable in your PATH is not PERL5, or is not the PERL you want to use.
358 use specified Perl binary to configure PerlMagick.
360 --with-perl-options=OPTIONS
361 options to pass on command-line when generating PerlMagick's Makefile
364 The PerlMagick module is normally installed using the Perl interpreter's
365 installation PREFIX, rather than ImageMagick's. If ImageMagick's
366 installation prefix is not the same as PERL's PREFIX, then you
367 may find that PerlMagick's sudo make install step tries to install
368 into a directory tree that you don't have write permissions to. This
369 common when PERL is delivered with the operating system or on Internet
370 Service Provider (ISP) web servers. If you want PerlMagick to install
371 elsewhere, then provide a PREFIX option to PERL's configuration step
372 via "--with-perl-options=PREFIX=/some/place". Other options accepted by
373 MakeMaker are 'LIB', 'LIBPERL_A', 'LINKTYPE', and 'OPTIMIZE'. See the
374 ExtUtils::MakeMaker(3) manual page for more information on configuring
378 disable BZLIB support.
381 disable Display Postscript support.
384 enable FlashPIX support.
387 disable TrueType support.
390 enable Ghostscript library support.
393 disable JBIG support.
396 disable JPEG support.
399 disable JPEG v2 support.
402 disable LCMS support.
405 disable LZMA support.
411 disable TIFF support.
417 prepend to default font search path.
420 directory containing Ghostscript fonts.
422 Specify the directory containing the Ghostscript Postscript Type 1 font
423 files (e.g. n022003l.pfb) so that they can be rendered using the FreeType
424 library. If the font files are installed using the default Ghostscript
425 installation paths (${prefix}/share/ghostscript/fonts), they should
426 be discovered automagically by configure and specifying this option is
427 not necessary. Specify this option if the Ghostscript fonts fail to be
428 located automagically, or the location needs to be overridden.
430 --with-windows-font-dir
431 directory containing MS-Windows fonts.
433 Specify the directory containing MS-Windows-compatible fonts. This not
434 necessary when ImageMagick is running under MS-Windows.
440 disable ZLIB support.
443 don't use the X Window System.
445 By default, ImageMagick uses the X11 delegate libraries if they are
446 available. When --without-x is specified, use of X11 is disabled. The
447 display, animate, and import sub-commands are not included. The remaining
448 sub-commands have reduced functionality such as no access to X11 fonts
449 (consider using Postscript or TrueType fonts instead).
451 --with-share-path=DIR
452 Alternate path to share directory (default share/ImageMagick).
455 use libstdc++ in DIR (for GNU C++).
457 While configure is designed to ease installation of ImageMagick, it often
458 discovers problems that would otherwise be encountered later when compiling
459 ImageMagick. The configure script tests for headers and libraries by
460 executing the compiler (CC) with the specified compilation flags (CFLAGS),
461 pre-processor flags (CPPFLAGS), and linker flags (LDFLAGS). Any errors are
462 logged to the file config.log. If configure fails to discover a header or
463 library please review this log file to determine why, however, please be
464 aware that *errors in the config.log are normal* because configure works by
465 trying something and seeing if it fails. An error in config.log is only a
466 problem if the test should have passed on your system.
468 Common causes of configure failures are: 1) a delegate header is not in the
469 header include path (CPPFLAGS -I option); 2) a delegate library is not in
470 the linker search/run path (LDFLAGS -L/-R option); 3) a delegate library is
471 missing a function (old version?); or 4) compilation environment is faulty.
473 If all reasonable corrective actions have been tried and the problem appears
474 be due to a flaw in the configure script, please send a bug report to the
475 ImageMagick Defect Support Forum. All bug reports should contain the operating
476 system type (as reported by uname -a) and the compiler/compiler-version. A
477 copy of the configure script output and/or the relevant portion of config.log
478 file may be valuable in order to find the problem. If you post portions
479 of config.log, please also send a script of the configure output and a
480 description of what you expected to see (and why) so the failure you are
481 observing can be identified and resolved.
483 ImageMagick is now configured and ready to build
487 Once ImageMagick is configured, these standard build targets are available
488 from the generated make files:
497 Run tests using the installed ImageMagick (sudo make install must be
498 done first). Ghostscript is a prerequisite, otherwise the EPS, PS,
499 and PDF tests will fail.
502 Remove everything in the build directory created by make.
505 remove everything in the build directory created by configure and
506 make. This useful if you want to start over from scratch.
509 Remove all files from the system which are (or would be) installed by sudo
510 make install using the current configuration. Note that this target is
511 imperfect for PerlMagick since Perl no longer supports an uninstall
514 In most cases you will simply wand to compile ImageMagick with this command:
518 Once built, you can optionally install ImageMagick on your system as
523 Now that ImageMagick is configured and built, type:
525 $magick> make install
529 By default, ImageMagick is installs binaries in /../usr/local/bin, libraries
530 in /../usr/local/lib, header files in /../usr/local/include and documentation
531 in /../usr/local/share. You can specify an alternative installation prefix
532 other than /../usr/local by giving configure the option --prefix=PATH. This
533 valuable in case you don't have privileges to install under the default
534 paths or if you want to install in the system directories instead.
536 To confirm your installation of the ImageMagick distribution was successful,
537 ensure that the installation directory is in your executable search path
542 The ImageMagick logo is displayed on your X11 display.
544 To verify the ImageMagick build configuration, type:
546 $magick> identify -list configure
548 To list which image formats are supported , type:
550 $magick> identify -list format
552 For a more comprehensive test, you run the ImageMagick test suite by typing:
556 Ghostscript is a prerequisite, otherwise the EPS, PS, and PDF tests will
557 fail. Note that due to differences between the developer's environment and
558 your own it is possible that a few tests may fail even though the results are
559 ok. Differences between the developer's environment environment and your own
560 may include the compiler, the CPU type, and the library versions used. The
561 ImageMagick developers use the current release of all dependent libraries.
563 Linux-specific Build instructions
565 Download ImageMagick.src.rpm from ftp.imagemagick.org or its mirrors and
566 verify the distribution against its message digest.
568 Build ImageMagick with this command:
570 $magick> rpmbuild --rebuild ImageMagick.src.rpm
572 After the build you, locate the RPMS folder and install the ImageMagick
573 binary RPM distribution:
575 $magick> rpm -ivh ImageMagick-6.5.9-?.*.rpm
577 MinGW-specific Build instructions
579 Although you can download and install delegate libraries yourself, many
580 are already available in the GnuWin32 distribution. Download and install
581 whichever delegate libraries you require such as JPEG, PNG, TIFF, etc. Make
582 sure you specify the development headers when you install a package. Next
585 $magick> tar jxvf ImageMagick-6.5.9-?.tar.bz2
586 $magick> cd ImageMagick-6.5.9
587 $magick> export CPPFLAGS="-Ic:/Progra~1/GnuWin32/include"
588 $magick> export LDFLAGS="-Lc:/Progra~1/GnuWin32/lib"
589 $magick> ./configure --without-perl
590 $magick> make $magick> sudo make install
592 Dealing with Unexpected Problems
594 Chances are the download, configure, build, and install of ImageMagick went
595 flawlessly as it is intended, however, certain systems and environments may
596 cause one or more steps to fail. We discuss a few problems we've run across
597 and how to take corrective action to ensure you have a working release
602 If the build complains about missing dependencies (e.g. .deps/source.PLO),
603 add --disable-dependency-tracking to your configure command line.
605 Some systems may fail to link at build time due to unresolved symbols. Try
606 adding the LDFLAGS to the configure command line:
608 $magick> configure LDFLAGS='-L/usr/local/lib -R/usr/local/lib'
610 Dynamic Linker Run-time Bindings
612 On some systems, ImageMagick may not find its shared library, libMagick.so. Try
613 running the ldconfig with the library path:
615 $magick> /sbin/ldconfig /usr/local/lib
617 Solaris and Linux systems have the ldd command which is useful to track which
618 libraries ImageMagick depends on:
620 $magick> ldd `which convert`
624 On occasion you may receive these warnings:
626 no decode delegate for this image format
627 no encode delegate for this image format
629 This exception indicates that an external delegate library or its headers
630 were not available when ImageMagick was built. To add support for the image
631 format, download and install the requisite delegate library and its header
632 files and reconfigure, rebuild, and reinstall ImageMagick. As an example,
633 lets add support for the JPEG image format. First we install the JPEG RPMS:
635 $magick> yum install libjpeg libjpeg-devel
637 Now reconfigure, rebuild, and reinstall ImageMagick. To verify JPEG is now
638 properly supported within ImageMagick, use this command:
640 $magick> identify -list format
642 You should see a mode of rw- associated with the JPEG tag. This mode means
643 the image can be read or written and can only support one image per image
648 If PerlMagick fails to link with a message similar to libperl.a is not found,
649 rerun configure with the --enable-shared or --enable-shared --with-modules
projects / imagemagick / blob