diff options
| author | Boris Kolpackov <boris@codesynthesis.com> | 2015-11-18 15:35:45 +0200 |
|---|---|---|
| committer | Boris Kolpackov <boris@codesynthesis.com> | 2015-11-18 15:35:45 +0200 |
| commit | 6280033ac4d3d3646c4c512a1c852c9c8f088f80 (patch) | |
| tree | 29d61def865015dca6f1f5f820f0ae7de5904bf8 /doc | |
| parent | 6dc69580d6101fb1adb1733dad11b5f5ab5fc831 (diff) | |
Add support for ANSI colorization of usage output
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cli.1 | 6 | ||||
| -rw-r--r-- | doc/cli.xhtml | 7 |
2 files changed, 13 insertions, 0 deletions
@@ -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> |