summaryrefslogtreecommitdiff
path: root/doc/src/sgml/installation.sgml
blob: 9e98acb407d205f801beb816a87f7b5894f6109f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
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
735
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
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
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
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
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
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
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
1388
1389
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
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
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
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
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
1523
1524
1525
1526
1527
1528
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
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
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
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.55 2001/09/12 20:57:28 petere Exp $ -->

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

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

 <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
/usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data &gt;logfile 2&gt;&amp;1 &amp;
/usr/local/pgsql/bin/createdb test
/usr/local/pgsql/bin/psql test
</synopsis>
   The long version is the rest of this
   <![%flattext-install-include;[document.]]>
   <![%flattext-install-ignore;[chapter.]]>
  </para>
 </sect1>


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

  <para>
   In general, a modern Unix-compatible platform should be able to run
   PostgreSQL. The platforms that had received explicit testing at the
   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 prerequisites exist for building <productname>PostgreSQL</>:
   <itemizedlist>
    <listitem>
     <indexterm>
      <primary>make</primary>
     </indexterm>

     <para>
      <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 <systemitem class="osname">GNU/Linux</> systems GNU 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>
      If at all possible you should 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><application>gzip</></para>
    </listitem>

    <listitem>
     <indexterm>
      <primary>readline</primary>
     </indexterm>

     <para>
      The <acronym>GNU</> <productname>Readline</> library for comfortable
      line editing and command history retrieval will automatically be used
      if found. You might wish to install it before proceeding, but it is not
      required.  (On <productname>NetBSD</productname>, the
      <filename>libedit</filename> library is
      <productname>readline</productname>-compatible and is used if
      <filename>libreadline</filename> is not found.)
     </para>
    </listitem>

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

     <para>
      <application>Flex</> and <application>Bison</> are
      <emphasis>not</> required when building from a released source
      package because the output files are pre-generated. You will
      need these programs only when building from a CVS tree or when
      the actual scanner and parser definition files were changed. If
      you need them, be sure to get <application>Flex</> 2.5.4 or
      later and <application>Bison</> 1.28 or later. Other <application>yacc</>
      programs can sometimes be used, but doing so requires extra
      efforts and is not recommended. Other <application>lex</> programs will
      definitely not work.
     </para>
    </listitem>

    <listitem>
     <indexterm>
      <primary>installation</primary>
      <secondary>on Windows</secondary>
     </indexterm>
     <para>
      To build on <productname>Windows NT</> or <productname>Windows
      2000</> you need the <productname>Cygwin</> and
      <productname>cygipc</> packages. See the file
      <filename>doc/FAQ_MSWIN</> for details.
     </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">http://www.gnu.org/order/ftp.html</>
   for a list) or at <ulink
   url="ftp://ftp.gnu.org/gnu/">ftp://ftp.gnu.org/gnu/</ulink>.
  </para>

  <para>
   Also check that you have sufficient disk space. You will need about
   30 MB for the source tree during compilation and about 5 MB for the
   installation directory. An empty database takes about 1 MB, later
   it takes about five times the amount of space that a flat text file
   with the same data would take. If you are going to run the
   regression tests you will temporarily need an extra 20 MB. Use the
   <command>df</command> command to check for disk space.
  </para>
 </sect1>

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

  <para>
   The <productname>PostgreSQL</> &version; sources can by obtained from <ulink
   url="ftp://ftp.postgresql.org/pub/postgresql-&version;.tar.gz"
   >ftp://ftp.postgresql.org/pub/postgresql-&version;.tar.gz</ulink>.
   Use a mirror if possible. Then unpack it:
<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> with the <productname>PostgreSQL</> sources
   in the current directory. Change into that directory for the rest
   of the installation procedure.
  </para>
 </sect1>
]]>

 <sect1 id="install-upgrading">
  <title>If You Are Upgrading</title>

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

  <para>
   The internal data storage format changes with new releases of
   <productname>PostgreSQL</>. Therefore, if you are upgrading an
   existing installation that does not have a version number
   <quote>&majorversion;.x</quote>, you must back up and restore your
   data as shown here. 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>

  <procedure>
   <step>
    <para>
     Make sure that your database is not updated during or after the
     backup. This does not affect the integrity of the backup, but the
     changed data would of course not be included. If necessary, edit
     the permissions in the file
     <filename>/usr/local/pgsql/data/pg_hba.conf</> (or equivalent) to
     disallow access from everyone except you.
    </para>
   </step>

   <step>
    <indexterm>
     <primary>pg_dumpall</primary>
    </indexterm>

    <para>
     To dump your database installation, type:
