diff options
Diffstat (limited to 'doc/ranger.pod')
| -rw-r--r-- | doc/ranger.pod | 153 |
1 files changed, 145 insertions, 8 deletions
diff --git a/doc/ranger.pod b/doc/ranger.pod index 7dc50d32..67297d18 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -7,7 +7,7 @@ ranger - visual file manager =head1 SYNOPSIS -B<ranger> [B<--version>] [B<--help>] [B<--debug>] [B<--clean>] +B<ranger> [B<--version>] [B<--help>] [B<--debug>] [B<--clean>] [B<--confdir>=I<directory>] [B<--copy-config>=I<which>] [B<--choosefile>=I<target>] [B<--choosefiles>=I<target>] [B<--choosedir>=I<target>] [B<--selectfile>=I<filepath>] @@ -33,7 +33,7 @@ commands and I<3?> for settings. The F<README> contains install instructions. -The file F<doc/HACKING> contains guidelines for code modification. +The file F<HACKING.md> 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 @@ -134,7 +134,7 @@ efficiently. =head2 TAGS Tags are single characters which are displayed left of a filename. You can use -tags however you want. Press "t" to toggle tags and "T" to remove any tags of +tags however you want. Press "t" to toggle tags and "ut" to remove any tags of the selection. The default tag is an Asterisk ("*"), but you can use any tag by typing I<"<tagnameE<gt>>. @@ -317,6 +317,10 @@ Move to the top Move to the bottom +=item [, ] + +Move up and down in the parent directory. + =item ^R Reload everything @@ -327,7 +331,7 @@ Redraw the screen =item i -Display the current file in a bigger window. +Inspect the current file in a bigger window. =item E @@ -341,6 +345,22 @@ Open a shell in the current directory Opens this man page +=item W + +Opens the log window where you can review messages that pop up at the bottom. + +=item w + +Opens the task window where you can view and modify background processes that +currently run in ranger. In there, you can type "dd" to abort a process and +"J" or "K" to change the priority of a process. Only one process is run at a +time. + +=item ^C + +Stop the currently running background process that ranger has started, like +copying files, loading directories or file previews. + =item <octal>=, +<who><what>, -<who><what> Change the permissions of the selection. For example, C<777=> is equivalent to @@ -363,6 +383,19 @@ modern GUI programs. Paste the copied/cut files, overwriting existing files. +=item pl, pL + +Create symlinks (absolute or relative) to the copied files + +=item phl + +Create hardlinks to the copied files + +=item pht + +Duplicate the subdirectory tree of the copied directory, then create +hardlinks for each contained file into the new directory tree. + =item mI<X> Create a bookmark with the name I<X> @@ -421,6 +454,25 @@ Search for files in the current directory. Open the console. +=item ! + +Open the console with the content "shell " so you can quickly run commands + +=item @ + +Open the console with the content "shell %s", placing the cursor before the +" %s" so you can quickly run commands with the current selection as the +argument. + +=item r + +Open the console with the content "open with " so you can decide which program +to use to open the current file selection. + +=item cd + +Open the console with the content "cd " + =item Alt-I<N> Open a tab. N has to be a number from 0 to 9. If the tab doesn't exist yet, it @@ -438,6 +490,12 @@ Go to the next or previous tab. You can also use TAB and SHIFT+TAB instead. Close the current tab. The last tab cannot be closed this way. +=item M + +A key chain that allows you to quickly change the line mode of all the files of +the current directory. For a more permanent solution, use the command +"default_linemode" in your rc.conf. + =back =head2 READLINE-LIKE BINDINGS IN THE CONSOLE @@ -603,6 +661,12 @@ this pattern will hide all files that start with a dot or end with a tilde. set hidden_filter ^\.|~$ +=item idle_delay [integer] + +The delay that ranger idly waits for user input, in milliseconds, with a +resolution of 100ms. Lower delay reduces lag between directory updates but +increases CPU load. + =item max_console_history_size [integer, none] How many console commands should be kept in history? "none" will disable the @@ -612,6 +676,12 @@ limit. How many directory changes should be kept in history? +=item metadata_deep_search [bool] + +When the metadata manager module looks for metadata, should it only look for a +".metadata.json" file in the current directory, or do a deep search and check +all directories above the current one as well? + =item mouse_enabled [bool] <zm> Enable mouse input? @@ -684,10 +754,10 @@ Sort directories first? Reverse the order of files? -=item sort [string] <oa>, <ob>, <oc>, <om>, <on>, <ot>, <os> +=item sort [string] <oa>, <ob>, <oc>, <om>, <on>, <ot>, <os>, <oz> Which sorting mechanism should be used? Choose one of B<atime>, B<basename>, -B<ctime>, B<mtime>, B<natural>, B<type>, B<size> +B<ctime>, B<mtime>, B<natural>, B<type>, B<size>, B<random> Note: You can reverse the order by typing an uppercase second letter in the key combination, e.g. "oN" to sort from Z to A. @@ -723,7 +793,7 @@ Gather and display data about version control systems. Supported vcs: git, hg. =item vcs_backend_git, vcs_backend_hg, vcs_backend_bzr [string] Sets the state for the version control backend. The possible values are: - + disabled don't display any information. local display only local state. enabled display both, local and remote state. May be slow for hg and bzr. @@ -755,23 +825,30 @@ ranger. For your convenience, this is a list of the "public" commands including copypmap key newkey [newkey2...] copytmap key newkey [newkey2...] cunmap keys... + default_linemode [path=regexp | tag=tags] linemodename delete edit [filename] eval [-q] python_code filter [string] + filter_inode_type [dfl] find pattern + flat level grep pattern + linemode linemodename load_copy_buffer map key command mark pattern mark_tag [tags] + meta key value mkdir dirname open_with [application] [flags] [mode] pmap key command + prompt_metadata [key1 [key2 [...]]] punmap keys... quit quit! relink newpath + rename_append rename newname save_copy_buffer scout [-FLAGS] pattern @@ -869,6 +946,21 @@ See C<copymap> Removes key mappings of the console. Works like the C<unmap> command. +=item default_linemode [I<path=regexp> | I<tag=tags>] I<linemodename> + +Sets the default linemode. See I<linemode> command. + +Examples: + +Set the global default linemode to "permissions": + :default_linemode permissions + +Set the default linemode to "permissions" for all files tagged with "p" or "P": + :default_linemode tag=pP permissions + +Set the default linemode for all files in ~/books/ to "metatitle": + :default_linemode path=/home/.*?/books/.* metatitle + =item delete Destroy all files in the selection with a roundhouse kick. ranger will ask for @@ -897,6 +989,13 @@ 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 filter_inode_type [dfl] + +Displays only the files of specified inode type. To display only directories, +use the 'd' parameter. To display only files, use the 'f' parameter. To display +only links, use the 'l' parameter. Parameters can be combined. To remove this +filter, use no parameter. + =item find I<pattern> Search files in the current directory that contain the given (case-insensitive) @@ -905,10 +1004,26 @@ 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 flat level + +Flattens the directory view up to the specified level. Level -1 means infinite +level. Level 0 means standard view without flattened directory view. Level +values -2 and less are invalid. + =item grep I<pattern> Looks for a string in all marked files or directories. +=item linemode I<linemodename> + +Sets the linemode of all files in the current directory. The linemode may be: + + "filename": display each line as "<basename>...<size>" + "permissions": display each line as "<permissions> <owner> <group> <basename>" + "metatitle": display metadata from .metadata.json files if + available, fall back to the "filename" linemode if no + metadata was found. See :meta command. + =item load_copy_buffer Load the copy buffer from F<~/.config/ranger/copy_buffer>. This can be used to @@ -936,6 +1051,16 @@ This command is based on the I<scout> command and supports all of its options. Mark all tags that are tagged with either of the given tags. When leaving out the tag argument, all tagged files are marked. +=item meta I<key> I<value> + +Set the metadata of the currently highlighted file. Example: + + :meta title The Hitchhiker's Guide to the Galaxy + :meta year 1979 + +This metadata can be displayed by, for example, using the "metatitle" line mode +by typing Mt. + =item mkdir I<dirname> Creates a directory with the name I<dirname>. @@ -955,6 +1080,11 @@ Note that if you specify an application, the mode is ignored. Binds keys for the pager. Works like the C<map> command. +=item prompt_metadata [I<keys ...>] + +Prompt the user to input metadata with the C<meta> command for multiple keys in +a row. + =item punmap [I<keys ...>] Removes key mappings of the pager. Works like the C<unmap> command. @@ -973,6 +1103,11 @@ it by typing `` or '' the next time you start ranger. Change the link destination of the current symlink file to <newpath>. First <tab> will load the original link. +=item rename_append + +Opens the console with ":rename <current file>" with the cursor automatically +placed before the file extension + =item rename I<newname> Rename the current file. If a file with that name already exists, the renaming @@ -1259,6 +1394,8 @@ GNU General Public License 3 or (at your option) any later version. =item The mailing list: L<http://savannah.nongnu.org/mail/?group=ranger> +=item IRC channel: #ranger on freenode.net + =back ranger is maintained with the git version control system. To fetch a fresh @@ -1278,7 +1415,7 @@ rifle(1) =head1 BUGS -Report bugs here: L<http://savannah.nongnu.org/bugs/?group=ranger> +Report bugs here: L<https://github.com/hut/ranger/issues> Please include as much relevant information as possible. For the most diagnostic output, run ranger like this: C<PYTHONOPTIMIZE= ranger --debug> |