summary refs log tree commit diff stats
path: root/doc/ranger.1
diff options
context:
space:
mode:
authorhut <hut@lavabit.com>2010-04-07 15:50:08 +0200
committerhut <hut@lavabit.com>2010-04-07 15:50:08 +0200
commit8d89c6f3a7cf6b0c8abc2ff68ecc7201ac08e872 (patch)
tree610dd3acfdac10ebe1d766a779897207ea6dfb33 /doc/ranger.1
parent55435343b142c424619e3072475ca8b3366d109c (diff)
parentf45f9734d2ff9fd6b68ff6c879d5b07b0e5c7d02 (diff)
downloadranger-8d89c6f3a7cf6b0c8abc2ff68ecc7201ac08e872.tar.gz
Merge branch 'devel' into newkey
Conflicts:
	ranger/core/actions.py
	ranger/defaults/keys.py
	ranger/ext/direction.py
	ranger/gui/ui.py
	ranger/gui/widgets/browserview.py
	ranger/gui/widgets/pager.py
Diffstat (limited to 'doc/ranger.1')
-rw-r--r--doc/ranger.1213
1 files changed, 213 insertions, 0 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1
new file mode 100644
index 00000000..9e1ab5a0
--- /dev/null
+++ b/doc/ranger.1
@@ -0,0 +1,213 @@
+.TH RANGER 1 ranger-1.0.4
+.SH NAME
+ranger - visual file manager
+.\"-----------------------------------------
+.SH SYNOPSIS
+.B ranger
+.R [OPTIONS] [FILE]
+.\"-----------------------------------------
+.SH DESCRIPTION
+Ranger is a file manager with an ncurses frontend written in Python.
+.P
+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 keybindings are similar to those of other console programs like
+.BR vim ", " mutt " or " ncmpcpp
+so the usage will be intuitive and efficient.
+.\"-----------------------------------------
+.SH OPTIONS
+.TP
+--version
+Print the version and exit.
+.TP
+-h, --help
+Print a list of options and exit.
+.TP
+-d, --debug
+Activate the debug mode:  Whenever an error occurs, ranger will exit and
+print a full backtrace.  The default behaviour is to merely print the
+name of the exception in the statusbar/log and to try to keep running.
+.TP
+-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.
+.TP
+-r \fIdir\fR, --confdir=\fIdir\fR
+Define a different configuration directory.  The default is $HOME/.ranger.
+.TP
+-m \fIn\fR, --mode=\fIn\fR
+When a filename is supplied, make it run in mode \fIn\fR. Check the
+documentation for more information on modes.
+.TP
+-f \fIflags\fR, --flags=\fIflags\fR
+When a filename is supplied, make it run with the flags \fIflags\fR. Check the
+documentation for more information on flags.
+.\"-----------------------------------------
+.SH USAGE
+.\"-----------------------------------------
+.SS General Keybindings
+Many keybindings take an additional numeric argument.  Type \fI5j\fR to move
+down 5 lines, \fI10<Space>\fR to mark 10 files or \fI3?\fR to read the
+third chapter of the documentation.
+.TP
+h, j, k, l
+Move left, down, up, right
+.TP
+^D or J, ^U or K
+Move a half page down, up
+.TP
+H, L
+Move back and forward in the history
+.TP
+gg
+Move to the top
+.TP
+G
+Move to the bottom
+.TP
+^R
+Reload everything
+.TP
+^L
+Redraw the screen
+.TP
+yy
+Yank the selection.  (mark the files as copied)
+.TP
+dd
+Cut the selection
+.TP
+pp
+Paste the copied/cut files.  By default, this will not overwrite existing
+files.  To overwrite them, use \fBpo\fR.
+.TP
+m\fIX\fR
+Create a bookmark with the name \fIX\fR
+.TP
+`\fIX\fR
+Move to the bookmark with the name \fIX\fR
+.TP
+n, N
+Find the next file, the previous file.  You can define what to look for
+by typing c\fIX\fR.  If nothing is specified, pressing n will get you to
+the newest file in the directory.
+.TP
+o\fIX\fR
+Change the sort method (like in mutt)
+.TP
+z\fIX\fR
+Change settings
+.TP
+f
+Quickly navigate by entering a part of the filename
+.TP
+Space
+Mark a file
+.TP
+v, V
+Toggle the mark-status of all files, unmark all files
+.TP
+/
+Open the search console
+.TP
+:
+Open the command console
+.TP
+?
+Opens the help screen with more keybindings and documentation
+.\"-----------------------------------------
+.SS Keybindings for using Tabs
+Tabs are used to work in different directories in the same Ranger instance.
+.TP
+g\fIN\fR
+Open a tab. N has to be a number from 0 to 9. If the tab doesn't exist yet,
+it will be created.
+.TP
+gn, ^N
+Create a new tab.
+.TP
+gt, gT
+Go to the next or previous tab.  You can also use TAB and SHIFT+TAB.
+.TP
+gc, ^W
+Close the current tab.  The last tab cannot be closed.
+.P
+.\"-----------------------------------------
+.SS Mouse Usage
+.TP
+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.
+.TP
+Right Mouse Button
+Enter a directory
+.TP
+Scroll Wheel
+Scroll
+.\"-----------------------------------------
+.SS Commands
+.TP
+:delete
+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.
+.TP
+:rename \fInewname\fR
+Rename the current file.  Also try the keybinding A for appending something
+to a file name.
+.TP
+: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.
+.\"-----------------------------------------
+.SH TIPS
+.SS
+Change the directory after exit
+A script like this in your bashrc would make you change the directory
+of your parent shell after exiting ranger:
+.nf
+
+ranger() {
+    $(which ranger) $@ &&
+    cd "$(grep \\^\\' ~/.ranger/bookmarks | cut -b3-)"
+}
+.\"-----------------------------------------
+.SH CONFIGURATION
+The files in
+.B ranger/defaults/
+can be copied into your configuration directory (by default, this is
+$HOME/.ranger) and customized according to your wishes.  
+.B ranger/defaults/options.py
+doesn't have to be copied completely though: Just define those settings
+you want to change and they will override the default values.
+Colorschemes can be placed in $HOME/.ranger/colorschemes.
+.P
+All configuration is done in Python.
+Each configuration file should contain sufficient documentation.
+.\"-----------------------------------------
+.SH COPYRIGHT
+Copyright \(co
+2009, 2010
+Roman Zimbelmann
+.P
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+There is NO warranty;
+not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.\"-----------------------------------------
+.SH SEE ALSO
+The project page:
+.RB < http://savannah.nongnu.org/projects/ranger >
+.P
+The mailing list:
+.RB < http://savannah.nongnu.org/mail/?group=ranger >
+.\"-----------------------------------------
+.SH BUGS
+Since Chuck Norris, the Texas Ranger, watches over this project, there ought
+to be no bugs.  If you think otherwise, please report them here:
+.P
+.RB < http://savannah.nongnu.org/bugs/?group=ranger >
5a08b5b238371b2d1bd0f594dad8dbeb9'>54d48b25 ^
290fe117 ^
5f128523 ^
54d48b25 ^



12d73ee8 ^

795f5244 ^
166e3c0d ^



12d73ee8 ^

f9d069b5 ^
5f128523 ^

12d73ee8 ^



12d73ee8 ^

795f5244 ^
166e3c0d ^

5f98a10c ^
2b250717 ^
5f98a10c ^


9dcbec39 ^
5f98a10c ^



9dcbec39 ^
5f98a10c ^




9dcbec39 ^
5f98a10c ^


166e3c0d ^

12d73ee8 ^

f9d069b5 ^
5f128523 ^
b24eb476 ^


e5e3640c ^
57bcdaee ^
57bcdaee ^
57bcdaee ^


57bcdaee ^


537ad74c ^
ee1a18f0 ^


5f128523 ^
ee1a18f0 ^

dc1323e9 ^
ee1a18f0 ^



dc1323e9 ^
ee1a18f0 ^



5f128523 ^
12d73ee8 ^





795f5244 ^
166e3c0d ^



12d73ee8 ^

f9d069b5 ^
0487a30e ^


12d73ee8 ^





795f5244 ^
166e3c0d ^
12d73ee8 ^
166e3c0d ^
2b250717 ^
e4630643 ^

5f98a10c ^
9dcbec39 ^
e4630643 ^

5f98a10c ^
9dcbec39 ^
e4630643 ^

166e3c0d ^



f9d069b5 ^
166e3c0d ^
827898fc ^
5f128523 ^
12d73ee8 ^


0012c703 ^


795f5244 ^
166e3c0d ^



0012c703 ^

f9d069b5 ^
dc1323e9 ^
b24eb476 ^
dc1323e9 ^
7fd01071 ^
dc1323e9 ^
dc1323e9 ^
0012c703 ^





795f5244 ^
166e3c0d ^



0012c703 ^

f9d069b5 ^
dc1323e9 ^
7fd01071 ^
dc1323e9 ^
dc1323e9 ^
0012c703 ^





795f5244 ^
166e3c0d ^



0012c703 ^

f9d069b5 ^
dc1323e9 ^
b24eb476 ^
dc1323e9 ^
7fd01071 ^
dc1323e9 ^
dc1323e9 ^
0012c703 ^





795f5244 ^
166e3c0d ^



0012c703 ^

f9d069b5 ^
dc1323e9 ^
7fd01071 ^
dc1323e9 ^
dc1323e9 ^
0012c703 ^


cf3ac87f ^






7fd01071 ^
15fdc5d9 ^
cf3ac87f ^

cf3ac87f ^

9fae6657 ^


795f5244 ^
166e3c0d ^



9fae6657 ^

f9d069b5 ^
9fae6657 ^







795f5244 ^
166e3c0d ^



9fae6657 ^

f9d069b5 ^
9fae6657 ^




45c08fea ^
12d73ee8 ^

45c08fea ^
54d48b25 ^
795f5244 ^
166e3c0d ^



54d48b25 ^
45c08fea ^
f9d069b5 ^
e02d7e98 ^
45c08fea ^
bbff2a35 ^



45c08fea ^
bbff2a35 ^
795f5244 ^
166e3c0d ^



bbff2a35 ^
45c08fea ^
f9d069b5 ^
45c08fea ^
e02d7e98 ^
bbff2a35 ^
45c08fea ^










909adb27 ^
45c08fea ^








0487a30e ^
45c08fea ^





bbff2a35 ^
45c08fea ^
e766fd13 ^
45c08fea ^





6fef33fd ^








45c08fea ^




54d48b25 ^

5e9eff8c ^



795f5244 ^
166e3c0d ^



5e9eff8c ^

f9d069b5 ^
5e9eff8c ^



fec4d874 ^
45bcfcfe ^













537ad74c ^
852d9b43 ^
45bcfcfe ^


fec4d874 ^



795f5244 ^
166e3c0d ^



fec4d874 ^

f9d069b5 ^
fec4d874 ^





6c96a437 ^
537ad74c ^

852d9b43 ^
fec4d874 ^
537ad74c ^
fec4d874 ^

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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462