1
1
mirror of https://github.com/wez/wezterm.git synced 2024-12-26 23:04:49 +03:00
wezterm/docs/imgcat.md

25 lines
758 B
Markdown
Raw Normal View History

2019-11-25 11:34:35 +03:00
wezterm implements support for the [iTerm2 inline images
protocol](https://iterm2.com/documentation-images.html) and provides a handy
`imgcat` subcommand to make it easy to try out. Because the protocol is
just a protocol, wezterm's `imgcat` also renders images in iTerm2.
To render an image inline in your terminal:
```console
2019-11-25 11:34:35 +03:00
$ wezterm imgcat /path/to/image.png
```
![inline image display](screenshots/wezterm-imgcat.png)
2020-01-01 05:33:24 +03:00
2019-11-25 11:34:35 +03:00
**Note that the image protocol isn't fully handled by multiplexer sessions
at this time**.
{{since('20220319-142410-0fcdea07')}}
WezTerm supports an extension to the protocol; passing `doNotMoveCursor=1` as
an argument to the `File` escape sequence causes wezterm to not move the cursor
position after processing the image.