merged libpng-1.2.6 to HEAD
[wxWidgets.git] / src / png / INSTALL
1
2 Installing libpng version 1.2.6 - August 15, 2004
3
4 Before installing libpng, you must first install zlib.  zlib
5 can usually be found wherever you got libpng.  zlib can be
6 placed in another directory, at the same level as libpng.
7 Note that your system might already have a preinstalled
8 zlib, but you will still need to have access to the
9 zlib.h and zconf.h include files that correspond to the
10 version of zlib that's installed.
11
12 You can rename the directories that you downloaded (they
13 might be called "libpng-1.2.6" or "lpng109" and "zlib-1.1.3"
14 or "zlib113") so that you have directories called "zlib" and "libpng".
15
16 Your directory structure should look like this:
17
18    ..       (the parent directory)
19       libpng  (this directory)
20           INSTALL (this file)
21           README
22           *.h
23           *.c
24           contrib
25              gregbook
26              msvctest
27              pngminus
28              pngsuite
29              visupng
30           projects
31              beos
32              borland
33              msvc
34              netware.txt
35              wince.txt
36           scripts
37              makefile.*
38           pngtest.png
39           etc.
40       zlib
41           README
42           *.h
43           *.c
44           contrib
45           etc.
46
47 If the line endings in the files look funny, you may wish to get the other
48 distribution of libpng.  It is available in both tar.gz (UNIX style line
49 endings) and zip (DOS style line endings) formats.
50
51 If you are building libpng with MSVC, you can enter the libpng\msvc directory
52 and follow the instructions in msvc\README.txt.
53
54 You can build libpng for WindowsCE by entering the downloading and installing
55 the libpng\wince directory as instructed in the projects\wince.txt file, and
56 then following the instructions in the README* files.  Similarly, you can
57 build libpng for Netware as instructed in projects\netware.txt.
58
59 Else enter the zlib directory and follow the instructions in zlib/README,
60 then come back here and choose the appropriate makefile.sys in the scripts
61 directory.
62
63 The files that are presently available in the scripts directory
64 include
65
66  makefile.std      =>  Generic UNIX makefile (cc, creates static libpng.a)
67  makefile.linux    =>  Linux/ELF makefile (gcc, creates libpng12.so.0.1.2.6)
68  makefile.gcmmx    =>  Linux/ELF makefile (gcc, creates libpng12.so.0.1.2.6,
69                        uses assembler code tuned for Intel MMX platform)
70  makefile.gcc      =>  Generic makefile (gcc, creates static libpng.a)
71  makefile.knr      =>  Archaic UNIX Makefile that converts files with
72                        ansi2knr (Requires ansi2knr.c from
73                        ftp://ftp.cs.wisc.edu/ghost)
74  makefile.aix      =>  AIX/gcc makefile
75  makefile.cygwin   =>  Cygwin/gcc makefile
76  makefile.darwin   =>  Darwin makefile, can use on MacosX
77  makefile.dec      =>  DEC Alpha UNIX makefile
78  makefile.hpgcc    =>  FreeBSD makefile
79  makefile.hpgcc    =>  HPUX makefile using gcc
80  makefile.hpux     =>  HPUX (10.20 and 11.00) makefile
81  makefile.ibmc     =>  IBM C/C++ version 3.x for Win32 and OS/2 (static)
82  makefile.intel    =>  Intel C/C++ version 4.0 and later
83  libpng.icc        =>  Project file for IBM VisualAge/C++ version 4.0 or later
84  makefile.netbsd   =>  NetBSD/cc makefile, uses PNGGCCRD, makes libpng.so.
85  makefile.ne0bsd  =>  NetBSD/cc makefile, uses PNGGCCRD, makes libpng0.so
86  makefile.openbsd  =>  OpenBSD makefile
87  makefile.sgi      =>  Silicon Graphics IRIX makefile (cc, creates static lib)
88  makefile.sggcc    =>  Silicon Graphics (gcc, creates libpng12.so.0.1.2.6)
89  makefile.sunos    =>  Sun makefile
90  makefile.solaris  =>  Solaris 2.X makefile (gcc, creates libpng12.so.0.1.2.6)
91  makefile.so9      =>  Solaris 9 makefile (gcc, creates libpng12.so.0.1.2.6)
92  makefile.32sunu   =>  Sun Ultra 32-bit makefile
93  makefile.64sunu   =>  Sun Ultra 64-bit makefile
94  makefile.sco      =>  For SCO OSr5  ELF and Unixware 7 with Native cc
95  makefile.mips     =>  MIPS makefile
96  makefile.acorn    =>  Acorn makefile
97  makefile.amiga    =>  Amiga makefile
98  smakefile.ppc     =>  AMIGA smakefile for SAS C V6.58/7.00 PPC compiler
99                        (Requires SCOPTIONS, copied from scripts/SCOPTIONS.ppc)
100  makefile.atari    =>  Atari makefile
101  makefile.beos     =>  BEOS makefile for X86
102  makefile.bor      =>  Borland makefile (uses bcc)
103  makefile.bc32     =>  32-bit Borland C++ (all modules compiled in C mode)
104  makefile.bd32     =>  To make a png32bd.dll with Borland C++ 4.5
105  makefile.tc3      =>  Turbo C 3.0 makefile
106  makefile.dj2      =>  DJGPP 2 makefile
107  makefile.msc      =>  Microsoft C makefile
108  makefile.vcawin32 =>  makefile for Microsoft Visual C++ 5.0 and later (uses
109                        assembler code tuned for Intel MMX platform)
110  makefile.vcwin32  =>  makefile for Microsoft Visual C++ 4.0 and later (does
111                        not use assembler code)
112  makefile.os2      =>  OS/2 Makefile (gcc and emx, requires pngos2.def)
113  pngos2.def        =>  OS/2 module definition file used by makefile.os2
114  makefile.watcom   =>  Watcom 10a+ Makefile, 32-bit flat memory model
115  makevms.com       =>  VMS build script
116  descrip.mms       =>  VMS makefile for MMS or MMK
117  pngdef.pas        =>  Defines for a png32bd.dll with Borland C++ 4.5
118  SCOPTIONS.ppc     =>  Used with smakefile.ppc
119
120 Copy the file (or files) that you need from the
121 scripts directory into this directory, for example
122
123    MSDOS example: copy scripts\makefile.msc makefile
124    UNIX example:    cp scripts/makefile.std makefile
125
126 Read the makefile to see if you need to change any source or
127 target directories to match your preferences.
128
129 Then read pngconf.h to see if you want to make any configuration
130 changes.
131
132 Then just run "make test" which will create the libpng library in
133 this directory and run a quick test that reads the "pngtest.png"
134 file and writes a "pngout.png" file that should be identical to it.
135 Look for "9782 zero samples" in the output of the test.  For more
136 confidence, you can run another test by typing "pngtest pngnow.png"
137 and looking for "289 zero samples" in the output.  Also, you can
138 run "pngtest -m *.png" in the "contrib/pngsuite" directory and compare
139 your output with the result shown in contrib/pngsuite/README.
140
141 Most of the makefiles will allow you to run "make install" to
142 put the library in its final resting place (if you want to
143 do that, run "make install" in the zlib directory first if necessary).
144 Some also allow you to run "make test-installed" after you have
145 run "make install".
146
147 If you encounter a compiler error message complaining about the
148 lines
149       __png.h__ already includes setjmp.h;
150       __dont__ include it again.;
151 This means you have compiled another module that includes setjmp.h,
152 which is hazardous because the two modules might not include exactly
153 the same setjmp.h.  If you are sure that you know what you are doing
154 and that they are exactly the same, then you can comment out or
155 delete the two lines.  Better yet, use the cexcept interface
156 instead, as demonstrated in contrib/visupng of the libpng distribution.
157
158 Further information can be found in the README and libpng.txt
159 files, in the individual makefiles, in png.h, and the manual pages
160 libpng.3 and png.5.