diff options
author | Bence Ferdinandy <bence@ferdinandy.com> | 2024-03-13 13:56:54 +0100 |
---|---|---|
committer | Robin Jarry <robin@jarry.cc> | 2024-03-25 23:10:21 +0100 |
commit | 523ca15a3b4882a4e49eb4736cc2d5d11b8df9a7 (patch) | |
tree | aac3f29b13397fcca98556f60429ed10e0b63852 | |
parent | 7bddae827a3aaab196b897adadd1d4999fe11b1c (diff) | |
download | aerc-523ca15a3b4882a4e49eb4736cc2d5d11b8df9a7.tar.gz |
docs: update filter tips for images
Since aerc uses vaxis, the image/* filter has incorrect information.
Update this with the new behaviour.
Fixes: 4e26faf498b8 ("msgviewer: implement inline image viewing")
Signed-off-by: Bence Ferdinandy <bence@ferdinandy.com>
Reviewed-by: Inwit <inwit@sindominio.net>
Acked-by: Robin Jarry <robin@jarry.cc>
-rw-r--r-- | doc/aerc-config.5.scd | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd index ea931675..b26d7695 100644 --- a/doc/aerc-config.5.scd +++ b/doc/aerc-config.5.scd @@ -1064,15 +1064,17 @@ _application/pdf_ https://www.xpdfreader.com/pdftotext-man.html _image/\*_ + This is a tricky topic. It's possible to display images in a terminal, but for high resolution images the terminal you are using either needs - to support sixels or the kitty terminal graphics protocol. - Unfortunately, aerc's built-in terminal supports neither, so only highly - pixelated images can be shown natively. A workaround is possible by - asking the terminal to draw on top of aerc and then remove the image - when done viewing. - - The built-in terminal can show pixelated images with *catimg*(1): + to support sixels or the kitty terminal graphics protocol. The built-in + terminal emulator of aerc (via the TUI library Vaxis) supports both. + Furthermore if you don't set any filter for images, Vaxis will figure + out what your terminal emulator supports and either use sixels, kitty + graphics, or fall back to a pixelated half-block. You can turn this + feature off, by setting a filter that is essentially no-op. + + You can still set a specific filter, e.g *catimg*(1): ``` image/\*=catimg -w$(tput cols) - |