1 b084f13e 2015-06-03 marcelgmr .TH ROVER 1 rover\-0.2.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 05c9a0a8 2014-12-02 marcelgmr [\fIDIRECTORY\fR [\fIDIRECTORY\fR [\fIDIRECTORY\fR [...]]]]
8 ff684771 2014-12-02 marcelgmr .B rover
9 05c9a0a8 2014-12-02 marcelgmr [\fIOPTION\fR]
10 ff684771 2014-12-02 marcelgmr .SH DESCRIPTION
11 ff684771 2014-12-02 marcelgmr Browse current working directory or the ones specified.
12 ff684771 2014-12-02 marcelgmr .SH OPTIONS
14 ff684771 2014-12-02 marcelgmr \fB\-h\fR, \fB\-\-help\fR
15 ff684771 2014-12-02 marcelgmr print help message and exit
17 ff684771 2014-12-02 marcelgmr \fB\-v\fR, \fB\-\-version\fR
18 ff684771 2014-12-02 marcelgmr print program version and exit
19 b0032a44 2014-12-04 marcelgmr .SH CONCEPTS
20 b0032a44 2014-12-04 marcelgmr .SS TABS
22 b0032a44 2014-12-04 marcelgmr Rover is operated via a tabbed interface. At any given moment, one (and only
23 b0032a44 2014-12-04 marcelgmr one) tab is visible on the screen. There are always ten tabs in total, numbered
24 b0032a44 2014-12-04 marcelgmr from 0 to 9. The number of the tab currently visible is shown on the top right
25 b0032a44 2014-12-04 marcelgmr corner of the screen. To view a different tab, one just needs to press its
26 b0032a44 2014-12-04 marcelgmr corresponding number. Each tab has a \fBcurrent working directory\fR (\fBCWD\fR)
27 b0032a44 2014-12-04 marcelgmr associated to it, also shown on the top of the screen. The \fBCWD\fR of the
28 b0032a44 2014-12-04 marcelgmr visible tab is changed as the user navigates through the file system.
30 b0032a44 2014-12-04 marcelgmr It's also possible to set the \fBCWD\fR of tabs at Rover start-up by passing the
31 b0032a44 2014-12-04 marcelgmr desired paths as command-line arguments. The tab number 0 always starts at
32 b0032a44 2014-12-04 marcelgmr \fB$HOME\fR. If more than nine directories are specified, only the first nine
33 b0032a44 2014-12-04 marcelgmr are used for tabs 1\-9 and the rest is ignored. Tabs for which an invalid path
34 b0032a44 2014-12-04 marcelgmr were assigned will also start at \fB$HOME\fR. Remaining tabs not specified on
35 b0032a44 2014-12-04 marcelgmr the command line start at the current working directory of the parent process.
36 b0032a44 2014-12-04 marcelgmr .SS ENTRIES
38 b0032a44 2014-12-04 marcelgmr An \fBentry\fR is anything that may be found inside a directory in some file
39 d07ebe17 2014-12-04 marcelgmr system. It may be a file, a directory, a link, a socket, a FIFO, etc. In its
40 d07ebe17 2014-12-04 marcelgmr most basic usage, Rover will gather the list of entries inside the \fBCWD\fR
41 d07ebe17 2014-12-04 marcelgmr and present them on the screen, one per line.
43 d07ebe17 2014-12-04 marcelgmr There is always one (and only one) highlighted entry visible. This is both the
44 d07ebe17 2014-12-04 marcelgmr \fBcursor\fR location and the current \fBselection\fR. The highlighting moves as
45 d07ebe17 2014-12-04 marcelgmr the user navigates the entry list with cursor commands. Simple operations, like
46 d07ebe17 2014-12-04 marcelgmr entering a subdirectory or renaming a file, are done by first selecting the
47 d07ebe17 2014-12-04 marcelgmr relevant entry and them issuing the appropriate command (see the \fBCOMMANDS\fR
48 d07ebe17 2014-12-04 marcelgmr section). For commands that operate on more than one entry at once (batch
49 d07ebe17 2014-12-04 marcelgmr commands), selection is not sufficient, since it's not possible to select more
50 d07ebe17 2014-12-04 marcelgmr than one entry. Batch commands are performed on marked entries.
51 b0032a44 2014-12-04 marcelgmr .SS MARKS
53 b0032a44 2014-12-04 marcelgmr For some file operations, it is convenient to first \fBmark\fR all entries that
54 b0032a44 2014-12-04 marcelgmr are to be processed, so that the appropriate command only needs to be issued
55 b0032a44 2014-12-04 marcelgmr once. For such purpose, Rover allows an arbitrary number of entries to be
56 b0032a44 2014-12-04 marcelgmr marked, with the limitation that they must be all in the same directory.
58 b0032a44 2014-12-04 marcelgmr Unlike simple selection, the effect of marks is not constrained by visibility.
59 b0032a44 2014-12-04 marcelgmr This is so one can mark a number of entries in some directory, navigate to other
60 b0032a44 2014-12-04 marcelgmr directory, and then finally issue a copy or move command. Moreover, marks are
61 b0032a44 2014-12-04 marcelgmr shared over all tabs. This allows one to mark some entries in one tab that is
62 b0032a44 2014-12-04 marcelgmr pointed to the "source" directory of the operation and then issue the command on
63 b0032a44 2014-12-04 marcelgmr another tab that is pointed to the "destination" directory.
64 ff684771 2014-12-02 marcelgmr .SH COMMANDS
67 ff684771 2014-12-02 marcelgmr Quit rover.
70 ff684771 2014-12-02 marcelgmr Move cursor down/up.
73 ff684771 2014-12-02 marcelgmr Move cursor down/up 10 lines.
76 ff684771 2014-12-02 marcelgmr Enter selected directory.
79 ff684771 2014-12-02 marcelgmr Go to parent directory.
82 ff684771 2014-12-02 marcelgmr Go to \fB$HOME\fR directory.
85 97217d57 2015-05-26 marcelgmr Refresh directory listing.
87 ff684771 2014-12-02 marcelgmr .B <RETURN>
88 ff684771 2014-12-02 marcelgmr Open \fB$SHELL\fR on the current directory.
90 ff684771 2014-12-02 marcelgmr .B <SPACE>
91 ff684771 2014-12-02 marcelgmr Open \fB$PAGER\fR with the selected file.
94 ff684771 2014-12-02 marcelgmr Open \fB$EDITOR\fR with the selected file.
97 a022230d 2015-04-26 marcelgmr Start incremental search.
99 ff684771 2014-12-02 marcelgmr .B f/d/s
100 ff684771 2014-12-02 marcelgmr Toggle file/directory/hidden listing.
102 ff684771 2014-12-02 marcelgmr .B n/N
103 ff684771 2014-12-02 marcelgmr Create new file/directory.
106 ff684771 2014-12-02 marcelgmr Rename selected file or directory.
109 e0d6077a 2015-05-27 marcelgmr Delete selected file or (empty) directory.
112 ff684771 2014-12-02 marcelgmr Toggle mark on the selected entry.
115 ff684771 2014-12-02 marcelgmr Toggle mark on all visible entries.
118 ff684771 2014-12-02 marcelgmr Mark all visible entries.
120 ff684771 2014-12-02 marcelgmr .B X/C/V
121 ff684771 2014-12-02 marcelgmr Delete/copy/move all marked entries.
123 ff684771 2014-12-02 marcelgmr .B 0-9
124 ff684771 2014-12-02 marcelgmr Change tab.
125 a022230d 2015-04-26 marcelgmr .SH LINE EDITING
127 a022230d 2015-04-26 marcelgmr Some commands will prompt for an input string. For example, in order to rename a
128 a022230d 2015-04-26 marcelgmr file, the user must supply the new name. This string will appear at the bottom
129 a022230d 2015-04-26 marcelgmr of the screen and must be edited interactivelly using the keyboard. Printable
130 a022230d 2015-04-26 marcelgmr keys will insert characters at the cursor position. The following shortcuts are
131 a022230d 2015-04-26 marcelgmr available for line editing:
133 a022230d 2015-04-26 marcelgmr .B <TAB>
134 a022230d 2015-04-26 marcelgmr Finish editing and \fBcancel\fR command.
136 a022230d 2015-04-26 marcelgmr .B <RETURN>
137 a022230d 2015-04-26 marcelgmr Finish editing and \fBconfirm\fR command.
139 a022230d 2015-04-26 marcelgmr .B <LEFT>/<RIGHT>
140 a022230d 2015-04-26 marcelgmr Move insertion cursor left/right.
142 a022230d 2015-04-26 marcelgmr .B <UP>/<DOWN>
143 a022230d 2015-04-26 marcelgmr Move insertion cursor to beginning/end of string.
145 a022230d 2015-04-26 marcelgmr .B <BACKSPACE>
146 a022230d 2015-04-26 marcelgmr Remove one character before cursor.
148 a022230d 2015-04-26 marcelgmr .B <DELETE>
149 a022230d 2015-04-26 marcelgmr Remove one character after cursor.
151 a022230d 2015-04-26 marcelgmr .B <CONTROL>+u
152 a022230d 2015-04-26 marcelgmr Clear line (remove all characters).
153 ec43194b 2014-12-04 marcelgmr .SH ENVIRONMENT VARIABLES
155 ec43194b 2014-12-04 marcelgmr .B HOME
156 ec43194b 2014-12-04 marcelgmr Full path of the home directory.
158 ec43194b 2014-12-04 marcelgmr .B PATH
159 ec43194b 2014-12-04 marcelgmr Colon\-separated path list for program directories.
161 ec43194b 2014-12-04 marcelgmr .B SHELL
162 ec43194b 2014-12-04 marcelgmr Name of shell program (e.g. \fI/bin/sh\fP).
164 ec43194b 2014-12-04 marcelgmr .B PAGER
165 ec43194b 2014-12-04 marcelgmr Name of pager program (e.g. \fIless\fP).
167 ec43194b 2014-12-04 marcelgmr .B EDITOR
168 ec43194b 2014-12-04 marcelgmr Name of editor program (e.g. \fIvim\fP or \fIemacs\fP).
170 cf66423f 2015-06-01 marcelgmr .B RVSEL
171 cf66423f 2015-06-01 marcelgmr Rover writes the name of the selected entry to this variable before running a
172 cf66423f 2015-06-01 marcelgmr subprocess. This allows one to use the selection as part of an arbitrary command
173 cf66423f 2015-06-01 marcelgmr by first invoking a shell from Rover (see the \fBCOMMANDS\fR section) and then
174 cf66423f 2015-06-01 marcelgmr typing something like \fBgrep abc "$RVSEL"\fR.
175 6c51734b 2014-12-02 marcelgmr .SH CONFIGURATION
177 05c9a0a8 2014-12-02 marcelgmr If you want to change Rover key bindings or colors, you can edit the
178 05c9a0a8 2014-12-02 marcelgmr \fIconfig.h\fP file in the source distribution and recompile the program. Rover
179 6c51734b 2014-12-02 marcelgmr will not use or create any external file during its execution, except when asked
180 6c51734b 2014-12-02 marcelgmr to do so by user commands.
181 ff684771 2014-12-02 marcelgmr .SH NOTES
183 ff684771 2014-12-02 marcelgmr \fBImportant\fR: Currently, Rover never asks for confirmation before overwriting
184 ff684771 2014-12-02 marcelgmr existing files while copying/moving marked entries. Please be careful to not
185 ff684771 2014-12-02 marcelgmr accidentally lose your data.
186 d781a4b9 2015-04-17 marcelgmr .SH LINKS
187 ff684771 2014-12-02 marcelgmr Rover homepage: <https://github.com/lecram/rover>.
188 d781a4b9 2015-04-17 marcelgmr .SH SEE ALSO
189 d781a4b9 2015-04-17 marcelgmr \fBmc(1)\fR, \fBvifm(1)\fR, \fBranger(1)\fR
