]> granicus.if.org Git - postgresql/blob - INSTALL
Remove inappropriate double-quoting in connectby() code; adjust
[postgresql] / INSTALL
1
2                      PostgreSQL Installation Instructions
3
4 This document describes the installation of PostgreSQL from the source code
5 distribution.
6
7 -------------------------------------------------------------------------------
8
9                                  Short Version
10
11   ./configure
12   gmake
13   su
14   gmake install
15   adduser postgres
16   mkdir /usr/local/pgsql/data
17   chown postgres /usr/local/pgsql/data
18   su - postgres
19   /usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data
20   /usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data >logfile 2>&1 &
21   /usr/local/pgsql/bin/createdb test
22   /usr/local/pgsql/bin/psql test
23
24 The long version is the rest of this document.
25
26 -------------------------------------------------------------------------------
27
28                                  Requirements
29
30 In general, a modern Unix-compatible platform should be able to run PostgreSQL.
31 The platforms that had received specific testing at the time of release are
32 listed in the Section called Supported Platforms below. In the "doc"
33 subdirectory of the distribution there are several platform-specific FAQ
34 documents you might wish to consult if you are having trouble.
35 The following software packages are required for building PostgreSQL:
36
37     * GNU make is required; other make programs will *not* work. GNU make is
38       often installed under the name "gmake"; this document will always refer
39       to it by that name. (On some systems GNU make is the default tool with
40       the name "make".) To test for GNU make enter
41
42         gmake --version
43
44       It is recommended to use version 3.76.1 or later.
45
46     * You need an ISO/ANSI C compiler. Recent versions of GCC are
47       recommendable, but PostgreSQL is known to build with a wide variety of
48       compilers from different vendors.
49
50     * gzip is needed to unpack the distribution in the first place. If you are
51       reading this, you probably already got past that hurdle.
52
53     * The GNU Readline library (for comfortable line editing and command
54       history retrieval) will be used by default. If you don't want to use it
55       then you must specify the "--without-readline" option for "configure".
56       (On NetBSD, the "libedit" library is readline-compatible and is used if
57       "libreadline" is not found.)
58
59     * To build on Windows NT or Windows 2000 you need the Cygwin and cygipc
60       packages. See the file "doc/FAQ_MSWIN" for details.
61
62 The following packages are optional. They are not required in the default
63 configuration, but they are needed when certain build options are enabled, as
64 explained below.
65
66     * To build the server programming language PL/Perl you need a full Perl
67       installation, including the "libperl" library and the header files. Since
68       PL/Perl will be a shared library, the "libperl" library must be a shared
69       library also on most platforms. This appears to be the default in recent
70       Perl versions, but it was not in earlier versions, and in general it is
71       the choice of whomever installed Perl at your site.
72       If you don't have the shared library but you need one, a message like
73       this will appear during the build to point out this fact:
74
75         *** Cannot build PL/Perl because libperl is not a shared library.
76         *** You might have to rebuild your Perl installation.  Refer to
77         *** the documentation for details.
78
79       (If you don't follow the on-screen output you will merely notice that the
80       PL/Perl library object, "plperl.so" or similar, will not be installed.)
81       If you see this, you will have to rebuild and install Perl manually to be
82       able to build PL/Perl. During the configuration process for Perl, request
83       a shared library.
84
85     * To build the Python interface module or the PL/Python server programming
86       language, you need a Python installation, including the header files.
87       Since PL/Python will be a shared library, the "libpython" library must be
88       a shared library also on most platforms. This is not the case in a
89       default Python installation.
90       If after building and installing you have a file called "plpython.so"
91       (possibly a different extension), then everything went well. Otherwise
92       you should have seen a notice like this flying by:
93
94         *** Cannot build PL/Python because libpython is not a shared library.
95         *** You might have to rebuild your Python installation.  Refer to
96         *** the documentation for details.
97
98       That means you have to rebuild (part of) your Python installation to
99       supply this shared library.
100       The catch is that the Python distribution or the Python maintainers do
101       not provide any direct way to do this. The closest thing we can offer you
102       is the information in Python FAQ 3.30. On some operating systems you
103       don't really have to build a shared library, but then you will have to
104       convince the PostgreSQL build system of this. Consult the "Makefile" in
105       the "src/pl/plpython" directory for details.
106
107     * If you want to build Tcl or Tk components (clients and the PL/Tcl
108       language) you of course need a Tcl installation.
109
110     * To build the JDBC driver, you need Ant 1.5 or higher and a JDK. Ant is a
111       special tool for building Java-based packages. It can be downloaded from
112       the Ant web site.
113       If you have several Java compilers installed, it depends on the Ant
114       configuration which one gets used. Precompiled Ant distributions are
115       typically set up to read a file ".antrc" in the current user's home
116       directory for configuration. For example, to use a different JDK than the
117       default, this may work:
118
119         JAVA_HOME=/usr/local/sun-jdk1.3
120         JAVACMD=$JAVA_HOME/bin/java
121
122            Note: Do not try to build the driver by calling "ant" or even
123            "javac" directly. This will not work. Run "gmake" normally as
124            described below.
125
126     * To enable Native Language Support (NLS), that is, the ability to display
127       a program's messages in a language other than English, you need an
128       implementation of the Gettext API. Some operating systems have this
129       built-in (e.g., Linux, NetBSD, Solaris), for other systems you can
130       download an add-on package from here: http://www.postgresql.org/~petere/
131       gettext.html. If you are using the gettext implementation in the GNU C
132       library then you will additionally need the GNU Gettext package for some
133       utility programs. For any of the other implementations you will not need
134       it.
135
136     * Kerberos, OpenSSL, or PAM, if you want to support authentication using
137       these services.
138
139 If you are build from a CVS tree instead of using a released source package, or
140 if you want to do development, you also need the following packages:
141
142     * Flex and Bison are needed to build a CVS checkout or if you changed the
143       actual scanner and parser definition files. If you need them, be sure to
144       get Flex 2.5.4 or later and Bison 1.50 or later. Other yacc programs can
145       sometimes be used, but doing so requires extra effort and is not
146       recommended. Other lex programs will definitely not work.
147
148 If you need to get a GNU package, you can find it at your local GNU mirror site
149 (see http://www.gnu.org/order/ftp.html for a list) or at ftp://ftp.gnu.org/
150 gnu/.
151 Also check that you have sufficient disk space. You will need about 65 MB for
152 the source tree during compilation and about 15 MB for the installation
153 directory. An empty database cluster takes about 25 MB, databases take about
154 five times the amount of space that a flat text file with the same data would
155 take. If you are going to run the regression tests you will temporarily need up
156 to an extra 90 MB. Use the "df" command to check for disk space.
157
158 -------------------------------------------------------------------------------
159
160                              If You Are Upgrading
161
162 The internal data storage format changes with new releases of PostgreSQL.
163 Therefore, if you are upgrading an existing installation that does not have a
164 version number "7.3.x", you must back up and restore your data as shown here.
165 These instructions assume that your existing installation is under the "/usr/
166 local/pgsql" directory, and that the data area is in "/usr/local/pgsql/data".
167 Substitute your paths appropriately.
168
169    1. Make sure that your database is not updated during or after the backup.
170       This does not affect the integrity of the backup, but the changed data
171       would of course not be included. If necessary, edit the permissions in
172       the file "/usr/local/pgsql/data/pg_hba.conf" (or equivalent) to disallow
173       access from everyone except you.
174
175    2. To back up your database installation, type:
176
177         pg_dumpall > outputfile
178
179       If you need to preserve OIDs (such as when using them as foreign keys),
180       then use the "-o" option when running "pg_dumpall".
181       "pg_dumpall" does not save large objects. Check the Administrator's Guide
182       if you need to do this.
183       To make the backup, you can use the "pg_dumpall" command from the version
184       you are currently running. For best results, however, try to use the
185       "pg_dumpall" command from PostgreSQL 7.3, since this version contains
186       bug fixes and improvements over older versions. While this advice might
187       seem idiosyncratic since you haven't installed the new version yet, it is
188       advisable to follow it if you plan to install the new version in parallel
189       with the old version. In that case you can complete the installation
190       normally and transfer the data later. This will also decrease the
191       downtime.
192
193    3. If you are installing the new version at the same location as the old one
194       then shut down the old server, at the latest before you install the new
195       files:
196
197         kill -INT `cat /usr/local/pgsql/data/postmaster.pid`
198
199       Versions prior to 7.0 do not have this "postmaster.pid" file. If you are
200       using such a version you must find out the process id of the server
201       yourself, for example by typing "ps ax | grep postmaster", and supply it
202       to the "kill" command.
203       On systems that have PostgreSQL started at boot time, there is probably a
204       start-up file that will accomplish the same thing. For example, on a Red
205       Hat Linux system one might find that
206
207         /etc/rc.d/init.d/postgresql stop
208
209       works. Another possibility is "pg_ctl stop".
210
211    4. If you are installing in the same place as the old version then it is
212       also a good idea to move the old installation out of the way, in case you
213       have trouble and need to revert to it. Use a command like this:
214
215         mv /usr/local/pgsql /usr/local/pgsql.old
216
217 After you have installed PostgreSQL 7.3, create a new database directory and
218 start the new server. Remember that you must execute these commands while
219 logged in to the special database user account (which you already have if you
220 are upgrading).
221
222   /usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data
223   /usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data
224
225 Finally, restore your data with
226
227   /usr/local/pgsql/bin/psql -d template1 -f outputfile
228
229 using the *new* psql.
230 These topics are discussed at length in the Administrator's Guide, which you
231 are encouraged to read in any case.
232
233 -------------------------------------------------------------------------------
234
235                             Installation Procedure
236
237    1. Configuration
238       The first step of the installation procedure is to configure the source
239       tree for your system and choose the options you would like. This is done
240       by running the "configure" script. For a default installation simply
241       enter
242
243         ./configure
244
245       This script will run a number of tests to guess values for various system
246       dependent variables and detect some quirks of your operating system, and
247       finally will create several files in the build tree to record what it
248       found. (You can also run "configure" in a directory outside the source
249       tree if you want to keep the build directory separate.)
250       The default configuration will build the server and utilities, as well as
251       all client applications and interfaces that require only a C compiler.
252       All files will be installed under "/usr/local/pgsql" by default.
253       You can customize the build and installation process by supplying one or
254       more of the following command line options to "configure":
255
256         --prefix=PREFIX
257
258             Install all files under the directory "PREFIX" instead of "/usr/
259             local/pgsql". The actual files will be installed into various
260             subdirectories; no files will ever be installed directly into the
261             "PREFIX" directory.
262             If you have special needs, you can also customize the individual
263             subdirectories with the following options.
264
265         --exec-prefix=EXEC-PREFIX
266
267             You can install architecture-dependent files under a different
268             prefix, "EXEC-PREFIX", than what "PREFIX" was set to. This can be
269             useful to share architecture-independent files between hosts. If
270             you omit this, then "EXEC-PREFIX" is set equal to "PREFIX" and both
271             architecture-dependent and independent files will be installed
272             under the same tree, which is probably what you want.
273
274         --bindir=DIRECTORY
275
276             Specifies the directory for executable programs. The default is
277             "EXEC-PREFIX/bin", which normally means "/usr/local/pgsql/bin".
278
279         --datadir=DIRECTORY
280
281             Sets the directory for read-only data files used by the installed
282             programs. The default is "PREFIX/share". Note that this has nothing
283             to do with where your database files will be placed.
284
285         --sysconfdir=DIRECTORY
286
287             The directory for various configuration files, "PREFIX/etc" by
288             default.
289
290         --libdir=DIRECTORY
291
292             The location to install libraries and dynamically loadable modules.
293             The default is "EXEC-PREFIX/lib".
294
295         --includedir=DIRECTORY
296
297             The directory for installing C and C++ header files. The default is
298             "PREFIX/include".
299
300         --docdir=DIRECTORY
301
302             Documentation files, except "man" pages, will be installed into
303             this directory. The default is "PREFIX/doc".
304
305         --mandir=DIRECTORY
306
307             The man pages that come with PostgreSQL will be installed under
308             this directory, in their respective "manx" subdirectories. The
309             default is "PREFIX/man".
310            Note: Care has been taken to make it possible to install
311            PostgreSQL into shared installation locations (such as "/usr/
312            local/include") without interfering with the namespace of the
313            rest of the system. First, the string "/postgresql" is
314            automatically appended to datadir, sysconfdir, and docdir,
315            unless the fully expanded directory name already contains the
316            string "postgres" or "pgsql". For example, if you choose "/usr/
317            local" as prefix, the documentation will be installed in "/usr/
318            local/doc/postgresql", but if the prefix is "/opt/postgres",
319            then it will be in "/opt/postgres/doc". The public C header
320            files of the client interfaces are installed into includedir
321            and are namespace-clean. The internal header files and the
322            server header files are installed into private directories
323            under includedir. See the Programmer's Guide for information
324            about how to get at the header files for each interface.
325            Finally, a private subdirectory will also be created, if
326            appropriate, under libdir for dynamically loadable modules.
327
328         --with-includes=DIRECTORIES
329
330             "DIRECTORIES" is a colon-separated list of directories that will be
331             added to the list the compiler searches for header files. If you
332             have optional packages (such as GNU Readline) installed in a non-
333             standard location, you have to use this option and probably also
334             the corresponding "--with-libraries" option.
335             Example: --with-includes=/opt/gnu/include:/usr/sup/include.
336
337         --with-libraries=DIRECTORIES
338
339             "DIRECTORIES" is a colon-separated list of directories to search
340             for libraries. You will probably have to use this option (and the
341             corresponding "--with-includes" option) if you have packages
342             installed in non-standard locations.
343             Example: --with-libraries=/opt/gnu/lib:/usr/sup/lib.
344
345         --enable-recode
346
347             Enables single-byte character set recode support. See the
348             Administrator's Guide about this feature. Note that a more general
349             form of character set conversion is supported in the default
350             configuration; this feature is obsolete.
351
352         --enable-nls[=LANGUAGES]
353
354             Enables Native Language Support (NLS), that is, the ability to
355             display a program's messages in a language other than English.
356             "LANGUAGES" is a space separated list of codes of the languages
357             that you want supported, for example --enable-nls='de fr'. (The
358             intersection between your list and the set of actually provided
359             translations will be computed automatically.) If you do not specify
360             a list, then all available translations are installed.
361             To use this option, you will need an implementation of the gettext
362             API; see above.
363
364         --with-pgport=NUMBER
365
366             Set "NUMBER" as the default port number for server and clients. The
367             default is 5432. The port can always be changed later on, but if
368             you specify it here then both server and clients will have the same
369             default compiled in, which can be very convenient. Usually the only
370             good reason to select a non-default value is if you intend to run
371             multiple PostgreSQL servers on the same machine.
372
373         --with-perl
374
375             Build the PL/Perl server-side language.
376
377         --with-python
378
379             Build the Python interface module and the PL/Python server-side
380             language. You need to have root access to be able to install the
381             Python module at its default place ("/usr/lib/pythonx.y").
382
383         --with-tcl
384
385             Build components that require Tcl/Tk, which are libpgtcl, pgtclsh,
386             pgtksh, and PL/Tcl. But see below about "--without-tk".
387
388         --without-tk
389
390             If you specify "--with-tcl" and this option, then the program that
391             requires Tk (pgtksh) will be excluded.
392
393         --with-tclconfig=DIRECTORY, --with-tkconfig=DIRECTORY
394
395             Tcl/Tk installs the files "tclConfig.sh" and "tkConfig.sh", which
396             contain configuration information needed to build modules
397             interfacing to Tcl or Tk. These files are normally found
398             automatically at their well-known locations, but if you want to use
399             a different version of Tcl or Tk you can specify the directory in
400             which to find them.
401
402         --with-java
403
404             Build the JDBC driver and associated Java packages.
405
406         --with-krb4[=DIRECTORY], --with-krb5[=DIRECTORY]
407
408             Build with support for Kerberos authentication. You can use either
409             Kerberos version 4 or 5, but not both. The "DIRECTORY" argument
410             specifies the root directory of the Kerberos installation; "/usr/
411             athena" is assumed as default. If the relevant header files and
412             libraries are not under a common parent directory, then you must
413             use the "--with-includes" and "--with-libraries" options in
414             addition to this option. If, on the other hand, the required files
415             are in a location that is searched by default (e.g., "/usr/lib"),
416             then you can leave off the argument.
417             "configure" will check for the required header files and libraries
418             to make sure that your Kerberos installation is sufficient before
419             proceeding.
420
421         --with-krb-srvnam=NAME
422
423             The name of the Kerberos service principal. postgres is the
424             default. There's probably no reason to change this.
425
426         --with-openssl[=DIRECTORY]
427
428             Build with support for SSL (encrypted) connections. This requires
429             the OpenSSL package to be installed. The "DIRECTORY" argument
430             specifies the root directory of the OpenSSL installation; the
431             default is "/usr/local/ssl".
432             "configure" will check for the required header files and libraries
433             to make sure that your OpenSSL installation is sufficient before
434             proceeding.
435
436         --with-pam
437
438              Build with PAM (Pluggable Authentication Modules) support.
439
440         --without-readline
441
442             Prevents the use of the Readline library. This disables command-
443             line editing and history in psql, so it is not recommended.
444
445         --without-zlib
446
447             Prevents the use of the Zlib library. This disables compression
448             support in pg_dump. This option is only intended for those rare
449             systems where this library is not available.
450
451         --enable-debug
452
453             Compiles all programs and libraries with debugging symbols. This
454             means that you can run the programs through a debugger to analyze
455             problems. This enlarges the size of the installed executables
456             considerably, and on non-GCC compilers it usually also disables
457             compiler optimization, causing slowdowns. However, having the
458             symbols available is extremely helpful for dealing with any
459             problems that may arise. Currently, this option is recommended for
460             production installations only if you use GCC. But you should always
461             have it on if you are doing development work or running a beta
462             version.
463
464         --enable-cassert
465
466              Enables assertion checks in the server, which test for many "can't
467             happen" conditions. This is invaluable for code development
468             purposes, but the tests slow things down a little. Also, having the
469             tests turned on won't necessarily enhance the stability of your
470             server! The assertion checks are not categorized for severity, and
471             so what might be a relatively harmless bug will still lead to
472             server restarts if it triggers an assertion failure. Currently,
473             this option is not recommended for production use, but you should
474             have it on for development work or when running a beta version.
475
476         --enable-depend
477
478              Enables automatic dependency tracking. With this option, the
479             makefiles are set up so that all affected object files will be
480             rebuilt when any header file is changed. This is useful if you are
481             doing development work, but is just wasted overhead if you intend
482             only to compile once and install. At present, this option will work
483             only if you use GCC.
484
485       If you prefer a C compiler different from the one "configure" picks then
486       you can set the environment variable CC to the program of your choice. By
487       default, "configure" will pick "gcc" unless this is inappropriate for the
488       platform. Similarly, you can override the default compiler flags with the
489       CFLAGS variable.
490
491       You can specify environment variables on the "configure" command line,
492       for example:
493
494         ./configure CC=/opt/bin/gcc CFLAGS='-O2 -pipe'
495
496    2. Build
497       To start the build, type
498
499         gmake
500
501       (Remember to use GNU make.) The build may take anywhere from 5 minutes to
502       half an hour depending on your hardware. The last line displayed should
503       be
504
505         All of PostgreSQL is successfully made. Ready to install.
506
507    3. Regression Tests
508       If you want to test the newly built server before you install it, you can
509       run the regression tests at this point. The regression tests are a test
510       suite to verify that PostgreSQL runs on your machine in the way the
511       developers expected it to. Type
512
513         gmake check
514
515       (This won't work as root; do it as an unprivileged user.) It is possible
516       that some tests fail, due to differences in error message wording or
517       floating point results. The file "src/test/regress/README" and the
518       Administrator's Guide contain detailed information about interpreting the
519       test results. You can repeat this test at any later time by issuing the
520       same command.
521
522    4. Installing The Files
523            Note: If you are upgrading an existing system and are going to
524            install the new files over the old ones, then you should have
525            backed up your data and shut down the old server by now, as
526            explained in the Section called If You Are Upgrading above.
527       To install PostgreSQL enter
528
529         gmake install
530
531       This will install files into the directories that were specified in step
532       1. Make sure that you have appropriate permissions to write into that
533       area. Normally you need to do this step as root. Alternatively, you could
534       create the target directories in advance and arrange for appropriate
535       permissions to be granted.
536       You can use gmake install-strip instead of gmake install to strip the
537       executable files and libraries as they are installed. This will save some
538       space. If you built with debugging support, stripping will effectively
539       remove the debugging support, so it should only be done if debugging is
540       no longer needed. install-strip tries to do a reasonable job saving
541       space, but it does not have perfect knowledge of how to strip every
542       unneeded byte from an executable file, so if you want to save all the
543       disk space you possibly can, you will have to do manual work.
544       If you built the Python interfaces and you were not the root user when
545       you executed the above command then that part of the installation
546       probably failed. In that case you should become the root user and then do
547
548         gmake -C src/interfaces/python install
549
550       If you do not have superuser access you are on your own: you can still
551       take the required files and place them in other directories where Python
552       can find them, but how to do that is left as an exercise.
553       The standard installation provides only the header files needed for
554       client application development. If you plan to do any server-side program
555       development (such as custom functions or data types written in C), then
556       you may want to install the entire PostgreSQL include tree into your
557       target include directory. To do that, enter
558
559         gmake install-all-headers
560
561       This adds a megabyte or two to the installation footprint, and is only
562       useful if you don't plan to keep the whole source tree around for
563       reference. (If you do, you can just use the source's include directory
564       when building server-side software.)
565       Client-only installation: If you want to install only the client
566       applications and interface libraries, then you can use these commands:
567
568         gmake -C src/bin install
569         gmake -C src/include install
570         gmake -C src/interfaces install
571         gmake -C doc install
572
573 Uninstallation: To undo the installation use the command "gmake uninstall".
574 However, this will not remove any created directories.
575 Cleaning: After the installation you can make room by removing the built files
576 from the source tree with the command "gmake clean". This will preserve the
577 files made by the configure program, so that you can rebuild everything with
578 "gmake" later on. To reset the source tree to the state in which it was
579 distributed, use "gmake distclean". If you are going to build for several
580 platforms from the same source tree you must do this and re-configure for each
581 build.
582 If you perform a build and then discover that your configure options were
583 wrong, or if you change anything that configure investigates (for example,
584 software upgrades), then it's a good idea to do "gmake distclean" before
585 reconfiguring and rebuilding. Without this, your changes in configuration
586 choices may not propagate everywhere they need to.
587
588 -------------------------------------------------------------------------------
589
590                             Post-Installation Setup
591
592 Shared Libraries
593
594 On some systems that have shared libraries (which most systems do) you need to
595 tell your system how to find the newly installed shared libraries. The systems
596 on which this is *not* necessary include BSD/OS, FreeBSD, HP-UX, IRIX, Linux,
597 NetBSD, OpenBSD, Tru64 UNIX (formerly Digital UNIX), and Solaris.
598 The method to set the shared library search path varies between platforms, but
599 the most widely usable method is to set the environment variable
600 LD_LIBRARY_PATH like so: In Bourne shells ("sh", "ksh", "bash", "zsh")
601
602   LD_LIBRARY_PATH=/usr/local/pgsql/lib
603   export LD_LIBRARY_PATH
604
605 or in "csh" or "tcsh"
606
607   setenv LD_LIBRARY_PATH /usr/local/pgsql/lib
608
609 Replace /usr/local/pgsql/lib with whatever you set "--libdir" to in step 1. You
610 should put these commands into a shell start-up file such as "/etc/profile" or
611 "~/.bash_profile". Some good information about the caveats associated with this
612 method can be found at http://www.visi.com/~barr/ldpath.html.
613 On some systems it might be preferable to set the environment variable
614 LD_RUN_PATH *before* building.
615 On Cygwin, put the library directory in the PATH or move the ".dll" files into
616 the "bin/" directory.
617 If in doubt, refer to the manual pages of your system (perhaps "ld.so" or
618 "rld"). If you later on get a message like
619
620   psql: error in loading shared libraries
621   libpq.so.2.1: cannot open shared object file: No such file or directory
622
623 then this step was necessary. Simply take care of it then.
624 If you are on BSD/OS, Linux, or SunOS 4 and you have root access you can run
625
626   /sbin/ldconfig /usr/local/pgsql/lib
627
628 (or equivalent directory) after installation to enable the run-time linker to
629 find the shared libraries faster. Refer to the manual page of "ldconfig" for
630 more information. On FreeBSD, NetBSD, and OpenBSD the command is
631
632   /sbin/ldconfig -m /usr/local/pgsql/lib
633
634 instead. Other systems are not known to have an equivalent command.
635
636 -------------------------------------------------------------------------------
637
638 Environment Variables
639
640 If you installed into "/usr/local/pgsql" or some other location that is not
641 searched for programs by default, you should add "/usr/local/pgsql/bin" (or
642 whatever you set "--bindir" to in step 1) into your PATH. Strictly speaking,
643 this is not necessary, but it will make the use of PostgreSQL much more
644 convenient.
645 To do this, add the following to your shell start-up file, such as
646 "~/.bash_profile" (or "/etc/profile", if you want it to affect every user):
647
648   PATH=/usr/local/pgsql/bin:$PATH
649   export PATH
650
651 If you are using "csh" or "tcsh", then use this command:
652
653   set path = ( /usr/local/pgsql/bin $path )
654
655 To enable your system to find the man documentation, you need to add a line
656 like the following to a shell start-up file unless you installed into a
657 location that is searched by default.
658
659   MANPATH=/usr/local/pgsql/man:$MANPATH
660   export MANPATH
661
662 The environment variables PGHOST and PGPORT specify to client applications the
663 host and port of the database server, overriding the compiled-in defaults. If
664 you are going to run client applications remotely then it is convenient if
665 every user that plans to use the database sets PGHOST. This is not required,
666 however: the settings can be communicated via command line options to most
667 client programs.
668
669 -------------------------------------------------------------------------------
670
671                                 Getting Started
672
673 The following is a quick summary of how to get PostgreSQL up and running once
674 installed. The Administrator's Guide contains more information.
675
676    1. Create a user account for the PostgreSQL server. This is the user the
677       server will run as. For production use you should create a separate,
678       unprivileged account ("postgres" is commonly used). If you do not have
679       root access or just want to play around, your own user account is enough,
680       but running the server as root is a security risk and will not work.
681
682         adduser postgres
683
684    2. Create a database installation with the "initdb" command. To run "initdb"
685       you must be logged in to your PostgreSQL server account. It will not work
686       as root.
687
688         root# mkdir /usr/local/pgsql/data
689         root# chown postgres /usr/local/pgsql/data
690         root# su - postgres
691         postgres$ /usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data
692
693       The "-D" option specifies the location where the data will be stored. You
694       can use any path you want, it does not have to be under the installation
695       directory. Just make sure that the server account can write to the
696       directory (or create it, if it doesn't already exist) before starting
697       "initdb", as illustrated here.
698
699    3. The previous step should have told you how to start up the database
700       server. Do so now. The command should look something like
701
702         /usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data
703
704       This will start the server in the foreground. To put the server in the
705       background use something like
706
707         nohup /usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data \
708             </dev/null >>server.log 2>&1 </dev/null &
709
710       To stop a server running in the background you can type
711
712         kill `cat /usr/local/pgsql/data/postmaster.pid`
713
714       In order to allow TCP/IP connections (rather than only Unix domain socket
715       ones) you need to pass the "-i" option to "postmaster".
716
717    4. Create a database:
718
719         createdb testdb
720
721       Then enter
722
723         psql testdb
724
725       to connect to that database. At the prompt you can enter SQL commands and
726       start experimenting.
727
728 -------------------------------------------------------------------------------
729
730                                    What Now?
731
732     * The PostgreSQL distribution contains a comprehensive documentation set,
733       which you should read sometime. After installation, the documentation can
734       be accessed by pointing your browser to "/usr/local/pgsql/doc/html/
735       index.html", unless you changed the installation directories.
736       The Tutorial should be your first reading if you are completely new to
737       SQL databases. If you are familiar with database concepts then you want
738       to proceed with the Administrator's Guide, which contains information
739       about how to set up the database server, database users, and
740       authentication.
741
742     * Usually, you will want to modify your computer so that it will
743       automatically start the database server whenever it boots. Some
744       suggestions for this are in the Administrator's Guide.
745
746     * Run the regression tests against the installed server (using the
747       sequential test method). If you didn't run the tests before installation,
748       you should definitely do it now. This is also explained in the
749       Administrator's Guide.
750
751 -------------------------------------------------------------------------------
752
753                               Supported Platforms
754
755 PostgreSQL has been verified by the developer community to work on the
756 platforms listed below. A supported platform generally means that PostgreSQL
757 builds and installs according to these instructions and that the regression
758 tests pass.
759      Note: If you are having problems with the installation on a supported
760      platform, please write to <pgsql-bugs@postgresql.org> or <pgsql-
761      ports@postgresql.org>, not to the people listed here.
762  ________________________________________________________________________________
763 |OS______|Processor__|Version|Reported_________________________|Remarks__________|
764 |AIX     |RS6000     |7.3    |2002-11-12, Andreas Zeugswetter  |see also doc/    |
765 |________|___________|_______|(<ZeugswetterA@spardat.at>)______|FAQ_AIX__________|
766 |BSD/OS  |x86        |7.3    |2002-10-25, Bruce Momjian        |4.2              |
767 |________|___________|_______|(<pgman@candle.pha.pa.us>)_______|_________________|
768 |FreeBSD |Alpha      |7.3    |2002-11-13, Chris Kings-Lynne    |                 |
769 |________|___________|_______|(<chriskl@familyhealth.com.au>)__|_________________|
770 |FreeBSD |x86        |7.3    |2002-10-29, 3.3, Nigel J. Andrews|                 |
771 |        |           |       |(<nandrews@investsystems.co.uk>),|                 |
772 |        |           |       |4.7, Larry Rosenman              |                 |
773 |        |           |       |(<ler@lerctr.org>), 5.0, Sean    |                 |
774 |        |           |       |Chittenden                       |                 |
775 |________|___________|_______|(<sean@chittenden.org>)__________|_________________|
776 |HP-UX   |PA-RISC    |7.3    |2002-10-28, 10.20 Tom Lane       |gcc and cc; see  |
777 |        |           |       |(<tgl@sss.pgh.pa.us>), 11.00,    |also doc/FAQ_HPUX|
778 |        |           |       |11.11, 32 & 64 bit, Giles Lean   |                 |
779 |________|___________|_______|(<giles@nemeton.com.au>)_________|_________________|
780 |IRIX    |MIPS       |7.3    |2002-10-27, Ian Barwick          |Irix64 Komma 6.5 |
781 |________|___________|_______|(<barwick@gmx.net>)______________|_________________|
782 |Linux   |Alpha      |7.3    |2002-10-28, Magnus Naeslund      |2.4.19-pre6      |
783 |________|___________|_______|(<mag@fbab.net>)_________________|_________________|
784 |Linux   |armv4l     |7.2    |2001-12-10, Mark Knox            |2.2.x            |
785 |________|___________|_______|(<segfault@hardline.org>)________|_________________|
786 |Linux   |MIPS       |7.2    |2001-11-15, Hisao Shibuya        |2.0.x; Cobalt    |
787 |________|___________|_______|(<shibuya@alpha.or.jp>)__________|Qube2____________|
788 |Linux   |PlayStation|7.2    |2001-12-12, Permaine Cheung      |#undef           |
789 |        |2          |       |<pcheung@redhat.com>)            |HAS_TEST_AND_SET,|
790 |________|___________|_______|_________________________________|slock_t__________|
791 |Linux   |PPC74xx    |7.3    |2002-10-26, Tom Lane             |bye 2.2.18; Apple|
792 |________|___________|_______|(<tgl@sss.pgh.pa.us>)____________|G3_______________|
793 |Linux   |S/390      |7.2    |2001-12-12, Permaine Cheung      |                 |
794 |________|___________|_______|<pcheung@redhat.com>)____________|_________________|
795 |Linux   |Sparc      |7.3    |2002-10-26, Doug McNaught        |3.0              |
796 |________|___________|_______|(<doug@mcnaught.org>)____________|_________________|
797 |Linux   |x86        |7.3    |2002-10-26, Alvaro Herrera       |2.4              |
798 |________|___________|_______|(<alvherre@dcc.uchile.cl>)_______|_________________|
799 |MacOS X |PPC        |7.3    |2002-10-28, 10.1, Tom Lane       |                 |
800 |        |           |       |(<tgl@sss.pgh.pa.us>), 10.2.1,   |                 |
801 |        |           |       |Adam Witney                      |                 |
802 |________|___________|_______|(<awitney@sghms.ac.uk>)__________|_________________|
803 |NetBSD  |Alpha      |7.2    |2001-11-20, Thomas Thai          |1.5W             |
804 |________|___________|_______|(<tom@minnesota.com>)____________|_________________|
805 |NetBSD  |arm32      |7.3    |2002-11-19, Patrick Welche       |1.6              |
806 |________|___________|_______|(<prlw1@newn.cam.ac.uk>)_________|_________________|
807 |NetBSD  |m68k       |7.0    |2000-04-10, Henry B. Hotz        |Mac 8xx          |
808 |________|___________|_______|(<hotz@jpl.nasa.gov>)____________|_________________|
809 |NetBSD  |MIPS       |7.2.1  |2002-06-13, Warwick Hunter       |1.5.3            |
810 |________|___________|_______|(<whunter@agile.tv>)_____________|_________________|
811 |NetBSD  |PPC        |7.2    |2001-11-28, Bill Studenmund      |1.5              |
812 |________|___________|_______|(<wrstuden@netbsd.org>)__________|_________________|
813 |NetBSD  |Sparc      |7.2    |2001-12-03, Matthew Green        |32- and 64-bit   |
814 |________|___________|_______|(<mrg@eterna.com.au>)____________|builds___________|
815 |NetBSD  |VAX        |7.1    |2001-03-30, Tom I. Helbekkmo     |1.5              |
816 |________|___________|_______|(<tih@kpnQwest.no>)______________|_________________|
817 |NetBSD  |x86        |7.3    |2002-11-14, Patrick Welche       |1.6              |
818 |________|___________|_______|(<prlw1@newn.cam.ac.uk>)_________|_________________|
819 |OpenBSD |Sparc      |7.3    |2002-11-17, Christopher Kings-   |3.2              |
820 |        |           |       |Lynne                            |                 |
821 |________|___________|_______|(<chriskl@familyhealth.com.au>)__|_________________|
822 |OpenBSD |x86        |7.3    |2002-11-14, 3.1 Magnus Naeslund  |                 |
823 |        |           |       |(<mag@fbab.net>), 3.2 Christopher|                 |
824 |        |           |       |Kings-Lynne                      |                 |
825 |________|___________|_______|(<chriskl@familyhealth.com.au>)__|_________________|
826 |Solaris |Sparc      |7.3    |2002-10-28, Andrew Sullivan      |Solaris 7 & 8;   |
827 |        |           |       |(<andrew@libertyrms.info>)       |see also doc/    |
828 |________|___________|_______|_________________________________|FAQ_Solaris______|
829 |Solaris |x86        |7.2    |2001-11-28, Martin Renters       |2.8; see also    |
830 |________|___________|_______|(<martin@datafax.com>)___________|doc/FAQ_Solaris__|
831 |SunOS 4 |Sparc      |7.2    |2001-12-04, Tatsuo Ishii (<t-    |                 |
832 |________|___________|_______|ishii@sra.co.jp>)________________|_________________|
833 |Tru64   |Alpha      |7.3    |2002-11-05, Alessio Bragadini    |                 |
834 |UNIX____|___________|_______|(<alessio@albourne.com>)_________|_________________|
835 |UnixWare|x86        |7.3    |2002-11-01, 7.1.3 Larry Rosenman |see also doc/    |
836 |        |           |       |(<ler@lerctr.org>), 7.1.1 and    |FAQ_SCO          |
837 |        |           |       |7.1.2(8.0.0) Olivier Prenant     |                 |
838 |________|___________|_______|(<ohp@pyrenet.fr>)_______________|_________________|
839 |Windows |x86        |7.3    |2002-10-29, Dave Page            |with Cygwin; see |
840 |        |           |       |(<dpage@vale-housing.co.uk>),    |doc/FAQ_MSWIN    |
841 |        |           |       |Jason Tishler                    |                 |
842 |________|___________|_______|(<jason@tishler.net>)____________|_________________|
843 |Windows |x86        |7.3    |2002-11-05, Dave Page            |native is client-|
844 |        |           |       |(<dpage@vale-housing.co.uk>)     |side only; see   |
845 |        |           |       |                                 |Administrator's  |
846 |________|___________|_______|_________________________________|Guide____________|
847
848 Unsupported Platforms: The following platforms are either known not to work, or
849 they used to work in a previous release and we did not receive explicit
850 confirmation of a successful test with version 7.3 at the time this list was
851 compiled. We include these here to let you know that these platforms *could* be
852 supported if given some attention.
853  _____________________________________________________________________________
854 |OS__________|Processor|Version|Reported_______________________|Remarks_______|
855 |BeOS        |x86      |7.2    |2001-11-29, Cyril Velter       |needs updates |
856 |            |         |       |(<cyril.velter@libertysurf.fr>)|to semaphore  |
857 |____________|_________|_______|_______________________________|code__________|
858 |DG/UX       |m88k     |6.3    |1998-03-01, Brian E Gallew     |no recent     |
859 |5.4R4.11____|_________|_______|(<geek+@cmu.edu>)______________|reports_______|
860 |MkLinux DR1 |PPC750   |7.0    |2001-04-03, Tatsuo Ishii (<t-  |7.1 needs OS  |
861 |____________|_________|_______|ishii@sra.co.jp>)______________|update?_______|
862 |NeXTSTEP    |x86      |6.x    |1998-03-01, David Wetzel       |bit rot       |
863 |____________|_________|_______|(<dave@turbocat.de>)___________|suspected_____|
864 |QNX 4 RTOS  |x86      |7.2    |2001-12-10, Bernd Tegge        |needs updates |
865 |            |         |       |(<tegge@repas-aeg.de>)         |to semaphore  |
866 |            |         |       |                               |code; see also|
867 |____________|_________|_______|_______________________________|doc/FAQ_QNX4__|
868 |QNX RTOS v6 |x86      |7.2    |2001-11-20, Igor Kovalenko     |patches       |
869 |            |         |       |(<Igor.Kovalenko@motorola.com>)|available in  |
870 |            |         |       |                               |archives, but |
871 |            |         |       |                               |too late for  |
872 |____________|_________|_______|_______________________________|7.2___________|
873 |SCO         |x86      |6.5    |1999-05-25, Andrew Merrill     |7.2 should    |
874 |OpenServer 5|         |       |(<andrew@compclass.com>)       |work, but no  |
875 |            |         |       |                               |reports; see  |
876 |            |         |       |                               |also doc/     |
877 |____________|_________|_______|_______________________________|FAQ_SCO_______|
878 |System V R4 |m88k     |6.2.1  |1998-03-01, Doug Winterburn    |needs new TAS |
879 |____________|_________|_______|(<dlw@seavme.xroads.com>)______|spinlock_code_|
880 |System V R4 |MIPS     |6.4    |1998-10-28, Frank Ridderbusch  |no recent     |
881 |____________|_________|_______|(<ridderbusch.pad@sni.de>)_____|reports_______|
882 |Ultrix      |MIPS     |7.1    |2001-03-26                     |TAS spinlock  |
883 |            |         |       |                               |code not      |
884 |____________|_________|_______|_______________________________|detected______|
885 |Ultrix______|VAX______|6.x____|1998-03-01_____________________|______________|
886