Skip to content

Commit 5aaa584

Browse files
michaelpqmichaelpq
committed
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
1 parent 806eb92 commit 5aaa584

26 files changed

+110
-42
lines changed

‎doc/src/sgml/oid2name.sgml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,13 @@
223223
utilities, also uses the environment variables supported by
224224
<application>libpq</application> (see <xref linkend="libpq-envars"/>).
225225
</para>
226+
227+
<para>
228+
The environment variable <envar>PG_COLOR</envar> specifies whether to use
229+
color in diagnostic messages. Possible values are
230+
<literal>always</literal>, <literal>auto</literal> and
231+
<literal>never</literal>.
232+
</para>
226233
</refsect1>
227234

228235
<refsect1>

‎doc/src/sgml/ref/clusterdb.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,8 +279,8 @@ PostgreSQL documentation
279279
<term><envar>PG_COLOR</envar></term>
280280
<listitem>
281281
<para>
282-
Specifies whether to use color in diagnostics messages. Possible values
283-
are <literal>always</literal>, <literal>auto</literal>,
282+
Specifies whether to use color in diagnostic messages. Possible values
283+
are <literal>always</literal>, <literal>auto</literal> and
284284
<literal>never</literal>.
285285
</para>
286286
</listitem>

‎doc/src/sgml/ref/createdb.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -327,8 +327,8 @@ PostgreSQL documentation
327327
<term><envar>PG_COLOR</envar></term>
328328
<listitem>
329329
<para>
330-
Specifies whether to use color in diagnostics messages. Possible values
331-
are <literal>always</literal>, <literal>auto</literal>,
330+
Specifies whether to use color in diagnostic messages. Possible values
331+
are <literal>always</literal>, <literal>auto</literal> and
332332
<literal>never</literal>.
333333
</para>
334334
</listitem>

‎doc/src/sgml/ref/createuser.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -405,8 +405,8 @@ PostgreSQL documentation
405405
<term><envar>PG_COLOR</envar></term>
406406
<listitem>
407407
<para>
408-
Specifies whether to use color in diagnostics messages. Possible values
409-
are <literal>always</literal>, <literal>auto</literal>,
408+
Specifies whether to use color in diagnostic messages. Possible values
409+
are <literal>always</literal>, <literal>auto</literal> and
410410
<literal>never</literal>.
411411
</para>
412412
</listitem>

‎doc/src/sgml/ref/dropdb.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,8 +245,8 @@ PostgreSQL documentation
245245
<term><envar>PG_COLOR</envar></term>
246246
<listitem>
247247
<para>
248-
Specifies whether to use color in diagnostics messages. Possible values
249-
are <literal>always</literal>, <literal>auto</literal>,
248+
Specifies whether to use color in diagnostic messages. Possible values
249+
are <literal>always</literal>, <literal>auto</literal> and
250250
<literal>never</literal>.
251251
</para>
252252
</listitem>

‎doc/src/sgml/ref/dropuser.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,8 @@ PostgreSQL documentation
225225
<term><envar>PG_COLOR</envar></term>
226226
<listitem>
227227
<para>
228-
Specifies whether to use color in diagnostics messages. Possible values
229-
are <literal>always</literal>, <literal>auto</literal>,
228+
Specifies whether to use color in diagnostic messages. Possible values
229+
are <literal>always</literal>, <literal>auto</literal> and
230230
<literal>never</literal>.
231231
</para>
232232
</listitem>

‎doc/src/sgml/ref/initdb.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -466,8 +466,8 @@ PostgreSQL documentation
466466
<term><envar>PG_COLOR</envar></term>
467467
<listitem>
468468
<para>
469-
Specifies whether to use color in diagnostics messages. Possible values
470-
are <literal>always</literal>, <literal>auto</literal>,
469+
Specifies whether to use color in diagnostic messages. Possible values
470+
are <literal>always</literal>, <literal>auto</literal> and
471471
<literal>never</literal>.
472472
</para>
473473
</listitem>

‎doc/src/sgml/ref/pg_basebackup.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -706,8 +706,8 @@ PostgreSQL documentation
706706

707707
<para>
708708
The environment variable <envar>PG_COLOR</envar> specifies whether to use
709-
color in diagnostics messages. Possible values are
710-
<literal>always</literal>, <literal>auto</literal>,
709+
color in diagnostic messages. Possible values are
710+
<literal>always</literal>, <literal>auto</literal> and
711711
<literal>never</literal>.
712712
</para>
713713
</refsect1>

‎doc/src/sgml/ref/pg_checksums.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,8 @@ PostgreSQL documentation
191191
<term><envar>PG_COLOR</envar></term>
192192
<listitem>
193193
<para>
194-
Specifies whether to use color in diagnostics messages. Possible values
195-
are <literal>always</literal>, <literal>auto</literal>,
194+
Specifies whether to use color in diagnostic messages. Possible values
195+
are <literal>always</literal>, <literal>auto</literal> and
196196
<literal>never</literal>.
197197
</para>
198198
</listitem>

