diff options
| author | Bruce Momjian <bruce@momjian.us> | 2006-03-01 00:23:33 +0000 |
|---|---|---|
| committer | Bruce Momjian <bruce@momjian.us> | 2006-03-01 00:23:33 +0000 |
| commit | 6853e341328efd75160a8d84d92384d326b7628c (patch) | |
| tree | cadf61b6cdce30377e860703e29607147efb0823 | |
| parent | 3952eecd4ad8d53d9126af99464c04e5a945e983 (diff) | |
| download | postgresql-6853e341328efd75160a8d84d92384d326b7628c.tar.gz postgresql-6853e341328efd75160a8d84d92384d326b7628c.zip | |
Add pg_service.conf documentation for libpq.
| -rw-r--r-- | doc/src/sgml/libpq.sgml | 35 |
1 files changed, 31 insertions, 4 deletions
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 5b0444190ca..acb86f8fc89 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.199 2005/11/04 23:14:00 petere Exp $ +$PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.199.2.1 2006/03/01 00:23:33 momjian Exp $ --> <chapter id="libpq"> @@ -298,9 +298,7 @@ PGconn *PQconnectdb(const char *conninfo); Service name to use for additional parameters. It specifies a service name in <filename>pg_service.conf</filename> that holds additional connection parameters. This allows applications to specify only a service name so connection parameters - can be centrally maintained. See - <filename>share/pg_service.conf.sample</> in the installation - directory for information on how to set up the file. + can be centrally maintained. See <xref linkend="libpq-pgservice">. </para> </listitem> </varlistentry> @@ -3997,6 +3995,35 @@ however.) </sect1> +<sect1 id="libpq-pgservice"> +<title>The Connection Service File</title> + +<indexterm zone="libpq-pgservice"> + <primary>connection service file</primary> +</indexterm> +<indexterm zone="libpq-pgservice"> + <primary>pg_service.conf</primary> +</indexterm> + +<para> +The connection service file allows libpq connection parameters to be +associated with a single service name. That service name can then be +specified by a libpq connection, and the associated settings will be +used. This allows connection parameters to be modified without requiring +a recompile of the libpq application. The service name can also be +specified using the <envar>PGSERVICE</envar> environment variable. +</para> +<para> +To use this feature, copy +<filename>share/pg_service.conf.sample</filename> to +<filename>etc/pg_service.conf</filename> and edit the file to add +service names and parameters. This file can be used for client-only +installs too. The file's location can also be specified by the +<envar>PGSYSCONFDIR</envar> environment variable. +</para> +</sect1> + + <sect1 id="libpq-ssl"> <title>SSL Support</title> |