From 9314141116e7851a87e760def912fda65b2ddca0 Mon Sep 17 00:00:00 2001
From: Peter Eisentraut
Date: Sat, 26 Aug 2000 13:08:16 +0000
Subject: Add pg-config utility that stores some configuration parameters other
 packages can use to configure their build.

E.g.,
$ pg-config --libdir
/usr/local/pgsql/lib

`pg-config --configure' stores the configure command line.
---
 doc/src/sgml/Makefile               |  3 +-
 doc/src/sgml/ref/allfiles.sgml      |  3 +-
 doc/src/sgml/ref/commands.sgml      |  3 +-
 doc/src/sgml/ref/pg-config-ref.sgml | 90 +++++++++++++++++++++++++++++++++++++
 4 files changed, 96 insertions(+), 3 deletions(-)
 create mode 100644 doc/src/sgml/ref/pg-config-ref.sgml

(limited to 'doc/src')

diff --git a/doc/src/sgml/Makefile b/doc/src/sgml/Makefile
index f9bf7b831fd..fd4af312523 100644
--- a/doc/src/sgml/Makefile
+++ b/doc/src/sgml/Makefile
@@ -8,7 +8,7 @@
 #
 #
 # IDENTIFICATION
-#    $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.17 2000/07/21 00:44:11 petere Exp $
+#    $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.18 2000/08/26 13:08:14 petere Exp $
 #
 #----------------------------------------------------------------------------
 
@@ -78,6 +78,7 @@ APPLICATIONS= createdb.sgml createlang.sgml createuser.sgml \
 	pg_upgrade.sgml \
 	pgaccess-ref.sgml \
 	pgadmin-ref.sgml \
+	pg-config-ref.sgml \
 	pgctl-ref.sgml \
 	pgtclsh.sgml \
 	pgtksh.sgml \
diff --git a/doc/src/sgml/ref/allfiles.sgml b/doc/src/sgml/ref/allfiles.sgml
index 1acdae9b24f..1bb3a0769d1 100644
--- a/doc/src/sgml/ref/allfiles.sgml
+++ b/doc/src/sgml/ref/allfiles.sgml
@@ -1,5 +1,5 @@
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/allfiles.sgml,v 1.20 2000/07/14 15:27:14 thomas Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/allfiles.sgml,v 1.21 2000/08/26 13:08:15 petere Exp $
 Postgres documentation
 Complete list of usable sgml source files in this directory.
 -->
@@ -120,6 +120,7 @@ Complete list of usable sgml source files in this directory.
 <!entity ipcclean           system "ipcclean.sgml">
 <!entity pgAccess           system "pgaccess-ref.sgml">
 <!entity pgAdmin            system "pgadmin-ref.sgml">
+<!entity pgConfig           system "pg-config-ref.sgml">
 <!entity pgCtl              system "pgctl-ref.sgml">
 <!entity pgDump             system "pg_dump.sgml">
 <!entity pgDumpall          system "pg_dumpall.sgml">
diff --git a/doc/src/sgml/ref/commands.sgml b/doc/src/sgml/ref/commands.sgml
index 28a3e12ab7b..1233c002f45 100644
--- a/doc/src/sgml/ref/commands.sgml
+++ b/doc/src/sgml/ref/commands.sgml
@@ -1,5 +1,5 @@
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/commands.sgml,v 1.27 2000/07/14 15:27:14 thomas Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/commands.sgml,v 1.28 2000/08/26 13:08:15 petere Exp $
 Postgres documentation
 -->
 
@@ -124,6 +124,7 @@ functions supported by <productname>Postgres</productname>.
    &ecpgRef;
    &pgAccess;
    &pgAdmin;
+   &pgConfig;
    &pgCtl;
    &pgDump;
    &pgDumpall;
diff --git a/doc/src/sgml/ref/pg-config-ref.sgml b/doc/src/sgml/ref/pg-config-ref.sgml
new file mode 100644
index 00000000000..72ce46f514e
--- /dev/null
+++ b/doc/src/sgml/ref/pg-config-ref.sgml
@@ -0,0 +1,90 @@
+<!-- $Header -->
+
+<refentry id="app-pg-config">
+ <refmeta>
+  <refentrytitle id="app-pg-config-title">pg-config</>
+  <refmiscinfo>Application</>
+ </refmeta>
+
+ <refnamediv>
+  <refname>pg-config</>
+  <refpurpose>Provides information about the installed version of <productname>PostgreSQL</></>
+ </refnamediv>
+
+ <refsynopsisdiv>
+<synopsis>
+pg-config --bindir | --includedir | --libdir | --configure | --version
+</synopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+  <title>Description</>
+  <para>
+   The <application>pg-config</> stores and provides 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
+   and libraries.
+  </para>
+
+  <para>
+   To use <application>pg-config</>, supply one or more of the following options:
+   <variablelist>
+    <varlistentry>
+     <term>--bindir</>
+     <listitem>
+      <para>
+       Print the location of user executables. Use this, for example, to find
+       the <application>psql</> program. This is normally also the location
+       where the <filename>pg-config</> program resides.       
+      </para>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry>
+     <term>--includedir</>
+     <listitem>
+      <para>
+       Print the location of C and C++ header files.
+      </para>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry>
+     <term>--libdir</>
+     <listitem>
+      <para>
+       Print the location of object code libraries.
+      </para>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry>
+     <term>--configure</>
+     <listitem>
+      <para>
+       Print the options that were given to the <filename>configure</>
+       script when <productname>PostgreSQL</> was configured for building.
+       This can be used to reproduce the identical configuration, or
+       to find out with what options a binary package was built. (Note
+       however that binary packages often contain vendor-specific custom
+       patches.)
+      </para>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry>
+     <term>--version</>
+     <listitem>
+      <para>
+       Print the version of <productname>PostgreSQL</> and exit.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+
+   If more than one option (except for <option>--version</>) is given, the
+   information is printed in that order, one item per line.
+  </para>
+ </refsect1>
+</refentry>
-- 
cgit v1.2.3