summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authormark-dawn <albama92@gmail.com>2018-02-14 01:16:38 +0100
committermark-dawn <albama92@gmail.com>2018-05-29 10:06:08 +0200
commitb512e309a0a09ee88c6866535ed23ec80f7aaef9 (patch)
treedd16e298169c17841d9efbce468a6684e1a3b178 /doc
parent41fa04be14857f83d32ea7b55b48292bc8f2393b (diff)
downloadranger-b512e309a0a09ee88c6866535ed23ec80f7aaef9.tar.gz
Kitty image display alpha, merge-ready
Added more comments to the code
reverted changes to default values in rc.conf
addes explanations in rc.config about the new options
Couple of small stylistic corrections after running make test
Updated the man pages
Diffstat (limited to 'doc')
-rw-r--r--doc/ranger.117
-rw-r--r--doc/ranger.pod15
2 files changed, 32 insertions, 0 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1
index 1290cb58..f8f0bd8c 100644
--- a/doc/ranger.1
+++ b/doc/ranger.1
@@ -324,6 +324,23 @@ The same as urxvt but utilizing not only the preview pane but the whole terminal
 window.
 .PP
 To enable this feature, set the option \f(CW\*(C`preview_images_method\*(C'\fR to urxvt-full.
+.PP
+\fIkitty\fR
+.IX Subsection "kitty"
+.PP
+This only works on Kitty.
+It requires \s-1PIL\s0 or pillow at the moment to work. A nasty bug that can
+corrupt the terminal window when scrolling quicly many images, that can
+be solved by with the \f(CW\*(C`redraw_window\*(C'\fR command.
+.PP
+To enable this feature, set the option \f(CW\*(C`preview_images_method\*(C'\fR to kitty
+.PP
+\fIkitty-network\fR
+.IX Subsection "kitty-network"
+.PP
+The same as kitty, but uses a streaming method to allow previews remotely,
+for example in an ssh session. However the system is slighly more computationally taxing
+and the quality of the preview is reduced for bandwidth considerations.
 .SS "\s-1SELECTION\s0"
 .IX Subsection "SELECTION"
 The \fIselection\fR is defined as \*(L"All marked files \s-1IF THERE ARE ANY,\s0 otherwise
diff --git a/doc/ranger.pod b/doc/ranger.pod
index 4cac8ef9..79a61a98 100644
--- a/doc/ranger.pod
+++ b/doc/ranger.pod
@@ -236,6 +236,21 @@ window.
 
 To enable this feature, set the option C<preview_images_method> to urxvt-full.
 
+=head3 kitty
+
+This only works on Kitty.
+It requires PIL or pillow at the moment to work. A nasty bug that can
+corrupt the terminal window when scrolling quicly many images, that can
+be solved by with the C<redraw_window> command.
+
+To enable this feature, set the option C<preview_images_method> to kitty
+
+=head3 kitty-network
+
+The same as kitty, but uses a streaming method to allow previews remotely,
+for example in an ssh session. However the system is slighly more computationally taxing
+and the quality of the preview is reduced for bandwidth considerations.
+
 =head2 SELECTION
 
 The I<selection> is defined as "All marked files IF THERE ARE ANY, otherwise