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