rover.1

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