vimprobable2.1

   1 .\" Process this file with
   2 .\" groff -man -Tascii vimprobable2.1
   3 .\"
   4 .TH VIMPROBABLE2 1 "FEBRUARY 2012" "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 mouselessly as possible. It uses keybindings that are inspired by Vim, the great editor.
  35 .PP
  36 Just like Vim, moving through a 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 section. These keybindings
  63 can be changed - either at runtime by altering
  64 .I vimprobablerc
  65 or editing
  66 .I keymap.h
  67 in the source directory (in which case you will need to recompile to see changes take effect).
  68
  69 .IP "Move through current page"
  70 Vimprobable recognizes the following motion commands:
  71 0, $, g, <shift>G, h, j, k, l, Ctrl-b, Ctrl-f, Ctrl-d, Ctrl-u, Ctrl-e, Ctrl-y
  72
  73 .IP "Move through pages"
  74 Ctrl-i, Ctrl-o, <shift>H, <shift>L
  75 .PP
  76 These commands are used to walk through the browse-history.
  77
  78 .IP "Reloading and cancel loading"
  79
  80 .I "    " r
  81 Reload
  82
  83 .I "    " <shift>R
  84 Force reload
  85
  86 .I "    " c
  87 Cancel load
  88
  89 .IP "Zoom in and out"
  90
  91 .I "    " zi
  92 Zoom text in
  93
  94 .I "    " zI
  95 Zoom full content in
  96
  97 .I "    " zo
  98 Zoom text out
  99
 100 .I "    " zO
 101 Zoom full content out
 102
 103 .I "    " zz
 104 Zoom reset
 105
 106 .I "    " zZ
 107 Zoom reset
 108
 109 .IP "URL commands"
 110
 111 .I "    " y
 112 Yank current URL into clipboard
 113
 114 .I "    " Y
 115 Yank current selection into clipboard
 116
 117 .I "    " gu
 118 Load URL one directory up
 119
 120 .I "    " gu
 121 Load rootdirectory of current URL
 122
 123 .I "    " gh
 124 Load homepage
 125
 126 .I "    " gH
 127 Load homepage into new window
 128
 129 .I "    " p
 130 Load URL from clipboard
 131
 132 .I "    " P
 133 Load URL from clipboard into new window
 134
 135 .I "    " o
 136 Insert URL from keyboard and load it
 137
 138 .I "    " t
 139 Insert URL from keyboard and load it into new window
 140
 141 .I "    " u
 142 Open a new window with the URL which was closed last
 143
 144
 145 .IP Search
 146
 147 .I "    " /
 148 Start search
 149
 150 .I "    " ?
 151 Start backward search
 152
 153 .I "    " n
 154 Next search result
 155
 156
 157 .IP Hinting
 158
 159 .I "    " f (or ;o)
 160 Follow link
 161
 162 .I "    " F (or ;t or ;w)
 163 Follow link in new window
 164
 165 .I "    " ;s
 166 Save the specified link (or element) to disk
 167
 168 .I "    " ;y
 169 Yank the destination's location
 170
 171 .I "    " ;O
 172 Generate an :open command with the link's URL (like O)
 173
 174 .I "    " ;T or ;W
 175 Generate an :tabopen command with the link's URL (like T)
 176
 177 .I "    " ;s
 178 Open image in current window
 179
 180 .I "    " ;S
 181 Open image in new window
 182
 183 .I "    " gi
 184 Focus next input field
 185
 186
 187 .SH COLON COMMANDS
 188
 189 The following commands are entered after first entering a colon (:)
 190
 191 .IP ":open "
 192
 193 Insert URL from keyboard and load it
 194
 195 Shortcut: o
 196
 197 .IP ":tabopen "
 198
 199 Insert URL from keyboard and load it into new window
 200
 201 Shortcut: t
 202
 203 .IP ":bma or :bookmark"
 204
 205 Bookmarks the current page.
 206
 207 Bookmarks are retrieved by tabcompletion when entering a new URL.
 208
 209 You can add tags to the bookmarks by just adding words after the command, e.g.
 210
 211 :bma tag1 tag2 tag3
 212
 213 .IP ":qt "
 214
 215 Open all bookmarks containing a certain tag in new windows.
 216
 217 .IP ":fo[rward] and :ba[ck]"
 218
 219 The commands :fo, :forward, :ba and :backward move through the browse-history
 220
 221 .IP ":re[load], :re! and :reload!"
 222
 223 The commands :re, :reload, ;re! and :reload! are given to reload or
 224 force reload.
 225
 226 .IP ":st[op]"
 227
 228 Cancel current loading
 229
 230 .IP ":source"
 231
 232 Toggles between normal view and sourcecode view.
 233
 234
 235 .IP ":set"
 236
 237 Change default settings on the fly. See
 238 .I man vimprobablerc
 239 for the list of settings to be changed.
 240
 241 .IP ":map"
 242
 243 Change default keybindings on the fly. See
 244 .I man vimprobablerc
 245 for the list of mappings to be changed.
 246
 247 .IP ":quit"
 248
 249 Close current window
 250
 251 Shortcut: d
 252
 253 .IP ":print"
 254
 255 Print the current URL
 256
 257 .SH MODES
 258
 259 Vimprobable is a modal browser. By default, it is in command mode, meaning that
 260 any keystroke will be interpreted by the internal command engine. INSERT mode
 261 is automatically activated if an input field on a website becomes focused.
 262 Should this not work (due to limitations of the Webkit-GTK engine and the faulty
 263 HTML code of some websites, this is possible), you can manually switch the
 264 browser to PASSTHROUGH mode instead (Ctrl+Z). In INSERT and PASSTHROUGH modes,
 265 keystrokes will not be interpreted by the browser, but passed to the underlying
 266 engine/website.
 267
 268 In addition, there is HINT mode. This is activated with the "f" key by default.
 269 Enter a the number of a link to follow it. Alternatively, you can enter the
 270 link text (case sensitive) to narrow down your choices.
 271
 272 .SH QUICKMARKS
 273
 274 Up to 9 quickmarks can be defined. These are stored as quickmark 1 up to
 275 quickmark 9.  You can store the URI of the current
 276 page as quickmark with
 277
 278 .I :set qmark=<hotkey>
 279
 280 Later you can recall the quickmark with
 281
 282 .I q<hotkey>
 283
 284 Example:
 285
 286 :set qmark=4
 287 Store current URI as quickmark 4
 288
 289 q4
 290 Recall quickmark 4
 291
 292 .SH SEARCHENGINES
 293
 294 Searchengines let you submit queries to web search engines and similar sites
 295 without having to type the complete URL or visit the page first.
 296
 297 For example, if
 298 .I ex
 299 is defined as the shortcut for the search at example.com, you can use "ex
 300 search term" instead of an URL to search there for "search term".
 301
 302 The following search engines (and shortcuts) are already defined in config.h:
 303
 304 .IP i
 305 http://ixquick.com/do/metasearch.pl?query=%s
 306 .IP w
 307 https://secure.wikimedia.org/wikipedia/en/w/index.php?title=Special%%3ASearch&search=%s&go=Go
 308 .IP wd
 309 https://secure.wikimedia.org/wikipedia/de/w/index.php?title=Special%%3ASearch&search=%s&go=Go
 310 .IP d
 311 https://duckduckgo.com/?q=%s&t=Vimprobable
 312 .IP dd
 313 https://duckduckgo.com/html/?q=%s&t=Vimprobable
 314
 315 .P
 316
 317 You can always overwrite them or define your own in
 318 .I $HOME/.config/vimprobable/vimprobablerc.
 319 See vimprobablerc (5) for details.
 320 .B Default search engine
 321
 322 If Vimprobable doesn't recognize an address as a valid URL or query to one of the
 323 defined search engines, it will use the default search engine instead. See
 324 .BR vimprobablerc (5)
 325 on how to set this default.
 326
 327 .SH URI HANDLERS
 328
 329 You can define external applications to handle requests for defined URI schemas.
 330
 331 The following URI handlers are already defined in config.h:
 332
 333 .IP ftp://
 334 x-terminal-emulator -e wget %s
 335 .IP mailto:
 336 x-terminal-emulator -e mutt %s
 337
 338 .P
 339
 340 See
 341 .BR vimprobablerc (5)
 342 for details how to add or override these settings.
 343
 344 You can always overwrite them or define your own in
 345 .I $HOME/.config/vimprobable/vimprobablerc.
 346
 347 .SH FILES
 348
 349 Please make sure you create these files before first running the browser.
 350 Everything but the history, bookmarks and closed files is optional. The cookies
 351 file is required if you want to use cookies.
 352
 353 .I $HOME/.config/vimprobable/vimprobablerc
 354
 355 .I $HOME/.config/vimprobable/bookmarks
 356
 357 .I $HOME/.config/vimprobable/cookies
 358
 359 .I $HOME/.config/vimprobable/history
 360
 361 .I $HOME/.config/vimprobable/closed
 362
 363 .I $HOME/.config/vimprobable/quickmarks
 364
 365 .I $HOME/.config/vimprobable/style.css
 366
 367
 368 .SH BUGS
 369 There has not been any significant bug-hunting yet.
 370 .SH AUTHORS
 371 Hannes Schueller and Matto Fransen
 372 .SH "SEE ALSO"
 373 .BR vimprobablerc (5),
 374
 375
 376
 377
 378