Skip to content

Commit

Permalink
Update help text everywhere
Browse files Browse the repository at this point in the history
  • Loading branch information
riquito committed Feb 25, 2024
1 parent 3ae8adc commit 353921f
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,12 @@ Memory consumption:
the whole input in memory (it also happens when -p or -m are being used)
--bytes allocate the whole input in memory
Colors:
Help is displayed using colors. Colors will be suppressed in the
following circumstances:
- when the TERM environment variable is not set or set to "dumb"
- when the NO_COLOR environment variable is set (regardless of value)
```

## Examples
Expand Down
8 changes: 8 additions & 0 deletions doc/tuc.1
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,14 @@ allocates the whole input in memory (it also happens when -p or -m are
being used)
.PP
--bytes allocate the whole input in memory
.SH COLORS
.PP
Help is displayed using colors.
Colors will be suppressed in the following circumstances:
.IP \[bu] 2
when the TERM environment variable is not set or set to \[lq]dumb\[rq]
.IP \[bu] 2
when the NO_COLOR environment variable is set (regardless of value)
.SH BUGS
.PP
See GitHub Issues: <https://github.com/riquito/tuc/issues>
Expand Down
9 changes: 9 additions & 0 deletions doc/tuc.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,15 @@ MEMORY CONSUMPTION

\--bytes allocate the whole input in memory

COLORS
======

Help is displayed using colors. Colors will be suppressed in the
following circumstances:

- when the TERM environment variable is not set or set to "dumb"
- when the NO_COLOR environment variable is set (regardless of value)

BUGS
====

Expand Down
6 changes: 6 additions & 0 deletions src/help.rs
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ Memory consumption:
the whole input in memory (it also happens when -p or -m are being used)
--bytes allocate the whole input in memory
Colors:
Help is displayed using colors. Colors will be suppressed in the
following circumstances:
- when the TERM environment variable is not set or set to "dumb"
- when the NO_COLOR environment variable is set (regardless of value)
"#
);

Expand Down

0 comments on commit 353921f

Please sign in to comment.