‎doc/src/sgml/ref/pg_controldata.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ PostgreSQL documentation
7373
<term><envar>PG_COLOR</envar></term>
7474
<listitem>
7575
<para>
76-
Specifies whether to use color in diagnostics messages. Possible values
77-
are <literal>always</literal>, <literal>auto</literal>,
76+
Specifies whether to use color in diagnostic messages. Possible values
77+
are <literal>always</literal>, <literal>auto</literal> and
7878
<literal>never</literal>.
7979
</para>
8080
</listitem>

‎doc/src/sgml/ref/pg_dump.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1229,8 +1229,8 @@ PostgreSQL documentation
12291229
<term><envar>PG_COLOR</envar></term>
12301230
<listitem>
12311231
<para>
1232-
Specifies whether to use color in diagnostics messages. Possible values
1233-
are <literal>always</literal>, <literal>auto</literal>,
1232+
Specifies whether to use color in diagnostic messages. Possible values
1233+
are <literal>always</literal>, <literal>auto</literal> and
12341234
<literal>never</literal>.
12351235
</para>
12361236
</listitem>

‎doc/src/sgml/ref/pg_dumpall.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -701,8 +701,8 @@ PostgreSQL documentation
701701
<term><envar>PG_COLOR</envar></term>
702702
<listitem>
703703
<para>
704-
Specifies whether to use color in diagnostics messages. Possible values
705-
are <literal>always</literal>, <literal>auto</literal>,
704+
Specifies whether to use color in diagnostic messages. Possible values
705+
are <literal>always</literal>, <literal>auto</literal> and
706706
<literal>never</literal>.
707707
</para>
708708
</listitem>

‎doc/src/sgml/ref/pg_isready.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,8 @@ PostgreSQL documentation
167167

168168
<para>
169169
The environment variable <envar>PG_COLOR</envar> specifies whether to use
170-
color in diagnostics messages. Possible values are
171-
<literal>always</literal>, <literal>auto</literal>,
170+
color in diagnostic messages. Possible values are
171+
<literal>always</literal>, <literal>auto</literal> and
172172
<literal>never</literal>.
173173
</para>
174174
</refsect1>

‎doc/src/sgml/ref/pg_receivewal.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -420,8 +420,8 @@ PostgreSQL documentation
420420

421421
<para>
422422
The environment variable <envar>PG_COLOR</envar> specifies whether to use
423-
color in diagnostics messages. Possible values are
424-
<literal>always</literal>, <literal>auto</literal>,
423+
color in diagnostic messages. Possible values are
424+
<literal>always</literal>, <literal>auto</literal> and
425425
<literal>never</literal>.
426426
</para>
427427
</refsect1>

‎doc/src/sgml/ref/pg_recvlogical.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -400,8 +400,8 @@ PostgreSQL documentation
400400

401401
<para>
402402
The environment variable <envar>PG_COLOR</envar> specifies whether to use
403-
color in diagnostics messages. Possible values are
404-
<literal>always</literal>, <literal>auto</literal>,
403+
color in diagnostic messages. Possible values are
404+
<literal>always</literal>, <literal>auto</literal> and
405405
<literal>never</literal>.
406406
</para>
407407
</refsect1>

‎doc/src/sgml/ref/pg_resetwal.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -328,8 +328,8 @@ PostgreSQL documentation
328328
<term><envar>PG_COLOR</envar></term>
329329
<listitem>
330330
<para>
331-
Specifies whether to use color in diagnostics messages. Possible values
332-
are <literal>always</literal>, <literal>auto</literal>,
331+
Specifies whether to use color in diagnostic messages. Possible values
332+
are <literal>always</literal>, <literal>auto</literal> and
333333
<literal>never</literal>.
334334
</para>
335335
</listitem>

‎doc/src/sgml/ref/pg_restore.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -827,8 +827,8 @@
827827
<term><envar>PG_COLOR</envar></term>
828828
<listitem>
829829
<para>
830-
Specifies whether to use color in diagnostics messages. Possible values
831-
are <literal>always</literal>, <literal>auto</literal>,
830+
Specifies whether to use color in diagnostic messages. Possible values
831+
are <literal>always</literal>, <literal>auto</literal> and
832832
<literal>never</literal>.
833833
</para>
834834
</listitem>

‎doc/src/sgml/ref/pg_rewind.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,8 +269,8 @@ PostgreSQL documentation
269269

270270
<para>
271271
The environment variable <envar>PG_COLOR</envar> specifies whether to use
272-
color in diagnostics messages. Possible values are
273-
<literal>always</literal>, <literal>auto</literal>,
272+
color in diagnostic messages. Possible values are
273+
<literal>always</literal>, <literal>auto</literal> and
274274
<literal>never</literal>.
275275
</para>
276276
</refsect1>

