man: Document DPKG_COLORS environment variable for all programs using it

23 files changed, 131 insertions, 0 deletions

diff --git a/debian/changelog b/debian/changelog
index b74217295..d2ed29134 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -19,6 +19,7 @@ dpkg (1.19.1) UNRELEASED; urgency=medium
     - Update gettext minimal version in README.
     - Add a missing dot on the dpkg-buildflags(1) «lfs» feature paragraph.
       Spotted by Helge Kreutzmann <debian@helgefjell.de>.
+    - Document DPKG_COLORS environment variable for all programs using it.
   * Packaging:
     - Install update-alternatives policykit-1 file.
     - Add Breaks to libdpkg-perl against pkg-kde-tools (<< 0.15.28~), as
diff --git a/man/dpkg-architecture.man b/man/dpkg-architecture.man
index ff0b4b630..ea70f948e 100644
--- a/man/dpkg-architecture.man
+++ b/man/dpkg-architecture.man
@@ -362,6 +362,12 @@ architecture information during a package build.
 If set, it will be used as the \fBdpkg\fP data directory, where the
 architecture tables are located (since dpkg 1.14.17).
 Defaults to «%PKGDATADIR%».
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.
 .SH NOTES
 All long command and option names available only since dpkg 1.17.17.
 .
diff --git a/man/dpkg-buildflags.man b/man/dpkg-buildflags.man
index f9b288ab5..258ef8265 100644
--- a/man/dpkg-buildflags.man
+++ b/man/dpkg-buildflags.man
@@ -529,6 +529,11 @@ If not set, it will discover the current vendor by reading
 This variable sets the build path (since dpkg 1.18.8) to use in features
 such as \fBfixdebugpath\fP so that they can be controlled by the caller.
 This variable is currently Debian and derivatives-specific.
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
 .
 .SH FILES
 .SS Configuration files
diff --git a/man/dpkg-checkbuilddeps.man b/man/dpkg-checkbuilddeps.man
index 1b4dc312c..63f7dbd3d 100644
--- a/man/dpkg-checkbuilddeps.man
+++ b/man/dpkg-checkbuilddeps.man
@@ -86,3 +86,8 @@ Show the version and exit.
 If set, it will be used as the active build profile(s) for the package
 being built. It is a space separated list of profile names. Overridden
 by the \fB\-P\fP option.
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
diff --git a/man/dpkg-deb.man b/man/dpkg-deb.man
index 769869b9e..f843f0a83 100644
--- a/man/dpkg-deb.man
+++ b/man/dpkg-deb.man
@@ -302,6 +302,11 @@ memory allocations, etc.
 .
 .SH ENVIRONMENT
 .TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.TP
 .B TMPDIR
 If set, \fBdpkg\-deb\fP will use it as the directory in which to create
 temporary files and directories.
diff --git a/man/dpkg-distaddfile.man b/man/dpkg-distaddfile.man
index acebafa93..c6b8a9846 100644
--- a/man/dpkg-distaddfile.man
+++ b/man/dpkg-distaddfile.man
@@ -55,6 +55,13 @@ Show the usage message and exit.
 .BR \-\-version
 Show the version and exit.
 .
+.SH ENVIRONMENT
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.
 .SH FILES
 .TP
 .B debian/files
diff --git a/man/dpkg-divert.man b/man/dpkg-divert.man
index 5774b11cb..c9d7e1ce7 100644
--- a/man/dpkg-divert.man
+++ b/man/dpkg-divert.man
@@ -117,6 +117,11 @@ be used as the \fBdpkg\fP data directory.
 .B DPKG_MAINTSCRIPT_PACKAGE
 If set and the \fB\-\-local\fP and \fB\-\-package\fP options have not been
 specified, \fBdpkg\-divert\fP will use it as the package name.
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
 .
 .SH FILES
 .TP
