blob: f987378009856bde14e8c371a6852799d2fa2d4d [file] [log] [blame]
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001
Glenn Randers-Pehrson66676012010-10-16 07:18:09 -05002Installing libpng
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06003
Glenn Randers-Pehrsonddfebd32006-02-22 09:19:25 -06004On Unix/Linux and similar systems, you can simply type
5
Glenn Randers-Pehrson7edd4582006-12-07 19:16:44 -06006 ./configure [--prefix=/path]
Glenn Randers-Pehrsonddfebd32006-02-22 09:19:25 -06007 make check
8 make install
9
10and ignore the rest of this document.
11
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -060012If configure does not work on your system, or if you have a need to
13change configure.ac or Makefile.am, and you have a reasonably
14up-to-date set of tools, running ./autogen.sh in a git clone before
15running ./configure may fix the problem. To be really sure that you
16aren't using any of the included pre-built scripts, you can do this:
Glenn Randers-Pehrson66676012010-10-16 07:18:09 -050017
Glenn Randers-Pehrson66121142010-10-16 07:22:19 -050018 ./configure --enable-maintainer-mode
Glenn Randers-Pehrson66676012010-10-16 07:18:09 -050019 make maintainer-clean
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -060020 ./autogen.sh --maintainer --clean
21 ./autogen.sh --maintainer
Glenn Randers-Pehrson66121142010-10-16 07:22:19 -050022 ./configure [--prefix=/path] [other options]
Glenn Randers-Pehrson66676012010-10-16 07:18:09 -050023 make
24 make install
25 make check
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -050026
27Instead, you can use one of the custom-built makefiles in the
Glenn Randers-Pehrsonddfebd32006-02-22 09:19:25 -060028"scripts" directory
29
30 cp scripts/makefile.system makefile
31 make test
32 make install
33
Glenn Randers-Pehrson9d27a1b2009-11-15 07:59:06 -060034The files that are presently available in the scripts directory
35are listed and described in scripts/README.txt.
36
Glenn Randers-Pehrsonddfebd32006-02-22 09:19:25 -060037Or you can use one of the "projects" in the "projects" directory.
38
39Before installing libpng, you must first install zlib, if it
40is not already on your system. zlib can usually be found
41wherever you got libpng. zlib can be placed in another directory,
42at the same level as libpng.
43
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -060044If your system already has a preinstalled zlib you will still need
45to have access to the zlib.h and zconf.h include files that
46correspond to the version of zlib that's installed.
47
48If you wish to test with a particular zlib that is not first in the
49standard library search path, put ZLIBLIB, ZLIBINC, CPPFLAGS, LDFLAGS,
50and LD_LIBRARY_PATH in your environment before running "make test"
51or "make distcheck":
52
53ZLIBLIB=/path/to/lib export ZLIBLIB
54ZLIBINC=/path/to/include export ZLIBINC
55CPPFLAGS="-I$ZLIBINC" export CPPFLAGS
56LDFLAGS="-L$ZLIBLIB" export LDFLAGS
57LD_LIBRARY_PATH="$ZLIBLIB:$LD_LIBRARY_PATH" export LD_LIBRARY_PATH
58
59If you are using one of the makefile scripts, put ZLIBLIB and ZLIBINC
60in your environment and type "make ZLIBLIB=$ZLIBLIB ZLIBINC=$ZLIBINC test".
61
Glenn Randers-Pehrson5b754aa2009-08-26 12:16:18 -050062If you want to use "cmake" (see www.cmake.org), type
Glenn Randers-Pehrson7edd4582006-12-07 19:16:44 -060063
64 cmake . -DCMAKE_INSTALL_PREFIX=/path
65 make
66 make install
67
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -060068You can rename the directories that you downloaded (they
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -060069might be called "libpng-x.y.z" or "libpngNN" and "zlib-1.2.7"
70or "zlib127") so that you have directories called "zlib" and "libpng".
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -060071
72Your directory structure should look like this:
73
74 .. (the parent directory)
75 libpng (this directory)
76 INSTALL (this file)
77 README
78 *.h
79 *.c
Glenn Randers-Pehrsonbe199c12009-11-12 13:57:42 -060080 CMakeLists.txt => "cmake" script
Glenn Randers-Pehrson22ad8f02009-11-14 07:25:31 -060081 configuration files:
82 configure.ac, configure, Makefile.am, Makefile.in,
Glenn Randers-Pehrson39515c92010-08-28 06:21:35 -050083 autogen.sh, config.guess, ltmain.sh, missing, libpng.pc.in,
84 libpng-config.in, aclocal.m4, config.h.in, config.sub,
Glenn Randers-Pehrson22ad8f02009-11-14 07:25:31 -060085 depcomp, install-sh, mkinstalldirs, test-pngtest.sh
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -050086 contrib
87 gregbook
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -060088 libtests
Glenn Randers-Pehrsonbe199c12009-11-12 13:57:42 -060089 pngminim
Glenn Randers-Pehrson6d8f3b01999-10-23 08:39:18 -050090 pngminus
91 pngsuite
Glenn Randers-Pehrsondb66d442000-06-23 21:38:16 -050092 visupng
Glenn Randers-Pehrsonfbbb5ec2001-01-15 22:01:20 -060093 projects
Glenn Randers-Pehrsonbe199c12009-11-12 13:57:42 -060094 visualc71
Glenn Randers-Pehrson66676012010-10-16 07:18:09 -050095 vstudio
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -060096 scripts
97 makefile.*
Glenn Randers-Pehrsonbe199c12009-11-12 13:57:42 -060098 *.def (module definition files)
Glenn Randers-Pehrson8c667862010-08-24 16:16:35 -050099 etc.
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600100 pngtest.png
101 etc.
102 zlib
103 README
104 *.h
105 *.c
106 contrib
107 etc.
108
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600109If the line endings in the files look funny, you may wish to get the other
110distribution of libpng. It is available in both tar.gz (UNIX style line
111endings) and zip (DOS style line endings) formats.
112
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600113If you are building libpng with MSVC, you can enter the
Glenn Randers-Pehrsonbe199c12009-11-12 13:57:42 -0600114libpng projects\visualc6 or visualc71 directory and follow the instructions
115in README.txt.
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500116
Glenn Randers-Pehrsona2aebb52009-11-14 17:58:32 -0600117Otherwise enter the zlib directory and follow the instructions in zlib/README,
Glenn Randers-Pehrsonddfebd32006-02-22 09:19:25 -0600118then come back here and run "configure" or choose the appropriate
119makefile.sys in the scripts directory.
Glenn Randers-Pehrsondb66d442000-06-23 21:38:16 -0500120
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600121Copy the file (or files) that you need from the
122scripts directory into this directory, for example
123
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -0500124 MSDOS example: copy scripts\makefile.msc makefile
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600125 UNIX example: cp scripts/makefile.std makefile
126
127Read the makefile to see if you need to change any source or
128target directories to match your preferences.
129
Glenn Randers-Pehrson10973a52010-10-16 19:40:09 -0500130Then read pnglibconf.dfa to see if you want to make any configuration
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600131changes.
132
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600133Then just run "make" which will create the libpng library in
134this directory and "make test" which will run a quick test that reads
135the "pngtest.png" file and writes a "pngout.png" file that should be
136identical to it. Look for "9782 zero samples" in the output of the
137test. For more confidence, you can run another test by typing
138"pngtest pngnow.png" and looking for "289 zero samples" in the output.
139Also, you can run "pngtest -m contrib/pngsuite/*.png" and compare
Glenn Randers-Pehrson6d8f3b01999-10-23 08:39:18 -0500140your output with the result shown in contrib/pngsuite/README.
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600141
142Most of the makefiles will allow you to run "make install" to
143put the library in its final resting place (if you want to
144do that, run "make install" in the zlib directory first if necessary).
Glenn Randers-Pehrsond1e8c862002-06-20 06:54:34 -0500145Some also allow you to run "make test-installed" after you have
Glenn Randers-Pehrson0cc2f952002-10-03 06:32:37 -0500146run "make install".
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600147
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500148Further information can be found in the README and libpng-manual.txt
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600149files, in the individual makefiles, in png.h, and the manual pages
150libpng.3 and png.5.
Glenn Randers-Pehrsonc2d83992011-11-16 14:30:24 -0600151
152Using the ./configure script -- 16 December 2002.
153=================================================
154
155The ./configure script should work compatibly with what scripts/makefile.*
156did, however there are some options you might need to add to configure
157explicitly, which previously was done semi-automatically (if you didn't edit
158scripts/makefile.* yourself, that is)
159
160CFLAGS="-Wall -O -funroll-loops \
161-malign-loops=2 -malign-functions=2" ./configure --prefix=/usr/include \
162--with-pkgconfigdir=/usr/lib/pkgconfig --includedir=/usr/include
163
164You can alternatively specify --includedir=/usr/include, /usr/local/include,
165/usr/include/libpng%NN%, or whatever.
166
167If you find that the configure script is out-of-date or is not supporting
168your platform properly, try running autogen.sh to regenerate "configure",
169"Makefile.in", and the other configuration files. Then try configure again.
170