-POSTGRES95 INSTALLATION INSTRUCTIONS
-Copyright (c) 1996 Regents of the University of California
+ PostgreSQL Installation Instructions
-This directory contains the source and documentation for Postgres95
-(version 2) Postgres95 is a derivative of POSTGRES 4.2 (the last
-release of the UC Berkeley research project). For copyright terms for
-postgres95, please see the file named COPYRIGHT. This version was
-developed by a team of developers on the postgres developers mailing
-list. Version 1 (through 1.01) was developed by Jolly Chen and Andrew
-Yu.
+ ------------------------------------------------------------------------
+Short Version
-REQUIREMENTS TO RUN POSTGRES95
-------------------------------
-
-Postgres95 has been tested on the following platforms:
-
- alpha - DEC Alpha AXP on OSF/1 2.0
- hpux - HP PA-RISC on HP-UX 9.0
- i386_solaris - i386 Solaris
- sparc_solaris - SUN SPARC on Solaris 2.4
- sparc - SUN SPARC on SunOS 4.1.3
- ultrix4 - DEC MIPS on Ultrix 4.4
- linux - Intel x86 on Linux 1.2 and Linux ELF
- BSD44_derived - OSs derived from 4.4-lite BSD (NetBSD, FreeBSD)
- bsdi - BSD/OS 2.0 and 2.01
- bsdi_2_1 - BSD/OS 2.1
- aix - IBM on AIX 3.2.5
- irix5 - SGI MIPS on IRIX 5.3
- dgux - DG/UX 5.4R3.10
- Some hooks are provided for
- svr4 - Intel x86 on Intel SVR4
- next - Motorola MC68K or Intel x86 on NeXTSTEP 3.2
- but these are guaranteed not to work as of yet.
+./configure
+gmake
+su
+gmake install
+adduser postgres
+mkdir /usr/local/pgsql/data
+chown postgres /usr/local/pgsql/data
+su - postgres
+/usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data
+/usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data >logfile 2>&1 &
+/usr/local/pgsql/bin/createdb test
+/usr/local/pgsql/bin/psql test
-Postgres95 is also known to work on a number of other platforms that the
-authors have not personally tested.
+The long version is the rest of this document.
-You should have at least 8 MB of memory and at least 30 MB of disk space to
-hold the source, binaries, and user databases.
+ ------------------------------------------------------------------------
+Requirements
-MIGRATING FROM POSTGRES VERSION 1
----------------------------------
+In general, a modern Unix-compatible platform should be able to run
+PostgreSQL. The platforms that had received specific testing at the time of
+release are listed in the Section called Supported Platforms below. In the
+"doc" subdirectory of the distribution there are several platform-specific
+FAQ documents you might wish to consult if you are having trouble.
-Version 2 is mostly backward compatible with Version 1, but the database
-format is incompatible, so if you have databases that you use with Version
-1, you need to convert them before you can use them with Version 2. Once
-you do that, you won't be able to use them with Version 1 anymore.
+The following prerequisites exist for building PostgreSQL:
-For details on how to do this conversion, see the file MIGRATION_V1_TO_V2.
+ * GNU make is required; other make programs will *not* work. GNU make is
+ often installed under the name "gmake"; this document will always refer
+ to it by that name. (On some systems GNU make is the default tool with
+ the name "make".) To test for GNU make enter
+ gmake --version
-INSTALLING POSTGRES95
----------------------
+ It is recommended to use version 3.76.1 or later.
-Installing Postgres95 encompasses only installing the software on your system
-so you can use it to access (or create or manipulate) databases. This
-step does not include actually creating any database or configuring your
-system to use it.
+ * You need an ISO/ANSI C compiler. Recent versions of GCC are
+ recommendable, but PostgreSQL is known to build with a wide variety of
+ compilers from different vendors.
-To install Postgres95 on UNIX platforms:
+ * gzip is needed to unpack the distribution in the first place. If you
+ are reading this, you probably already got past that hurdle.
-1. Unpack the source distribution into a source directory. We'll assume
- "/usr/src/postgres95" in this discussion. This should be a new directory.
-
-2. Set your current directory to the source directory:
+ * 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 essential. (On NetBSD,
+ the "libedit" library is readline-compatible and is used if
+ "libreadline" is not found.)
- cd /usr/src/postgres95
+ * GNU Flex and Bison are needed to build from scratch, but they are *not*
+ required when building from a released source package because
+ pre-generated output files are included in released packages. You will
+ need these programs only when building from a CVS tree or if you
+ changed the actual scanner and parser definition files. If you need
+ them, be sure to get Flex 2.5.4 or later and Bison 1.28 or later. Other
+ yacc programs can sometimes be used, but doing so requires extra effort
+ and is not recommended. Other lex programs will definitely not work.
-3. Build Postgres95:
+ * To build on Windows NT or Windows 2000 you need the Cygwin and cygipc
+ packages. See the file "doc/FAQ_MSWIN" for details.
- If you're installing Postgres95 on Ultrix 4.x or Linux, see the
- porting notes at the end for additional packages that you need to install
- before installing Postgres95.
+If you need to get a GNU package, you can find it at your local GNU mirror
+site (see http://www.gnu.org/order/ftp.html for a list) or at
+ftp://ftp.gnu.org/gnu/.
- Our Makefiles require GNU make (called gmake in this document) and
- also assume that "install" accepts BSD options. The INSTALL
- variable in the Makefiles is set to the BSD-compatible version of
- install. On some systems, you will have to find a BSD-compatible
- install to the location of this program. (eg. bsdinst, which comes
- with the MIT X Window System distribution)
+Also check that you have sufficient disk space. You will need about 30 MB
+for the source tree during compilation and about 10 MB for the installation
+directory. An empty database cluster takes about 20 MB, databases take about
+five times the amount of space that a flat text file with the same data
+would take. If you are going to run the regression tests you will
+temporarily need an extra 20 MB. Use the "df" command to check for disk
+space.
- Customization can be done by editing src/Makefile.global. You may change
- the various configuration options here, such as where the Postgres95
- executable files are installed and where postgres looks for the database
- directory. The configuration switches are fairly self-explanatory, but we
- will go over some of the more commonly-changed options:
+ ------------------------------------------------------------------------
- - PORTNAME specifies the platform on which Postgres95 is being build
- (BSD44_derived is the default). You might need to change it to reflect
- your platform. (sparc for SunOS 4.1.x, sparc_solaris for Solaris
- 2.4, ultrix4 for Ultrix 4.4, and hpux for HP-UX 9.0)
+If You Are Upgrading
- - SRCDIR specifies where the source files are located. (defaults to
- $(POSTGRESDIR)/src.)
+The internal data storage format changes with new releases of PostgreSQL.
+Therefore, if you are upgrading an existing installation that does not have
+a version number "7.2.x", you must back up and restore your data as shown
+here. These instructions assume that your existing installation is under the
+"/usr/local/pgsql" directory, and that the data area is in
+"/usr/local/pgsql/data". Substitute your paths appropriately.
- - POSTGRESDIR specifies the top-level directory where Postgres95
- binaries, header files, libraries, and databases are installed.
+ 1. Make sure that your database is not updated during or after the backup.
+ This does not affect the integrity of the backup, but the changed data
+ would of course not be included. If necessary, edit the permissions in
+ the file "/usr/local/pgsql/data/pg_hba.conf" (or equivalent) to
+ disallow access from everyone except you.
- - NAMEDATALEN and OIDNAMELEN allows you to set the maximum length of
- system identifiers (table names, function names, etc.) It
- defaults to 32. You may alter this if you like, but be aware that
- databases created with different NAMEDATALEN's do not
- interoperate.
+ 2. To dump your database installation, type:
- - USE_READLINE specifies whether you want to use the GNU readline and
- history libraries for the psql interactive frontend program. GNU
- readline is not supplied with postgres95 and can be found in the
- usual ftp sites for GNU software.
+ pg_dumpall > outputfile
- - HBA specifies whether you wish to use host-based authentication
- for postgres95. See the section "How to Create a Database System"
- for how to set up the HBA permissions if you decide to use HBA.
+ If you need to preserve OIDs (such as when using them as foreign keys),
+ then use the "-o" option when running "pg_dumpall".
- After editing src/Makefile.global, you are ready to compile Postgres95
- (it takes about 10 minutes on a 133Mhz Pentium running linux):
+ "pg_dumpall" does not save large objects. Check the Administrator's
+ Guide if you need to do this.
- % cd src
- % gmake
+ Make sure that you use the "pg_dumpall" command from the version you
+ are currently running. 7.2's "pg_dumpall" should not be used on older
+ databases.
- The gmake ultimately issues the message "All of Postgres95 is
- successfully made. Ready to install." If you don't get that, the make
- failed, and there should be error messages at the end detailing why.
+ 3. If you are installing the new version at the same location as the old
+ one then shut down the old server, at the latest before you install the
+ new files:
-4. Install Postgres95
+ kill -INT `cat /usr/local/pgsql/data/postmaster.pid`
- Installing just means placing all the files built in the previous step
- into their live locations on your system.
+ Versions prior to 7.0 do not have this "postmaster.pid" file. If you
+ are using such a version you must find out the process id of the server
+ yourself, for example by typing "ps ax | grep postmaster", and supply
+ it to the "kill" command.
- % gmake install
+ 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
- This will narrate all the files being installed. You should watch and
- be sure the files are going to reasonable places and confirm for yourself
- that they ended up where they belong.
+ /etc/rc.d/init.d/postgresql stop
- Any error messages indicate something is wrong and you probably have to
- correct it before Postgres95 will work.
+ works. Another possibility is "pg_ctl stop".
+ 4. If you are installing in the same place as the old version then it is
+ also a good idea to move the old installation out of the way, in case
+ you have trouble and need to revert to it. Use a command like this:
-HOW TO CREATE A DATABASE SYSTEM
--------------------------------
+ mv /usr/local/pgsql /usr/local/pgsql.old
-Once you have Postgres installed, you'll need at least one database system
-on which to operate. A database system is a collection of databases that
-are used together and fall under a single authority. You can have as many
-database systems as you want on a single unix system.
+After you have installed PostgreSQL 7.2, 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).
-You select a unix user to be the "postgres superuser" for a database
-system and that user, for one thing, owns all the unix files that hold
-all the data for that database system. It is usually a good idea to create
-a user for the sole purpose of being a postgres superuser.
+/usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data
+/usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data
-WARNING: Postgres95 is not secure. Anyone who can connect to a database
-system can easily assume all the unix privileges of its Postgres
-superuser. The simplest way is by creating and running a C language
-function. There are plans to remedy this in future developent.
+Finally, restore your data with
-The program initdb (part of Postgres) is what initializes (creates) a
-database system. See the man page for initdb.
+/usr/local/pgsql/bin/psql -d template1 -f outputfile
-Example:
+using the *new* psql.
- % initdb --pgdata=/usr/lib/postgres_data --username=postgres
+You can also install the new version in parallel with the old one to
+decrease the downtime. These topics are discussed at length in the
+Administrator's Guide, which you are encouraged to read in any case.
-This example creates the files for the database system in the directory
-/usr/lib/postgres_data and makes user "postgres" the Postgres superuser
-for the new database system.
+ ------------------------------------------------------------------------
-By default, the user issuing the initdb command becomes the Postgres
-superuser, and only the unix superuser can specify any other user as the
-Postgres superuser.
+Installation Procedure
-Setting up Permissions
-----------------------
+ 1. Configuration
-The first thing you should do after creating a database system is set up
-the permissions for connecting to the database. These are kept in the
-file pg_hba in the data directory. Initdb creates a sample version of
-this file, which contains comments telling you how to set it up.
+ The first step of the installation procedure is to configure the source
+ tree for your system and choose the options you would like. This is
+ done by running the "configure" script. For a default installation
+ simply enter
-The Postmaster Daemon
----------------------
+ ./configure
-Finally, in order to use the database system, you'll need to have a
-postmaster daemon running. There is one postmaster process per database
-system. The postmaster runs the program "postgres" and must run as the
-Postgres superuser. See the postgres man page.
+ This script will run a number of tests to guess values for various
+ system dependent variables and detect some quirks of your operating
+ system, and finally will create several files in the build tree to
+ record what it found.
-So, for example, you can login as the Postgres superuser and issue the
-command:
+ The default configuration will build the server and utilities, as well
+ as all client applications and interfaces that require only a C
+ compiler. All files will be installed under "/usr/local/pgsql" by
+ default.
- % postgres -S -D/usr/lib/postgres/postgres_data -p5432
+ You can customize the build and installation process by supplying one
+ or more of the following command line options to "configure":
-This says to run the postmaster against the database system created above,
-to accept connections from users on the conventional TCP port 5432, and
-(-S) to run in the background without issuing messages about normal
-execution.
+ --prefix=PREFIX
-This is a good daemon to start via system startup scripts, using su (be
-careful NOT to run the postmaster as the unix superuser by mistake).
+ Install all files under the directory "PREFIX" instead of
+ "/usr/local/pgsql". The actual files will be installed into
+ various subdirectories; no files will ever be installed directly
+ into the "PREFIX" directory.
+ If you have special needs, you can also customize the individual
+ subdirectories with the following options.
-TESTING POSTGRES95
-------------------
+ --exec-prefix=EXEC-PREFIX
-We suggest you run the regression tests to make sure the release was
-installed successfully and works as designed in your environment. The
-regression tests can be found in src/test/regress. (see
-src/test/regress/README for more details)
+ You can install architecture-dependent files under a different
+ prefix, "EXEC-PREFIX", than what "PREFIX" was set to. This can be
+ useful to share architecture-independent files between hosts. If
+ you omit this, then "EXEC-PREFIX" is set equal to "PREFIX" and
+ both architecture-dependent and independent files will be
+ installed under the same tree, which is probably what you want.
- % cd /usr/src/postgres95/src/test/regress
- % gmake all runtest
+ --bindir=DIRECTORY
-This will run a whole slew of regression tests and might take a long time
-to run. When it's done, the output is in the file obj/regress.out. You
-can compare this to a sample run that we supply in the file
-sample.regress.out. (You should get roughly the same output except for
-some pathnames.)
+ Specifies the directory for executable programs. The default is
+ "EXEC-PREFIX/bin", which normally means "/usr/local/pgsql/bin".
- % diff obj/regress.out sample.regress.out
+ --datadir=DIRECTORY
-The regression test takes about half an hour to run on a Sparc 10. You
-may want to use 'grep -v' to remove unsignificant differences.
+ Sets the directory for read-only data files used by the installed
+ programs. The default is "PREFIX/share". Note that this has
+ nothing to do with where your database files will be placed.
+ --sysconfdir=DIRECTORY
-PLAYING WITH POSTGRES95
------------------------
+ The directory for various configuration files, "PREFIX/etc" by
+ default.
-After Postgres95 is installed, a database system is created, a postmaster
-daemon is running, and the regression tests have passed, you'll want to
-see Postgres95 do something. That's easy. Invoke the interactive interface
-to Postgres95, psql, and start typing SQL:
+ --libdir=DIRECTORY
- % psql -d/usr/lib/postgres_data template1
+ The location to install libraries and dynamically loadable
+ modules. The default is "EXEC-PREFIX/lib".
-(psql has to open a particular database, but at this point the only one
-that exists is the template1 database, which always exists. We will connect
-to it only long enough to create another one and switch to it).
+ --includedir=DIRECTORY
-The response from psql is:
+ The directory for installing C and C++ header files. The default
+ is "PREFIX/include".
- type \? for help on slash commands
- type \q to quit
- type \g or terminate with semicolon to execute query
-You are currently connected to the database: template1
+ --docdir=DIRECTORY
-template1=>
+ Documentation files, except "man" pages, will be installed into
+ this directory. The default is "PREFIX/doc".
-Create the database foo:
+ --mandir=DIRECTORY
-template1=> CREATE DATABASE FOO;
-INSERT 773248
+ The man pages that come with PostgreSQL will be installed under
+ this directory, in their respective "manx" subdirectories. The
+ default is "PREFIX/man".
-(Don't ever forget those SQL semicolons. Psql won't execute anything until it
-sees the semicolon).
+ Note: Care has been taken to make it possible to install
+ PostgreSQL into shared installation locations (such as
+ "/usr/local/include") without interfering with the namespace
+ of the rest of the system. First, the string "/postgresql" is
+ automatically appended to datadir, sysconfdir, and docdir,
+ unless the fully expanded directory name already contains the
+ string "postgres" or "pgsql". For example, if you choose
+ "/usr/local" as prefix, the documentation will be installed
+ in "/usr/local/doc/postgresql", but if the prefix is
+ "/opt/postgres", then it will be in "/opt/postgres/doc".
+ Second, the installation layout of the C and C++ header files
+ has been reorganized in the 7.2 release. The public header
+ files of the client interfaces are installed into includedir
+ and are namespace-clean. The internal header files and the
+ server header files are installed into private directories
+ under includedir. See the Programmer's Guide for information
+ about how to get at the header files for each interface.
+ Finally, a private subdirectory will also be created, if
+ appropriate, under libdir for dynamically loadable modules.
-template1=> \c foo
-closing connection to database: template1
-connecting to new database: foo
+ --with-includes=DIRECTORIES
-(\ commands aren't SQL, so no semicolon. Use \? to see all the \ commands).
+ "DIRECTORIES" is a colon-separated list of directories that will
+ be added to the list the compiler searches for header files. If
+ you have optional packages (such as GNU Readline) installed in a
+ non-standard location, you have to use this option and probably
+ also the corresponding "--with-libraries" option.
-template1=> CREATE TABLE bar (column1 int4, column2 char16);
-CREATE
+ Example: --with-includes=/opt/gnu/include:/usr/sup/include.
-template1=> \d bar
+ --with-libraries=DIRECTORIES
-...
+ "DIRECTORIES" is a colon-separated list of directories to search
+ for libraries. You will probably have to use this option (and the
+ corresponding "--with-includes" option) if you have packages
+ installed in non-standard locations.
-You get the idea.
+ Example: --with-libraries=/opt/gnu/lib:/usr/sup/lib.
+ --enable-locale
+ Enables locale support. There is a performance penalty associated
+ with locale support, but if you are not in an English-speaking
+ environment you will most likely need this.
-QUESTIONS? BUGS? FEEDBACK?
---------------------------
+ --enable-recode
-First, please read the Frequently Asked Questions and answers in the file
-called FAQ.
+ Enables single-byte character set recode support. See the
+ Administrator's Guide about this feature.
-If you still have questions, please send them to
-postgres95@postgres95.vnet.net.
+ --enable-multibyte
-If you have a bug report to make, please send a filled out version of
-the file named "bug.template" to pg95-dev@ki.net.
+ Allows the use of multibyte character encodings (including
+ Unicode) and character set encoding conversion. Read the
+ Administrator's Guide for details.
-If you would like to help out with the development and maintenance of
-postgres95, send subscribe to the developers mailing list. See
-README.support for more information
+ Note that some interfaces (such as Tcl or Java) expect all
+ character strings to be in Unicode, so this option will be
+ required to correctly support these interfaces.
-----------------------------------------------------------------------
+ --enable-nls[=LANGUAGES]
-Porting Notes:
--------------
-Ultrix4.x:
- You need to install the libdl-1.1 package since Ultrix 4.x doesn't
- have a dynamic loader. It's available in
- s2k-ftp.CS.Berkeley.EDU:pub/personal/andrew/libdl-1.1.tar.Z
+ Enables Native Language Support (NLS), that is, the ability to
+ display a program's messages in a language other than English.
+ "LANGUAGES" is a space separated list of codes of the languages
+ that you want supported, for example --enable-nls='de fr'. (The
+ intersection between your list and the set of actually provided
+ translations will be computed automatically.) If you do not
+ specify a list, then all available translations are installed.
-Linux:
- The linux port defaults to the ELF binary format. (Note that if you're
- using ELF, you don't need dld because you'll be using the dl library
- that comes with Linux ELF instead.)
+ To use this option, you will need an implementation of the gettext
+ API. Some operating systems have this built-in (e.g., Linux,
+ NetBSD, Solaris), for other systems you can download an add-on
+ package from here: http://www.postgresql.org/~petere/gettext.html.
+ If you are using the gettext implementation in the GNU C library
+ then you will additionally need the GNU gettext package for some
+ utility programs. For any of the other implementations you will
+ not need it.
- To compile on non-ELF Linux, comment out the LINUX_ELF line in
- src/mk/port/postgres.mk.linux. Also, the dld library MUST be obtained
- and installed on the system. It enables dynamic link loading capability
- to the postgres port. The dld library can be obtained from the sunsite
- linux distributions. The current name is dld-3.2.5.
- (Jalon Q. Zimmerman
- <sneaker@powergrid.electriciti.com> 5/11/95)
+ --with-pgport=NUMBER
- To compile with flex, you need a recent version (2.5.2 or
- later). Otherwise, you will get a 'yy_flush_buffer' undefined error.
+ Set "NUMBER" as the default port number for server and clients.
+ The default is 5432. The port can always be changed later on, but
+ if you specify it here then both server and clients will have the
+ same default compiled in, which can be very convenient. Usually
+ the only good reason to select a non-default value is if you
+ intend to run multiple PostgreSQL servers on the same machine.
-BSD/OS:
- For BSD/OS 2.0 and 2.01, you will need to get flex version 2.5.2
- as well as the GNU dld library. Flex version 2.5.3 has a known bug.
+ --with-CXX
-NeXT:
- The NeXT port was supplied by Tom R. Hageman <tom@basil.icce.rug.nl>.
- It requires a SysV IPC emulation library and header files for
- shared libary and semaphore stuff. Tom just happens to sell such
- a product so contact him for information. He has also indicated that
- binary releases of postgres95 for NEXTSTEP will be made available to
- the general public. Contact Info@RnA.nl for information.
+ Build the C++ interface library.
+ --with-perl
+ Build the Perl interface module. The Perl interface will be
+ installed at the usual place for Perl modules (typically under
+ "/usr/lib/perl"), so you must have root access to perform the
+ installation step (see step 4). You need to have Perl 5 installed
+ to use this option.
+
+ --with-python
+
+ Build the Python interface module. You need to have root access to
+ be able to install the Python module at its default place
+ ("/usr/lib/pythonx.y"). To be able to use this option, you must
+ have Python installed and your system needs to support shared
+ libraries. If you instead want to build a new complete interpreter
+ binary, you will have to do it manually.
+
+ --with-tcl
+
+ Builds components that require Tcl/Tk, which are libpgtcl,
+ pgtclsh, pgtksh, PgAccess, and PL/Tcl. But see below about
+ "--without-tk".
+
+ --without-tk
+
+ If you specify "--with-tcl" and this option, then programs that
+ require Tk (pgtksh and PgAccess) will be excluded.
+
+ --with-tclconfig=DIRECTORY, --with-tkconfig=DIRECTORY
+
+ Tcl/Tk installs the files "tclConfig.sh" and "tkConfig.sh", which
+ contain configuration information needed to build modules
+ interfacing to Tcl or Tk. These files are normally found
+ automatically at their well-known locations, but if you want to
+ use a different version of Tcl or Tk you can specify the directory
+ in which to find them.
+
+ --enable-odbc
+
+ Build the ODBC driver. By default, the driver will be independent
+ of a driver manager. To work better with a driver manager already
+ installed on your system, use one of the following options in
+ addition to this one. More information can be found in the
+ Programmer's Guide.
+
+ --with-iodbc
+
+ Build the ODBC driver for use with iODBC.
+
+ --with-unixodbc
+
+ Build the ODBC driver for use with unixODBC.
+
+ --with-odbcinst=DIRECTORY
+
+ Specifies the directory where the ODBC driver will expect its
+ "odbcinst.ini" configuration file. The default is
+ "/usr/local/pgsql/etc" or whatever you specified as
+ "--sysconfdir". It should be arranged that the driver reads the
+ same file as the driver manager.
+
+ If either the option "--with-iodbc" or the option
+ "--with-unixodbc" is used, this option will be ignored because in
+ that case the driver manager handles the location of the
+ configuration file.
+
+ --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.
+
+ --with-krb4[=DIRECTORY], --with-krb5[=DIRECTORY]
+
+ Build with support for Kerberos authentication. You can use either
+ Kerberos version 4 or 5, but not both. The "DIRECTORY" argument
+ specifies the root directory of the Kerberos installation;
+ "/usr/athena" is assumed as default. If the relevant header files
+ and libraries are not under a common parent directory, then you
+ must use the "--with-includes" and "--with-libraries" options in
+ addition to this option. If, on the other hand, the required files
+ are in a location that is searched by default (e.g., "/usr/lib"),
+ then you can leave off the argument.
+
+ "configure" will check for the required header files and libraries
+ to make sure that your Kerberos installation is sufficient before
+ proceeding.
+
+ --with-krb-srvnam=NAME
+
+ The name of the Kerberos service principal. postgres is the
+ default. There's probably no reason to change this.
+
+ --with-openssl[=DIRECTORY]
+
+ Build with support for SSL (encrypted) connections. This requires
+ the OpenSSL package to be installed. The "DIRECTORY" argument
+ specifies the root directory of the OpenSSL installation; the
+ default is "/usr/local/ssl".
+
+ "configure" will check for the required header files and libraries
+ to make sure that your OpenSSL installation is sufficient before
+ proceeding.
+
+ --with-pam
+
+ Build with PAM (Pluggable Authentication Modules) support.
+
+ --enable-syslog
+
+ Enables the PostgreSQL server to use the syslog logging facility.
+ (Using this option does not mean that you must log with syslog or
+ even that it will be done by default, it simply makes it possible
+ to turn that option on at run time.)
+
+ --enable-debug
+
+ Compiles all programs and libraries with debugging symbols. This
+ means that you can run the programs through a debugger to analyze
+ 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 recommended for
+ production installations only if you use GCC. But you should
+ always 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 server 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.
+
+ --enable-depend
+
+ Enables automatic dependency tracking. With this option, the
+ makefiles are set up so that all affected object files will be
+ rebuilt when any header file is changed. This is useful if you are
+ doing development work, but is just wasted overhead if you intend
+ only to compile once and install. At present, this option will
+ work only if you use GCC.
+
+ If you prefer a C or C++ compiler different from the one "configure"
+ picks then you can set the environment variables CC or CXX,
+ respectively, to the program of your choice. Similarly, you can
+ override the default compiler flags with the CFLAGS and CXXFLAGS
+ variables. For example:
+
+ env CC=/opt/bin/gcc CFLAGS='-O2 -pipe' ./configure
+
+ 2. Build
+
+ To start the build, type
+
+ gmake
+
+ (Remember to use GNU make.) The build may take anywhere from 5 minutes
+ to half an hour depending on your hardware. The last line displayed
+ should be
+
+ All of PostgreSQL is successfully made. Ready to install.
+
+ 3. Regression Tests
+
+ If you want to test the newly built server before you install it, you
+ can run the regression tests at this point. The regression tests are a
+ test suite to verify that PostgreSQL runs on your machine in the way
+ the developers expected it to. Type
+
+ gmake check
+
+ (This won't work as root; do it as an unprivileged user.) It is
+ possible that some tests fail, due to differences in error message
+ wording or floating point results. The file "src/test/regress/README"
+ and the Administrator's Guide contain detailed information about
+ interpreting the test results. You can repeat this test at any later
+ time by issuing the same command.
+
+ 4. Installing The Files
+
+ Note: If you are upgrading an existing system and are going
+ to install the new files over the old ones, then you should
+ have backed up your data and shut down the old server by now,
+ as explained in the Section called If You Are Upgrading
+ above.
+
+ To install PostgreSQL enter
+
+ gmake install
+
+ This will install files into the directories that were specified in
+ step 1. Make sure that you have appropriate permissions to write into
+ that area. Normally you need to do this step as root. Alternatively,
+ you could create the target directories in advance and arrange for
+ appropriate permissions to be granted.
+
+ If you built the Perl or Python interfaces and you were not the root
+ user when you executed the above command then that part of the
+ installation probably failed. In that case you should become the root
+ user and then do
+
+ gmake -C src/interfaces/perl5 install
+ gmake -C src/interfaces/python install
+
+ If you do not have superuser access you are on your own: you can still
+ take the required files and place them in other directories where Perl
+ or Python can find them, but how to do that is left as an exercise.
+
+ The standard installation provides only the header files needed for
+ client application development. If you plan to do any server-side
+ program development (such as custom functions or data types 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 installation 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 interface libraries, then you can use these commands:
+
+ gmake -C src/bin install
+ gmake -C src/include install
+ gmake -C src/interfaces install
+ gmake -C doc install
+
+ To undo the installation use the command "gmake uninstall". However,
+ this will not remove any created directories.
+
+After the installation you can make room by removing the built files from
+the source tree with the "gmake clean" command. This will preserve the files
+made by the configure program, so that you can rebuild everything with
+"gmake" later on. To reset the source tree to the state in which it was
+distributed, use "gmake distclean". If you are going to build for several
+platforms from the same source tree you must do this and re-configure for
+each build.
+
+If you perform a build and then discover that your configure options were
+wrong, or if you change anything that configure investigates (for example,
+you install GNU Readline), then it's a good idea to do "gmake distclean"
+before reconfiguring and rebuilding. Without this, your changes in
+configuration choices may not propagate everywhere they need to.
+
+ ------------------------------------------------------------------------
+
+Post-Installation Setup
+
+Shared Libraries
+
+On some systems that have shared libraries (which most systems do) you need
+to tell your system how to find the newly installed shared libraries. The
+systems on which this is *not* necessary include BSD/OS, FreeBSD, HP-UX,
+IRIX, Linux, NetBSD, OpenBSD, Tru64 UNIX (formerly Digital UNIX), and
+Solaris.
+
+The method to set the shared library search path varies between platforms,
+but the most widely usable method is to set the environment variable
+LD_LIBRARY_PATH like so: In Bourne shells ("sh", "ksh", "bash", "zsh")
+
+LD_LIBRARY_PATH=/usr/local/pgsql/lib
+export LD_LIBRARY_PATH
+
+or in "csh" or "tcsh"
+
+setenv LD_LIBRARY_PATH /usr/local/pgsql/lib
+
+Replace /usr/local/pgsql/lib with whatever you set "--libdir" to in step 1.
+You should put these commands into a shell start-up file such as
+"/etc/profile" or "~/.bash_profile". Some good information about the caveats
+associated with this method can be found at
+http://www.visi.com/~barr/ldpath.html.
+
+On some systems it might be preferable to set the environment variable
+LD_RUN_PATH *before* building.
+
+If in doubt, refer to the manual pages of your system (perhaps "ld.so" or
+"rld"). If you later on get a message like
+
+psql: error in loading shared libraries
+libpq.so.2.1: cannot open shared object file: No such file or directory
+
+then this step was necessary. Simply take care of it then.
+
+If you are on BSD/OS, Linux, or SunOS 4 and you have root access you can run
+
+/sbin/ldconfig /usr/local/pgsql/lib
+
+(or equivalent directory) after installation to enable the run-time linker
+to find the shared libraries faster. Refer to the manual page of "ldconfig"
+for more information. On FreeBSD, NetBSD, and OpenBSD the command is
+
+/sbin/ldconfig -m /usr/local/pgsql/lib
+
+instead. Other systems are not known to have an equivalent command.
+
+ ------------------------------------------------------------------------
+
+Environment Variables
+
+If you installed into "/usr/local/pgsql" or some other location that is not
+searched for programs by default, you need to add "/usr/local/pgsql/bin" (or
+whatever you set "--bindir" to in step 1) into your PATH. To do this, add
+the following to your shell start-up file, such as "~/.bash_profile" (or
+"/etc/profile", if you want it to affect every user):
+
+PATH=/usr/local/pgsql/bin:$PATH
+
+If you are using "csh" or "tcsh", then use this command:
+
+set path = ( /usr/local/pgsql/bin $path )
+
+To enable your system to find the man documentation, you need to add a line
+like the following to a shell start-up file:
+
+MANPATH=/usr/local/pgsql/man:$MANPATH
+
+The environment variables PGHOST and PGPORT specify to client applications
+the host and port of the database server, overriding the compiled-in
+defaults. If you are going to run client applications remotely then it is
+convenient if every user that plans to use the database sets PGHOST. This is
+not required, however: the settings can be communicated via command line
+options to most client programs.
+
+ ------------------------------------------------------------------------
+
+Getting Started
+
+The following is a quick summary of how to get PostgreSQL up and running
+once installed. The Administrator's Guide contains more information.
+
+ 1. Create a user account for the PostgreSQL server. This is the user the
+ server will run as. For production use you should create a separate,
+ unprivileged account ("postgres" is commonly used). If you do not have
+ root access or just want to play around, your own user account is
+ enough, but running the server as root is a security risk and will not
+ work.
+
+ adduser postgres
+
+ 2. Create a database installation with the "initdb" command. To run
+ "initdb" you must be logged in to your PostgreSQL server account. It
+ will not work as root.
+
+ root# mkdir /usr/local/pgsql/data
+ root# chown postgres /usr/local/pgsql/data
+ root# su - postgres
+ postgres$ /usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data
+
+ The "-D" option specifies the location where the data will be stored.
+ You can use any path you want, it does not have to be under the
+ installation directory. Just make sure that the server account can
+ write to the directory (or create it, if it doesn't already exist)
+ before starting "initdb", as illustrated here.
+
+ 3. The previous step should have told you how to start up the database
+ server. Do so now. The command should look something like
+
+ /usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data
+
+ This will start the server in the foreground. To put the server in the
+ background use something like
+
+ nohup /usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data \
+ </dev/null >>server.log 2>&1 </dev/null &
+
+ To stop a server running in the background you can type
+
+ kill `cat /usr/local/pgsql/data/postmaster.pid`
+
+ In order to allow TCP/IP connections (rather than only Unix domain
+ socket ones) you need to pass the "-i" option to "postmaster".
+
+ 4. Create a database:
+
+ createdb testdb
+
+ Then enter
+
+ psql testdb
+
+ to connect to that database. At the prompt you can enter SQL commands
+ and start experimenting.
+
+ ------------------------------------------------------------------------
+
+What Now?
+
+ * The PostgreSQL distribution contains a comprehensive documentation set,
+ which you should read sometime. After installation, the documentation
+ can be accessed by pointing your browser to
+ "/usr/local/pgsql/doc/html/index.html", unless you changed the
+ installation directories.
+
+ The Tutorial should be your first reading if you are completely new to
+ SQL databases. 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.
+
+ * Usually, you will want to modify your computer so that it will
+ automatically start the database server whenever it boots. Some
+ suggestions for this are in the Administrator's Guide.
+
+ * Run the regression tests against the installed server (using the
+ sequential test method). If you didn't run the tests before
+ installation, you should definitely do it now. This is also explained
+ in the Administrator's Guide.
+
+ ------------------------------------------------------------------------
+
+Supported Platforms
+
+PostgreSQL has been verified by the developer community to work on the
+platforms listed below. A supported platform generally means that PostgreSQL
+builds and installs according to these instructions and that the regression
+tests pass.
+
+ Note: If you are having problems with the installation on a
+ supported platform, please write to <pgsql-bugs@postgresql.org> or
+ <pgsql-ports@postgresql.org>, not to the people listed here.
+
+ OS Processor Version Reported Remarks
+ AIX RS6000 7.2 2001-12-19, Andreas Zeugswetter see also
+ (<ZeugswetterA@spardat.at>), doc/FAQ_AIX
+ Tatsuo Ishii
+ (<t-ishii@sra.co.jp>)
+ BeOS x86 7.2 2001-11-29, Cyril Velter 5.0.4
+ (<cyril.velter@libertysurf.fr>)
+ BSD/OS x86 7.2 2001-11-27, Bruce Momjian 4.2
+ (<pgman@candle.pha.pa.us>)
+ FreeBSDAlpha 7.2 2001-12-18, Chris Kings-Lynne
+ (<chriskl@familyhealth.com.au>)
+ FreeBSDx86 7.2 2001-11-14, Chris Kings-Lynne
+ (<chriskl@familyhealth.com.au>)
+ HP-UX PA-RISC 7.2 2001-11-29, Joseph Conway 11.00 and 10.20;
+ (<Joseph.Conway@home.com>), Tom see also
+ Lane (<tgl@sss.pgh.pa.us>) doc/FAQ_HPUX
+ IRIX MIPS 7.2 2001-11-28, Luis Amigo 6.5.13, MIPSPro
+ (<lamigo@atc.unican.es>) 7.30
+ Linux Alpha 7.2 2001-11-16, Tom Lane 2.2.18; tested at
+ (<tgl@sss.pgh.pa.us>) SourceForge
+ Linux armv4l 7.2 2001-12-10, Mark Knox 2.2.x
+ (<segfault@hardline.org>)
+ Linux MIPS 7.2 2001-11-15, Hisao Shibuya 2.0.x; Cobalt
+ (<shibuya@alpha.or.jp>) Qube2
+ Linux PlayStation 7.2 2001-12-12, Permaine Cheung #undef
+ 2 <pcheung@redhat.com>) HAS_TEST_AND_SET,
+ slock_t
+ Linux PPC74xx 7.2 2001-11-16, Tom Lane 2.2.18; Apple G3
+ (<tgl@sss.pgh.pa.us>)
+ Linux S/390 7.2 2001-12-12, Permaine Cheung
+ <pcheung@redhat.com>)
+ Linux Sparc 7.2 2001-11-28, Doug McNaught 2.2.19
+ (<doug@wireboard.com>)
+ Linux x86 7.2 2001-11-15, Thomas Lockhart 2.0.x, 2.2.x,
+ (<lockhart@fourpalms.org>) 2.4.x
+ MacOS XPPC 7.2 2001-11-28, Gavin Sherry 10.1.x
+ (<swm@linuxworld.com.au>)
+ NetBSD Alpha 7.2 2001-11-20, Thomas Thai 1.5W
+ (<tom@minnesota.com>)
+ NetBSD arm32 7.1 2001-03-21, Patrick Welche 1.5E
+ (<prlw1@cam.ac.uk>)
+ NetBSD m68k 7.0 2000-04-10, Henry B. Hotz Mac 8xx
+ (<hotz@jpl.nasa.gov>)
+ NetBSD PPC 7.2 2001-11-28, Bill Studenmund 1.5
+ (<wrstuden@netbsd.org>)
+ NetBSD Sparc 7.2 2001-12-03, Matthew Green 32- and 64-bit
+ (<mrg@eterna.com.au>) builds
+ NetBSD VAX 7.1 2001-03-30, Tom I. Helbekkmo 1.5
+ (<tih@kpnQwest.no>)
+ NetBSD x86 7.2 2001-11-28, Bill Studenmund 1.5
+ (<wrstuden@netbsd.org>)
+ OpenBSDSparc 7.2 2001-11-27, Brandon Palmer 3.0
+ (<bpalmer@crimelabs.net>)
+ OpenBSDx86 7.2 2001-11-26, Brandon Palmer 3.0
+ (<bpalmer@crimelabs.net>)
+ Open x86 7.2 2001-11-28, OU-8 Larry Rosenman see also
+ UNIX (<ler@lerctr.org>), UW-7 Olivier doc/FAQ_SCO
+ Prenant (<ohp@pyrenet.fr>)
+ QNX 4 x86 7.2 2001-12-10, Bernd Tegge 4.25; see also
+ RTOS (<tegge@repas-aeg.de>) doc/FAQ_QNX4
+ SolarisSparc 7.2 2001-11-12, Andrew Sullivan 2.6-8; see also
+ (<andrew@libertyrms.com>) doc/FAQ_Solaris
+ Solarisx86 7.2 2001-11-28, Martin Renters 2.8; see also
+ (<martin@datafax.com>) doc/FAQ_Solaris
+ SunOS 4Sparc 7.2 2001-12-04, Tatsuo Ishii
+ (<t-ishii@sra.co.jp>)
+ Tru64 Alpha 7.2 2001-11-26, Alessio Bragadini 5.0; 4.0g with cc
+ UNIX (<alessio@albourne.com>), Bernd and gcc
+ Tegge (<tegge@repas-aeg.de>)
+ Windowsx86 7.2 2001-12-13, Dave Page with Cygwin; see
+ (<dpage@vale-housing.co.uk>), doc/FAQ_MSWIN
+ Jason Tishler
+ (<jason@tishler.net>)
+ Windowsx86 7.2 2001-12-10, Dave Page native is
+ (<dpage@vale-housing.co.uk>) client-side only;
+ see
+ Administrator's
+ Guide
+
+Unsupported Platforms: The following platforms are either known not to work,
+or they used to work in a previous release and we did not receive explicit
+confirmation of a successful test with version 7.2 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
+ DG/UX m88k 6.3 1998-03-01, Brian E Gallew no recent
+ 5.4R4.11 (<geek+@cmu.edu>) reports
+ MkLinux DR1PPC750 7.0 2001-04-03, Tatsuo Ishii 7.1 needs OS
+ (<t-ishii@sra.co.jp>) update?
+ NeXTSTEP x86 6.x 1998-03-01, David Wetzel bit rot
+ (<dave@turbocat.de>) suspected
+ QNX RTOS v6x86 7.2 2001-11-20, Igor Kovalenko patches
+ (<Igor.Kovalenko@motorola.com>) available in
+ archives,
+ but too late
+ for 7.2
+ SCO x86 6.5 1999-05-25, Andrew Merrill 7.2 should
+ OpenServer (<andrew@compclass.com>) work, but no
+ 5 reports; see
+ also
+ doc/FAQ_SCO
+ System V R4m88k 6.2.1 1998-03-01, Doug Winterburn needs new
+ (<dlw@seavme.xroads.com>) TAS spinlock
+ code
+ System V R4MIPS 6.4 1998-10-28, Frank Ridderbusch no recent
+ (<ridderbusch.pad@sni.de>) reports
+ Ultrix MIPS 7.1 2001-03-26 TAS spinlock
+ code not
+ detected
+ Ultrix VAX 6.x 1998-03-01
projects / postgresql / blobdiff