Skip to content

Commit

Permalink
Update README.md to mention --strip-ansi
Browse files Browse the repository at this point in the history
  • Loading branch information
eth-p committed Jun 16, 2024
1 parent c465923 commit 87b0c2e
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -759,9 +759,14 @@ bat() {

If an input file contains color codes or other ANSI escape sequences or control characters, `bat` will have problems
performing syntax highlighting and text wrapping, and thus the output can become garbled.
When displaying such files it is recommended to disable both syntax highlighting and wrapping by

If your version of `bat` supports the `--strip-ansi=auto` option, it can be used to remove such sequences
before syntax highlighting. Alternatively, you may disable both syntax highlighting and wrapping by
passing the `--color=never --wrap=never` options to `bat`.

> [!NOTE]
> The `auto` option of `--strip-ansi` avoids removing escape sequences when the syntax is plain text.
### Terminals & colors

`bat` handles terminals *with* and *without* truecolor support. However, the colors in most syntax
Expand Down

0 comments on commit 87b0c2e

Please sign in to comment.