granicus.if.org Git - imagemagick/blob - 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 https://imagemagick.org/script/install-source.php.
   5
   6 Unix/Linux/Darwin/Mac OS X/Cygwin/MinGW Install:
   7
   8   Download the appropriate binary from
   9
  10      ftp://ftp.imagemagick.org/pub/ImageMagick/binaries
  11
  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
  30      export MAGICK_HOME="$HOME/ImageMagick-7.0.2"
  31
  32   On Linux and Solaris machines set the LD_LIBRARY_PATH environment variable:
  33
  34      export LD_LIBRARY_PATH="$HOME/ImageMagick-7.0.2/lib"
  35
  36   On Mac OS X (Darwin) machines set the DYLD_LIBRARY_PATH environment variable:
  37
  38      export DYLD_LIBRARY_PATH="$HOME/ImageMagick-7.0.2/lib"
  39
  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
  47       cd ImageMagick-7.0.2/PerlMagick
  48       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
  65       include colors.xml, delegates.xml, and others.
  66       ImageMagick searches for configuration files in the following order, and
  67       loads them if found:
  68
  69           $MAGICK_CONFIGURE_PATH
  70           $MAGICK_HOME/etc/ImageMagick
  71           $MAGICK_HOME/share/ImageMagick-7.0.2/config
  72           $HOME/.config/ImageMagick/
  73           <client path>/etc/ImageMagick/
  74           <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
  83           $MAGICK_HOME/etc/ImageMagick
  84           $MAGICK_HOME/share/ImageMagick-7.0.2/config
  85           $HOME/.config/ImageMagick/
  86           <client path>/etc/ImageMagick/
  87           <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>/
  97           $MAGICK_HOME/etc/ImageMagick/modules-Q16/coders/
  98           $HOME/.config/ImageMagick/
  99           <client path>/../etc/ImageMagick/modules-Q16/coders/
 100           $MAGICK_HOME/etc/ImageMagick/modules-Q16/coders
 101           $MAGICK_HOME/share/ImageMagick-7.0.2/modules-Q16/coders
 102           $HOME/.config/ImageMagick/
 103           <client path>/etc/ImageMagick/modules-Q16/coders
 104           <current directory>/
 105
 106 Windows Vista, XP, and NT Install:
 107
 108   Download one of
 109
 110       ftp://ftp.imagemagick.org/pub/ImageMagick/binaries/ImageMagick-7.0.2-0-Q16-windows-dll.exe
 111       ftp://ftp.imagemagick.org/pub/ImageMagick/binaries/ImageMagick-7.0.2-0-Q16-windows-static.exe
 112       ftp://ftp.imagemagick.org/pub/ImageMagick/binaries/ImageMagick-7.0.2-0-Q8-windows-dll.exe
 113       ftp://ftp.imagemagick.org/pub/ImageMagick/binaries/ImageMagick-7.0.2-0-Q8-windows-static.exe
 114
 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
 129 VMS Install:
 130
 131   Type
 132
 133       unzip ImageMagick.zip
 134       set default [.imagemagick]
 135       @make
 136       identify -verbose logo: