diff options
| author | Delisa Mason <iskanamagus@gmail.com> | 2015-03-08 16:13:43 -0700 |
|---|---|---|
| committer | Delisa Mason <iskanamagus@gmail.com> | 2015-03-08 16:39:30 -0700 |
| commit | 84417076a58ec3be7ad08ca959b5bacab8955e72 (patch) | |
| tree | b3096026d3cf0efc23c523619ed2b66d6e1b021f /doc | |
| parent | 30e73031874b6fcf63459a2e658893823a3e5a21 (diff) | |
| download | ranger-84417076a58ec3be7ad08ca959b5bacab8955e72.tar.gz | |
Update documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ranger.1 | 21 | ||||
| -rw-r--r-- | doc/ranger.pod | 19 |
2 files changed, 32 insertions, 8 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1 index 42b32f70..34b1d0d7 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`use_w3m_image_preview\*(C'\fR to true. +.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`use_iterm2_image_preview\*(C'\fR to true. .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 75da97b9..7575e5b6 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<use_w3m_image_preview> to true. + +=head3 iTerm2 + +This only works in iTerm2 compiled with image preview support, but works over +ssh. + +To enable this feature, set the option C<use_iterm2_image_preview> to true. =head2 SELECTION |