diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/howto-publish-a-release.md | 4 | ||||
| -rw-r--r-- | doc/ranger.1 | 34 | ||||
| -rw-r--r-- | doc/ranger.pod | 32 | ||||
| -rw-r--r-- | doc/rifle.1 | 22 |
4 files changed, 73 insertions, 19 deletions
diff --git a/doc/howto-publish-a-release.md b/doc/howto-publish-a-release.md index e8d669ce..6bd70047 100644 --- a/doc/howto-publish-a-release.md +++ b/doc/howto-publish-a-release.md @@ -37,7 +37,7 @@ Make a release commit * [ ] Write changelog entry * [ ] Think of a witty commit message * [ ] Commit -* [ ] Tag the signed release with `git tag -a <commit-id>`, using the same +* [ ] Tag the signed release with `git tag -as vX.Y.Z`, using the same commit message as annotation * [ ] Push release and tag @@ -73,4 +73,4 @@ Announce the update Change back to before --------------------- -* [ ] Change `VERSION` in `ranger/__init__.py` back to `master` +* [ ] Change `__release__` in `ranger/__init__.py` back to `False` diff --git a/doc/ranger.1 b/doc/ranger.1 index ea010eac..5a159e12 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.9.1" "2018-07-15" "ranger manual" +.TH RANGER 1 "ranger-1.9.2" "2018-10-26" "ranger manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -299,6 +299,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 a terminal with a nonzero border which is not automatically detected, the w3m preview will be misaligned. +Use the \f(CW\*(C`w3m_offset\*(C'\fR option to manually adjust the image offset. This should be the same value as the terminal's border value. +.PP \fIiTerm2\fR .IX Subsection "iTerm2" .PP @@ -667,6 +670,9 @@ the current directory. For a more permanent solution, use the command .IP ".n" 14 .IX Item ".n" Apply a new filename filter. +.IP ".m" 14 +.IX Item ".m" +Apply a new mimetype filter. .IP ".d" 14 .IX Item ".d" Apply the typefilter \*(L"directory\*(R". @@ -840,9 +846,16 @@ Display the free disk space in the status bar? .IP "display_tags_in_all_columns [bool]" 4 .IX Item "display_tags_in_all_columns [bool]" Display tags in all columns? -.IP "draw_borders [bool]" 4 -.IX Item "draw_borders [bool]" -Draw borders around columns? +.IP "draw_borders [string]" 4 +.IX Item "draw_borders [string]" +Draw borders around or between the columns? Possible values are: +.Sp +.Vb 4 +\& none no borders of any sort +\& outline draw an outline around all the columns +\& separators draw only vertical lines between columns +\& both both of the above +.Ve .IP "draw_progress_bar_in_status_bar [bool]" 4 .IX Item "draw_progress_bar_in_status_bar [bool]" Draw a progress bar in the status bar which displays the average state of all @@ -880,6 +893,9 @@ Otherwise the submaps are replaced with \*(L"...\*(R". .IP "hostname_in_titlebar [bool]" 4 .IX Item "hostname_in_titlebar [bool]" Show hostname in titlebar? +.IP "size_in_bytes [bool]" 4 +.IX Item "size_in_bytes [bool]" +Print file sizes in bytes instead of the default human-readable format. .IP "idle_delay [integer]" 4 .IX Item "idle_delay [integer]" The delay that ranger idly waits for user input, in milliseconds, with a @@ -1057,6 +1073,11 @@ traditional miller column view that shows multiple levels of the hierarchy, or .IX Item "w3m_delay [float]" Delay in seconds before displaying an image with the w3m method. Increase it in case of experiencing display corruption. +.IP "w3m_offset [int]" 4 +.IX Item "w3m_offset [int]" +Offset in pixels for the inner border of the terminal. Some terminals require +the offset to be specified explicitly, among others st and UXterm, some don't +like urxvt. .IP "wrap_scroll [bool]" 4 .IX Item "wrap_scroll [bool]" Enable scroll wrapping \- moving down while on the last item will wrap around to @@ -1463,6 +1484,9 @@ This can be used to re-evaluate the rc.conf file after changing it: .Vb 1 \& map X chain shell vim \-p %confdir/rc.conf %rangerdir/config/rc.conf; source %confdir/rc.conf .Ve +.IP "scroll_preview \fIvalue\fR" 2 +.IX Item "scroll_preview value" +Scroll the file preview by \fIvalue\fR lines. .IP "terminal" 2 .IX Item "terminal" Spawns the \fIx\-terminal-emulator\fR starting in the current directory. @@ -1641,7 +1665,7 @@ ranger is maintained with the git version control system. To fetch a fresh copy, run: .PP .Vb 1 -\& git clone git://git.savannah.nongnu.org/ranger.git +\& git clone git@github.com:ranger/ranger.git .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" diff --git a/doc/ranger.pod b/doc/ranger.pod index 5c668235..8fbc8826 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 a terminal with a nonzero border which is not automatically detected, the w3m preview will be misaligned. +Use the C<w3m_offset> option to manually adjust the image offset. This should be the same value as the terminal's border value. + =head3 iTerm2 This only works in iTerm2 compiled with image preview support, but works over @@ -628,6 +631,10 @@ the current directory. For a more permanent solution, use the command Apply a new filename filter. +=item .m + +Apply a new mimetype filter. + =item .d Apply the typefilter "directory". @@ -852,10 +859,15 @@ Display the free disk space in the status bar? Display tags in all columns? -=item draw_borders [bool] +=item draw_borders [string] -Draw borders around columns? +Draw borders around or between the columns? Possible values are: + none no borders of any sort + outline draw an outline around all the columns + separators draw only vertical lines between columns + both both of the above + =item draw_progress_bar_in_status_bar [bool] Draw a progress bar in the status bar which displays the average state of all @@ -896,6 +908,10 @@ Otherwise the submaps are replaced with "...". Show hostname in titlebar? +=item size_in_bytes [bool] + +Print file sizes in bytes instead of the default human-readable format. + =item idle_delay [integer] The delay that ranger idly waits for user input, in milliseconds, with a @@ -1110,6 +1126,12 @@ B<multipane> to use multiple panes (one per tab) similar to midnight-commander. Delay in seconds before displaying an image with the w3m method. Increase it in case of experiencing display corruption. +=item w3m_offset [int] + +Offset in pixels for the inner border of the terminal. Some terminals require +the offset to be specified explicitly, among others st and UXterm, some don't +like urxvt. + =item wrap_scroll [bool] Enable scroll wrapping - moving down while on the last item will wrap around to @@ -1563,6 +1585,10 @@ This can be used to re-evaluate the rc.conf file after changing it: map X chain shell vim -p %confdir/rc.conf %rangerdir/config/rc.conf; source %confdir/rc.conf +=item scroll_preview I<value> + +Scroll the file preview by I<value> lines. + =item terminal Spawns the I<x-terminal-emulator> starting in the current directory. @@ -1803,7 +1829,7 @@ GNU General Public License 3 or (at your option) any later version. ranger is maintained with the git version control system. To fetch a fresh copy, run: - git clone git://git.savannah.nongnu.org/ranger.git + git clone git@github.com:ranger/ranger.git diff --git a/doc/rifle.1 b/doc/rifle.1 index c8c679ec..9ed1a145 100644 --- a/doc/rifle.1 +++ b/doc/rifle.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== @@ -54,16 +54,20 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.if !\nF .nr F 0 -.if \nF>0 \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.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==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. @@ -129,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "RIFLE 1" -.TH RIFLE 1 "rifle-1.9.1" "2018-06-07" "rifle manual" +.TH RIFLE 1 "rifle-1.9.2" "2018-09-09" "rifle manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l |