diff options
Diffstat (limited to 'doc/ranger.pod')
| -rw-r--r-- | doc/ranger.pod | 48 |
1 files changed, 27 insertions, 21 deletions
diff --git a/doc/ranger.pod b/doc/ranger.pod index 38b3ca17..8f6cc62a 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -93,8 +93,8 @@ down 5 lines, I<2l> to open a file in mode 2, I<10<SpaceE<gt>> to mark 10 files or I<3?> to read the third chapter of the documentation. Key bindings can be changed. Detailed instructions for this are in the -key binding configuration file at ranger/defaults/keys.py. You can copy it to -your local configuration directory with the --copy-config option. +key binding configuration file at F<ranger/defaults/keys.py>. You can copy it +to your local configuration directory with the --copy-config option. =over 14 @@ -320,9 +320,10 @@ This section lists all built-in settings of ranger. The valid types for the value are in [brackets]. The hotkey to toggle the setting is in <brokets>, if a hotkey exists. -Settings can be changed in the file ~/.config/ranger/options.py or on the fly -with the command B<:set option value>. Examples: C<:set column_ratios (1,2,3)>, -C<:set show_hidden=True> +Settings can be changed in the file F<~/.config/ranger/options.py> or on the +fly with the command B<:set option value>. Examples: + :set column_ratios (1,2,3) + :set show_hidden=True =over @@ -337,7 +338,7 @@ loss. When false, bookmarks are saved when ranger is exited. When no preview is visible, should the last column be squeezed to make use of the whitespace? -=item colorscheme_overlay [python function, None] +=item colorscheme_overlay [function, None] An overlay function for colorschemes. See the default options.py for an explanation and an example. @@ -384,7 +385,7 @@ Flush the input after each key hit? One advantage is that when scrolling down with "j", ranger stops scrolling instantly when you release the key. One disadvantage is that when you type commands blindly, some keys might get lost. -=item hidden_filter [regular expression] +=item hidden_filter [regexp] A regular expression pattern for files which should be hidden. @@ -448,7 +449,8 @@ Show hidden files? =item sort_case_insensitive [bool] <zc> -Sort case-insensitively? If true, "a" will be listed before "B" even though its ASCII value is higher. +Sort case-insensitively? If true, "a" will be listed before "B" even though +its ASCII value is higher. =item sort_directories_first [bool] <zd> @@ -561,8 +563,8 @@ Looks for a string in all marked files or directories. =item load_copy_buffer -Load the copy buffer from I<confdir/copy_buffer>. This can be used to pass the -list of copied files to another ranger instance. +Load the copy buffer from F<~/.config/ranger/copy_buffer>. This can be used to +pass the list of copied files to another ranger instance. =item mark I<pattern> @@ -618,10 +620,11 @@ doesn't work for functions and regular expressions. Valid values are: None None bool True or False + integer 0 or 1 or -1 or 2 etc. list [1, 2, 3] tuple 1, 2, 3 or (1, 2, 3) function lambda <arguments>: <expression> - regexp regexp('<regexp>') + regexp regexp('<pattern>') string Anything =item shell [-I<flags>] I<command> @@ -648,18 +651,21 @@ Unmark all files matching a regular expression pattern. =head1 FILES ranger reads several configuration files which are located in -$HOME/.config/ranger or $XDG_CONFIG_HOME/ranger if $XDG_CONFIG_HOME is defined. -The configuration is done mostly in python. When removing a configuration file, -remove its compiled version too. (Python automatically compiles modules. -Since python3 they are saved in the __pycache__ directory, earlier versions -store them with the .pyc extension in the same directory.) +F<$HOME/.config/ranger> or F<$XDG_CONFIG_HOME/ranger> if $XDG_CONFIG_HOME is +defined. The configuration is done mostly in python. When removing a +configuration file, remove its compiled version too. (Python automatically +compiles modules. Since python3 they are saved in the __pycache__ directory, +earlier versions store them with the .pyc extension in the same directory.) Use the --copy-config option to obtain the default configuration files. They include further documentation and it's too much to put here. You don't need to copy the whole file though, most configuration files are -overlaid on top of the defaults (options.py, command.py, keys.py) or can be -sub-classed (apps.py, colorschemes). +overlaid on top of the defaults (F<options.py>, F<command.py>, F<keys.py>) or +can be sub-classed (F<apps.py>, F<colorschemes>). + +When starting ranger with the B<--clean> option, it will not access or create +any of these files. =head2 CONFIGURATION @@ -747,7 +753,7 @@ the "S" key. Defaults to "bash". =item XDG_CONFIG_HOME -Specifies the directory for configuration files. Defaults to "$HOME/.config". +Specifies the directory for configuration files. Defaults to F<$HOME/.config>. =back @@ -773,8 +779,8 @@ opening in your current vim session. =head2 Bash: cd to last path after exit -This is a bash function (to put in your ~/.bashrc) to change the directory to -the last visited one after ranger quits. You can always type C<cd -> to go +This is a bash function (to put in your F<~/.bashrc>) to change the directory +to the last visited one after ranger quits. You can always type C<cd -> to go back to the original one. function ranger-cd { |