diff --git a/man/dpkg-genbuildinfo.man b/man/dpkg-genbuildinfo.man
index ad5e614b1..b3161a81d 100644
--- a/man/dpkg-genbuildinfo.man
+++ b/man/dpkg-genbuildinfo.man
@@ -149,6 +149,11 @@ The special feature “\fBall\fP” can be used to enable or disable all other
 features.
 The feature “\fBpath\fP” controls whether to unconditionally include the
 \fBBuild\-Path\fP field.
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
 .
 .SH FILES
 .TP
diff --git a/man/dpkg-genchanges.man b/man/dpkg-genchanges.man
index 99ec93d49..14ec9af0d 100644
--- a/man/dpkg-genchanges.man
+++ b/man/dpkg-genchanges.man
@@ -192,6 +192,13 @@ Show the usage message and exit.
 .BR \-\-version
 Show the version and exit.
 .
+.SH ENVIRONMENT
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.
 .SH FILES
 .TP
 .B debian/files
diff --git a/man/dpkg-gencontrol.man b/man/dpkg-gencontrol.man
index 4d62a222e..950fc8d1d 100644
--- a/man/dpkg-gencontrol.man
+++ b/man/dpkg-gencontrol.man
@@ -146,6 +146,13 @@ Show the usage message and exit.
 .BR \-\-version
 Show the version and exit.
 .
+.SH ENVIRONMENT
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.
 .SH FILES
 .TP
 .B debian/control
diff --git a/man/dpkg-gensymbols.man b/man/dpkg-gensymbols.man
index 27a52b116..7a8fbf139 100644
--- a/man/dpkg-gensymbols.man
+++ b/man/dpkg-gensymbols.man
@@ -507,6 +507,12 @@ Show the version and exit.
 Overrides the command check level, even if the \fB\-c\fP command-line
 argument was given (note that this goes against the common convention
 of command-line arguments having precedence over environment variables).
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.
 .SH SEE ALSO
 .BR https://people.redhat.com/drepper/symbol\-versioning
 .br
diff --git a/man/dpkg-mergechangelogs.man b/man/dpkg-mergechangelogs.man
index 786dad281..e2090dee8 100644
--- a/man/dpkg-mergechangelogs.man
+++ b/man/dpkg-mergechangelogs.man
@@ -60,6 +60,13 @@ Show the usage message and exit.
 .B \-\-version
 Show the version and exit.
 .
+.SH ENVIRONMENT
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.
 .SH LIMITATIONS
 .P
 Anything that is not parsed by Dpkg::Changelog is lost during the merge.
diff --git a/man/dpkg-name.man b/man/dpkg-name.man
index 619601515..0bf48fc4e 100644
--- a/man/dpkg-name.man
+++ b/man/dpkg-name.man
@@ -77,6 +77,13 @@ Show the usage message and exit.
 .BR \-v ", " \-\-version
 Show the version and exit.
 .
+.SH ENVIRONMENT
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.
 .SH BUGS
 Some packages don't follow the name structure
 .IB package _ version _ architecture .deb\fR.\fP
diff --git a/man/dpkg-parsechangelog.man b/man/dpkg-parsechangelog.man
index 654dee1cc..439c0351f 100644
--- a/man/dpkg-parsechangelog.man
+++ b/man/dpkg-parsechangelog.man
@@ -192,6 +192,13 @@ since dpkg 1.14.16.
 .PP
 Short option parsing with non-bundled values available only since dpkg 1.18.0.
 .
+.SH ENVIRONMENT
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.
 .SH FILES
 .TP
 .B debian/changelog
diff --git a/man/dpkg-query.man b/man/dpkg-query.man
index a7e7a5fd8..7e02cc5d7 100644
--- a/man/dpkg-query.man
+++ b/man/dpkg-query.man
@@ -314,6 +314,11 @@ memory allocations, etc.
 If set and the \fB\-\-admindir\fP option has not been specified, it will
 be used as the \fBdpkg\fP data directory.
 .TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.TP
 \fBCOLUMNS\fP
 This setting influences the output of the \fB\-\-list\fP option by changing
 the width of its output.
diff --git a/man/dpkg-scanpackages.man b/man/dpkg-scanpackages.man
index cd43de32f..495e62e91 100644
--- a/man/dpkg-scanpackages.man
+++ b/man/dpkg-scanpackages.man
@@ -115,6 +115,13 @@ Show the usage message and exit.
 .BR \-\-version
 Show the version and exit.
 .
