summaryrefslogtreecommitdiff
path: root/cli/doc
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2021-11-09 13:01:13 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2021-11-09 13:01:13 +0200
commitcd3758bb328ff425bb06f18c81d3c353b508a336 (patch)
treeed8a85f7c01fa83852bb6d51e4fc2dd2a268b388 /cli/doc
parent9944c0e901d370316fe55fb845ad1c3c6721038d (diff)
Add --ascii-tree for translating UTF-8 tree(1) output to ASCII
Diffstat (limited to 'cli/doc')
-rw-r--r--cli/doc/bootstrap/cli.14
-rw-r--r--cli/doc/bootstrap/cli.xhtml6
2 files changed, 10 insertions, 0 deletions
diff --git a/cli/doc/bootstrap/cli.1 b/cli/doc/bootstrap/cli.1
index d684d30..1cced65 100644
--- a/cli/doc/bootstrap/cli.1
+++ b/cli/doc/bootstrap/cli.1
@@ -206,6 +206,10 @@ the long usage function has the \fB*long_usage()\fR suffix\.
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--ascii-tree\fR"
+Convert UTF-8 \fBtree(1)\fR output to ASCII\. Specifically, box-drawing
+characters used in the \fB--charset=UTF-8\fR output are replaced with ASCII
+characters used in the --charset=ASCII\fR output\.
.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
diff --git a/cli/doc/bootstrap/cli.xhtml b/cli/doc/bootstrap/cli.xhtml
index b62bf57..9ee5c16 100644
--- a/cli/doc/bootstrap/cli.xhtml
+++ b/cli/doc/bootstrap/cli.xhtml
@@ -258,6 +258,12 @@ arg+{ --foo } # 'arg+{' ...</pre>
potentially in separate files, and would like their usage to have the same
indentation level.</dd>
+ <dt><code><b>--ascii-tree</b></code></dt>
+ <dd>Convert UTF-8 <code><b>tree(1)</b></code> output to ASCII.
+ Specifically, box-drawing characters used in the
+ <code><b>--charset=UTF-8</b></code> output are replaced with ASCII
+ characters used in the <code>--charset=ASCII</code> output.</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