docs: document the --color-scheme option

Signed-off-by: Markus Lehtonen <markus.lehtonen@linux.intel.com>

3 files changed, 45 insertions, 0 deletions

diff --git a/docs/manpages/gbp-buildpackage.sgml b/docs/manpages/gbp-buildpackage.sgml
index ea578e25..79fb81db 100644
--- a/docs/manpages/gbp-buildpackage.sgml
+++ b/docs/manpages/gbp-buildpackage.sgml
@@ -24,6 +24,7 @@
       <arg><option>--git-tag</option></arg>
       <arg><option>--git-verbose</option></arg>
       <arg><option>--git-color=</option><replaceable>[auto|on|off]</replaceable></arg>
+      <arg><option>--git-color-scheme</option>=<replaceable>COLOR_SCHEME</replaceable></arg>
       <arg><option>--git-notify=</option><replaceable>[auto|on|off]</replaceable></arg>
       <arg><option>--git-upstream-branch=</option><replaceable>treeish</replaceable></arg>
       <arg><option>--git-debian-branch=</option><replaceable>branch_name</replaceable></arg>
@@ -204,6 +205,20 @@
         </listitem>
       </varlistentry>
       <varlistentry>
+        <term><option>--git-color-scheme</option>=<replaceable>COLOR_SCHEME</replaceable></term>
+        <listitem>
+          <para>
+          Colors to use in output (when color is enabled). The format for
+          COLOR_SCHEME is
+          '&lt;debug&gt;:&lt;info&gt;:&lt;warning&gt;:&lt;error&gt;'.
+          Numerical values and color names are accepted, empty fields imply
+          the default color. For example --git-color-scheme='cyan:34::' would
+          show debug messages in cyan, info messages in blue and other messages
+          in default (i.e. warning and error messages in red).
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
         <term><option>--git-upstream-branch</option>=<replaceable>branch_name</replaceable>
         </term>
         <listitem>
diff --git a/docs/manpages/gbp-config.sgml b/docs/manpages/gbp-config.sgml
index b281597a..599d1168 100644
--- a/docs/manpages/gbp-config.sgml
+++ b/docs/manpages/gbp-config.sgml
@@ -23,6 +23,7 @@
 
       <arg><option>--verbose</option></arg>
       <arg><option>--color=</option><replaceable>[auto|on|off]</replaceable></arg>
+      <arg><option>--color-scheme</option>=<replaceable>COLOR_SCHEME</replaceable></arg>
       <group choice='req'>
 	<arg choice="plain"><replaceable>command.option</replaceable></arg>
 	<arg choice="plain"><replaceable>command</replaceable></arg>
@@ -54,6 +55,20 @@
           <para>Whether to use colored output.</para>
         </listitem>
       </varlistentry>
+      <varlistentry>
+        <term><option>--color-scheme</option>=<replaceable>COLOR_SCHEME</replaceable></term>
+        <listitem>
+          <para>
+          Colors to use in output (when color is enabled). The format for
+          COLOR_SCHEME is
+          '&lt;debug&gt;:&lt;info&gt;:&lt;warning&gt;:&lt;error&gt;'.
+          Numerical values and color names are accepted, empty fields imply
+          the default color. For example --git-color-scheme='cyan:34::' would
+          show debug messages in cyan, info messages in blue and other messages
+          in default (i.e. warning and error messages in red).
+          </para>
+        </listitem>
+      </varlistentry>
     </variablelist>
   </refsect1>
   <refsect1>
diff --git a/docs/manpages/gbp-pq.sgml b/docs/manpages/gbp-pq.sgml
index 6251ab39..697916ca 100644
--- a/docs/manpages/gbp-pq.sgml
+++ b/docs/manpages/gbp-pq.sgml
@@ -22,6 +22,7 @@
       &gbp-pq;
       <arg><option>--verbose</option></arg>
       <arg><option>--color=</option><replaceable>[auto|on|off]</replaceable></arg>
+      <arg><option>--color-scheme</option>=<replaceable>COLOR_SCHEME</replaceable></arg>
       <arg><option>--[no-]patch-numbers</option></arg>
       <arg><option>--topic=</option><replaceable>topic</replaceable></arg>
       <arg><option>--time-machine=</option><replaceable>num</replaceable></arg>
@@ -138,6 +139,20 @@
         </listitem>
       </varlistentry>
       <varlistentry>
+        <term><option>--color-scheme</option>=<replaceable>COLOR_SCHEME</replaceable></term>
+        <listitem>
+          <para>
+          Colors to use in output (when color is enabled). The format for
+          COLOR_SCHEME is
+          '&lt;debug&gt;:&lt;info&gt;:&lt;warning&gt;:&lt;error&gt;'.
+          Numerical values and color names are accepted, empty fields imply
+          the default color. For example --git-color-scheme='cyan:34::' would
+          show debug messages in cyan, info messages in blue and other messages
+          in default (i.e. warning and error messages in red).
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
         <term><option>--[no-]patch-numbers</option>
         </term>
         <listitem>