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