More clearly document that most PostgreSQL utilities support libpq

environment variables.  Backpatch to 8.2.X.

diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml
index 563840d0b3fd7e97c6561c94f916ed86536963be..44025474c13e40b2f5fd8c2767ae988de669d898 100644 (file)
--- a/doc/src/sgml/ref/clusterdb.sgml
+++ b/doc/src/sgml/ref/clusterdb.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.18 2006/09/16 00:30:17 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.18.2.1 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -190,6 +190,13 @@ PostgreSQL documentation
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
+  </para>
+
  </refsect1>
 
 
@@ -235,7 +242,6 @@ PostgreSQL documentation
 
   <simplelist type="inline">
    <member><xref linkend="sql-cluster" endterm="sql-cluster-title"></member>
-   <member>Environment Variables (<xref linkend="libpq-envars">)</member>
   </simplelist>
  </refsect1>
 

diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml
index 0863e9a75af55cefe5599a7366b5392601ea753c..e20addc3fb4379eaf8d997b75c32468fcfdd5f48 100644 (file)
--- a/doc/src/sgml/ref/createdb.sgml
+++ b/doc/src/sgml/ref/createdb.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/createdb.sgml,v 1.42 2006/09/16 00:30:18 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/createdb.sgml,v 1.42.2.1 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -241,6 +241,13 @@ PostgreSQL documentation
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
+  </para>
+
  </refsect1>
 
 
@@ -294,7 +301,6 @@ PostgreSQL documentation
   <simplelist type="inline">
    <member><xref linkend="app-dropdb"></member>
    <member><xref linkend="sql-createdatabase" endterm="sql-createdatabase-title"></member>
-   <member>Environment Variables (<xref linkend="libpq-envars">)</member>
   </simplelist>
  </refsect1>
 

diff --git a/doc/src/sgml/ref/createlang.sgml b/doc/src/sgml/ref/createlang.sgml
index 5f9fac44d19ce735e176131b1e2ec92ba8124fb9..6edaab73c13d6517f1083cb6b5da58a9209507c1 100644 (file)
--- a/doc/src/sgml/ref/createlang.sgml
+++ b/doc/src/sgml/ref/createlang.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/createlang.sgml,v 1.38 2006/09/16 00:30:18 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/createlang.sgml,v 1.38.2.1 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -171,6 +171,13 @@ PostgreSQL documentation
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
+  </para>
+
  </refsect1>
 
 
@@ -181,7 +188,9 @@ PostgreSQL documentation
     Most error messages are self-explanatory. If not, run
     <application>createlang</application> with the <option>--echo</option>
     option and see under the respective <acronym>SQL</acronym> command
-    for details.
+    for details.  Also, any default connection settings and environment
+    variables used by the <application>libpq</application> front-end
+    library will apply.
    </para>
  </refsect1>
 
@@ -216,7 +225,6 @@ PostgreSQL documentation
   <simplelist type="inline">
    <member><xref linkend="app-droplang"></member>
    <member><xref linkend="sql-createlanguage" endterm="sql-createlanguage-title"></member>
-   <member>Environment Variables (<xref linkend="libpq-envars">)</member>
   </simplelist>
  </refsect1>
 

diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml
index 9197ea8a3059beac172b7b8c54c1b097d6c290ce..880053d6b87d2a585bb201ad5e13568ee78f1fc1 100644 (file)
--- a/doc/src/sgml/ref/createuser.sgml
+++ b/doc/src/sgml/ref/createuser.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/createuser.sgml,v 1.45 2006/09/16 00:30:18 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/createuser.sgml,v 1.45.2.1 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -331,6 +331,13 @@ PostgreSQL documentation
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
+  </para>
+
  </refsect1>
 
 
@@ -401,7 +408,6 @@ PostgreSQL documentation
   <simplelist type="inline">
    <member><xref linkend="app-dropuser"></member>
    <member><xref linkend="sql-createrole" endterm="sql-createrole-title"></member>
-   <member>Environment Variables (<xref linkend="libpq-envars">)</member>
   </simplelist>
  </refsect1>
 

