about summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorhut <hut@lepus.uberspace.de>2015-03-18 22:11:01 +0100
committerhut <hut@lepus.uberspace.de>2015-03-18 22:11:01 +0100
commit7993ed4b19d57cfda0a22426cb0c3bcf88232bc3 (patch)
treee89c6830699621306e70ddbfb988efde43c842f8 /doc
parent9a879332d96e36fc348053cc0d23f03de73a2ed2 (diff)
parent7e85001052e4398f71e50e731899800106d2eefd (diff)
downloadranger-7993ed4b19d57cfda0a22426cb0c3bcf88232bc3.tar.gz
Merge branch 'add-iterm2-image-preview-support' of git://github.com/kattrali/ranger
Diffstat (limited to 'doc')
-rw-r--r--doc/ranger.121
-rw-r--r--doc/ranger.pod19
2 files changed, 32 insertions, 8 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1
index 42b32f70..3ba4fe4e 100644
--- a/doc/ranger.1
+++ b/doc/ranger.1
@@ -263,12 +263,25 @@ Install these programs (just the ones you need) and scope.sh will automatically
 use them.
 .PP
 Independently of the preview script, there is a feature to preview images
-by drawing them directly into the terminal.  This does not work over ssh,
-requires certain terminals (tested on \*(L"xterm\*(R" and \*(L"urxvt\*(R") and is incompatible
-with tmux, although it works with screen.
+by drawing them directly into the terminal. To enable this feature, set the
+option \f(CW\*(C`preview_images\*(C'\fR to true and enable one of the image preview modes:
+.PP
+\fIw3m\fR
+.IX Subsection "w3m"
+.PP
+This does not work over ssh, requires certain terminals (tested on \*(L"xterm\*(R" and
+\&\*(L"urxvt\*(R") and is incompatible with tmux, although it works with screen.
 .PP
 To enable this feature, install the program \*(L"w3m\*(R" and set the option
-\&\f(CW\*(C`preview_images\*(C'\fR to true.
+\&\f(CW\*(C`preview_images_method\*(C'\fR to w3m.
+.PP
+\fIiTerm2\fR
+.IX Subsection "iTerm2"
+.PP
+This only works in iTerm2 compiled with image preview support, but works over
+ssh.
+.PP
+To enable this feature, set the option \f(CW\*(C`preview_images_method\*(C'\fR to iterm2.
 .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 7b3354c4..336a886c 100644
--- a/doc/ranger.pod
+++ b/doc/ranger.pod
@@ -163,12 +163,23 @@ Install these programs (just the ones you need) and scope.sh will automatically
 use them.
 
 Independently of the preview script, there is a feature to preview images
-by drawing them directly into the terminal.  This does not work over ssh,
-requires certain terminals (tested on "xterm" and "urxvt") and is incompatible
-with tmux, although it works with screen.
+by drawing them directly into the terminal. To enable this feature, set the
+option C<preview_images> to true and enable one of the image preview modes:
+
+=head3 w3m
+
+This does not work over ssh, requires certain terminals (tested on "xterm" and
+"urxvt") and is incompatible with tmux, although it works with screen.
 
 To enable this feature, install the program "w3m" and set the option
-C<preview_images> to true.
+C<preview_images_method> to w3m.
+
+=head3 iTerm2
+
+This only works in iTerm2 compiled with image preview support, but works over
+ssh.
+
+To enable this feature, set the option C<preview_images_method> to iterm2.
 
 =head2 SELECTION