Commit 3a8d83ca authored by Tom Lane's avatar Tom Lane

Doc: clarify location of libpq's default service file on Windows.

The documentation didn't specify the name of the per-user service file
on Windows, and extrapolating from the pattern used for other config
files gave the wrong answer.  The fact that it isn't consistent with the
others sure seems like a bug, but it's far too late to change that now;
we'd just penalize people who worked it out in the past.  So, simply
document the true state of affairs.

In passing, fix some gratuitous differences between the discussions
of the service file and the password file.

Julien Rouhaud, per question from Dominique Devienne.

Backpatch to all supported branches.  I (tgl) also chose to back-patch
the part of commit ba356a39 that touched libpq.sgml's description of
the service file --- in hindsight, I'm not sure why I didn't do so at
the time, as it includes some fairly essential information.

Discussion: https://postgr.es/m/CAFCRh-_mdLrh8eYVzhRzu4c8bAFEBn=rwoHOmFJcQOTsCy5nig@mail.gmail.com
parent 8d9d1286
...@@ -7775,9 +7775,11 @@ myEventProc(PGEventId evtId, void *evtInfo, void *passThrough) ...@@ -7775,9 +7775,11 @@ myEventProc(PGEventId evtId, void *evtInfo, void *passThrough)
<primary><envar>PGSERVICEFILE</envar></primary> <primary><envar>PGSERVICEFILE</envar></primary>
</indexterm> </indexterm>
<envar>PGSERVICEFILE</envar> specifies the name of the per-user <envar>PGSERVICEFILE</envar> specifies the name of the per-user
connection service file. If not set, it defaults connection service file
to <filename>~/.pg_service.conf</filename>
(see <xref linkend="libpq-pgservice"/>). (see <xref linkend="libpq-pgservice"/>).
Defaults to <filename>~/.pg_service.conf</filename>, or
<filename>%APPDATA%\postgresql\.pg_service.conf</filename> on
Microsoft Windows.
</para> </para>
</listitem> </listitem>
...@@ -8077,11 +8079,11 @@ myEventProc(PGEventId evtId, void *evtInfo, void *passThrough) ...@@ -8077,11 +8079,11 @@ myEventProc(PGEventId evtId, void *evtInfo, void *passThrough)
The file <filename>.pgpass</filename> in a user's home directory can The file <filename>.pgpass</filename> in a user's home directory can
contain passwords to contain passwords to
be used if the connection requires a password (and no password has been be used if the connection requires a password (and no password has been
specified otherwise). On Microsoft Windows the file is named specified otherwise). On Microsoft Windows the file is named
<filename>%APPDATA%\postgresql\pgpass.conf</filename> (where <filename>%APPDATA%\postgresql\pgpass.conf</filename> (where
<filename>%APPDATA%</filename> refers to the Application Data subdirectory in <filename>%APPDATA%</filename> refers to the Application Data subdirectory in
the user's profile). the user's profile).
Alternatively, a password file can be specified Alternatively, the password file to use can be specified
using the connection parameter <xref linkend="libpq-connect-passfile"/> using the connection parameter <xref linkend="libpq-connect-passfile"/>
or the environment variable <envar>PGPASSFILE</envar>. or the environment variable <envar>PGPASSFILE</envar>.
</para> </para>
...@@ -8150,8 +8152,12 @@ myEventProc(PGEventId evtId, void *evtInfo, void *passThrough) ...@@ -8150,8 +8152,12 @@ myEventProc(PGEventId evtId, void *evtInfo, void *passThrough)
Service names can be defined in either a per-user service file or a Service names can be defined in either a per-user service file or a
system-wide file. If the same service name exists in both the user system-wide file. If the same service name exists in both the user
and the system file, the user file takes precedence. and the system file, the user file takes precedence.
By default, the per-user service file is located By default, the per-user service file is named
at <filename>~/.pg_service.conf</filename>; this can be overridden by <filename>~/.pg_service.conf</filename>.
On Microsoft Windows, it is named
<filename>%APPDATA%\postgresql\.pg_service.conf</filename> (where
<filename>%APPDATA%</filename> refers to the Application Data subdirectory
in the user's profile). A different file name can be specified by
setting the environment variable <envar>PGSERVICEFILE</envar>. setting the environment variable <envar>PGSERVICEFILE</envar>.
The system-wide file is named <filename>pg_service.conf</filename>. The system-wide file is named <filename>pg_service.conf</filename>.
By default it is sought in the <filename>etc</filename> directory By default it is sought in the <filename>etc</filename> directory
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment