Blob


1 .TH ROVER 1 rover\-0.1.1
2 .SH NAME
3 rover \- file browser for the terminal
4 .SH SYNOPSIS
5 .B rover
6 [\fIDIRECTORY\fR [\fIDIRECTORY\fR [\fIDIRECTORY\fR [...]]]]
7 .br
8 .B rover
9 [\fIOPTION\fR]
10 .SH DESCRIPTION
11 Browse current working directory or the ones specified.
12 .SH OPTIONS
13 .TP
14 \fB\-h\fR, \fB\-\-help\fR
15 print help message and exit
16 .TP
17 \fB\-v\fR, \fB\-\-version\fR
18 print program version and exit
19 .SH CONCEPTS
20 .SS TABS
21 .PP
22 Rover is operated via a tabbed interface. At any given moment, one (and only
23 one) tab is visible on the screen. There are always ten tabs in total, numbered
24 from 0 to 9. The number of the tab currently visible is shown on the top right
25 corner of the screen. To view a different tab, one just needs to press its
26 corresponding number. Each tab has a \fBcurrent working directory\fR (\fBCWD\fR)
27 associated to it, also shown on the top of the screen. The \fBCWD\fR of the
28 visible tab is changed as the user navigates through the file system.
29 .PP
30 It's also possible to set the \fBCWD\fR of tabs at Rover start-up by passing the
31 desired paths as command-line arguments. The tab number 0 always starts at
32 \fB$HOME\fR. If more than nine directories are specified, only the first nine
33 are used for tabs 1\-9 and the rest is ignored. Tabs for which an invalid path
34 were assigned will also start at \fB$HOME\fR. Remaining tabs not specified on
35 the command line start at the current working directory of the parent process.
36 .SS ENTRIES
37 .PP
38 An \fBentry\fR is anything that may be found inside a directory in some file
39 system. It may be a file, a directory, a link, a socket, a FIFO, etc. In its
40 most basic usage, Rover will gather the list of entries inside the \fBCWD\fR
41 and present them on the screen, one per line.
42 .PP
43 There is always one (and only one) highlighted entry visible. This is both the
44 \fBcursor\fR location and the current \fBselection\fR. The highlighting moves as
45 the user navigates the entry list with cursor commands. Simple operations, like
46 entering a subdirectory or renaming a file, are done by first selecting the
47 relevant entry and them issuing the appropriate command (see the \fBCOMMANDS\fR
48 section). For commands that operate on more than one entry at once (batch
49 commands), selection is not sufficient, since it's not possible to select more
50 than one entry. Batch commands are performed on marked entries.
51 .SS MARKS
52 .PP
53 For some file operations, it is convenient to first \fBmark\fR all entries that
54 are to be processed, so that the appropriate command only needs to be issued
55 once. For such purpose, Rover allows an arbitrary number of entries to be
56 marked, with the limitation that they must be all in the same directory.
57 .PP
58 Unlike simple selection, the effect of marks is not constrained by visibility.
59 This is so one can mark a number of entries in some directory, navigate to other
60 directory, and then finally issue a copy or move command. Moreover, marks are
61 shared over all tabs. This allows one to mark some entries in one tab that is
62 pointed to the "source" directory of the operation and then issue the command on
63 another tab that is pointed to the "destination" directory.
64 .SH COMMANDS
65 .TP
66 .B q
67 Quit rover.
68 .TP
69 .B j/k
70 Move cursor down/up.
71 .TP
72 .B J/K
73 Move cursor down/up 10 lines.
74 .TP
75 .B l
76 Enter selected directory.
77 .TP
78 .B h
79 Go to parent directory.
80 .TP
81 .B H
82 Go to \fB$HOME\fR directory.
83 .TP
84 .B <RETURN>
85 Open \fB$SHELL\fR on the current directory.
86 .TP
87 .B <SPACE>
88 Open \fB$PAGER\fR with the selected file.
89 .TP
90 .B e
91 Open \fB$EDITOR\fR with the selected file.
92 .TP
93 .B /
94 Start incremental search (\fB<RETURN>\fR to finish).
95 .TP
96 .B f/d/s
97 Toggle file/directory/hidden listing.
98 .TP
99 .B n/N
100 Create new file/directory.
101 .TP
102 .B r
103 Rename selected file or directory.
104 .TP
105 .B m
106 Toggle mark on the selected entry.
107 .TP
108 .B M
109 Toggle mark on all visible entries.
110 .TP
111 .B a
112 Mark all visible entries.
113 .TP
114 .B X/C/V
115 Delete/copy/move all marked entries.
116 .TP
117 .B 0-9
118 Change tab.
119 .SH ENVIRONMENT VARIABLES
120 .TP
121 .B HOME
122 Full path of the home directory.
123 .TP
124 .B PATH
125 Colon\-separated path list for program directories.
126 .TP
127 .B SHELL
128 Name of shell program (e.g. \fI/bin/sh\fP).
129 .TP
130 .B PAGER
131 Name of pager program (e.g. \fIless\fP).
132 .TP
133 .B EDITOR
134 Name of editor program (e.g. \fIvim\fP or \fIemacs\fP).
135 .SH CONFIGURATION
136 .PP
137 If you want to change Rover key bindings or colors, you can edit the
138 \fIconfig.h\fP file in the source distribution and recompile the program. Rover
139 will not use or create any external file during its execution, except when asked
140 to do so by user commands.
141 .SH NOTES
142 .PP
143 \fBImportant\fR: Currently, Rover never asks for confirmation before overwriting
144 existing files while copying/moving marked entries. Please be careful to not
145 accidentally lose your data.
146 .SH LINKS
147 Rover homepage: <https://github.com/lecram/rover>.
148 .SH SEE ALSO
149 \fBmc(1)\fR, \fBvifm(1)\fR, \fBranger(1)\fR