summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
authorhut <hut@lavabit.com>2011-10-08 19:32:55 +0200
committerhut <hut@lavabit.com>2011-10-08 19:32:55 +0200
commit7dc8fef89688b92ff03ec8005e57286751d0c539 (patch)
treea9ebc09b2fe8b0ecb4efbe2ba4e98c9cec3df35f /README
parent66683d4ed41dd9a9faab3286a469e06759434dee (diff)
downloadranger-7dc8fef89688b92ff03ec8005e57286751d0c539.tar.gz
README: Update
Diffstat (limited to 'README')
-rw-r--r--README43
1 files changed, 22 insertions, 21 deletions
diff --git a/README b/README
index 3cf0bfde..52142aa8 100644
--- a/README
+++ b/README
@@ -1,9 +1,9 @@
 ranger v.1.5.0
 ==============
 ranger is a console file manager with VI key bindings.  It provides a
-minimalistic yet nice curses interface with a view on the directory hierarchy.
-The secondary task of ranger is to psychically guess which program you want to
-use for opening particular files.
+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 file describes ranger and how to get it to run.  For instructions on the
 usage, please read the man page.  See doc/HACKING for development specific
@@ -11,8 +11,7 @@ information.  For configuration, check the sample files that ranger creates
 in your ~/.config/ranger directory.
 
 A note to packagers:  Versions meant for packaging are listed in the changelog
-on the website and are taken from the stable branch.  The master branch is a
-"work in progress" branch.
+on the website.
 
 
 About
@@ -22,8 +21,8 @@ About
 
 * Website:     http://ranger.nongnu.org/
 * Download:    http://ranger.nongnu.org/ranger-stable.tar.gz
-* GIT Clone:   http://git.sv.gnu.org/r/ranger.git
 * Bug reports: https://savannah.nongnu.org/bugs/?group=ranger&func=additem
+* git clone    http://git.sv.gnu.org/r/ranger.git
 
 
 Design Goals
@@ -37,7 +36,7 @@ Design Goals
 Features
 --------
 * UTF-8 Support  (if your python copy supports it)
-* Multi-column display (Miller Columns)
+* Multi-column display
 * Preview of the selected file/directory
 * Common file operations (create/chmod/copy/delete/...)
 * Renaming multiple files at once
@@ -50,43 +49,45 @@ Features
 Dependencies
 ------------
 * Python (tested with version 2.6, 2.7, 3.1, 3.2) with the curses module
+  and, optionally, support for wide-unicode.
 
 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)
+Optional, for enhanced file previews (with "scope.sh"):
 * 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
+* lynx, w3m or elinks for previews of html pages
+* pdftotext for pdf previews
+* transmission-show for viewing bit-torrent information
+* mediainfo for viewing information about media files
 
 
 Installing
 ----------
-
 Use the package manager of your operating system to install ranger.
+Note that ranger can be started without installing by simply running ranger.py.
 
 To install ranger manually:
     sudo make install
 
 This translates roughly to:
-    sudo ./setup.py install --optimize=1 --record=install_log.txt
+    sudo python setup.py install --optimize=1 --record=install_log.txt
 
 This also saves a list of all installed files to install_log.txt, which you can
 use to uninstall ranger.
 
-
 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.
-
-An easy way to customize ranger is running "ranger --copy-config=all"
-and editing the new files in ~/.config/ranger/.
+to open a file or type Q to quit.  The third column shows a preview of the
+current file.  The second is the main column and the first shows the parent
+directory.
+
+Ranger will automatically copy simple configuration files to ~/.config/ranger.
+If you mess them up, just delete them and ranger will copy them again. Run
+ranger with --dont-copy-config to disable this.  Also check ranger/defaults/
+for the default configuration.
=ee9a9237d6324f1de1bb7150083eacf7b9af5f70'>ee9a9237 ^
33352536 ^
6030d7e2 ^
261b1b80 ^
6030d7e2 ^
ee9a9237 ^
33352536 ^










9d27e966 ^
33352536 ^
9d27e966 ^
33352536 ^

9d27e966 ^
33352536 ^

ee9a9237 ^
6030d7e2 ^
ee9a9237 ^
33352536 ^


ee9a9237 ^
33352536 ^



b8475380 ^
7a583220 ^
33352536 ^

6030d7e2 ^
3d6450f2 ^
3d6450f2 ^
6030d7e2 ^
ee9a9237 ^
6030d7e2 ^
ee9a9237 ^
6030d7e2 ^
ee9a9237 ^
33352536 ^
6030d7e2 ^
ee9a9237 ^
6030d7e2 ^

ee9a9237 ^
6030d7e2 ^
ee9a9237 ^
33352536 ^
6030d7e2 ^
ee9a9237 ^
6030d7e2 ^

9d27e966 ^
33352536 ^

ee9a9237 ^
6030d7e2 ^
ee9a9237 ^
33352536 ^
6030d7e2 ^

3d6450f2 ^

6030d7e2 ^
ee9a9237 ^
6030d7e2 ^
ee9a9237 ^
6030d7e2 ^
ee9a9237 ^
33352536 ^
6030d7e2 ^
ee9a9237 ^
6030d7e2 ^

ee9a9237 ^
6030d7e2 ^
ee9a9237 ^
33352536 ^
6030d7e2 ^
ee9a9237 ^
6030d7e2 ^

ee9a9237 ^
6030d7e2 ^
ee9a9237 ^
33352536 ^
6030d7e2 ^
ee9a9237 ^
6030d7e2 ^

9d27e966 ^
33352536 ^

ee9a9237 ^
6030d7e2 ^
ee9a9237 ^
33352536 ^
6030d7e2 ^

b31455f8 ^


2a2a5b1e ^
6030d7e2 ^
9b16f190 ^
6030d7e2 ^
9b16f190 ^

438e5a0d ^



6ee77ba7 ^
ee9a9237 ^
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159