RANGER(1)

NAME
ranger - visual file manager

SYNOPSIS
ranger [--help] [--version] [--debug] [--clean] [--list-unused-keys] [--fail-unless-cd] [--choosedir=targetfile] [--choosefile=targetfile] [--copy-config=file] [--mode=mode] [--flags=flags] [path/filename]

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.

This manual mainly contains information on the usage of ranger. Refer to the README for install instructions and to doc/HACKING for development specific information. For configuration, see the files in ranger/defaults. They are usually installed to /usr/lib/python*/site-packages/ranger/defaults and can be obtained with ranger's --copy-config option.

Inside ranger, you can press 1? for a list of key bindings, 2? for a list of commands and 3? for a list of settings.

OPTIONS

-d, --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.

-c, --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.

--choosefile=targetfile
    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 absolute path of that file into targetfile.

--choosefiles=targetfile
    Allows you to pick multiple files with ranger. This changes the behavior so that when you open a file, ranger will exit and write the absolute paths of all selected files into targetfile, adding one newline after each filename.

--choosedir=targetfile
    Allows you to pick a directory with ranger. When you exit ranger, it will write the last visited directory into targetfile.

--selectfile=targetfile
    Open ranger with targetfile selected.

--copy-config=file
    Create copies of the default configuration files in your local configuration directory. Existing ones will not be overwritten. Possible values: all, rc, apps, commands, options, scope.

--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 "getch()".

--list-tagged-files=tag
    List all files which are tagged with the given tag. Note: Tags are single characters. The default tag is "*"

--fail-unless-cd
    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.)

-m n, --mode=n
    When a filename is supplied, run it in mode n. This has no effect unless the execution of this file type is explicitly handled in the configuration.

-f flags, --flags=flags
    When a filename is supplied, run it with the given flags to modify behavior. The execution of this file type is explicitly handled in the configuration.

--cmd=command
    Execute the command after the configuration has been read. Use this option multiple times to run multiple commands.

--version
    Print the version and exit.

-h, --help
    Print a list of options and exit.

CONCEPTS

  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 "<tagname>.

  PREVIEWS
By default, only text files are previewed, but you can enable external preview scripts by setting the option "use_preview_script" and "preview_files" to True.

This default script is ~/.config/ranger/scope.sh. It contains more documentation and calls to the programs lynx and elinks for html, highlight for text/code, img2txt for images, atool for archives, pdftotext for PDFs and mediainfo for video and audio files.

Install these programs (just the ones you need) and scope.sh will automatically use them.

  SELECTION
The selection 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 <Space>, v, etc. A yellow Mrk symbol at the bottom right indicates that there are marked files in this directory.

  MACROS
Macros can be used in commands to abbreviate things.

 %f   the highlighted file
 %d   the path of the current directory
 %s   the selected files in the current directory.
 %t   all tagged files in the current directory
 %c   the full paths of the currently copied/cut files

The macros %f, %d and %s also have upper case variants, %F, %D and %S, which refer to the next tab. To refer to specific tabs, add a number in between. (%7s = selection of the seventh tab.)

%c is the only macro which ranges out of the current directory. So you may "abuse" the copying function for other purposes, like diffing two files which are in different directories:

 Yank the file A (type yy), move to the file B, then type
 @diff %c %f

Macros for file paths are generally shell-escaped so they can be used in the :shell command.

  BOOKMARKS
Type m<key> to bookmark the current directory. You can re-enter this directory by typing `<key>. <key> can be any letter or digit. Unlike vim, both lowercase and uppercase bookmarks are persistent.

Each time you jump to a bookmark, the special bookmark at key ` will be set to the last directory. So typing "``" gets you back to where you were before.

Bookmarks are selectable when tabbing in the :cd command.

Note: The bookmarks ' (Apostrophe) and ` (Backtick) are the same.

  FLAGS
Flags give you a way to modify the behavior of the spawned process. They are used in the commands :open_with (key "r") and :shell (key "!").

 s   Silent mode.  Output will be discarded.
 d   Detach the process.  (Run in background)
 p   Redirect output to the pager
 w   Wait for an Enter-press when the process is done
 c   Run the current file only, instead of the selection
 r   Run application with root privilege (requires sudo)
 t   Run application in a new terminal window

By default, all the flags are off unless specified otherwise in the apps.py configuration file. You can specify as many flags as you want. An uppercase flag negates the effect: "ddcccDs" is equivalent to "cs".

The "t" flag looks for the environment variable TERMCMD, and uses it as the terminal command, if it's not set it'll use xterm.

