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 has
10 vi-like key bindings for navigation and can open files in $PAGER and $EDITOR.
11 Basic file system operations are also implemented (see rover(1) for details).
12 Rover is designed to be simple, fast and portable.
13 
14 
15 Quick Start
16 ===========
17 
18  Building and Installing:
19  ```
20  $ make
21  $ sudo make install
22  ```
23 
24  Running:
25  ```
26  $ rover [DIR1 [DIR2 [DIR3 [...]]]]
27  ```
28 
29  Basic Usage:
30  ```
31        q - quit Rover
32        ? - show Rover manual
33      j/k - move cursor down/up
34      J/K - move cursor down/up 10 lines
35      g/G - move cursor to top/bottom of listing
36        l - enter selected directory
37        h - go to parent directory
38        H - go to $HOME directory
39      0-9 - change tab
40   RETURN - open $SHELL on the current directory
41    SPACE - open $PAGER with the selected file
42        e - open $VISUAL or $EDITOR with the selected file
43        / - start incremental search (RETURN to finish)
44      n/N - create new file/directory
45        R - rename selected file or directory
46        D - delete selected file or (empty) directory
47  ```
48 
49  Please read rover(1) for more information.
50 
51 
52 Requirements
53 ============
54 
55  * Unix-like system;
56  * curses library.
57 
58 
59 Configuration
60 =============
61 
62  Rover configuration (mostly key bindings and colors) can only be changed by
63 editing the file `config.h` and rebuilding the binary.
64 
65  Note that the external programs executed by some Rover commands may be changed
66 via the appropriate environment variables. For example, to specify an editor:
67  ```
68  $ VISUAL=vi rover
69  ```
70 
71  Rover will first check for variables prefixed  with ROVER_. This can be used to
72 change Rover behavior without interfering with the global environment:
73  ```
74  $ ROVER_VISUAL=vi rover
75  ```
76 
77  Please read rover(1) for more information.
78 
79 
80 Copying
81 =======
82 
83  All of the source code and documentation for Rover is released into the public
84 domain and provided without warranty of any kind.