Clean up markup.

Add new bibliographic references from Paul Aoki. Include libpq++ docs from the old man page in the Programmer's Guide. Update Unix installation info for ODBC.

Clean up markup.
Add new bibliographic references from Paul Aoki. Include libpq++ docs from the old man page in the Programmer's Guide. Update Unix installation info for ODBC.
d98011d8 · Thomas G. Lockhart · 03cb232a · d98011d8 · d98011d8 · d98011d8
Commit d98011d8 authored Oct 10, 1998 by Thomas G. Lockhart
9 changed files
--- a/doc/src/sgml/biblio.sgml
+++ b/doc/src/sgml/biblio.sgml
@@ -317,6 +317,40 @@ The POSTGRES Group
 <!--
 <BIBLIOMISC>&dash;</BIBLIOMISC>
+<BOOKBIBLIO ID="OLSON93">
+2. Olson, Nels Edward.
+     Partial indexing in POSTGRES : research project / by Nels Edward Olson.  
+   1993.
+       UCB   Engin     T7.49.1993 O676
+-->
+<TITLE ID="OLSON93-full">
+Partial indexing in POSTGRES : research project
+</TITLE>
+<TITLEABBREV ID="OLSON93">
+Olson, 1993
+</TITLEABBREV>
+<AUTHORGROUP>
+<AUTHOR>
+<FIRSTNAME>Nels</FIRSTNAME>
+<SURNAME>Olson</SURNAME>
+</AUTHOR>
+</AUTHORGROUP>
+<PUBDATE>1993</PUBDATE>
+<ISSN>UCB Engin T7.49.1993 O676</ISSN>
+<PUBLISHER>
+<PUBLISHERNAME>University  of  California, Berkeley CA</PUBLISHERNAME>
+</PUBLISHER>
+<!--
+</BOOKBIBLIO>
+-->
+</BIBLIOENTRY>
+<BIBLIOENTRY>
+<!--
+<BIBLIOMISC>&dash;</BIBLIOMISC>
 <BOOKBIBLIO ID="ONG90">
 -->
 <TITLE ID="ONG90-full">
@@ -381,6 +415,55 @@ Rowe and Stonebraker, 1987
 <!--
 <BIBLIOMISC>&dash;</BIBLIOMISC>
+<BOOKBIBLIO ID="SESHADRI95">
+1. CONFERENCE PAPER
+   Seshadri, P.; Swami, A.
+     Generalized partial indexes.
+   IN:  Proceedings of the Eleventh International Conference on Data
+   Engineering (Cat. No.95CH35724). (Proceedings of the Eleventh International
+   Conference on Data Engineering (Cat. No.95CH35724)Proceedings of the
+   Eleventh International Conference on Data Engineering, Taipei, Taiwan, 6-10
+   March 1995). Edited by: Yu, P.S.; Chen, A.L.P. Los Alamitos, CA, USA: IEEE
+   Comput. Soc. Press, 1995. p. 420-7.
+http://simon.cs.cornell.edu/home/praveen/papers/partindex.de95.ps.Z
+-->
+<TITLE ID="SESHADRI95-full">
+<ulink url="http://simon.cs.cornell.edu/home/praveen/papers/partindex.de95.ps.Z">
+Generalized partial indexes
+</ulink>
+</TITLE>
+<TITLEABBREV ID="SESHADRI95">
+</TITLEABBREV>
+<AUTHORGROUP>
+<AUTHOR>
+<FIRSTNAME>P.</FIRSTNAME>
+<SURNAME>Seshadri</SURNAME>
+</AUTHOR>
+<AUTHOR>
+<FIRSTNAME>A.</FIRSTNAME>
+<SURNAME>Swami</SURNAME>
+</AUTHOR>
+</AUTHORGROUP>
+<CONFGROUP>
+<CONFDATES>March 1995</CONFDATES>
+<CONFTITLE>Eleventh International Conference on Data Engineering</CONFTITLE>
+</CONFGROUP>
+<PUBDATE>1995</PUBDATE>
+<ISSN>Cat. No.95CH35724</ISSN>
+<PUBLISHER>
+<PUBLISHERNAME>IEEE Computer Society Press</PUBLISHERNAME>
+</PUBLISHER>
+<!--
+</BOOKBIBLIO>
+-->
+</BIBLIOENTRY>
+<BIBLIOENTRY>
+<!--
+<BIBLIOMISC>&dash;</BIBLIOMISC>
 <BOOKBIBLIO ID="STON86">
 -->
 <TITLE ID="STON86-full">
