installation.sgml 87.0 KB
Newer Older
1
<!-- $PostgreSQL: pgsql/doc/src/sgml/installation.sgml,v 1.299 2008/01/24 06:23:32 petere Exp $ -->
2 3 4 5 6 7 8 9 10 11 12 13 14

<chapter id="installation">
 <title><![%standalone-include[<productname>PostgreSQL</>]]>
  Installation Instructions</title>

 <indexterm zone="installation">
  <primary>installation</primary>
 </indexterm>

 <para>
  This <![%standalone-include;[document]]>
  <![%standalone-ignore;[chapter]]> describes the installation of
  <productname>PostgreSQL</productname> from the source code
15 16 17 18 19
  distribution.  (If you are installing a pre-packaged distribution,
  such as an RPM or Debian package, ignore this
  <![%standalone-include;[document]]>
  <![%standalone-ignore;[chapter]]>
  and read the packager's instructions instead.)
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
 </para>

 <sect1 id="install-short">
  <title>Short Version</title>

  <para>
<synopsis>
./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
36
/usr/local/pgsql/bin/postgres -D /usr/local/pgsql/data &gt;logfile 2&gt;&amp;1 &amp;
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
/usr/local/pgsql/bin/createdb test
/usr/local/pgsql/bin/psql test
</synopsis>
   The long version is the rest of this
   <![%standalone-include;[document.]]>
   <![%standalone-ignore;[chapter.]]>
  </para>
 </sect1>


 <sect1 id="install-requirements">
  <title>Requirements</title>

  <para>
   In general, a modern Unix-compatible platform should be able to run
   <productname>PostgreSQL</>.
53
   The platforms that had received specific testing at the
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
   time of release are listed in <xref linkend="supported-platforms">
   below. In the <filename>doc</> subdirectory of the distribution
   there are several platform-specific <acronym>FAQ</> documents you
   might wish to consult if you are having trouble.
  </para>

  <para>
   The following software packages are required for building
   <productname>PostgreSQL</>:

   <itemizedlist>
    <listitem>
     <para>
      <indexterm>
       <primary>make</primary>
      </indexterm>

      <acronym>GNU</> <application>make</> is required; other
      <application>make</> programs will <emphasis>not</> work.
      <acronym>GNU</> <application>make</> is often installed under
      the name <filename>gmake</filename>; this document will always
      refer to it by that name. (On some systems
      <acronym>GNU</acronym> <application>make</> is the default tool with the name
      <filename>make</>.) To test for <acronym>GNU</acronym>
      <application>make</application> enter
<screen>
<userinput>gmake --version</userinput>
</screen>
      It is recommended to use version 3.76.1 or later.
     </para>
    </listitem>

    <listitem>
     <para>
      You need an <acronym>ISO</>/<acronym>ANSI</> C compiler. Recent
      versions of <productname>GCC</> are recommendable, but
      <productname>PostgreSQL</> is known to build with a wide variety
      of compilers from different vendors.
     </para>
    </listitem>

    <listitem>
     <para>
97 98 99
      <application>tar</> is required to unpack the source
      distribution in the first place, in addition to either
      <application>gzip</> or <application>bzip2</>.
100 101 102 103 104 105 106 107
     </para>
    </listitem>

    <listitem>
     <para>
      <indexterm>
       <primary>readline</primary>
      </indexterm>
108 109 110
      <indexterm>
       <primary>libedit</primary>
      </indexterm>
111 112

      The <acronym>GNU</> <productname>Readline</> library (for
113 114 115 116 117 118 119 120 121 122 123 124 125 126
      simple line editing and command history retrieval) is
      used by default. If you don't want to use it then you must specify
      the <option>--without-readline</option> option for
      <filename>configure</>. As an alternative, you can often use the
      BSD-licensed <filename>libedit</filename> library, originally
      developed on <productname>NetBSD</productname>. The
      <filename>libedit</filename> library is
      GNU <productname>Readline</productname>-compatible and is used if
      <filename>libreadline</filename> is not found, or if
      <option>--with-libedit-preferred</option> is used as an 
      option to <filename>configure</>. If you are using a package-based
      Linux distribution, be aware that you need both the 
      <literal>readline</> and <literal>readline-devel</> packages, if 
      those are separate in your distribution.
127 128 129
     </para>
    </listitem>

130 131 132 133 134 135 136 137 138 139 140 141 142 143
    <listitem>
     <para>
      <indexterm>
       <primary>zlib</primary>
      </indexterm>

      The <productname>zlib</productname> compression library will be
      used by default. If you don't want to use it then you must
      specify the <option>--without-zlib</option> option for
      <filename>configure</filename>. Using this option disables
      support for compressed archives in <application>pg_dump</> and
      <application>pg_restore</>.
     </para>
    </listitem>
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
   </itemizedlist>
  </para>

  <para>
   The following packages are optional.  They are not required in the
   default configuration, but they are needed when certain build
   options are enabled, as explained below.

   <itemizedlist>
    <listitem>
     <para>
      To build the server programming language
      <application>PL/Perl</application> you need a full
      <productname>Perl</productname> installation, including the
      <filename>libperl</filename> library and the header files.
      Since <application>PL/Perl</application> will be a shared
      library, the <indexterm><primary>libperl</primary></indexterm>
      <filename>libperl</filename> library must be a shared library
      also on most platforms.  This appears to be the default in
      recent <productname>Perl</productname> versions, but it was not
T
Tom Lane 已提交
164
      in earlier versions, and in any case it is the choice of whomever
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
      installed Perl at your site.
     </para>

     <para>
      If you don't have the shared library but you need one, a message
      like this will appear during the build to point out this fact:
<screen>
*** Cannot build PL/Perl because libperl is not a shared library.
*** You might have to rebuild your Perl installation.  Refer to
*** the documentation for details.
</screen>
      (If you don't follow the on-screen output you will merely notice
      that the <application>PL/Perl</application> library object,
      <filename>plperl.so</filename> or similar, will not be
      installed.)  If you see this, you will have to rebuild and
      install <productname>Perl</productname> manually to be able to
      build <application>PL/Perl</application>.  During the
      configuration process for <productname>Perl</productname>,
      request a shared library.
     </para>
    </listitem>

    <listitem>
     <para>
      To build the <application>PL/Python</> server programming
      language, you need a <productname>Python</productname>
      installation with the header files and the <application>distutils</application> module.
      The <application>distutils</application> module is included by default with
      <productname>Python</productname> 1.6 and later; users of
      earlier versions of <productname>Python</productname> will need
      to install it.
     </para>

     <para>
      Since <application>PL/Python</application> will be a shared
      library, the <indexterm><primary>libpython</primary></indexterm>
      <filename>libpython</filename> library must be a shared library
      also on most platforms.  This is not the case in a default
      <productname>Python</productname> installation.  If after
      building and installing you have a file called
      <filename>plpython.so</filename> (possibly a different
      extension), then everything went well.  Otherwise you should
      have seen a notice like this flying by:
<screen>
*** Cannot build PL/Python because libpython is not a shared library.
*** You might have to rebuild your Python installation.  Refer to
*** the documentation for details.
</screen>
      That means you have to rebuild (part of) your
      <productname>Python</productname> installation to supply this
      shared library.
     </para>

     <para>
      If you have problems, run <productname>Python</> 2.3 or later's
      configure using the <literal>--enable-shared</> flag.  On some
      operating systems you don't have to build a shared library, but
      you will have to convince the <productname>PostgreSQL</> build
      system of this.  Consult the <filename>Makefile</filename> in
      the <filename>src/pl/plpython</filename> directory for details.
     </para>
    </listitem>

    <listitem>
     <para>
      If you want to build the <application>PL/Tcl</application>
231 232 233 234
      procedural language, you of course need a <productname>Tcl</>
      installation.  If you are using a pre-8.4 release of
      <productname>Tcl</>, ensure that it was built without multithreading
      support.
235 236 237 238 239 240 241 242 243 244 245 246
     </para>
    </listitem>

    <listitem>
     <para>
      To enable Native Language Support (<acronym>NLS</acronym>), that
      is, the ability to display a program's messages in a language
      other than English, you need an implementation of the
      <application>Gettext</> <acronym>API</acronym>.  Some operating
      systems have this built-in (e.g., <systemitem
      class="osname">Linux</>, <systemitem class="osname">NetBSD</>,
      <systemitem class="osname">Solaris</>), for other systems you
247
      can download an add-on package from <ulink
248
      url="http://developer.postgresql.org/~petere/bsd-gettext/"></ulink>.
249 250 251 252 253 254 255 256 257 258
      If you are using the <application>Gettext</> implementation in
      the <acronym>GNU</acronym> C library then you will additionally
      need the <productname>GNU Gettext</productname> package for some
      utility programs.  For any of the other implementations you will
      not need it.
     </para>
    </listitem>

    <listitem>
     <para>
259 260
      <application>Kerberos</>, <productname>OpenSSL</>, 
      <productname>OpenLDAP</>, and/or
T
Tom Lane 已提交
261 262
      <application>PAM</>, if you want to support authentication or
      encryption using these services.
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
     </para>
    </listitem>
   </itemizedlist>
  </para>

  <para>
   If you are building from a <acronym>CVS</acronym> tree instead of
   using a released source package, or if you want to do development,
   you also need the following packages:

   <itemizedlist>
    <listitem>
     <para>
      <indexterm>
       <primary>flex</primary>
      </indexterm>
      <indexterm>
       <primary>bison</primary>
      </indexterm>
      <indexterm>
       <primary>yacc</primary>
      </indexterm>

T
Tom Lane 已提交
286
      GNU <application>Flex</> and <application>Bison</>
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
      are needed to build a CVS checkout or if you changed the actual
      scanner and parser definition files. If you need them, be sure
      to get <application>Flex</> 2.5.4 or later and
      <application>Bison</> 1.875 or later. Other <application>yacc</>
      programs can sometimes be used, but doing so requires extra
      effort and is not recommended. Other <application>lex</>
      programs will definitely not work.
     </para>
    </listitem>
   </itemizedlist>
  </para>

  <para>
   If you need to get a <acronym>GNU</acronym> package, you can find
   it at your local <acronym>GNU</acronym> mirror site (see <ulink
   url="http://www.gnu.org/order/ftp.html"></>
   for a list) or at <ulink
   url="ftp://ftp.gnu.org/gnu/"></ulink>.
  </para>

  <para>
   Also check that you have sufficient disk space. You will need about
   65 MB for the source tree during compilation and about 15 MB for
   the installation directory. An empty database cluster takes about
   25 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 up to an extra
T
Tom Lane 已提交
314
   90 MB. Use the <command>df</command> command to check free disk
315 316 317 318 319 320 321 322 323 324 325 326
   space.
  </para>
 </sect1>

<![%standalone-ignore;[
 <sect1 id="install-getsource">
  <title>Getting The Source</title>

  <para>
   The <productname>PostgreSQL</> &version; sources can be obtained by
   anonymous FTP from <ulink
   url="ftp://ftp.postgresql.org/pub/source/v&version;/postgresql-&version;.tar.gz"></ulink>.
327 328 329
   Other download options can be found on our website:
   <ulink url="http://www.postgresql.org/download/"></ulink>. After you
   have obtained the file, unpack it:
330 331 332 333 334 335 336 337 338 339 340 341 342 343
<screen>
<userinput>gunzip postgresql-&version;.tar.gz</userinput>
<userinput>tar xf postgresql-&version;.tar</userinput>
</screen>
   This will create a directory
   <filename>postgresql-&version;</filename> under the current directory
   with the <productname>PostgreSQL</> sources.
   Change into that directory for the rest
   of the installation procedure.
  </para>
 </sect1>
]]>

 <sect1 id="install-upgrading">
344
  <title>Upgrading</title>
345 346 347 348 349 350

  <indexterm zone="install-upgrading">
   <primary>upgrading</primary>
  </indexterm>

  <para>
351 352 353 354 355 356 357 358 359 360
   These instructions assume that your existing installation is under the
   <filename>/usr/local/pgsql</> directory, and that the data area is in
   <filename>/usr/local/pgsql/data</>.  Substitute your paths
   appropriately.
  </para>

  <para>
   The internal data storage format typically changes in every major
   release of <productname>PostgreSQL</>. Therefore, if you are upgrading
   an existing installation that does not have a version number of
361
   <quote>&majorversion;.x</quote>, you must back up and restore your
362 363 364 365
   data.  If you are upgrading from <productname>PostgreSQL</>
   <quote>&majorversion;.x</quote>, the new version can use your current
   data files so you should skip the backup and restore steps below because
   they are unnecessary.
366 367 368 369 370
  </para>

  <procedure>
   <step>
    <para>
371 372 373 374 375
     If making a backup, make sure that your database is being updated.
     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 <filename>/usr/local/pgsql/data/pg_hba.conf</>
     (or equivalent) to disallow access from everyone except you.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
    </para>

    <para>
     <indexterm>
      <primary>pg_dumpall</primary>
      <secondary>use during upgrade</secondary>
     </indexterm>

     To back up your database installation, type:
<screen>
<userinput>pg_dumpall &gt; <replaceable>outputfile</></userinput>
</screen>
     If you need to preserve OIDs (such as when using them as
     foreign keys), then use the <option>-o</option> option when running
     <application>pg_dumpall</>.
    </para>

    <para>
     To make the backup, you can use the <application>pg_dumpall</application>
     command from the version you are currently running.  For best
     results, however, try to use the <application>pg_dumpall</application>
     command from <productname>PostgreSQL</productname> &version;,
     since this version contains bug fixes and improvements over older
     versions.  While this advice might seem idiosyncratic since you
     haven't installed the new version yet, it is advisable to follow
     it if you plan to install the new version in parallel with the
     old version.  In that case you can complete the installation
     normally and transfer the data later.  This will also decrease
     the downtime.
    </para>
   </step>

   <step>
    <para>
410
     Shut down the old server:
411
<screen>
T
Tom Lane 已提交
412
<userinput>pg_ctl stop</>
413
</screen>
T
Tom Lane 已提交
414 415 416 417 418 419 420 421
     On systems that have <productname>PostgreSQL</> started at boot time,
     there is probably a start-up file that will accomplish the same thing. For
     example, on a <systemitem class="osname">Red Hat Linux</> system one
     might find that
<screen>
<userinput>/etc/rc.d/init.d/postgresql stop</userinput>
</screen>
     works.
422 423 424 425 426
    </para>
   </step>

   <step>
    <para>
427 428 429 430 431 432
     If restoring from backup, rename or delete the old installation
     directory.  It is a good idea to rename the directory, rather than
     delete it, in case you have trouble and need to revert to it.  Keep
     in mind the directory might consume significant disk space.  To rename
     the directory, use a command like this:
<screen> 
433 434 435 436 437
<userinput>mv /usr/local/pgsql /usr/local/pgsql.old</>
</screen>
    </para>
   </step>

438 439 440 441 442 443 444 445 446 447 448 449 450
   <step>
    <para>
     Install the new version of <productname>PostgreSQL</productname> as
     outlined in <![%standalone-include[the next section.]]>
     <![%standalone-ignore[<xref linkend="install-procedure">.]]>
    </para>
   </step>

   <step>
    <para>
     Create a new database cluster if needed.  Remember that you must
     execute these commands while logged in to the special database user
     account (which you already have if you are upgrading).
451 452
<programlisting>
<userinput>/usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data</>
453 454 455 456
</programlisting>
    </para>
   </step>

457 458 459 460 461 462 463
   <step>
    <para>
     Restore your previous <filename>pg_hba.conf</> and any
     <filename>postgresql.conf</> modifications.
    </para>
   </step>

464 465 466 467 468
   <step>
    <para>
     Start the database server, again from the special database user
     account:
<programlisting>
469
<userinput>/usr/local/pgsql/bin/postgres -D /usr/local/pgsql/data</>
470
</programlisting>
471 472 473 474 475 476
    </para>
   </step>

   <step>
    <para>
     Finally, restore your data from backup with
477
<screen>
478
<userinput>/usr/local/pgsql/bin/psql -d postgres -f <replaceable>outputfile</></userinput>
479
</screen>
480 481 482 483
     using the <emphasis>new</> <application>psql</>.
    </para>
   </step>
  </procedure>
484 485

  <para>
T
Tom Lane 已提交
486 487 488
   Further discussion appears in
   <![%standalone-include[the documentation,]]>
   <![%standalone-ignore[<xref linkend="migration">,]]>
489 490
   including instructions on how the previous installation can continue
   running while the new installation is installed.
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
  </para>
 </sect1>


 <sect1 id="install-procedure">
  <title>Installation Procedure</title>

  <procedure>

  <step id="configure">
   <title>Configuration</>

   <indexterm zone="configure">
    <primary>configure</primary>
   </indexterm>

   <para>
    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 <filename>configure</> script. For a
    default installation simply enter
<screen>
<userinput>./configure</userinput>
</screen>
    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.  (You can also run
    <filename>configure</filename> in a directory outside the source
    tree if you want to keep the build directory separate.)
   </para>

   <para>
    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
    <filename>/usr/local/pgsql</> by default.
   </para>

   <para>
    You can customize the build and installation process by supplying one
    or more of the following command line options to
    <filename>configure</filename>:

     <variablelist>
      <varlistentry>
       <term><option>--prefix=<replaceable>PREFIX</></option></term>
       <listitem>
        <para>
         Install all files under the directory <replaceable>PREFIX</>
         instead of <filename>/usr/local/pgsql</filename>. The actual
         files will be installed into various subdirectories; no files
         will ever be installed directly into the
         <replaceable>PREFIX</> directory.
        </para>

        <para>
         If you have special needs, you can also customize the
         individual subdirectories with the following options. However,
         if you leave these with their defaults, the installation will be
         relocatable, meaning you can move the directory after
         installation. (The <literal>man</> and <literal>doc</>
         locations are not affected by this.)
        </para>

        <para>
         For relocatable installs, you might want to use 
         <filename>configure</filename>'s <literal>--disable-rpath</>
         option.  Also, you will need to tell the operating system how
         to find the shared libraries.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--exec-prefix=<replaceable>EXEC-PREFIX</></option></term>
       <listitem>
        <para>
         You can install architecture-dependent files under a
         different prefix, <replaceable>EXEC-PREFIX</>, than what
         <replaceable>PREFIX</> was set to. This can be useful to
         share architecture-independent files between hosts. If you
         omit this, then <replaceable>EXEC-PREFIX</> is set equal to
         <replaceable>PREFIX</> and both architecture-dependent and
         independent files will be installed under the same tree,
         which is probably what you want.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--bindir=<replaceable>DIRECTORY</></option></term>
       <listitem>
        <para>
         Specifies the directory for executable programs. The default
         is <filename><replaceable>EXEC-PREFIX</>/bin</>, which
         normally means <filename>/usr/local/pgsql/bin</>.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--datadir=<replaceable>DIRECTORY</></option></term>
       <listitem>
        <para>
         Sets the directory for read-only data files used by the
         installed programs. The default is
         <filename><replaceable>PREFIX</>/share</>. Note that this has
         nothing to do with where your database files will be placed.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--sysconfdir=<replaceable>DIRECTORY</></option></term>
       <listitem>
        <para>
         The directory for various configuration files,
         <filename><replaceable>PREFIX</>/etc</> by default.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--libdir=<replaceable>DIRECTORY</></option></term>
       <listitem>
        <para>
         The location to install libraries and dynamically loadable
         modules. The default is
         <filename><replaceable>EXEC-PREFIX</>/lib</>.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--includedir=<replaceable>DIRECTORY</></option></term>
       <listitem>
        <para>
         The directory for installing C and C++ header files. The
         default is <filename><replaceable>PREFIX</>/include</>.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--mandir=<replaceable>DIRECTORY</></option></term>
       <listitem>
        <para>
         The man pages that come with <productname>PostgreSQL</> will be installed under
         this directory, in their respective
         <filename>man<replaceable>x</></> subdirectories.
         The default is <filename><replaceable>PREFIX</>/man</>.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-docdir=<replaceable>DIRECTORY</></option></term>
       <term><option>--without-docdir</option></term>
       <listitem>
        <para>
         Documentation files, except <quote>man</> pages, will be
         installed into this directory. The default is
         <filename><replaceable>PREFIX</>/doc</>.  If the option
         <option>--without-docdir</option> is specified, the
         documentation will not be installed by <command>make
         install</command>.  This is intended for packaging scripts
         that have special methods for installing documentation.
        </para>
       </listitem>
      </varlistentry>
     </variablelist>

     <note>
      <para>
       Care has been taken to make it possible to install
       <productname>PostgreSQL</> into shared installation locations
       (such as <filename>/usr/local/include</filename>) without
       interfering with the namespace of the rest of the system. First,
       the string <quote><literal>/postgresql</literal></quote> is
       automatically appended to <varname>datadir</varname>,
       <varname>sysconfdir</varname>, and <varname>docdir</varname>,
       unless the fully expanded directory name already contains the
       string <quote><literal>postgres</></quote> or
       <quote><literal>pgsql</></quote>. For example, if you choose
       <filename>/usr/local</filename> as prefix, the documentation will
       be installed in <filename>/usr/local/doc/postgresql</filename>,
       but if the prefix is <filename>/opt/postgres</filename>, then it
       will be in <filename>/opt/postgres/doc</filename>. The public C
       header files of the client interfaces are installed into
       <varname>includedir</varname> and are namespace-clean. The
       internal header files and the server header files are installed
       into private directories under <varname>includedir</varname>. See
       the documentation of each interface for information about how to
       get at the its header files. Finally, a private subdirectory will
       also be created, if appropriate, under <varname>libdir</varname>
       for dynamically loadable modules.
      </para>
     </note>
    </para>

    <para>
     <variablelist>
      <varlistentry>
       <term><option>--with-includes=<replaceable>DIRECTORIES</></option></term>
       <listitem>
        <para>
         <replaceable>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 <application>Readline</>) installed in a non-standard
         location,
         you have to use this option and probably also the corresponding
         <option>--with-libraries</> option.
        </para>
        <para>
         Example: <literal>--with-includes=/opt/gnu/include:/usr/sup/include</>.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-libraries=<replaceable>DIRECTORIES</></option></term>
       <listitem>
        <para>
         <replaceable>DIRECTORIES</> is a colon-separated list of
         directories to search for libraries. You will probably have
         to use this option (and the corresponding
         <option>--with-includes</> option) if you have packages
         installed in non-standard locations.
        </para>
        <para>
         Example: <literal>--with-libraries=/opt/gnu/lib:/usr/sup/lib</>.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--enable-nls<optional>=<replaceable>LANGUAGES</replaceable></optional></option></term>
       <listitem>
        <para>
         Enables Native Language Support (<acronym>NLS</acronym>),
         that is, the ability to display a program's messages in a
         language other than English.
