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