psql environment doc addition

Started by Andrew Dunstanover 19 years ago2 messagespatches
Jump to latest
#1Andrew Dunstan
andrew@dunslane.net

I was looking the other day for a variable that turned out to be
PGSSLMODE, but the psql docs didn't reveal it to me. I propose to add
the following para to the psql docs to point to additional info on
environment variables. I know it's in the SEE ALSO section, but that
didn't jump out at me, especially on the man page that just says:

SEE ALSO
Environment Variables (the documentation)

Any objections?

cheers

andrew

Index: psql-ref.sgml
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v
retrieving revision 1.172
diff -c -r1.172 psql-ref.sgml
*** psql-ref.sgml       23 Oct 2006 18:10:32 -0000      1.172
--- psql-ref.sgml       21 Nov 2006 14:47:38 -0000
***************
*** 2598,2603 ****
--- 2598,2610 ----
   <refsect1>
    <title>Environment</title>
+   <para>
+     As a <application>libpq</application> application, 
<application>psql</application>
+       is influenced by all the environment variables that influence the
+       <application>libpq</application> library. For a complete list of 
those
+        variables, see <xref linkend="libpq-envars">.
+   </para>
+
    <variablelist>
     <varlistentry>
      <term><envar>PAGER</envar></term>
#2Bruce Momjian
bruce@momjian.us
In reply to: Andrew Dunstan (#1)
Re: psql environment doc addition

I have modified your patch and applied it, attached. It clearly wasn't
clear to have it at the bottom.

---------------------------------------------------------------------------

Andrew Dunstan wrote:

I was looking the other day for a variable that turned out to be
PGSSLMODE, but the psql docs didn't reveal it to me. I propose to add
the following para to the psql docs to point to additional info on
environment variables. I know it's in the SEE ALSO section, but that
didn't jump out at me, especially on the man page that just says:

SEE ALSO
Environment Variables (the documentation)

Any objections?

cheers

andrew

Index: psql-ref.sgml
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v
retrieving revision 1.172
diff -c -r1.172 psql-ref.sgml
*** psql-ref.sgml       23 Oct 2006 18:10:32 -0000      1.172
--- psql-ref.sgml       21 Nov 2006 14:47:38 -0000
***************
*** 2598,2603 ****
--- 2598,2610 ----
<refsect1>
<title>Environment</title>
+   <para>
+     As a <application>libpq</application> application, 
<application>psql</application>
+       is influenced by all the environment variables that influence the
+       <application>libpq</application> library. For a complete list of 
those
+        variables, see <xref linkend="libpq-envars">.
+   </para>
+
<variablelist>
<varlistentry>
<term><envar>PAGER</envar></term>

---------------------------(end of broadcast)---------------------------
TIP 9: In versions below 8.0, the planner will ignore your desire to
choose an index scan if your joining column's datatypes do not
match

--
Bruce Momjian bruce@momjian.us
EnterpriseDB http://www.enterprisedb.com

+ If your life is a hard drive, Christ can be your backup. +

Attachments:

/bjm/difftext/x-diffDownload+8-8