T
Tom Lane 已提交
735
         <replaceable>LANGUAGES</replaceable> is a space-separated
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
         list of codes of the languages that you want supported, for
         example <literal>--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.
        </para>

        <para>
         To use this option, you will need an implementation of the
         <application>Gettext</> API; see above.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-pgport=<replaceable>NUMBER</></option></term>
       <listitem>
        <para>
         Set <replaceable>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
         <productname>PostgreSQL</> servers on the same machine.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-perl</option></term>
       <listitem>
        <para>
         Build the <application>PL/Perl</> server-side language.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-python</option></term>
       <listitem>
        <para>
         Build the <application>PL/Python</> server-side language.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-tcl</option></term>
       <listitem>
        <para>
         Build the <application>PL/Tcl</> server-side language.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-tclconfig=<replaceable>DIRECTORY</replaceable></option></term>
       <listitem>
        <para>
         Tcl installs the file <filename>tclConfig.sh</filename>, which
         contains configuration information needed to build modules
         interfacing to Tcl. This file is normally found automatically
         at a well-known location, but if you want to use a different
         version of Tcl you can specify the directory in which to look
         for it.
        </para>
       </listitem>
      </varlistentry>

M
Magnus Hagander 已提交
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
      <varlistentry>
       <term><option>--with-gssapi</option></term>
       <listitem>
        <para>
         Build with support for GSSAPI authentication. On many
         systems, the GSSAPI (usually a part of the Kerberos installation)
         system is not installed in a location
         that is searched by default (e.g., <filename>/usr/include</>,
         <filename>/usr/lib</>), so you must use the options
         <option>--with-includes</> and <option>--with-libraries</> in
         addition to this option.  <filename>configure</> will check
         for the required header files and libraries to make sure that
         your GSSAPI installation is sufficient before proceeding.
        </para>
       </listitem>
      </varlistentry>