diff --git a/doc/src/sgml/ref/dropdb.sgml b/doc/src/sgml/ref/dropdb.sgml
index 8b4198af4d6d3039e1480fa6db6426f3a6736f7a..ea9b91a07d19bac2c6f6a5d31477c2206878b26a 100644 (file)
--- a/doc/src/sgml/ref/dropdb.sgml
+++ b/doc/src/sgml/ref/dropdb.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.28 2006/09/16 00:30:18 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.28.2.1 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -168,6 +168,13 @@ PostgreSQL documentation
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
+  </para>
+
  </refsect1>
 
 
@@ -220,7 +227,6 @@ DROP DATABASE</computeroutput>
   <simplelist type="inline">
    <member><xref linkend="app-createdb"></member>
    <member><xref linkend="sql-dropdatabase" endterm="sql-dropdatabase-title"></member>
-   <member>Environment Variables (<xref linkend="libpq-envars">)</member>
   </simplelist>
  </refsect1>
 

diff --git a/doc/src/sgml/ref/droplang.sgml b/doc/src/sgml/ref/droplang.sgml
index 380d0243b07f23c8ac260fda1af452f19830e162..0128dca7281a2fc50ca3a891e24f63565f2d6de7 100644 (file)
--- a/doc/src/sgml/ref/droplang.sgml
+++ b/doc/src/sgml/ref/droplang.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/droplang.sgml,v 1.27 2006/09/16 00:30:18 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/droplang.sgml,v 1.27.2.1 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -179,6 +179,13 @@ PostgreSQL documentation
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
+  </para>
+
  </refsect1>
 
 
@@ -189,7 +196,9 @@ PostgreSQL documentation
     Most error messages are self-explanatory. If not, run
     <application>droplang</application> with the <option>--echo</option>
     option and see under the respective <acronym>SQL</acronym> command
-    for details.
+    for details.  Also, any default connection settings and environment
+    variables used by the <application>libpq</application> front-end
+    library will apply.
    </para>
  </refsect1>
 
@@ -220,7 +229,6 @@ PostgreSQL documentation
   <simplelist type="inline">
    <member><xref linkend="app-createlang"></member>
    <member><xref linkend="sql-droplanguage" endterm="sql-droplanguage-title"></member>
-   <member>Environment Variables (<xref linkend="libpq-envars">)</member>
   </simplelist>
  </refsect1>
 

diff --git a/doc/src/sgml/ref/dropuser.sgml b/doc/src/sgml/ref/dropuser.sgml
index f103fddaf80daf2a81ed38dc0b9413e727a893fa..95be35529ae17205fe57cdf4a8bb277749ba1f92 100644 (file)
--- a/doc/src/sgml/ref/dropuser.sgml
+++ b/doc/src/sgml/ref/dropuser.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.34 2006/09/16 00:30:18 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.34.2.1 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -171,6 +171,13 @@ PostgreSQL documentation
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
+  </para>
+
  </refsect1>
 
 
@@ -223,7 +230,6 @@ DROP ROLE</computeroutput>
   <simplelist type="inline">
    <member><xref linkend="app-createuser"></member>
    <member><xref linkend="sql-droprole" endterm="sql-droprole-title"></member>
-   <member>Environment Variables (<xref linkend="libpq-envars">)</member>
   </simplelist>
  </refsect1>
 

diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml
index aa34b386ae409d60696174a84107b7f02fb26955..4740a4c72bbbb691633ed769f7b309b579c93107 100644 (file)
--- a/doc/src/sgml/ref/initdb.sgml
+++ b/doc/src/sgml/ref/initdb.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/initdb.sgml,v 1.37 2006/09/16 00:30:18 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/initdb.sgml,v 1.37.2.1 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -280,6 +280,13 @@ PostgreSQL documentation
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
+  </para>
+
  </refsect1>
 
  <refsect1>

