2003-11-29 20:52:15 +01:00
|
|
|
<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.17 2003/11/29 19:51:39 pgsql Exp $ -->
|
2000-08-26 15:08:16 +02:00
|
|
|
|
2000-10-20 15:44:39 +02:00
|
|
|
<refentry id="app-pgconfig">
|
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>
|
2001-09-03 14:57:50 +02:00
|
|
|
<refpurpose>retrieve information about the installed version of <productname>PostgreSQL</></refpurpose>
|
2000-08-26 15:08:16 +02:00
|
|
|
</refnamediv>
|
|
|
|
|
2003-08-31 19:32:24 +02:00
|
|
|
<indexterm zone="app-pgconfig">
|
|
|
|
<primary>pg_config</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2000-08-26 15:08:16 +02:00
|
|
|
<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>
|
2001-09-16 18:11:11 +02:00
|
|
|
<arg>--pkglibdir</arg>
|
2000-11-12 00:01:45 +01:00
|
|
|
<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>
|
2002-01-20 23:19:57 +01:00
|
|
|
<term><option>--bindir</option></>
|
2000-08-26 15:08:16 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Print the location of user executables. Use this, for example, to find
|
2003-03-24 15:32:51 +01:00
|
|
|
the <command>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>
|
2002-01-20 23:19:57 +01:00
|
|
|
<term><option>--includedir</option></>
|
2000-08-26 15:08:16 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
Print the location of C header files of the client interfaces.
|
2001-08-28 16:20:28 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-01-20 23:19:57 +01:00
|
|
|
<term><option>--includedir-server</option></>
|
2001-08-28 16:20:28 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
Print the location of C header files for server
|
2001-08-28 16:20:28 +02:00
|
|
|
programming.
|
2000-08-26 15:08:16 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-01-20 23:19:57 +01:00
|
|
|
<term><option>--libdir</option></>
|
2000-08-26 15:08:16 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Print the location of object code libraries.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-09-16 18:11:11 +02:00
|
|
|
<varlistentry>
|
2002-01-20 23:19:57 +01:00
|
|
|
<term><option>--pkglibdir</option></>
|
2001-09-16 18:11:11 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Print the location of dynamically loadable modules, or where
|
|
|
|
the server would search for them. (Other
|
|
|
|
architecture-dependent data files may also be installed in this
|
|
|
|
directory.)
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-08-26 15:08:16 +02:00
|
|
|
<varlistentry>
|
2002-01-20 23:19:57 +01:00
|
|
|
<term><option>--configure</option></>
|
2000-08-26 15:08:16 +02:00
|
|
|
<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>
|
2002-01-20 23:19:57 +01:00
|
|
|
<term><option>--version</option></>
|
2000-08-26 15:08:16 +02:00
|
|
|
<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>
|
2003-03-24 15:32:51 +01:00
|
|
|
The option <option>--includedir-server</option> was new in
|
2002-11-15 04:11:18 +01:00
|
|
|
<productname>PostgreSQL</> 7.2. In prior releases, the server include files were
|
2001-08-28 16:20:28 +02:00
|
|
|
installed in the same location as the client headers, which could
|
2003-03-24 15:32:51 +01:00
|
|
|
be queried with the option <option>--includedir</option>. To make your
|
2001-08-28 16:20:28 +02:00
|
|
|
package handle both cases, try the newer option first and test the
|
|
|
|
exit status to see whether it succeeded.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-11-15 04:11:18 +01:00
|
|
|
In releases prior to <productname>PostgreSQL</> 7.1, before the
|
2001-08-28 16:20:28 +02:00
|
|
|
<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>
|
2002-11-15 04:11:18 +01:00
|
|
|
The <command>pg_config</command> utility first appeared in
|
|
|
|
<productname>PostgreSQL</> 7.1.
|
2001-08-28 16:20:28 +02:00
|
|
|
</para>
|
|
|
|
</refsect1>
|
2000-08-26 15:08:16 +02:00
|
|
|
</refentry>
|
2003-01-19 01:13:31 +01:00
|
|
|
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
|
|
Local variables:
|
|
|
|
mode: sgml
|
|
|
|
sgml-omittag:nil
|
|
|
|
sgml-shorttag:t
|
|
|
|
sgml-minimize-attributes:nil
|
|
|
|
sgml-always-quote-attributes:t
|
|
|
|
sgml-indent-step:1
|
|
|
|
sgml-indent-data:t
|
|
|
|
sgml-parent-document:nil
|
|
|
|
sgml-default-dtd-file:"../reference.ced"
|
|
|
|
sgml-exposed-tags:nil
|
|
|
|
sgml-local-catalogs:"/usr/lib/sgml/catalog"
|
|
|
|
sgml-local-ecat-files:nil
|
|
|
|
End:
|
|
|
|
-->
|