From 654bd6985df897d3c9eb0be403e44d1871e4e352 Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Mon, 9 Mar 2020 10:54:55 +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/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 | 24 ++++++++++++++++++++++++ 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 ++-- 24 files changed, 89 insertions(+), 42 deletions(-) diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml index b25845ffc67..218094f086d 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 8fc8128bf9c..2fca26237e3 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 abe25f17d01..9d24df8b7a8 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 3fbdb337164..38da0c25034 100644 --- a/doc/src/sgml/ref/dropdb.sgml +++ b/doc/src/sgml/ref/dropdb.sgml @@ -233,8 +233,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 72bb7e8535c..f9aab340d3b 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 da5c8f53075..a04a1801650 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 fc9e222f8d0..37d9efdc284 100644 --- a/doc/src/sgml/ref/pg_basebackup.sgml +++ b/doc/src/sgml/ref/pg_basebackup.sgml @@ -690,8 +690,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 162bafdb331..6baf9deaaea 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 abac59aa500..4aae8b193de 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 4bcd4bdaefe..13bd320b313 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 7268be9f3ef..f0859896c54 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 68447b5093d..3d5b551b87f 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 177e9211c08..febfc0ba135 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 4c79f90414d..41508fdc1e5 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 8a9e22d050f..3b6c32c8d32 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 c6013546a0e..e9a145ad6ea 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 ac142d22fcd..76a0c7327ad 100644 --- a/doc/src/sgml/ref/pg_rewind.sgml +++ b/doc/src/sgml/ref/pg_rewind.sgml @@ -239,8 +239,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 329c10e4303..667093f0601 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 a3d3538b28a..84c2df572a6 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 11fa7c48e02..3c2bcc4c4e8 100644 --- a/doc/src/sgml/ref/pgbench.sgml +++ b/doc/src/sgml/ref/pgbench.sgml @@ -823,6 +823,30 @@ 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 ). + + + Notes diff --git a/doc/src/sgml/ref/pgtestfsync.sgml b/doc/src/sgml/ref/pgtestfsync.sgml index 501157cb369..c6aa5673f14 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 c6c20de2434..cfd0918751f 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -4378,8 +4378,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 25b5a727705..860c579a3f0 100644 --- a/doc/src/sgml/ref/reindexdb.sgml +++ b/doc/src/sgml/ref/reindexdb.sgml @@ -357,8 +357,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 47d93456f86..1c301bb6d7f 100644 --- a/doc/src/sgml/ref/vacuumdb.sgml +++ b/doc/src/sgml/ref/vacuumdb.sgml @@ -456,8 +456,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.