From 52495e127b7a2364d764b150a47801dcd9729a30 Mon Sep 17 00:00:00 2001 From: sxyazi Date: Fri, 15 Mar 2024 01:14:42 +0800 Subject: [PATCH] docs: add `xclip` / `wl-clipboard` / `xsel` as optional dependencies --- docs/configuration/yazi.md | 2 +- docs/image-preview.md | 2 +- docs/installation.md | 3 +++ 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/configuration/yazi.md b/docs/configuration/yazi.md index 9e834a28..3d0bb2b1 100644 --- a/docs/configuration/yazi.md +++ b/docs/configuration/yazi.md @@ -136,7 +136,7 @@ This value determines the number of samples used during the training, range 10-2 - ueberzug_scale (Float): Ueberzug image scaling ratio, `scale>1` for enlargement, `scale<1` for reduction. For example, `0.5` indicates a reduction to half. - ueberzug_offset (`[x, y, width, height]`): Ueberzug image offset, in cell units. For example, `[0.5, 0.5, -0.5, -0.5]` indicates that the image is offset by half a cell in both directions, and the width and height are reduced by half a cell. -This is useful for solving [the bug of Ueberzug image size calculation](https://github.com/jstkdng/ueberzugpp/issues/122). +This is useful for solving [a bug of Überzug++ image size calculation](https://github.com/jstkdng/ueberzugpp/issues/122). If your monitor has a `2.0` scale factor, and is running on Wayland under Hyprland, you may need to set `ueberzug_scale: 0.5`, and adjust the value of `ueberzug_offset` according to your case, to offset this issue. diff --git a/docs/image-preview.md b/docs/image-preview.md index d155f6ba..e8c21143 100644 --- a/docs/image-preview.md +++ b/docs/image-preview.md @@ -85,7 +85,7 @@ That's it! you can now get Yazi's image preview working properly. ## Why can't I preview images via Überzug++? -This may be an issue with Überzug++, please try running `ueberzug layer` directly in the terminal without Yazi, and paste: +This may be an issue with Überzug++, please try running `ueberzugpp layer` directly in the terminal without Yazi, and paste: ```sh {"action":"add","identifier":"preview","max_height":0,"max_width":0,"path":"/your/image-path.jpg","x":0,"y":0} diff --git a/docs/installation.md b/docs/installation.md index b7ad273b..92e05858 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -20,6 +20,9 @@ Yazi can be _optionally_ extended with other command line tools to enable additi - [`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) +- [`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. ## Packaging status