diff --git a/INSTALL b/INSTALL index f8ed711be8..ad69977f55 100644 --- a/INSTALL +++ b/INSTALL @@ -1,14 +1,4 @@ -PostgreSQL Installation Instructions - -Table of Contents -Short Version -Requirements -If You Are Upgrading -Installation Procedure -Post-Installation Setup -Getting Started -What Now? -Supported Platforms + PostgreSQL Installation Instructions Short Version @@ -22,6 +12,7 @@ su - postgres /usr/local/pgsql/bin/createdb test /usr/local/pgsql/bin/psql test + The long version is the rest of this document. ------------------------------------------------------------------------ @@ -53,7 +44,9 @@ The following prerequisites exist for building PostgreSQL: * The GNU Readline library for comfortable line editing and command history retrieval will automatically be used if found. You might wish - to install it before proceeding, but it is not required. + to install it before proceeding, but it is not required. (On NetBSD, + the libedit library is readline-compatible and is used if libreadline + is not found.) * Flex and Bison are not required when building from a released source package because the output files are pre-generated. You will need these @@ -99,10 +92,12 @@ here. These instructions assume that your existing installation is under the pg_dumpall > outputfile If you need to preserve the OIDs (such as when using them as foreign - keys), then use the -o option when running pg_dumpall. + keys), then use the -o option when running pg_dumpall. pg_dumpall does + not save large objects. Check the Administrator's Guide if you need to + do this. Make sure that you use the pg_dumpall command from the version you are - currently running. 7.1devel's pg_dumpall should not be used on older + currently running. 7.1's pg_dumpall should not be used on older databases. 3. If you are installing the new version at the same location as the old @@ -116,9 +111,9 @@ here. These instructions assume that your existing installation is under the yourself, for example by typing ps ax | grep postmaster, and supply it to the kill command. - On systems which have PostgreSQL started at boot time, there is - probably a start-up file that will accomplish the same thing. For - example, on a Red Hat Linux system one might find that + On systems that have PostgreSQL started at boot time, there is probably + a start-up file that will accomplish the same thing. For example, on a + Red Hat Linux system one might find that /etc/rc.d/init.d/postgresql stop @@ -130,10 +125,10 @@ here. These instructions assume that your existing installation is under the mv /usr/local/pgsql /usr/local/pgsql.old -After you have installed PostgreSQL 7.1devel, create a new database -directory and start the new server. Remember that you must execute these -commands while logged in to the special database user account (which you -already have if you are upgrading). +After you have installed PostgreSQL 7.1, create a new database directory and +start the new server. Remember that you must execute these commands while +logged in to the special database user account (which you already have if +you are upgrading). /usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data /usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data @@ -369,6 +364,13 @@ Installation Procedure to make sure that your OpenSSL installation is sufficient before proceeding. + --with-java + + Build the JDBC driver and associated Java packages. This option + requires Ant to be installed (as well as a JDK, of course). Refer + to the JDBC driver documentation in the Programmer's Guide for + more information. + --enable-syslog Enables the PostgreSQL server to use the syslog logging facility. @@ -380,7 +382,26 @@ Installation Procedure Compiles all programs and libraries with debugging symbols. This means that you can run the programs through a debugger to analyze - problems. This option is not recommended for production use. + problems. This enlarges the size of the installed executables + considerably, and on non-gcc compilers it usually also disables + compiler optimization, causing slowdowns. However, having the + symbols available is extremely helpful for dealing with any + problems that may arise. Currently, this option is considered of + marginal value for production installations, but you should have + it on if you are doing development work or running a beta version. + + --enable-cassert + + Enables assertion checks in the server, which test for many "can't + happen" conditions. This is invaluable for code development + purposes, but the tests slow things down a little. Also, having + the tests turned on won't necessarily enhance the stability of + your server! The assertion checks are not categorized for + severity, and so what might be a relatively harmless bug will + still lead to postmaster restarts if it triggers an assertion + failure. Currently, this option is not recommended for production + use, but you should have it on for development work or when + running a beta version. If you prefer a C or C++ compiler different from the one configure picks then you can set the environment variables CC and CXX, @@ -449,8 +470,21 @@ Installation Procedure other directories where Perl or Python can find them, but how to do that is left as an exercise. + The standard install installs only the header files needed for client + application development. If you plan to do any server-side program + development (such as custom functions or datatypes written in C), then + you may want to install the entire PostgreSQL include tree into your + target include directory. To do that, enter + + gmake install-all-headers + + This adds a megabyte or two to the install footprint, and is only + useful if you don't plan to keep the whole source tree around for + reference. (If you do, you can just use the source's include directory + when building server-side software.) + Client-only installation. If you want to install only the client - applications and interfaces, then you can use these commands: + applications and interface libraries, then you can use these commands: gmake -C src/bin install gmake -C src/interfaces install @@ -600,13 +634,13 @@ What Now? * The Tutorial should be your first reading if you are completely new to SQL databases. It should have been installed at - /usr/local/pgsql/doc/html/tutorial.htm unless you changed the + /usr/local/pgsql/doc/html/tutorial.html unless you changed the installation directories. * If you are familiar with database concepts then you want to proceed with the Administrator's Guide, which contains information about how to set up the database server, database users, and authentication. It can - be found at /usr/local/pgsql/doc/html/admin.htm. + be found at /usr/local/pgsql/doc/html/admin.html. * Usually, you will want to modify your computer so that it will automatically start the database server whenever it boots. Some @@ -630,87 +664,113 @@ tests pass. supported platform, please write to or , not to the people listed here. - OS Processor Version Reported Remarks - AIX 4.3.2 RS6000 7.0 2000-04-05, Andread Zeugswetter See also - () doc/FAQ_AIX - BSDI 4.01 x86 7.0 2000-04-04, Bruce Momjian - () - Compaq Tru64 Alpha 7.0 2000-04-11, Andrew McMurry - 5.0 () - FreeBSD 4.0 x86 7.0 2000-04-04, Marc Fournier - () - HPUX 9.0x andPA-RISC 7.0 2000-04-12, Tom Lane See also - 10.20 () doc/FAQ_HPUX - IRIX 6.5.6f MIPS 6.5.3 2000-02-18, Kevin Wheatley MIPSPro - () 7.3.1.1m N32 - build - Linux 2.0.x Alpha 7.0 2000-04-05, Ryan Kirkpatrick with published - () patches - Linux 2.2.x armv4l 7.0 2000-04-17, Mark Knox Regression - () test needs - work. - Linux 2.2.x x86 7.0 2000-03-26, Lamar Owen - () - Linux 2.0.x MIPS 7.0 2000-04-13, Tatsuo Ishii Cobalt Qube - () - Linux 2.2.5 Sparc 7.0 2000-04-02, Tom Szybist - () - LinuxPPC R4 PPC603e 7.0 2000-04-13, Tatsuo Ishii - () - mklinux PPC750 7.0 2000-04-13, Tatsuo Ishii - () - NetBSD 1.4 arm32 7.0 2000-04-08, Patrick Welche - () - NetBSD 1.4U x86 7.0 2000-03-26, Patrick Welche - () - NetBSD m68k 7.0 2000-04-10, Henry B. Hotz Mac 8xx - () - NetBSD Sparc 7.0 2000-04-13, Tom I. Helbekkmo - () - QNX 4.25 x86 7.0 2000-04-01, Dr. Andreas Kardos See also - () doc/FAQ_QNX4 - SCO x86 6.5 1999-05-25, Andrew Merrill See also - OpenServer 5 () doc/FAQ_SCO - SCO UnixWare x86 7.0 2000-04-18, Billy G. Allie See also - 7 () doc/FAQ_SCO - Solaris x86 7.0 2000-04-12, Marc Fournier - () - Solaris Sparc 7.0 2000-04-12, Peter Eisentraut - 2.5.1-2.7 (), Marc Fournier - () - SunOS 4.1.4 Sparc 7.0 2000-04-13, Tatsuo Ishii - () - Windows/Win32x86 7.0 2000-04-02, Magnus Hagander Client-side - () libraries or - ODBC/JDBC, no - server-side - WinNT/Cygwin x86 7.0 2000-03-30, Daniel Horak with - () RedHat/Cygnus - Cygwin toolset + OS Processor Version Reported Remarks + AIX 4.3.3RS6000 7.1 2001-03-21, Gilles Darold see also + () doc/FAQ_AIX + BeOS x86 7.1 2001-02-26, Cyril Velter requires new + 5.0.4 () BONE networking + stack + BSD/OS x86 7.1 2001-03-20, Bruce Momjian + 4.01 () + Compaq Alpha 7.1 2001-03-26, Adriaan Joubert 4.0-5.0, cc and + Tru64 () gcc + UNIX + FreeBSD x86 7.1 2001-03-19, Vince Vielhaber + 4.3 () + HP/UX PA-RISC 7.1 2001-03-19, 10.20 Tom Lane 32- and 64-bit + (), 2001-03-22, on 11.00; see + 11.00, 11i Giles Lean also + () doc/FAQ_HPUX + IRIX MIPS 7.1 2001-03-22, Robert Bruccoleri 32-bit + 6.5.11 () compilation + model + Linux Alpha 7.1 2001-01-23, Ryan Kirkpatrick + 2.2.x () + Linux armv4l 7.1 2001-02-22, Mark Knox + 2.2.x () + Linux MIPS 7.1 2001-03-30, Dominic Eidson Cobalt Qube + 2.0.x () + Linux PPC74xx 7.1 2001-03-19, Tom Lane Apple G3 + 2.2.18 () + Linux S/390 7.1 2000-11-17, Neale Ferguson + () + Linux Sparc 7.1 2001-01-30, Ryan Kirkpatrick + 2.2.15 () + Linux x86 7.1 2001-03-19, Thomas Lockhart 2.0.x, 2.2.x, + () 2.4.2 + MacOS X PPC 7.1 2000-12-11, Peter Bierman Darwin (only) + (), 2000-12-11, Beta-2 or higher + Daniel Luke () + NetBSD Alpha 7.1 2001-03-22, Giles Lean + 1.5 () + NetBSD arm32 7.1 2001-03-21, Patrick Welche + 1.5E () + NetBSD m68k 7.0 2000-04-10, Henry B. Hotz Mac 8xx + () + NetBSD PPC 7.1 2001-04-05, Henry B. Hotz Mac G4 + () + NetBSD Sparc 7.1 2000-04-05, Matthew Green 32- and 64-bit + () builds + NetBSD VAX 7.1 2001-03-30, Tom I. Helbekkmo + 1.5 () + NetBSD x86 7.1 2001-03-23, Giles Lean + 1.5 () + OpenBSD Sparc 7.1 2001-03-23, Brandon Palmer + 2.8 () + OpenBSD x86 7.1 2001-03-21, Brandon Palmer + 2.8 () + SCO x86 7.1 2001-03-19, Larry Rosenman UDK FS compiler; + UnixWare () see also + 7.1.1 doc/FAQ_SCO + Solaris Sparc 7.1 2001-03-22, Marc Fournier see also + 2.7-8 (), 2001-03-25, doc/FAQ_Solaris + Justin Clift () + Solaris x86 7.1 2001-03-27, Mathijs Brands see also + 2.8 () doc/FAQ_Solaris + SunOS Sparc 7.1 2001-03-23, Tatsuo Ishii + 4.1.4 () + Windows x86 7.1 2001-03-16, Jason Tishler with Cygwin + NT/2000 () toolset, see + with doc/FAQ_MSWIN + Cygwin Unsupported Platforms. The following platforms have not been verified to work. Platforms listed for version 6.3.x and later should also work with -7.1devel, but we did not receive explicit confirmation of such at the time -this list was compiled. We include these here to let you know that these +7.1, but we did not receive explicit confirmation of such at the time this +list was compiled. We include these here to let you know that these platforms could be supported if given some attention. - OS Processor Version Reported Remarks - BeOS x86 7.0 2000-05-01, Adam Haberlach Client-side - () coming soon? - DGUX m88k 6.3 1998-03-01, Brian E Gallew 6.4 probably - 5.4R4.11 () OK. Needs new - maintainer. - NetBSD 1.3VAX 6.3 1998-03-01, Tom I Helbekkmo 7.0 should - () work. - System V m88k 6.2.1 1998-03-01, Doug Winterburn Needs new TAS - R4 4.4 () spinlock code - System V MIPS 6.4 1998-10-28, Frank Ridderbusch No 64-bit - R4 () integer - Ultrix MIPS, VAX 6.x 1998-03-01 No recent - reports. - Obsolete? - MacOS all 6.x 1998-03-01 Not library - compatible; - use ODBC/JDBC. - NextStep x86 6.x 1998-03-01, David Wetzel Client-only - () support + OS Processor VersionReported Remarks + DGUX m88k 6.3 1998-03-01, Brian E Gallew 6.4 probably OK + 5.4R4.11 () + MkLinux DR1 PPC750 7.0 2001-04-03, Tatsuo Ishii 7.1 needs OS + () update? + NextStep x86 6.x 1998-03-01, David Wetzel bit rot + () suspected + QNX 4.25 x86 7.0 2000-04-01, Dr. Andreas Spinlock code + Kardos needs work. See + () also + doc/FAQ_QNX4. + SCO x86 6.5 1999-05-25, Andrew Merrill 7.1 should work, + OpenServer () but no reports; + 5 see also + doc/FAQ_SCO + System V R4 m88k 6.2.1 1998-03-01, Doug Winterburn needs new TAS + () spinlock code + System V R4 MIPS 6.4 1998-10-28, Frank no 64-bit + Ridderbusch integer + () + Ultrix MIPS 7.1 2001-03-26 TAS spinlock + code not + detected + Ultrix VAX 6.x 1998-03-01 No recent + reports. + Obsolete? + Windows 9x, x86 7.1 2001-03-26, Magnus Hagander client-side + ME, NT, () libraries (libpq + 2000 and psql) or + (native) ODBC/JDBC, no + server-side; see + Administrator's + Guide for + instructions diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml index 9d3ffba47a..31c9a10547 100644 --- a/doc/src/sgml/installation.sgml +++ b/doc/src/sgml/installation.sgml @@ -1,4 +1,4 @@ - + <![%flattext-install-include[<productname>PostgreSQL</>]]> @@ -1191,24 +1191,24 @@ gunzip -c user.ps.gz \ <entry>RS6000</entry> <entry>7.1</entry> <entry>2001-03-21, Gilles Darold (<email>gilles@darold.net</email>)</entry> - <entry>See also <filename>doc/FAQ_AIX</filename></entry> + <entry>see also <filename>doc/FAQ_AIX</filename></entry> </row> <row> <entry>BeOS 5.0.4</entry> <entry>x86</entry> <entry>7.1</entry> - <entry>2001-02-26, Cyril Velter(<email>cyril.velter@libertysurf.fr</email>)</entry> - <entry>Requires new BONE networking stack</entry> + <entry>2001-02-26, Cyril Velter (<email>cyril.velter@libertysurf.fr</email>)</entry> + <entry>requires new BONE networking stack</entry> </row> <row> - <entry>BSDI 4.01</entry> + <entry>BSD/OS 4.01</entry> <entry>x86</entry> <entry>7.1</entry> <entry>2001-03-20, Bruce Momjian (<email>pgman@candle.pha.pa.us</email>)</entry> <entry></entry> </row> <row> - <entry>Compaq Tru64</entry> + <entry>Compaq Tru64 UNIX</entry> <entry>Alpha</entry> <entry>7.1</entry> <entry>2001-03-26, Adriaan Joubert (<email>a.joubert@albourne.com</email>)</entry> @@ -1222,12 +1222,12 @@ gunzip -c user.ps.gz \ <entry></entry> </row> <row> - <entry>HPUX</entry> + <entry>HP/UX</entry> <entry>PA-RISC</entry> <entry>7.1</entry> <entry>2001-03-19, 10.20 Tom Lane (<email>tgl@sss.pgh.pa.us</email>), 2001-03-22, 11.00, 11i Giles Lean (<email>giles@nemeton.com.au</email>)</entry> - <entry>32- and 64-bit on 11.00. See <filename>doc/FAQ_HPUX</filename></entry> + <entry>32- and 64-bit on 11.00; see also <filename>doc/FAQ_HPUX</filename></entry> </row> <row> <entry>IRIX 6.5.11</entry> @@ -1356,19 +1356,12 @@ gunzip -c user.ps.gz \ <entry>2001-03-21, Brandon Palmer (<email>bpalmer@crimelabs.net</email>)</entry> <entry></entry> </row> - <row> - <entry>SCO OpenServer 5</entry> - <entry>x86</entry> - <entry>7.1</entry> - <entry>2001-03-13, Billy G. Allie (<email>Bill.Allie@mug.org</email>)</entry> - <entry>See also <filename>doc/FAQ_SCO</filename></entry> - </row> <row> <entry>SCO UnixWare 7.1.1</entry> <entry>x86</entry> <entry>7.1</entry> <entry>2001-03-19, Larry Rosenman (<email>ler@lerctr.org</email>)</entry> - <entry>UDK FS compiler. See <filename>doc/FAQ_SCO</filename></entry> + <entry>UDK FS compiler; see also <filename>doc/FAQ_SCO</filename></entry> </row> <row> <entry>Solaris 2.7-8</entry> @@ -1376,14 +1369,14 @@ gunzip -c user.ps.gz \ <entry>7.1</entry> <entry>2001-03-22, Marc Fournier (<email>scrappy@hub.org</email>), 2001-03-25, Justin Clift (<email>justin@postgresql.org</email>)</entry> - <entry></entry> + <entry>see also <filename>doc/FAQ_Solaris</filename></entry> </row> <row> <entry>Solaris 2.8</entry> <entry>x86</entry> <entry>7.1</entry> <entry>2001-03-27, Mathijs Brands (<email>mathijs@ilse.nl</email>)</entry> - <entry></entry> + <entry>see also <filename>doc/FAQ_Solaris</filename></entry> </row> <row> <entry>SunOS 4.1.4</entry> @@ -1393,11 +1386,11 @@ gunzip -c user.ps.gz \ <entry></entry> </row> <row> - <entry>WinNT/Cygwin</entry> + <entry>Windows NT/2000 with Cygwin</entry> <entry>x86</entry> <entry>7.1</entry> <entry>2001-03-16, Jason Tishler (<email>Jason.Tishler@dothill.com</email>)</entry> - <entry>with <productname>Cygwin</productname> toolset</entry> + <entry>with <application>Cygwin</application> toolset, see <filename>doc/FAQ_MSWIN</filename></entry> </row> </tbody> </tgroup> @@ -1433,7 +1426,7 @@ gunzip -c user.ps.gz \ <entry>m88k</entry> <entry>6.3</entry> <entry>1998-03-01, Brian E Gallew (<email>geek+@cmu.edu</email>)</entry> - <entry>6.4 probably OK.</entry> + <entry>6.4 probably OK</entry> </row> <row> <entry>MkLinux DR1</entry> @@ -1447,28 +1440,35 @@ gunzip -c user.ps.gz \ <entry>x86</entry> <entry>6.x</entry> <entry>1998-03-01, David Wetzel (<email>dave@turbocat.de</email>)</entry> - <entry>Client-only support</entry> + <entry>bit rot suspected</entry> </row> <row> <entry>QNX 4.25</entry> <entry>x86</entry> <entry>7.0</entry> <entry>2000-04-01, Dr. Andreas Kardos (<email>kardos@repas-aeg.de</email>)</entry> - <entry>See also <filename>doc/FAQ_QNX4</filename></entry> + <entry>Spinlock code needs work. See also <filename>doc/FAQ_QNX4</filename>.</entry> + </row> + <row> + <entry>SCO OpenServer 5</entry> + <entry>x86</entry> + <entry>6.5</entry> + <entry>1999-05-25, Andrew Merrill (<email>andrew@compclass.com</>)</entry> + <entry>7.1 should work, but no reports; see also <filename>doc/FAQ_SCO</filename></entry> </row> <row> <entry>System V R4</entry> <entry>m88k</entry> <entry>6.2.1</entry> <entry>1998-03-01, Doug Winterburn (<email>dlw@seavme.xroads.com</email>)</entry> - <entry>Needs new TAS spinlock code</entry> + <entry>needs new TAS spinlock code</entry> </row> <row> <entry>System V R4</entry> <entry>MIPS</entry> <entry>6.4</entry> <entry>1998-10-28, Frank Ridderbusch (<email>ridderbusch.pad@sni.de</email>)</entry> - <entry>No 64-bit integer</entry> + <entry>no 64-bit integer</entry> </row> <row> <entry>Ultrix</entry> @@ -1485,11 +1485,16 @@ gunzip -c user.ps.gz \ <entry>No recent reports. Obsolete?</entry> </row> <row> - <entry>Windows/Win32</entry> + <entry>Windows 9x, ME, NT, 2000 (native)</entry> <entry>x86</entry> <entry>7.1</entry> <entry>2001-03-26, Magnus Hagander (<email>mha@sollentuna.net</email>)</entry> - <entry>Client-side libraries or ODBC/JDBC, no server-side</entry> + <entry> + client-side libraries (libpq and psql) or ODBC/JDBC, no server-side; +<![%flattext-install-include[see Administrator's Guide]]> +<![%flattext-install-ignore[see <xref linkend="install-win32">]]> + for instructions + </entry> </row> </tbody> </tgroup>