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  Using:
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        t - go to the target of the selected link
40        r - refresh directory listing
41   RETURN - open $SHELL on the current directory
42    SPACE - open $PAGER with the selected file
43        e - open $EDITOR with the selected file
44        o - open $OPEN with the selected file
45        / - start incremental search (RETURN to finish)
46    f/d/s - toggle file/directory/hidden listing
47      n/N - create new file/directory
48        R - rename selected file or directory
49        E - toggle execute permission of the selected file
50        D - delete selected file or (empty) directory
51        m - toggle mark on the selected entry
52        M - toggle mark on all visible entries
53        a - mark all visible entries
54    X/C/V - delete/copy/move all marked entries
55      0-9 - change tab
56  ```
57 
58 **Important Note**: Currently, Rover never asks for confirmation before
59 overwriting existing files while copying/moving marked entries. Please be
60 careful to not accidentally lose your data.
61 
62 
63 Requirements
64 ============
65 
66  * Unix-like system;
67  * curses library.
68 
69 
70 Configuration
71 =============
72 
73  Rover configuration (mostly key bindings and colors) can only be changed by
74 editing the file `config.h` and rebuilding the binary.
75 
76  Note that the external programs executed by some Rover commands may be changed
77 via the appropriate environment variables. For example, to specify an editor:
78  ```
79  $ EDITOR=vi rover
80  ```
81 
82  Rover will first check for variables prefixed  with ROVER_. This can be used to
83 change Rover behavior without interfering with the global environment:
84  ```
85  $ ROVER_EDITOR=vi rover
86  ```
87 
88  Please read rover(1) for more information.
89 
90 
91 Copying
92 =======
93 
94  All of the source code and documentation for Rover is released into the public
95 domain and provided without warranty of any kind.