vimprobable2.1

   1 .\" Process this file with
   2 .\" groff -man -Tascii vimprobable2.1
   3 .\"
   4 .TH VIMPROBABLE2 1 "JANUARY 2010" "Linux User Manuals"
   5 .SH NAME
   6 Vimprobable \- A WWW browser based on webkit with keybindings inspired by vim, the great editor.
   7
   8 .SH SYNOPSIS
   9 .B vimprobable2
  10 .OP \fL\-c|\-\-config
  11 .OP \fL\-e|\-\-embed
  12 .OP \fL\-h|\-\-help
  13 .OP \fL\-v|\-\-version
  14 .OP URI
  15
  16 .SH OPTIONS
  17 .TP
  18 .BI -c " config file"
  19 Use the specified config file.  If none found, defaults to
  20 .I $HOME/.config/vimprobable/vimprobablerc
  21 .TP
  22 .BI -e " windowid"
  23 Given the windowid of an XEmbed-aware application, Vimprobable will use that as its parent.
  24 .TP
  25 .BI -h
  26 Prints out a short usage summary.
  27 .TP
  28 .BI -v
  29 Prints the version of Vimprobable.
  30
  31 .SH DESCRIPTION
  32 Vimprobable is a WWW browser that is build around the webkit library. Vimprobable is fast.
  33 Vimprobable comes without buttons and other graphic widgets. It is aimed at being controlled
  34 as mouseless as possible. It uses keybindings that are inspired by vim, the great editor.
  35 .PP
  36 Just like vim, moving through the webpage can be done by entering commands by the keyboard.
  37 Most of these commands require just one or two keystrokes.
  38 .PP
  39 Vimprobable mimics the ex-commandmode of vim. By entering a colon (:) commands like open,
  40 set and map can be entered.
  41
  42 .SH QUICK START
  43
  44 Don't want to read this entire manpage? Here are a few basic steps:
  45
  46 .I "    " o
  47 Insert URL from keyboard and load it
  48
  49 .I "    " t
  50 Insert URL from keyboard and load it into new window
  51
  52 .I "    " j
  53 Scroll down
  54
  55 .I "    " k
  56 Scroll up
  57
  58 .I "    " d
  59 Close current window
  60
  61 .SH KEYBOARD BINDINGS
  62 The default keyboard bindings are explained in this sections. These keybindings
  63 can be changed.
  64
  65 .IP "Move through current page"
  66 Vimprobable recognizes the following motion commands:
  67 0, $, g, <shift>G, h, j, k, l, Ctrl-b, Ctrl-f, Ctrl-d, Ctrl-u, Ctrl-e, Ctrl-y
  68
  69 .IP "Move through pages"
  70 Ctrl-i, Ctrl-o, <shift>H, <shift>L
  71 .PP
  72 These commands are used to walk through the browse-history.
  73
  74 .IP "Reloading and cancel loading"
  75
  76 .I "    " r
  77 Reload
  78
  79 .I "    " <shift>R
  80 Force reload
  81
  82 .I "    " c
  83 Cancel load
  84
  85 .IP "Zoom in and out"
  86
  87 .I "    " zi
  88 Zoom text in
  89
  90 .I "    " zI
  91 Zoom full content in
  92
  93 .I "    " zo
  94 Zoom text out
  95
  96 .I "    " zo
  97 Zoom full content out
  98
  99 .I "    " zz
 100 Zoom reset
 101
 102 .I "    " zZ
 103 Zoom reset
 104
 105 .IP "URL commands"
 106
 107 .I "    " y
 108 Yank current URL into clipboard
 109
 110 .I "    " Y
 111 Yank current selection into clipboard
 112
 113 .I "    " gu
 114 Load URL one directory up
 115
 116 .I "    " gu
 117 Load rootdirectory of current URL
 118
 119 .I "    " gh
 120 Load homepage
 121
 122 .I "    " gH
 123 Load homepage into new window
 124
 125 .I "    " p
 126 Load URL from clipboard
 127
 128 .I "    " P
 129 Load URL from clipboard into new window
 130
 131 .I "    " o
 132 Insert URL from keyboard and load it
 133
 134 .I "    " t
 135 Insert URL from keyboard and load it into new window
 136
 137 .I "    " u
 138 Open a new window with the URL which has been closed last
 139
 140
 141 .IP Search
 142
 143 .I "    " /
 144 Start search
 145
 146 .I "    " ?
 147 Start backward search
 148
 149 .I "    " n
 150 Next search result
 151
 152
 153
 154 .SH COLON COMMANDS
 155
 156 The following commands are entered after first entering a colon (:)
 157
 158 .IP ":open "
 159
 160 Insert URL from keyboard and load it
 161
 162 Shortcut: o
 163
 164 .IP ":tabopen "
 165
 166 Insert URL from keyboard and load it into new window
 167
 168 Shortcut: t
 169
 170 .IP ":bma or :bookmark"
 171
 172 Bookmarks the current page.
 173
 174 Bookmarks are retrieved by tabcompletion when entering a new URL.
 175
 176 You can add tags to the bookmarks by just adding words after the command, e.g.
 177
 178 :bma tag1 tag2 tag3
 179
 180 .IP ":qt "
 181
 182 Open all bookmarks containing a certain tag in new windows.
 183
 184 .IP ":fo[rward] and :ba[ck]"
 185
 186 The commands :fo, :forward, :ba and :backward moves through the browse-history
 187
 188 .IP ":re[load], :re! and :reload!"
 189
 190 The commands :re, :reload, ;re! and :reload! are given to reload or
 191 force reload.
 192
 193 .IP ":st[op]"
 194
 195 Cancel current loading
 196
 197 .IP ":source"
 198
 199 Toggles between normal view and sourcecode view.
 200
 201
 202 .IP ":set"
 203
 204 Change default settings on the fly. See man vimprobablerc for the list of
 205 settings to be changed.
 206
 207 .IP ":map"
 208
 209 Change default keybindings on the fly. See man vimprobablerc for the list of
 210 mappings to be changed.
 211
 212 .IP ":quit"
 213
 214 Close current window
 215
 216 Shortcut: d
 217
 218 .IP ":print"
 219
 220 Print the current URL
 221
 222 .SH QUICKMARKS
 223
 224 Up to 9 quickmarks can be defined. These are stored as quickmark 1 up to
 225 quickmark 9.  You can store the URI of the current
 226 page as quickmark with
 227
 228 .I :set qmark=<hotkey>
 229
 230 Later you can recall the quickmark with
 231
 232 .I q<hotkey>
 233
 234 Example:
 235
 236 :set qmark=4
 237 Store current URI as quickmark 4
 238
 239 q4
 240 Recall quickmark 4
 241
 242 .SH FILES
 243
 244 Please make sure you create these files before running the browser.
 245 Everything but the history, bookmarks and closed files is optional. The cookies
 246 file is required if you want to use cookies.
 247
 248 .I $HOME/.config/vimprobable/vimprobablerc
 249
 250 .I $HOME/.config/vimprobable/bookmarks
 251
 252 .I $HOME/.config/vimprobable/cookies
 253
 254 .I $HOME/.config/vimprobable/history
 255
 256 .I $HOME/.config/vimprobable/closed
 257
 258 .I $HOME/.config/vimprobable/quickmarks
 259
 260 .I $HOME/.config/vimprobable/style.css
 261
 262
 263 .SH BUGS
 264 There has not been any significant bug-hunting yet.
 265 .SH AUTHORS
 266 Hannes Schueller and Matto Fransen
 267 .SH "SEE ALSO"
 268 .BR vimprobablerc (1),
 269
 270
 271