summaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/pg_config-ref.sgml
diff options
context:
space:
mode:
authorPeter Eisentraut <peter_e@gmx.net>2001-08-28 14:20:28 +0000
committerPeter Eisentraut <peter_e@gmx.net>2001-08-28 14:20:28 +0000
commitf5944af8ba020b26741845c59682e6bd835beb07 (patch)
treeafbfcc4b7fd07e80e475a0338945d76f2d2bb58a /doc/src/sgml/ref/pg_config-ref.sgml
parent3fcea502c49746cd353c9f1827ebb3c5a535a9f0 (diff)
downloadpostgresql-f5944af8ba020b26741845c59682e6bd835beb07.tar.gz
Include directory rearrangement
Client headers are no longer in a subdirectory, since they have been made namespace-clean. Internal libpq headers are in a private subdirectory. Server headers are in a private subdirectory. pg_config has a new option to point there.
Diffstat (limited to 'doc/src/sgml/ref/pg_config-ref.sgml')
-rw-r--r--doc/src/sgml/ref/pg_config-ref.sgml62
1 files changed, 58 insertions, 4 deletions
diff --git a/doc/src/sgml/ref/pg_config-ref.sgml b/doc/src/sgml/ref/pg_config-ref.sgml
index 680418771c..89fc04fbf7 100644
--- a/doc/src/sgml/ref/pg_config-ref.sgml
+++ b/doc/src/sgml/ref/pg_config-ref.sgml
@@ -1,4 +1,4 @@
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.5 2001/03/05 18:42:56 momjian Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.6 2001/08/28 14:20:26 petere Exp $ -->
<refentry id="app-pgconfig">
<docinfo>
@@ -22,6 +22,7 @@
<group choice="req" rep="repeat">
<arg>--bindir</arg>
<arg>--includedir</arg>
+ <arg>--includedir-server</arg>
<arg>--libdir</arg>
<arg>--configure</arg>
<arg>--version</arg>
@@ -32,12 +33,17 @@
<refsect1>
<title>Description</>
<para>
- The <application>pg_config</> utility provides configuration parameters
+ The <application>pg_config</> utility prints configuration parameters
of the currently installed version of <productname>PostgreSQL</>. It is
intended, for example, to be used by software packages that want to interface
- to <productname>PostgreSQL</> in order to find the respective header files
+ to <productname>PostgreSQL</> to facilitate finding the required header files
and libraries.
</para>
+ </refsect1>
+
+
+ <refsect1>
+ <title>Options</title>
<para>
To use <application>pg_config</>, supply one or more of the following options:
@@ -57,7 +63,17 @@
<term>--includedir</>
<listitem>
<para>
- Print the location of C and C++ header files.
+ Print the location of C and C++ header files of the client interfaces.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>--includedir-server</>
+ <listitem>
+ <para>
+ Print the location of C and C++ header files for server
+ programming.
</para>
</listitem>
</varlistentry>
@@ -99,4 +115,42 @@
information is printed in that order, one item per line.
</para>
</refsect1>
+
+
+ <refsect1>
+ <title>Notes</title>
+
+ <para>
+ The option <option>--includedir-server</option> is new in
+ PostgreSQL 7.2. In prior releases, the server include files were
+ installed in the same location as the client headers, which could
+ be queried with the <option>--includedir</option>. To make your
+ package handle both cases, try the newer option first and test the
+ exit status to see whether it succeeded.
+ </para>
+
+ <para>
+ In releases prior to PostgreSQL 7.1, before the
+ <command>pg_config</command> came to be, a method for finding the
+ equivalent configuration information did not exist.
+ </para>
+ </refsect1>
+
+
+ <refsect1>
+ <title>History</title>
+
+ <para>
+ The <command>pg_config</command> utility first appeared in PostgreSQL 7.1.
+ </para>
+ </refsect1>
+
+
+ <refsect1>
+ <title>See Also</title>
+
+ <para>
+ <citetitle>PostgreSQL Programmer's Guide</citetitle>
+ </para>
+ </refsect1>
</refentry>