824 825 826 827
      <varlistentry>
       <term><option>--with-krb5</option></term>
       <listitem>
        <para>
828
         Build with support for Kerberos 5 authentication. On many
829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
         systems, the Kerberos system is not installed in a location
         that is searched by default (e.g., <filename>/usr/include</>,
         <filename>/usr/lib</>), so you must use the options
         <option>--with-includes</> and <option>--with-libraries</> in
         addition to this option.  <filename>configure</> will check
         for the required header files and libraries to make sure that
         your Kerberos installation is sufficient before proceeding.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-krb-srvnam=<replaceable>NAME</></option></term>
       <listitem>
        <para>
M
Magnus Hagander 已提交
844 845
         The default name of the Kerberos service principal (also used
         by GSSAPI).
B
 
Bruce Momjian 已提交
846
         <literal>postgres</literal> is the default. There's usually no
M
Magnus Hagander 已提交
847 848 849
         reason to change this unless you have a Windows environment,
         in which case it must be set to uppercase
         <literal>POSTGRES</literal>.
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <indexterm>
        <primary>OpenSSL</primary>
        <seealso>SSL</seealso>
       </indexterm>

       <term><option>--with-openssl</option></term>
       <listitem>
        <para>
         Build with support for <acronym>SSL</> (encrypted)
         connections. This requires the <productname>OpenSSL</>
         package to be installed.  <filename>configure</> will check
         for the required header files and libraries to make sure that
         your <productname>OpenSSL</> installation is sufficient
         before proceeding.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-pam</option></term>
       <listitem>
        <para>
         Build with <acronym>PAM</><indexterm><primary>PAM</></>
         (Pluggable Authentication Modules) support.
        </para>
       </listitem>
      </varlistentry>

883 884 885 886
      <varlistentry>
       <term><option>--with-ldap</option></term>
       <listitem>
        <para>
887 888 889 890 891 892 893 894 895 896 897
         Build with <acronym>LDAP</><indexterm><primary>LDAP</></>
         support for authentication and connection parameter lookup (see 
         <![%standalone-include[the documentation about client authentication
         and libpq]]><![%standalone-ignore[<xref linkend="libpq-ldap"> and
         <xref linkend="auth-ldap">]]> for more information). On Unix,
         this requires the <productname>OpenLDAP</> package to be
         installed. <filename>configure</> will check for the required
         header files and libraries to make sure that your
         <productname>OpenLDAP</> installation is sufficient before
         proceeding. On Windows, the default <productname>WinLDAP</>
         library is used.
898 899 900 901
        </para>
       </listitem>
      </varlistentry>

902
      <varlistentry>
903
       <term><option>--without-readline</option></term>
904 905
       <listitem>
        <para>
906 907 908 909
         Prevents use of the <application>Readline</> library
         (and <application>libedit</> as well).  This option disables
         command-line editing and history in
         <application>psql</application>, so it is not recommended.
910 911 912 913
        </para>
       </listitem>
      </varlistentry>

914
      <varlistentry>
915
       <term><option>--with-libedit-preferred</option></term>
916 917
       <listitem>
        <para>
918 919 920 921
         Favors the use of the BSD-licensed <application>libedit</> library
         rather than GPL-licensed <application>Readline</>.  This option
         is significant only if you have both libraries installed; the
         default in that case is to use <application>Readline</>.
922 923 924 925 926
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
927
       <term><option>--with-bonjour</option></term>
928 929
       <listitem>
        <para>
930
         Build with Bonjour support.  This requires Bonjour support
T
Tom Lane 已提交
931
         in your operating system.  Recommended on Mac OS X.
932 933 934 935
        </para>
       </listitem>
      </varlistentry>

936 937 938 939
      <varlistentry>
       <term><option>--with-ossp-uuid</option></term>
       <listitem>
        <para>
940
         Use the <ulink url="http://www.ossp.org/pkg/lib/uuid/">OSSP UUID
941
         library</ulink> when building <filename>contrib/uuid-ossp</>.
942 943
         The library provides functions to generate
         UUIDs.<indexterm><primary>UUID</primary></indexterm>
944 945 946 947
        </para>
       </listitem>
      </varlistentry>

948 949 950 951
      <varlistentry>
       <term><option>--with-libxml</option></term>
       <listitem>
        <para>
952 953
         Build with libxml (enables SQL/XML support).  Libxml version 2.6.23 or
         later is required for this feature.
954
        </para>
955 956 957 958 959 960 961 962 963 964 965 966

        <para>
         Libxml installs a program <command>xml2-config</command> that
         can be used to detect the required compiler and linker
         options.  PostgreSQL will use it automatically if found.  To
         specify a libxml installation at an unusual location, you can
         either set the environment variable
         <envar>XML2_CONFIG</envar> to point to the
         <command>xml2-config</command> program belonging to the
         installation, or use the options
         <option>--with-includes</option> and
         <option>--with-libraries</option>.
T
Tom Lane 已提交
967
        </para>
968 969 970
       </listitem>
      </varlistentry>

971 972 973 974
      <varlistentry>
       <term><option>--with-libxslt</option></term>
       <listitem>
        <para>
975 976 977
         Use libxslt when building <filename>contrib/xml2</>.
         <filename>contrib/xml2</> relies on this library to perform
         XSL transformations of XML.
978 979 980 981
        </para>
       </listitem>
      </varlistentry>

982 983 984 985 986 987 988
      <varlistentry>
       <term><option>--enable-integer-datetimes</option></term>
       <listitem>
        <para>
         Use 64-bit integer storage for datetimes and intervals, rather
         than the default floating-point storage.  This reduces the range
         of representable values but guarantees microsecond precision across
989 990 991
         the full range (see
         <![%standalone-include[the documentation about datetime datatypes]]>
         <![%standalone-ignore[<xref linkend="datatype-datetime">]]>
992
         for more information).
993 994 995 996
        </para>
       </listitem>
      </varlistentry>

997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
      <varlistentry>
       <term><option>--disable-spinlocks</option></term>
       <listitem>
        <para>
         Allow the build to succeed even if <productname>PostgreSQL</>
         has no CPU spinlock support for the platform.  The lack of
         spinlock support will result in poor performance; therefore,
         this option should only be used if the build aborts and
         informs you that the platform lacks spinlock support. If this
         option is required to build <productname>PostgreSQL</> on
         your platform, please report the problem to the
         <productname>PostgreSQL</> developers.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--enable-thread-safety</option></term>
       <listitem>
        <para>
         Make the client libraries thread-safe.  This allows
         concurrent threads in <application>libpq</application> and
         <application>ECPG</application> programs to safely control
T
Tom Lane 已提交
1020 1021
         their private connection handles.  This option requires adequate
         threading support in your operating system.
1022 1023 1024 1025 1026
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
1027 1028 1029 1030 1031 1032
       <term><option>--with-system-tzdata=<replaceable>DIRECTORY</replaceable></option></term>
       <indexterm>
        <primary>time zone data</primary>
       </indexterm>
       <listitem>
        <para>
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
         <productname>PostgreSQL</> includes its own time zone database,
         which it requires for date and time operations.  This time zone
         database is in fact compatible with the <quote>zic</> time zone
         database provided by many operating systems such as FreeBSD,
         Linux, and Solaris, so it would be redundant to install it again.
         When this option is used, the system-supplied time zone database
         in <replaceable>DIRECTORY</replaceable> is used instead of the one
         included in the PostgreSQL source distribution.
         <replaceable>DIRECTORY</replaceable> must be specified as an
         absolute path.  <filename>/usr/share/zoneinfo</filename> is a
