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