diff --git a/docs/image-preview.md b/docs/image-preview.md index 67f709e4..26867e50 100644 --- a/docs/image-preview.md +++ b/docs/image-preview.md @@ -9,27 +9,27 @@ Yazi has done a lot of work to adapt to different terminals and multiplexers, tr This is by no means a simple task, to reduce maintenance costs, we only guarantee it is available in the **_latest version_** of terminals and multiplexers (tmux, Zellij): -| Platform | Protocol | Support | -| ----------------- | ----------------------------------------------------------------------------------------------------- | --------------------- | -| kitty | [Kitty unicode placeholders](https://sw.kovidgoyal.net/kitty/graphics-protocol/#unicode-placeholders) | ✅ Built-in | -| Konsole | [Kitty old protocol](https://github.com/sxyazi/yazi/blob/main/yazi-adaptor/src/kitty_old.rs) | ✅ Built-in | -| iTerm2 | [Inline images protocol](https://iterm2.com/documentation-images.html) | ✅ Built-in | -| WezTerm | [Inline images protocol](https://iterm2.com/documentation-images.html) | ✅ Built-in | -| Mintty (Git Bash) | [Inline images protocol](https://iterm2.com/documentation-images.html) | ✅ Built-in | -| foot | [Sixel graphics format](https://www.vt100.net/docs/vt3xx-gp/chapter14.html) | ✅ Built-in | -| Ghostty | [Kitty old protocol](https://github.com/sxyazi/yazi/blob/main/yazi-adaptor/src/kitty_old.rs) | ✅ Built-in | -| Black Box | [Sixel graphics format](https://www.vt100.net/docs/vt3xx-gp/chapter14.html) | ✅ Built-in | -| VSCode | [Inline images protocol](https://iterm2.com/documentation-images.html) | ✅ Built-in | -| Tabby | [Inline images protocol](https://iterm2.com/documentation-images.html) | ✅ Built-in | -| Hyper | [Inline images protocol](https://iterm2.com/documentation-images.html) | ✅ Built-in | -| X11 / Wayland | Window system protocol | ☑️ Überzug++ required | -| Fallback | [Chafa](https://hpjansson.org/chafa/) | ☑️ Überzug++ required | +| Platform | Protocol | Support | +| ----------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | +| kitty | [Kitty unicode placeholders](https://sw.kovidgoyal.net/kitty/graphics-protocol/#unicode-placeholders) | ✅ Built-in | +| Konsole | [Kitty old protocol](https://github.com/sxyazi/yazi/blob/main/yazi-adaptor/src/kitty_old.rs) | ✅ Built-in | +| iTerm2 | [Inline images protocol](https://iterm2.com/documentation-images.html) | ✅ Built-in | +| WezTerm | [Inline images protocol](https://iterm2.com/documentation-images.html) | ✅ Built-in | +| Mintty (Git Bash) | [Inline images protocol](https://iterm2.com/documentation-images.html) | ✅ Built-in | +| foot | [Sixel graphics format](https://www.vt100.net/docs/vt3xx-gp/chapter14.html) | ✅ Built-in | +| Ghostty | [Kitty old protocol](https://github.com/sxyazi/yazi/blob/main/yazi-adaptor/src/kitty_old.rs) | ✅ Built-in | +| Black Box | [Sixel graphics format](https://www.vt100.net/docs/vt3xx-gp/chapter14.html) | ✅ Built-in | +| VSCode | [Inline images protocol](https://iterm2.com/documentation-images.html) | ✅ Built-in | +| Tabby | [Inline images protocol](https://iterm2.com/documentation-images.html) | ✅ Built-in | +| Hyper | [Inline images protocol](https://iterm2.com/documentation-images.html) | ✅ Built-in | +| X11 / Wayland | Window system protocol | ☑️ [Überzug++](https://github.com/jstkdng/ueberzugpp) required | +| Fallback | [ASCII art (Unicode block)](https://en.wikipedia.org/wiki/ASCII_art) | ☑️ [Chafa](https://hpjansson.org/chafa/) required | Yazi automatically selects the appropriate preview method for you, based on the priority from top to bottom. That's relying on the `$TERM`, `$TERM_PROGRAM`, and `$XDG_SESSION_TYPE` variables, make sure you don't overwrite them by mistake! For instance, if your terminal is Alacritty, which doesn't support displaying images itself, but you are running on an X11/Wayland environment, -it will automatically use the "Window system protocol" to display images - this requires you to have [Überzug++](https://github.com/jstkdng/ueberzugpp) installed. +it will automatically use the "Window system protocol" to display images - this requires you to have Überzug++ installed. ## tmux users {#tmux} diff --git a/docs/installation.md b/docs/installation.md index 3bbf77e2..6735bce9 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -13,13 +13,14 @@ Yazi can be **optionally** extended with other command line tools to enable addi - [nerd-fonts](https://www.nerdfonts.com/) ([_recommended_](/docs/faq#dont-like-nerd-fonts)) - [`ffmpegthumbnailer`](https://github.com/dirkvdb/ffmpegthumbnailer) (for video thumbnails) -- [`unar`](https://theunarchiver.com/command-line) (for archive preview) +- [7-Zip](https://www.7-zip.org/) (for archive extraction and preview) - [`jq`](https://jqlang.github.io/jq/) (for JSON preview) - [`poppler`](https://poppler.freedesktop.org/) (for PDF preview) - [`fd`](https://github.com/sharkdp/fd) (for file searching) - [`rg`](https://github.com/BurntSushi/ripgrep) (for file content searching) - [`fzf`](https://github.com/junegunn/fzf) (for quick file subtree navigation) - [`zoxide`](https://github.com/ajeetdsouza/zoxide) (for historical directories navigation) +- [ImageMagick](https://imagemagick.org/) (for SVG, Font, HEIC, and JPEG XL preview) - [`xclip`](https://github.com/astrand/xclip) / [`wl-clipboard`](https://github.com/bugaevc/wl-clipboard) / [`xsel`](https://github.com/kfish/xsel) (for system clipboard support) If the functions are not working properly, please try upgrading them to the latest version. @@ -33,13 +34,13 @@ Most packages on this page are maintained by the community, and they **_may not ## Arch Linux ```sh -sudo pacman -S yazi ffmpegthumbnailer unarchiver jq poppler fd ripgrep fzf zoxide +sudo pacman -S yazi ffmpegthumbnailer p7zip jq poppler fd ripgrep fzf zoxide imagemagick ``` If you want to use the latest Git version, you can install it from [AUR](https://aur.archlinux.org/packages/yazi-git/) or [Arch Linux CN](https://github.com/archlinuxcn/repo/): ```sh -paru -S yazi-git ffmpegthumbnailer unarchiver jq poppler fd ripgrep fzf zoxide +paru -S yazi-git ffmpegthumbnailer p7zip jq poppler fd ripgrep fzf zoxide imagemagick ``` ## Nix @@ -209,7 +210,7 @@ First, make sure that Homebrew is fully up-to-date with `brew update`. Then you can install Yazi (and the optional dependencies): ```sh -brew install yazi ffmpegthumbnailer unar jq poppler fd ripgrep fzf zoxide font-symbols-only-nerd-font +brew install yazi ffmpegthumbnailer sevenzip jq poppler fd ripgrep fzf zoxide imagemagick font-symbols-only-nerd-font ``` If you prefer to use the most recent code, use the `--HEAD` flag when installing Yazi. @@ -221,7 +222,7 @@ brew install yazi --HEAD ## MacPorts ```bash -sudo port install yazi ffmpegthumbnailer unar jq poppler fd ripgrep fzf zoxide +sudo port install yazi ffmpegthumbnailer 7zip jq poppler fd ripgrep fzf zoxide ImageMagick ``` ## NetBSD @@ -253,7 +254,7 @@ You can download the latest official binaries from [GitHub Releases](https://git ```sh scoop install yazi # Install the optional dependencies (recommended): -scoop install unar jq poppler fd ripgrep fzf zoxide +scoop install unar jq poppler fd ripgrep fzf zoxide imagemagick ``` ## AOSC OS