.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` 
.    ds C' 
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PG_WRAPPER 1"
.TH PG_WRAPPER 1 "2025-05-07" "Debian" "Debian PostgreSQL infrastructure"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
pg_wrapper \- wrapper for PostgreSQL client commands
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fIclient-program\fR [\fB\-\-cluster\fR \fIversion\fR/\fIcluster\fR] [...]
.PP
(\fIclient-program\fR: \fBpsql\fR, \fBcreatedb\fR, \fBdropuser\fR, and all other client
programs installed in \f(CW\*(C`/usr/lib/postgresql/\*(C'\fR\fIversion\fR\f(CW\*(C`/bin\*(C'\fR).
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This program is run only as a link to names which correspond to PostgreSQL
programs in \f(CW\*(C`/usr/lib/postgresql/\*(C'\fR\fIversion\fR\f(CW\*(C`/bin\*(C'\fR. It determines the
configured cluster and database for the user and calls the appropriate version
of the desired program to connect to that cluster and database, supplying any
specified options to that command.
.PP
The target cluster is selected by the following means, in descending order of
precedence:
.IP "\(bu" 4
explicit specification with the \fB\-\-host\fR option
.IP "\(bu" 4
explicit specification with the \fB\-\-cluster\fR option
.IP "\(bu" 4
if the \fB\s-1PGHOST\s0\fR environment variable is set, no further cluster selection is
performed. The default PostgreSQL version and port number (from the command
line, the environment variable \fB\s-1PGPORT\s0\fR, or default 5432) will be used.
.IP "\(bu" 4
explicit specification with the \fB\s-1PGCLUSTER\s0\fR environment variable
.IP "\(bu" 4
if a port is given (either via \fB\-p\fR, \fB\-\-port\fR, or \fB\s-1PGPORT\s0\fR), and no host is
given, the local cluster matching that port number is used
.IP "\(bu" 4
matching entry in \f(CW\*(C`~/.postgresqlrc\*(C'\fR (see \fBpostgresqlrc\fR\|(5)), if that
file exists
.IP "\(bu" 4
matching entry in \f(CW\*(C`/etc/postgresql\-common/user_clusters\*(C'\fR (see
\&\fBuser_clusters\fR\|(5)), if that file exists
.IP "\(bu" 4
If only one cluster exists on the local system, that one will be selected.
.IP "\(bu" 4
If several clusters exist on the local system, the one listening on the default port 5432
will be selected.
.PP
If none of these rules match, \fBpg_wrapper\fR does not set any environment
variables and the program called will likely error out with a message like
\&\*(L"could not connect to server: Connection refused\*(R".
.PP
For \fBpsql\fR, \fBpg_archivecleanup\fR, and \fBpg_isready\fR, \fBpg_wrapper\fR will always use the binary from
the newest PostgreSQL version installed, as these are downwards compatible.
If the cluster version is older than 9.2, the newest considered binary version is 14.
.PP
Note that \fBpg_wrapper\fR needs to be able to read the server config to get the
port number to connect to. If a non-standard port is configured in a place that
pg_wrapper cannot read, connecting will fail. This particularly holds if the
port was configured via \fB\s-1ALTER SYSTEM\s0\fR in \f(CW\*(C`postgresql.auto.conf\*(C'\fR and
pg_wrapper is invoked as any user other than \fBpostgres\fR and \fBroot\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-cluster\fR \fIversion\fR\fB/\fR\fIcluster\fR" 4
.IX Item "--cluster version/cluster"
.PD 0
.IP "\fB\-\-cluster\fR \fIversion\fR\fB/\fR\fIhost\fR\fB:\fR[\fIport\fR]" 4
.IX Item "--cluster version/host:[port]"
.PD
\&\fIcluster\fR is either the name of a cluster on the local system, or takes the form
\&\fIhost\fR:\fIport\fR for a remote cluster. If \fIport\fR is left empty (i. e. you just
specify \fIhost:\fR), it defaults to 5432.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
.IP "\fB\s-1PGCLUSTER\s0\fR" 4
.IX Item "PGCLUSTER"
If \f(CW$PGCLUSTER\fR is set, its value (of the form \fIversion\fR/\fIcluster\fR)
specifies the desired cluster, similar to the \fB\-\-cluster\fR option. However, if
\&\fB\-\-cluster\fR is specified, it overrides the value of \f(CW$PGCLUSTER\fR.
.IP "\fB\s-1PG_CLUSTER_CONF_ROOT\s0\fR" 4
.IX Item "PG_CLUSTER_CONF_ROOT"
This specifies an alternative base directory for cluster configurations. This
is usually \f(CW\*(C`/etc/postgresql/\*(C'\fR, but for testing/development purposes you can
change this to point to e. g. your home directory, so that you can use the
postgresql-common tools without root privileges.
.IP "\fB\s-1PGSYSCONFDIR\s0\fR" 4
.IX Item "PGSYSCONFDIR"
This is the location of PostgreSQL's and postgresql-common's global
configuration (e. g. \f(CW\*(C`pg_service.conf\*(C'\fR, \fBuser_clusters\fR\|(5)). The default is
\&\f(CW\*(C`/etc/postgresql\-common/\*(C'\fR.
.SH "FILES"
.IX Header "FILES"
.ie n .IP "\*(C`/etc/postgresql\-common/user_clusters\*(C'" 4
.el .IP "\f(CW\*(C`/etc/postgresql\-common/user_clusters\*(C'\fR" 4
.IX Item "/etc/postgresql-common/user_clusters"
stores the default cluster and database for users and groups as set by
the administrators.
.ie n .IP "\*(C`$HOME/.postgresqlrc\*(C'" 4
.el .IP "\f(CW\*(C`$HOME/.postgresqlrc\*(C'\fR" 4
.IX Item "$HOME/.postgresqlrc"
stores defaults set by the user himself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBuser_clusters\fR\|(5), \fBpostgresqlrc\fR\|(5)
.SH "AUTHOR"
.IX Header "AUTHOR"
Martin Pitt <mpitt@debian.org>
