=head1 NAME ranger - visual file manager =head1 SYNOPSIS B [I] [I] =head1 DESCRIPTION Ranger is a file manager with an ncurses front-end written in Python. It is designed to give you a broader overview of the file system by displaying previews and backviews, dividing the screen into several columns. The key bindings are similar to those of other console programs like B, B or B so the usage will be intuitive and efficient. =head1 OPTIONS =over 14 =item B<--verison> Print the version and exit. =item B<-h>, B<--help> Print a list of options and exit. =item B<-d>, B<--debug> Activate the debug mode: Whenever an error occurs, ranger will exit and print a full traceback. The default behavior is to merely print the name of the exception in the statusbar/log and try to keep running. =item B<-c>, B<--clean> Activate the clean mode: Ranger will not access or create any configuration files nor will it leave any traces on your system. This is useful when your configuration is broken, when you want to avoid clutter, etc. =item B<--choosefile>=I Allows you to pick a file with ranger. This changes the behavior so that when you open a file, ranger will exit and write the name of that file into I. =item B<--choosedir>=I Allows you to pick a directory with ranger. When you exit ranger, it will write the last visited directory into I. =item B<--copy-config>=I Create copies of the default configuration files in your local configuration directory. Existing ones will not be overwritten. Possible values: I, I, I, I, I, I. =item B<--fail-unless-c>d Return the exit code 1 if ranger is used to run a file instead of used for file browsing. (For example, "ranger --fail-unless-cd test.txt" returns 1.) =item B<-m> I, B<--mode>=I When a filename is supplied, run it in mode I. This has no effect unless the execution of this file type is explicitly handled in the configuration. =item B<-f> I, B<--flags>=I When a filename is supplied, run it with the given I to modify behavior. The execution of this file type is explicitly handled in the configuration. =back =head1 KEY BINDINGS Many key bindings take an additional numeric argument. Type I<5j> to move down 5 lines, I<2l> to open a file in mode 2, I<10> 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 F. You can copy it to your local configuration directory with the --copy-config option. =over 14 =item h, j, k, l Move left, down, up or right =item ^D or J, ^U or K Move a half page down, up =item H, L Move back and forward in the history =item gg Move to the top =item G Move to the bottom =item ^R Reload everything =item ^L Redraw the screen =item S Open a shell in the current directory =item yy Yank the selection to the "copy" buffer and mark them as to be copied =item dd Cut the selection to the "copy" buffer and mark them as to be moved =item pp Paste the files from the "copy" buffer here (by moving or copying, depending on how they are marked.) By default, this will not overwrite existing files. To overwrite them, use I. =item mI Create a bookmark with the name I =item `I Move to the bookmark with the name I =item n, N Find the next file. By default, this gets you to the newest file in the directory, but if you search something using the keys /, cm, ct, ..., it will get you to the next found entry. =item N Find the previous file. =item oI Change the sort method (like in mutt) =item zI Change settings. See the settings section for a list of settings and their hotkey. =item f Quickly navigate by entering a part of the filename. =item Space Mark a file. =item v Toggle the mark-status of all files, unmark all files. =item V, uv Unmark all files =item ^VI Mark all files in the given direction. Works just like dI. =item u^VI Unmark all files in the given direction. Works just like dI. =item gI Open a tab. N has to be a number from 0 to 9. If the tab doesn't exist yet, it will be created. =item gn, ^N Create a new tab. =item gt, gT Go to the next or previous tab. You can also use TAB and SHIFT+TAB instead. =item gc, ^W Close the current tab. The last tab cannot be closed this way. =item / Search for files in the current directory. =item : Open the console. =item ? Opens the help screen with more key bindings and documentation =back =head2 MIDNIGHT COMMANDER-LIKE BINDINGS =over 14 =item Display Help. =item Display the file. =item Edit the file. =item Copy the file. =item Cut the file. =item Open the console with ":mkdir ". =item Prompt for deletion of the selected files. =item Exit ranger. =back =head2 READLINE-LIKE BINDINGS IN THE CONSOLE =over 14 =item ^B, ^F Move left and right (B for back, F for forward) =item ^P, ^N Move up and down (P for previous, N for Next) =item ^A, ^E Move to the start or to the end =item ^D Delete the current character. =item ^H Backspace. =back =head1 MOUSE BUTTONS =over =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. =item Right Mouse Button Enter a directory or run a file. =item Scroll Wheel Scrolls up or down. You can point at the column of the parent directory to switch directories. =back =head1 SETTINGS 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 , if a hotkey exists. 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 =item autosave_bookmarks [bool] Save bookmarks (used with mX and `X) instantly? This helps to synchronize bookmarks between multiple ranger instances but leads to *slight* performance loss. When false, bookmarks are saved when ranger is exited. =item collapse_preview [bool] When no preview is visible, should the last column be squeezed to make use of the whitespace? =item colorscheme_overlay [function, None] An overlay function for colorschemes. See the default options.py for an explanation and an example. =item colorscheme [string] Which colorscheme to use? These colorschemes are available by default: B, B, B, B, B. Snow is monochrome, texas and default88 use 88 colors. =item column_ratios [tuple, list] How many columns are there, and what are their relative widths? For example, a value of (1, 1, 1) would mean 3 even sized columns. (1, 1, 1, 1, 4) means 5 columns with the preview column being as large as the other columns combined. =item dirname_in_tabs [bool] Display the directory name in tabs? =item display_size_in_main_column [bool] Display the file size in the main column? =item display_size_in_status_bar [bool] Display the file size in the status bar? =item display_tags_in_all_columns [bool] Display tags in all columns? =item draw_bookmark_borders [bool] Draw borders around the bookmark window? =item draw_borders [bool] Draw borders around columns? =item flushinput [bool] 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 [regexp] A regular expression pattern for files which should be hidden. =item max_console_history_size [integer, None] How many console commands should be kept in history? =item max_history_size [integer, None] How many directory changes should be kept in history? =item mouse_enabled [bool] Enable mouse input? =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. =item preview_directories [bool] Preview directories in the preview column? =item preview_files [bool] Preview files in the preview column? =item preview_script [string, None] Which script should handle generating previews? If the file doesn't exist, or use_preview_script is off, ranger will handle previews itself by just printing the content. =item save_console_history [bool] Should the console history be saved on exit? If disabled, the console history is reset when you restart ranger. =item scroll_offset [integer] Try to keep this much space between the top/bottom border when scrolling. =item shorten_title [integer, bool] Trim the title of the window if it gets long? The number defines how many directories are displayed at once, False turns off this feature. =item show_cursor [bool] Always show the terminal cursor? =item show_hidden_bookmarks [bool] Show dotfiles in the bookmark preview window? (Type ') =item show_hidden [bool] , <^H> Show hidden files? =item sort_case_insensitive [bool] Sort case-insensitively? If true, "a" will be listed before "B" even though its ASCII value is higher. =item sort_directories_first [bool] Sort directories first? =item sort_reverse [bool] Sort reversed? =item sort [string] , , , , , , Which sorting mechanism should be used? Choose one of B, B, B, B, B, B, B Note: You can reverse the order by using an uppercase O in the key combination. =item tilde_in_titlebar [bool] Abbreviate $HOME with ~ in the title bar (first line) of ranger? =item unicode_ellipsis [bool] Use a unicode "..." character instead of "~" to mark cut-off filenames? =item update_title [bool] Set a window title? =item use_preview_script [bool] Use the preview script defined in the setting I? =item xterm_alt_key [bool] Enable this if key combinations with the Alt Key don't work for you. (Especially on xterm) =back =head1 COMMANDS =over 2 =item bulkrename This command opens a list of selected files in an external editor. After you edit and save the file, it will generate a shell script which does bulk renaming according to the changes you did in the file. This shell script is opened in an editor for you to review. After you close it, it will be executed. =item cd [I] The cd command changes the directory. The command C<:cd -> is equivalent to typing ``. =item chmod I Sets the permissions of the selection to the octal number. The octal number is between 000 and 777. The digits specify the permissions for the user, the group and others. A 1 permits execution, a 2 permits writing, a 4 permits reading. Add those numbers to combine them. So a 7 permits everything. Key bindings in the form of [-+] and = also exist. For example, B<+ar> allows reading for everyone, -ow forbids others to write and =777 allows everything. See also: man 1 chmod =item delete [I] Destroy all files in the selection with a roundhouse kick. Ranger will ask for a confirmation if you attempt to delete multiple (marked) files or non-empty directories. When asking for confirmation, this command will only proceed if the last given word starts with a `y'. =item edit [I] Edit the current file or the file in the argument. =item eval I Evaluates the python code. `fm' is a reference to the FM instance. To display text, use the function `p'. Examples: :eval fm :eval len(fm.env.directories) :eval p("Hello World!") =item filter [I] Displays only the files which contain the I in their basename. =item find I Search files in the current directory that match the given (case-insensitive) regular expression pattern as you type. Once there is an unambiguous result, it will be run immediately. (Or entered, if it's a directory.) =item grep I Looks for a string in all marked files or directories. =item load_copy_buffer 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 Mark all files matching the regular expression pattern. =item mkdir I Creates a directory with the name I. =item open_with [I] [I] [I] Open the selected files with the given application, unless it is omitted, in which case the default application is used. I are characters out of "sdpcwSDPCW" and I is any positive integer. Their meanings are discussed in their own sections. =item quit Like quit!, but closes only this tab if multiple tabs are open. =item quit! Quit ranger. The current directory will be bookmarked as ' so you can re-enter it by typing `` or '' the next time you start ranger. =item rename I Rename the current file. If a file with that name already exists, it will be overwritten without notice. Also try the key binding A for appending something to a file name. =item save_copy_buffer Save the copy buffer from I<~/.config/ranger/copy_buffer>. This can be used to pass the list of copied files to another ranger instance. =item search I Search files in the current directory that match the given (case insensitive) regular expression pattern. =item search_inc I 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. =item set I