README.md: Add 'Garbled output' to 'Troubleshooting' (#1937)

As per #234, #403, #1572, #1823 and #1897, this commit clarifies that
`bat` cannot properly handle escape sequences.

Signed-off-by: Isabella Basso <isabbasso@riseup.net>
This commit is contained in:
Isabella Basso 2021-11-19 03:09:19 -03:00 committed by GitHub
parent 194e7bbcd1
commit 59d4cfb75c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions

View File

@ -674,6 +674,13 @@ bat() {
## Troubleshooting
### Garbled output
If an input file contains color codes or other ANSI escape sequences, `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
passing the `--color=never --wrap=never` options to `bat`.
### Terminals & colors
`bat` handles terminals *with* and *without* truecolor support. However, the colors in most syntax