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 8fe7904a 2014-11-07 marcelgmr is designed to be simple and portable. It was originally written to be
11 8fe7904a 2014-11-07 marcelgmr used on a headless Raspberry Pi accessed via ssh. The [Ranger file manager](http://ranger.nongnu.org/)
12 8fe7904a 2014-11-07 marcelgmr was a major inspiration for the user interface design, but Rover has
13 8fe7904a 2014-11-07 marcelgmr significantly less features and dependencies.
16 8fe7904a 2014-11-07 marcelgmr Quick Start
17 8fe7904a 2014-11-07 marcelgmr ===========
19 8fe7904a 2014-11-07 marcelgmr Building:
24 719c5cd4 2014-11-08 marcelgmr Installing:
26 8faaef35 2014-11-09 marcelgmr $ sudo make install
29 8fe7904a 2014-11-07 marcelgmr Running:
31 719c5cd4 2014-11-08 marcelgmr $ rover
34 ac947adb 2014-11-09 marcelgmr Specify path for some (up to 9) tabs at startup:
36 ac947adb 2014-11-09 marcelgmr $ rover [DIR1 [DIR2 [DIR3 [...]]]]
41 8fe7904a 2014-11-07 marcelgmr q - quit Rover
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 8fe7904a 2014-11-07 marcelgmr f - toggle file listing
52 8fe7904a 2014-11-07 marcelgmr d - toggle directory listing
53 8fe7904a 2014-11-07 marcelgmr s - toggle hidden file/directory listing
54 c78b45be 2014-11-09 marcelgmr 0-9 - change tab
58 0aeec769 2014-11-07 marcelgmr Dependencies
59 0aeec769 2014-11-07 marcelgmr ============
61 0aeec769 2014-11-07 marcelgmr Rover is supposed to run on any Unix-like system with a curses implementation.
62 d925320d 2014-11-07 marcelgmr To build Rover, you need a C compiler (supporting at least C89) and a `curses.h`
63 d925320d 2014-11-07 marcelgmr header file.
66 8fe7904a 2014-11-07 marcelgmr Configuration
67 8fe7904a 2014-11-07 marcelgmr =============
69 2254ef43 2014-11-11 marcelgmr By default, rover is installed to `/usr/local/bin/rover`. To change this and other
70 719c5cd4 2014-11-08 marcelgmr build options, such as the name of the curses library, please edit `Makefile`
71 719c5cd4 2014-11-08 marcelgmr before executing `make` or specify the options during invocation. For example,
72 719c5cd4 2014-11-08 marcelgmr to link against `libncurses.so` and install to `/opt/bin/rover`:
74 2254ef43 2014-11-11 marcelgmr make LDLIBS=-lncurses PREFIX=/opt install
77 8fe7904a 2014-11-07 marcelgmr Rover configuration (mostly key bindings and colors) can only be changed
78 d925320d 2014-11-07 marcelgmr by editing the file `config.h` and rebuilding the binary (with `make`).
80 0aeec769 2014-11-07 marcelgmr Note that the external programs executed by some Rover commands may be changed
81 719c5cd4 2014-11-08 marcelgmr via the appropriate environment variables. For example, to specify an editor:
83 719c5cd4 2014-11-08 marcelgmr $ EDITOR=vi rover
87 8fe7904a 2014-11-07 marcelgmr Copyright
88 8fe7904a 2014-11-07 marcelgmr =========
90 8fe7904a 2014-11-07 marcelgmr All of the code and documentation in Rover has been dedicated to the
91 8fe7904a 2014-11-07 marcelgmr public domain.
