=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<--list-unused-keys> List common keys which are not bound to any action in the "browser" context. This list is not complete, you can bind any key that is supported by curses: use the key code returned by C. =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 CONCEPTS =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 the selection. The default tag is an Asterisk ("*"), but you can use any tag by typing I<">. =head2 PREVIEWS By default, only text files are previewed, but you can enable external preview scripts by creating F<~/.config/ranger/scope.sh> (see preview_script option.) This script will then be executed each time you attempt to preview a file. Fetch the default scope.sh (from F) by running C This default script contains more documentation and calls to the programs I and I for html, I for text/code, I for images, I for archives, I for PDFs and I for video and audio files. Install these programs (just the ones you need) and scope.sh will automatically use them. Make sure to also have the options "use_preview_script" and "preview_files" turned on. =head2 SELECTION The I is defined as "All marked files IF THERE ARE ANY, otherwise the current file." Be aware of this when using the :delete command, which deletes all files in the selection. You can mark files by pressing , v, etc. A yellow B symbol at the bottom right indicates that there are marked files in this directory. =head2 MACROS Macros can be used in commands to abbreviate things. %f the highlighted file %d the path of the current direc

# Change the prompt when you open a shell from inside ranger
#
# Add this line to your .bashrc for it to work.

[ -n "$RANGER_LEVEL" ] && PS1="$PS1"'(in ranger) '

f 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 You can enter the commands in the console which is opened by pressing ":". There are additional commands which are directly translated to python functions, one for every method in the ranger.core.actions.Actions class. They are not documented here, since they are mostly for key bindings, not to be typed in by a user. Read the source if you are interested in them. =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 chain I[; I[; I...]] Combines multiple commands into one, separated by columns. =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 cmap I I Binds keys for the console. Works like the C command. =item console [-pI] I Opens the console with the command already typed in. The cursor is placed at I. =item copycmap I I [I ...] See C =item copymap I I [I ...] Copies the keybinding I to I in the "browser" context. This is a deep copy, so if you change the new binding (or parts of it) later, the old one is not modified. To copy key bindings of the console, taskview, or pager use "copycmap", "copytmap" or "copypmap". =item copypmap I I [I ...] See C =item copytmap I I [I ...] See C =item cunmap I I Removes key mappings of the console. Works like the C command. =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<-q>] I Evaluates the python code. `fm' is a reference to the FM instance. To display text, use the function `p'. The result is displayed on the screen unless you use the "-q" option. 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 map I I Assign the key combination to the given command. Whenever you type the key/keys, the command will be executed. Additionally, if you use a quantifier when typing the key, like 5j, it will be passed to the command as the attribute "self.quantifier". The keys you bind with this command are accessible in the file browser only, not in the console, task view or pager. To bind keys there, use the commands "cmap", "tmap" or "pmap". =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 pmap I I Binds keys for the pager. Works like the C command. =item punmap I I Removes key mappings of the pager. Works like the C command. =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, the renaming will fail. 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