vimprobable2.1

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