vimprobablerc.5

   1 .\" Process this file with
   2 .\" groff -man -Tascii vimprobablerc.5
   3 .\"
   4 .TH VIMPROBABLERC 5 "FEBRUARY 2012" "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 homepage=URL
  70 Set the URL of the homepage.
  71
  72 .IP useragent=<useragent-string>
  73 Replace the default useragent-string.
  74
  75 .IP acceptlanguage=<acceptlanguage-string>
  76 Replace the default acceptlanguage-string.
  77
  78 .IP scripts=[true|false]
  79 Enable or disable scripts.
  80
  81 .IP plugins=[true|false]
  82 Enable or disable plugins.
  83
  84 .IP java=[true|false]
  85 Enable or disable Java applets.
  86
  87 .IP images=[true|false]
  88 Enable or disable autoload of images.
  89
  90 .IP shrinkimages=[true|false]
  91 Enable or disable autoshrink of images.
  92
  93 .IP cursivefont=cursivefont-family
  94 Replace the default cursive font family
  95
  96 .IP defaultencoding=encoding
  97 Replace the default encoding
  98
  99 .IP defaultfont=default-font-family
 100 Replace the default font family
 101
 102 .IP defaultsearch=searchengine-shortcut
 103 Replace the default search engine
 104
 105 .IP escapeinput=[true|false]
 106 Ignore automatic focusing of input elements by websites on load.
 107
 108 .IP fontsize=integer
 109 Replace the default fontsize
 110
 111 .IP monofontsize=integer
 112 Replace the default monospace fontsize
 113
 114 .IP caret=[true|false]
 115 Enable or disable caret browsing
 116
 117 .IP fantasyfont=fantasy-font-family
 118 Replace the default fantasy font family
 119
 120 .IP minimumfontsize=integer
 121 Replace the default minimum font size
 122
 123 .IP monofont=default-monospace-font-family
 124 Replace the default monospace font family
 125
 126 .IP pagecache=[true|false]
 127 Enable or disable webkit's internal page cache
 128
 129 .IP proxy=[true|false]
 130 Whether to read and use the http_proxy environment variable
 131
 132 .IP backgrounds=[true|false]
 133 Enable or disable print backgrounds
 134
 135 .IP sansfont=default-sans-font-family
 136 Replace the default sans-serif font family
 137
 138 .IP scrollbars=[true|false]
 139 Enable or disable scrollbars.
 140
 141 .IP statusbar=[true|false]
 142 Show or hide the status bar.
 143
 144 .IP inputbox=[true|false]
 145 Show or hide the input box.
 146
 147 .IP seriffont=default-serif-font-family
 148 Replace the default serif font family
 149
 150 .IP stylesheet=URL
 151 Replace the user stylesheet
 152
 153 .IP webinspector=[true|false]
 154 Enable or disable webinspector
 155
 156 .IP strictssl=[true|false]
 157 Reject or accept unverified certificates (default: true)
 158
 159 .IP cabundle=/path/to/file
 160 Where CA certificates are stored (default: /etc/ssl/certs/ca-certificates.crt)
 161
 162 .IP tempdir=/path/without/slash
 163 A path to a directory for temporary files (default: $TMPDIR or /tmp)
 164
 165 .SH MAPPINGS
 166
 167 Keys can be mapped to the following functions:
 168
 169 .IP quit
 170 Close the browser
 171
 172 .IP stop
 173 Stop the current loading process
 174
 175 .IP bookmark
 176 Save the current website in the bookmarks
 177
 178 .IP source
 179 Toggle HTML source view
 180
 181 .IP inspect
 182 Opens the webinspector if the webinspector is enabled
 183
 184 .IP jumpleft
 185 Scroll to left edge
 186
 187 .IP jumpright
 188 Scroll to right edge
 189
 190 .IP jumptop
 191 Scroll to top of the page
 192
 193 .IP jumpbottom
 194 Scroll to bottom of the page
 195
 196 .IP pageup
 197 Scroll one screensize up
 198
 199 .IP pagedown
 200 Scroll one screensize down
 201
 202 .IP navigationback
 203 Go to previous page in browser-history
 204
 205 .IP navigationforward
 206 Go to next page in browser-history
 207
 208 .IP reload
 209 Reload current page
 210
 211 .IP scrollleft
 212 Scroll the page one step to the left
 213
 214 .IP scrollright
 215 Scroll the page one step to the right
 216
 217 .IP scrollup
 218 Scroll the page one step up
 219
 220 .IP scrolldown
 221 Scroll the page one step down
 222
 223 .IP openeditor
 224 When in a text box, open the external editor
 225
 226 Example:
 227 To map the 'R' key to reload to current page, add the following
 228 line into ~/.config/vimprobable/vimprobablerc:
 229
 230 map R reload
 231
 232 .SH MAPPING KEYS TO COLON COMMANDS
 233
 234 Key can be mapped to any colon commands. Instead of entering an
 235 internal symbol for the key combination to be mapped to, enter
 236 a command line as you would enter it within a running browser
 237 instance. For example:
 238
 239 map <C-s>=:set scripts=false
 240
 241 This would map Control-s to disable Javascript.
 242
 243 map i=:javascript console.log('insertmode_on')
 244
 245 This maps the i key to manually activate INSERT mode.
 246
 247 .SH MAPPING COMMANDS TO EXISTING COMMANDS
 248
 249 You can create new commands by mapping them to an already
 250 working command line. For example:
 251
 252 map :bmatag1=:bookmark tag1
 253
 254 would create a new command "bmatag1" which would bookmark
 255 the current page and automatically add "tag1" to it.
 256
 257 .SH INTERACTIVE SETTING
 258 All settings can be changed on the fly by entering
 259 :set followed by one of the commands in the SETTINGS section
 260 above.
 261
 262 .SH SEARCH ENGINES
 263
 264 You can define new search engine shortcuts or override the pre-defined ones
 265 using the following format (without the angle brackets):
 266
 267 .RS 4
 268 searchengine <shortcut> <URL with exactly one %s>
 269 .RE
 270
 271 where the %s serves as a placeholder for the search term. Other percent signs
 272 in the URL have to be escaped as %%\&.
 273
 274 .SH URI HANDLERS
 275
 276 You can define external applications to handle requests for defined URI schemas
 277 using the following syntax (without the angle brackets):
 278
 279 .RS 4
 280 handler <URI schema> <handler command with exactly one %s>
 281 .RE
 282
 283 where the %s serves as a placeholder for the rest of the URI.
 284
 285 .SH BUGS
 286 There has not been any significant bug-hunting yet.
 287 .SH AUTHORS
 288 Hannes Schueller and Matto Fransen
 289 .SH "SEE ALSO"
 290 .BR vimprobable2 (1),