8000 Doc: fix some description of environment variables with frontend tools · postgrespro/postgres@5aaa584 · GitHub
[go: up one dir, main page]
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>

0 commit comments

Comments
 (0)
0