Skip to content

Commit 353921f

Browse files
committed
Update help text everywhere
1 parent 3ae8adc commit 353921f

File tree

4 files changed

+29
-0
lines changed

4 files changed

+29
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ Memory consumption:
9696
the whole input in memory (it also happens when -p or -m are being used)
9797
9898
--bytes allocate the whole input in memory
99+
100+
Colors:
101+
Help is displayed using colors. Colors will be suppressed in the
102+
following circumstances:
103+
- when the TERM environment variable is not set or set to "dumb"
104+
- when the NO_COLOR environment variable is set (regardless of value)
99105
```
100106

101107
## Examples

doc/tuc.1

+8
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,14 @@ allocates the whole input in memory (it also happens when -p or -m are
186186
being used)
187187
.PP
188188
--bytes allocate the whole input in memory
189+
.SH COLORS
190+
.PP
191+
Help is displayed using colors.
192+
Colors will be suppressed in the following circumstances:
193+
.IP \[bu] 2
194+
when the TERM environment variable is not set or set to \[lq]dumb\[rq]
195+
.IP \[bu] 2
196+
when the NO_COLOR environment variable is set (regardless of value)
189197
.SH BUGS
190198
.PP
191199
See GitHub Issues: <https://github.com/riquito/tuc/issues>

doc/tuc.1.md

+9
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,15 @@ MEMORY CONSUMPTION
116116

117117
\--bytes allocate the whole input in memory
118118

119+
COLORS
120+
======
121+
122+
Help is displayed using colors. Colors will be suppressed in the
123+
following circumstances:
124+
125+
- when the TERM environment variable is not set or set to "dumb"
126+
- when the NO_COLOR environment variable is set (regardless of value)
127+
119128
BUGS
120129
====
121130

src/help.rs

+6
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,12 @@ Memory consumption:
7070
the whole input in memory (it also happens when -p or -m are being used)
7171
7272
--bytes allocate the whole input in memory
73+
74+
Colors:
75+
Help is displayed using colors. Colors will be suppressed in the
76+
following circumstances:
77+
- when the TERM environment variable is not set or set to "dumb"
78+
- when the NO_COLOR environment variable is set (regardless of value)
7379
"#
7480
);
7581

0 commit comments

Comments
 (0)