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 scripts=[true|false]
  69 Enable or disable scripts.
  70
  71 .IP plugins=[true|false]
  72 Enable or disable plugins.
  73
  74 .IP java=[true|false]
  75 Enable or disable Java applets.
  76
  77 .IP images=[true|false]
  78 Enable or disable autoload of images.
  79
  80 .IP shrinkimages=[true|false]
  81 Enable or disable autoshrink of images.
  82
  83 .IP cursivefont=cursivefont-family
  84 Replace the default cursive font family
  85
  86 .IP defaultencoding=encoding
  87 Replace the default encoding
  88
  89 .IP defaultfont=default-font-family
  90 Replace the default font family
  91
  92 .IP fontsize=integer
  93 Replace the default fontsize
  94
  95 .IP monofontsize=integer
  96 Replace the default monospace fontsize
  97
  98 .IP caret=[true|false]
  99 Enable or disable caret browsing
 100
 101 .IP fantasyfont=fantasy-font-family
 102 Replace the default fantasy font family
 103
 104 .IP minimumfontsize=integer
 105 Replace the default minimum font size
 106
 107 .IP monofont=default-monospace-font-family
 108 Replace the default monospace font family
 109
 110 .IP proxy=[true|false]
 111 Whether to read and use the http_proxy environment variable
 112
 113 .IP backgrounds=[true|false]
 114 Enable or disable print backgrounds
 115
 116 .IP sansfont=default-sans-font-family
 117 Replace the default sans-serif font family
 118
 119 .IP scrollbars=[true|false]
 120 Enable or disable scrollbars.
 121
 122 .IP seriffont=default-serif-font-family
 123 Replace the default serif font family
 124
 125 .IP stylesheet=URL
 126 Replace the user stylesheet
 127
 128 .IP webinspector=[true|false]
 129 Enable or disable webinspector
 130
 131 .SH MAPPINGS
 132
 133 Keys can be mapped to the following functions:
 134
 135 .IP quit
 136 Close the browser
 137
 138 .IP stop
 139 Stop the current loading process
 140
 141 .IP bookmark
 142 Save the current website in the bookmarks
 143
 144 .IP source
 145 Toggle HTML source view
 146
 147 .IP jumpleft
 148 Scroll to left edge
 149
 150 .IP jumpright
 151 Scroll to right edge
 152
 153 .IP jumptop
 154 Scroll to top of the page
 155
 156 .IP jumpbottom
 157 Scroll to bottom of the page
 158
 159 .IP pageup
 160 Scroll one screensize up
 161
 162 .IP pagedown
 163 Scroll one screensize down
 164
 165 .IP navigationback
 166 Go to previous page in browser-history
 167
 168 .IP navigationforward
 169 Go to next page in browser-history
 170
 171 .IP reload
 172 Reload current page
 173
 174 .IP scrollleft
 175 Scroll the page one step to the left
 176
 177 .IP scrollright
 178 Scroll the page one step to the right
 179
 180 .IP scrollup
 181 Scroll the page one step up
 182
 183 .IP scrolldown
 184 Scroll the page one step down
 185
 186 Example:
 187 To map the 'R' key to reload to current page, add the following
 188 line into ~/.config/vimprobable/vimprobablerc:
 189
 190 map <S-R> reload
 191
 192 .SH INTERACTIVE SETTING
 193 All settings can be changed on the fly by entering
 194 :set followed by one of the commands in the SETTINGS section
 195 above.
 196
 197 .SH BUGS
 198 There has not been any significant bug-hunting yet.
 199 .SH AUTHORS
 200 Hannes Schueller and Matto Fransen
 201 .SH "SEE ALSO"
 202 .BR vimprobable (1),
 203
 204
 205