1 Introduction
2 ============
3 
4  Rover is a file browser for the terminal.
5 
6 ![Rover screenshot](/../screenshots/screenshot.png?raw=true "Screenshot")
7 
8  The main goal is to provide a faster way to explore a file system from the
9 terminal, compared to what's possible by using `cd`, `ls`, etc. Rover
10 is designed to be simple and portable. It was originally written to be
11 used on a headless Raspberry Pi accessed via ssh. The [Ranger file manager](http://ranger.nongnu.org/)
12 was a major inspiration for the user interface design, but Rover has
13 significantly less features and dependencies.
14 
15 
16 Quick Start
17 ===========
18 
19  Building:
20  ```
21  $ make
22  ```
23 
24  Installing:
25  ```
26  $ sudo make install
27  ```
28 
29  Running:
30  ```
31  $ rover
32  ```
33 
34  Specify path for some (up to 9) tabs at startup:
35  ```
36  $ rover [DIR1 [DIR2 [DIR3 [...]]]]
37  ```
38 
39  Using:
40  ```
41        q - quit Rover
42      j/k - move cursor down/up
43      J/K - move cursor down/up 10 lines
44        l - enter selected directory
45        h - go to parent directory
46        H - go to $HOME directory
47   RETURN - open $SHELL on the current directory
48    SPACE - open $PAGER with the selected file
49        e - open $EDITOR with the selected file
50        / - start incremental search (RETURN to finish)
51    f/d/s - toggle file/directory/hidden listing
52      n/N - create new file/directory
53        r - rename selected file or directory
54        m - toggle mark on the selected entry
55        M - toggle mark on all visible entries
56        a - mark all visible entries
57    X/C/V - delete/copy/move all marked entries
58      0-9 - change tab
59  ```
60 
61 
62 Dependencies
63 ============
64 
65  Rover is supposed to run on any Unix-like system with a curses implementation.
66 To build Rover, you need a C compiler (supporting at least C89) and a `curses.h`
67 header file.
68 
69 
70 Configuration
71 =============
72 
73  By default, rover is installed to `/usr/local/bin/rover`. To change this and other
74 build options, such as the name of the curses library, please edit `Makefile`
75 before executing `make` or specify the options during invocation. For example,
76 to link against `libncurses.so` and install to `/opt/bin/rover`:
77  ```
78  make LDLIBS=-lncurses PREFIX=/opt install
79  ```
80 
81  Rover configuration (mostly key bindings and colors) can only be changed
82 by editing the file `config.h` and rebuilding the binary (with `make`).
83 
84  Note that the external programs executed by some Rover commands may be changed
85 via the appropriate environment variables. For example, to specify an editor:
86  ```
87  $ EDITOR=vi rover
88  ```
89 
90 
91 Copyright
92 =========
93 
94  All of the code and documentation in Rover has been dedicated to the
95    public domain.