1 8fe7904a 2014-11-07 marcelgmr Introduction
2 8fe7904a 2014-11-07 marcelgmr ============
4 ee238663 2014-11-09 marcelgmr Rover is a file browser for the terminal.
6 95bdeca1 2014-11-07 marcelgmr 
8 cc8a22df 2014-11-07 marcelgmr The main goal is to provide a faster way to explore a file system from the
9 8fe7904a 2014-11-07 marcelgmr terminal, compared to what's possible by using `cd`, `ls`, etc. Rover
10 cfa4fe73 2014-12-03 marcelgmr is designed to be simple and portable. The [Ranger file manager](http://ranger.nongnu.org/)
11 8fe7904a 2014-11-07 marcelgmr was a major inspiration for the user interface design, but Rover has
12 8fe7904a 2014-11-07 marcelgmr significantly less features and dependencies.
15 8fe7904a 2014-11-07 marcelgmr Quick Start
16 8fe7904a 2014-11-07 marcelgmr ===========
18 8fe7904a 2014-11-07 marcelgmr Building:
23 719c5cd4 2014-11-08 marcelgmr Installing:
25 8faaef35 2014-11-09 marcelgmr $ sudo make install
28 8fe7904a 2014-11-07 marcelgmr Running:
30 719c5cd4 2014-11-08 marcelgmr $ rover
33 ac947adb 2014-11-09 marcelgmr Specify path for some (up to 9) tabs at startup:
35 ac947adb 2014-11-09 marcelgmr $ rover [DIR1 [DIR2 [DIR3 [...]]]]
40 8fe7904a 2014-11-07 marcelgmr q - quit Rover
41 33a574e8 2014-12-02 marcelgmr ? - show Rover manual
42 8986353b 2014-11-11 marcelgmr j/k - move cursor down/up
43 8986353b 2014-11-11 marcelgmr J/K - move cursor down/up 10 lines
44 8fe7904a 2014-11-07 marcelgmr l - enter selected directory
45 8fe7904a 2014-11-07 marcelgmr h - go to parent directory
46 8fe7904a 2014-11-07 marcelgmr H - go to $HOME directory
47 8fe7904a 2014-11-07 marcelgmr RETURN - open $SHELL on the current directory
48 2f7057e8 2014-11-09 marcelgmr SPACE - open $PAGER with the selected file
49 2f7057e8 2014-11-09 marcelgmr e - open $EDITOR with the selected file
50 8fe7904a 2014-11-07 marcelgmr / - start incremental search (RETURN to finish)
51 7b9cb44d 2014-11-14 marcelgmr f/d/s - toggle file/directory/hidden listing
52 7b9cb44d 2014-11-14 marcelgmr n/N - create new file/directory
53 7b9cb44d 2014-11-14 marcelgmr r - rename selected file or directory
54 7b9cb44d 2014-11-14 marcelgmr m - toggle mark on the selected entry
55 7b9cb44d 2014-11-14 marcelgmr M - toggle mark on all visible entries
56 7b9cb44d 2014-11-14 marcelgmr a - mark all visible entries
57 7b9cb44d 2014-11-14 marcelgmr X/C/V - delete/copy/move all marked entries
58 c78b45be 2014-11-09 marcelgmr 0-9 - change tab
61 a31a7b29 2014-11-15 marcelgmr **Important Note**: Currently, Rover never asks for confirmation before
62 a31a7b29 2014-11-15 marcelgmr overwriting existing files while copying/moving marked entries. Please be
63 a31a7b29 2014-11-15 marcelgmr careful to not accidentally lose your data.
66 0aeec769 2014-11-07 marcelgmr Dependencies
67 0aeec769 2014-11-07 marcelgmr ============
69 0aeec769 2014-11-07 marcelgmr Rover is supposed to run on any Unix-like system with a curses implementation.
70 e5fe9820 2015-04-17 marcelgmr To build Rover, you need a C compiler and a curses library with the corresponding
71 e5fe9820 2015-04-17 marcelgmr header file.
74 8fe7904a 2014-11-07 marcelgmr Configuration
75 8fe7904a 2014-11-07 marcelgmr =============
77 2254ef43 2014-11-11 marcelgmr By default, rover is installed to `/usr/local/bin/rover`. To change this and other
78 719c5cd4 2014-11-08 marcelgmr build options, such as the name of the curses library, please edit `Makefile`
79 719c5cd4 2014-11-08 marcelgmr before executing `make` or specify the options during invocation. For example,
80 719c5cd4 2014-11-08 marcelgmr to link against `libncurses.so` and install to `/opt/bin/rover`:
82 2254ef43 2014-11-11 marcelgmr make LDLIBS=-lncurses PREFIX=/opt install
85 8fe7904a 2014-11-07 marcelgmr Rover configuration (mostly key bindings and colors) can only be changed
86 d925320d 2014-11-07 marcelgmr by editing the file `config.h` and rebuilding the binary (with `make`).
88 0aeec769 2014-11-07 marcelgmr Note that the external programs executed by some Rover commands may be changed
89 719c5cd4 2014-11-08 marcelgmr via the appropriate environment variables. For example, to specify an editor:
91 719c5cd4 2014-11-08 marcelgmr $ EDITOR=vi rover
95 8fe7904a 2014-11-07 marcelgmr Copyright
96 8fe7904a 2014-11-07 marcelgmr =========
98 cfa4fe73 2014-12-03 marcelgmr All of the Rover source code and documentation is released into the public
99 cfa4fe73 2014-12-03 marcelgmr domain and provided without warranty of any kind.
