Initial checking of the libpng library.
[oota-llvm.git] / runtime / libpng / INSTALL
1
2 Installing libpng version 1.2.5 - October 3, 2002
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.5" or "lpng109" and "zlib-1.1.4"
14 or "zlib114") 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              libpng*.in
39           pngtest.png
40           etc.
41       zlib
42           README
43           *.h
44           *.c
45           contrib
46           etc.
47
48 If the line endings in the files look funny, you may wish to get the other
49 distribution of libpng.  It is available in both tar.gz (UNIX style line
50 endings) and zip (DOS style line endings) formats.
51
52 If you are building libpng with MSVC, you can enter the libpng\msvc directory
53 and follow the instructions in msvc\README.txt.
54
55 You can build libpng for WindowsCE by entering the downloading and installing
56 the libpng\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 as instructed in projects\netware.txt.
59
60 Else enter the zlib directory and follow the instructions in zlib/README,
61 then come back here and choose the appropriate makefile.sys in the scripts
62 directory.
63
64 The files that are presently available in the scripts directory
65 include
66
67  makefile.std      =>  Generic UNIX makefile (cc, creates static libpng.a)
68  makefile.linux    =>  Linux/ELF makefile (gcc, creates libpng12.so.0.1.2.5)
69  makefile.gcmmx    =>  Linux/ELF makefile (gcc, creates libpng12.so.0.1.2.5,
70                        uses assembler code tuned for Intel MMX platform)
71  makefile.gcc      =>  Generic makefile (gcc, creates static libpng.a)
72  makefile.knr      =>  Archaic UNIX Makefile that converts files with
73                        ansi2knr (Requires ansi2knr.c from
74                        ftp://ftp.cs.wisc.edu/ghost)
75  makefile.aix      =>  AIX/gcc makefile
76  makefile.cygwin   =>  Cygwin/gcc makefile
77  makefile.darwin   =>  Darwin makefile
78  makefile.dec      =>  DEC Alpha UNIX makefile
79  makefile.hpgcc    =>  FreeBSD makefile
80  makefile.hpgcc    =>  HPUX makefile using gcc
81  makefile.hpux     =>  HPUX (10.20 and 11.00) makefile
82  makefile.ibmc     =>  IBM C/C++ version 3.x for Win32 and OS/2 (static)
83  makefile.intel    =>  Intel C/C++ version 4.0 and later
84  libpng.icc        =>  Project file for IBM VisualAge/C++ version 4.0 or later
85  makefile.macosx   =>  MACOS X Makefile
86  makefile.netbsd   =>  NetBSD/cc makefile, uses PNGGCCRD, makes libpng.so.
87  makefile.ne0bsd  =>  NetBSD/cc makefile, uses PNGGCCRD, makes libpng0.so
88  makefile.openbsd  =>  OpenBSD makefile
89  makefile.sgi      =>  Silicon Graphics IRIX makefile (cc, creates static lib)
90  makefile.sggcc    =>  Silicon Graphics (gcc, creates libpng12.so.0.1.2.5)
91  makefile.sunos    =>  Sun makefile
92  makefile.solaris  =>  Solaris 2.X makefile (gcc, creates libpng12.so.0.1.2.5)
93  makefile.so9      =>  Solaris 9 makefile (gcc, creates libpng12.so.0.1.2.5)
94  makefile.32sunu   =>  Sun Ultra 32-bit makefile
95  makefile.64sunu   =>  Sun Ultra 64-bit makefile
96  makefile.sco      =>  For SCO OSr5  ELF and Unixware 7 with Native cc
97  makefile.mips     =>  MIPS makefile
98  makefile.acorn    =>  Acorn makefile
99  makefile.amiga    =>  Amiga makefile
100  smakefile.ppc     =>  AMIGA smakefile for SAS C V6.58/7.00 PPC compiler
101                        (Requires SCOPTIONS, copied from scripts/SCOPTIONS.ppc)
102  makefile.atari    =>  Atari makefile
103  makefile.beos     =>  BEOS makefile for X86
104  makefile.bor      =>  Borland makefile (uses bcc)
105  makefile.bc32     =>  32-bit Borland C++ (all modules compiled in C mode)
106  makefile.bd32     =>  To make a png32bd.dll with Borland C++ 4.5
107  makefile.tc3      =>  Turbo C 3.0 makefile
108  makefile.dj2      =>  DJGPP 2 makefile
109  makefile.msc      =>  Microsoft C makefile
110  makefile.vcawin32 =>  makefile for Microsoft Visual C++ 5.0 and later (uses
111                        assembler code tuned for Intel MMX platform)
112  makefile.vcwin32  =>  makefile for Microsoft Visual C++ 4.0 and later (does
113                        not use assembler code)
114  makefile.os2      =>  OS/2 Makefile (gcc and emx, requires pngos2.def)
115  pngos2.def        =>  OS/2 module definition file used by makefile.os2
116  makefile.watcom   =>  Watcom 10a+ Makefile, 32-bit flat memory model
117  makevms.com       =>  VMS build script
118  descrip.mms       =>  VMS makefile for MMS or MMK
119  pngdef.pas        =>  Defines for a png32bd.dll with Borland C++ 4.5
120  SCOPTIONS.ppc     =>  Used with smakefile.ppc
121
122 Copy the file (or files) that you need from the
123 scripts directory into this directory, for example
124
125    MSDOS example: copy scripts\makefile.msc makefile
126    UNIX example:    cp scripts/makefile.std makefile
127
128 Read the makefile to see if you need to change any source or
129 target directories to match your preferences.
130
131 Then read pngconf.h to see if you want to make any configuration
132 changes.
133
134 Then just run "make test" which will create the libpng library in
135 this directory and run a quick test that reads the "pngtest.png"
136 file and writes a "pngout.png" file that should be identical to it.
137 Look for "9782 zero samples" in the output of the test.  For more
138 confidence, you can run another test by typing "pngtest pngnow.png"
139 and looking for "289 zero samples" in the output.  Also, you can
140 run "pngtest -m *.png" in the "contrib/pngsuite" directory and compare
141 your output with the result shown in contrib/pngsuite/README.
142
143 Most of the makefiles will allow you to run "make install" to
144 put the library in its final resting place (if you want to
145 do that, run "make install" in the zlib directory first if necessary).
146 Some also allow you to run "make test-installed" after you have
147 run "make install".
148
149 Further information can be found in the README and libpng.txt
150 files, in the individual makefiles, in png.h, in the README files in
151 subdirectories of the LIB directory, and the manual pages libpng.3 and png.5.