Examples: ":open_with p" will pipe the output of that process into the pager. ":shell -w df" will run "df" and wait for you to press Enter before switching back to ranger.

  MODES
By specifying a mode (a positive integer), you can tell ranger what to do with a file when running it. You can specify which mode to use by typing <mode>l or <mode><Enter> or :open_with <mode>. The default mode is 0.

Examples: "l" (mode zero) to list the contents of an archive, "1l" (mode one) to extract an archive. See the apps.py configuration file for all programs and modes.

KEY BINDINGS
Key bindings are defined in the file ranger/defaults/rc.conf. Check this file for a list of all key bindings. You can copy it to your local configuration directory with the --copy-config=rc option.

Many key bindings take an additional numeric argument. Type 5j to move down 5 lines, 2l to open a file in mode 2, 10<Space> to mark 10 files.

This list contains the most useful bindings:

  MAIN BINDINGS

h, j, k, l
    Move left, down, up or right

^D or J, ^U or K
    Move a half page down, up

H, L
    Move back and forward in the history

gg  Move to the top

G   Move to the bottom

^R  Reload everything

^L  Redraw the screen

S   Open a shell in the current directory

?   Opens this man page

yy  Yank the selection to the "copy" buffer and mark them as to be copied

dd  Cut the selection to the "copy" buffer and mark them as to be moved

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 po.

mX  Create a bookmark with the name X

