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 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 "    " gi
 178 Focus next input field
 179
 180
 181 .SH COLON COMMANDS
 182
 183 The following commands are entered after first entering a colon (:)
 184
 185 .IP ":open "
 186
 187 Insert URL from keyboard and load it
 188
 189 Shortcut: o
 190
 191 .IP ":tabopen "
 192
 193 Insert URL from keyboard and load it into new window
 194
 195 Shortcut: t
 196
 197 .IP ":bma or :bookmark"
 198
 199 Bookmarks the current page.
 200
 201 Bookmarks are retrieved by tabcompletion when entering a new URL.
 202
 203 You can add tags to the bookmarks by just adding words after the command, e.g.
 204
 205 :bma tag1 tag2 tag3
 206
 207 .IP ":qt "
 208
 209 Open all bookmarks containing a certain tag in new windows.
 210
 211 .IP ":fo[rward] and :ba[ck]"
 212
 213 The commands :fo, :forward, :ba and :backward move through the browse-history
 214
 215 .IP ":re[load], :re! and :reload!"
 216
 217 The commands :re, :reload, ;re! and :reload! are given to reload or
 218 force reload.
 219
 220 .IP ":st[op]"
 221
 222 Cancel current loading
 223
 224 .IP ":source"
 225
 226 Toggles between normal view and sourcecode view.
 227
 228
 229 .IP ":set"
 230
 231 Change default settings on the fly. See
 232 .I man vimprobablerc
 233 for the list of settings to be changed.
 234
 235 .IP ":map"
 236
 237 Change default keybindings on the fly. See
 238 .I man vimprobablerc
 239 for the list of mappings to be changed.
 240
 241 .IP ":quit"
 242
 243 Close current window
 244
 245 Shortcut: d
 246
 247 .IP ":print"
 248
 249 Print the current URL
 250
 251 .SH MODES
 252
 253 Vimprobable is a modal browser. By default, it is in command mode, meaning that
 254 any keystroke will be interpreted by the internal command engine. INSERT mode
 255 is automatically activated if an input field on a website becomes focused.
 256 Should this not work (due to limitations of the Webkit-GTK engine and the faulty
 257 HTML code of some websites, this is possible), you can manually switch the
 258 browser to PASSTHROUGH mode instead (Ctrl+Z). In INSERT and PASSTHROUGH modes,
 259 keystrokes will not be interpreted by the browser, but passed to the underlying
 260 engine/website.
 261
 262 In addition, there is HINT mode. This is activated with the "f" key by default.
 263 Enter a the number of a link to follow it. Alternatively, you can enter the
 264 link text (case sensitive) to narrow down your choices.
 265
 266 .SH QUICKMARKS
 267
 268 Up to 9 quickmarks can be defined. These are stored as quickmark 1 up to
 269 quickmark 9.  You can store the URI of the current
 270 page as quickmark with
 271
 272 .I :set qmark=<hotkey>
 273
 274 Later you can recall the quickmark with
 275
 276 .I q<hotkey>
 277
 278 Example:
 279
 280 :set qmark=4
 281 Store current URI as quickmark 4
 282
 283 q4
 284 Recall quickmark 4
 285
 286 .SH SEARCHENGINES
 287
 288 Searchengines let you submit queries to web search engines and similar sites
 289 without having to type the complete URL or visit the page first.
 290
 291 For example, if
 292 .I ex
 293 is defined as the shortcut for the search at example.com, you can use "ex
 294 search term" instead of an URL to search there for "search term".
 295
 296 The following search engines (and shortcuts) are already defined in config.h:
 297
 298 .IP i
 299 http://ixquick.com/do/metasearch.pl?query=%s
 300 .IP s
 301 https://ssl.scroogle.org/cgi-bin/nbbwssl.cgi?Gw=%s
 302 .IP w
 303 https://secure.wikimedia.org/wikipedia/en/w/index.php?title=Special%%3ASearch&search=%s&go=Go
 304 .IP wd
 305 https://secure.wikimedia.org/wikipedia/de/w/index.php?title=Special%%3ASearch&search=%s&go=Go
 306
 307 .P
 308
 309 You can always overwrite them or define your own in
 310 .I $HOME/.config/vimprobable/searchengines.
 311 In this file, every line defines one shortcut for one URL in the following
 312 format (without the angle brackets):
 313
 314 .RS 4
 315 <shortcut> <URL with exactly one %s>
 316 .RE
 317
 318 where the %s serves as a placeholder for the search term. Other percent signs
 319 in the URL have to be escaped as %%\&.
 320
 321 .B Default search engine
 322
 323 If Vimprobable doesn't recognize an address as a valid URL or query to one of the
 324 defined search engines, it will use the default search engine instead. See
 325 .BR vimprobablerc (1)
 326 on how to set this default.
 327
 328 .SH FILES
 329
 330 Please make sure you create these files before first running the browser.
 331 Everything but the history, bookmarks and closed files is optional. The cookies
 332 file is required if you want to use cookies.
 333
 334 .I $HOME/.config/vimprobable/vimprobablerc
 335
 336 .I $HOME/.config/vimprobable/bookmarks
 337
 338 .I $HOME/.config/vimprobable/searchengines
 339
 340 .I $HOME/.config/vimprobable/cookies
 341
 342 .I $HOME/.config/vimprobable/history
 343
 344 .I $HOME/.config/vimprobable/closed
 345
 346 .I $HOME/.config/vimprobable/quickmarks
 347
 348 .I $HOME/.config/vimprobable/style.css
 349
 350
 351 .SH BUGS
 352 There has not been any significant bug-hunting yet.
 353 .SH AUTHORS
 354 Hannes Schueller and Matto Fransen
 355 .SH "SEE ALSO"
 356 .BR vimprobablerc (5),
 357
 358
 359
 360
 361