diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration/joshuto.toml.md | 2 | ||||
| -rw-r--r-- | docs/image_previews/README.md | 39 | ||||
| -rw-r--r-- | docs/image_previews/kitty.md | 71 |
3 files changed, 28 insertions, 84 deletions
diff --git a/docs/configuration/joshuto.toml.md b/docs/configuration/joshuto.toml.md index 7c90fc2..acec5bf 100644 --- a/docs/configuration/joshuto.toml.md +++ b/docs/configuration/joshuto.toml.md @@ -5,6 +5,8 @@ This file is for general configurations. All options available and their default values: ```toml +# Enables mouse support (true by default) +mouse_support = true # This is for configuring how many items to reach before 'scrolling' the view scroll_offset = 6 diff --git a/docs/image_previews/README.md b/docs/image_previews/README.md index a65c145..0223335 100644 --- a/docs/image_previews/README.md +++ b/docs/image_previews/README.md @@ -1,21 +1,38 @@ # Image Thumbnails in File Previews -Joshuto does not support image previews directly. -One reason is that Joshuto wants to stay independent of specific display protocols and terminal emulators. +Joshuto supports some terminal graphics protocols for image previews directly. +See [ratatui-image](https://github.com/benjajaja/ratatui-image?tab=readme-ov-file#compatibility-matrix) +for which terminals are supported. -However, Joshuto offers two text-preview-related hooks which allow to easily implement an -image preview with some simple scripts. +To disable or override the detected protocol, the `preview_protocol` option can +be used in the `joshuto.toml` file. Accepted values are `auto` (default), +`disabled`, or any of the [implemented protocols](https://docs.rs/ratatui-image/latest/ratatui_image/picker/enum.ProtocolType.html) +in lowercase. +```toml +[preview] +preview_protocol = "halfblocks" +... +``` + +However, since not all terminals have some graphics protocol implementation, +Joshuto offers two text-preview-related hooks which allow to easily implement +an image preview with some simple scripts. The hooks can be configured in the `joshuto.toml` file. ```toml [preview] ... -preview_shown_hook_script = "~/path/to/some/executable_script_1" -preview_removed_hook_script = "~/path/to/some/executable_script_2" +preview_script = "~/path/to/some/executable_script_1" +preview_shown_hook_script = "~/path/to/some/executable_script_2" +preview_removed_hook_script = "~/path/to/some/executable_script_3" ``` -The shown-hook is called whenever a new file-preview (in the 3rd pane) is activated. +The `preview_script` hook is called the first time for textual previews (thus +it's cached). If the script returns zero, then its output is displayed. + +The `preview_shown_hook_script` is called each time a file-preview (in the 3rd +pane) is focused. -The removed-hook will be called each time the file preview panel -completely disappears in Joshuto. +The `preview_removed_hook_script` will be called each time the file preview +panel completely disappears in Joshuto. That is the case if the user selects a file for which no file preview is shown (either due to missing output of the preview script or due to file size), if the preview is not cached already and the preview pane is temporarily removed, @@ -42,9 +59,6 @@ The “removed” script does not get any arguments. Using these hooks, one can trigger various actions when moving the cursor along files in Joshuto, and they can also be used to show image previews by the help of other 3rd party tools. -Keep in mind that the result of the “normal” `preview` script you use for textual previews -is cached by Joshuto and is not called every time a file is focused, but the “shown” hook is. - # Wrapper Script For some of the 3rd party tools, it's necessary to run them as a separate process, in parallel to Joshuto. @@ -60,7 +74,6 @@ in the terminal and then Joshuto. We have recipes for a few famous solutions. * [Überzug](ueberzug.md) (only for X11) * [Überzug++](ueberzugpp.md) (for X11, some Wayland compositors, and some specific terminal emulators) -* [Kitty](kitty.md) (for the Kitty terminal) ## Other Recipes and Tricks * [Combining text preview and image preview](combined_with_text.md) diff --git a/docs/image_previews/kitty.md b/docs/image_previews/kitty.md deleted file mode 100644 index 0fbddf2..0000000 --- a/docs/image_previews/kitty.md +++ /dev/null @@ -1,71 +0,0 @@ -# Image Previews with Kitty's `icat` - -The [Kitty](https://sw.kovidgoyal.net/kitty/) terminal must be [installed](https://sw.kovidgoyal.net/kitty/binary/#) -and used for the solution explained here. - -To preview images in Kitty, you need to create these two scripts and make them executable. - -`~/.config/joshuto/on_preview_shown`: - -```shell -#!/usr/bin/env bash - -FILE_PATH="$1" # Full path of the previewed file -PREVIEW_X_COORD="$2" # x coordinate of upper left cell of preview area -PREVIEW_Y_COORD="$3" # y coordinate of upper left cell of preview area -PREVIEW_WIDTH="$4" # Width of the preview pane (number of fitting characters) -PREVIEW_HEIGHT="$5" # Height of the preview pane (number of fitting characters) - -TMP_FILE="$HOME/.cache/joshuto/thumbcache.png" - -mimetype=$(file --mime-type -Lb "$FILE_PATH") - -function image { - kitty +kitten icat \ - --transfer-mode=file \ - --clear 2>/dev/null - kitty +kitten icat \ - --transfer-mode=file \ - --place "${PREVIEW_WIDTH}x${PREVIEW_HEIGHT}@${PREVIEW_X_COORD}x${PREVIEW_Y_COORD}" \ - "$1" 2>/dev/null -} - -function video { - ffmpegthumbnailer -i "$1" -o "${TMP_FILE}" -s 0 2>/dev/null - image "${TMP_FILE}" -} - -case "$mimetype" in - image/*) - image "${FILE_PATH}" - ;; - video/*) - video "${FILE_PATH}" - ;; - *) - kitty +kitten icat \ - --transfer-mode=file \ - --clear 2>/dev/null - ;; -esac -``` - -`~/.config/joshuto/on_preview_removed.sh`: - -```shell -#!/usr/bin/env bash - -kitty +kitten icat \ - --transfer-mode=file \ - --clear 2>/dev/null -``` - -The first script will use `icat` to place an image on top of joshuto's preview window. -If any images already exist, they will be cleared before showing the image. - -The second script simply clears any existing images on the screen. - -That's it. Previewing images should now work whenever you select a file. - - - |