1
1
mirror of https://github.com/wez/wezterm.git synced 2024-12-29 16:42:13 +03:00
wezterm/docs/imgcat.md
2022-03-19 16:37:27 -07:00

27 lines
821 B
Markdown

## iTerm Image Protocol Support
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:
```
$ wezterm imgcat /path/to/image.png
```
<img width="100%" height="100%" src="screenshots/wezterm-imgcat.png" alt="inline image display">
**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.