diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cheatsheet.svg | 2 | ||||
| -rw-r--r-- | doc/ranger.1 | 52 | ||||
| -rw-r--r-- | doc/ranger.pod | 40 | ||||
| -rw-r--r-- | doc/rifle.1 | 6 | ||||
| -rw-r--r-- | doc/rifle.pod | 6 | ||||
| -rwxr-xr-x | doc/tools/convert_papermode_to_metadata.py | 6 |
6 files changed, 77 insertions, 35 deletions
diff --git a/doc/cheatsheet.svg b/doc/cheatsheet.svg index 0a6e46e7..aa2e2d72 100644 --- a/doc/cheatsheet.svg +++ b/doc/cheatsheet.svg @@ -4339,7 +4339,7 @@ y="271.36215" style="font-size:15px;line-height:1.25;font-family:sans-serif"><tspan style="font-weight:bold;font-family:sans-serif" - id="tspan5683">#ranger</tspan> on irc.freenode.net</tspan></text> + id="tspan5683">#ranger</tspan> on irc.libera.chat</tspan></text> <rect style="fill:#e6e6e6;fill-opacity:1;stroke:#000000;stroke-width:1.0020833;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" id="rect5634-3" diff --git a/doc/ranger.1 b/doc/ranger.1 index ecf4b168..5ce8566a 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.9.3" "2020-08-22" "ranger manual" +.TH RANGER 1 "ranger-1.9.3" "2021-09-01" "ranger manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -631,7 +631,7 @@ Reload everything Toggle \fIfreeze_files\fR setting. When active (indicated by a cyan \fI\s-1FROZEN\s0\fR message in the status bar), directories and files will not be loaded, improving performance when all the files you need are already loaded. This does not -affect file previews, which can be toggled with \fIzI\fR. Also try disabling the +affect file previews, which can be toggled with \fIzp\fR. Also try disabling the preview of directories with \fIzP\fR. .IP "^L" 14 .IX Item "^L" @@ -850,11 +850,11 @@ Backspace. .IX Header "MOUSE BUTTONS" .IP "Left Mouse Button" 4 .IX Item "Left Mouse Button" -Click on something and you'll move there. To run a file, \*(L"enter\*(R" it, like a -directory, by clicking on the preview. +Click on something and you'll move there. .IP "Right Mouse Button" 4 .IX Item "Right Mouse Button" -Enter a directory or run a file. +Enter a directory or run a file. To run a file you can either right click the +file in the main column or right click on the preview. .IP "Scroll Wheel" 4 .IX Item "Scroll Wheel" Scrolls up or down. You can point at the column of the parent directory while @@ -947,7 +947,7 @@ with the preview column being as large as the other columns combined. .IP "confirm_on_delete [string]" 4 .IX Item "confirm_on_delete [string]" Ask for a confirmation when running the \*(L"delete\*(R" command? Valid values are -\&\*(L"always\*(R" (default), \*(L"never\*(R", \*(L"multiple\*(R". With \*(L"multiple\*(R", ranger will ask only +\&\*(L"always\*(R", \*(L"never\*(R", \*(L"multiple\*(R" (default). With \*(L"multiple\*(R", ranger will ask only if you delete multiple files at once. .IP "dirname_in_tabs [bool]" 4 .IX Item "dirname_in_tabs [bool]" @@ -974,6 +974,16 @@ Draw borders around or between the columns? Possible values are: \& separators draw only vertical lines between columns \& both both of the above .Ve +.IP "draw_borders_multipane [string]" 4 +.IX Item "draw_borders_multipane [string]" +Draw borders around or between the panes. This setting overrides +\&\fIdraw_borders\fR specifically for the multipane viewmode in case you want +different border styles in both viewmodes. There's one additional legal value +on top of those for \fIdraw_borders\fR: +.Sp +.Vb 1 +\& active\-pane draw an outline around the active pane only +.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 @@ -1076,8 +1086,8 @@ will be temporarily disabled automatically. .IP "padding_right [bool]" 4 .IX Item "padding_right [bool]" When collapse_preview is on and there is no preview, should there remain a -little padding on the right? This allows you to click into that space to run -the file. +little padding on the right? This allows you to right click into that space to +run the file. .IP "preview_directories [bool] <zP>" 4 .IX Item "preview_directories [bool] <zP>" Preview directories in the preview column? @@ -1237,7 +1247,7 @@ ranger. For your convenience, this is a list of the \*(L"public\*(R" commands i \& chain command1[; command2[; command3...]] \& chmod octal_number \& cmap key command -\& console [\-pSTARTPOSITION] command +\& console [\-pSTARTPOSITION | \-s SENTINEL] command \& copycmap key newkey [newkey2...] \& copymap key newkey [newkey2...] \& copypmap key newkey [newkey2...] @@ -1331,10 +1341,12 @@ example, \fB+ar\fR allows reading for everyone, \-ow forbids others to write and 777= allows everything. .Sp See also: man 1 chmod -.IP "console [\-p\fIN\fR] \fIcommand\fR" 2 -.IX Item "console [-pN] command" -Opens the console with the command already typed in. The cursor is placed at -\&\fIN\fR. +.IP "console [\-p\fIN\fR | \-s \fIsentinel\fR] \fIcommand\fR" 2 +.IX Item "console [-pN | -s sentinel] command" +Opens the console with the command already typed in. The cursor is placed at +\&\fIN\fR or at the first occurrence of \fIsentinel\fR. Note that sentinel strings can +potentially occur inside macro expansions. If you cannot provide a sentinel +which is guaranteed to be unique, you should use \f(CW\*(C`\-p\*(C'\fR. .IP "copymap \fIkey\fR \fInewkey\fR [\fInewkey2\fR ...]" 2 .IX Item "copymap key newkey [newkey2 ...]" .PD 0 @@ -1936,9 +1948,17 @@ provided along with the source code. .IX Item "The project page: <https://ranger.github.io/>" .IP "The mailing list: <https://savannah.nongnu.org/mail/?group=ranger>" 4 .IX Item "The mailing list: <https://savannah.nongnu.org/mail/?group=ranger>" -.IP "\s-1IRC\s0 channel: #ranger on freenode.net" 4 -.IX Item "IRC channel: #ranger on freenode.net" +.IP "\s-1IRC\s0 channel: #ranger on irc.libera.chat" 4 +.IX Item "IRC channel: #ranger on irc.libera.chat" +.RS 4 .PD +.RS 9 +Don't have an \s-1IRC\s0 client? Join us via the webchat! +<https://web.libera.chat/#ranger> +.RE +.RE +.RS 4 +.RE .PP ranger is maintained with the git version control system. To fetch a fresh copy, run: diff --git a/doc/ranger.pod b/doc/ranger.pod index db5fa90f..3fdc37d3 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -578,7 +578,7 @@ Reload everything Toggle I<freeze_files> setting. When active (indicated by a cyan I<FROZEN> message in the status bar), directories and files will not be loaded, improving performance when all the files you need are already loaded. This does not -affect file previews, which can be toggled with I<zI>. Also try disabling the +affect file previews, which can be toggled with I<zp>. Also try disabling the preview of directories with I<zP>. =item ^L @@ -884,12 +884,12 @@ Backspace. =item Left Mouse Button -Click on something and you'll move there. To run a file, "enter" it, like a -directory, by clicking on the preview. +Click on something and you'll move there. =item Right Mouse Button -Enter a directory or run a file. +Enter a directory or run a file. To run a file you can either right click the +file in the main column or right click on the preview. =item Scroll Wheel @@ -1026,6 +1026,15 @@ Draw borders around or between the columns? Possible values are: separators draw only vertical lines between columns both both of the above +=item draw_borders_multipane [string] + +Draw borders around or between the panes. This setting overrides +I<draw_borders> specifically for the multipane viewmode in case you want +different border styles in both viewmodes. There's one additional legal value +on top of those for I<draw_borders>: + + active-pane draw an outline around the active pane only + =item draw_progress_bar_in_status_bar [bool] Draw a progress bar in the status bar which displays the average state of all @@ -1139,8 +1148,8 @@ will be temporarily disabled automatically. =item padding_right [bool] When collapse_preview is on and there is no preview, should there remain a -little padding on the right? This allows you to click into that space to run -the file. +little padding on the right? This allows you to right click into that space to +run the file. =item preview_directories [bool] <zP> @@ -1338,7 +1347,7 @@ ranger. For your convenience, this is a list of the "public" commands including chain command1[; command2[; command3...]] chmod octal_number cmap key command - console [-pSTARTPOSITION] command + console [-pSTARTPOSITION | -s SENTINEL] command copycmap key newkey [newkey2...] copymap key newkey [newkey2...] copypmap key newkey [newkey2...] @@ -1439,10 +1448,12 @@ example, B<+ar> allows reading for everyone, -ow forbids others to write and See also: man 1 chmod -=item console [-pI<N>] I<command> +=item console [-pI<N> | -s I<sentinel>] I<command> -Opens the console with the command already typed in. The cursor is placed at -I<N>. +Opens the console with the command already typed in. The cursor is placed at +I<N> or at the first occurrence of I<sentinel>. Note that sentinel strings can +potentially occur inside macro expansions. If you cannot provide a sentinel +which is guaranteed to be unique, you should use C<-p>. =item copymap I<key> I<newkey> [I<newkey2> ...] @@ -2148,7 +2159,14 @@ GNU General Public License 3 or (at your option) any later version. =item The mailing list: L<https://savannah.nongnu.org/mail/?group=ranger> -=item IRC channel: #ranger on freenode.net +=item IRC channel: #ranger on irc.libera.chat + +=over 9 + +Don't have an IRC client? Join us via the webchat! +L<https://web.libera.chat/#ranger> + +=back =back diff --git a/doc/rifle.1 b/doc/rifle.1 index b3dd6373..6b676162 100644 --- a/doc/rifle.1 +++ b/doc/rifle.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "RIFLE 1" -.TH RIFLE 1 "rifle-1.9.3" "2020-02-08" "rifle manual" +.TH RIFLE 1 "rifle-1.9.3" "2020-11-08" "rifle manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -216,8 +216,8 @@ List all the different methods: .PP .Vb 4 \& $ rifle \-l helloworld.py -\& 0:editor::"$EDITOR" \-\- "$@" -\& 1:pager::"$PAGER" \-\- "$@" +\& 0:editor::$EDITOR \-\- "$@" +\& 1:pager::$PAGER \-\- "$@" \& 2:::python \-\- "$1" .Ve .PP diff --git a/doc/rifle.pod b/doc/rifle.pod index e0abaa3b..63c8f9b3 100644 --- a/doc/rifle.pod +++ b/doc/rifle.pod @@ -72,7 +72,7 @@ rifle shares configuration files with ranger, though ranger is not required in order to use rifle. The default configuration file F<rifle.conf> is expected to be at F<~/.config/ranger/rifle.conf>. However, this can be overridden with the B<-c> option. Note that due to the nature of the configuration, rifle will -only read one file, it will not read the defaults in addition. +only read one file, it will not read the defaults in addition. This file specifies patterns for determining the commands to open files with. The syntax is described in the comments of the default F<rifle.conf> that ships @@ -117,8 +117,8 @@ Specifies the directory for configuration files. Defaults to F<$HOME/.config>. List all the different methods: $ rifle -l helloworld.py - 0:editor::"$EDITOR" -- "$@" - 1:pager::"$PAGER" -- "$@" + 0:editor::$EDITOR -- "$@" + 1:pager::$PAGER -- "$@" 2:::python -- "$1" Display its content by opening it with "cat": diff --git a/doc/tools/convert_papermode_to_metadata.py b/doc/tools/convert_papermode_to_metadata.py index 57459097..58371193 100755 --- a/doc/tools/convert_papermode_to_metadata.py +++ b/doc/tools/convert_papermode_to_metadata.py @@ -36,9 +36,10 @@ def replace(source, target): print("Skipping file `%s'" % source) return - result = dict() + result = {} # Read the input file and convert it to a dictionary + # pylint: disable=unspecified-encoding with open(".paperinfo", "r") as infile: reader = csv.reader(infile, skipinitialspace=True) for lineno, row in enumerate(reader): @@ -59,6 +60,9 @@ def replace(source, target): # Write the obtained dictionary into the target file if result: + # There's no way to specify encoding in 2.x even though in this case we + # could choose to write in UTF-8. + # pylint: disable=unspecified-encoding with open(".metadata.json", "w") as outfile: json.dump(result, outfile, indent=2) else: |
