summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorTom Lane2005-08-09 22:47:03 +0000
committerTom Lane2005-08-09 22:47:03 +0000
commitcbd015d71829e825cefde48bf71786d5eb177b94 (patch)
tree19493448d1a0ca944d218c457ccf4a8151736fa0 /doc/src
parentc7bba5e21c25e5b4afda3df7c1a9ef9d7a4584ed (diff)
Extend pg_config to be able to report the build-time values of CC,
CPPFLAGS, CFLAGS, CFLAGS_SL, LDFLAGS, LDFLAGS_SL, and LIBS. Change it so that invoking pg_config with no arguments reports all available information, rather than just giving an error message. Per discussion.
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/ref/pg_config-ref.sgml104
1 files changed, 89 insertions, 15 deletions
diff --git a/doc/src/sgml/ref/pg_config-ref.sgml b/doc/src/sgml/ref/pg_config-ref.sgml
index db09883902f..daf0496290c 100644
--- a/doc/src/sgml/ref/pg_config-ref.sgml
+++ b/doc/src/sgml/ref/pg_config-ref.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.20 2005/06/09 18:15:05 petere Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.21 2005/08/09 22:47:03 tgl Exp $ -->
<refentry id="app-pgconfig">
<refmeta>
@@ -19,16 +19,7 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_config</command>
- <group choice="req" rep="repeat">
- <arg>--bindir</arg>
- <arg>--includedir</arg>
- <arg>--includedir-server</arg>
- <arg>--libdir</arg>
- <arg>--pkglibdir</arg>
- <arg>--pgxs</arg>
- <arg>--configure</arg>
- <arg>--version</arg>
- </group>
+ <arg rep="repeat"><replaceable>option</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -48,7 +39,8 @@
<title>Options</title>
<para>
- To use <application>pg_config</>, supply one or more of the following options:
+ To use <application>pg_config</>, supply one or more of the following
+ options:
<variablelist>
<varlistentry>
<term><option>--bindir</option></>
@@ -125,17 +117,92 @@
</varlistentry>
<varlistentry>
+ <term><option>--cc</option></>
+ <listitem>
+ <para>
+ Print the value of the CC macro that was used for building
+ <productname>PostgreSQL</>. This shows the C compiler used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--cppflags</option></>
+ <listitem>
+ <para>
+ Print the value of the CPPFLAGS macro that was used for building
+ <productname>PostgreSQL</>. This shows C compiler switches needed
+ at preprocessing time (typically, <literal>-I</> switches).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--cflags</option></>
+ <listitem>
+ <para>
+ Print the value of the CFLAGS macro that was used for building
+ <productname>PostgreSQL</>. This shows C compiler switches.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--cflags_sl</option></>
+ <listitem>
+ <para>
+ Print the value of the CFLAGS_SL macro that was used for building
+ <productname>PostgreSQL</>. This shows extra C compiler switches
+ used for building shared libraries.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--ldflags</option></>
+ <listitem>
+ <para>
+ Print the value of the LDFLAGS macro that was used for building
+ <productname>PostgreSQL</>. This shows linker switches.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--ldflags_sl</option></>
+ <listitem>
+ <para>
+ Print the value of the LDFLAGS_SL macro that was used for building
+ <productname>PostgreSQL</>. This shows linker switches
+ used for building shared libraries.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--libs</option></>
+ <listitem>
+ <para>
+ Print the value of the LIBS macro that was used for building
+ <productname>PostgreSQL</>. This normally contains <literal>-l</>
+ switches for external libraries linked into <productname>PostgreSQL</>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>--version</option></>
<listitem>
<para>
- Print the version of <productname>PostgreSQL</> and exit.
+ Print the version of <productname>PostgreSQL</>.
</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.
+ If more than one option is given, the information is printed in that order,
+ one item per line. If no options are given, all available information
+ is printed, with labels.
</para>
</refsect1>
@@ -153,6 +220,13 @@
</para>
<para>
+ The options <option>--cc</option>, <option>--cppflags</option>,
+ <option>--cflags</option>, <option>--cflags_sl</option>,
+ <option>--ldflags</option>, <option>--ldflags_sl</option>,
+ and <option>--libs</option> are new in <productname>PostgreSQL</> 8.1.
+ </para>
+
+ <para>
In releases prior to <productname>PostgreSQL</> 7.1, before
<command>pg_config</command> came to be, a method for finding the
equivalent configuration information did not exist.