diff options
Diffstat (limited to 'doc/ranger.pod')
| -rw-r--r-- | doc/ranger.pod | 55 |
1 files changed, 42 insertions, 13 deletions
diff --git a/doc/ranger.pod b/doc/ranger.pod index ac9970c5..713878f6 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -19,19 +19,29 @@ B<ranger> [B<--version>] [B<--help>] [B<--debug>] [B<--clean>] =head1 DESCRIPTION -ranger is a console file manager with VI key bindings. It provides a -minimalistic and nice curses interface with a view on the directory hierarchy. -The secondary task of ranger is to figure out which program you want to use to -open your files with. +ranger is a console file manager with VI key bindings. -This manual mainly contains information on the usage of ranger. Refer to the -F<README> for install instructions and to F<doc/HACKING> for development -specific information. For configuration, see the files in F<ranger/config>. -They are usually installed to F</usr/lib/python*/site-packages/ranger/config> -and can be obtained with ranger's --copy-config option. -Inside ranger, you can press I<1?> for a list of key bindings, I<2?> for a list -of commands and I<3?> for a list of settings. + + +=head1 RESOURCES + +I<This manual> contains instructions on how to use and configure ranger. + +I<Inside ranger>, you can press I<1?> for a list of key bindings, I<2?> for +commands and I<3?> for settings. + +The F<README> contains install instructions. + +The file F<doc/HACKING> contains guidelines for code modification. + +The directory F<doc/configs> contains configuration files. They are usually +installed to F</usr/lib/python*/site-packages/ranger/config> and can be +obtained with ranger's --copy-config option. + +The man page of rifle(1) describes the functions of the file opener + +The section I<LINKS> of this man page contains further resources. @@ -868,12 +878,16 @@ Examples: Displays only the files which contain the I<string> in their basename. Running this command without any parameter will reset the fitler. +This command is based on the I<scout> command and supports all of its options. + =item find I<pattern> Search files in the current directory that contain the given (case-insensitive) string in their name as you type. Once there is an unambiguous result, it will be run immediately. (Or entered, if it's a directory.) +This command is based on the I<scout> command and supports all of its options. + =item grep I<pattern> Looks for a string in all marked files or directories. @@ -898,6 +912,8 @@ not in the console, task view or pager. To bind keys there, use the commands Mark all files matching the regular expression pattern. +This command is based on the I<scout> command and supports all of its options. + =item mark_tag [I<tags>] Mark all tags that are tagged with either of the given tags. When leaving out @@ -910,8 +926,13 @@ Creates a directory with the name I<dirname>. =item open_with [I<application>] [I<flags>] [I<mode>] Open the selected files with the given application, unless it is omitted, in -which case the default application is used. I<flags> and I<mode> have their -own section in the man page. +which case the default application is used. I<flags> change the way the +application is executed and are described in their own section in this man +page. The I<mode> is a number that specifies which application to use. The list +of applications is generated by the external file opener "rifle" and can be +displayed when pressing "r" in ranger. + +Note that if you specify an application, the mode is ignored. =item pmap I<key> I<command> @@ -973,12 +994,16 @@ a :filter-like command using globbing. Search files in the current directory that match the given (case insensitive) regular expression pattern. +This command is based on the I<scout> command and supports all of its options. + =item search_inc I<pattern> Search files in the current directory that match the given (case insensitive) regular expression pattern. This command gets you to matching files as you type. +This command is based on the I<scout> command and supports all of its options. + =item set I<option> I<value> Assigns a new value to an option. Valid options are listed in the settings @@ -1023,6 +1048,8 @@ you type. When only one directory is left, it is entered and the console is automatically reopened, allowing for fast travel. To close the console, press ESC or execute a file. +This command is based on the I<scout> command and supports all of its options. + =item tunmap [I<keys ...>] Removes key mappings of the taskview. Works like the C<unmap> command. @@ -1036,6 +1063,8 @@ in the console, taskview, or pager use "cunmap", "tunmap" or "punmap". Unmark all files matching a regular expression pattern. +This command is based on the I<scout> command and supports all of its options. + =item unmark_tag [I<tags>] Unmark all tags that are tagged with either of the given tags. When leaving |