From 6280033ac4d3d3646c4c512a1c852c9c8f088f80 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Wed, 18 Nov 2015 15:35:45 +0200
Subject: Add support for ANSI colorization of usage output

---
 doc/cli.1     | 6 ++++++
 doc/cli.xhtml | 7 +++++++
 2 files changed, 13 insertions(+)

(limited to 'doc')

diff --git a/doc/cli.1 b/doc/cli.1
index 88f6be0..663fdaf 100644
--- a/doc/cli.1
+++ b/doc/cli.1
@@ -120,6 +120,12 @@ provided\.
 Indent option descriptions \fIlen\fR characters when printing usage\. This is
 useful when you have multiple options classes, potentially in separate files,
 and would like their usage to have the same indentation level\.
+.IP "\fB--ansi-color\fR"
+Use ANSI color escape sequences when printing usage\. By "color" we really
+only mean the bold and underline modifiers\. Note that Windows console does
+not recognize ANSI escape sequences and will display them as garbage\.
+However, if you pipe such output through \fBless\fR(1)\fR, it will display
+them correctly\.
 .IP "\fB--exclude-base\fR"
 Exclude base class information from usage and documentation\.
 .IP "\fB--class\fR \fIfq-name\fR"
diff --git a/doc/cli.xhtml b/doc/cli.xhtml
index e2baa6b..305087c 100644
--- a/doc/cli.xhtml
+++ b/doc/cli.xhtml
@@ -165,6 +165,13 @@
     separate files, and would like their usage to have the same indentation
     level.</dd>
 
+    <dt><code><b>--ansi-color</b></code></dt>
+    <dd>Use ANSI color escape sequences when printing usage. By "color" we
+    really only mean the bold and underline modifiers. Note that Windows
+    console does not recognize ANSI escape sequences and will display them as
+    garbage. However, if you pipe such output through
+    <code><b>less</b>(1)</code>, it will display them correctly.</dd>
+
     <dt><code><b>--exclude-base</b></code></dt>
     <dd>Exclude base class information from usage and documentation.</dd>
 
-- 
cgit v1.1