Re: BUG #5103: "pg_ctl -w (re)start" fails with custom unix_socket_directory - Mailing list pgsql-bugs

Michael Renner wrote:
> Alvaro Herrera wrote:
> > Michael Renner wrote:
> >
> >> Mentioning PGHOST in pg_ctl's
> >> manpage/documentation should make this entirely clear for people who
> >> aren't familiar with the extensive environment variables PostgreSQLs
> >> client library can use. [1]
> >
> > Yeah, this has been complained about many, many times.
>
> Usually an indicator that it need's fixing, eh? ;)
>
> >> If this is a viable option I can write a small patch against the
> >> documentation.
> >
> > I think the patch we need here is something that creates a separate
> > manpage for the libpq environment variables, and some kind of note in
> > each and every libpq-using program referring the user to that page.
>
> Looking through the available variables probably only PGHOST seems to be
> of interest for pg_ctl's purposes; psql's manpage already refers to The
> Documentation for further variables and information. What's needed in
> pg_ctl's case is just a pointer for the uninformed, at least for me
> that'd have sufficed.

Based on your suggestion, I have documented the use of PGHOST by pg_ctl
with the attached patch.  I specifically mentioned the socket location.

--
  Bruce Momjian  <bruce@momjian.us>        http://momjian.us
  EnterpriseDB                             http://enterprisedb.com
  PG East:  http://www.enterprisedb.com/community/nav-pg-east-2010.do
  + If your life is a hard drive, Christ can be your backup. +
Index: doc/src/sgml/ref/pg_ctl-ref.sgml
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v
retrieving revision 1.47
diff -c -c -r1.47 pg_ctl-ref.sgml
*** doc/src/sgml/ref/pg_ctl-ref.sgml    10 Dec 2009 06:32:28 -0000    1.47
--- doc/src/sgml/ref/pg_ctl-ref.sgml    22 Feb 2010 22:28:14 -0000
***************
*** 393,406 ****
     </varlistentry>

     <varlistentry>
      <term><envar>PGPORT</envar></term>

      <listitem>
       <para>
!       Default port for <xref linkend="app-psql"> (used by the -w option).
       </para>
      </listitem>
     </varlistentry>
    </variablelist>

    <para>
--- 393,418 ----
     </varlistentry>

     <varlistentry>
+     <term><envar>PGHOST</envar></term>
+
+     <listitem>
+      <para>
+       Default hostname or Unix-domain socket location for <xref
+       linkend="app-psql"> (used by the -w option).
+      </para>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry>
      <term><envar>PGPORT</envar></term>

      <listitem>
       <para>
!       Default port number for <xref linkend="app-psql"> (used by the -w option).
       </para>
      </listitem>
     </varlistentry>
+
    </variablelist>

    <para>
Index: doc/src/sgml/ref/postgres-ref.sgml
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v
retrieving revision 1.51
diff -c -c -r1.51 postgres-ref.sgml
*** doc/src/sgml/ref/postgres-ref.sgml    9 Jul 2007 01:08:09 -0000    1.51
--- doc/src/sgml/ref/postgres-ref.sgml    22 Feb 2010 22:28:14 -0000
***************
*** 579,585 ****

      <listitem>
       <para>
!       Default port (preferably set in the configuration file)
       </para>
      </listitem>
     </varlistentry>
--- 579,585 ----

      <listitem>
       <para>
!       Default port number (preferably set in the configuration file)
       </para>
      </listitem>
     </varlistentry>