]> git.imager.perl.org - imager.git/blobdiff - README
- i_img_pal_new() now releases the image object memory if creation
[imager.git] / README
diff --git a/README b/README
index eb504c9dd96a93089189f7f0923764017d648c4b..0dde365467b439a18cb845b3ee928970f6e1a172 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,12 @@
 ================================================================
-Copyright (c) 1999, 2000 Arnar M. Hrafnkelsson. All rights reserved.
+Copyright (c) 1999-2001 Arnar M. Hrafnkelsson. All rights reserved.
 This program is free software; you can redistribute it and/or
 modify it under the same terms as Perl itself.
 ================================================================
 
 >> THIS SOFTWARE COMES WITH ABSOLUTELY NO WARRANTY WHATSOEVER <<
+If you like or hate Imager, please let us know by sending mail 
+to imager@imager.perl.org
 
 ================================================================
 
@@ -82,18 +84,33 @@ Which simply sets the environment variables for the extra libraries
 to include the X libraries (which we do not use at all, but must
 included since libgif has been linked with it).
 
+Otherwise you could just build giflib without any X11 dependencies:
+
+  # must be a clean tree
+  cd giflib-4.1.0
+  ./configure --without-x ...
+
 Also note that libgif has a few bugs: You can run something like
 
-$ perl -Iblib/lib -Iblib/arch t/t10formats.t
+$ perl -Iblib/lib -Iblib/arch t/t105gif.t
 
 This way you can see what comments the test script prints out.
-t/t10formats.t checks for an bug in libgiff and prints out a patch
+t/t105gif.t checks for an bug in libgif and prints out a patch
 if that bug is present, note that this bug only affects the more
 "advanced" features of libgif.
 
-Imager needs to have a fairly recent libtiff installed (we know it
-it runs fine with 3.5.5).  In the future we might consider supporting older
-libtiff versions.  For now you can either configure Imager manually (by
+If for some reason you have libungif-devel package installed but
+not libungif on RedHat then you will probably get lots of errors
+like undefined symbol: FreeSavedImages when running make test.
+Install libungif package to fix it.
+
+Stock libungif 4.1.2 or later seems to fix all of the bugs, if you
+have a problem that version of linungif (or later), let us know and
+we'll look into it.
+
+Imager needs to have a libtiff version of at least 3.5.5.  In the
+future we might consider supporting older libtiff versions.  For
+now you can either configure Imager manually (by
 setting the IM_MANUAL environment variable to 1, in sh:
 
 $ IM_MANUAL=1 perl Makefile.PL
@@ -112,27 +129,40 @@ If it worked just continue with the installation as normally
 Some hints about getting the Imager module to find the libraries it
 needs for specific features.  The libraries it uses are:
 
- jpeg: ftp://ftp.uu.net/graphics/jpeg/jpegsrc.v6b.tar.gz
+ jpeg: http://www.ijg.org/files/
+       ftp://ftp.uu.net/graphics/jpeg/jpegsrc.v6b.tar.gz
+
+ftp.uu.net is still linked from many places, including the Independent
+JPEG Groups's home page, but it is non-functional.
+
+  png: http://www.libpng.org/pub/png/libpng.html
+
+  you also need zlib to use png:  http://www.gzip.org/zlib/
+We have encountered problems with libpng 1.0.1, which were fixed in 1.0.5
+Note: you should probably be using zlib 1.1.4, since 1.1.3 has a 
+potential security problem.
 
-  png: ftp://ftp.uu.net/graphics/png  
-  you also need zlib to use png:  ftp://ftp.uu.net/pub/archiving/zip/zlib
+  gif: http://sourceforge.net/projects/libungif
 
-  gif: http://www.arrakeen.demon.co.uk/giflib/  
-or at: http://prtr-13.ucsc.edu/~badger/software/libungif/index.shtml
+giflib/libungif has come a long way since the buggy versions around
+when Imager's gif support code was written.  Preferably you should get
+at least version 4.1.2.  If you have a recent Linux distribution you
+should be safe with whatever giflib it provides, but if you're
+building from source, please try to use the latest version.
+
+At the time of writing you will need to manually select to install the
+4.1.2-1 of cygwin's libungif package.
 
  tiff: http://www.libtiff.org/
 
-   t1: ftp://ftp.neuroinformatik.ruhr-uni-bochum.de/pub/software/t1lib/
-or at: ftp://sunsite.unc.edu/pub/Linux/libs/graphics/
+   t1: http://www.ibiblio.org/pub/Linux/libs/graphics/
 
    tt: http://www.freetype.org/
 
-
 Precompiled versions of some of the libraries might be found at:
 
 AIX:
-   http://www.bull.de/
-   ftp://ftp.rge.com/pub/systems/aix/bull/
+   http://www.bullfreeware.com/
 
 
 
@@ -162,15 +192,25 @@ font.
 =================
 
 Imager can be installed on Win32 systems.  This was ported and tested
-with Microsoft Visual C++ 6.0 with build 623 of ActivePerl.  If you
-have the appropriate libraries installed you can read and write PNG,
-TIFF, PPM and JPEG files.  There is currently no support for fonts
-under Win32, though it might be preferable to try to use Win32's
-native font support over the external librarie - why force the user to
-install yet another library?
+with Microsoft Visual C++ 6.0 with build 623 of ActivePerl.  You can
+use all of the features of Imager.  You can also use Win32 GDI fonts
+directly by supplying the 'face' parameter to Imager::Font->new(...).
+
+I've tested with both MSVC++ 6.0 and cygwin (perl 5.6.1).
+
+If you see an error under cygwin during testing along the lines of:
+
+  C:\cygwin\bin\perl.exe: *** unable to remap C:\cygwin\...some dll to the 
+    same address as parent (0x...) != 0x....
+
+you will need to install the cygwin rebase package and run:
+
+  $ rebaseall -v
 
-I haven't tried to target compilers other than VC++, since I don't
-have them installed.
+Under cygwin you will need at least libungif 4.1.2 installed to
+prevent lockups in the gif test scripts.  At the time of writing you
+need to select libungif-4.1.2-1 manually in the setup.exe installation
+tool.
 
 If you have any problems with the Win32 support, please email
 tony@develop-help.com (don't forget to use nmake instead of make).
@@ -181,7 +221,7 @@ tony@develop-help.com (don't forget to use nmake instead of make).
 
 The Imager module homepage is currently at:
 
- http://www.eecs.umich.edu/~addi/perl/Imager/
+ http://imager.perl.org/
 
 The current docs are rather bad as I've been busy adding features
 but hopefully they will be updated soon.  Until then you'll just
@@ -199,6 +239,7 @@ Thanks go to:
   Claes Jacobson      ( Claes )
   Philip Gwyn         ( Leolo )
   Michael Slade       ( Micksa )
+                      ( Cogent )
   Brad Murray         ( HalfJack )
   Nicholas Dronen     ( Veblen )
   Michael G Schwern   ( Schwern )