diff options
| -rw-r--r-- | doc/ranger.1 | 16 | ||||
| -rw-r--r-- | doc/ranger.pod | 14 |
2 files changed, 27 insertions, 3 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1 index 6d9afbb0..d3d6841c 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -124,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.5.5" "02/18/2013" "ranger manual" +.TH RANGER 1 "ranger-1.5.5" "02/22/2013" "ranger manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -226,7 +226,7 @@ typing \fI"<tagname>\fR. .SS "\s-1PREVIEWS\s0" .IX Subsection "PREVIEWS" By default, only text files are previewed, but you can enable external preview -scripts by setting the option \f(CW\*(C`use_preview_script\*(C'\fR and \f(CW\*(C`preview_files\*(C'\fR to True. +scripts by setting the option \f(CW\*(C`use_preview_script\*(C'\fR and \f(CW\*(C`preview_files\*(C'\fR to true. .PP This default script is \fI~/.config/ranger/scope.sh\fR. It contains more documentation and calls to the programs \fIlynx\fR and \fIelinks\fR for html, @@ -235,6 +235,14 @@ documentation and calls to the programs \fIlynx\fR and \fIelinks\fR for html, .PP 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. +.PP +To enable this feature, install the program \*(L"w3m\*(R" and set the option +\&\f(CW\*(C`preview_images\*(C'\fR to true. .SS "\s-1SELECTION\s0" .IX Subsection "SELECTION" The \fIselection\fR is defined as \*(L"All marked files \s-1IF\s0 \s-1THERE\s0 \s-1ARE\s0 \s-1ANY\s0, otherwise @@ -270,6 +278,10 @@ are in different directories: .PP Macros for file paths are generally shell-escaped so they can be used in the \&\f(CW\*(C`shell\*(C'\fR command. +.PP +Additionally, if you create a key binding that uses <any>, a special statement +which accepts any key, then the macro \f(CW%any\fR (or \f(CW%any0\fR, \f(CW%any1\fR, \f(CW%any2\fR, ...) can be +used in the command to get the key that was pressed. .SS "\s-1BOOKMARKS\s0" .IX Subsection "BOOKMARKS" Type \fBm<key>\fR to bookmark the current directory. You can re-enter this diff --git a/doc/ranger.pod b/doc/ranger.pod index a8800498..b5a14b76 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -131,7 +131,7 @@ typing I<"<tagnameE<gt>>. =head2 PREVIEWS By default, only text files are previewed, but you can enable external preview -scripts by setting the option C<use_preview_script> and C<preview_files> to True. +scripts by setting the option C<use_preview_script> and C<preview_files> to true. This default script is F<~/.config/ranger/scope.sh>. It contains more documentation and calls to the programs I<lynx> and I<elinks> for html, @@ -141,6 +141,14 @@ I<pdftotext> for PDFs and I<mediainfo> for video and audio files. 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. + +To enable this feature, install the program "w3m" and set the option +C<preview_images> to true. + =head2 SELECTION The I<selection> is defined as "All marked files IF THERE ARE ANY, otherwise @@ -174,6 +182,10 @@ are in different directories: Macros for file paths are generally shell-escaped so they can be used in the C<shell> command. +Additionally, if you create a key binding that uses <any>, a special statement +which accepts any key, then the macro %any (or %any0, %any1, %any2, ...) can be +used in the command to get the key that was pressed. + =head2 BOOKMARKS Type B<m<keyE<gt>> to bookmark the current directory. You can re-enter this |