about summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authortoonn <toonn@toonn.io>2019-09-17 20:57:57 +0200
committertoonn <toonn@toonn.io>2019-09-17 21:01:43 +0200
commit061aabf404681e477302549ab42f43967dc53a64 (patch)
tree6506878981d5878b2d0463db42aa5f4f665b7beb /doc
parentbbb66cd9d7b27443f2d1a44f02c34f3b1ea851f7 (diff)
downloadranger-061aabf404681e477302549ab42f43967dc53a64.tar.gz
Document überzug preview method in the manpage
Fixes #1453
Diffstat (limited to 'doc')
-rw-r--r--doc/ranger.110
-rw-r--r--doc/ranger.pod9
2 files changed, 19 insertions, 0 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1
index c7825f15..6453cc79 100644
--- a/doc/ranger.1
+++ b/doc/ranger.1
@@ -317,6 +317,16 @@ This only works in terminology. It can render vector graphics, but works only lo
 .PP
 To enable this feature, set the option \f(CW\*(C`preview_images_method\*(C'\fR to terminology.
 .PP
+\fIueberzug\fR
+.IX Subsection "ueberzug"
+.PP
+U\*:berzug is a command line utility which draws images on terminals using child
+windows. It requires \s-1PIL \s0(or pillow) and relies on X11. This makes it
+compatible (in a limited way, i.e., tmux splits are not supported) with many
+terminals and tmux but not the linux console or Wayland.
+.PP
+To enable this feature, set the option \f(CW\*(C`preview_images_method\*(C'\fR to ueberzug.
+.PP
 \fIurxvt\fR
 .IX Subsection "urxvt"
 .PP
diff --git a/doc/ranger.pod b/doc/ranger.pod
index 620efdcc..61268855 100644
--- a/doc/ranger.pod
+++ b/doc/ranger.pod
@@ -225,6 +225,15 @@ This only works in terminology. It can render vector graphics, but works only lo
 
 To enable this feature, set the option C<preview_images_method> to terminology.
 
+=head3 ueberzug
+
+Überzug is a command line utility which draws images on terminals using child
+windows. It requires PIL (or pillow) and relies on X11. This makes it
+compatible (in a limited way, i.e., tmux splits are not supported) with many
+terminals and tmux but not the linux console or Wayland.
+
+To enable this feature, set the option C<preview_images_method> to ueberzug.
+
 =head3 urxvt
 
 This only works in urxvt compiled with pixbuf support. Does not work over ssh.