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