2001-08-28 16:20:28 +02:00
|
|
|
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.6 2001/08/28 14:20:26 petere Exp $ -->
|
2000-08-26 15:08:16 +02:00
|
|
|
|
2000-10-20 15:44:39 +02:00
|
|
|
<refentry id="app-pgconfig">
|
2000-11-12 00:01:45 +01:00
|
|
|
<docinfo>
|
|
|
|
<date>2000-11-11</date>
|
|
|
|
</docinfo>
|
|
|
|
|
2000-08-26 15:08:16 +02:00
|
|
|
<refmeta>
|
2000-11-12 00:01:45 +01:00
|
|
|
<refentrytitle id="app-pgconfig-title">pg_config</refentrytitle>
|
|
|
|
<manvolnum>1</manvolnum>
|
|
|
|
<refmiscinfo>Application</refmiscinfo>
|
2000-08-26 15:08:16 +02:00
|
|
|
</refmeta>
|
|
|
|
|
|
|
|
<refnamediv>
|
2000-11-12 00:01:45 +01:00
|
|
|
<refname>pg_config</refname>
|
|
|
|
<refpurpose>Provides information about the installed version of <productname>PostgreSQL</></refpurpose>
|
2000-08-26 15:08:16 +02:00
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
2000-11-12 00:01:45 +01:00
|
|
|
<cmdsynopsis>
|
|
|
|
<command>pg_config</command>
|
|
|
|
<group choice="req" rep="repeat">
|
|
|
|
<arg>--bindir</arg>
|
|
|
|
<arg>--includedir</arg>
|
2001-08-28 16:20:28 +02:00
|
|
|
<arg>--includedir-server</arg>
|
2000-11-12 00:01:45 +01:00
|
|
|
<arg>--libdir</arg>
|
|
|
|
<arg>--configure</arg>
|
|
|
|
<arg>--version</arg>
|
|
|
|
</group>
|
|
|
|
</cmdsynopsis>
|
2000-08-26 15:08:16 +02:00
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Description</>
|
|
|
|
<para>
|
2001-08-28 16:20:28 +02:00
|
|
|
The <application>pg_config</> utility prints configuration parameters
|
2000-08-26 15:08:16 +02:00
|
|
|
of the currently installed version of <productname>PostgreSQL</>. It is
|
|
|
|
intended, for example, to be used by software packages that want to interface
|
2001-08-28 16:20:28 +02:00
|
|
|
to <productname>PostgreSQL</> to facilitate finding the required header files
|
2000-08-26 15:08:16 +02:00
|
|
|
and libraries.
|
|
|
|
</para>
|
2001-08-28 16:20:28 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Options</title>
|
2000-08-26 15:08:16 +02:00
|
|
|
|
|
|
|
<para>
|
2000-10-11 00:03:31 +02:00
|
|
|
To use <application>pg_config</>, supply one or more of the following options:
|
2000-08-26 15:08:16 +02:00
|
|
|
<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
|
2000-10-11 00:03:31 +02:00
|
|
|
where the <filename>pg_config</> program resides.
|
2000-08-26 15:08:16 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term>--includedir</>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-08-28 16:20:28 +02:00
|
|
|
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.
|
2000-08-26 15:08:16 +02:00
|
|
|
</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>
|
2001-08-28 16:20:28 +02:00
|
|
|
|
|
|
|
|
|
|
|
<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>
|
2000-08-26 15:08:16 +02:00
|
|
|
</refentry>
|