‎doc/src/sgml/ref/pg_waldump.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,8 +223,8 @@ PostgreSQL documentation
223223
<term><envar>PG_COLOR</envar></term>
224224
<listitem>
225225
<para>
226-
Specifies whether to use color in diagnostics messages. Possible values
227-
are <literal>always</literal>, <literal>auto</literal>,
226+
Specifies whether to use color in diagnostic messages. Possible values
227+
are <literal>always</literal>, <literal>auto</literal> and
228228
<literal>never</literal>.
229229
</para>
230230
</listitem>

‎doc/src/sgml/ref/pgarchivecleanup.sgml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,18 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E"
147147
</para>
148148
</refsect1>
149149

150+
<refsect1>
151+
<title>Environment</title>
152+
153+
<para>
154+
The environment variable <envar>PG_COLOR</envar> specifies whether to use
155+
color in diagnostic messages. Possible values are
156+
<literal>always</literal>, <literal>auto</literal> and
157+
<literal>never</literal>.
158+
</para>
159+
</refsect1>
160+
161+
150162
<refsect1>
151163
<title>Notes</title>
152164

‎doc/src/sgml/ref/pgbench.sgml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -883,6 +883,37 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
883883
</para>
884884
</refsect1>
885885

886+
<refsect1>
887+
<title>Environment</title>
888+
889+
<variablelist>
890+
<varlistentry>
891+
<term><envar>PGHOST</envar></term>
892+
<term><envar>PGPORT</envar></term>
893+
<term><envar>PGUSER</envar></term>
894+
895+
<listitem>
896+
<para>
897+
Default connection parameters.
898+
</para>
899+
</listitem>
900+
</varlistentry>
901+
</variablelist>
902+
903+
<para>
904+
This utility, like most other <productname>PostgreSQL</productname> utilities,
905+
uses the environment variables supported by <application>libpq</application>
906+
(see <xref linkend="libpq-envars"/>).
907+
</para>
908+
909+
<para>
910+
The environment variable <envar>PG_COLOR</envar> specifies whether to use
911+
color in diagnostic messages. Possible values are
912+
<literal>always</literal>, <literal>auto</literal> and
913+
<literal>never</literal>.
914+
</para>
915+
</refsect1>
916+
886917
<refsect1>
887918
<title>Notes</title>
888919

‎doc/src/sgml/ref/pgtestfsync.sgml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,17 @@
103103

104104
</refsect1>
105105

106+
<refsect1>
107+
<title>Environment</title>
108+
109+
<para>
110+
The environment variable <envar>PG_COLOR</envar> specifies whether to use
111+
color in diagnostic messages. Possible values are
112+
<literal>always</literal>, <literal>auto</literal> and
113+
<literal>never</literal>.
114+
</para>
115+
</refsect1>
116+
106117
<refsect1>
107118
<title>See Also</title>
108119

‎doc/src/sgml/ref/psql-ref.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4501,8 +4501,8 @@ $endif
45014501
<term><envar>PG_COLOR</envar></term>
45024502
<listitem>
45034503
<para>
4504-
Specifies whether to use color in diagnostics messages. Possible values
4505-
are <literal>always</literal>, <literal>auto</literal>,
4504+
Specifies whether to use color in diagnostic messages. Possible values
4505+
are <literal>always</literal>, <literal>auto</literal> and
45064506
<literal>never</literal>.
45074507
</para>
45084508
</listitem>

‎doc/src/sgml/ref/reindexdb.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -380,8 +380,8 @@ PostgreSQL documentation
380380
<term><envar>PG_COLOR</envar></term>
381381
<listitem>
382382
<para>
383-
Specifies whether to use color in diagnostics messages. Possible values
384-
are <literal>always</literal>, <literal>auto</literal>,
383+
Specifies whether to use color in diagnostic messages. Possible values
384+
are <literal>always</literal>, <literal>auto</literal> and
385385
<literal>never</literal>.
386386
</para>
387387
</listitem>

‎doc/src/sgml/ref/vacuumdb.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -474,8 +474,8 @@ PostgreSQL documentation
474474
<term><envar>PG_COLOR</envar></term>
475475
<listitem>
476476
<para>
477-
Specifies whether to use color in diagnostics messages. Possible values
478-
are <literal>always</literal>, <literal>auto</literal>,
477+
Specifies whether to use color in diagnostic messages. Possible values
478+
are <literal>always</literal>, <literal>auto</literal> and
479479
<literal>never</literal>.
480480
</para>
481481
</listitem>

‎doc/src/sgml/vacuumlo.sgml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,13 @@
196196
also uses the environment variables supported by <application>libpq</application>
197197
(see <xref linkend="libpq-envars"/>).
198198
</para>
199+
200+
<para>
201+
The environment variable <envar>PG_COLOR</envar> specifies whether to use
202+
color in diagnostic messages. Possible values are
203+
<literal>always</literal>, <literal>auto</literal> and
204+
<literal>never</literal>.
205+
</para>
199206
</refsect1>
200207

201208
<refsect1>

0 commit comments

Comments
 (0)