mirror of
https://github.com/postgres/postgres.git
synced 2025-04-25 21:42:33 +03:00
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:
parent
806eb92c01
commit
5aaa584f81
@ -223,6 +223,13 @@
|
|||||||
utilities, also uses the environment variables supported by
|
utilities, also uses the environment variables supported by
|
||||||
<application>libpq</application> (see <xref linkend="libpq-envars"/>).
|
<application>libpq</application> (see <xref linkend="libpq-envars"/>).
|
||||||
</para>
|
</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>
|
||||||
|
|
||||||
<refsect1>
|
<refsect1>
|
||||||
|
@ -279,8 +279,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -327,8 +327,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -405,8 +405,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -245,8 +245,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -225,8 +225,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -466,8 +466,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -706,8 +706,8 @@ PostgreSQL documentation
|
|||||||
|
|
||||||
<para>
|
<para>
|
||||||
The environment variable <envar>PG_COLOR</envar> specifies whether to use
|
The environment variable <envar>PG_COLOR</envar> specifies whether to use
|
||||||
color in diagnostics messages. Possible values are
|
color in diagnostic messages. Possible values are
|
||||||
<literal>always</literal>, <literal>auto</literal>,
|
<literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
@ -191,8 +191,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -73,8 +73,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -1229,8 +1229,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -701,8 +701,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -167,8 +167,8 @@ PostgreSQL documentation
|
|||||||
|
|
||||||
<para>
|
<para>
|
||||||
The environment variable <envar>PG_COLOR</envar> specifies whether to use
|
The environment variable <envar>PG_COLOR</envar> specifies whether to use
|
||||||
color in diagnostics messages. Possible values are
|
color in diagnostic messages. Possible values are
|
||||||
<literal>always</literal>, <literal>auto</literal>,
|
<literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
@ -420,8 +420,8 @@ PostgreSQL documentation
|
|||||||
|
|
||||||
<para>
|
<para>
|
||||||
The environment variable <envar>PG_COLOR</envar> specifies whether to use
|
The environment variable <envar>PG_COLOR</envar> specifies whether to use
|
||||||
color in diagnostics messages. Possible values are
|
color in diagnostic messages. Possible values are
|
||||||
<literal>always</literal>, <literal>auto</literal>,
|
<literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
@ -400,8 +400,8 @@ PostgreSQL documentation
|
|||||||
|
|
||||||
<para>
|
<para>
|
||||||
The environment variable <envar>PG_COLOR</envar> specifies whether to use
|
The environment variable <envar>PG_COLOR</envar> specifies whether to use
|
||||||
color in diagnostics messages. Possible values are
|
color in diagnostic messages. Possible values are
|
||||||
<literal>always</literal>, <literal>auto</literal>,
|
<literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
@ -328,8 +328,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -827,8 +827,8 @@
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -269,8 +269,8 @@ PostgreSQL documentation
|
|||||||
|
|
||||||
<para>
|
<para>
|
||||||
The environment variable <envar>PG_COLOR</envar> specifies whether to use
|
The environment variable <envar>PG_COLOR</envar> specifies whether to use
|
||||||
color in diagnostics messages. Possible values are
|
color in diagnostic messages. Possible values are
|
||||||
<literal>always</literal>, <literal>auto</literal>,
|
<literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
@ -223,8 +223,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -147,6 +147,18 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E"
|
|||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</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>
|
<refsect1>
|
||||||
<title>Notes</title>
|
<title>Notes</title>
|
||||||
|
|
||||||
|
@ -883,6 +883,37 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
|
|||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</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>
|
<refsect1>
|
||||||
<title>Notes</title>
|
<title>Notes</title>
|
||||||
|
|
||||||
|
@ -103,6 +103,17 @@
|
|||||||
|
|
||||||
</refsect1>
|
</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>
|
<refsect1>
|
||||||
<title>See Also</title>
|
<title>See Also</title>
|
||||||
|
|
||||||
|
@ -4501,8 +4501,8 @@ $endif
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -380,8 +380,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -474,8 +474,8 @@ PostgreSQL documentation
|
|||||||
<term><envar>PG_COLOR</envar></term>
|
<term><envar>PG_COLOR</envar></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Specifies whether to use color in diagnostics messages. Possible values
|
Specifies whether to use color in diagnostic messages. Possible values
|
||||||
are <literal>always</literal>, <literal>auto</literal>,
|
are <literal>always</literal>, <literal>auto</literal> and
|
||||||
<literal>never</literal>.
|
<literal>never</literal>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -196,6 +196,13 @@
|
|||||||
also uses the environment variables supported by <application>libpq</application>
|
also uses the environment variables supported by <application>libpq</application>
|
||||||
(see <xref linkend="libpq-envars"/>).
|
(see <xref linkend="libpq-envars"/>).
|
||||||
</para>
|
</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>
|
||||||
|
|
||||||
<refsect1>
|
<refsect1>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user