blob: f25ef4948425c5d1516b0b38ac0ae71b1d4ff99a [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +00001This file documents how to use the binary distribution packages built by
2ImageMagick Studio LLC, and found in the ImageMagick 'binaries' subdirectory
Elliott Hughes5d41fba2021-04-12 16:36:42 -07003of ImageMagick download sites. Those who want to build ImageMagick from source
Cristy1eccad32018-09-09 19:34:39 -04004code should refer to https://imagemagick.org/script/install-source.php.
cristy3ed852e2009-09-05 21:47:34 +00005
6Unix/Linux/Darwin/Mac OS X/Cygwin/MinGW Install:
7
8 Download the appropriate binary from
9
Elliott Hughes5d41fba2021-04-12 16:36:42 -070010 https://download.imagemagick.org/ImageMagick/download/binaries
cristy3ed852e2009-09-05 21:47:34 +000011
12 Create (or choose) a directory to install the package into and change to that
13 directory, for example:
14
15 cd $HOME
16
17 Extract the contents of the package using the command
18
19 gzip -dc /path/to/package.tar.gz | tar -xf -
20
21 If the 'bin' subdirectory of the extracted package is not already in your
22 executable search path, add it to your PATH environment variable. For
23 example
24
25 export PATH; PATH="$HOME/ImageMagick/bin:$PATH"
26
27 Set the MAGICK_HOME environment variable to the path where you extracted the
28 ImageMagick files. For example
29
Elliott Hughes5d41fba2021-04-12 16:36:42 -070030 export MAGICK_HOME="$HOME/ImageMagick-7.0.11"
cristy3ed852e2009-09-05 21:47:34 +000031
32 On Linux and Solaris machines set the LD_LIBRARY_PATH environment variable:
33
Elliott Hughes5d41fba2021-04-12 16:36:42 -070034 export LD_LIBRARY_PATH="$HOME/ImageMagick-7.0.11/lib"
cristy3ed852e2009-09-05 21:47:34 +000035
36 On Mac OS X (Darwin) machines set the DYLD_LIBRARY_PATH environment variable:
37
Elliott Hughes5d41fba2021-04-12 16:36:42 -070038 export DYLD_LIBRARY_PATH="$HOME/ImageMagick-7.0.11/lib"
cristy3ed852e2009-09-05 21:47:34 +000039
40 Now, test ImageMagick to see if it is working
41
42 convert logo: logo.gif
43 display logo.gif
44
45 To install PerlMagick type
46
Elliott Hughes5d41fba2021-04-12 16:36:42 -070047 cd ImageMagick-7.0.11/PerlMagick
cristy3ed852e2009-09-05 21:47:34 +000048 perl Makefile.PL
49 make
50 make install
51
52 Additional Information
53
54 Environment Variables:
55
56 In addition to the MAGICK_HOME environment variable defined above, you may
57 find these variables useful:
58
59 MAGICK_TMPDIR path to store temporary files
60 LD_LIBRARY_PATH path to libMagick.so and other libraries
61
62 Configuration Files
63
64 ImageMagick depends on a number of external configuration files which
Dirk Lemstrae2939a42018-10-04 23:20:08 +020065 include colors.xml, delegates.xml, and others.
cristy3ed852e2009-09-05 21:47:34 +000066 ImageMagick searches for configuration files in the following order, and
67 loads them if found:
68
69 $MAGICK_CONFIGURE_PATH
cristy5d3be3b2011-04-01 14:40:46 +000070 $MAGICK_HOME/etc/ImageMagick
Elliott Hughes5d41fba2021-04-12 16:36:42 -070071 $MAGICK_HOME/share/ImageMagick-7.0.11/config
cristy9f3b4fc2014-02-08 14:56:20 +000072 $HOME/.config/ImageMagick/
cristyed6fae02011-04-01 14:32:17 +000073 <client path>/etc/ImageMagick/
cristy3ed852e2009-09-05 21:47:34 +000074 <current directory>/
75
76 Font Files
77
78 ImageMagick is able to load raw TrueType and Postscript font files. It
79 searches for the font configuration file, type.xml, in the following
80 order, and loads them if found:
81
82 $MAGICK_CONFIGURE_PATH
cristy5d3be3b2011-04-01 14:40:46 +000083 $MAGICK_HOME/etc/ImageMagick
Elliott Hughes5d41fba2021-04-12 16:36:42 -070084 $MAGICK_HOME/share/ImageMagick-7.0.11/config
cristy9f3b4fc2014-02-08 14:56:20 +000085 $HOME/.config/ImageMagick/
cristyed6fae02011-04-01 14:32:17 +000086 <client path>/etc/ImageMagick/
cristy3ed852e2009-09-05 21:47:34 +000087 <current directory>/
88 $MAGICK_FONT_PATH
89
90 Module Files
91
92 ImageMagick's file format support is usually provided in the form of
93 loadable modules. It searches for loadable modules in the following order
94 and it uses the first match found:
95
96 <current directory>/
cristyed6fae02011-04-01 14:32:17 +000097 $MAGICK_HOME/etc/ImageMagick/modules-Q16/coders/
cristy9f3b4fc2014-02-08 14:56:20 +000098 $HOME/.config/ImageMagick/
cristyed6fae02011-04-01 14:32:17 +000099 <client path>/../etc/ImageMagick/modules-Q16/coders/
100 $MAGICK_HOME/etc/ImageMagick/modules-Q16/coders
Elliott Hughes5d41fba2021-04-12 16:36:42 -0700101 $MAGICK_HOME/share/ImageMagick-7.0.11/modules-Q16/coders
cristy9f3b4fc2014-02-08 14:56:20 +0000102 $HOME/.config/ImageMagick/
cristyed6fae02011-04-01 14:32:17 +0000103 <client path>/etc/ImageMagick/modules-Q16/coders
cristy3ed852e2009-09-05 21:47:34 +0000104 <current directory>/
105
106Windows Vista, XP, and NT Install:
107
108 Download one of
109
Elliott Hughes5d41fba2021-04-12 16:36:42 -0700110 https://download.imagemagick.org/download/ImageMagick/binaries/ImageMagick-7.0.11-15-Q16-windows-dll.exe
111 https://download.imagemagick.org/download/ImageMagick/binaries/ImageMagick-7.0.11-15-Q16-windows-static.exe
112 https://download.imagemagick.org/download/ImageMagick/binaries/ImageMagick-7.0.11-15-Q8-windows-dll.exe
113 https://download.imagemagick.org/download/ImageMagick/binaries/ImageMagick-7.0.11-15-Q8-windows-static.exe
cristy3ed852e2009-09-05 21:47:34 +0000114
115 and execute it (or "open" it from your browser) to start the installation
116 program.
117
118 Once ImageMagick is installed, Select Start->Programs->Command Prompt. In
119 the Command Prompt window type
120
121 convert logo: logo.gif
122 imdisplay logo.gif
123
124 If you have an X11 server, from the Command Prompt window type
125
126 set DISPLAY=:0
127 display
128
129VMS Install:
130
131 Type
132
133 unzip ImageMagick.zip
134 set default [.imagemagick]
135 @make
136 identify -verbose logo: