From: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Date: Thu, 15 Sep 2022 00:41:13 +0000 (+1200)
Subject: docs/man/samba-tool explain --color
X-Git-Tag: talloc-2.4.0~943
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dad0c9a52eb142ea105231ab1e8df75ff00da210;p=thirdparty%2Fsamba.git

docs/man/samba-tool explain --color

Signed-off-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
---

diff --git a/docs-xml/manpages/samba-tool.8.xml b/docs-xml/manpages/samba-tool.8.xml
index 9a40bb1bec4..10ffa8a4d5f 100644
--- a/docs-xml/manpages/samba-tool.8.xml
+++ b/docs-xml/manpages/samba-tool.8.xml
@@ -69,6 +69,29 @@
 	</para></listitem>
 	</varlistentry>
 
+	<varlistentry>
+	<term>--color=always|never|auto</term>
+	<listitem>
+          <para>
+	    Indicate whether samba-tool should use ANSI colour codes
+	    in its output. If 'auto' (the default), samba-tool will
+	    use colour when its output is directed toward a terminal,
+	    unless the NO_COLOR environment variable is set and
+	    non-empty.
+	  </para>
+          <para>
+            The values 'yes' and 'force' are accepted as synonyms for
+            'always'; 'no' and 'none' for 'never'; and 'tty' and
+            'if-tty' for 'auto'.
+          </para>
+          <para>
+	    Note that asking for colour doesn't mean samba-tool will
+	    necessarily be very colourful. Many commands are very
+	    monochrome, particularly when successful.
+	</para>
+        </listitem>
+	</varlistentry>
+
 	&cmdline.common.debug.client;
 
 	</variablelist>