summaryrefslogtreecommitdiff
path: root/doc/cli.1
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2015-11-18 15:35:45 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2015-11-18 15:35:45 +0200
commit6280033ac4d3d3646c4c512a1c852c9c8f088f80 (patch)
tree29d61def865015dca6f1f5f820f0ae7de5904bf8 /doc/cli.1
parent6dc69580d6101fb1adb1733dad11b5f5ab5fc831 (diff)
Add support for ANSI colorization of usage output
Diffstat (limited to 'doc/cli.1')
-rw-r--r--doc/cli.16
1 files changed, 6 insertions, 0 deletions
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"