vimprobablerc.5

   1 .\" Process this file with
   2 .\" groff -man -Tascii vimprobablerc.5
   3 .\"
   4 .TH VIMPROBABLERC 5 "DECEMBER 2014" "Linux User Manuals"
   5 .SH NAME
   6 vimprobablerc \- The configuration file for Vimprobable
   7 .SH DESCRIPTION
   8 If you have a .config/vimprobable/vimprobablerc in your home directory, Vimprobable
   9 will read it at startup.
  10 .PP
  11 The vimprobablerc file consists of a series of configuration options, one per line. Blank lines and lines starting with a
  12 colon (:) are seen as comments and will be ignored.
  13 .SH FILES
  14 .I $HOME/.config/vimprobable/vimprobablerc
  15 .PP
  16 Per user configuration file.
  17 .SH FORMAT
  18 .IP set
  19 .RS
  20 set is used to alter a default setting. For possible options that can be altered,
  21 see the SETTINGS section below.
  22
  23 Each line looks like this:
  24
  25 .I "    " set what=value
  26
  27 Vimprobable is not picky about white space in these lines.
  28 .RE
  29 .IP map
  30 .RS
  31 map is used to change the default key-binding. For possible options that
  32 can be altered see the MAPPING section below.
  33
  34 Each line looks like this:
  35
  36 .I "    " map what=value
  37
  38 Vimprobable is not picky about white space in these lines.
  39
  40 .RE
  41 .IP misc
  42 .RS
  43 Any command listed under colon commands in vimprobable2(1) will be accepted in the config file as well.
  44
  45
  46 .SH FORMAT MODIFIED KEYS
  47
  48 It is possible to map keys modified with eiter Control or Modkeys.
  49 To map a key modified with Control, use this format: <C-h>
  50 where C stands for the Control-key and h for the h-key.
  51 <M1-j> maps the combination of Mod1 and the j-key. Mod1 is
  52 usually the "Alt" key, Mod4 the "Windows" key.
  53
  54 Examples:
  55 <C-h> : Ctrl-h
  56 <C-k> : Ctrl-k
  57 z<M1-i>: z followed by Alt-i
  58
  59 .RE
  60
  61 .SH SETTINGS
  62
  63 This section describes the possible options that can be changed from
  64 their default value.
  65
  66 .IP completioncase=[true|false]
  67 Case sensitive (true) or insensitive tab completion.
  68
  69 .IP cookies=[true|false|no_third]
  70 Cookie policy: accept all cookies, no cookies or all but third party
  71 cookies (default).
  72
  73 .IP localstorage=[true|false]
  74 Enable or disable HTML5 local storage (default: false)
  75
  76 .IP html5db=[true|false]
  77 Enable or disable HTML5 database (default: false)
  78
  79 .IP homepage=URL
  80 Set the URL of the homepage.
  81
  82 .IP useragent=<useragent-string>
  83 Replace the default useragent-string.
  84
  85 .IP acceptlanguage=<acceptlanguage-string>
  86 Replace the default acceptlanguage-string.
  87
  88 .IP scripts=[true|false]
  89 Enable or disable scripts.
  90
  91 .IP plugins=[true|false]
  92 Enable or disable plugins.
  93
  94 .IP popups=[true|false]
  95 FALSE enables Webkit's internal popup blocker. Note: this may interfere
  96 with the hint following feature's ability to open links in a new
  97 window.
  98
  99 .IP private=[true|false]
 100 Enable or disable private mode. In private mode, no cookies and no
 101 browsing history will be written.
 102
 103 .IP java=[true|false]
 104 Enable or disable Java applets.
 105
 106 .IP images=[true|false]
 107 Enable or disable autoload of images.
 108
 109 .IP shrinkimages=[true|false]
 110 Enable or disable autoshrink of images.
 111
 112 .IP completionfontnormal=font
 113 Font used in the tab completion list.
 114
 115 .IP completionfonterror=font
 116 Font used in the tab completion list for errors.
 117
 118 .IP cursivefont=cursivefont-family
 119 Replace the default cursive font family
 120
 121 .IP defaultencoding=encoding
 122 Replace the default encoding
 123
 124 .IP defaultfont=default-font-family
 125 Replace the default font family
 126
 127 .IP defaultsearch=searchengine-shortcut
 128 Replace the default search engine
 129
 130 .IP downloadspath=/path/to/downloaded/files
 131 Absolute path on the local file system to download files to (default: $HOME)
 132
 133 .IP escapeinput=[true|false]
 134 Ignore automatic focusing of input elements by websites on load.
 135
 136 .IP fontsize=integer
 137 Replace the default fontsize
 138
 139 .IP monofontsize=integer
 140 Replace the default monospace fontsize
 141
 142 .IP caret=[true|false]
 143 Enable or disable caret browsing
 144
 145 .IP fantasyfont=fantasy-font-family
 146 Replace the default fantasy font family
 147
 148 .IP minimumfontsize=integer
 149 Replace the default minimum font size
 150
 151 .IP monofont=default-monospace-font-family
 152 Replace the default monospace font family
 153
 154 .IP pagecache=[true|false]
 155 Enable or disable webkit's internal page cache
 156
 157 .IP proxy=[true|false]
 158 Whether to read and use the http_proxy environment variable
 159
 160 .IP backgrounds=[true|false]
 161 Enable or disable print backgrounds
 162
 163 .IP sansfont=default-sans-font-family
 164 Replace the default sans-serif font family
 165
 166 .IP scrollbars=[true|false]
 167 Enable or disable scrollbars.
 168
 169 .IP statusbar=[true|false]
 170 Show or hide the status bar.
 171
 172 .IP statusfont=font
 173 Dont used in the status bar.
 174
 175 .IP inputbox=[true|false]
 176 Show or hide the input box.
 177
 178 .IP seriffont=default-serif-font-family
 179 Replace the default serif font family
 180
 181 .IP stylesheet=URL
 182 Replace the user stylesheet
 183
 184 .IP urlboxfontnormal=font
 185 Font used in the URL box.
 186
 187 .IP urlboxfontwarning=font
 188 Font used in the URL box for warnings.
 189
 190 .IP urlboxfonterror=font
 191 Font used in the URL box for errors.
 192
 193 .IP webinspector=[true|false]
 194 Enable or disable webinspector
 195
 196 .IP strictssl=[true|false]
 197 Reject or accept unverified certificates (default: true)
 198
 199 .IP cabundle=/path/to/file
 200 Where CA certificates are stored (default: /etc/ssl/certs/ca-certificates.crt)
 201
 202 .IP tempdir=/path/without/slash
 203 A path to a directory for temporary files (default: $TMPDIR or /tmp)
 204
 205 .SH MAPPINGS
 206
 207 Keys can be mapped to the following functions:
 208
 209 .IP quit
 210 Close the browser
 211
 212 .IP stop
 213 Stop the current loading process
 214
 215 .IP bookmark
 216 Save the current website in the bookmarks
 217
 218 .IP source
 219 Toggle HTML source view
 220
 221 .IP esource
 222 View/edit HTML source in an external editor
 223
 224 .IP inspect
 225 Opens the webinspector if the webinspector is enabled
 226
 227 .IP jumpleft
 228 Scroll to left edge
 229
 230 .IP jumpright
 231 Scroll to right edge
 232
 233 .IP jumptop
 234 Scroll to top of the page
 235
 236 .IP jumpbottom
 237 Scroll to bottom of the page
 238
 239 .IP pageup
 240 Scroll one screensize up
 241
 242 .IP pagedown
 243 Scroll one screensize down
 244
 245 .IP navigationback
 246 Go to previous page in browser-history
 247
 248 .IP navigationforward
 249 Go to next page in browser-history
 250
 251 .IP reload
 252 Reload current page
 253
 254 .IP scrollleft
 255 Scroll the page one step to the left
 256
 257 .IP scrollright
 258 Scroll the page one step to the right
 259
 260 .IP scrollup
 261 Scroll the page one step up
 262
 263 .IP scrolldown
 264 Scroll the page one step down
 265
 266 .IP openeditor
 267 When in a text box, open the external editor
 268
 269 Example:
 270 To map the 'R' key to reload to current page, add the following
 271 line into ~/.config/vimprobable/vimprobablerc:
 272
 273 map R reload
 274
 275 .SH MAPPING KEYS TO COLON COMMANDS
 276
 277 Key can be mapped to any colon commands. Instead of entering an
 278 internal symbol for the key combination to be mapped to, enter
 279 a command line as you would enter it within a running browser
 280 instance. For example:
 281
 282 map <C-s>=:set scripts=false
 283
 284 This would map Control-s to disable Javascript.
 285
 286 map i=:javascript console.log('insertmode_on')
 287
 288 This maps the i key to manually activate INSERT mode.
 289
 290 .SH MAPPING COMMANDS TO EXISTING COMMANDS
 291
 292 You can create new commands by mapping them to an already
 293 working command line. For example:
 294
 295 map :bmatag1=:bookmark tag1
 296
 297 would create a new command "bmatag1" which would bookmark
 298 the current page and automatically add "tag1" to it.
 299
 300 .SH INTERACTIVE SETTING
 301 All settings can be changed on the fly by entering
 302 :set followed by one of the commands in the SETTINGS section
 303 above.
 304
 305 .SH SHORTCUTS (SEARCH ENGINES)
 306
 307 You can define new shortcuts or override the pre-defined ones
 308 using the following format (without the angle brackets):
 309
 310 .RS 4
 311 shortcut <shortcut> <URL with at most one %s>
 312 .RE
 313
 314 where the %s serves as a placeholder for the term to be inserted into the URL.
 315 Other percent signs in the URL have to be escaped as %%\&. Using the shortcut
 316 feature without %s will simply work as shorthand to much-used bookmarks.
 317
 318 .SH URI HANDLERS
 319
 320 You can define external applications to handle requests for defined URI schemas
 321 using the following syntax (without the angle brackets):
 322
 323 .RS 4
 324 handler <URI schema> <handler command with exactly one %s>
 325 .RE
 326
 327 where the %s serves as a placeholder for the rest of the URI.
 328
 329 .SH BUGS
 330 There has not been any significant bug-hunting yet.
 331 .SH AUTHORS
 332 Hannes Schueller and Matto Fransen
 333 .SH "SEE ALSO"
 334 .BR vimprobable2 (1),