]> granicus.if.org Git - imagemagick/blob - QuickStart.txt
(no commit message)
[imagemagick] / QuickStart.txt
1 This file documents how to use the binary distribution packages built by
2 ImageMagick Studio LLC, and found in the ImageMagick 'binaries' subdirectory
3 of ImageMagick ftp sites.  Those who want to build ImageMagick from source
4 code should refer to the file README.txt in the ImageMagick source package
5 or http://www.imagemagick.org/script/install-source.php on the web.
6
7 Unix/Linux/Darwin/Mac OS X/Cygwin/MinGW Install:
8
9   Download the appropriate binary from
10
11      ftp://ftp.imagemagick.org/pub/ImageMagick/binaries
12
13   Create (or choose) a directory to install the package into and change to that
14   directory, for example:
15
16      cd $HOME
17
18   Extract the contents of the package using the command
19
20      gzip -dc /path/to/package.tar.gz | tar -xf -
21
22   If the 'bin' subdirectory of the extracted package is not already in your
23   executable search path, add it to your PATH environment variable.  For
24   example
25
26      export PATH; PATH="$HOME/ImageMagick/bin:$PATH"
27
28   Set the MAGICK_HOME environment variable to the path where you extracted the
29   ImageMagick files. For example
30
31      export MAGICK_HOME="$HOME/ImageMagick-6.6.2"
32
33   On Linux and Solaris machines set the LD_LIBRARY_PATH environment variable:
34
35      export LD_LIBRARY_PATH="$HOME/ImageMagick-6.6.2/lib"
36
37   On Mac OS X (Darwin) machines set the DYLD_LIBRARY_PATH environment variable:
38
39      export DYLD_LIBRARY_PATH="$HOME/ImageMagick-6.6.2/lib"
40
41   Now, test ImageMagick to see if it is working
42
43      convert logo: logo.gif
44      display logo.gif
45
46   To install PerlMagick type
47
48       cd ImageMagick-6.6.2/PerlMagick
49       perl Makefile.PL
50       make
51       make install
52
53   Additional Information
54
55     Environment Variables:
56
57       In addition to the MAGICK_HOME environment variable defined above, you may
58       find these variables useful:
59
60         MAGICK_TMPDIR           path to store temporary files
61         LD_LIBRARY_PATH         path to libMagick.so and other libraries
62
63     Configuration Files
64
65       ImageMagick depends on a number of external configuration files which
66       include colors.xml, delegates.xml, magic.xml, coder.xml, and others.
67       ImageMagick searches for configuration files in the following order, and
68       loads them if found:
69
70           $MAGICK_CONFIGURE_PATH
71           $MAGICK_HOME/lib/ImageMagick-6.6.2/config
72           $MAGICK_HOME/share/ImageMagick-6.6.2/config
73           $HOME/.magick/
74           <client path>/lib/ImageMagick-6.6.2/
75           <current directory>/
76
77     Font Files
78
79       ImageMagick is able to load raw TrueType and Postscript font files.  It
80       searches for the font configuration file, type.xml, in the following
81       order, and loads them if found:
82
83           $MAGICK_CONFIGURE_PATH
84           $MAGICK_HOME/lib/ImageMagick-6.6.2/config
85           $MAGICK_HOME/share/ImageMagick-6.6.2/config
86           $HOME/.magick/
87           <client path>/lib/ImageMagick-6.6.2/
88           <current directory>/
89           $MAGICK_FONT_PATH
90
91     Module Files
92
93       ImageMagick's file format support is usually provided in the form of
94       loadable modules. It searches for loadable modules in the following order
95       and it uses the first match found:
96
97           <current directory>/
98           $MAGICK_HOME/lib/ImageMagick-6.6.2/modules-Q16/coders/
99           $HOME/.magick/
100           <client path>/../lib/ImageMagick-6.6.2/modules-Q16/coders/
101           $MAGICK_HOME/lib/ImageMagick-6.6.2/modules-Q16/coders
102           $MAGICK_HOME/share/ImageMagick-6.6.2/modules-Q16/coders
103           $HOME/.magick/
104           <client path>/lib/ImageMagick-6.6.2/modules-Q16/coders
105           <current directory>/
106
107 Windows Vista, XP, and NT Install:
108
109   Download one of
110
111       ftp://ftp.imagemagick.org/pub/ImageMagick/binaries/ImageMagick-6.6.2-0-Q16-windows-dll.exe
112       ftp://ftp.imagemagick.org/pub/ImageMagick/binaries/ImageMagick-6.6.2-0-Q16-windows-static.exe
113       ftp://ftp.imagemagick.org/pub/ImageMagick/binaries/ImageMagick-6.6.2-0-Q8-windows-dll.exe
114       ftp://ftp.imagemagick.org/pub/ImageMagick/binaries/ImageMagick-6.6.2-0-Q8-windows-static.exe
115
116   and execute it (or "open" it from your browser) to start the installation
117   program.
118
119   Once ImageMagick is installed, Select Start->Programs->Command Prompt.  In
120   the Command Prompt window type
121
122       convert logo: logo.gif
123       imdisplay logo.gif
124
125   If you have an X11 server, from the Command Prompt window type
126
127       set DISPLAY=:0
128       display
129
130 VMS Install:
131
132   Type
133
134       unzip ImageMagick.zip
135       set default [.imagemagick]
136       @make
137       identify -verbose logo: