summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorjohn <john.luke.greco@gmail.com>2017-10-22 13:44:09 -0700
committerjohn <john.luke.greco@gmail.com>2017-10-22 14:21:17 -0700
commit538986719e81987d7a08aa083757f345fa9acaee (patch)
tree56309370d5c2bc64b17b4aeb2dbcd4fbea0fb847 /doc
parent5375eb89664764a3c17444367d0f561733ca3422 (diff)
downloadranger-538986719e81987d7a08aa083757f345fa9acaee.tar.gz
Add config opts for iTerm2 font size (for preview)
Add two config options "iterm2_font_width" and "iterm2_font_height" that
override the default values of _minimum_font_width and
_minimum_font_height in ITerm2ImageDisplayer.  The default values may
cause preview distortion if set too high (Issue #499) or result in the
preview being smaller than necessary if set too low.
Diffstat (limited to 'doc')
-rw-r--r--doc/ranger.16
-rw-r--r--doc/ranger.pod4
-rw-r--r--doc/rifle.12
3 files changed, 10 insertions, 2 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1
index f96c7f20..cd00cd95 100644
--- a/doc/ranger.1
+++ b/doc/ranger.1
@@ -129,7 +129,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RANGER 1"
-.TH RANGER 1 "ranger-1.9.0b5" "10/01/2017" "ranger manual"
+.TH RANGER 1 "ranger-1.9.0b5" "10/22/2017" "ranger manual"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -296,6 +296,10 @@ ssh.
 .PP
 To enable this feature, set the option \f(CW\*(C`preview_images_method\*(C'\fR to iterm2.
 .PP
+This feature relies on the dimensions of the terminal's font.  By default, a
+width of 8 and height of 11 are used.  To use other values, set the options
+\&\f(CW\*(C`iterm2_font_width\*(C'\fR and \f(CW\*(C`iterm2_font_height\*(C'\fR to the desired values.
+.PP
 \fIurxvt\fR
 .IX Subsection "urxvt"
 .PP
diff --git a/doc/ranger.pod b/doc/ranger.pod
index 310ab1fd..43926f46 100644
--- a/doc/ranger.pod
+++ b/doc/ranger.pod
@@ -201,6 +201,10 @@ ssh.
 
 To enable this feature, set the option C<preview_images_method> to iterm2.
 
+This feature relies on the dimensions of the terminal's font.  By default, a
+width of 8 and height of 11 are used.  To use other values, set the options
+C<iterm2_font_width> and C<iterm2_font_height> to the desired values.
+
 =head3 urxvt
 
 This only works in urxvt compiled with pixbuf support. Does not work over ssh.
diff --git a/doc/rifle.1 b/doc/rifle.1
index 4d501df0..9d9e08f9 100644
--- a/doc/rifle.1
+++ b/doc/rifle.1
@@ -129,7 +129,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RIFLE 1"
-.TH RIFLE 1 "rifle-1.9.0b5" "10/01/2017" "rifle manual"
+.TH RIFLE 1 "rifle-1.9.0b5" "10/22/2017" "rifle manual"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l