1 .TH ROVER 1 rover\-1.0.0
3 rover \- file browser for the terminal
6 [\fB\-d\fR|\fB\-\-save\-cwd\fR \fIFILE\fR]
7 [\fB\-m\fR|\fB\-\-save\-marks\fR \fIFILE\fR]
8 [\fIDIR\fR [\fIDIR\fR [\fIDIR\fR [...]]]]
11 \fB\-h\fR|\fB\-\-help\fR
14 \fB\-v\fR|\fB\-\-version\fR
16 Browse current working directory or the ones specified.
19 \fB\-d\fR, \fB\-\-save\-cwd\fR
20 write last visited path to \fIFILE\fR before exiting
22 \fB\-m\fR, \fB\-\-save\-marks\fR
23 append path of marked entries to \fIFILE\fR before exiting;
24 if \fIFILE\fR doesn't exist, it'll be created
26 \fB\-h\fR, \fB\-\-help\fR
27 print help message and exit
29 \fB\-v\fR, \fB\-\-version\fR
30 print program version and exit
34 Rover is operated via a tabbed interface. There are always ten tabs in total,
35 numbered from 0 to 9. At any given moment, one (and only one) tab is visible on
36 the screen. The number of the tab currently visible is shown on the top right
37 corner of the screen. To view a different tab, one just needs to press its
38 corresponding number. Each tab has a \fBcurrent working directory\fR (\fBCWD\fR)
39 associated to it, also shown on the top of the screen. The \fBCWD\fR of the
40 visible tab is changed as the user navigates through the file system.
42 It's also possible to set the \fBCWD\fR of tabs at Rover start-up by passing the
43 desired paths as command-line arguments. The tab number 0 always starts at
44 \fB$HOME\fR. If more than nine directories are specified, only the first nine
45 are used for tabs 1\-9 and the rest are ignored. Tabs for which an invalid path
46 was assigned will also start at \fB$HOME\fR. Remaining tabs not specified on
47 the command line start at the current working directory of the parent process.
50 An \fBentry\fR is anything that may be found inside a directory in some file
51 system. It may be a file, a directory, a link, a socket, a FIFO, etc. In its
52 most basic usage, Rover will gather a list of entries inside the \fBCWD\fR
53 and present it on the screen.
55 There is always one (and only one) highlighted entry visible. This is both the
56 \fBcursor\fR location and the current \fBselection\fR. The highlighting moves as
57 the user navigates the entry list with cursor commands. Simple operations, like
58 entering a subdirectory or renaming a file, are done by first selecting the
59 relevant entry and then issuing the appropriate command (see the \fBCOMMANDS\fR
60 section). For commands that operate on more than one entry at once (batch
61 commands), selection is not sufficient, since it's not possible to select more
62 than one entry. Batch commands are performed on marked entries.
65 For some file operations, it is convenient to first \fBmark\fR all entries that
66 are to be processed, so that the appropriate command only needs to be issued
67 once. For such purpose, Rover allows an arbitrary number of entries to be
68 marked, with the limitation that they must be all in the same directory.
70 Unlike simple selection, the effect of marks is not constrained by visibility.
71 This is so one can mark a number of entries in some directory, navigate to another
72 directory, and then finally issue a copy or move command. Moreover, marks are
73 shared over all tabs. This allows one to mark some entries in one tab that is
74 pointed to the "source" directory of the operation and then issue the command on
75 another tab that is pointed to the "destination" directory.
85 Move cursor down/up 10 lines.
88 Move cursor to top/bottom of listing.
91 Enter selected directory.
94 Go to parent directory.
97 Go to \fB$HOME\fR directory.
100 Go to the target of the selected link.
103 Copy location to clipboard.
106 Go to location in clipboard.
109 Refresh directory listing.
112 Open \fB$SHELL\fR on the current directory.
115 Open \fB$PAGER\fR with the selected file.
118 Open \fB$VISUAL\fR or \fB$EDITOR\fR with the selected file.
121 Open \fB$OPEN\fR with the selected file.
124 Start incremental search.
127 Toggle file/directory/hidden listing.
130 Create new file/directory.
133 Rename selected file or directory.
136 Toggle execute permission of the selected file.
139 Delete selected file or (empty) directory.
142 Toggle mark on the selected entry.
145 Toggle mark on all visible entries.
148 Mark all visible entries.
151 Delete/copy/move all marked entries.
157 Some commands will prompt for an input string. For example, in order to rename a
158 file, the user must supply the new name. This string will appear at the bottom
159 of the screen and must be edited interactively using the keyboard. Printable
160 keys will insert characters at the cursor position. The following shortcuts are
161 available for line editing:
164 Finish editing and \fBcancel\fR command.
167 Finish editing and \fBconfirm\fR command.
170 Move insertion cursor left/right.
173 Move insertion cursor to beginning/end of string.
176 Remove one character before cursor.
179 Remove one character after cursor.
182 Clear line (remove all characters).
183 .SH ENVIRONMENT VARIABLES
186 Full path of the home directory.
189 Colon\-separated path list for program directories.
192 Name of shell program (e.g. \fI/bin/sh\fP).
195 Name of pager program (e.g. \fIless\fP).
198 Name of visual editor program (e.g. \fIvim\fP or \fIemacs\fP).
201 Name of line editor program (e.g. \fIed\fP or \fIex\fP).
204 Path of clipboard file (e.g. \fI/tmp/clipboard\fP).
205 The user must have read and write permissions on this path.
206 If this variable is not defined, Rover will use an internal, in-memory, clipboard.
209 Rover writes the name of the selected entry to this variable before running a
210 subprocess. This allows one to use the selection as part of an arbitrary command
211 by first invoking a shell from Rover (see the \fBCOMMANDS\fR section) and then
212 typing something like \fBgrep abc "$RVSEL"\fR.
215 This variable can be set to a command accepting a single argument: a filename.
216 The command is supposed to open the given file with an appropriate program.
218 .B ROVER_SHELL, ROVER_PAGER, ROVER_VISUAL, ROVER_EDITOR, ROVER_OPEN
219 If any of these variables are set, they override \fBSHELL\fR, \fBPAGER\fR,
220 \fBVISUAL\fR, \fBEDITOR\fR and \fBOPEN\fR, respectively.
223 If you want to change Rover key bindings or colors, you can edit the
224 \fIconfig.h\fP file in the source distribution and recompile the program. Rover
225 will not use or create any external file during its execution, except when asked
226 to do so by user commands or command-line options.
229 \fBImportant\fR: Currently, Rover never asks for confirmation before overwriting
230 existing files while copying/moving marked entries. Please be careful to not
231 accidentally lose your data.
233 Rover homepage: <http://lecram.github.io/p/rover/>.
235 \fBnoice(1)\fR, \fBmc(1)\fR, \fBvifm(1)\fR, \fBranger(1)\fR
