|
| 1 | +<!-- $Header --> |
| 2 | + |
| 3 | +<refentry id="app-pg-config"> |
| 4 | + <refmeta> |
| 5 | + <refentrytitle id="app-pg-config-title">pg-config</> |
| 6 | + <refmiscinfo>Application</> |
| 7 | + </refmeta> |
| 8 | + |
| 9 | + <refnamediv> |
| 10 | + <refname>pg-config</> |
| 11 | + <refpurpose>Provides information about the installed version of <productname>PostgreSQL</></> |
| 12 | + </refnamediv> |
| 13 | + |
| 14 | + <refsynopsisdiv> |
| 15 | +<synopsis> |
| 16 | +pg-config --bindir | --includedir | --libdir | --configure | --version |
| 17 | +</synopsis> |
| 18 | + </refsynopsisdiv> |
| 19 | + |
| 20 | + <refsect1> |
| 21 | + <title>Description</> |
| 22 | + <para> |
| 23 | + The <application>pg-config</> stores and provides configuration parameters |
| 24 | + of the currently installed version of <productname>PostgreSQL</>. It is |
| 25 | + intended, for example, to be used by software packages that want to interface |
| 26 | + to <productname>PostgreSQL</> in order to find the respective header files |
| 27 | + and libraries. |
| 28 | + </para> |
| 29 | + |
| 30 | + <para> |
| 31 | + To use <application>pg-config</>, supply one or more of the following options: |
| 32 | + <variablelist> |
| 33 | + <varlistentry> |
| 34 | + <term>--bindir</> |
| 35 | + <listitem> |
| 36 | + <para> |
| 37 | + Print the location of user executables. Use this, for example, to find |
| 38 | + the <application>psql</> program. This is normally also the location |
| 39 | + where the <filename>pg-config</> program resides. |
| 40 | + </para> |
| 41 | + </listitem> |
| 42 | + </varlistentry> |
| 43 | + |
| 44 | + <varlistentry> |
| 45 | + <term>--includedir</> |
| 46 | + <listitem> |
| 47 | + <para> |
| 48 | + Print the location of C and C++ header files. |
| 49 | + </para> |
| 50 | + </listitem> |
| 51 | + </varlistentry> |
| 52 | + |
| 53 | + <varlistentry> |
| 54 | + <term>--libdir</> |
| 55 | + <listitem> |
| 56 | + <para> |
| 57 | + Print the location of object code libraries. |
| 58 | + </para> |
| 59 | + </listitem> |
| 60 | + </varlistentry> |
| 61 | + |
| 62 | + <varlistentry> |
| 63 | + <term>--configure</> |
| 64 | + <listitem> |
| 65 | + <para> |
| 66 | + Print the options that were given to the <filename>configure</> |
| 67 | + script when <productname>PostgreSQL</> was configured for building. |
| 68 | + This can be used to reproduce the identical configuration, or |
| 69 | + to find out with what options a binary package was built. (Note |
| 70 | + however that binary packages often contain vendor-specific custom |
| 71 | + patches.) |
| 72 | + </para> |
| 73 | + </listitem> |
| 74 | + </varlistentry> |
| 75 | + |
| 76 | + <varlistentry> |
| 77 | + <term>--version</> |
| 78 | + <listitem> |
| 79 | + <para> |
| 80 | + Print the version of <productname>PostgreSQL</> and exit. |
| 81 | + </para> |
| 82 | + </listitem> |
| 83 | + </varlistentry> |
| 84 | + </variablelist> |
| 85 | + |
| 86 | + If more than one option (except for <option>--version</>) is given, the |
| 87 | + information is printed in that order, one item per line. |
| 88 | + </para> |
| 89 | + </refsect1> |
| 90 | +</refentry> |