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