From 5aaa584f819e2d8d2fb23cdf2174ce6e5628e1f5 Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Mon, 9 Mar 2020 10:53:22 +0900 Subject: [PATCH] Doc: fix some description of environment variables with frontend tools MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This addresses a couple of issues in the documentation: - Description of PG_COLOR was missing for some tools (pg_archivecleanup and pg_test_fsync), while the other descriptions had grammar mistakes. - pgbench supports more environment variables: PGUSER, PGHOST and PGPORT. - vacuumlo, oid2name and pgbench support coloring (HEAD only) Author: Michael Paquier Reviewed-by: Fabien Coelho, Daniel Gustafsson, Juan José Santamaría Flecha Discussion: https://postgr.es/m/20200304075418.GJ2593@paquier.xyz Backpatch-through: 12 --- doc/src/sgml/oid2name.sgml | 7 ++++++ doc/src/sgml/ref/clusterdb.sgml | 4 ++-- doc/src/sgml/ref/createdb.sgml | 4 ++-- doc/src/sgml/ref/createuser.sgml | 4 ++-- doc/src/sgml/ref/dropdb.sgml | 4 ++-- doc/src/sgml/ref/dropuser.sgml | 4 ++-- doc/src/sgml/ref/initdb.sgml | 4 ++-- doc/src/sgml/ref/pg_basebackup.sgml | 4 ++-- doc/src/sgml/ref/pg_checksums.sgml | 4 ++-- doc/src/sgml/ref/pg_controldata.sgml | 4 ++-- doc/src/sgml/ref/pg_dump.sgml | 4 ++-- doc/src/sgml/ref/pg_dumpall.sgml | 4 ++-- doc/src/sgml/ref/pg_isready.sgml | 4 ++-- doc/src/sgml/ref/pg_receivewal.sgml | 4 ++-- doc/src/sgml/ref/pg_recvlogical.sgml | 4 ++-- doc/src/sgml/ref/pg_resetwal.sgml | 4 ++-- doc/src/sgml/ref/pg_restore.sgml | 4 ++-- doc/src/sgml/ref/pg_rewind.sgml | 4 ++-- doc/src/sgml/ref/pg_waldump.sgml | 4 ++-- doc/src/sgml/ref/pgarchivecleanup.sgml | 12 ++++++++++ doc/src/sgml/ref/pgbench.sgml | 31 ++++++++++++++++++++++++++ doc/src/sgml/ref/pgtestfsync.sgml | 11 +++++++++ doc/src/sgml/ref/psql-ref.sgml | 4 ++-- doc/src/sgml/ref/reindexdb.sgml | 4 ++-- doc/src/sgml/ref/vacuumdb.sgml | 4 ++-- doc/src/sgml/vacuumlo.sgml | 7 ++++++ 26 files changed, 110 insertions(+), 42 deletions(-) diff --git a/doc/src/sgml/oid2name.sgml b/doc/src/sgml/oid2name.sgml index c7ebd61c6b..dfe3682739 100644 --- a/doc/src/sgml/oid2name.sgml +++ b/doc/src/sgml/oid2name.sgml @@ -223,6 +223,13 @@ utilities, also uses the environment variables supported by libpq (see ). + + + The environment variable PG_COLOR specifies whether to use + color in diagnostic messages. Possible values are + always, auto and + never. + diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml index d11ac2dc9c..177856ca74 100644 --- a/doc/src/sgml/ref/clusterdb.sgml +++ b/doc/src/sgml/ref/clusterdb.sgml @@ -279,8 +279,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml index 8fc8128bf9..2fca26237e 100644 --- a/doc/src/sgml/ref/createdb.sgml +++ b/doc/src/sgml/ref/createdb.sgml @@ -327,8 +327,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml index abe25f17d0..9d24df8b7a 100644 --- a/doc/src/sgml/ref/createuser.sgml +++ b/doc/src/sgml/ref/createuser.sgml @@ -405,8 +405,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/dropdb.sgml b/doc/src/sgml/ref/dropdb.sgml index f79bbb9a85..28b18bfcb0 100644 --- a/doc/src/sgml/ref/dropdb.sgml +++ b/doc/src/sgml/ref/dropdb.sgml @@ -245,8 +245,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/dropuser.sgml b/doc/src/sgml/ref/dropuser.sgml index 72bb7e8535..f9aab340d3 100644 --- a/doc/src/sgml/ref/dropuser.sgml +++ b/doc/src/sgml/ref/dropuser.sgml @@ -225,8 +225,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index da5c8f5307..a04a180165 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -466,8 +466,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml index fc9ba2e8b0..29bf2f9b97 100644 --- a/doc/src/sgml/ref/pg_basebackup.sgml +++ b/doc/src/sgml/ref/pg_basebackup.sgml @@ -706,8 +706,8 @@ PostgreSQL documentation The environment variable PG_COLOR specifies whether to use - color in diagnostics messages. Possible values are - always, auto, + color in diagnostic messages. Possible values are + always, auto and never. diff --git a/doc/src/sgml/ref/pg_checksums.sgml b/doc/src/sgml/ref/pg_checksums.sgml index 162bafdb33..6baf9deaae 100644 --- a/doc/src/sgml/ref/pg_checksums.sgml +++ b/doc/src/sgml/ref/pg_checksums.sgml @@ -191,8 +191,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/pg_controldata.sgml b/doc/src/sgml/ref/pg_controldata.sgml index abac59aa50..4aae8b193d 100644 --- a/doc/src/sgml/ref/pg_controldata.sgml +++ b/doc/src/sgml/ref/pg_controldata.sgml @@ -73,8 +73,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 4bcd4bdaef..13bd320b31 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -1229,8 +1229,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index 7268be9f3e..f0859896c5 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -701,8 +701,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/pg_isready.sgml b/doc/src/sgml/ref/pg_isready.sgml index 68447b5093..3d5b551b87 100644 --- a/doc/src/sgml/ref/pg_isready.sgml +++ b/doc/src/sgml/ref/pg_isready.sgml @@ -167,8 +167,8 @@ PostgreSQL documentation The environment variable PG_COLOR specifies whether to use - color in diagnostics messages. Possible values are - always, auto, + color in diagnostic messages. Possible values are + always, auto and never. diff --git a/doc/src/sgml/ref/pg_receivewal.sgml b/doc/src/sgml/ref/pg_receivewal.sgml index 177e9211c0..febfc0ba13 100644 --- a/doc/src/sgml/ref/pg_receivewal.sgml +++ b/doc/src/sgml/ref/pg_receivewal.sgml @@ -420,8 +420,8 @@ PostgreSQL documentation The environment variable PG_COLOR specifies whether to use - color in diagnostics messages. Possible values are - always, auto, + color in diagnostic messages. Possible values are + always, auto and never. diff --git a/doc/src/sgml/ref/pg_recvlogical.sgml b/doc/src/sgml/ref/pg_recvlogical.sgml index 4c79f90414..41508fdc1e 100644 --- a/doc/src/sgml/ref/pg_recvlogical.sgml +++ b/doc/src/sgml/ref/pg_recvlogical.sgml @@ -400,8 +400,8 @@ PostgreSQL documentation The environment variable PG_COLOR specifies whether to use - color in diagnostics messages. Possible values are - always, auto, + color in diagnostic messages. Possible values are + always, auto and never. diff --git a/doc/src/sgml/ref/pg_resetwal.sgml b/doc/src/sgml/ref/pg_resetwal.sgml index 8a9e22d050..3b6c32c8d3 100644 --- a/doc/src/sgml/ref/pg_resetwal.sgml +++ b/doc/src/sgml/ref/pg_resetwal.sgml @@ -328,8 +328,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index c6013546a0..e9a145ad6e 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -827,8 +827,8 @@ PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/pg_rewind.sgml b/doc/src/sgml/ref/pg_rewind.sgml index 42d29edd4e..f64d659522 100644 --- a/doc/src/sgml/ref/pg_rewind.sgml +++ b/doc/src/sgml/ref/pg_rewind.sgml @@ -269,8 +269,8 @@ PostgreSQL documentation The environment variable PG_COLOR specifies whether to use - color in diagnostics messages. Possible values are - always, auto, + color in diagnostic messages. Possible values are + always, auto and never. diff --git a/doc/src/sgml/ref/pg_waldump.sgml b/doc/src/sgml/ref/pg_waldump.sgml index 329c10e430..667093f060 100644 --- a/doc/src/sgml/ref/pg_waldump.sgml +++ b/doc/src/sgml/ref/pg_waldump.sgml @@ -223,8 +223,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/pgarchivecleanup.sgml b/doc/src/sgml/ref/pgarchivecleanup.sgml index a3d3538b28..84c2df572a 100644 --- a/doc/src/sgml/ref/pgarchivecleanup.sgml +++ b/doc/src/sgml/ref/pgarchivecleanup.sgml @@ -147,6 +147,18 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E" + + Environment + + + The environment variable PG_COLOR specifies whether to use + color in diagnostic messages. Possible values are + always, auto and + never. + + + + Notes diff --git a/doc/src/sgml/ref/pgbench.sgml b/doc/src/sgml/ref/pgbench.sgml index 4c48a58ed2..41b3880c91 100644 --- a/doc/src/sgml/ref/pgbench.sgml +++ b/doc/src/sgml/ref/pgbench.sgml @@ -883,6 +883,37 @@ pgbench options d + + Environment + + + + PGHOST + PGPORT + PGUSER + + + + Default connection parameters. + + + + + + + This utility, like most other PostgreSQL utilities, + uses the environment variables supported by libpq + (see ). + + + + The environment variable PG_COLOR specifies whether to use + color in diagnostic messages. Possible values are + always, auto and + never. + + + Notes diff --git a/doc/src/sgml/ref/pgtestfsync.sgml b/doc/src/sgml/ref/pgtestfsync.sgml index 501157cb36..c6aa5673f1 100644 --- a/doc/src/sgml/ref/pgtestfsync.sgml +++ b/doc/src/sgml/ref/pgtestfsync.sgml @@ -103,6 +103,17 @@ + + Environment + + + The environment variable PG_COLOR specifies whether to use + color in diagnostic messages. Possible values are + always, auto and + never. + + + See Also diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index 67ecec27cf..402c4b1b26 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -4501,8 +4501,8 @@ $endif PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/reindexdb.sgml b/doc/src/sgml/ref/reindexdb.sgml index 0128118cc7..f6c3d9538b 100644 --- a/doc/src/sgml/ref/reindexdb.sgml +++ b/doc/src/sgml/ref/reindexdb.sgml @@ -380,8 +380,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml index cf7f77ba30..fd1dc140ab 100644 --- a/doc/src/sgml/ref/vacuumdb.sgml +++ b/doc/src/sgml/ref/vacuumdb.sgml @@ -474,8 +474,8 @@ PostgreSQL documentation PG_COLOR - Specifies whether to use color in diagnostics messages. Possible values - are always, auto, + Specifies whether to use color in diagnostic messages. Possible values + are always, auto and never. diff --git a/doc/src/sgml/vacuumlo.sgml b/doc/src/sgml/vacuumlo.sgml index 0b57a77af4..26b764d54b 100644 --- a/doc/src/sgml/vacuumlo.sgml +++ b/doc/src/sgml/vacuumlo.sgml @@ -196,6 +196,13 @@ also uses the environment variables supported by libpq (see ). + + + The environment variable PG_COLOR specifies whether to use + color in diagnostic messages. Possible values are + always, auto and + never. +