Re: Fwd: Bug#308535: postgresql-client: [psql] manual page does

From: Bruce Momjian <pgman(at)candle(dot)pha(dot)pa(dot)us>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: Martin Pitt <mpitt(at)debian(dot)org>,PostgreSQL Bugs <pgsql-bugs(at)postgresql(dot)org>
Subject: Re: Fwd: Bug#308535: postgresql-client: [psql] manual page does
Date: 2005-05-14 16:40:15
Message-ID: 200505141640.j4EGeFl18594@candle.pha.pa.us
Views: Raw Message | Whole Thread | Download mbox
Thread:
Lists: pgsql-bugs pgsql-docs

Tom Lane wrote:
> Martin Pitt <mpitt(at)debian(dot)org> writes:
> > We recently got the bug report below. Do you agree that documenting
> > ~/.pgpass in psql(1) is a good idea?
>
> On that theory we'd have to replicate large parts of the libpq
> documentation on every one of the "client application" pages,
> which doesn't seem very maintainable. (.pgpass is just the tip
> of the iceberg; the "environment variables" and "SSL support"
> pages are also pretty critical for users to know about.)
>
> I agree that there needs to be some more prominent mention,
> but this doesn't look like the way to do it. Maybe some
> "see also" links?

Have you looked at the current docs? 8.0.3 has this in the second
paragraph of the psql Usage section:

http://www.postgresql.org/docs/8.0/static/app-psql.html

It is also convenient to have a ~/.pgpass file to avoid regularly having
to type in passwords. See Section 27.12 for more information.

This was added in February:

revision 1.133
date: 2005/02/11 04:19:05; author: momjian; state: Exp; lines: +22 -15
Mention that some psql environment variables come from libpq and note
more variables can be found in the libpq manual section.

Mention .pgpass in the psql manual page section dealing with connection
parameters and point to the libpq section for more details.

Is that sufficient?

--
Bruce Momjian | http://candle.pha.pa.us
pgman(at)candle(dot)pha(dot)pa(dot)us | (610) 359-1001
+ If your life is a hard drive, | 13 Roberts Road
+ Christ can be your backup. | Newtown Square, Pennsylvania 19073

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Tom Lane 2005-05-14 18:07:49 Re: [BUGS] Fwd: Bug#308535: postgresql-client: [psql] manual page does not document ~/.pgpass file
Previous Message Andrew Sullivan 2005-05-13 21:07:35 Re: Whence the Opterons?

Browse pgsql-bugs by date

  From Date Subject
Next Message Tom Lane 2005-05-14 18:07:49 Re: [BUGS] Fwd: Bug#308535: postgresql-client: [psql] manual page does not document ~/.pgpass file
Previous Message Celia McInnis 2005-05-14 05:33:19 Re: BUG #1578: ::bit(n) behaves "differently" if applied to bit