diff options
author | LeLobster <nhoise@live.nl> | 2018-10-05 00:04:39 +0200 |
---|---|---|
committer | LeLobster <nhoise@live.nl> | 2018-10-05 00:04:39 +0200 |
commit | 2679b379d2ee9816ddd65d23f635663da61abe29 (patch) | |
tree | 5aa9a04de29b3b2ef07ec9b138d8fac256fb4772 /doc | |
parent | addcfa2823e994fbebf1a8740a9e986cc41fa340 (diff) | |
download | ranger-2679b379d2ee9816ddd65d23f635663da61abe29.tar.gz |
Add comment about st_border_offset in the man page
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ranger.1 | 33 | ||||
-rw-r--r-- | doc/ranger.pod | 3 | ||||
-rw-r--r-- | doc/rifle.1 | 22 |
3 files changed, 28 insertions, 30 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1 index 4bbcc60c..24ae284c 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== @@ -54,20 +54,16 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{\ -. if \nF \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.if !\nF .nr F 0 +.if \nF>0 \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -. if !\nF==2 \{\ -. nr % 0 -. nr F 2 -. \} +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 . \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.9.2" "2018-09-10" "ranger manual" +.TH RANGER 1 "ranger-1.9.2" "10/05/2018" "ranger manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -173,7 +169,7 @@ plugins, sample configuration files and some programs for integrating ranger with other software. They are usually installed to \&\fI/usr/share/doc/ranger/examples\fR. .PP -The man page of \fBrifle\fR\|(1) describes the functions of the file opener +The man page of \fIrifle\fR\|(1) describes the functions of the file opener .PP The section \fI\s-1LINKS\s0\fR of this man page contains further resources. .SH "POSITIONAL ARGUMENTS" @@ -299,6 +295,9 @@ This does not work over ssh, requires certain terminals (tested on \*(L"xterm\*( To enable this feature, install the program \*(L"w3m\*(R" and set the option \&\f(CW\*(C`preview_images_method\*(C'\fR to w3m. .PP +When using \*(L"st\*(R" with a compiled border larger than 0 the w3m preview will be misaligned. +Use the \f(CW\*(C`st_border_offset\*(C'\fR option to manually adjust the image offset. This should be the same value as st's borderpx. +.PP \fIiTerm2\fR .IX Subsection "iTerm2" .PP @@ -339,7 +338,7 @@ To enable this feature, set the option \f(CW\*(C`preview_images_method\*(C'\fR t \fIkitty\fR .IX Subsection "kitty" .PP -This only works on Kitty. It requires \s-1PIL\s0 (or pillow) to work. +This only works on Kitty. It requires \s-1PIL \s0(or pillow) to work. Allows remote image previews, for example in an ssh session. .PP To enable this feature, set the option \f(CW\*(C`preview_images_method\*(C'\fR to kitty. @@ -625,7 +624,7 @@ Toggle the mark-status of all files .IP "V" 14 .IX Item "V" Starts the visual mode, which selects all files between the starting point and -the cursor until you press \s-1ESC.\s0 To unselect files in the same way, use \*(L"uV\*(R". +the cursor until you press \s-1ESC. \s0 To unselect files in the same way, use \*(L"uV\*(R". .IP "/" 14 Search for files in the current directory. .IP ":" 14 @@ -1655,7 +1654,7 @@ copy, run: .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fBrifle\fR\|(1) +\&\fIrifle\fR\|(1) .SH "BUGS" .IX Header "BUGS" Report bugs here: <https://github.com/ranger/ranger/issues> diff --git a/doc/ranger.pod b/doc/ranger.pod index 637973ac..77d1e18a 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -209,6 +209,9 @@ This does not work over ssh, requires certain terminals (tested on "xterm" and To enable this feature, install the program "w3m" and set the option C<preview_images_method> to w3m. +When using "st" with a compiled border larger than 0 the w3m preview will be misaligned. +Use the C<st_border_offset> option to manually adjust the image offset. This should be the same value as st's borderpx. + =head3 iTerm2 This only works in iTerm2 compiled with image preview support, but works over diff --git a/doc/rifle.1 b/doc/rifle.1 index 9ed1a145..bcd82df0 100644 --- a/doc/rifle.1 +++ b/doc/rifle.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== @@ -54,20 +54,16 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{\ -. if \nF \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.if !\nF .nr F 0 +.if \nF>0 \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -. if !\nF==2 \{\ -. nr % 0 -. nr F 2 -. \} +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 . \} .\} -.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -133,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "RIFLE 1" -.TH RIFLE 1 "rifle-1.9.2" "2018-09-09" "rifle manual" +.TH RIFLE 1 "rifle-1.9.2" "10/05/2018" "rifle manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l |