`X  Move to the bookmark with the name X

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.

N   Find the previous file.

oX  Change the sort method (like in mutt)

zX  Change settings. See the settings section for a list of settings and their hotkey.

f   Quickly navigate by entering a part of the filename.

Space
    Mark a file.

v   Toggle the mark-status of all files, unmark all files.

V, uv
    Unmark all files

/   Search for files in the current directory.

:   Open the console.

Alt-N
    Open a tab. N has to be a number from 0 to 9. If the tab doesn't exist yet, it will be created.

gn, ^N
    Create a new tab.

gt, gT
    Go to the next or previous tab. You can also use TAB and SHIFT+TAB instead.

gc, ^W
    Close the current tab. The last tab cannot be closed this way.

  MIDNIGHT COMMANDER-LIKE BINDINGS

<F1>
    Display Help.

<F3>
    Display the file.

<F4>
    Edit the file.

<F5>
    Copy the file.

<F6>
    Cut the file.

<F7>
    Open the console with ":mkdir ".

<F8>
    Prompt for deletion of the selected files.

<F10>
    Exit ranger.

  READLINE-LIKE BINDINGS IN THE CONSOLE

^B, ^F
    Move left and right (B for back, F for forward)

^P, ^N
    Move up and down (P for previous, N for Next)

^A, ^E
    Move to the start or to the end

^D  Delete the current character.

^H  Backspace.

MOUSE BUTTONS

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.

Right Mouse Button
    Enter a directory or run a file.

Scroll Wheel
    Scrolls up or down. You can point at the column of the parent directory to switch directories.

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 <brokets>, if a hotkey exists.

Settings can be changed in the file ~/.config/ranger/options.py or on the fly with the command :set option value. Examples:
 :set column_ratios (1,2,3)
 :set show_hidden=True

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.

collapse_preview [bool] <zc>
    When no preview is visible, should the last column be squeezed to make use of the whitespace?

colorscheme_overlay [function, None]
    An overlay function for colorschemes. See the default options.py for an explanation and an example.

colorscheme [string]
    Which colorscheme to use? These colorschemes are available by default: default, default88, texas, jungle, snow. Snow is monochrome, texas and default88 use 88 colors.

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.

dirname_in_tabs [bool]
    Display the directory name in tabs?

display_size_in_main_column [bool]
    Display the file size in the main column?

display_size_in_status_bar [bool]
    Display the file size in the status bar?

display_tags_in_all_columns [bool]
    Display tags in all columns?

draw_bookmark_borders [bool]
    Draw borders around the bookmark window?

draw_borders [bool]
    Draw borders around columns?

flushinput [bool] <zi>
    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.

hidden_filter [regexp]
    A regular expression pattern for files which should be hidden.

max_console_history_size [integer, None]
    How many console commands should be kept in history?

max_history_size [integer, None]
    How many directory changes should be kept in history?

mouse_enabled [bool] <zm>
    Enable mouse input?

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.

preview_directories [bool] <zP>
    Preview directories in the preview column?

preview_files [bool] <zp>
    Preview files in the preview column?

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.

save_console_history [bool]
    Should the console history be saved on exit? If disabled, the console history is reset when you restart ranger.

scroll_offset [integer]
    Try to keep this much space between the top/bottom border when scrolling.

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.

show_cursor [bool]
    Always show the terminal cursor?

show_hidden_bookmarks [bool]
    Show dotfiles in the bookmark preview window? (Type ')

show_hidden [bool] <zh>, <^H>
    Show hidden files?

sort_case_insensitive [bool] <zc>
    Sort case-insensitively? If true, "a" will be listed before "B" even though its ASCII value is higher.

sort_directories_first [bool] <zd>
    Sort directories first?

sort_reverse [bool] <or>
    Sort reversed?

sort [string] <oa>, <ob>, <oc>, <om>, <on>, <ot>, <os>
    Which sorting mechanism should be used? Choose one of atime, basename, ctime, mtime, natural, type, size

    Note: You can reverse the order by using an uppercase O in the key combination.

tilde_in_titlebar [bool]
    Abbreviate $HOME with ~ in the title bar (first line) of ranger?

unicode_ellipsis [bool]
    Use a unicode "..." character instead of "~" to mark cut-off filenames?

update_title [bool]
    Set a window title?

use_preview_script [bool] <zv>
    Use the preview script defined in the setting preview_script?

xterm_alt_key [bool]
    Enable this if key combinations with the Alt Key don't work for you. (Especially on xterm)

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.

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.

cd [directory]
    The cd command changes the directory. The command ":cd -" is equivalent to typing ``.

chain command1[; command2[; command3...]]
    Combines multiple commands into one, separated by columns.

chmod octal_number
    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 [-+]<who><what> and =<octal> also exist. For example, +ar allows reading for everyone, -ow forbids others to write and =777 allows everything.

    See also: man 1 chmod

cmap key command
    Binds keys for the console. Works like the "map" command.

console [-pN] command
    Opens the console with the command already typed in. The cursor is placed at N.

copycmap key newkey [newkey2 ...]
    See "copymap"

copymap key newkey [newkey2 ...]
    Copies the keybinding key to newkey 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".

copypmap key newkey [newkey2 ...]
    See "copymap"

copytmap key newkey [newkey2 ...]
    See "copymap"

cunmap key command
    Removes key mappings of the console. Works like the "unmap" command.

delete [confirmation]
    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'.

edit [filename]
    Edit the current file or the file in the argument.

eval [-q] python_code
    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!")

filter [string]
    Displays only the files which contain the string in their basename.

find pattern
    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.)

grep pattern
    Looks for a string in all marked files or directories.

load_copy_buffer
    Load the copy buffer from ~/.config/ranger/copy_buffer. This can be used to pass the list of copied files to another ranger instance.

map key command
    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".

mark pattern
    Mark all files matching the regular expression pattern.

mkdir dirname
    Creates a directory with the name dirname.

open_with [application] [flags] [mode]
    Open the selected files with the given application, unless it is omitted, in which case the default application is used. flags are characters out of "sdpcwSDPCW" and mode is any positive integer. Their meanings are discussed in their own sections.

pmap key command
    Binds keys for the pager. Works like the "map" command.

punmap key command
    Removes key mappings of the pager. Works like the "unmap" command.

quit
    Like quit!, but closes only this tab if multiple tabs are open.

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.

rename newname
    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.

relink newpath
    Change the link destination of the current symlink file to <newpath>. First <tab> will load the original link.

save_copy_buffer
    Save the copy buffer from ~/.config/ranger/copy_buffer. This can be used to pass the list of copied files to another ranger instance.

search pattern
    Search files in the current directory that match the given (case insensitive) regular expression pattern.

search_inc 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.

set option=value
    Assigns a new value to an option. Valid options are listed in the settings section. Use tab completion to get the current value of an option, though this 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('<pattern>')
     string         Anything

shell [-flags] command
    Run a shell command. flags are discussed in their own section.

terminal
    Spawns the x-terminal-emulator starting in the current directory.

touch filename
    Creates an empty file with the name filename, unless it already exists.

tmap key command
    Binds keys for the taskview. Works like the "map" command.

tunmap key command
    Removes key mappings of the taskview. Works like the "unmap" command.

unmap [keys ...]
    Removes the given key mappings in the "browser" context. To unmap key bindings in the console, taskview, or pager use "cunmap", "tunmap" or "punmap".

unmark pattern
    Unmark all files matching a regular expression pattern.

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.)

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, rc.conf) or can be sub-classed (apps.py, colorschemes).

When starting ranger with the --clean option, it will not access or create any of these files.

  CONFIGURATION

apps.py
    Controls which applications are used to open files.

commands.py
    Defines commands which can be used by typing ":".

rc.conf
    Contains a list of commands which are executed on startup. Mostly key bindings are defined here.

options.py
    Sets a handful of basic options.

scope.sh
    This is a script that handles file previews. When the options use_preview_script and preview_files or, respectively, preview_directories are set, the program specified in the option preview_script is run and its output and/or exit code determines rangers reaction.

colorschemes/
    Colorschemes can be placed here.

  STORAGE

bookmarks
    This file contains a list of bookmarks. The syntax is /^(.):(.*)$/. The first character is the bookmark key and the rest after the colon is the path to the file. In ranger, bookmarks can be set by typing m<key>, accessed by typing '<key> and deleted by typing um<key>.

copy_buffer
    When running the command :save_copy_buffer, the paths of all currently copied files are saved in this file. You can later run :load_copy_buffer to copy the same files again, pass them to another ranger instance or process them in a script.

history
    Contains a list of commands that have been previously typed in.

tagged
    Contains a list of tagged files. The syntax is /^(.:)?(.*)$/ where the first letter is the optional name of the tag and the rest after the optional colon is the path to the file. In ranger, tags can be set by pressing t and removed with T. To assign a named tag, type "<tagname>.

ENVIRONMENT
These environment variables have an effect on ranger:

RANGER_LEVEL
    Ranger sets this environment variable to "1" or increments it if it already exists. External programs can determine whether they were spawned from ranger by checking for this variable.

EDITOR
    Defines the editor to be used for the "E" key. Defaults to the first installed program out of "vim", "emacs" and "nano".

SHELL
    Defines the shell that ranger is going to use with the :shell command and the "S" key. Defaults to "bash".

TERMCMD
    Defines the terminal emulator command that ranger is going to use with the :terminal command and the "t" run flag. Defaults to "x-terminal-emulator" or "xterm"

XDG_CONFIG_HOME
    Specifies the directory for configuration files. Defaults to $HOME/.config.

PYTHONOPTIMIZE
    This variable determines the optimize level of python.

    Using PYTHONOPTIMIZE=1 (like python -O) will make python discard assertion statements. You will gain efficiency at the cost of losing some debug info.

    Using PYTHONOPTIMIZE=2 (like python -OO) will additionally discard any docstrings. Using this will disable the <F1> key on commands.

EXAMPLES

  BASH: Display that the shell spawned from ranger:
By putting this in ~/.bashrc, "(in ranger) " will be displayed next to your prompt to notify you that the shell spawned from ranger.

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

  VIM: File Chooser
This is a vim function which allows you to use ranger to select a file for opening in your current vim session.

 fun! RangerChooser()
   exec "silent !ranger --choosefile=/tmp/chosenfile " . expand("%:p:h")
   if filereadable('/tmp/chosenfile')
     exec 'edit ' . system('cat /tmp/chosenfile')
     call system('rm /tmp/chosenfile')
   endif
   redraw!
 endfun
 map ,r :call RangerChooser()<CR>

  Bash: cd to last path after exit
This is a bash function (for ~/.bashrc) to change the directory to the last visited one after ranger quits. You can always type "cd -" to go back to the original one.

 function ranger-cd {
   tempfile='/tmp/chosendir'
   /usr/bin/ranger --choosedir="$tempfile" "${@:-$(pwd)}"
   test -f "$tempfile" &&
   if [ "$(cat -- "$tempfile")" != "$(echo -n `pwd`)" ]; then
     cd -- "$(cat "$tempfile")"
   fi
   rm -f -- "$tempfile"
 }

 # This binds Ctrl-O to ranger-cd:
 bind '"\C-o":"ranger-cd\C-m"'

LICENSE
GNU General Public License 3 or (at your option) any later version.

LINKS

Download:  <http://ranger.nongnu.org/ranger-stable.tar.gz>
The project page: <http://ranger.nongnu.org/>
The mailing list: <http://savannah.nongnu.org/mail/?group=ranger>

ranger is maintained with the git version control system. To fetch a fresh copy, run:

 git clone git://git.savannah.nongnu.org/ranger.git

BUGS
Report bugs here: <http://savannah.nongnu.org/bugs/?group=ranger>

Please include as much relevant information as possible. For the most diagnostic output, run ranger like this: "PYTHONOPTIMIZE= ranger --debug"