diff --git a/doc/src/sgml/ref/pg_controldata.sgml b/doc/src/sgml/ref/pg_controldata.sgml
index ab8d1efddf3825a0fc36dd5ec6a0c0a9bfb72eae..7a7f76158505558d97bde82dd3e1182cc0338526 100644 (file)
--- a/doc/src/sgml/ref/pg_controldata.sgml
+++ b/doc/src/sgml/ref/pg_controldata.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.8 2006/09/16 00:30:19 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.8.2.1 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -57,7 +57,6 @@ PostgreSQL documentation
      </para>
     </listitem>
    </varlistentry>
-
   </variablelist>
  </refsect1>
 </refentry>

diff --git a/doc/src/sgml/ref/pg_ctl-ref.sgml b/doc/src/sgml/ref/pg_ctl-ref.sgml
index df5b3755b5360ad86c3246493bc979d040e534a0..1103349b07c9974641946cbabf1c658ee24f4abf 100644 (file)
--- a/doc/src/sgml/ref/pg_ctl-ref.sgml
+++ b/doc/src/sgml/ref/pg_ctl-ref.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.35 2006/12/02 00:34:52 petere Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.35.2.1 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -341,7 +341,10 @@ PostgreSQL documentation
   </variablelist>
 
   <para>
-   For others, see <xref linkend="app-postgres">.
+   For additional server variables, see <xref linkend="app-postgres">.
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
   </para>
  </refsect1>
 

diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml
index 389ac09995c4c18377fdad1871b677220b0e56f4..313f292661182d2f00399ffcf4f4c2e5e5fb85d1 100644 (file)
--- a/doc/src/sgml/ref/pg_dump.sgml
+++ b/doc/src/sgml/ref/pg_dump.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.92 2006/11/28 22:54:18 tgl Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.92.2.1 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -681,6 +681,13 @@ PostgreSQL documentation
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
+  </para>
+
  </refsect1>
 
  <refsect1 id="app-pgdump-diagnostics">
@@ -691,7 +698,9 @@ PostgreSQL documentation
    <command>SELECT</command> statements. If you have problems running
    <application>pg_dump</application>, make sure you are able to
    select information from the database using, for example, <xref
-   linkend="app-psql">.
+   linkend="app-psql">.  Also, any default connection settings and environment
+   variables used by the <application>libpq</application> front-end
+   library will apply.
   </para>
  </refsect1>
 
@@ -875,7 +884,6 @@ CREATE DATABASE foo WITH TEMPLATE template0;
    <member><xref linkend="app-pg-dumpall"></member>
    <member><xref linkend="app-pgrestore"></member>
    <member><xref linkend="app-psql"></member>
-   <member>Environment Variables (<xref linkend="libpq-envars">)</member>
   </simplelist>
  </refsect1>
 

diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml
index ff23a41511e083c389a8c8868034c98e9c22a24f..5aae695d146b4099a3a24bef2d25b3a9453018d3 100644 (file)
--- a/doc/src/sgml/ref/pg_dumpall.sgml
+++ b/doc/src/sgml/ref/pg_dumpall.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.58.2.1 2007/01/15 17:22:48 neilc Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.58.2.2 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -355,6 +355,13 @@ PostgreSQL documentation
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
+  </para>
+
  </refsect1>
 
 
@@ -410,9 +417,8 @@ PostgreSQL documentation
   <title>See Also</title>
 
   <para>
-    <xref linkend="app-pgdump">.  Check there for details on possible
-    error conditions.  Also see supported environment variables
-    (<xref linkend="libpq-envars">).
+    Check <xref linkend="app-pgdump"> for details on possible
+    error conditions.
   </para>
  </refsect1>   
 

diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml
index e7c4ee036e71e497fe78b2176d4554b56b70802b..85528ed25454ecda0d99dfe8863ae182e1623aa3 100644 (file)
--- a/doc/src/sgml/ref/pg_restore.sgml
+++ b/doc/src/sgml/ref/pg_restore.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.64 2006/11/26 18:11:11 tgl Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.64.2.1 2007/02/20 18:11:17 momjian Exp $ -->
 
 <refentry id="APP-PGRESTORE">
  <refmeta>