<screen>
<userinput>pg_dumpall &gt; <replaceable>outputfile</></userinput>
</screen>
     If you need to preserve the OIDs (such as when using them as
     foreign keys), then use the <option>-o</option> option when running
     <command>pg_dumpall</>.  <command>pg_dumpall</command> does not
     save large objects.  Check
     <![%flattext-install-include[the <citetitle>Administrator's Guide</>]]>
     <![%flattext-install-ignore[<xref linkend="backup-dump-caveats">]]>
     if you need to do this.
    </para>

    <para>
     Make sure that you use the <command>pg_dumpall</> command
     from the version you are currently running. &version;'s
     <command>pg_dumpall</> should not be used on older databases.
    </para>
   </step>

   <step>
    <para>
     If you are installing the new version at the same location as the
     old one then shut down the old server, at the latest before you
     install the new files:
<screen>
<userinput>kill -INT `cat /usr/local/pgsql/data/postmaster.pid`</>
</screen>
     Versions prior to 7.0 do not have this
     <filename>postmaster.pid</> file. If you are using such a version
     you must find out the process id of the server yourself, for
     example by typing <userinput>ps ax | grep postmaster</>, and
     supply it to the <command>kill</> command.
    </para>

    <para>
     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.
    </para>
   </step>

   <step>
    <para>
     If you are installing in the same place as the old version then
     it is also a good idea to move the old installation out of the
     way, in case you still need it later on. Use a command like this:
<screen>
<userinput>mv /usr/local/pgsql /usr/local/pgsql.old</>
</screen>
    </para>
   </step>
  </procedure>

  <para>
   After you have installed <productname>PostgreSQL</> &version;, create a new database
   directory and start the new server. Remember that you must execute
   these commands while logged in to the special database user account
   (which you already have if you are upgrading).
<programlisting>
<userinput>/usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data</>
<userinput>/usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data</>
</programlisting>
   Finally, restore your data with
<screen>
<userinput>/usr/local/pgsql/bin/psql -d template1 -f <replaceable>outputfile</></userinput>
</screen>
   using the <emphasis>new</> <application>psql</>.
  </para>

  <para>
   You can also install the new version in parallel with the old one
   to decrease the downtime. These topics are discussed at length in
   <![%flattext-install-include[the <citetitle>Administrator's Guide</>,]]>
   <![%flattext-install-ignore[<xref linkend="migration">,]]>
   which you are encouraged
   to read in any case.
  </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 creates several files in the build
    tree to record what it found.
   </para>

   <para>
    The default configuration will build the server and utilities, as
    well as all client applications and interfaces that only require 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.
        </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>--docdir=<replaceable>DIRECTORY</></option></term>
       <listitem>
        <para>
         Documentation files, except <quote>man</> pages, will be
         installed into this directory. The default is
         <filename><replaceable>PREFIX</>/doc</>.
        </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>
     </variablelist>

     <note>
      <para>
       Care has been taken to make it possible to install 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>.  Second, the
       installation layout of the C and C++ header files has been
       reorganized in the 7.2 release.  The public header files of the
       client interfaces are installed into
       <varname>includedir</varname> and are namespace-clean.  The
       internal header files and the server header files are installed
       into private directories under
       <filename><replaceable>includedir</replaceable>/postgresql</filename>.
       See the <citetitle>Programmer's Guide</citetitle> for
       information how to get at the header files for each interface.
      </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 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-locale</option></term>
       <listitem>
        <para>
         Enables locale support. There is a performance penalty
         associated with locale support, but if you are not in an
         English-speaking environment you will most likely need this.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--enable-recode</option></term>
       <listitem>
        <para>
         Enables single-byte character set recode support. See
         <![%flattext-install-include[the <citetitle>Administrator's Guide</citetitle>]]>
         <![%flattext-install-ignore[<xref linkend="recode">]]> about this feature.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--enable-multibyte</option></term>
       <listitem>
        <para>
         Allows the use of multibyte character encodings. This is
         primarily for languages like Japanese, Korean, and Chinese.
         Read 
         <![%flattext-install-include[the <citetitle>Administrator's Guide</citetitle>]]>
         <![%flattext-install-ignore[<xref linkend="multibyte">]]>
         for details.
        </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 message in a language other than
         English.  <replaceable>LANGUAGES</replaceable> is a space
         separated list of codes of the languages that you want
         supported.  (The intersection between your list and the set
         of actually provided translations will be computed
         automatically.)  If you do not specify it, then all available
         translations are installed.
        </para>

        <comment>
         The list of provided translations should be shown somewhere.
        </comment>

        <para>
         To use this option, you will need an implementation of the
         <application>gettext</> API.  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 can download
         an add-on package from here:  <ulink
         url="http://www.postgresql.org/~petere/gettext.html"
         ><systemitem class="resource">http://www.postgresql.org/~petere/gettext.html</></ulink>.  If
         you are using the <application>gettext</> implementation in the GNU 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>

        <comment>
         The download location should be moved.
        </comment>

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

      <varlistentry>
       <term><option>--with-CXX</option></term>
       <listitem>
        <para>
         Build the C++ interface library.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-perl</option></term>
       <listitem>
        <para>
         Build the Perl interface module. The Perl interface
         will be installed at the usual place for Perl modules
         (typically under <filename>/usr/lib/perl</filename>), so you
         must have root access to perform the installation step (see
         <xref linkend="install">). You need to have Perl 5 installed to
         use this option.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-python</option></term>
       <listitem>
        <para>
         Build the Python interface module. You need to have root
         access to be able to install the Python module at its default
         place
         (<filename>/usr/lib/python<replaceable>x</>.<replaceable>y</></>).
         To be able to use this option, you must have Python installed
         and your system needs to support shared libraries. If you
         instead want to build a new complete interpreter binary, you
         will have to do it manually.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-tcl</option></term>
       <listitem>
        <para>
         Builds components that require Tcl/Tk, which are
         <application>libpgtcl</>, <application>pgtclsh</>,
         <application>pgtksh</application>, <application>PgAccess</>,
         and <application>PL/Tcl</>.  But see below about
         <option>--without-tk</>.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--without-tk</option></term>
       <listitem>
        <para>
         If you specify <option>--with-tcl</> and this option, then
         programs that require <productname>Tk</>
         (<application>pgtksh</> and <application>PgAccess</>) will be
         excluded.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-tclconfig=<replaceable>DIRECTORY</replaceable></option></term>
       <term><option>--with-tkconfig=<replaceable>DIRECTORY</replaceable></option></term>
       <listitem>
        <para>
         Tcl/Tk installs the files <filename>tclConfig.sh</filename> and
         <filename>tkConfig.sh</filename> which contain certain
         configuration information that is needed to build modules
         interfacing to Tcl or Tk. These files are normally found
         automatically at their well-known location, but if you want to
         use a different version of Tcl or Tk you can specify the
         directory where to find them.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--enable-pltcl-unknown</option></term>
       <listitem>
        <para>
         Enables enables PL/Tcl unknown support.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--enable-pltcl-utf</option></term>
       <listitem>
        <para>
         Enables enables PL/Tcl <function>Tcl_UtfToExternal</> and <function>Tcl_ExternalToUtf</>
         conversion support. These functions needed for Tcl versions 8.1
         and above for proper handling of 8-bit characters.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--enable-odbc</option></term>
       <listitem>
        <para>
         Build the ODBC driver package.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-odbcinst=<replaceable>DIRECTORY</></option></term>
       <listitem>
        <para>
         Specifies the directory where the ODBC driver will expect its
         <filename>odbcinst.ini</> configuration file. The default is
         <filename>/usr/local/pgsql/etc</filename> or whatever you
         specified as <option>--sysconfdir</option>. A default file
         will be installed there. If you intend to share the
         <filename>odbcinst.ini</> file between several ODBC drivers
         then you may want to use this option.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--with-krb4=<replaceable>DIRECTORY</></option></term>
       <term><option>--with-krb5=<replaceable>DIRECTORY</></option></term>
       <listitem>
        <para>
         Build with support for Kerberos authentication. You can use
         either Kerberos version 4 or 5, but not both. The
         <replaceable>DIRECTORY</> argument specifies the root
         directory of the Kerberos installation;
         <filename>/usr/athena</> is assumed as default. If the
         relevant headers files and libraries are not under a common
         parent directory, then you must use the
         <option>--with-includes</> and <option>--with-libraries</>
         options in addition to this option. If, on the other hand,
         the required files are in a location that is searched by
         default (e.g., <filename>/usr/lib</>), then you can leave off
         the argument.
        </para>

        <para>
         <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>
         The name of the Kerberos service principal.
         <literal>postgres</literal> is the default. There's probably no
         reason to change this.
        </para>
       </listitem>
      </varlistentry>

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

       <term><option>--with-openssl=<replaceable>DIRECTORY</></option></term>
       <listitem>
        <para>
         Build with support for <acronym>SSL</> (encrypted) connections. 
         This requires the <productname>OpenSSL</> package to be installed.
         The <replaceable>DIRECTORY</> argument specifies the
         root directory of the <productname>OpenSSL</> installation; the
         default is <filename>/usr/local/ssl</>.
        </para>

        <para>
         <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-java</option></term>
       <listitem>
        <para>
         Build the <acronym>JDBC</acronym> driver and associated Java
         packages.  This option requires
         <application>Ant</application> to be installed (as well as a
         <acronym>JDK</acronym>, of course).  Refer to the
         <acronym>JDBC</acronym> driver documentation in the
         <citetitle>Programmer's Guide</citetitle> for more
         information.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--enable-syslog</option></term>
       <listitem>
        <para>
         Enables the <productname>PostgreSQL</> server to use the
         <systemitem>syslog</> logging facility. (Using this option does not mean
         that you must log with <systemitem>syslog</> or even that it will be done
         by default, it simply makes it possible to turn this option
         on at run time.)
        </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
	 with any problems that may arise.  Currently, this option is
	 considered of marginal value for production installations, but
	 you should have it on if you are doing development work or
	 running a beta version.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term><option>--enable-cassert</option></term>
       <listitem>
        <para>
	 Enables <firstterm>assertion</> checks in the server, which test for
	 many <quote>can't happen</> conditions.  This is invaluable for
	 code development purposes, but the tests slow things down a little.
	 Also, having the tests turned on won't necessarily enhance the
	 stability of your server!  The assertion checks are not categorized
	 for severity, and so what might be a relatively harmless bug will
	 still lead to postmaster restarts if it triggers an assertion
	 failure.  Currently, this option is not recommended for
         production use, but you should have it on for development work
	 or when running a beta version.
        </para>
       </listitem>
      </varlistentry>
     </variablelist>
   </para>

   <para>
    If you prefer a C or C++ compiler different from the one
    <filename>configure</filename> picks then you can set the
    environment variables <envar>CC</> and <envar>CXX</envar>,
    respectively, to the program of your choice.  Similarly, you can
    override the default compiler flags with the <envar>CFLAGS</envar>
    and <envar>CXXFLAGS</envar> variables.  For example:
<screen>
<userinput>env CC=/opt/bin/gcc CFLAGS='-02 -pipe' ./configure</>
</screen>
   </para>
  </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
    can take anywhere from 5 minutes to half an hour. 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>
    It is possible that some tests fail, due to differences in error
    message wording or floating point results.
    <![%flattext-install-include[The file
    <filename>src/test/regress/README</> and the
    <citetitle>Administrator's Guide</citetitle> contain]]>
    <![%flattext-install-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
     the new files over the old ones then you should have backed up
     your data and shut down the old server by now, as explained in
     <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>
    If you built the Perl or Python interfaces and you were not the
    root user when you executed the above command then that part of
    the installation probably failed. In that case you should become
    the root user and then do
<screen>
<userinput>gmake -C src/interfaces/perl5 install</userinput>
<userinput>gmake -C src/interfaces/python install</userinput>
</screen>
    Due to a quirk in the Perl build environment the first command
    will actually rebuild the complete interface and then install it.
    This is not harmful, just unusual. If you do not have superuser
    access you are on your own: you can still take the required files
    and place them in other directories where Perl or Python can find
    them, but how to do that is left as an exercise.
   </para>

   <para>
    The standard install installs only the header files needed for client
    application development.  If you plan to do any server-side program
    development (such as custom functions or data types written in C),
    then you may want to install the entire <productname>PostgreSQL</>
    include tree into your target include directory.  To do that, enter
<screen>
<userinput>gmake install-all-headers</userinput>
</screen>
    This adds a megabyte or two to the install footprint, and is only
    useful if you don't plan to keep the whole source tree around for
    reference.  (If you do, you can just use the source's include
    directory when building server-side software.)
   </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/interfaces install</>
<userinput>gmake -C doc install</>
</screen>
    </para>
   </formalpara>

   <para>
    To undo the installation use the command <command>gmake
    uninstall</>. However, this will not remove the Perl and Python
    interfaces and it will not remove any directories.
   </para>
  </step>
  </procedure>

  <para>
   After the installation you can make room by removing the built
   files from the source tree with the <command>gmake clean</>
   command. This will preserve the choices made by the configure
   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
   build for several platforms from the same source tree you must do
   this and re-configure for each build.
  </para>

 </sect1>

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

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

   <indexterm>
    <primary>shared libraries</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
    shells (<command>sh</>, <command>ksh</>, <command>bash</>, <command>zsh</>)
<programlisting>
LD_LIBRARY_PATH=/usr/local/pgsql/lib
export LD_LIBRARY_PATH
</programlisting>
    or in <command>csh</> or <command>tcsh</>
<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 the method can
    be found at <ulink
    url="http://www.visi.com/~barr/ldpath.html">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 Linux systems the following is the preferred method, but you
    must have root access. Edit the file <filename>/etc/ld.so.conf</>
    to add a line
<programlisting>
<filename>/usr/local/pgsql/lib</>
</programlisting>
    Then run command <command>/sbin/ldconfig</>.
   </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>
  </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 need to
    add <filename>/usr/local/pgsql/bin</> (or what you set
    <option><literal>--bindir</></> to in <xref linkend="configure">)
    into your <envar>PATH</>. 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=$PATH:/usr/local/pgsql/bin
</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>
     <seealso>man pages</seealso>
    </indexterm>
    To enable your system to find the <application>man</>
    documentation, you need to add a line like the following to a
    shell start-up file:
<programlisting>
MANPATH=$MANPATH:/usr/local/pgsql/man
</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</>, but it
    is not required and the settings can be communicated via command
    line options to most client programs.
   </para>
  </sect2>
 </sect1>


<![%flattext-install-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 <citetitle>Administrator's Guide</>
   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>

   <step>
    <para>
     The previous step should have told you how to start up the
     database server. Do so now. The command should look something
     like
<programlisting>
/usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data
</programlisting>
     This will start the server in the foreground. To put the server
     in the background use something like
<programlisting>
nohup /usr/local/pgsql/bin/postmaster -D /usr/local/pgsql/data \
    &lt;/dev/null &gt;&gt;server.log 2&gt;&amp;1 &lt;/dev/null &amp;
</programlisting>
    </para>

    <para>
     To stop a server running in the background you can type
<programlisting>
kill `cat /usr/local/pgsql/data/postmaster.pid`
</programlisting>
    </para>

    <para>
     In order to allow TCP/IP connections (rather than only Unix
     domain socket ones) you need to pass the <option>-i</> option to
     <filename>postmaster</>.
    </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 <citetitle>Tutorial</> should be your first reading if you
      are completely new to <acronym>SQL</> databases. It should have
      been installed at
      <filename>/usr/local/pgsql/doc/html/tutorial.html</> unless you
      changed the installation directories.
     </para>
    </listitem>

    <listitem>
     <para>
      If you are familiar with database concepts then you want to
      proceed with the <citetitle>Administrator's Guide</citetitle>,
      which contains information about how to set up the database
      server, database users, and authentication. It can be found at
      <filename>/usr/local/pgsql/doc/html/admin.html</>.
     </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 <citetitle>Administrator's
      Guide</citetitle>.
     </para>
    </listitem>

    <listitem>
     <para>
      Run the regression tests against the installed server (using the
      sequential test method). If you didn't run the tests before
      installation, you should definitely do it now. This is also
      explained in the <citetitle>Administrator's Guide</citetitle>.
     </para>
    </listitem>

   </itemizedlist>
  </para>

<!-- do we still ship this? -->
<!--
  <para>
   The documentation is also available in Postscript format. If you
   have a Postscript printer, or have your machine already set up to
   accept Postscript files using a print filter, then to print, for
   example the <citetitle>User's Guide</> simply type
<programlisting>
cd /usr/local/pgsql/doc
gunzip -c user.ps.gz | lpr
</programlisting>
   Here is how you might do it if you have <productname>Ghostscript</>
   installed on your system and are writing to a Laserjet printer.
<programlisting>
gunzip -c user.ps.gz \
    | gs -sDEVICE=laserjet -r300 -q -dNOPAUSE -sOutputFile=- \
    | lpr
</programlisting>
   Printer setups can vary wildly from system to system. If in doubt,
   consult your manuals or your local expert.
  </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
   tests pass.
  </para>

  <note>
   <para>
    If you are having problems with the installation on a supported
    platform, please write to <email>[email protected]</email>
    or <email>[email protected]</email>, not to the people
    listed here.
   </para>
  </note>

    <informaltable>
     <tgroup cols="4">
      <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 4.3.3</></entry>
	<entry><systemitem>RS6000</></entry>
	<entry>7.1</entry>
	<entry>2001-03-21, Gilles Darold (<email>[email protected]</email>)</entry>
        <entry>see also <filename>doc/FAQ_AIX</filename></entry>
       </row>
       <row>
	<entry><systemitem class="osname">BeOS 5.0.4</></entry>
	<entry><systemitem>x86</></entry>
	<entry>7.1</entry>
	<entry>2001-02-26, Cyril Velter (<email>[email protected]</email>)</entry>
        <entry>requires new BONE networking stack</entry>
       </row>
       <row>
	<entry><systemitem class="osname">BSD/OS 4.01</></entry>
	<entry><systemitem>x86</></entry>
	<entry>7.1</entry>
	<entry>2001-03-20, Bruce Momjian (<email>[email protected]</email>)</entry>
        <entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">FreeBSD 4.3</></entry>
	<entry><systemitem>x86</></entry>
	<entry>7.1</entry>
	<entry>2001-03-19, Vince Vielhaber (<email>[email protected]</email>)</entry>
        <entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">HP-UX</></entry>
	<entry><systemitem>PA-RISC</></entry>
	<entry>7.1</entry>
	<entry>2001-03-19, 10.20 Tom Lane (<email>[email protected]</email>),
	       2001-03-22, 11.00, 11i Giles Lean (<email>[email protected]</email>)</entry>
        <entry>32- and 64-bit on 11.00; see also <filename>doc/FAQ_HPUX</filename></entry>
       </row>
       <row>
	<entry><systemitem class="osname">IRIX 6.5.11</></entry>
	<entry><systemitem>MIPS</></entry>
	<entry>7.1</entry>
	<entry>2001-03-22, Robert Bruccoleri (<email>[email protected]</email>)</entry>
	<entry>32-bit compilation model</entry>
       </row>
       <row>
	<entry><systemitem class="osname">Linux 2.2.x</></entry>
	<entry><systemitem>Alpha</></entry>
	<entry>7.1</entry>
	<entry>2001-01-23, Ryan Kirkpatrick (<email>[email protected]</email>)</entry>
	<entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">Linux 2.2.x</></entry>
	<entry><systemitem>armv4l</></entry>
	<entry>7.1</entry>
	<entry>2001-02-22, Mark Knox (<email>[email protected]</email>)</entry>
	<entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">Linux 2.0.x</></entry>
	<entry><systemitem>MIPS</></entry>
	<entry>7.1</entry>
	<entry>2001-03-30, Dominic Eidson (<email>[email protected]</email>)</entry>
	<entry><productname>Cobalt Qube</></entry>
       </row>
       <row>
	<entry><systemitem class="osname">Linux 2.2.18</></entry>
	<entry><systemitem>PPC74xx</></entry>
	<entry>7.1</entry>
	<entry>2001-03-19, Tom Lane (<email>[email protected]</email>)</entry>
	<entry>Apple G3</entry>
       </row>
       <row>
	<entry><systemitem class="osname">Linux</></entry>
	<entry><systemitem>S/390</></entry>
	<entry>7.1</entry>
	<entry>2000-11-17, Neale Ferguson (<email>[email protected]</email>)</entry>
	<entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">Linux 2.2.15</></entry>
	<entry><systemitem>Sparc</></entry>
	<entry>7.1</entry>
	<entry>2001-01-30, Ryan Kirkpatrick (<email>[email protected]</email>)</entry>
	<entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">Linux</></entry>
	<entry><systemitem>x86</></entry>
	<entry>7.1</entry>
	<entry>2001-03-19, Thomas Lockhart (<email>[email protected]</email>)</entry>
	<entry>2.0.x, 2.2.x, 2.4.2</entry>
       </row>
       <row>
	<entry><systemitem class="osname">MacOS X</></entry>
	<entry><systemitem>PPC</></entry>
	<entry>7.1</entry>
	<entry>2000-12-11, Peter Bierman (<email>[email protected]</email>),
	       2000-12-11, Daniel Luke (<email>[email protected]</email>)</entry>
	<entry>Darwin (only) Beta-2 or higher</entry>
       </row>
       <row>
	<entry><systemitem class="osname">NetBSD 1.5</></entry>
	<entry><systemitem>Alpha</></entry>
	<entry>7.1</entry>
	<entry>2001-03-22, Giles Lean (<email>[email protected]</email>)</entry>
	<entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">NetBSD 1.5E</></entry>
	<entry><systemitem>arm32</></entry>
	<entry>7.1</entry>
	<entry>2001-03-21, Patrick Welche (<email>[email protected]</email>)</entry>
	<entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">NetBSD</></entry>
	<entry><systemitem>m68k</></entry>
	<entry>7.0</entry>
	<entry>2000-04-10, Henry B. Hotz (<email>[email protected]</email>)</entry>
	<entry>Mac 8xx</entry>
       </row>
       <row>
	<entry><systemitem class="osname">NetBSD</></entry>
	<entry><systemitem>PPC</></entry>
	<entry>7.1</entry>
	<entry>2001-04-05, Henry B. Hotz (<email>[email protected]</email>)</entry>
	<entry>Mac G4</entry>
       </row>
       <row>
	<entry><systemitem class="osname">NetBSD</></entry>
	<entry><systemitem>Sparc</></entry>
	<entry>7.1</entry>
	<entry>2000-04-05, Matthew Green (<email>[email protected]</email>)</entry>
	<entry>32- and 64-bit builds</entry>
       </row>
       <row>
        <entry><systemitem class="osname">NetBSD 1.5</></entry>
        <entry><systemitem>VAX</></entry>
        <entry>7.1</entry>
        <entry>2001-03-30, Tom I. Helbekkmo (<email>[email protected]</email>)</entry>
        <entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">NetBSD 1.5</></entry>
	<entry><systemitem>x86</></entry>
	<entry>7.1</entry>
	<entry>2001-03-23, Giles Lean (<email>[email protected]</email>)</entry>
	<entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">OpenBSD 2.8</></entry>
	<entry><systemitem>Sparc</></entry>
	<entry>7.1</entry>
	<entry>2001-03-23, Brandon Palmer (<email>[email protected]</email>)</entry>
        <entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">OpenBSD 2.8</></entry>
	<entry><systemitem>x86</></entry>
	<entry>7.1</entry>
	<entry>2001-03-21, Brandon Palmer (<email>[email protected]</email>)</entry>
        <entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">SCO UnixWare 7.1.1</></entry>
	<entry><systemitem>x86</></entry>
	<entry>7.1</entry>
	<entry>2001-03-19, Larry Rosenman (<email>[email protected]</email>)</entry>
	<entry><productname>UDK FS</productname> compiler; see also <filename>doc/FAQ_SCO</filename></entry>
       </row>
       <row>
	<entry><systemitem class="osname">Solaris 2.7-8</></entry>
	<entry><systemitem>Sparc</></entry>
	<entry>7.1</entry>
	<entry>2001-03-22, Marc Fournier (<email>[email protected]</email>),
       2001-03-25, Justin Clift (<email>[email protected]</email>)</entry>
	<entry>see also <filename>doc/FAQ_Solaris</filename></entry>
       </row>
       <row>
	<entry><systemitem class="osname">Solaris 2.8</></entry>
	<entry><systemitem>x86</></entry>
	<entry>7.1</entry>
	<entry>2001-03-27, Mathijs Brands (<email>[email protected]</email>)</entry>
	<entry>see also <filename>doc/FAQ_Solaris</filename></entry>
       </row>
       <row>
	<entry><systemitem class="osname">SunOS 4.1.4</></entry>
	<entry><systemitem>Sparc</></entry>
	<entry>7.1</entry>
	<entry>2001-03-23, Tatsuo Ishii (<email>[email protected]</email>)</entry>
	<entry></entry>
       </row>
       <row>
	<entry><systemitem class="osname">Tru64 UNIX</></entry>
	<entry><systemitem>Alpha</></entry>
	<entry>7.1</entry>
	<entry>2001-03-26, Adriaan Joubert (<email>[email protected]</email>)</entry>
        <entry>4.0-5.0, <command>cc</> and <command>gcc</></entry>
       </row>
       <row>
	<entry><systemitem class="osname">Windows NT/2000</> with <application>Cygwin</></entry>
	<entry><systemitem>x86</></entry>
	<entry>7.1</entry>
	<entry>2001-03-16, Jason Tishler (<email>[email protected]</email>)</entry>
        <entry>with <application>Cygwin</application> tool set, see <filename>doc/FAQ_MSWIN</filename></entry>
       </row>
      </tbody>
     </tgroup>
    </informaltable>

  <formalpara>
   <title>Unsupported Platforms</title>
   <para>
    The following platforms have not been verified to work. Platforms
    listed for version 6.3.x and later should also work with
    &version;, but we did not receive explicit confirmation of such at
    the time this list was compiled. We include these here to let you
    know that these platforms <emphasis>could</> be supported if given
    some attention.
   </para>
  </formalpara>

  <informaltable>
   <tgroup cols="4">
    <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">DGUX 5.4R4.11</></entry>
      <entry><systemitem>m88k</></entry>
      <entry>6.3</entry>
      <entry>1998-03-01, Brian E Gallew (<email>[email protected]</email>)</entry>
      <entry>6.4 probably OK</entry>
     </row>
     <row>
      <entry><systemitem class="osname">MkLinux DR1</></entry>
      <entry><systemitem>PPC750</></entry>
      <entry>7.0</entry>
      <entry>2001-04-03, Tatsuo Ishii (<email>[email protected]</email>)</entry>
      <entry>7.1 needs OS update?</entry>
     </row>
     <row>
      <entry><systemitem class="osname">NextStep</></entry>
      <entry><systemitem>x86</></entry>
      <entry>6.x</entry>
      <entry>1998-03-01, David Wetzel (<email>[email protected]</email>)</entry>
      <entry>bit rot suspected</entry>
     </row>
     <row>
      <entry><systemitem class="osname">QNX 4.25</></entry>
      <entry><systemitem>x86</></entry>
      <entry>7.0</entry>
      <entry>2000-04-01, Dr. Andreas Kardos (<email>[email protected]</email>)</entry>
      <entry>Spinlock code needs work.  See also <filename>doc/FAQ_QNX4</filename>.</entry>
     </row>
     <row>
      <entry><systemitem class="osname">SCO OpenServer 5</></entry>
      <entry><systemitem>x86</></entry>
      <entry>6.5</entry>
      <entry>1999-05-25, Andrew Merrill (<email>[email protected]</>)</entry>
      <entry>7.1 should work, but no reports; see also <filename>doc/FAQ_SCO</filename></entry>
     </row>
     <row>
      <entry><systemitem class="osname">System V R4</></entry>
      <entry><systemitem>m88k</></entry>
      <entry>6.2.1</entry>
      <entry>1998-03-01, Doug Winterburn (<email>[email protected]</email>)</entry>
      <entry>needs new <acronym>TAS</acronym> spinlock code</entry>
     </row>
     <row>
      <entry><systemitem class="osname">System V R4</></entry>
      <entry><systemitem>MIPS</></entry>
      <entry>6.4</entry>
      <entry>1998-10-28, Frank Ridderbusch (<email>[email protected]</email>)</entry>
      <entry>no 64-bit integer</entry>
     </row>
     <row>
      <entry><systemitem class="osname">Ultrix</></entry>
      <entry><systemitem>MIPS</></entry>
      <entry>7.1</entry>
      <entry>2001-03-26</entry>
      <entry><acronym>TAS</acronym> spinlock code not detected</entry>
     </row>
     <row>
      <entry><systemitem class="osname">Ultrix</></entry>
      <entry><systemitem>VAX</></entry>
      <entry>6.x</entry>
      <entry>1998-03-01</entry>
      <entry>No recent reports. Obsolete?</entry>
     </row>
     <row>
      <entry><systemitem class="osname">Windows 9x, ME, NT, 2000</> (native)</entry>
      <entry><systemitem>x86</></entry>
      <entry>7.1</entry>
      <entry>2001-03-26, Magnus Hagander (<email>[email protected]</email>)</entry>
      <entry>
       client-side libraries (<application>libpq</> and <application>psql</>) or ODBC/JDBC, no server-side;
<![%flattext-install-include[see Administrator's Guide]]>
<![%flattext-install-ignore[see <xref linkend="install-win32">]]>
       for instructions
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>

 </sect1>

</chapter>