From 59d4cfb75c1a17a26b2b38956ee08d8c53f04e04 Mon Sep 17 00:00:00 2001 From: Isabella Basso Date: Fri, 19 Nov 2021 03:09:19 -0300 Subject: [PATCH] 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 --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 8db781c5..84657d53 100644 --- a/README.md +++ b/README.md @@ -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