[wxWidgets.git] / src / png / INSTALL


Installing libpng version 1.2.4 - July 8, 2002

Before installing libpng, you must first install zlib.  zlib
can usually be found wherever you got libpng.  zlib can be
placed in another directory, at the same level as libpng.
Note that your system might already have a preinstalled
zlib, but you will still need to have access to the
zlib.h and zconf.h include files that correspond to the
version of zlib that's installed.

You can rename the directories that you downloaded (they
might be called "libpng-1.2.4" or "lpng109" and "zlib-1.1.4"
or "zlib114") so that you have directories called "zlib" and "libpng".

Your directory structure should look like this:

   ..       (the parent directory)
      libpng  (this directory)
          INSTALL (this file)
          README
          *.h
          *.c
          contrib
             gregbook
             msvctest
             pngminus
             pngsuite
             visupng
          projects
             beos
             borland
             msvc
             netware.txt
             wince.txt
          scripts
             makefile.*
             libpng*.in
          mangle
             makefile.*
             mangle.in
          pngtest.png
          etc.
      zlib
          README
          *.h
          *.c
          contrib
          etc.

If the line endings in the files look funny, you may wish to get the other
distribution of libpng.  It is available in both tar.gz (UNIX style line
endings) and zip (DOS style line endings) formats.

If you are building libpng with MSVC, you can enter the libpng\msvc directory
and follow the instructions in msvc\README.txt.

You can build libpng for WindowsCE by entering the downloading and installing
the libpng\wince directory as instructed in the projects\wince.txt file, and
then following the instructions in the README* files.  Similarly, you can
build libpng for Netware as instructed in projects\netware.txt.

Else enter the zlib directory and follow the instructions in zlib/README,
then come back here and choose the appropriate makefile.sys in the scripts
directory.

The files that are presently available in the scripts directory
include

 makefile.std      =>  Generic UNIX makefile (cc, creates static libpng.a)
 makefile.linux    =>  Linux/ELF makefile (gcc, creates libpng12.so.0.1.2.4)
 makefile.gcmmx    =>  Linux/ELF makefile (gcc, creates libpng12.so.0.1.2.4,
                       uses assembler code tuned for Intel MMX platform)
 makefile.gcc      =>  Generic makefile (gcc, creates static libpng.a)
 makefile.knr      =>  Archaic UNIX Makefile that converts files with
                       ansi2knr (Requires ansi2knr.c from
                       ftp://ftp.cs.wisc.edu/ghost)
 makefile.aix      =>  AIX makefile
 makefile.cygwin   =>  Cygwin/gcc makefile
 makefile.darwin   =>  Darwin makefile
 makefile.dec      =>  DEC Alpha UNIX makefile
 makefile.hpgcc    =>  FreeBSD makefile
 makefile.hpgcc    =>  HPUX makefile using gcc
 makefile.hpux     =>  HPUX (10.20 and 11.00) makefile
 makefile.ibmc     =>  IBM C/C++ version 3.x for Win32 and OS/2 (static)
 makefile.intel    =>  Intel C/C++ version 4.0 and later
 libpng.icc        =>  Project file for IBM VisualAge/C++ version 4.0 or later
 makefile.macosx   =>  MACOS X Makefile
 makefile.netbsd   =>  NetBSD/cc makefile, uses PNGGCCRD, makes libpng.so.
 makefile.ne0bsd  =>  NetBSD/cc makefile, uses PNGGCCRD, makes libpng0.so
 makefile.openbsd  =>  OpenBSD makefile
 makefile.sgi      =>  Silicon Graphics IRIX makefile (cc, creates static lib)
 makefile.sggcc    =>  Silicon Graphics (gcc, creates libpng12.so.0.1.2.4)
 makefile.sunos    =>  Sun makefile
 makefile.solaris  =>  Solaris 2.X makefile (gcc, creates libpng12.so.0.1.2.4)
 makefile.so9      =>  Solaris 9 makefile (gcc, creates libpng12.so.0.1.2.4)
 makefile.32sunu   =>  Sun Ultra 32-bit makefile
 makefile.64sunu   =>  Sun Ultra 64-bit makefile
 makefile.sco      =>  For SCO OSr5  ELF and Unixware 7 with Native cc
 makefile.mips     =>  MIPS makefile
 makefile.acorn    =>  Acorn makefile
 makefile.amiga    =>  Amiga makefile
 smakefile.ppc     =>  AMIGA smakefile for SAS C V6.58/7.00 PPC compiler
                       (Requires SCOPTIONS, copied from scripts/SCOPTIONS.ppc)
 makefile.atari    =>  Atari makefile
 makefile.beos     =>  BEOS makefile for X86
 makefile.bor      =>  Borland makefile (uses bcc)
 makefile.bc32     =>  32-bit Borland C++ (all modules compiled in C mode)
 makefile.bd32     =>  To make a png32bd.dll with Borland C++ 4.5
 makefile.tc3      =>  Turbo C 3.0 makefile
 makefile.dj2      =>  DJGPP 2 makefile
 makefile.msc      =>  Microsoft C makefile
 makefile.vcawin32 =>  makefile for Microsoft Visual C++ 5.0 and later (uses
                       assembler code tuned for Intel MMX platform)
 makefile.vcwin32  =>  makefile for Microsoft Visual C++ 4.0 and later (does
                       not use assembler code)
 makefile.os2      =>  OS/2 Makefile (gcc and emx, requires pngos2.def)
 pngos2.def        =>  OS/2 module definition file used by makefile.os2
 makefile.watcom   =>  Watcom 10a+ Makefile, 32-bit flat memory model
 makevms.com       =>  VMS build script
 descrip.mms       =>  VMS makefile for MMS or MMK
 pngdef.pas        =>  Defines for a png32bd.dll with Borland C++ 4.5
 SCOPTIONS.ppc     =>  Used with smakefile.ppc

Copy the file (or files) that you need from the
scripts directory into this directory, for example

   MSDOS example: copy scripts\makefile.msc makefile
   UNIX example:    cp scripts/makefile.std makefile

Read the makefile to see if you need to change any source or
target directories to match your preferences.

Then read pngconf.h to see if you want to make any configuration
changes.

Then just run "make test" which will create the libpng library in
this directory and run a quick test that reads the "pngtest.png"
file and writes a "pngout.png" file that should be identical to it.
Look for "9782 zero samples" in the output of the test.  For more
confidence, you can run another test by typing "pngtest pngnow.png"
and looking for "289 zero samples" in the output.  Also, you can
run "pngtest -m *.png" in the "contrib/pngsuite" directory and compare
your output with the result shown in contrib/pngsuite/README.

Most of the makefiles will allow you to run "make install" to
put the library in its final resting place (if you want to
do that, run "make install" in the zlib directory first if necessary).
Some also allow you to run "make test-installed" after you have
run "make install".  This will build and run executables called "pngtesti"
and "mangle/pngtestm".

The files that are presently available in the mangle directory include the
following.  The makefiles are automatically run by the corresponding makefiles
in the scripts directory when you run "make", "make install", or
"make test-installed".

 mangle.in        =>  Function-decoration macros added to png.h by the
                      makefiles.
 makefile.linux   =>  Linux/ELF makefile
                      (gcc, creates libpng12m.so.0.1.2.4)
 makefile.gcmmx   =>  Linux/ELF makefile (gcc, creates
                      libpng12.so.0m.1.2.4, uses assembler code
                      tuned for Intel MMX platform)
 makefile.sgi     =>  Silicon Graphics (cc, creates libpng12m.so)
 makefile.sggcc   =>  Silicon Graphics (gcc, creates libpng12m.so)

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