VIMPROBABLERC(5)

NAME
vimprobablerc - The configuration file for Vimprobable

DESCRIPTION
If you have a .config/vimprobable/vimprobablerc in your home directory, Vimprobable will read it at startup.

The vimprobablerc file consists of a series of configuration options, one per line. Blank lines and lines starting with a colon (:) are seen as comments and will be ignored.

FILES
$HOME/.config/vimprobable/vimprobablerc

Per user configuration file.

FORMAT

set
    set is used to alter a default setting. For possible options that can be altered, see the SETTINGS section below. Each line looks like this: set what=value Vimprobable is not picky about white space in these lines.

map
    map is used to change the default key-binding. For possible options that can be altered see the MAPPING section below. Each line looks like this: map what=value Vimprobable is not picky about white space in these lines.

misc
    Any command listed under colon commands in vimprobable2(1) will be accepted in the config file as well.

FORMAT MODIFIED KEYS
It is possible to map keys modified with eiter Control or Modkeys. To map a key modified with Control, use this format: <C-h> where C stands for the Control-key and h for the h-key. <M1-j> maps the combination of Mod1 and the j-key. Mod1 is usually the "Alt" key, Mod4 the "Windows" key. Examples: <C-h> : Ctrl-h <C-k> : Ctrl-k z<M1-i>: z followed by Alt-i

SETTINGS
This section describes the possible options that can be changed from their default value.

completioncase=[true|false]
    Case sensitive (true) or insensitive tab completion.

homepage=URL
    Set the URL of the homepage.

useragent=<useragent-string>
    Replace the default useragent-string.

acceptlanguage=<acceptlanguage-string>
    Replace the default acceptlanguage-string.

scripts=[true|false]
    Enable or disable scripts.

plugins=[true|false]
    Enable or disable plugins.

java=[true|false]
    Enable or disable Java applets.

images=[true|false]
    Enable or disable autoload of images.

shrinkimages=[true|false]
    Enable or disable autoshrink of images.

cursivefont=cursivefont-family
    Replace the default cursive font family

defaultencoding=encoding
    Replace the default encoding

defaultfont=default-font-family
    Replace the default font family

defaultsearch=searchengine-shortcut
    Replace the default search engine

escapeinput=[true|false]
    Ignore automatic focusing of input elements by websites on load.

fontsize=integer
    Replace the default fontsize

monofontsize=integer
    Replace the default monospace fontsize

caret=[true|false]
    Enable or disable caret browsing

fantasyfont=fantasy-font-family
    Replace the default fantasy font family

minimumfontsize=integer
    Replace the default minimum font size

monofont=default-monospace-font-family
    Replace the default monospace font family

pagecache=[true|false]
    Enable or disable webkit's internal page cache

proxy=[true|false]
    Whether to read and use the http_proxy environment variable

backgrounds=[true|false]
    Enable or disable print backgrounds

sansfont=default-sans-font-family
    Replace the default sans-serif font family

scrollbars=[true|false]
    Enable or disable scrollbars.

statusbar=[true|false]
    Show or hide the status bar.

inputbox=[true|false]
    Show or hide the input box.

seriffont=default-serif-font-family
    Replace the default serif font family

stylesheet=URL
    Replace the user stylesheet

webinspector=[true|false]
    Enable or disable webinspector

strictssl=[true|false]
    Reject or accept unverified certificates (default: true)

cabundle=/path/to/file
    Where CA certificates are stored (default: /etc/ssl/certs/ca-certificates.crt)

tempdir=/path/without/slash
    A path to a directory for temporary files (default: $TMPDIR or /tmp)

MAPPINGS
Keys can be mapped to the following functions:

quit
    Close the browser

stop
    Stop the current loading process

bookmark
    Save the current website in the bookmarks

source
    Toggle HTML source view

inspect
    Opens the webinspector if the webinspector is enabled

jumpleft
    Scroll to left edge

jumpright
    Scroll to right edge

jumptop
    Scroll to top of the page

jumpbottom
    Scroll to bottom of the page

pageup
    Scroll one screensize up

pagedown
    Scroll one screensize down

navigationback
    Go to previous page in browser-history

navigationforward
    Go to next page in browser-history

reload
    Reload current page

scrollleft
    Scroll the page one step to the left

scrollright
    Scroll the page one step to the right

scrollup
    Scroll the page one step up

scrolldown
    Scroll the page one step down

openeditor
    When in a text box, open the external editor Example: To map the 'R' key to reload to current page, add the following line into ~/.config/vimprobable/vimprobablerc: map R reload

MAPPING KEYS TO COLON COMMANDS
Key can be mapped to any colon commands. Instead of entering an internal symbol for the key combination to be mapped to, enter a command line as you would enter it within a running browser instance. For example: map <C-s>=:set scripts=false This would map Control-s to disable Javascript. map i=:javascript console.log('insertmode_on') This maps the i key to manually activate INSERT mode.

MAPPING COMMANDS TO EXISTING COMMANDS
You can create new commands by mapping them to an already working command line. For example: map :bmatag1=:bookmark tag1 would create a new command "bmatag1" which would bookmark the current page and automatically add "tag1" to it.

INTERACTIVE SETTING
All settings can be changed on the fly by entering :set followed by one of the commands in the SETTINGS section above.

SHORTCUTS (SEARCH ENGINES)
You can define new shortcuts or override the pre-defined ones using the following format (without the angle brackets):
    shortcut <shortcut> <URL with at most one %s>
where the %s serves as a placeholder for the term to be inserted into the URL. Other percent signs in the URL have to be escaped as %%. Using the shortcut feature without %s will simply work as shorthand to much-used bookmarks.

URI HANDLERS
You can define external applications to handle requests for defined URI schemas using the following syntax (without the angle brackets):
    handler <URI schema> <handler command with exactly one %s>
where the %s serves as a placeholder for the rest of the URI.

BUGS
There has not been any significant bug-hunting yet.

AUTHORS
Hannes Schueller and Matto Fransen

SEE ALSO
vimprobable2(1),