+.SH ENVIRONMENT
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.
 .SH DIAGNOSTICS
 .B dpkg\-scanpackages
 outputs the usual self-explanatory errors. It also warns about packages
diff --git a/man/dpkg-scansources.man b/man/dpkg-scansources.man
index a68504456..e9317f024 100644
--- a/man/dpkg-scansources.man
+++ b/man/dpkg-scansources.man
@@ -92,6 +92,13 @@ Show the usage message and exit.
 .IP "\fB\-\-version\fR" 4
 Show the version and exit.
 .
+.SH ENVIRONMENT
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.
 .SH SEE ALSO
 .BR deb\-override (5),
 .BR deb\-extra\-override (5),
diff --git a/man/dpkg-shlibdeps.man b/man/dpkg-shlibdeps.man
index e5c319d1c..598778fe4 100644
--- a/man/dpkg-shlibdeps.man
+++ b/man/dpkg-shlibdeps.man
@@ -266,6 +266,13 @@ Show the usage message and exit.
 .BR \-\-version
 Show the version and exit.
 .
+.SH ENVIRONMENT
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.
 .SH DIAGNOSTICS
 .SS Warnings
 Since
diff --git a/man/dpkg-source.man b/man/dpkg-source.man
index f393ae0e0..96ec6f4c1 100644
--- a/man/dpkg-source.man
+++ b/man/dpkg-source.man
@@ -774,6 +774,11 @@ of that fact.
 .
 .SH ENVIRONMENT
 .TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.TP
 .B SOURCE_DATE_EPOCH
 If set, it will be used as the timestamp (as seconds since the epoch) to
 clamp the mtime in the \fBtar\fP(5) file entries.
diff --git a/man/dpkg-split.man b/man/dpkg-split.man
index 3508f0155..8f7fdde43 100644
--- a/man/dpkg-split.man
+++ b/man/dpkg-split.man
@@ -217,6 +217,11 @@ memory allocations, etc.
 .
 .SH ENVIRONMENT
 .TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
+.TP
 .B SOURCE_DATE_EPOCH
 If set, it will be used as the timestamp (as seconds since the epoch) in
 the \fBdeb\-split\fP(5)'s \fBar\fP(5) container.
diff --git a/man/dpkg-statoverride.man b/man/dpkg-statoverride.man
index eb63ea983..800801683 100644
--- a/man/dpkg-statoverride.man
+++ b/man/dpkg-statoverride.man
@@ -103,6 +103,11 @@ memory allocations, etc.
 .B DPKG_ADMINDIR
 If set and the \fB\-\-admindir\fP option has not been specified, it will
 be used as the \fBdpkg\fP data directory.
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
 .
 .SH FILES
 .TP
diff --git a/man/dpkg-trigger.man b/man/dpkg-trigger.man
index 79f4e8eca..5e4877144 100644
--- a/man/dpkg-trigger.man
+++ b/man/dpkg-trigger.man
@@ -98,6 +98,11 @@ memory allocations, etc.
 .B DPKG_ADMINDIR
 If set and the \fB\-\-admindir\fP option has not been specified, it will
 be used as the \fBdpkg\fP data directory.
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
 .
 .SH SEE ALSO
 .BR dpkg (1),
diff --git a/man/dpkg-vendor.man b/man/dpkg-vendor.man
index 98815f15c..d6bfcf3e8 100644
--- a/man/dpkg-vendor.man
+++ b/man/dpkg-vendor.man
@@ -62,6 +62,11 @@ with the \fBDEB_VENDOR\fP environment variable or
 \fBDEB_VENDOR\fP
 This setting defines the current vendor. If not set, it will discover the
 current vendor by reading \fB%PKGCONFDIR%/origins/default\fP.
+.TP
+.B DPKG_COLORS
+Sets the color mode (since dpkg 1.18.5).
+The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
+\fBnever\fP.
 .
 .SH SEE ALSO
 .BR deb\-origin (5).