vimprobablerc.1

   1 .\" Process this file with
   2 .\" groff -man -Tascii vimprobablerc.1
   3 .\"
   4 .TH VIMPROBABLERC 1 "December 2009" "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 .SH FORMAT MODIFIED KEYS
  41
  42 It is possible to mapi keys modified with eiter Control or Shift.
  43 To map a key modified with Control, use this format: <C-h>
  44 where C stands for the Control-key and h for the h-key.
  45 or <S-k> where S stands for the Shift-key and k for the k-key.
  46
  47 Examples:
  48 <C-h> : Ctrl-h
  49 <C-k> : Ctrl-k
  50 z<S-i>: z followed by Shift-i
  51
  52 .RE
  53
  54 .SH SETTINGS
  55
  56 This section describes the possible options that can be changed from
  57 their default value.
  58
  59 .IP completioncase=[true|false]
  60 Case sensitive (true) or insensitive tab completion.
  61
  62 .IP homepage=URL
  63 Set the URL of the homepage.
  64
  65 .IP useragent=<useragent-string>
  66 Replace the default useragent-string.
  67
  68 .IP acceptlanguage=<acceptlanguage-string>
  69 Replace the default acceptlanguage-string.
  70
  71 .IP scripts=[true|false]
  72 Enable or disable scripts.
  73
  74 .IP plugins=[true|false]
  75 Enable or disable plugins.
  76
  77 .IP java=[true|false]
  78 Enable or disable Java applets.
  79
  80 .IP images=[true|false]
  81 Enable or disable autoload of images.
  82
  83 .IP shrinkimages=[true|false]
  84 Enable or disable autoshrink of images.
  85
  86 .IP cursivefont=cursivefont-family
  87 Replace the default cursive font family
  88
  89 .IP defaultencoding=encoding
  90 Replace the default encoding
  91
  92 .IP defaultfont=default-font-family
  93 Replace the default font family
  94
  95 .IP fontsize=integer
  96 Replace the default fontsize
  97
  98 .IP monofontsize=integer
  99 Replace the default monospace fontsize
 100
 101 .IP caret=[true|false]
 102 Enable or disable caret browsing
 103
 104 .IP fantasyfont=fantasy-font-family
 105 Replace the default fantasy font family
 106
 107 .IP minimumfontsize=integer
 108 Replace the default minimum font size
 109
 110 .IP monofont=default-monospace-font-family
 111 Replace the default monospace font family
 112
 113 .IP proxy=[true|false]
 114 Whether to read and use the http_proxy environment variable
 115
 116 .IP backgrounds=[true|false]
 117 Enable or disable print backgrounds
 118
 119 .IP sansfont=default-sans-font-family
 120 Replace the default sans-serif font family
 121
 122 .IP scrollbars=[true|false]
 123 Enable or disable scrollbars.
 124
 125 .IP seriffont=default-serif-font-family
 126 Replace the default serif font family
 127
 128 .IP stylesheet=URL
 129 Replace the user stylesheet
 130
 131 .IP webinspector=[true|false]
 132 Enable or disable webinspector
 133
 134 .SH MAPPINGS
 135
 136 Keys can be mapped to the following functions:
 137
 138 .IP quit
 139 Close the browser
 140
 141 .IP stop
 142 Stop the current loading process
 143
 144 .IP bookmark
 145 Save the current website in the bookmarks
 146
 147 .IP source
 148 Toggle HTML source view
 149
 150 .IP jumpleft
 151 Scroll to left edge
 152
 153 .IP jumpright
 154 Scroll to right edge
 155
 156 .IP jumptop
 157 Scroll to top of the page
 158
 159 .IP jumpbottom
 160 Scroll to bottom of the page
 161
 162 .IP pageup
 163 Scroll one screensize up
 164
 165 .IP pagedown
 166 Scroll one screensize down
 167
 168 .IP navigationback
 169 Go to previous page in browser-history
 170
 171 .IP navigationforward
 172 Go to next page in browser-history
 173
 174 .IP reload
 175 Reload current page
 176
 177 .IP scrollleft
 178 Scroll the page one step to the left
 179
 180 .IP scrollright
 181 Scroll the page one step to the right
 182
 183 .IP scrollup
 184 Scroll the page one step up
 185
 186 .IP scrolldown
 187 Scroll the page one step down
 188
 189 Example:
 190 To map the 'R' key to reload to current page, add the following
 191 line into ~/.config/vimprobable/vimprobablerc:
 192
 193 map <S-R> reload
 194
 195 .SH MAPPING COLON COMMANDS
 196
 197 Key can be mapped to any colon commands. Instead of entering an
 198 internal symbol for the key combination to be mapped to, enter
 199 a command line as you would enter it within a running browser
 200 instance. For example:
 201
 202 map <C-s>=:set scripts=false
 203
 204 This would map Control-s to disable Javascript.
 205
 206 .SH INTERACTIVE SETTING
 207 All settings can be changed on the fly by entering
 208 :set followed by one of the commands in the SETTINGS section
 209 above.
 210
 211 .SH BUGS
 212 There has not been any significant bug-hunting yet.
 213 .SH AUTHORS
 214 Hannes Schueller and Matto Fransen
 215 .SH "SEE ALSO"
 216 .BR vimprobable2 (1),