@@ -506,6 +506,13 @@
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
+  </para>
+
  </refsect1>
 
 
@@ -518,7 +525,9 @@
    internally executes <acronym>SQL</acronym> statements. If you have
    problems running <application>pg_restore</application>, make sure
    you are able to select information from the database using, for
-   example, <xref linkend="app-psql">.
+   example, <xref linkend="app-psql">.  Also, any default connection
+   settings and environment variables used by the
+   <application>libpq</application> front-end library will apply.
   </para>
  </refsect1>
 
@@ -687,7 +696,6 @@ CREATE DATABASE foo WITH TEMPLATE template0;
    <member><xref linkend="app-pgdump"></member>
    <member><xref linkend="app-pg-dumpall"></member>
    <member><xref linkend="app-psql"></member>
-   <member>Environment Variables (<xref linkend="libpq-envars">)</member>
   </simplelist>
  </refsect1>
 </refentry>

diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml
index 100a3d00a4b7dd9fa3eda1550dd559dc318bb129..990d8d14a0f1ad5e74389b1ad7d98286ae02911b 100644 (file)
--- a/doc/src/sgml/ref/psql-ref.sgml
+++ b/doc/src/sgml/ref/psql-ref.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.175.2.3 2006/12/11 22:48:08 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.175.2.4 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -2680,10 +2680,9 @@ $endif
   </variablelist>
 
   <para>
-   Because <application>psql</application> uses <application>libpq</application>
-   internally, all <application>libpq</application> environment variables are
-   also honored by <application>psql</application>.  For a complete list of those
-   variables, see <xref linkend="libpq-envars">.
+   This utility, like most other <productname>PostgreSQL</> utilities,
+   also uses the environment variables supported by <xref 
+   linkend="libpq-envars" endterm="libpq">.
   </para>
 
  </refsect1>

diff --git a/doc/src/sgml/ref/reindexdb.sgml b/doc/src/sgml/ref/reindexdb.sgml
index 8bf274e322903d38dbeb63d7130aae6afbbab4da..1594df0c2bc503bad7b9e65532ebcea57a7e55b0 100644 (file)
--- a/doc/src/sgml/ref/reindexdb.sgml
+++ b/doc/src/sgml/ref/reindexdb.sgml
@@ -213,6 +213,14 @@ PostgreSQL documentation
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   Because <application>psql</application> uses <application>libpq</application>
+   internally, all <application>libpq</application> environment variables are
+   also honored by <application>psql</application>.  For a complete list of those
+   variables, see <xref linkend="libpq-envars">.
+  </para>
+
  </refsect1>
 
 
@@ -270,7 +278,6 @@ PostgreSQL documentation
 
   <simplelist type="inline">
    <member><xref linkend="sql-reindex" endterm="sql-reindex-title"></member>
-   <member>Environment Variables (<xref linkend="libpq-envars">)</member>
   </simplelist>
  </refsect1>
 

diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml
index bbeb34ff6de6777845f2f0a008fc8ddabc9697d5..df874d2b56fb517400de060c8891c9d89c511fa2 100644 (file)
--- a/doc/src/sgml/ref/vacuumdb.sgml
+++ b/doc/src/sgml/ref/vacuumdb.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.37 2006/09/16 00:30:20 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.37.2.1 2007/02/20 18:11:17 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -235,6 +235,14 @@ PostgreSQL documentation
     </listitem>
    </varlistentry>
   </variablelist>
+
+  <para>
+   Because <application>psql</application> uses <application>libpq</application>
+   internally, all <application>libpq</application> environment variables are
+   also honored by <application>psql</application>.  For a complete list of those
+   variables, see <xref linkend="libpq-envars">.
+  </para>
+
  </refsect1>
 
 
@@ -301,7 +309,6 @@ PostgreSQL documentation
 
   <simplelist type="inline">
    <member><xref linkend="sql-vacuum" endterm="sql-vacuum-title"></member>
-   <member>Environment Variables (<xref linkend="libpq-envars">)</member>
   </simplelist>
  </refsect1>