ROVER(1)

NAME
rover - file browser for the terminal

SYNOPSIS
rover [-d|--save-cwd FILE] [-m|--save-marks FILE] [DIR [DIR [DIR [...]]]]
rover -h|--help
rover -v|--version

DESCRIPTION
Browse current working directory or the ones specified.

OPTIONS

-d, --save-cwd
    write last visited path to FILE before exiting

-m, --save-marks
    append path of marked entries to FILE before exiting; if FILE doesn't exist, it'll be created

-h, --help
    print help message and exit

-v, --version
    print program version and exit

CONCEPTS

  TABS

Rover is operated via a tabbed interface. There are always ten tabs in total, numbered from 0 to 9. At any given moment, one (and only one) tab is visible on the screen. The number of the tab currently visible is shown on the top right corner of the screen. To view a different tab, one just needs to press its corresponding number. Each tab has a current working directory (CWD) associated to it, also shown on the top of the screen. The CWD of the visible tab is changed as the user navigates through the file system.

It's also possible to set the CWD of tabs at Rover start-up by passing the desired paths as command-line arguments. The tab number 0 always starts at $HOME. If more than nine directories are specified, only the first nine are used for tabs 1-9 and the rest are ignored. Tabs for which an invalid path was assigned will also start at $HOME. Remaining tabs not specified on the command line start at the current working directory of the parent process.

  ENTRIES

An entry is anything that may be found inside a directory in some file system. It may be a file, a directory, a link, a socket, a FIFO, etc. In its most basic usage, Rover will gather a list of entries inside the CWD and present it on the screen.

There is always one (and only one) highlighted entry visible. This is both the cursor location and the current selection. The highlighting moves as the user navigates the entry list with cursor commands. Simple operations, like entering a subdirectory or renaming a file, are done by first selecting the relevant entry and then issuing the appropriate command (see the COMMANDS section). For commands that operate on more than one entry at once (batch commands), selection is not sufficient, since it's not possible to select more than one entry. Batch commands are performed on marked entries.

  MARKS

For some file operations, it is convenient to first mark all entries that are to be processed, so that the appropriate command only needs to be issued once. For such purpose, Rover allows an arbitrary number of entries to be marked, with the limitation that they must be all in the same directory.

Unlike simple selection, the effect of marks is not constrained by visibility. This is so one can mark a number of entries in some directory, navigate to another directory, and then finally issue a copy or move command. Moreover, marks are shared over all tabs. This allows one to mark some entries in one tab that is pointed to the "source" directory of the operation and then issue the command on another tab that is pointed to the "destination" directory.

COMMANDS

q   Quit rover.

j/k Move cursor down/up.

J/K Move cursor down/up 10 lines.

g/G Move cursor to top/bottom of listing.

l   Enter selected directory.

h   Go to parent directory.

H   Go to $HOME directory.

t   Go to the target of the selected link.

y   Copy location to clipboard.

p   Go to location in clipboard.

r   Refresh directory listing.

<RETURN>
    Open $SHELL on the current directory.

<SPACE>
    Open $PAGER with the selected file.

e   Open $EDITOR with the selected file.

o   Open $OPEN with the selected file.

/   Start incremental search.

f/d/s
    Toggle file/directory/hidden listing.

n/N Create new file/directory.

R   Rename selected file or directory.

E   Toggle execute permission of the selected file.

D   Delete selected file or (empty) directory.

m   Toggle mark on the selected entry.

M   Toggle mark on all visible entries.

a   Mark all visible entries.

X/C/V
    Delete/copy/move all marked entries.

0-9 Change tab.

LINE EDITING

Some commands will prompt for an input string. For example, in order to rename a file, the user must supply the new name. This string will appear at the bottom of the screen and must be edited interactively using the keyboard. Printable keys will insert characters at the cursor position. The following shortcuts are available for line editing:

<TAB>
    Finish editing and cancel command.

<RETURN>
    Finish editing and confirm command.

<LEFT>/<RIGHT>
    Move insertion cursor left/right.

<UP>/<DOWN>
    Move insertion cursor to beginning/end of string.

<BACKSPACE>
    Remove one character before cursor.

<DELETE>
    Remove one character after cursor.

<CONTROL>+u
    Clear line (remove all characters).

ENVIRONMENT VARIABLES

HOME
    Full path of the home directory.

PATH
    Colon-separated path list for program directories.

SHELL
    Name of shell program (e.g. /bin/sh).

PAGER
    Name of pager program (e.g. less).

EDITOR
    Name of editor program (e.g. vim or emacs).

CLIP
    Path of clipboard file (e.g. /tmp/clipboard). The user must have read and write permissions on this path. If this variable is not defined, Rover will use an internal, in-memory, clipboard.

RVSEL
    Rover writes the name of the selected entry to this variable before running a subprocess. This allows one to use the selection as part of an arbitrary command by first invoking a shell from Rover (see the COMMANDS section) and then typing something like grep abc "$RVSEL".

OPEN
    This variable can be set to a command accepting a single argument: a filename. The command is supposed to open the given file with an appropriate program.

ROVER_SHELL, ROVER_PAGER, ROVER_EDITOR, ROVER_OPEN
    If any of these variables are set, they override SHELL, PAGER, EDITOR and OPEN, respectivelly.

CONFIGURATION

If you want to change Rover key bindings or colors, you can edit the config.h file in the source distribution and recompile the program. Rover will not use or create any external file during its execution, except when asked to do so by user commands or command-line options.

NOTES

Important: Currently, Rover never asks for confirmation before overwriting existing files while copying/moving marked entries. Please be careful to not accidentally lose your data.

LINKS
Rover homepage: <http://lecram.github.io/p/rover/>.

SEE ALSO
noice(1), mc(1), vifm(1), ranger(1)