Vimperator

options

Vimperator has a number of internal variables and switches which can be set to achieve special effects. These options come in 5 forms:

boolean can only be on or off
number has a numeric value
string has a string value
charlist like a string but with unique characters
stringlist a comma-separated list of strings

Setting options

E764 set-option

:set :se

:se[t]
Show all options that differ from their default value.

:se[t] all
Show all options.

:se[t] {option}?
Show value of {option}.

:se[t] {option}
Toggle option: set, switch it on.

Number option: show value.
String option: show value.

:set-default

:se[t] {option}&
Reset option to its default value.

:se[t] all&
Set all options to their default value.

:set-args E487 E521

:se[t] {option}={value}

Set string or number option to {value}.
For numeric options the value must be given in decimal. The old value can be inserted by typing <Tab>.

:set+=

:se[t] {option}+={value}

Add the {value} to a number option, or append the {value} to a string option. When the option is a comma separated list, a comma is added, unless the value was empty. If the option is a list of flags, superfluous flags are removed. When adding a flag that was already present the option value doesn't change.

:set^=

:se[t] {option}^={value}

Multiply the {value} to a number option, or prepend the {value} to a string option. When the option is a comma separated list, a comma is added, unless the value was empty.

:set-=

:se[t] {option}-={value}

Subtract the {value} from a number option, or remove the {value} from a string option, if it is there. If the {value} is not found in a string option, there is no error or warning. When the option is a comma separated list, a comma is deleted, unless the option becomes empty. When the option is a list of flags, {value} must be exactly as they appear in the option. Remove flags one by one to avoid problems.

:setlocal :setl

:setl[ocal]

:setl[ocal] all

:setl[ocal] {option}?

:setl[ocal] {option}

:setl[ocal] {option}&

:setl[ocal] all&

:setl[ocal] {option}={value}

:setl[ocal] {option}+={value}

:setl[ocal] {option}^={value}

:setl[ocal] {option}-={value}

The same as :set command, but operates on local for current tab options only. See :set for details.

:setglobal :setg

:setg[lobal]

:setg[lobal] all

:setg[lobal] {option}?

:setg[lobal] {option}

:setg[lobal] {option}&

:setg[lobal] all&

:setg[lobal] {option}={value}

:setg[lobal] {option}+={value}

:setg[lobal] {option}^={value}

:setg[lobal] {option}-={value}

The same as :set command, but operates on global options only. See :set for details.

Setting Firefox options

firefox-options

Most Firefox options are not touched/overridden by Vimperator. In order to set any of these preferences use either of the following:

:prefs :preferences

:pref[erences]

Show Browser Preferences
You can change the browser preferences from this dialog. Be aware that not all Firefox preferences work, because Vimperator overrides some key bindings and changes Firefox's GUI.

:prefs! :preferences!

:pref[erences]!

Opens about:config in the current tab where you can change advanced Firefox preferences.

:set-!

:se[t]! {preference}={value}

Change any Firefox {preference} (those in the about:config window). You can also reset/delete those preferences with :set! {preference}&.

List of options

list-options

'act' 'activate'

'activate' 'act'
stringlist (default: "homepage,quickmark,tabopen,paste")

Define when tabs are automatically activated. Available items:

homepage gH mapping
quickmark go and gn mappings
tabopen :tabopen[!] command
paste P and gP mappings

'albc' 'activelinkbgcolor'