1043
         likely directory on some operating systems.  Note that the
1044 1045 1046 1047
         installation routine will not detect mismatching or erroneous time
         zone data.  If you use this option, you are advised to run the
         regression tests to verify that the time zone data you have
         pointed to works correctly with <productname>PostgreSQL</>.
1048 1049 1050 1051 1052 1053 1054
        </para>

        <para>
         This option is mainly aimed at binary package distributors
         who know their target operating system well.  The main
         advantage of using this option is that the PostgreSQL package
         won't need to be upgraded whenever any of the many local
1055 1056 1057 1058
         daylight-saving time rules change.  Another advantage is that
         PostgreSQL can be cross-compiled<indexterm><primary>cross
         compilation</primary></indexterm> more straightforwardly if the
         time zone database files do not need to be built during the
1059 1060 1061 1062 1063 1064
         installation.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
1065 1066 1067
       <term><option>--without-zlib</option></term>
       <listitem>
        <para>
T
Tom Lane 已提交
1068 1069 1070 1071 1072 1073
         <indexterm>
          <primary>zlib</primary>
         </indexterm>
         Prevents use of the <application>Zlib</> library.  This disables
         support for compressed archives in <application>pg_dump</application>
         and <application>pg_restore</application>.
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
         This option is only intended for those rare systems where this
         library is not available.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--enable-debug</option></term>
       <listitem>
        <para>
         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
1090
         with any problems that might arise.  Currently, this option is
1091 1092 1093 1094 1095 1096 1097
         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.
        </para>
       </listitem>
      </varlistentry>

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
      <varlistentry>
       <term><option>--enable-profiling</option></term>
       <listitem>
        <para>
         If using GCC, all programs and libraries are compiled so they
         can be profiled.  On backend exit, a subdirectory will be created
         that contains the <filename>gmon.out</> file for use in profiling.
         This option is for use only with GCC and when doing development work.
        </para>
       </listitem>
      </varlistentry>

1110 1111 1112 1113 1114
      <varlistentry>
       <term><option>--enable-cassert</option></term>
       <listitem>
        <para>
         Enables <firstterm>assertion</> checks in the server, which test for
1115
         many <quote>cannot happen</> conditions.  This is invaluable for
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
         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.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--enable-depend</option></term>
       <listitem>
        <para>
         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.
        </para>
       </listitem>
      </varlistentry>

1142 1143 1144 1145
      <varlistentry>
       <term><option>--enable-dtrace</option></term>
       <listitem>
        <para>
1146 1147 1148
         <indexterm>
          <primary>DTrace</primary>
         </indexterm>
1149 1150 1151 1152
         Compiles with support for the dynamic tracing tool DTrace.
         Operating system support for DTrace is currently only
         available in Solaris.
        </para>
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163

        <para>
         To point to the <command>dtrace</command> program, the
         environment variable <envar>DTRACE</envar> can be set.  This
         will often be necessary because <command>dtrace</command> is
         typically installed under <filename>/usr/sbin</filename>,
         which might not be in the path.  Additional command-line
         options for the <command>dtrace</command> program can be
         specified in the environment variable
         <envar>DTRACEFLAGS</envar>.
        </para>
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176

        <para>
         To include DTrace support in a 64-bit binary, specify
         <literal>DTRACEFLAGS="-64"</> to configure.  For example,
         using the GCC compiler:
<screen>
./configure CC='gcc -m64' --enable-dtrace DTRACEFLAGS='-64' ...
</screen>            
         Using Sun's compiler:
<screen>            
./configure CC='/opt/SUNWspro/bin/cc -xtarget=native64' --enable-dtrace DTRACEFLAGS='-64' ...
</screen>
        </para>
1177 1178 1179
       </listitem>
      </varlistentry>

1180 1181 1182 1183 1184
     </variablelist>
    </para>

    <para>
     If you prefer a C compiler different from the one
T
Tom Lane 已提交
1185
     <filename>configure</filename> picks, you can set the
1186 1187
     environment variable <envar>CC</> to the program of your choice.
     By default, <filename>configure</filename> will pick
T
Tom Lane 已提交
1188 1189 1190
     <filename>gcc</filename> if available, else the platform's
     default (usually <filename>cc</>).  Similarly, you can override the
     default compiler flags if needed with the <envar>CFLAGS</envar> variable.
1191 1192 1193 1194 1195 1196 1197 1198 1199
    </para>

    <para>
     You can specify environment variables on the
     <filename>configure</filename> command line, for example:
<screen>
<userinput>./configure CC=/opt/bin/gcc CFLAGS='-O2 -pipe'</>
</screen>
    </para>
1200 1201

    <para>
1202 1203 1204
     Here is a list of the significant variables that can be set in
     this manner:
 
1205 1206
     <variablelist>
      <varlistentry>
1207
       <term><envar>CC</envar></term>
1208 1209
       <listitem>
        <para>
1210
         C compiler
1211 1212 1213 1214 1215
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
1216
       <term><envar>CFLAGS</envar></term>
1217 1218
       <listitem>
        <para>
1219
         options to pass to the C compiler
1220 1221 1222 1223
        </para>
       </listitem>
      </varlistentry>

1224
      <varlistentry>
1225
       <term><envar>CPP</envar></term>
1226 1227
       <listitem>
        <para>
1228
         C preprocessor
1229 1230 1231 1232 1233
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
1234
       <term><envar>CPPFLAGS</envar></term>
1235 1236
       <listitem>
        <para>
1237
         options to pass to the C preprocessor
1238 1239 1240 1241
        </para>
       </listitem>
      </varlistentry>

1242
      <varlistentry>
1243
       <term><envar>DTRACE</envar></term>
1244 1245
       <listitem>
        <para>
1246
         location of the <command>dtrace</command> program
1247 1248 1249 1250 1251
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
1252
       <term><envar>DTRACEFLAGS</envar></term>
1253 1254
       <listitem>
        <para>
1255
         options to pass to the <command>dtrace</command> program
1256 1257 1258 1259 1260
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
1261
       <term><envar>LDFLAGS</envar></term>
1262 1263
       <listitem>
        <para>
1264
         options to pass to the link editor
1265 1266 1267 1268 1269
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
1270
       <term><envar>LDFLAGS_SL</envar></term>
1271 1272
       <listitem>
        <para>
1273
         linker options for shared library linking
1274 1275 1276 1277 1278
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
1279
       <term><envar>MSGFMT</envar></term>
1280 1281
       <listitem>
        <para>
1282
         <command>msgfmt</command> program for native language support
1283 1284 1285 1286 1287
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
1288
       <term><envar>PERL</envar></term>
1289 1290
       <listitem>
        <para>
1291 1292
         Full path to the Perl interpreter.  This will be used to
         determine the dependencies for building PL/Perl.
1293 1294 1295 1296 1297
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
1298
       <term><envar>PYTHON</envar></term>
1299 1300
       <listitem>
        <para>
1301 1302
         Full path to the Python interpreter.  This will be used to
         determine the dependencies for building PL/Python.
1303 1304 1305 1306 1307
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
1308
       <term><envar>TCLSH</envar></term>
1309 1310
       <listitem>
        <para>
P
Peter Eisentraut 已提交
1311
         Full path to the Tcl interpreter.  This will be used to
1312
         determine the dependencies for building PL/Tcl.
1313 1314 1315 1316
        </para>
       </listitem>
      </varlistentry>

1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
      <varlistentry>
       <term><envar>XML2_CONFIG</envar></term>
       <listitem>
        <para>
         <command>xml2-config</command> program used to locate the
         libxml installation.
        </para>
       </listitem>
      </varlistentry>

1327
      <varlistentry>
1328
       <term><envar>YACC</envar></term>
1329 1330
       <listitem>
        <para>
1331
         Yacc program (<literal>bison -y</literal> if using Bison)
1332 1333 1334 1335 1336
        </para>
       </listitem>
      </varlistentry>
     </variablelist>
    </para>
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347
   </step>

  <step>
   <title>Build</title>

   <para>
    To start the build, type
<screen>
<userinput>gmake</userinput>
</screen>
    (Remember to use <acronym>GNU</> <application>make</>.) The build
P
Peter Eisentraut 已提交
1348
    will take a few minutes depending on your
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387
    hardware. The last line displayed should be
<screen>
All of PostgreSQL is successfully made. Ready to install.
</screen>
   </para>
  </step>

  <step>
   <title>Regression Tests</title>

   <indexterm>
    <primary>regression test</primary>
   </indexterm>

   <para>
    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 <productname>PostgreSQL</>
    runs on your machine in the way the developers expected it
    to. Type
