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