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