mirrors/nnn
1
0
Fork 0
mirror of https://github.com/jarun/nnn.git synced 2024-11-27 13:21:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Live previews (markdown)

luukvbaal 2021-05-31 00:03:47 +02:00
parent 855726cab0
commit 3966df490d
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Live-previews.md

@ -31,15 +31,14 @@ Follow the instructions in the [plugin documentation](https://github.com/jarun/n
There are 2 previewer plugins for `nnn`, using various mechanisms to display the preview window:
- [preview-tabbed](https://github.com/jarun/nnn/blob/master/plugins/preview-tabbed): the preview window is a [tabbed](https://tools.suckless.org/tabbed) X window, files are viewed using Xembed capable programs ([mpv](https://mpv.io) for audio/video, [sxiv](https://github.com/muennich/sxiv) for images, [zathura](https://pwmt.org/projects/zathura) for PDF, xterm/urxvt/st + [nuke](https://github.com/jarun/nnn/blob/master/plugins/nuke) plugin text preview for other files)
- [preview-tui](https://github.com/jarun/nnn/blob/master/plugins/preview-tui): the preview window is either a tmux pane, a new terminal window or a [kitty](https://sw.kovidgoyal.net/kitty/) pane (needs kitty's `allow_remote_control` option turned on), and files are previewed using tools like tree, less, file, mediainfo, kitty's icat, [ueberzug](https://github.com/seebye/ueberzug) etc. On WSL it will use [QuickLook](https://github.com/QL-Win/QuickLook) to preview files. It can also use ranger's scope.sh or pistol. It's a good starting point from where you can build your own customized plugin.
- [preview-tui-ext](https://github.com/jarun/nnn/blob/master/plugins/preview-tui-ext): a more extended version of `preview-tui`, including ueberzug support and other optional dependencies. Meant to include preview support for an any file-type imaginable.
- [preview-tui](https://github.com/jarun/nnn/blob/master/plugins/preview-tui): the preview window is either a tmux pane, a new terminal window or a [kitty](https://sw.kovidgoyal.net/kitty/) pane (needs kitty's `allow_remote_control` option turned on), and files are previewed using tools like tree, less, file, mediainfo, kitty's icat, [ueberzug](https://github.com/seebye/ueberzug) etc. On WSL it will use [QuickLook](https://github.com/QL-Win/QuickLook) to preview files. It can also use ranger's scope.sh or pistol. Feel free to submit a pull-request for any previewer you feel is missing.
To run a previewer (or any plugin in general) when you start `nnn`, use the option `-P`
Notes:
1. `nnn` does not watch the hovered file and update the path if it's modified while under preview. Press <kbd>Esc</kbd> or click on the entry to update the preview without changing the hovered entry.
2. To close the `preview-tui(-ext)` preview windows run the plugin again or press <kbd>^C</kbd> on the preview window.
2. To close the `preview-tui` preview windows run the plugin again or press <kbd>^C</kbd> on the preview window.
## Custom script configuration example