@@ -388,7 +471,6 @@ The Design of <ProductName>Postgres</ProductName>
 </TITLE>
 <TITLEABBREV ID="STON86">
 Stonebraker and Rowe, 1986
-STON86
 </TITLEABBREV>
 <AUTHORGROUP>
 <AUTHOR>
@@ -515,6 +597,42 @@ Stonebraker et al, 1989</TITLEABBREV>
 <!--
 <BIBLIOMISC>&dash;</BIBLIOMISC>
+<BOOKBIBLIO ID="STON89b">
+1. Stonebraker, M.
+     The case for partial indexes (DBMS).
+   SIGMOD Record, Dec. 1989, vol.18, (no.4):4-11.
+http://s2k-ftp.CS.Berkeley.EDU:8000/postgres/papers/ERL-M89-17.pdf
+-->
+<TITLE ID="STON89b-full">
+<ulink url="http://s2k-ftp.CS.Berkeley.EDU:8000/postgres/papers/ERL-M89-17.pdf">
+The case for partial indexes (DBMS)
+</ulink>
+</TITLE>
+<TITLEABBREV ID="STON89b">
+Stonebraker, M, 1989b</TITLEABBREV>
+<AUTHORGROUP>
+<AUTHOR>
+<FIRSTNAME>M.</FIRSTNAME>
+<SURNAME>Stonebraker</SURNAME>
+</AUTHOR>
+</AUTHORGROUP>
+<CONFGROUP>
+<CONFDATES>Dec. 1989</CONFDATES>
+<CONFTITLE>Record 18(no.4):4-11</CONFTITLE>
+<CONFSPONSOR>SIGMOD</CONFSPONSOR>
+<CONFNUM>1989</CONFNUM>
+</CONFGROUP>
+<!--
+</BOOKBIBLIO>
+-->
+</BIBLIOENTRY>
+<BIBLIOENTRY>
+<!--
+<BIBLIOMISC>&dash;</BIBLIOMISC>
 <BOOKBIBLIO ID="STON90a">
 -->
 <TITLE ID="STON90a-full">

--- a/doc/src/sgml/compiler.sgml
+++ b/doc/src/sgml/compiler.sgml
@@ -9,7 +9,7 @@
 <Date>Transcribed 1998-02-12</Date>
 </DocInfo>
-<Title>GCC Default Optimizations</Title>
+<Title><application>gcc</application> Default Optimizations</Title>
 <Para>
 <Note>

