aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorPeter Eisentraut <peter@eisentraut.org>2024-05-15 13:05:30 +0200
committerPeter Eisentraut <peter@eisentraut.org>2024-05-15 13:06:12 +0200
commit96bc29edfde9b8ad0de573702a6b1c55f73ce912 (patch)
tree77b4ce1abfd0d359fe297c785d5cbc8c70a95b42 /doc/src
parentcff942453f21ad13db28d820711a45ec94e856a2 (diff)
downloadpostgresql-96bc29edfde9b8ad0de573702a6b1c55f73ce912.tar.gz
postgresql-96bc29edfde9b8ad0de573702a6b1c55f73ce912.zip
doc: Add standard Environment section to pg_upgrade ref page
Reviewed-by: Daniel Gustafsson <daniel@yesql.se> Discussion: https://www.postgresql.org/message-id/flat/8458c9c5-18f1-46d7-94c4-1c30e4f44908%40eisentraut.org
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/ref/pgupgrade.sgml98
1 files changed, 98 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/pgupgrade.sgml b/doc/src/sgml/ref/pgupgrade.sgml
index 10c842adb14..9877f2f01c6 100644
--- a/doc/src/sgml/ref/pgupgrade.sgml
+++ b/doc/src/sgml/ref/pgupgrade.sgml
@@ -940,6 +940,104 @@ psql --username=postgres --file=script.sql postgres
</refsect1>
<refsect1>
+ <title>Environment</title>
+
+ <para>
+ Some environment variables can be used to provide defaults for command-line options:
+
+ <variablelist>
+ <varlistentry>
+ <term><envar>PGBINOLD</envar></term>
+
+ <listitem>
+ <para>
+ The old PostgreSQL executable directory; option
+ <option>-b</option>/<option>--old-bindir</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><envar>PGBINNEW</envar></term>
+
+ <listitem>
+ <para>
+ The new PostgreSQL executable directory; option
+ <option>-B</option>/<option>--new-bindir</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><envar>PGDATAOLD</envar></term>
+
+ <listitem>
+ <para>
+ The old database cluster configuration directory; option
+ <option>-d</option>/<option>--old-datadir</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><envar>PGDATANEW</envar></term>
+
+ <listitem>
+ <para>
+ The new database cluster configuration directory; option
+ <option>-D</option>/<option>--new-datadir</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><envar>PGPORTOLD</envar></term>
+
+ <listitem>
+ <para>
+ The old cluster port number; option
+ <option>-p</option>/<option>--old-port</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><envar>PGPORTNEW</envar></term>
+
+ <listitem>
+ <para>
+ The new cluster port number; option
+ <option>-P</option>/<option>--new-port</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><envar>PGSOCKETDIR</envar></term>
+
+ <listitem>
+ <para>
+ Directory to use for postmaster sockets during upgrade; option
+ <option>-s</option>/<option>--socketdir</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><envar>PGUSER</envar></term>
+
+ <listitem>
+ <para>
+ Cluster's install user name; option
+ <option>-U</option>/<option>--username</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1>
<title>Notes</title>
<para>