3 ranger is a console file manager with VI key bindings. It provides a
4 minimalistic and nice curses interface with a view on the directory hierarchy.
5 The secondary task of ranger is to figure out which program you want to use to
8 This file describes ranger and how to get it to run. For instructions on the
9 usage, please read the man page. See doc/HACKING for development specific
10 information. For configuration, check the files in ranger/defaults/. They
11 are usually installed to /usr/lib/python*/site-packages/ranger/defaults/
12 and can be obtained with ranger's --copy-config option.
14 A note to packagers: Versions meant for packaging are listed in the changelog
20 * Authors: Check the copyright notices in each source file
21 * License: GNU General Public License Version 3
23 * Website: http://ranger.nongnu.org/
24 * Download: http://ranger.nongnu.org/ranger-stable.tar.gz
25 * Bug reports: https://savannah.nongnu.org/bugs/?group=ranger&func=additem
26 * git clone http://git.sv.gnu.org/r/ranger.git
31 * An easily maintainable file manager in a high level language
32 * A quick way to switch directories and browse the file system
33 * Keep it small but useful, do one thing and do it well
34 * Console based, with smooth integration into the unix shell
39 * UTF-8 Support (if your python copy supports it)
40 * Multi-column display
41 * Preview of the selected file/directory
42 * Common file operations (create/chmod/copy/delete/...)
43 * Renaming multiple files at once
44 * VIM-like console and hotkeys
45 * Automatically determine file types and run them with correct programs
46 * Change the directory of your shell after exiting ranger
47 * Tabs, Bookmarks, Mouse support
52 * Python (tested with version 2.6, 2.7, 3.1, 3.2) with support for ncurses
53 and (optionally) wide-unicode.
54 * A pager ("less" by default)
57 * The "file" program for determining file types
58 * The python module "chardet", in case of encoding detection problems
60 Optional, for enhanced file previews (with "scope.sh"):
61 * img2txt (from caca-utils) for previewing images
62 * highlight for syntax highlighting of code
63 * atool for previews of archives
64 * lynx, w3m or elinks for previews of html pages
65 * pdftotext for pdf previews
66 * transmission-show for viewing bit-torrent information
67 * mediainfo for viewing information about media files
72 Use the package manager of your operating system to install ranger.
73 Note that ranger can be started without installing by simply running ranger.py.
75 To install ranger manually:
78 This translates roughly to:
79 sudo python setup.py install --optimize=1 --record=install_log.txt
81 This also saves a list of all installed files to install_log.txt, which you can
82 use to uninstall ranger.
87 After starting ranger, you can use the Arrow Keys (or hjkl) to navigate, Enter
88 to open a file or type Q to quit. The third column shows a preview of the
89 current file. The second is the main column and the first shows the parent
92 Ranger can automatically copy default configuration files to ~/.config/ranger
93 if you run it with the switch --copy-config. (see ranger --help for a
94 description of that switch.) Also check ranger/defaults/ for the default