c8h4/postgresql
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

More clearly document that most PostgreSQL utilities support libpq

Browse source 
environment variables.  Backpatch to 8.2.X.
This commit is contained in:
Bruce Momjian 2007-02-20 18:10:59 +00:00
parent ecba519d4e
commit 571df93cff
16 changed files with 128 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/src/sgml/ref/clusterdb.sgml
View file

@ -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.19 2007/02/20 18:10:58 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>

10
doc/src/sgml/ref/createdb.sgml
View file

@ -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.43 2007/02/20 18:10:58 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>

14
doc/src/sgml/ref/createlang.sgml
View file

@ -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.39 2007/02/20 18:10:58 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>

10
doc/src/sgml/ref/createuser.sgml
View file

@ -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.46 2007/02/20 18:10:58 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>

10
doc/src/sgml/ref/dropdb.sgml
View file

@ -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.29 2007/02/20 18:10:58 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>

14
doc/src/sgml/ref/droplang.sgml
View file

@ -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.28 2007/02/20 18:10:58 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>

10
doc/src/sgml/ref/dropuser.sgml
View file

@ -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.35 2007/02/20 18:10:58 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>

9
doc/src/sgml/ref/initdb.sgml
View file

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/initdb.sgml,v 1.40 2007/02/01 19:10:24 momjian Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/initdb.sgml,v 1.41 2007/02/20 18:10:58 momjian Exp $
PostgreSQL documentation
-->
@ -291,6 +291,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>

3
doc/src/sgml/ref/pg_controldata.sgml
View file

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.9 2007/01/31 23:26:04 momjian Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.10 2007/02/20 18:10:58 momjian Exp $
PostgreSQL documentation
-->
@ -57,7 +57,6 @@ PostgreSQL documentation
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>

5
doc/src/sgml/ref/pg_ctl-ref.sgml
View file

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.38 2007/01/31 23:26:04 momjian Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.39 2007/02/20 18:10:58 momjian Exp $
PostgreSQL documentation
-->
@ -357,6 +357,9 @@ PostgreSQL documentation
<para>
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>

14
doc/src/sgml/ref/pg_dump.sgml
View file

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.95 2007/02/20 15:01:17 momjian Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.96 2007/02/20 18:10:58 momjian Exp $
PostgreSQL documentation
-->
@ -683,6 +683,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">
@ -693,7 +700,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>
@ -866,7 +875,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>

14
doc/src/sgml/ref/pg_dumpall.sgml
View file

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.65 2007/02/01 04:39:33 neilc Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.66 2007/02/20 18:10:58 momjian Exp $
PostgreSQL documentation
-->
@ -403,6 +403,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>
@ -458,9 +465,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>

14
doc/src/sgml/ref/pg_restore.sgml
View file

@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.68 2007/02/20 15:01:17 momjian Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.69 2007/02/20 18:10:58 momjian Exp $ -->
<refentry id="APP-PGRESTORE">
<refmeta>
@ -508,6 +508,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>
@ -520,7 +527,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>
@ -680,7 +689,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>

9
doc/src/sgml/ref/psql-ref.sgml
View file

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.183 2007/02/01 19:10:24 momjian Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.184 2007/02/20 18:10:58 momjian Exp $
PostgreSQL documentation
-->
@ -2697,10 +2697,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>

9
doc/src/sgml/ref/reindexdb.sgml
View file

@ -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>

11
doc/src/sgml/ref/vacuumdb.sgml
View file

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.38 2007/01/31 23:26:04 momjian Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.39 2007/02/20 18:10:59 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>