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