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        ? - show Rover manual
43      j/k - move cursor down/up
44      J/K - move cursor down/up 10 lines
45        l - enter selected directory
46        h - go to parent directory
47        H - go to $HOME directory
48   RETURN - open $SHELL on the current directory
49    SPACE - open $PAGER with the selected file
50        e - open $EDITOR with the selected file
51        / - start incremental search (RETURN to finish)
52    f/d/s - toggle file/directory/hidden listing
53      n/N - create new file/directory
54        r - rename selected file or directory
55        m - toggle mark on the selected entry
56        M - toggle mark on all visible entries
57        a - mark all visible entries
58    X/C/V - delete/copy/move all marked entries
59      0-9 - change tab
60  ```
61 
62 **Important Note**: Currently, Rover never asks for confirmation before
63 overwriting existing files while copying/moving marked entries. Please be
64 careful to not accidentally lose your data.
65 
66 
67 Dependencies
68 ============
69 
70  Rover is supposed to run on any Unix-like system with a curses implementation.
71 To build Rover, you need a C compiler (supporting at least C89) and a `curses.h`
72 header file.
73 
74 
75 Configuration
76 =============
77 
78  By default, rover is installed to `/usr/local/bin/rover`. To change this and other
79 build options, such as the name of the curses library, please edit `Makefile`
80 before executing `make` or specify the options during invocation. For example,
81 to link against `libncurses.so` and install to `/opt/bin/rover`:
82  ```
83  make LDLIBS=-lncurses PREFIX=/opt install
84  ```
85 
86  Rover configuration (mostly key bindings and colors) can only be changed
87 by editing the file `config.h` and rebuilding the binary (with `make`).
88 
89  Note that the external programs executed by some Rover commands may be changed
90 via the appropriate environment variables. For example, to specify an editor:
91  ```
92  $ EDITOR=vi rover
93  ```
94 
95 
96 Copyright
97 =========
98 
99  All of the code and documentation in Rover has been dedicated to the
100    public domain.