'activelinkbgcolor' 'albc'
string (default: ##88FF00)

Background color of the current active link during hint mode.

'alfc' 'activelinkfgcolor'

'activelinkfgcolor' 'alfc'
string (default: black)

Foreground color of the current active link during hint mode.

'cpt' 'complete'

'complete' 'cpt'
charlist (default: sfbh)

Items which are completed at the :[tab]open prompt. Available items:

s Search engines and keyword URLs
f Local files
b Bookmarks
h History
l Firefox location bar entries (bookmarks and history sorted in an intelligent way)
S Suggest engines

The order is important, so :set complete=bs would list bookmarks first, and then any available quick searches. Add "sort" to the 'wildoptions' option if you want all entries sorted. If 'wildoptions' contains "auto", "b" and "h" are not available for performance reasons but you can use "l" to achieve a similar effect. On the other hand "l" does not yet work, when 'wildoptions' does NOT contain "auto".

'ds' 'defsearch'

'defsearch' 'ds'
string (default: "google")

Sets the default search engine. The default search engine name is used in the :[tab]open [arg] command if [arg] neither looks like a URL or like a specified search engine/keyword.

This means, it you set 'defsearch' to "youtube", then :open arnold schwarzenegger will be exactly the same as :open youtube arnold schwarzenegger. Therefore, you need to add a keyword or search engine "youtube" first.

'editor'

'editor'
string (default: "gvim -f")

Set the external text editor. Sets the editor to run when <C-i> is pressed in INSERT and TEXTAREA modes.
Warning: Vimperator will not behave correctly if the editor forks its own process, such as with gvim without the -f argument.

'eht' 'extendedhinttags'

'extendedhinttags' 'eht'
string

(default: //*[@onclick or @onmouseover or @onmousedown or @onmouseup or @oncommand or @class='lk' or @class='s'] | //input[not(@type='hidden')] | //a | //area | //iframe | //textarea | //button | //select | //xhtml:*[@onclick or @onmouseover or @onmousedown or @onmouseup or @oncommand or @class='lk' or @class='s'] | //xhtml:input[not(@type='hidden')] | //xhtml:a | //xhtml:area | //xhtml:iframe | //xhtml:textarea | //xhtml:button | //xhtml:select)

The XPath string of hintable elements activated by ;.

'nofc' 'nofocuscontent' 'fc' 'focuscontent'

'focuscontent' 'fc'
boolean (default: off)

Focus the content after a page has loaded. This is useful, if you always want to stay in normal mode when browsing between web sites. When "on", it blurs any textbox which often is automatically focused on page load. If you usually like 'focuscontent' but sometimes you'd like to focus the first input field, you can use gi to jump to it.

'nofs' 'nofullscreen' 'fs' 'fullscreen'

'fullscreen' 'fs'
boolean (default: off)

Show the current window fullscreen. Also hide certain GUI elements like the statusline.

'go' 'guioptions'

'guioptions' 'go'
charlist (default: "")

Show or hide certain GUI elements like the menu or toolbar. Supported characters:

m Menubar
T Toolbar
b Bookmark bar

You can also hide the tab bar with :set showtabline=0.

'hm' 'hintmatching'

'hintmatching' 'hm'
string (default: contains)

Change the hint matching algorithm during hint mode. Possible values:

contains The typed characters are split on whitespace, and these character groups have to match anywhere inside the text of the link.
wordstartswith The typed characters are matched with the beginning of the first word (see 'wordseparators') in the link as long as possible. If no matches occur in the current word, then the matching is continued at the beginning of the next word. The words are worked through in the order they appear in the link. If the typed characters contain spaces, then the characters are split on whitespace. These character groups are then matched with the beginning of the words, beginning at the first one and continuing with the following words in the order they appear in the link.
firstletters Behaves like wordstartswith, but non matching words aren't overleaped.
custom Delegate to a custom function: liberator.plugins.customHintMatcher(hintString)

'hs' 'hintstyle'

'hintstyle' 'hs'
string

(default: z-index:5000; font-family:monospace; font-size:12px; color:white; background-color:red; border-color:ButtonShadow; border-width:0px; border-style:solid; padding:0px 1px 0px 1px; position:absolute;)

CSS specification of hints

'ht' 'hinttags'

'hinttags' 'ht'
string

(default: //*[@onclick or @onmouseover or @onmousedown or @onmouseup or @oncommand or @class='lk' or @class='s'] | //input[not(@type='hidden')] | //a | //area | //iframe | //textarea | //button | //select | //xhtml:*[@onclick or @onmouseover or @onmousedown or @onmouseup or @oncommand or @class='lk' or @class='s'] | //xhtml:input[not(@type='hidden')] | //xhtml:a | //xhtml:area | //xhtml:iframe | //xhtml:textarea | //xhtml:button | //xhtml:select)

XPath string of hintable elements activated by f and F

'hto' 'hinttimeout'

'hinttimeout' 'hto'
number (default: 0)

Automatically follow non unique numerical hint after 'hinttimeout' milliseconds.
Set to 0 (the default) to only follow numeric hints after pressing <Return> or when the hint is unique.

'hi' 'history'

'history' 'hi'
number (default: 500)

Number of Ex commands and search patterns to store in the commandline history.

'nohls' 'nohlsearch' 'hls' 'hlsearch'

'hlsearch' 'hls'
boolean (default: off)

Highlight previous search pattern matches

'hlss' 'hlsearchstyle'

'hlsearchstyle' 'hlss'

string (default: color: black; background-color: yellow; padding: 0; display: inline;)

CSS specification of highlighted search items

'noic' 'noignorecase' 'ic' 'ignorecase'

'ignorecase' 'ic'
boolean (default: on)

Ignore case in search patterns.

'nois' 'noincsearch' 'is' 'incsearch'

'incsearch' 'is'
boolean (default: on)

Show where the search pattern matches as it is typed.
Note: Incremental searching currently only works in the forward direction.

'noim' 'noinsertmode' 'im' 'insertmode'

'insertmode' 'im'
boolean (default: on)

Use Insert mode as the default for text areas. Makes Vimperator work in a way that Insert mode is the default mode for text areas. Useful if you want to use Vimperator as a modeless editor, keeping the known Firefox interface for editing text areas.

'ls' 'laststatus'

'laststatus' 'ls'
number (default: 2)

Determines when the last window will have a status line. Possible values:

0 Never
1 Only if there are multiple windows
2 Always

Note: laststatus=1 not implemented yet.

'lbc' 'linkbgcolor'

'linkbgcolor' 'lbc'
string (default: yellow)

Background color of a link during hint mode.

'lfc' 'linkfgcolor'

'linkfgcolor' 'lfc'
string (default: black)

Foreground color of a link during hint mode.

'nolks' 'nolinksearch' 'lks' 'linksearch'

'linksearch' 'lks'
boolean (default: off)

Limit the search to hyperlink text. This includes (X)HTML elements with an "href" atrribute and XLink "simple" links.

'nomore' 'more'

'more'
boolean (default: on)

Pause the message list window when more than one screen of listings is displayed

'nextpattern'

'nextpattern'
stringlist (default: \bnext,^>$,^(>>|»)$,^(>|»),(>|»)$,\bmore\b)

Patterns to use when guessing the 'next' page in a document sequence. Each pattern, in order, is matched against all links in the page with the first match being used. The patterns are case insensitive regular expressions.

'newtab'

'newtab'
stringlist (default: "")

Define which Ex commands output the result in a new tab automatically. You can also use :tab command to manually output a command in a new tab.

The possible values:

all All commands
addons :addo[ns] command
downloads :downl[oads] command
help :h[elp] command
javascript :javascript! or :js! command
prefs :pref[erences]! or :prefs! command

'noonline' 'online'

'online'
boolean (default on)

Show and set the 'work offline' behavior.

'pageinfo' 'pa'

'pageinfo' 'pa'
charlist (default: gfm)

Desired info on :pa[geinfo]. Available items:

g General info
f Feeds
m Meta tags

The order matters.

'pps' 'popups'

'popups' 'pps'
number (default: 1)

Define where to show requested popup windows. Does not apply to windows which are opened by middle clicking a link, they always open in a new tab. Possible values:

0 Force to open in the current tab (Warning: this can stop some web sites from working correctly!)
1 Always open in a new tab
2 Open in a new window if it has a specific requested size (default in Firefox)
3 Always open in a new window
4 Open in the same tab unless it has a specific requested size

Note: This option does not change the popup blocker of Firefox in any way.

'nopreload' 'preload'

'preload' 'nopreload'
boolean (default: on)

Speed up first time history/bookmark completion

History access can be quite slow for a large history. Vimperator maintains a cache to speed it up significantly on subsequent access. In order to also speed up first time access, it is cached at startup, if this option is set (recommended).

'previouspattern'

'previouspattern'
stringlist (default: \bprev|previous\b,^<$,^(<<|«)$,^(<|«),(<|«)$)

Patterns to use when guessing the 'previous' page in a document sequence Each pattern, in order, is matched against all links in the page with the first match being used. The patterns are case insensitive regular expressions.

'scr' 'scroll'

'scroll' 'scr'
number (default: 0)

Number of lines to scroll with C-u and C-d commands. The number of lines scrolled defaults to half the window size. When a {count} is specified to the <C-u> or <C-d> commands this is used to set the value of 'scroll' and also used for the current command. The value can be reset to half the window height with :set scroll=0.

'shell' 'sh'

'shell' 'sh'
string (default: on)

Show the current mode in the command line.

'shellcmdflag' 'shcf'

'shellcmdflag' 'shcf'
string (default: $SHELL or "sh", Win32: "cmd.exe")

Shell to use for executing :! and :run commands.

'nosmd' 'noshowmode' 'smd' 'showmode'

'showmode' 'smd'
boolean (default: "-c", Win32: "/c")

Flag passed to shell when executing :! and :run commands.

E.g. bash -c gvim

'ssli' 'showstatuslinks'

'showstatuslinks' 'ssli'
number (default: 1)

Show the destination of the link under the cursor in the status bar Also links which are focused by keyboard commands like <Tab> are shown. Possible values:

0 Don't show link destination
1 Show the link in the status line
2 Show the link in the command line

'stal' 'showtabline'

'showtabline' 'stal'
number (default: 2)

Control when to show the tab bar of opened web pages. Possible values:

0 Never show tab bar
1 Show tab bar only if more than one tab is open
2 Always show tab bar

'noscs' 'nosmartcase' 'scs' 'smartcase'

'smartcase' 'scs'
boolean (default: on)

Override the 'ignorecase' option if the pattern contains uppercase characters. This is only used if the 'ignorecase' option is set.

'suggestengines'

'suggestengines'
stringlist (default: "google")

Set the search engines which can be used for completion suggestions. Add "S" to the 'complete' option if you want use this feature.

Warning: This feature could make tab-completion slower because it needs to wait for changes, so use it only if you have a fast internet connection.

'titlestring'

'titlestring'
string (default: "Vimperator")

Change the title of the browser window. Vimperator changes the browser title from "Title of web page - Mozilla Firefox" to "Title of web page - Vimperator".
If you don't like that, you can restore it with: :set titlestring=Mozilla Firefox.

'noum' 'nousermode' 'um' 'usermode'

'usermode' 'um'
boolean (default: off)

Show current website with a minimal style sheet to make it easily accessible. Note that this is a local option for now, later it may be split into a global and :setlocal part

'urlseparator'

'urlseparator'
string (default: ",\s")

Set the separator regexp used to separate multiple URL args. Multiple arguments can be specified for :open, and similar commands, using this regexp as the separator. Using whitespace alone is not generally useful since it is often contained in a single argument. E.g. :open linus torvalds should perform a single search for the key words "linus" and "torvalds"

'verbose', 'vbs'

'verbose' 'vbs'
number (default: 0)

Define which type of messages are logged. When bigger than zero, Vimperator will give messages about what it is doing. They are printed to the error console which can be shown with :javascript!. The highest value is 9, being the most verbose mode.

'novb' 'novisualbell' 'vb' 'visualbell'

'visualbell' 'vb'
boolean (default: off)

Use visual bell instead of beeping on errors. For now you can't turn off both, this will hopefully change.

'visualbellstyle' 't_vb'

'visualbellstyle' 't_vb'
string (default: "border: none; background-color: black;")

The CSS style to use for the visual bell. Set this to the empty string if you want no bell at all.

'wim' 'wildmode'

'wildmode' 'wim'
stringlist (default: "list:full")

Define how command line completion works. It is a comma-separated list of parts, where each part specifies what to do for each consecutive use of the completion key. The first part specifies the behavior for the first use of the completion key, the second part for the second use, etc.

These are the possible values for each part:

"" Complete only the first match
"full" Complete the next full match. After the last, the original string is used.
"longest" Complete till the longest common string.
"list" When more than one match, list all matches.
"list:full" When more than one match, list all matches and complete first match.
"list:longest" When more than one match, list all matches and complete till the longest common string. When there is only a single match, it is fully completed regardless of the case.

'wop' 'wildoptions'

'wildoptions' 'wop'
stringlist (default: "")

A list of words that change how command line completion is done.

Possible words:

auto Automatically show completions while you are typing
sort Always sorts completion list, overriding the 'complete' option.

'wsp' 'wordseparators'

'wordseparators' 'wsp'
string (default: [\.,!\?:;/\\"\^\$%&§\(\)\[\]{}<>#\*\+\|=~ _\\-])

A regex which defines the word separators which are used for the 'hintmatching' types 'wordstartswith' and 'firstletters' to split the words in the text of a link.