<screen>
<userinput>gmake check</userinput>
</screen>
    (This won't work as root; do it as an unprivileged user.)
    <![%standalone-include[The file
    <filename>src/test/regress/README</> and the
    documentation contain]]>
    <![%standalone-ignore[<xref linkend="regress"> contains]]>
    detailed information about interpreting the test results. You can
    repeat this test at any later time by issuing the same command.
   </para>
  </step>

  <step id="install">
   <title>Installing The Files</title>

   <note>
    <para>
     If you are upgrading an existing system and are going to install
T
Tom Lane 已提交
1388 1389
     the new files over the old ones, be sure to back up
     your data and shut down the old server before proceeding, as explained in
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
     <xref linkend="install-upgrading"> above.
    </para>
   </note>

   <para>
    To install <productname>PostgreSQL</> enter
<screen>
<userinput>gmake install</userinput>
</screen>
    This will install files into the directories that were specified
    in <xref linkend="configure">. 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.
   </para>

   <para>
    You can use <literal>gmake install-strip</literal> instead of
    <literal>gmake install</literal> to strip the executable files and
    libraries as they are installed.  This will save some space.  If
    you built with debugging support, stripping will effectively
    remove the debugging support, so it should only be done if
    debugging is no longer needed.  <literal>install-strip</literal>
    tries to do a reasonable job saving space, but it does not have
    perfect knowledge of how to strip every unneeded byte from an
    executable file, so if you want to save all the disk space you
    possibly can, you will have to do manual work.
   </para>

   <para>
    The standard installation provides all the header files needed for client
T
Tom Lane 已提交
1422 1423 1424 1425 1426
    application development as well as for server-side program
    development, such as custom functions or data types written in C.
    (Prior to <productname>PostgreSQL</> 8.0, a separate <literal>gmake
    install-all-headers</> command was needed for the latter, but this
    step has been folded into the standard install.)
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
   </para>

   <formalpara>
    <title>Client-only installation:</title>
    <para>
     If you want to install only the client applications and
     interface libraries, then you can use these commands:
<screen>
<userinput>gmake -C src/bin install</>
<userinput>gmake -C src/include install</>
<userinput>gmake -C src/interfaces install</>
<userinput>gmake -C doc install</>
</screen>
1440 1441
    <filename>src/bin</> has a few binaries for server-only use,
    but they are small.
1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477
    </para>
   </formalpara>
  </step>
  </procedure>

  <formalpara>
   <title>Registering <application>eventlog</> on <systemitem 
   class="osname">Windows</>:</title>
   <para>
    To register a <systemitem class="osname">Windows</> <application>eventlog</>
    library with the operating system, issue this command after installation:
<screen>
<userinput>regsvr32 <replaceable>pgsql_library_directory</>/pgevent.dll</>
</screen>
    This creates registry entries used by the event viewer.
   </para>
  </formalpara>

  <formalpara>
   <title>Uninstallation:</title>
   <para>
    To undo the installation use the command <command>gmake
    uninstall</>. However, this will not remove any created directories.
   </para>
  </formalpara>

  <formalpara>
   <title>Cleaning:</title>

   <para>
    After the installation you can make room by removing the built
    files from the source tree with the command <command>gmake
    clean</>. This will preserve the files made by the <command>configure</command>
    program, so that you can rebuild everything with <command>gmake</>
    later on. To reset the source tree to the state in which it was
    distributed, use <command>gmake distclean</>. If you are going to
T
Tom Lane 已提交
1478 1479 1480 1481
    build for several platforms within the same source tree you must do
    this and re-configure for each build.  (Alternatively, use
    a separate build tree for each platform, so that the source tree
    remains unmodified.)
1482 1483 1484 1485 1486 1487 1488 1489 1490
   </para>
  </formalpara>

  <para>
   If you perform a build and then discover that your <command>configure</>
   options were wrong, or if you change anything that <command>configure</>
   investigates (for example, software upgrades), then it's a good
   idea to do <command>gmake distclean</> before reconfiguring and
   rebuilding.  Without this, your changes in configuration choices
1491
   might not propagate everywhere they need to.
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
  </para>
 </sect1>

 <sect1 id="install-post">
  <title>Post-Installation Setup</title>

  <sect2>
   <title>Shared Libraries</title>

   <indexterm>
    <primary>shared library</primary>
   </indexterm>

   <para>
    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
    <emphasis>not</emphasis> necessary include <systemitem
    class="osname">BSD/OS</>, <systemitem class="osname">FreeBSD</>,
    <systemitem class="osname">HP-UX</>, <systemitem
    class="osname">IRIX</>, <systemitem class="osname">Linux</>,
    <systemitem class="osname">NetBSD</>, <systemitem
    class="osname">OpenBSD</>, <systemitem class="osname">Tru64
    UNIX</> (formerly <systemitem class="osname">Digital UNIX</>), and
    <systemitem class="osname">Solaris</>.
   </para>

   <para>
    The method to set the shared library search path varies between
    platforms, but the most widely usable method is to set the
    environment variable <envar>LD_LIBRARY_PATH</> like so: In Bourne
1523
    shells (<command>sh</>, <command>ksh</>, <command>bash</>, <command>zsh</>):
1524 1525 1526 1527
<programlisting>
LD_LIBRARY_PATH=/usr/local/pgsql/lib
export LD_LIBRARY_PATH
</programlisting>
1528
    or in <command>csh</> or <command>tcsh</>:
1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570
<programlisting>
setenv LD_LIBRARY_PATH /usr/local/pgsql/lib
</programlisting>
    Replace <literal>/usr/local/pgsql/lib</> with whatever you set
    <option><literal>--libdir</></> to in <xref linkend="configure">.
    You should put these commands into a shell start-up file such as
    <filename>/etc/profile</> or <filename>~/.bash_profile</>.  Some
    good information about the caveats associated with this method can
    be found at <ulink
    url="http://www.visi.com/~barr/ldpath.html"></ulink>.
   </para>

   <para>
    On some systems it might be preferable to set the environment
    variable <envar>LD_RUN_PATH</envar> <emphasis>before</emphasis>
    building.
   </para>

   <para>
    On <systemitem class="osname">Cygwin</systemitem>, put the library
    directory in the <envar>PATH</envar> or move the
    <filename>.dll</filename> files into the <filename>bin</filename>
    directory.
   </para>

   <para>
    If in doubt, refer to the manual pages of your system (perhaps
    <command>ld.so</command> or <command>rld</command>). If you later
    on get a message like
<screen>
psql: error in loading shared libraries
libpq.so.2.1: cannot open shared object file: No such file or directory
</screen>
    then this step was necessary.  Simply take care of it then.
   </para>

   <para>
    <indexterm>
     <primary>ldconfig</primary>
    </indexterm>
    If you are on <systemitem class="osname">BSD/OS</>, <systemitem
    class="osname">Linux</>, or <systemitem class="osname">SunOS 4</>
1571
    and you have root access you can run:
1572 1573 1574 1575 1576 1577 1578 1579
<programlisting>
/sbin/ldconfig /usr/local/pgsql/lib
</programlisting>
    (or equivalent directory) after installation to enable the
    run-time linker to find the shared libraries faster.  Refer to the
    manual page of <command>ldconfig</> for more information.  On
    <systemitem class="osname">FreeBSD</>, <systemitem
    class="osname">NetBSD</>, and <systemitem
1580
    class="osname">OpenBSD</> the command is:
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
<programlisting>
/sbin/ldconfig -m /usr/local/pgsql/lib
</programlisting>
    instead.  Other systems are not known to have an equivalent
    command.
   </para>
  </sect2>

  <sect2>
   <title>Environment Variables</title>

   <indexterm>
    <primary><envar>PATH</envar></primary>
   </indexterm>

   <para>
    If you installed into <filename>/usr/local/pgsql</> or some other
    location that is not searched for programs by default, you should
    add <filename>/usr/local/pgsql/bin</> (or whatever you set
    <option><literal>--bindir</></> to in <xref linkend="configure">)
    into your <envar>PATH</>.  Strictly speaking, this is not
    necessary, but it will make the use of <productname>PostgreSQL</>
    much more convenient.
   </para>

   <para>
    To do this, add the following to your shell start-up file, such as
    <filename>~/.bash_profile</> (or <filename>/etc/profile</>, if you
    want it to affect every user):
<programlisting>
PATH=/usr/local/pgsql/bin:$PATH
export PATH
</programlisting>
    If you are using <command>csh</> or <command>tcsh</>, then use this command:
<programlisting>
set path = ( /usr/local/pgsql/bin $path )
</programlisting>
   </para>

   <para>
    <indexterm>
     <primary><envar>MANPATH</envar></primary>
    </indexterm>
    To enable your system to find the <application>man</>
    documentation, you need to add lines like the following to a
    shell start-up file unless you installed into a location that is
1627
    searched by default:
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
<programlisting>
MANPATH=/usr/local/pgsql/man:$MANPATH
export MANPATH
</programlisting>
   </para>

   <para>
    The environment variables <envar>PGHOST</> and <envar>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 <envar>PGHOST</>.  This
    is not required, however: the settings can be communicated via command
    line options to most client programs.
   </para>
  </sect2>
 </sect1>


<![%standalone-include;[
 <sect1 id="install-getting-started">
  <title>Getting Started</title>

  <para>
   The following is a quick summary of how to get <productname>PostgreSQL</> up and
   running once installed. The main documentation contains more information.
  </para>

  <procedure>
   <step>
    <para>
     Create a user account for the <productname>PostgreSQL</>
     server. This is the user the server will run as. For production
     use you should create a separate, unprivileged account
     (<quote>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.
<screen>
<userinput>adduser postgres</>
</screen>
    </para>
   </step>

   <step>
    <para>
     Create a database installation with the <command>initdb</>
     command. To run <command>initdb</> you must be logged in to your
     <productname>PostgreSQL</> server account. It will not work as
     root.
<screen>
root# <userinput>mkdir /usr/local/pgsql/data</>
root# <userinput>chown postgres /usr/local/pgsql/data</>
root# <userinput>su - postgres</>
postgres$ <userinput>/usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data</>
</screen>
    </para>

    <para>
     The <option>-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 <command>initdb</>, as
     illustrated here.
    </para>
   </step>

1696
   <step>
1697 1698 1699 1700 1701 1702 1703 1704
    <para>
     At this point, if you did not use the <command>initdb</> <literal>-A</>
     option, you might want to modify <filename>pg_hba.conf</> to control
     local access to the server before you start it.  The default is to 
     trust all local users.
    </para>
   </step>

1705 1706
   <step>
    <para>
1707 1708 1709
     The previous <command>initdb</> step should have told you how to
     start up the database server. Do so now. The command should look
     something like:
1710
<programlisting>
1711
/usr/local/pgsql/bin/postgres -D /usr/local/pgsql/data
1712 1713
</programlisting>
     This will start the server in the foreground. To put the server
1714
     in the background use something like:
1715
<programlisting>
1716
nohup /usr/local/pgsql/bin/postgres -D /usr/local/pgsql/data \
1717 1718 1719 1720 1721
    &lt;/dev/null &gt;&gt;server.log 2&gt;&amp;1 &lt;/dev/null &amp;
</programlisting>
    </para>

    <para>
1722
     To stop a server running in the background you can type:
1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
<programlisting>
kill `cat /usr/local/pgsql/data/postmaster.pid`
</programlisting>
    </para>
   </step>

   <step>
    <para>
     Create a database:
<screen>
<userinput>createdb testdb</>
</screen>
     Then enter
<screen>
<userinput>psql testdb</>
</screen>
     to connect to that database. At the prompt you can enter SQL
     commands and start experimenting.
    </para>
   </step>
  </procedure>
 </sect1>

 <sect1 id="install-whatnow">
  <title>What Now?</title>

  <para>
   <itemizedlist>
    <listitem>
     <para>
      The <productname>PostgreSQL</> distribution contains a
      comprehensive documentation set, which you should read sometime.
      After installation, the documentation can be accessed by
      pointing your browser to
      <filename>/usr/local/pgsql/doc/html/index.html</>, unless you
      changed the installation directories.
     </para>

     <para>
      The first few chapters of the main documentation are the Tutorial,
      which should be your first reading if you are completely new to
      <acronym>SQL</> databases.  If you are familiar with database
      concepts then you want to proceed with part on server
      administration, which contains information about how to set up
      the database server, database users, and authentication.
     </para>
    </listitem>

    <listitem>
     <para>
      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 documentation.
     </para>
    </listitem>

    <listitem>
     <para>
      Run the regression tests against the installed server (using
      <command>gmake installcheck</command>). If you didn't run the
      tests before installation, you should definitely do it now. This
      is also explained in the documentation.
     </para>
    </listitem>

    <listitem>
     <para>
      By default, <productname>PostgreSQL</> is configured to run on
      minimal hardware.  This allows it to start up with almost any
      hardware configuration. The default configuration is, however,
      not designed for optimum performance. To achieve optimum
      performance, several server parameters must be adjusted, the two
      most common being <varname>shared_buffers</varname> and
      <varname>work_mem</varname>.
      Other parameters mentioned in the documentation also affect
      performance.
     </para>
    </listitem>
   </itemizedlist>
  </para>
 </sect1>
]]>


 <sect1 id="supported-platforms">
  <title>Supported Platforms</title>

  <para>
   <productname>PostgreSQL</> has been verified by the developer
   community to work on the platforms listed below. A supported
   platform generally means that <productname>PostgreSQL</> builds and
   installs according to these instructions and that the regression
1815
   tests pass.  <quote>Build farm</quote> entries refer to active test
1816
   machines in the <ulink url="http://buildfarm.postgresql.org/">
1817
   PostgreSQL Build Farm</ulink>.
1818
   Platform entries that show an older version of
1819 1820 1821
   PostgreSQL are those that did not receive explicit testing at the
   time of release of version &majorversion; but that we still
   expect to work.
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
  </para>

  <note>
   <para>
    If you are having problems with the installation on a supported
    platform, please write to <email>pgsql-bugs@postgresql.org</email>
    or <email>pgsql-ports@postgresql.org</email>, not to the people
    listed here.
   </para>
  </note>

    <informaltable>
     <tgroup cols="5">
      <thead>
       <row>
        <entry><acronym>OS</acronym></entry>
        <entry>Processor</entry>
        <entry>Version</entry>
        <entry>Reported</entry>
        <entry>Remarks</entry>
       </row>
      </thead>
      <tbody>
       <row>
        <entry><systemitem class="osname">AIX</></entry>
        <entry><systemitem>PowerPC</></entry>
1848
        <entry>8.2.0</entry>
1849
        <entry>Build farm
1850
         <systemitem class="systemname">grebe</systemitem> (5.3, gcc 4.0.1); 
1851 1852
         <systemitem class="systemname">kookaburra</systemitem> (5.2, cc 6.0); 
         <systemitem class="systemname">asp</systemitem> (5.2, gcc 3.3.2)</entry>
T
Tom Lane 已提交
1853 1854
        <entry>see <filename>doc/FAQ_AIX</filename>,
         particularly if using AIX 5.3 ML3</entry>
1855 1856 1857 1858 1859 1860
       </row>
       <row>
        <entry><systemitem class="osname">AIX</></entry>
        <entry><systemitem>RS6000</></entry>
        <entry>8.0.0</entry>
        <entry>Hans-J&uuml;rgen Sch&ouml;nig (<email>hs@cybertec.at</email>), 2004-12-06</entry>
1861
        <entry>see <filename>doc/FAQ_AIX</filename></entry>
1862 1863 1864 1865
       </row>
       <row>
        <entry><systemitem class="osname">BSD/OS</></entry>
        <entry><systemitem>x86</></entry>
B
Bruce Momjian 已提交
1866 1867
        <entry>8.2.0</entry>
        <entry>Bruce Momjian (<email>bruce@momjian.us</email>), 2007-01-25</entry>
1868 1869 1870 1871 1872
        <entry>4.3.1</entry>
       </row>
       <row>
        <entry><systemitem class="osname">Debian GNU/Linux</></entry>
        <entry><systemitem>Alpha</></entry>
1873
        <entry>8.2.0</entry>
1874
        <entry>Build farm <systemitem class="systemname">hare</systemitem> (3.1, gcc 3.3.4)</entry>
1875 1876 1877 1878 1879
        <entry></entry>
       </row>
       <row>
        <entry><systemitem class="osname">Debian GNU/Linux</></entry>
        <entry><systemitem>AMD64</></entry>
1880 1881 1882 1883 1884
        <entry>8.2.0</entry>
        <entry>Build farm
         <systemitem class="systemname">shad</systemitem> (4.0, gcc 4.1.2);
         <systemitem class="systemname">kite</systemitem> (3.1, gcc 4.0);
         <systemitem class="systemname">panda</systemitem> (sid, gcc 3.3.5)</entry>
1885
        <entry></entry>
1886 1887 1888
       </row>
       <row>
        <entry><systemitem class="osname">Debian GNU/Linux</></entry>
1889
        <entry><systemitem>ARM</></entry>
1890
        <entry>8.2.0</entry>
1891 1892 1893 1894 1895 1896
        <entry>Build farm <systemitem class="systemname">penguin</systemitem> (3.1, gcc 3.3.4)</entry>
        <entry></entry>
       </row>
       <row>
        <entry><systemitem class="osname">Debian GNU/Linux</></entry>
        <entry><systemitem>Athlon XP</></entry>
1897
        <entry>8.2.0</entry>
1898
        <entry>Build farm <systemitem class="systemname">rook</systemitem> (3.1, gcc 3.3.5)</entry>
1899 1900 1901 1902
        <entry></entry>
       </row>
       <row>
        <entry><systemitem class="osname">Debian GNU/Linux</></entry>
1903
        <entry><systemitem>IA64</></entry>
1904 1905
        <entry>8.2.0</entry>
        <entry>Build farm <systemitem class="systemname">dugong</systemitem> (unstable, icc 9.1.045)</entry>
1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
        <entry></entry>
       </row>
       <row>
        <entry><systemitem class="osname">Debian GNU/Linux</></entry>
        <entry><systemitem>m68k</></entry>
        <entry>8.0.0</entry>
        <entry>No&egrave;l K&ouml;the (<email>noel@debian.org</email>), 2004-12-09</entry>
        <entry>sid</entry>
       </row>
       <row>
        <entry><systemitem class="osname">Debian GNU/Linux</></entry>
        <entry><systemitem>MIPS</></entry>
1918
        <entry>8.2.0</entry>
1919 1920 1921 1922 1923 1924 1925
        <entry>Build farm
         <systemitem class="systemname">otter</systemitem> (3.1, gcc 3.3.4)</entry>
        <entry></entry>
       </row>
       <row>
        <entry><systemitem class="osname">Debian GNU/Linux</></entry>
        <entry><systemitem>MIPSEL</></entry>
1926
        <entry>8.2.0</entry>
1927 1928 1929 1930
        <entry>Build farm
         <systemitem class="systemname">lionfish</systemitem> (3.1, gcc 3.3.4);
         <systemitem class="systemname">corgi</systemitem> (3.1, gcc 3.3.4)</entry>
        <entry></entry>
1931 1932 1933 1934
       </row>
       <row>
        <entry><systemitem class="osname">Debian GNU/Linux</></entry>
        <entry><systemitem>PA-RISC</></entry>
1935 1936 1937 1938
        <entry>8.2.0</entry>
        <entry>Build farm
         <systemitem class="systemname">manatee</systemitem> (3.1, gcc 4.0.1);
         <systemitem class="systemname">kingfisher</systemitem> (3.1, gcc 3.3.5)</entry>
1939
        <entry></entry>
1940 1941 1942 1943 1944 1945
     </row>
       <row>
        <entry><systemitem class="osname">Debian GNU/Linux</></entry>
        <entry><systemitem>PowerPC</></entry>
        <entry>8.0.0</entry>
        <entry>No&egrave;l K&ouml;the (<email>noel@debian.org</email>), 2004-12-15</entry>
1946
        <entry>sid</entry>
1947 1948 1949 1950
       </row>
       <row>
        <entry><systemitem class="osname">Debian GNU/Linux</></entry>
        <entry><systemitem>Sparc</></entry>
1951 1952 1953 1954
        <entry>8.1.0</entry>
        <entry>Build farm <systemitem class="systemname">dormouse</systemitem>
         (3.1, gcc 3.2.5; 64-bit)</entry>
        <entry></entry>
1955 1956 1957 1958
       </row>
       <row>
        <entry><systemitem class="osname">Debian GNU/Linux</></entry>
        <entry><systemitem>x86</></entry>
1959 1960
        <entry>8.2.0</entry>
        <entry>Build farm <systemitem class="systemname">wildebeest</systemitem> (3.1, gcc 3.3.5)</entry>
1961 1962
       </row>
       <row>
1963
        <entry><systemitem class="osname">Fedora Linux</></entry>
1964
        <entry><systemitem>AMD64</></entry>
1965 1966 1967 1968 1969 1970
        <entry>8.2.0</entry>
        <entry>Build farm
         <systemitem class="systemname">impala</systemitem> (FC6, gcc 4.1.1);
         <systemitem class="systemname">bustard</systemitem> (FC5, gcc 4.1.0);
         <systemitem class="systemname">wasp</systemitem> (FC5, gcc 4.1.0);
         <systemitem class="systemname">viper</systemitem> (FC3, gcc 3.4.4)</entry>
1971
        <entry></entry>
1972 1973
       </row>
       <row>
1974 1975 1976 1977 1978
        <entry><systemitem class="osname">Fedora Linux</></entry>
        <entry><systemitem>PowerPC</></entry>
        <entry>8.2.0</entry>
        <entry>Build farm
         <systemitem class="systemname">sponge</systemitem> (FC5, gcc 4.1.0)</entry>
1979
        <entry></entry>
1980 1981
       </row>
       <row>
1982 1983 1984 1985 1986 1987 1988
        <entry><systemitem class="osname">Fedora Linux</></entry>
        <entry><systemitem>x86</></entry>
        <entry>8.2.0</entry>
        <entry>Build farm
         <systemitem class="systemname">agouti</systemitem> (FC5, gcc 4.1.1);
         <systemitem class="systemname">thrush</systemitem> (FC1, gcc 3.3.2)</entry>
        <entry></entry>
1989
       </row>
1990 1991 1992
       <row>
        <entry><systemitem class="osname">FreeBSD</></entry>
        <entry><systemitem>AMD64</></entry>
1993
        <entry>8.2.0</entry>
1994
        <entry>Build farm
1995 1996 1997
         <systemitem class="systemname">platypus</systemitem> (6, gcc 3.4.4);
         <systemitem class="systemname">dove</systemitem> (6.1, gcc 3.4.4);
         <systemitem class="systemname">ermine</systemitem> (6.1, gcc 3.4.4)</entry>
1998 1999
        <entry></entry>
       </row>
2000 2001 2002
       <row>
        <entry><systemitem class="osname">FreeBSD</></entry>
        <entry><systemitem>x86</></entry>
2003
        <entry>8.2.0</entry>
2004
        <entry>Build farm
2005
         <systemitem class="systemname">minnow</systemitem> (6.1, gcc 3.4.4);
2006 2007
         <systemitem class="systemname">echidna</systemitem> (6, gcc 3.4.2);
         <systemitem class="systemname">herring</systemitem> (6, Intel cc 7.1)</entry>
2008 2009
        <entry></entry>
       </row>
2010 2011 2012
       <row>
        <entry><systemitem class="osname">Gentoo Linux</></entry>
        <entry><systemitem>AMD64</></entry>
2013 2014 2015 2016 2017 2018 2019
        <entry>8.1.0</entry>
        <entry>Build farm <systemitem class="systemname">caribou</systemitem> (2.6.9, gcc 3.3.5)</entry>
        <entry></entry>
       </row>
       <row>
        <entry><systemitem class="osname">Gentoo Linux</></entry>
        <entry><systemitem>IA64</></entry>
2020
        <entry>8.2.0</entry>
2021 2022 2023 2024 2025 2026
        <entry>Build farm <systemitem class="systemname">stoat</systemitem> (2.6, gcc 3.3)</entry>
        <entry></entry>
       </row>
       <row>
        <entry><systemitem class="osname">Gentoo Linux</></entry>
        <entry><systemitem>PowerPC 64</></entry>
2027
        <entry>8.2.0</entry>
2028
        <entry>Build farm <systemitem class="systemname">cobra</systemitem> (1.4.16, gcc 3.4.3)</entry>
2029 2030
        <entry></entry>
       </row>
2031 2032 2033
       <row>
        <entry><systemitem class="osname">Gentoo Linux</></entry>
        <entry><systemitem>x86</></entry>
2034 2035
        <entry>8.2.0</entry>
        <entry>Build farm <systemitem class="systemname">mongoose</systemitem> (1.6.14, icc 9.0.032)</entry>
2036 2037
        <entry></entry>
       </row>
2038 2039
       <row>
        <entry><systemitem class="osname">HP-UX</></entry>
2040
        <entry><systemitem>IA64</></entry>
2041 2042
        <entry>8.2.0</entry>
        <entry>Tom Lane (<email>tgl@sss.pgh.pa.us</email>), 2006-10-23</entry>
T
Tom Lane 已提交
2043
        <entry>11.23, <command>gcc</> and <command>cc</>; see <filename>doc/FAQ_HPUX</filename></entry>
2044
       </row>
2045 2046 2047
       <row>
        <entry><systemitem class="osname">HP-UX</></entry>
        <entry><systemitem>PA-RISC</></entry>
2048 2049
        <entry>8.2.0</entry>
        <entry>Tom Lane (<email>tgl@sss.pgh.pa.us</email>), 2006-10-23</entry>
T
Tom Lane 已提交
2050
        <entry>10.20 and 11.23, <command>gcc</> and <command>cc</>; see <filename>doc/FAQ_HPUX</filename></entry>
2051 2052 2053 2054
       </row>
       <row>
        <entry><systemitem class="osname">IRIX</></entry>
        <entry><systemitem>MIPS</></entry>
T
Tom Lane 已提交
2055 2056 2057
        <entry>8.1.0</entry>
        <entry>Kenneth Marshall (<email>ktm@is.rice.edu</email>), 2005-11-04</entry>
        <entry>6.5, <command>cc</command> only</entry>
2058
       </row>
2059 2060 2061 2062 2063 2064 2065
       <row>
        <entry><systemitem class="osname">Kubuntu Linux</></entry>
        <entry><systemitem>AMD64</></entry>
        <entry>8.2.0</entry>
        <entry>Build farm <systemitem class="systemname">rosella</systemitem> (5.10 <quote>Breezy</>, gcc 4.0)</entry>
        <entry></entry>
       </row>
2066 2067 2068
       <row>
        <entry><systemitem class="osname">Mac OS X</></entry>
        <entry><systemitem>PowerPC</></entry>
2069
        <entry>8.2.0</entry>
2070
        <entry>Build farm
2071
         <systemitem class="systemname">tuna</systemitem> (10.4.2, gcc 4.0)</entry>
2072
        <entry></entry>
2073 2074
       </row>
       <row>
2075
        <entry><systemitem class="osname">Mac OS X</></entry>
2076
        <entry><systemitem>x86</></entry>
2077 2078 2079
        <entry>8.2.0</entry>
        <entry>Build farm
         <systemitem class="systemname">jackal</systemitem> (10.4.8, gcc 4.0.1)</entry>
2080
        <entry></entry>
2081 2082
       </row>
       <row>
2083 2084 2085 2086 2087
        <entry><systemitem class="osname">Mandriva Linux</></entry>
        <entry><systemitem>x86</></entry>
        <entry>8.2.0</entry>
        <entry>Build farm <systemitem class="systemname">gopher</systemitem> (Mandriva 2006, gcc 4.0.1)</entry>
        <entry></entry>
2088
       </row>
2089 2090 2091
       <row>
        <entry><systemitem class="osname">NetBSD</></entry>
        <entry><systemitem>m68k</></entry>
2092
        <entry>8.2.0</entry>
2093 2094
        <entry>Build farm <systemitem class="systemname">osprey</systemitem> (2.0, gcc 3.3.3)</entry>
        <entry></entry>
2095
       </row>
2096 2097
       <row>
        <entry><systemitem class="osname">NetBSD</></entry>
2098 2099 2100 2101 2102
        <entry><systemitem>x86</></entry>
        <entry>8.2.0</entry>
        <entry>Build farm
         <systemitem class="systemname">gazelle</systemitem> (3.0, gcc 3.3.3);
         <systemitem class="systemname">canary</systemitem> (1.6, gcc 2.95.3)</entry>
2103 2104
       </row>
       <row>
2105 2106 2107 2108 2109
        <entry><systemitem class="osname">OpenBSD</></entry>
        <entry><systemitem>AMD64</></entry>
        <entry>8.2.0</entry>
        <entry>Build farm
         <systemitem class="systemname">zebra</systemitem> (4.0, gcc 3.3.5)</entry>
2110
       </row>
2111 2112 2113 2114 2115 2116 2117
       <row>
        <entry><systemitem class="osname">OpenBSD</></entry>
        <entry><systemitem>Sparc</></entry>
        <entry>8.0.0</entry>
        <entry>Chris Mair (<email>list@1006.org</email>), 2005-01-10</entry>
        <entry>3.3</entry>
       </row>
2118 2119
       <row>
        <entry><systemitem class="osname">OpenBSD</></entry>
2120
        <entry><systemitem>Sparc64</></entry>
2121 2122
        <entry>8.2.0</entry>
        <entry>Build farm <systemitem class="systemname">spoonbill</systemitem> (3.9, gcc 3.3.5)</entry>
2123 2124 2125 2126
       </row>
       <row>
        <entry><systemitem class="osname">OpenBSD</></entry>
        <entry><systemitem>x86</></entry>
2127 2128 2129 2130
        <entry>8.2.0</entry>
        <entry>Build farm
         <systemitem class="systemname">emu</systemitem> (4.0, gcc 3.3.5);
         <systemitem class="systemname">guppy</systemitem> (3.8, gcc 3.3.5)</entry>
2131
        <entry>minor ecpg test failure on 3.8</entry>
2132 2133 2134 2135
       </row>
       <row>
        <entry><systemitem class="osname">Red Hat Linux</></entry>
        <entry><systemitem>AMD64</></entry>
2136 2137 2138
        <entry>8.1.0</entry>
        <entry>Tom Lane (<email>tgl@sss.pgh.pa.us</email>), 2005-10-23</entry>
        <entry>RHEL 4</entry>
2139 2140 2141 2142
       </row>
       <row>
        <entry><systemitem class="osname">Red Hat Linux</></entry>
        <entry><systemitem>IA64</></entry>
2143 2144 2145
        <entry>8.1.0</entry>
        <entry>Tom Lane (<email>tgl@sss.pgh.pa.us</email>), 2005-10-23</entry>
        <entry>RHEL 4</entry>
2146 2147 2148 2149
       </row>
       <row>
        <entry><systemitem class="osname">Red Hat Linux</></entry>
        <entry><systemitem>PowerPC</></entry>
2150 2151 2152
        <entry>8.1.0</entry>
        <entry>Tom Lane (<email>tgl@sss.pgh.pa.us</email>), 2005-10-23</entry>
        <entry>RHEL 4</entry>
2153 2154 2155 2156
       </row>
       <row>
        <entry><systemitem class="osname">Red Hat Linux</></entry>
        <entry><systemitem>PowerPC 64</></entry>
2157 2158 2159
        <entry>8.1.0</entry>
        <entry>Tom Lane (<email>tgl@sss.pgh.pa.us</email>), 2005-10-23</entry>
        <entry>RHEL 4</entry>
2160 2161 2162 2163
       </row>
       <row>
        <entry><systemitem class="osname">Red Hat Linux</></entry>
        <entry><systemitem>S/390</></entry>
2164 2165 2166
        <entry>8.1.0</entry>
        <entry>Tom Lane (<email>tgl@sss.pgh.pa.us</email>), 2005-10-23</entry>
        <entry>RHEL 4</entry>
2167 2168 2169 2170
       </row>
       <row>
        <entry><systemitem class="osname">Red Hat Linux</></entry>
        <entry><systemitem>S/390x</></entry>
2171 2172 2173
        <entry>8.1.0</entry>
        <entry>Tom Lane (<email>tgl@sss.pgh.pa.us</email>), 2005-10-23</entry>
        <entry>RHEL 4</entry>
2174 2175 2176 2177
       </row>
       <row>
        <entry><systemitem class="osname">Red Hat Linux</></entry>
        <entry><systemitem>x86</></entry>
2178 2179 2180
        <entry>8.1.0</entry>
        <entry>Tom Lane (<email>tgl@sss.pgh.pa.us</email>), 2005-10-23</entry>
        <entry>RHEL 4</entry>
2181
       </row>
T
Tom Lane 已提交
2182 2183 2184 2185 2186 2187 2188
       <row>
        <entry><systemitem class="osname">Slackware Linux</></entry>
        <entry><systemitem>x86</></entry>
        <entry>8.1.0</entry>
        <entry>Sergey Koposov (<email>math@sai.msu.ru</email>), 2005-10-24</entry>
        <entry>10.0</entry>
       </row>
2189 2190 2191
       <row>
        <entry><systemitem class="osname">Solaris</></entry>
        <entry><systemitem>Sparc</></entry>
2192 2193 2194
        <entry>8.2.0</entry>
        <entry>Build farm
         <systemitem class="systemname">hyena</systemitem> (Solaris 10, gcc 3.4.3)</entry>
T
Tom Lane 已提交
2195
        <entry>see <filename>doc/FAQ_Solaris</filename></entry>
2196 2197 2198 2199
       </row>
       <row>
        <entry><systemitem class="osname">Solaris</></entry>
        <entry><systemitem>x86</></entry>
2200 2201 2202 2203
        <entry>8.2.0</entry>
        <entry>Build farm
         <systemitem class="systemname">dragonfly</systemitem> (Solaris 9, gcc 3.2.3);
         <systemitem class="systemname">kudu</systemitem> (Solaris 9, cc 5.3)</entry>
2204 2205
        <entry>see <filename>doc/FAQ_Solaris</filename></entry>
       </row>
2206 2207 2208
       <row>
        <entry><systemitem class="osname">SUSE Linux</></entry>
        <entry><systemitem>AMD64</></entry>
T
Tom Lane 已提交
2209 2210 2211
        <entry>8.1.0</entry>
        <entry>Josh Berkus (<email>josh@agliodbs.com</email>), 2005-10-23</entry>
        <entry>SLES 9.3</entry>
2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247
       </row>
       <row>
        <entry><systemitem class="osname">SUSE Linux</></entry>
        <entry><systemitem>IA64</></entry>
        <entry>8.0.0</entry>
        <entry>Reinhard Max (<email>max@suse.de</email>), 2005-01-03</entry>
        <entry>SLES 9</entry>
       </row>
       <row>
        <entry><systemitem class="osname">SUSE Linux</></entry>
        <entry><systemitem>PowerPC</></entry>
        <entry>8.0.0</entry>
        <entry>Reinhard Max (<email>max@suse.de</email>), 2005-01-03</entry>
        <entry>SLES 9</entry>
       </row>
       <row>
        <entry><systemitem class="osname">SUSE Linux</></entry>
        <entry><systemitem>PowerPC 64</></entry>
        <entry>8.0.0</entry>
        <entry>Reinhard Max (<email>max@suse.de</email>), 2005-01-03</entry>
        <entry>SLES 9</entry>
       </row>
       <row>
        <entry><systemitem class="osname">SUSE Linux</></entry>
        <entry><systemitem>S/390</></entry>
        <entry>8.0.0</entry>
        <entry>Reinhard Max (<email>max@suse.de</email>), 2005-01-03</entry>
        <entry>SLES 9</entry>
       </row>
       <row>
        <entry><systemitem class="osname">SUSE Linux</></entry>
        <entry><systemitem>S/390x</></entry>
        <entry>8.0.0</entry>
        <entry>Reinhard Max (<email>max@suse.de</email>), 2005-01-03</entry>
        <entry>SLES 9</entry>
       </row>
2248 2249 2250 2251
       <row>
        <entry><systemitem class="osname">SUSE Linux</></entry>
        <entry><systemitem>x86</></entry>
        <entry>8.0.0</entry>
2252 2253
        <entry>Reinhard Max (<email>max@suse.de</email>), 2005-01-03</entry>
        <entry>9.0, 9.1, 9.2, SLES 9</entry>
2254
       </row>
2255 2256 2257
       <row>
        <entry><systemitem class="osname">Tru64 UNIX</></entry>
        <entry><systemitem>Alpha</></entry>
2258 2259 2260
        <entry>8.1.0</entry>
        <entry>Honda Shigehiro (<email>fwif0083@mb.infoweb.ne.jp</email>), 2005-11-01</entry>
        <entry>5.0, <command>cc</> 6.1-011</entry>
2261
       </row>
2262 2263 2264 2265 2266 2267
       <row>
        <entry><systemitem class="osname">Ubuntu Linux</></entry>
        <entry><systemitem>x86</></entry>
        <entry>8.2.0</entry>
        <entry>Build farm <systemitem class="systemname">caracara</systemitem> (6.06, gcc 4.0.3)</entry>
       </row>
2268 2269 2270
       <row>
        <entry><systemitem class="osname">UnixWare</></entry>
        <entry><systemitem>x86</></entry>
2271 2272
        <entry>8.2.0</entry>
        <entry>Build farm <systemitem class="systemname">warthog</systemitem>
2273 2274
         (7.1.4, <command>cc</command> 4.2)</entry>
        <entry>see <filename>doc/FAQ_SCO</filename></entry>
2275 2276 2277 2278
       </row>
       <row>
        <entry><systemitem class="osname">Windows</></entry>
        <entry><systemitem>x86</></entry>
2279
        <entry>8.2.0</entry>
2280
        <entry>Build farm
2281 2282 2283 2284
         <systemitem class="systemname">yak</systemitem> (XP SP2, gcc 3.4.2);
         <systemitem class="systemname">bandicoot</systemitem> (Windows 2000 Pro, gcc 3.4.2);
         <systemitem class="systemname">snake</systemitem> (Windows Server 2003 SP1, gcc 3.4.2);
         <systemitem class="systemname">trout</systemitem> (Windows Server 2000 SP4, gcc 3.4.2)</entry>
2285
        <entry>see <filename>doc/FAQ_MINGW</filename></entry>
2286 2287 2288 2289
       </row>
       <row>
        <entry><systemitem class="osname">Windows with <application>Cygwin</application></></entry>
        <entry><systemitem>x86</></entry>
2290 2291 2292
        <entry>8.2.0</entry>
        <entry>Build farm <systemitem class="systemname">eel</systemitem>
         (W2K Server SP4, gcc 3.4.4)</entry>
2293
        <entry>see <filename>doc/FAQ_CYGWIN</filename></entry>
2294
       </row>
2295 2296 2297 2298 2299 2300 2301
       <row>
        <entry><systemitem class="osname">Yellow Dog Linux</></entry>
        <entry><systemitem>PowerPC</></entry>
        <entry>8.1.0</entry>
        <entry>Build farm <systemitem class="systemname">carp</systemitem> (4.0, gcc 3.3.3)</entry>
        <entry></entry>
       </row>
2302 2303 2304 2305 2306 2307 2308
      </tbody>
     </tgroup>
    </informaltable>

  <formalpara>
   <title>Unsupported Platforms:</title>
   <para>
2309 2310 2311
    The following platforms used to work but have not been tested recently.
    We include these here to let you know that these platforms
    <emphasis>could</> be supported if given some attention.
2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327
   </para>
  </formalpara>

  <informaltable>
   <tgroup cols="5">
    <thead>
     <row>
      <entry><acronym>OS</acronym></entry>
      <entry>Processor</entry>
      <entry>Version</entry>
      <entry>Reported</entry>
      <entry>Remarks</entry>
     </row>
    </thead>

    <tbody>
2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341
     <row>
      <entry><systemitem class="osname">Debian GNU/Linux</></entry>
      <entry><systemitem>S/390</></entry>
      <entry>7.4</entry>
      <entry>No&egrave;l K&ouml;the (<email>noel@debian.org</email>), 2003-10-25</entry>
      <entry></entry>
     </row>
     <row>
      <entry><systemitem class="osname">FreeBSD</></entry>
      <entry><systemitem>Alpha</></entry>
      <entry>7.4</entry>
      <entry>Peter Eisentraut (<email>peter_e@gmx.net</email>), 2003-10-25</entry>
      <entry>4.8</entry>
     </row>
2342 2343 2344
     <row>
      <entry><systemitem class="osname">Linux</></entry>
      <entry><systemitem>PlayStation 2</></entry>
2345 2346
      <entry>8.0.0</entry>
      <entry>Chris Mair (<email>list@1006.org</email>), 2005-01-09</entry>
2347
      <entry>requires <option>--disable-spinlocks</option> (works, but very slow)</entry>
2348 2349 2350 2351 2352
     </row>
     <row>
      <entry><systemitem class="osname">NetBSD</></entry>
      <entry><systemitem>Alpha</></entry>
      <entry>7.2</entry>
2353
      <entry>Thomas Thai (<email>tom@minnesota.com</email>), 2001-11-20</entry>
2354 2355
      <entry>1.5W</entry>
     </row>
2356 2357 2358 2359 2360 2361 2362
     <row>
      <entry><systemitem class="osname">NetBSD</></entry>
      <entry><systemitem>arm32</></entry>
      <entry>7.4</entry>
      <entry>Patrick Welche (<email>prlw1@newn.cam.ac.uk</email>), 2003-11-12</entry>
      <entry>1.6ZE/acorn32</entry>
     </row>
2363 2364 2365 2366
     <row>
      <entry><systemitem class="osname">NetBSD</></entry>
      <entry><systemitem>MIPS</></entry>
      <entry>7.2.1</entry>
2367
      <entry>Warwick Hunter (<email>whunter@agile.tv</email>), 2002-06-13</entry>
2368 2369 2370 2371 2372 2373
      <entry>1.5.3</entry>
     </row>
     <row>
      <entry><systemitem class="osname">NetBSD</></entry>
      <entry><systemitem>PowerPC</></entry>
      <entry>7.2</entry>
2374
      <entry>Bill Studenmund (<email>wrstuden@netbsd.org</email>), 2001-11-28</entry>
2375 2376
      <entry>1.5</entry>
     </row>
2377 2378 2379 2380 2381 2382 2383
     <row>
      <entry><systemitem class="osname">NetBSD</></entry>
      <entry><systemitem>Sparc</></entry>
      <entry>7.4.1</entry>
      <entry>Peter Eisentraut (<email>peter_e@gmx.net</email>), 2003-11-26</entry>
      <entry>1.6.1, 32-bit</entry>
     </row>
2384 2385 2386 2387
     <row>
      <entry><systemitem class="osname">NetBSD</></entry>
      <entry><systemitem>VAX</></entry>
      <entry>7.1</entry>
2388
      <entry>Tom I. Helbekkmo (<email>tih@kpnQwest.no</email>), 2001-03-30</entry>
2389 2390 2391 2392 2393 2394
      <entry>1.5</entry>
     </row>
     <row>
      <entry><systemitem class="osname">SCO OpenServer</></entry>
      <entry><systemitem>x86</></entry>
      <entry>7.3.1</entry>
2395
      <entry>Shibashish Satpathy (<email>shib@postmark.net</>), 2002-12-11</entry>
2396 2397 2398 2399 2400 2401
      <entry>5.0.4, <command>gcc</>;  see also <filename>doc/FAQ_SCO</filename></entry>
     </row>
     <row>
      <entry><systemitem class="osname">SunOS 4</></entry>
      <entry><systemitem>Sparc</></entry>
      <entry>7.2</entry>
2402
      <entry>Tatsuo Ishii (<email>t-ishii@sra.co.jp</email>), 2001-12-04</entry>
2403 2404 2405 2406 2407 2408 2409 2410
      <entry></entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </sect1>

</chapter>