postgresql/doc/src/sgml/ref/pg_config-ref.sgml

<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.5 2001/03/05 18:42:56 momjian Exp $ -->

<refentry id="app-pgconfig">
 <docinfo>
  <date>2000-11-11</date>
 </docinfo>

 <refmeta>
  <refentrytitle id="app-pgconfig-title">pg_config</refentrytitle>
  <manvolnum>1</manvolnum>
  <refmiscinfo>Application</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>pg_config</refname>
  <refpurpose>Provides information about the installed version of <productname>PostgreSQL</></refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <cmdsynopsis>
   <command>pg_config</command>
   <group choice="req" rep="repeat">
    <arg>--bindir</arg>
    <arg>--includedir</arg>
    <arg>--libdir</arg>
    <arg>--configure</arg>
    <arg>--version</arg>
   </group>
  </cmdsynopsis>
 </refsynopsisdiv>

 <refsect1>
  <title>Description</>
  <para>
   The <application>pg_config</> utility 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>