summary refs log tree commit diff stats
path: root/README
blob: 8f87298e2a78aaa5aabe043eef20915f6139e011 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
Ranger v.1.4.3
==============

Ranger is a free console file manager that gives you greater flexibility
and a good overview of your files without having to leave your *nix console.
It visualizes the directory tree in two dimensions: the directory hierarchy
on one, lists of files on the other, with a preview to the right so you know
where you'll be going.

The default keys are similar to those of Vim, Emacs and Midnight Commander,
though Ranger is easily controllable with just the arrow keys or the mouse.

The program is written in Python (2.6 or 3.1) and uses curses for the
text-based user interface.


Getting Started
---------------

Ranger can be started without installing:  Just run ranger.py.  If you want to
install it anyway, the INSTALL file contains instructions.

After starting ranger, you can use the Arrow Keys (or hjkl) to navigate, Enter
to open a file or type Q to quit.  The column on the right shows a preview of
the current file.  The second from the right is the main column and the others
show parent directories.

The manual page of ranger contains a documentation of rangers functions,
keybindings, commands and options.  You can access it by typing "?" in ranger,
running "man ranger" or view it online.

An easy way to customize ranger is running "ranger --copy-config=all"
and editing the new files in ~/.config/ranger/.


About
-----

* Authors:         Check the copyright notices in each source file
* Website:         http://ranger.nongnu.org/
* License:         GNU General Public License Version 3

* Download URL of the newest stable version:
http://ranger.nongnu.org/ranger-stable.tar.gz

* Git Clone URL:
git clone http://git.sv.gnu.org/r/ranger.git

* Bug report:
https://savannah.nongnu.org/bugs/?group=ranger&func=additem


Design Goals
------------

* An easily maintainable file manager in a high level language
* A quick way to switch directories and browse the file system
* Keep it small but useful, do one thing and do it well
* Console based, with smooth integration into the unix shell


Features
--------

* Multi-column display (Miller Columns)
* Preview of the selected file/directory
* Common file operations (create/chmod/copy/delete/...)
* Renaming multiple files at once
* VIM-like console and hotkeys
* Automatically determine file types and run them with correct programs
* Change the directory of your shell after exiting ranger
* Tabs, Bookmarks, Mouse support


Dependencies
------------

* Python 2.6, 2.7 or Python 3.1 with the curses module
(Later versions might work too, but 2.5 definitely won't.)

Optional:
* The "file" program
* A pager ("less" by default)
* The python module "chardet", in case of encoding detection problems

For scope.sh: (enhanced file previews)
* img2txt (from caca-utils) for previewing images
* highlight for syntax highlighting of code
* atool for previews of archives
* lynx or elinks for previews of html pages