--- a/doc/src/sgml/ecpg.sgml
+++ b/doc/src/sgml/ecpg.sgml
--- a/doc/src/sgml/libpgtcl.sgml
+++ b/doc/src/sgml/libpgtcl.sgml
@@ -165,14 +165,13 @@ proc getDBs { {host "localhost"} {port "5432"} } {
 <DATE>1997-12-24</DATE>
 </REFSYNOPSISDIVINFO>
 <SYNOPSIS>
+pg_connect -conninfo <REPLACEABLE CLASS="PARAMETER">connectOptions</REPLACEABLE>
 pg_connect <REPLACEABLE CLASS="PARAMETER">dbName</REPLACEABLE> <OPTIONAL>-host <REPLACEABLE CLASS="PARAMETER">hostName</REPLACEABLE></OPTIONAL>
  <OPTIONAL>-port <REPLACEABLE
  CLASS="PARAMETER">portNumber</REPLACEABLE></OPTIONAL> <OPTIONAL>-tty
  <REPLACEABLE CLASS="PARAMETER">pqtty</REPLACEABLE></OPTIONAL>
  <OPTIONAL>-options <REPLACEABLE
  CLASS="PARAMETER">optionalBackendArgs</REPLACEABLE></OPTIONAL>
-<para>
-pg_connect -conninfo <REPLACEABLE CLASS="PARAMETER">connectOptions</REPLACEABLE>
 </SYNOPSIS>
 <REFSECT2 ID="R2-PGTCL-PGCONNECT-1">
@@ -438,6 +437,8 @@ where the optname is usable as an option in pg_connect -conninfo.
 </REFSECT1INFO>
 <TITLE>Description
 </TITLE>
+<para>
 <FUNCTION>pg_conndefaults</FUNCTION> returns info about the connection
 options available in <FUNCTION>pg_connect -conninfo</FUNCTION> and the
 current default value for each option.

--- a/doc/src/sgml/libpq++.sgml
+++ b/doc/src/sgml/libpq++.sgml
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
--- a/doc/src/sgml/odbc.sgml
+++ b/doc/src/sgml/odbc.sgml
@@ -41,34 +41,41 @@ This could be anything from a text file to an Oracle or
 <productname>Postgres</productname> <acronym>RDBMS</acronym>.
 <Para>
-The backend access come from <acronym>ODBC</acronym> drivers, or vendor specifc drivers that
+The backend access come from <acronym>ODBC</acronym> drivers, 
-allow data access.   <productname>psqlODBC</productname> is such a driver, along with others that are
+or vendor specifc drivers that
+allow data access.   <productname>psqlODBC</productname> is such a driver,
+ along with others that are
 available, such as the OpenLink <acronym>ODBC</acronym> drivers.
 <Para>
-Once you write an <acronym>ODBC</acronym> application, you SHOULD be able to connect to ANY
+Once you write an <acronym>ODBC</acronym> application, 
+you <emphasis>should</emphasis> be able to connect to <emphasis>any</emphasis>
 back end database, regardless of the vendor, as long as the database schema
 is the same.
 <Para>
 For example. you could have <productname>MS SQL Server</productname>
 and <productname>Postgres</productname> servers which have
-exactly the same data.  Using <acronym>ODBC</acronym>, your Windows app would make exactly the
+exactly the same data.  Using <acronym>ODBC</acronym>, 
-same calls and the back end data source would look the same (to the windows
+your Windows app would make exactly the
+same calls and the back end data source would look the same (to the Windows
 app).
 <para>
-<ulink url="http://www.insightdist.com/">Insight Distributors</ulink> provides active and ongoing
+<ulink url="http://www.insightdist.com/">Insight Distributors</ulink> 
-support for the core <productname>psqlODBC</productname> distribution. They provide a
+provides active and ongoing
-<ulink url="http://www.insightdist.com/psqlodbc/"><acronym>FAQ</acronym></ulink>, ongoing development
+support for the core <productname>psqlODBC</productname> distribution. 
-on the code base, and actively participate on the 
+They provide a
+<ulink url="http://www.insightdist.com/psqlodbc/"><acronym>FAQ</acronym></ulink>,
+ ongoing development on the code base, and actively participate on the 
 <ulink url="mailto:interfaces@postgresql.org">interfaces mailing list</ulink>.
 <sect1>
 <title><productname>Windows</productname> Applications</title>
 <Para>
-In the real world, differences in drivers and the level of <acronym>ODBC</acronym> support
+In the real world, differences in drivers and the level of 
+<acronym>ODBC</acronym> support
 lessens the potential of <acronym>ODBC</acronym>:
 <SimpleList>
@@ -76,7 +83,8 @@ lessens the potential of <acronym>ODBC</acronym>:
 Access, Delphi, and Visual Basic all support <acronym>ODBC</acronym> directly.
 <Member>
-Under C++, such as Visual C++, you can use the C++ <acronym>ODBC</acronym> <acronym>API</acronym>.
+Under C++, such as Visual C++, 
+you can use the C++ <acronym>ODBC</acronym> <acronym>API</acronym>.
 <Member>
 In Visual C++, you can use the CRecordSet class, which wraps the 
@@ -88,24 +96,27 @@ Windows C++ development under Windows NT.
 <Para>
 If I write an app for <productname>Postgres</productname> 
 can I write it using <acronym>ODBC</acronym> calls
-to the <productname>Postgres</productname> server, or is that only when another database program 
+to the <productname>Postgres</productname> server, 
+or is that only when another database program 
 like MS SQL Server or Access needs to access the data?
 <Para>
-Again, the <acronym>ODBC</acronym> <acronym>API</acronym> set is the way to go.
+Again, the <acronym>ODBC</acronym> <acronym>API</acronym> set 
-You can find out more at
+is the way to go.
-Microsoft's web site or in your Visual C++ docs (if that's what you are using.)
+For <productname>Visual C++</productname> you can find out more at
+Microsoft's web site or in your docs.
 <Para>
-Visual Basic and the other RAD tools have Recordset objects that use <acronym>ODBC</acronym>
+Visual Basic and the other RAD tools have Recordset objects 
+that use <acronym>ODBC</acronym>
 directly to access data.  Using the data-aware controls, you can quickly
-link to the <acronym>ODBC</acronym> back end database (<Emphasis>very</Emphasis> quickly).
+link to the <acronym>ODBC</acronym> back end database 
+(<Emphasis>very</Emphasis> quickly).
 <Para>
 Playing around with MS Access will help you sort this out.  Try using
-File->Get External Data
+<literal>File->Get External Data</literal>.
-<Para>
 <Tip>
 <Para>
 You'll have to set up a DSN first.
@@ -125,21 +136,103 @@ The <productname>Postgres</productname> datetime type will break MS Access.
 <title>Unix Applications</title>
 <para>
-<productname>ApplixWare</productname> has an <acronym>ODBC</acronym> database interface
+<productname>ApplixWare</productname> has an 
-supported on at least some platforms. <productname>ApplixWare</productname> v4.4.1 has been
+<acronym>ODBC</acronym> database interface
+supported on at least some platforms. 
+<productname>ApplixWare</productname> v4.4.1 has been
 demonstrated under Linux with <productname>Postgres</productname> v6.4 
 using the <productname>psqlODBC</productname>
 driver contained in the <productname>Postgres</productname> distribution.
+<sect2>
+<title>Building the Driver</title>
+<para>
+The driver can be built in a standalone, client-only installation, or can be 
+built as a part of the main <productname>Postgres</productname> distribution.
+The standalone installation is convenient if you have <acronym>ODBC</acronym>
+client applications on multiple, heterogeneous platforms. The integrated
+installation is convenient when the target client is the same as the
+server, or when the client and server have similar runtime configurations.
+<sect3>
+<title>Integrated Installation</title>
+<para>
+For an integrated installation, specify the <option>--with-odbc</option>
+command-line argument for src/configure:
+<programlisting>
+./configure --with-odbc
+</programlisting>
+Once configured, the <acronym>ODBC</acronym> driver will be built and installed
+into the areas defined for the other components of the
+<productname>Postgres</productname> system. The installation-wide
+<acronym>ODBC</acronym> configuration file will be placed into
+the top directory of the Postgres target tree (<envar>POSTGRESDIR</envar>).
+This can be overridden from the <application>make</application> command-line
+as
+<programlisting>
+% make ODBCINST=<replaceable>filename</replaceable>
+</programlisting>
+<sect3>
+<title>Standalone Installation</title>
+<para>
+A standalone installation is not integrated with or built on the normal
+<productname>Postgres</productname> distribution. It should be best suited
+for building the <acronym>ODBC</acronym> driver for multiple, heterogeneous
+clients who do not have a locally-installed <productname>Postgres</productname>
+source tree.
+<para>
+The standalone installation distribution can be built from the
+<productname>Postgres</productname> distribution or may be obtained
+from <ulink url="http://insightdist.com/psqlodbc">Insight Distributors</ulink>,
+the current maintainers of the non-Unix sources.
+<para>
+To create a tar file for a complete standalone installation, first
+configure the main <productname>Postgres</productname> distribution.
+Then, create the tar file:
+<programlisting>
+% cd interfaces/odbc
+% make standalone
+</programlisting>
+<para>
+Copy the output tar file to your target system, unpack it into a clean
+directory, and then:
+<programlisting>
+% ./configure --with-odbcinst=<replaceable>instfile</replaceable>
+% make POSTGRESDIR=<replaceable>targettree</replaceable> ODBCINST=<replaceable>instfile</replaceable>
+</programlisting>
+<note>
+<para>
+The <envar>ODBCINST</envar> can be specified on either or both command lines.
+</note>
+<para>
+If you would like to install components into different trees, then you
+can specify various destinations explicitly:
+<programlisting>
+% make BINDIR=<replaceable>bindir</replaceable> LIBDIR=<replaceable>libdir</replaceable> HEADERDIR=<replaceable>headerdir</replaceable> ODBCINST=<replaceable>instfile</replaceable>
+</programlisting>
 <sect2>
 <title>Configuration Files</title>
 <para>
-The <filename>~/.odbc.ini</filename> contains user-specified access information 
+<filename>~/.odbc.ini</filename> contains user-specified access information 
-for the <productname>psqlODBC</productname>
+for the <productname>psqlODBC</productname> driver. 
-driver. The file uses conventions typical for <productname>Windows</productname> 
+The file uses conventions typical for <productname>Windows</productname> 
-Registry files, but despite this
+Registry files, but despite this restriction can be made to work.
-restriction can be made to work.
 <para>
 Here is an example <filename>.odbc.ini</filename> file, 

--- a/doc/src/sgml/ports.sgml
+++ b/doc/src/sgml/ports.sgml
@@ -115,7 +115,7 @@
    <ENTRY>linux 2.0.x</ENTRY>
    <ENTRY>x86</ENTRY>
    <ENTRY>v6.4</ENTRY>
-    <ENTRY>1998-09-14</ENTRY>
+    <ENTRY>1998-10-09</ENTRY>
    <ENTRY>(<ULink url="mailto:lockhart@alumni.caltech.edu">Thomas Lockhart</ULink>,
 <ULink url="mailto:t-ishii@sra.co.jp">Tatsuo Ishii</ULink>)</ENTRY>
  </ROW>
@@ -165,9 +165,9 @@
  <ROW>
    <ENTRY>SVR4</ENTRY>
    <ENTRY>MIPS</ENTRY>
-    <ENTRY>v6.3</ENTRY>
+    <ENTRY>v6.4</ENTRY>
-    <ENTRY>1998-03-01</ENTRY>
+    <ENTRY>1998-10-08</ENTRY>
-    <ENTRY>similar to v6.2.1; "mostly working" (<ULink url="mailto:ridderbusch.pad@sni.de">Frank Ridderbusch</ULink>)</ENTRY>
+    <ENTRY>no 64-bit int support (<ULink url="mailto:ridderbusch.pad@sni.de">Frank Ridderbusch</ULink>)</ENTRY>
  </ROW>
  <ROW>
    <ENTRY>SVR4 4.4</ENTRY>
@@ -179,21 +179,27 @@
  <ROW>
    <ENTRY>Unixware</ENTRY>
    <ENTRY>x86</ENTRY>
-    <ENTRY>v6.3</ENTRY>
+    <ENTRY>v6.4</ENTRY>
-    <ENTRY>1998-03-01</ENTRY>
+    <ENTRY>1998-10-04</ENTRY>
    <ENTRY>aka UNIVEL (<ULink url="mailto:Bill.Allie@mug.org">Billy G. Allie</ULink>)</ENTRY>
  </ROW>
  <ROW>
-    <ENTRY>NextStep</ENTRY>
+    <ENTRY>Windows NT</ENTRY>
    <ENTRY>x86</ENTRY>
-    <ENTRY>v6.x</ENTRY>
+    <ENTRY>v6.4</ENTRY>
-    <ENTRY>1998-03-01</ENTRY>
+    <ENTRY>1998-10-08</ENTRY>
-    <ENTRY>client-only support; v1.0.9 worked with patches (<ULink url="mailto:dave@turbocat.de">David Wetzel</ULink>)</ENTRY>
+    <ENTRY>Mostly working with the Cygwin library. No DLLs yet. <ulink url="mailto:horak@mmp.plzen-city.cz">Horak Daniel</ulink> </ENTRY>
  </ROW>
 </TBODY>
 </TGROUP>
 </TABLE>
+<note>
+<para>
+For <productname>Windows NT</productname>, look for patches on the
+<ulink url="http://postgresql.org">Postgres web site</ulink>.
+</note>
 <Sect1>
 <Title>Unsupported Platforms</Title>
@@ -238,18 +244,18 @@ Others listed here do not provide sufficient library support for an attempt.
    <ENTRY>Amiga, HP300, Mac; not yet working (<ULink url="mailto:hotz@jpl.nasa.gov">Henry Hotz</ULink>)</ENTRY>
  </ROW>
  <ROW>
-    <ENTRY>Ultrix</ENTRY>
+    <ENTRY>NextStep</ENTRY>
-    <ENTRY>MIPS,VAX?</ENTRY>
+    <ENTRY>x86</ENTRY>
    <ENTRY>v6.x</ENTRY>
    <ENTRY>1998-03-01</ENTRY>
-    <ENTRY>no recent reports; obsolete?</ENTRY>
+    <ENTRY>client-only support; v1.0.9 worked with patches (<ULink url="mailto:dave@turbocat.de">David Wetzel</ULink>)</ENTRY>
  </ROW>
  <ROW>
-    <ENTRY>Windows NT</ENTRY>
+    <ENTRY>Ultrix</ENTRY>
-    <ENTRY>all</ENTRY>
+    <ENTRY>MIPS,VAX?</ENTRY>
-    <ENTRY>v6.3</ENTRY>
+    <ENTRY>v6.x</ENTRY>
    <ENTRY>1998-03-01</ENTRY>
-    <ENTRY>not library compatible; client side maybe; use ODBC/JDBC</ENTRY>
+    <ENTRY>no recent reports; obsolete?</ENTRY>
  </ROW>
  <ROW>
    <ENTRY>Windows</ENTRY>

--- a/doc/src/sgml/programmer.sgml
+++ b/doc/src/sgml/programmer.sgml
@@ -55,6 +55,7 @@ $log$
 <!entity spi      SYSTEM "spi.sgml">
 <!entity func-ref SYSTEM "func-ref.sgml">
 <!entity libpq    SYSTEM "libpq.sgml">
+<!entity libpqpp  SYSTEM "libpq++.sgml">
 <!entity libpgtcl SYSTEM "libpgtcl.sgml">
 <!entity ecpg     SYSTEM "ecpg.sgml">
 <!entity odbc     SYSTEM "odbc.sgml">
@@ -135,8 +136,8 @@ Your name here...
 now becoming available in some commercial databases.
 It provides SQL92/SQL3 language support,
 transaction integrity, and type extensibility.
- <ProductName>PostgreSQL</ProductName> is a public-domain, open source descendant
+ <ProductName>PostgreSQL</ProductName> is a public-domain, 
- of this original Berkeley code.
+ open source descendant of this original Berkeley code.
 </Para>
 </Preface>
@@ -151,16 +152,17 @@ It provides SQL92/SQL3 language support,
 &xindex;
 &gist;
 &dfunc;
-&trigger;
-&spi;
 <!-- reference -->
 &func-ref;
+&trigger;
+&spi;
 &lobj;
-&ecpg;
 &libpq;
+&libpqpp;
 &libpgtcl;
+&ecpg;
 &odbc;
 &jdbc;