README

   1 ================================================================
   2 Copyright (c) 1999-2001 Arnar M. Hrafnkelsson. All rights reserved.
   3 Copyright (c) 2004 Anthony Cook.
   4 This program is free software; you can redistribute it and/or
   5 modify it under the same terms as Perl itself.
   6 ================================================================
   7
   8 >> THIS SOFTWARE COMES WITH ABSOLUTELY NO WARRANTY WHATSOEVER <<
   9 If you like or hate Imager, please let us know by sending mail
  10 to imager@imager.perl.org
  11
  12 ================================================================
  13
  14
  15 ========================
  16 1. Patent infringements?
  17 ========================
  18
  19 Imager as such contains no patented algorithms.  The external
  20 libraries (which are not written by me) may or may not contain
  21 patented algorithms.  YOU ARE SOLELY RESPONSIBLE FOR OBTAINING
  22 LICENSE(S) TO USE SUCH LIBRARIES SHOULD YOU NEED ANY.
  23
  24
  25 ========================
  26 2. Compiling and testing
  27 ========================
  28
  29 Some care has been taken to make the installation as smooth as
  30 possible.  This is rather hard due to the difference between operating
  31 systems and site setups.  To get started just type
  32
  33 $ perl Makefile.PL
  34
  35 It should blurb out a list of which libraries were found and which
  36 not.  If you add a library to the machine after installing Imager it
  37 does not automatically become available in Imager.  It only uses the
  38 libraries that are found.  If the list of found libraries is not what
  39 you expected, then the Makefile.PL is either not searching in the
  40 right directories or your box does not have the libraries you think it
  41 does.  For a list of where to get the libraries have a look at
  42 3. External dependencies.  To widen the search path for libraries and
  43 include files set the IM_INCPATH and IM_LIBPATH variables.  The
  44 environment variables that matter when Makefile.PL is run are
  45
  46 IM_INCPATH      colon separated list of paths to extra include files
  47 IM_LIBPATH      colon separated list of paths to extra library files
  48
  49 IM_VERBOSE      turns on verbose mode for the library scanning and such
  50 IM_MANUAL       to manually select which libraries are used and which not
  51 IM_NOLOG        if true logging will not be compiled into the module
  52 IM_DEBUG_MALLOC if true malloc debugging will be compiled into the module
  53                 do not use IM_DEBUG_MALLOC in production - this slows
  54                 everything down
  55
  56 IM_CFLAGS       Extra flags to pass to the compiler
  57 IM_LFLAGS       Extra flags to pass to the linker
  58 IM_DFLAGS       Extra flags to pass to the preprocessor
  59
  60
  61
  62 When finding the libraries has been sorted out it's time for
  63
  64 $ make
  65
  66 and if that works then do
  67
  68 $ make test
  69
  70 If either fails do take a peek at the file errep.perl.  It's creates a
  71 file report.txt.  This is some information which will help me discover
  72 where the problem is so I can try to fix it in future releases.  If
  73 you find running it ok (just remember - no warranty!) please send the
  74 report.txt via email to addi@umich.edu .
  75
  76 Troubleshooting tips:
  77
  78 A common problem is that libgif/libungif are sometimes linked to the X
  79 libraries and then running the tests fails.  In that case something
  80 like:
  81
  82 $ IM_LFLAGS="-L/usr/X11R6/lib -lX11" perl Makefile.PL
  83
  84 Which simply sets the environment variables for the extra libraries
  85 to include the X libraries (which we do not use at all, but must
  86 included since libgif has been linked with it).
  87
  88 Otherwise you could just build giflib without any X11 dependencies:
  89
  90   # must be a clean tree
  91   cd giflib-4.1.0
  92   ./configure --without-x ...
  93
  94 Also note that libgif has a few bugs: You can run something like
  95
  96 $ perl -Iblib/lib -Iblib/arch t/t105gif.t
  97
  98 This way you can see what comments the test script prints out.
  99 t/t105gif.t checks for an bug in libgif and prints out a patch
 100 if that bug is present, note that this bug only affects the more
 101 "advanced" features of libgif.
 102
 103 If for some reason you have libungif-devel package installed but
 104 not libungif on RedHat then you will probably get lots of errors
 105 like undefined symbol: FreeSavedImages when running make test.
 106 Install libungif package to fix it.
 107
 108 Stock libungif 4.1.2 or later seems to fix all of the bugs, if you
 109 have a problem that version of linungif (or later), let us know and
 110 we'll look into it.
 111
 112 Imager needs to have a libtiff version of at least 3.5.5.  In the
 113 future we might consider supporting older libtiff versions.  For
 114 now you can either configure Imager manually (by
 115 setting the IM_MANUAL environment variable to 1, in sh:
 116
 117 $ IM_MANUAL=1 perl Makefile.PL
 118
 119 and simply say no to tiff support when asked if you want it, the same thing
 120 can be used to circumvent problems in gifs to get Imager going.
 121
 122
 123 If it worked just continue with the installation as normally
 124 (with make install).
 125
 126 ========================
 127 3. External dependencies
 128 ========================
 129
 130 Some hints about getting the Imager module to find the libraries it
 131 needs for specific features.  The libraries it uses are:
 132
 133  jpeg: http://www.ijg.org/files/
 134        ftp://ftp.uu.net/graphics/jpeg/jpegsrc.v6b.tar.gz
 135
 136 ftp.uu.net is still linked from many places, including the Independent
 137 JPEG Groups's home page, but it is non-functional.
 138
 139   png: http://www.libpng.org/pub/png/libpng.html
 140
 141   you also need zlib to use png:  http://www.gzip.org/zlib/
 142 We have encountered problems with libpng 1.0.1, which were fixed in 1.0.5
 143 Note: you should probably be using zlib 1.1.4, since 1.1.3 has a
 144 potential security problem.
 145
 146   gif: http://sourceforge.net/projects/libungif
 147
 148 giflib/libungif has come a long way since the buggy versions around
 149 when Imager's gif support code was written.  Preferably you should get
 150 at least version 4.1.2.  If you have a recent Linux distribution you
 151 should be safe with whatever giflib it provides, but if you're
 152 building from source, please try to use the latest version.
 153
 154 At the time of writing you will need to manually select to install the
 155 4.1.2-1 of cygwin's libungif package.
 156
 157  tiff: http://www.libtiff.org/
 158
 159    t1: http://www.ibiblio.org/pub/Linux/libs/graphics/
 160
 161    tt: http://www.freetype.org/
 162
 163 Precompiled versions of some of the libraries might be found at:
 164
 165 AIX:
 166    http://www.bullfreeware.com/
 167
 168
 169
 170 ========================
 171 4. Logging and debugging
 172 ========================
 173
 174 Logging is compiled in by default - if you should want to get of it
 175 from the binaries you can do so by setting the env IMAGER_NOLOG
 176 to something. If you want to enable malloc debugging to check for leaks
 177 then set IMAGER_DEBUG_MALLOC to something.  Needless to say it is
 178 pretty pointless to have malloc debug enabled with no logging since you
 179 can never see the malloc information that way.
 180
 181
 182 =================
 183 5. Win32 Support
 184 =================
 185
 186 Imager can be installed on Win32 systems.  This was ported and tested
 187 with Microsoft Visual C++ 6.0 with build 623 of ActivePerl.  You can
 188 use all of the features of Imager.  You can also use Win32 GDI fonts
 189 directly by supplying the 'face' parameter to Imager::Font->new(...).
 190
 191 I've tested with both MSVC++ 6.0 and cygwin (perl 5.6.1).
 192
 193 If you see an error under cygwin during testing along the lines of:
 194
 195   C:\cygwin\bin\perl.exe: *** unable to remap C:\cygwin\...some dll to the
 196     same address as parent (0x...) != 0x....
 197
 198 you will need to install the cygwin rebase package and run:
 199
 200   $ rebaseall -v
 201
 202 Under cygwin you will need at least libungif 4.1.2 installed to
 203 prevent lockups in the gif test scripts.  At the time of writing you
 204 need to select libungif-4.1.2-1 manually in the setup.exe installation
 205 tool.
 206
 207 If you have any problems with the Win32 support, please email
 208 tony@develop-help.com (don't forget to use nmake instead of make).
 209
 210 =======================
 211 6. General information
 212 =======================
 213
 214 The Imager module homepage is currently at:
 215
 216  http://imager.perl.org/
 217
 218 The current docs are rather bad as I've been busy adding features
 219 but hopefully they will be updated soon.  Until then you'll just
 220 have to use the source. The test scripts might also be a good idea.
 221 By activating the the #init_log lines in the test script you can get
 222 rather verbose debugging output from the C code.
 223
 224
 225 ========================
 226 7. Thanks
 227 ========================
 228
 229 Thanks go to:
 230   Tony Cook           ( TonyC )
 231   Claes Jacobson      ( Claes )
 232   Philip Gwyn         ( Leolo )
 233   Michael Slade       ( Micksa )
 234                       ( Cogent )
 235   Brad Murray         ( HalfJack )
 236   Nicholas Dronen     ( Veblen )
 237   Michael G Schwern   ( Schwern )
 238   Rocco Caputo        ( Dngor )
 239   Graham barr         ( Gbarr )
 240   Mark-Jason Dominus  ( Mjd )
 241   Jerome
 242   Jason Alexander     ( Jalex )
 243   Randal R. Schwartz  ( Merlyn )
 244   Tkil                ( )
 245   Artur Bergman       ( Sky )
 246   Luc St-Louis        ( Lucs )
 247   PerlJam             ( )
 248   Roderick Schertler  ( Roderick )
 249   Nathan Torkington   ( gnat )
 250
 251 (and just to play it safe) all those I forgot to mention.