rdelaage
/
postgresql
mirror of https://git.postgresql.org/git/postgresql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc: fix some description of environment variables with frontend tools 

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
This commit is contained in:
Michael Paquier 2020-03-09 10:53:22 +09:00
parent 806eb92c01
commit 5aaa584f81
26 changed files with 110 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/src/sgml/oid2name.sgml
View File

@ -223,6 +223,13 @@
utilities, also uses the environment variables supported by
<application>libpq</application> (see <xref linkend="libpq-envars"/>).
</para>
<para>
The environment variable <envar>PG_COLOR</envar> specifies whether to use
color in diagnostic messages. Possible values are
<literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</refsect1>
<refsect1>

4
doc/src/sgml/ref/clusterdb.sgml
View File

@ -279,8 +279,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/createdb.sgml
View File

@ -327,8 +327,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/createuser.sgml
View File

@ -405,8 +405,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/dropdb.sgml
View File

@ -245,8 +245,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/dropuser.sgml
View File

@ -225,8 +225,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/initdb.sgml
View File

@ -466,8 +466,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/pg_basebackup.sgml
View File

@ -706,8 +706,8 @@ PostgreSQL documentation
<para>
The environment variable <envar>PG_COLOR</envar> specifies whether to use
color in diagnostics messages. Possible values are
<literal>always</literal>, <literal>auto</literal>,
color in diagnostic messages. Possible values are
<literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</refsect1>

4
doc/src/sgml/ref/pg_checksums.sgml
View File

@ -191,8 +191,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/pg_controldata.sgml
View File

@ -73,8 +73,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/pg_dump.sgml
View File

@ -1229,8 +1229,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/pg_dumpall.sgml
View File

@ -701,8 +701,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/pg_isready.sgml
View File

@ -167,8 +167,8 @@ PostgreSQL documentation
<para>
The environment variable <envar>PG_COLOR</envar> specifies whether to use
color in diagnostics messages. Possible values are
<literal>always</literal>, <literal>auto</literal>,
color in diagnostic messages. Possible values are
<literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</refsect1>

4
doc/src/sgml/ref/pg_receivewal.sgml
View File

@ -420,8 +420,8 @@ PostgreSQL documentation
<para>
The environment variable <envar>PG_COLOR</envar> specifies whether to use
color in diagnostics messages. Possible values are
<literal>always</literal>, <literal>auto</literal>,
color in diagnostic messages. Possible values are
<literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</refsect1>

4
doc/src/sgml/ref/pg_recvlogical.sgml
View File

@ -400,8 +400,8 @@ PostgreSQL documentation
<para>
The environment variable <envar>PG_COLOR</envar> specifies whether to use
color in diagnostics messages. Possible values are
<literal>always</literal>, <literal>auto</literal>,
color in diagnostic messages. Possible values are
<literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</refsect1>

4
doc/src/sgml/ref/pg_resetwal.sgml
View File

@ -328,8 +328,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/pg_restore.sgml
View File

@ -827,8 +827,8 @@
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/pg_rewind.sgml
View File

@ -269,8 +269,8 @@ PostgreSQL documentation
<para>
The environment variable <envar>PG_COLOR</envar> specifies whether to use
color in diagnostics messages. Possible values are
<literal>always</literal>, <literal>auto</literal>,
color in diagnostic messages. Possible values are
<literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</refsect1>

4
doc/src/sgml/ref/pg_waldump.sgml
View File

@ -223,8 +223,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

12
doc/src/sgml/ref/pgarchivecleanup.sgml
View File

@ -147,6 +147,18 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E"
</para>
</refsect1>
<refsect1>
<title>Environment</title>
<para>
The environment variable <envar>PG_COLOR</envar> specifies whether to use
color in diagnostic messages. Possible values are
<literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</refsect1>
<refsect1>
<title>Notes</title>

31
doc/src/sgml/ref/pgbench.sgml
View File

@ -883,6 +883,37 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
</para>
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term><envar>PGHOST</envar></term>
<term><envar>PGPORT</envar></term>
<term><envar>PGUSER</envar></term>
<listitem>
<para>
Default connection parameters.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
This utility, like most other <productname>PostgreSQL</productname> utilities,
uses the environment variables supported by <application>libpq</application>
(see <xref linkend="libpq-envars"/>).
</para>
<para>
The environment variable <envar>PG_COLOR</envar> specifies whether to use
color in diagnostic messages. Possible values are
<literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</refsect1>
<refsect1>
<title>Notes</title>

11
doc/src/sgml/ref/pgtestfsync.sgml
View File

@ -103,6 +103,17 @@
</refsect1>
<refsect1>
<title>Environment</title>
<para>
The environment variable <envar>PG_COLOR</envar> specifies whether to use
color in diagnostic messages. Possible values are
<literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</refsect1>
<refsect1>
<title>See Also</title>

4
doc/src/sgml/ref/psql-ref.sgml
View File

@ -4501,8 +4501,8 @@ $endif
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/reindexdb.sgml
View File

@ -380,8 +380,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

4
doc/src/sgml/ref/vacuumdb.sgml
View File

@ -474,8 +474,8 @@ PostgreSQL documentation
<term><envar>PG_COLOR</envar></term>
<listitem>
<para>
Specifies whether to use color in diagnostics messages. Possible values
are <literal>always</literal>, <literal>auto</literal>,
Specifies whether to use color in diagnostic messages. Possible values
are <literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</listitem>

7
doc/src/sgml/vacuumlo.sgml
View File

@ -196,6 +196,13 @@
also uses the environment variables supported by <application>libpq</application>
(see <xref linkend="libpq-envars"/>).
</para>
<para>
The environment variable <envar>PG_COLOR</envar> specifies whether to use
color in diagnostic messages. Possible values are
<literal>always</literal>, <literal>auto</literal> and
<literal>never</literal>.
</para>
</refsect1>
<refsect1>