vimb(1) Vimb Manual vimb(1)NAMEvimb - Vim Browser - A modal web browser based on webkit, inspired by
vim the great editor.
SYNOPSISvimb [-hkv] [-C cmd] [-c config] [-e winid] [URI|file|-]
DESCRIPTIONvimb is a webkit based web browser that behaves like the vimperator
plugin for the firefox and usage paradigms from the great editor vim.
The goal of vimb is to build a completely keyboard-driven, efficient
and pleasurable browsing-experience.
OPTIONS
If no URI or file is given vimb will open the configured home-page. If
URI is '-', vimb reads the html to display from stdin.
Mandatory arguments to long options are mandatory for short options
too.
-C, --cmd CMD
Run CMD as ex command line right before the first page is
loaded. Several ex commands can be used separated by "|".
Example: vimb--cmd "set cookie-accept=origin|set header=Ref‐
erer,DNT=1"
-c, --config CONFIG-FILE
Use custom configuration given as CONFIG-FILE. This will also be
applied on new spawned instances.
-e, --embed WINID
WINID of an XEmbed-aware application, that vimb will use as its
parent.
-h, --help
Show help options.
-k, --kiosk
Run vimb in kiosk mode with nearly no keybindings, not inputbox
and no context menu.
-v, --version
Print build and version information.
MODESvimb is modal an has following main modes:
Normal Mode
The default mode. Pressing Escape always enter normal mode.
Input Mode
Used for editing text elements in a webpage.
Command Mode
Execute ex-commands from the builtin inputbox (commandline).
Pass-Through Mode
In Pass-Through mode only the `<Esc>` and `<C-[>` keybindings
are interpreted by vimb, all other keystrokes are given to the
webview to handle them. This allows to use websites that uses
keybindings itself, that might be swallowed by vimb else.
NORMAL MODE COMMANDS
Some of the Normal Model Commands can have a numeric count to multiply
the effect of the command. If a command supports the count this is
shown as [N].
General
: Start Command Mode and print `:' to the input box.
gi Set cursor to the first editable element in the page and switch
to Input Mode.
CTRL-Z Switch vimb into Pass-Through Mode.
gf Toggle show html source of current page.
gF Open the Web Inspector for current page.
CTRL-V Pass the next key press directly to gtk.
CTRL-Q Quit the browser if there are no running downloads.
Navigation
o Start Command Mode and print `:open ' to input box.
O Start Command Mode and print `:open URI' to input box.
t Start Command Mode and print `:tabopen ' to input box.
T Start Command Mode and print `:tabopen URI' to input box.
gh Open the configured home-page.
gH Open the configured home-page into new window.
u Open the last closed page.
U Open the last closed page into a new window.
CTRL-P Open the oldest entry from read it later queue in current
browser window, if vimb has been compiled with QUEUE feature.
["x]p Open the URI out of the register x or if not given from clip‐
board.
["x]P Open the URI out of the register x or if not given from clip‐
board into new window.
[N]CTRL-O
Go back N steps in the browser history.
[N]CTRL-I
Go forward N steps in the browser history.
[N]gu Go to the Nth descendent directory of the current opened URI.
gU Go to the domain of the current opened page.
[N]CTRL-A
Increments the last number in URL by 1, or by N if given.
[N]CTRL-X
Decrements the last number in URL by 1, or by N if given. Nega‐
tive numbers are not supported as trailing numbers in URLs are
often preceded by hyphens.
r Reload the website.
R Reload the website without using caches.
CTRL-C Stop loading the current page.
Motion
[N]CTRL-F
Scroll N pages down.
[N]CTRL-B
Scroll N pages up.
[N]CTRL-D
Scroll N half pages down.
[N]CTRL-U
Scroll N half pages up.
[N]gg Scroll to the top of the current page. Or if N is given to N% of
the page.
[N]G Scroll to the bottom of the current page. Or if N is given to N%
of the page.
[N]0 Scroll N steps to the left of current page.
[N]$ Scroll N steps to the right of current page.
[N]h Scroll N steps to the left of page.
[N]l Scroll N steps to the right of page.
[N]j Scroll page N steps down.
[N]k Scroll page N steps up.
[N]]] Follow the last Nth link matching `nextpattern'.
[N][[ Follow the last Nth link matching `previouspattern'.
m{a-z} Set a page mark {a-z} at current possition on page. Such set
marks are only available on the current page, if the page is
left, all marks will be removed.
'{a-z} Jump to the mark {a-z} on current page.
'' Jumps to the position before the latest jump, or where the last
"m'" command was given.
Hinting
The hinting is the way to do what you would do with the mouse in common
mouse-driven browsers. Open URI, yank URI, save page and so on. If the
hinting is started, the relevant elements on the page will be marked by
numbered labels. Hints can be selected by using <Tab>, <C-I> or <C-
Tab>, <C-O>, by typing the number of the label, or filtering the ele‐
ments by some text that is part of the hinted element (like URI, link
text, button label) and any combination of this methods. If <enter> is
pressed, the current active hint will be fired. If only one possible
hint remains, this will be fired automatically.
Syntax: ;{mode}{hint}
Start hint mode. Different elements depending on mode are highlighted
and numbered. Elements can be selected either by typing their number,
or by typing part of their text (hint) to narrow down the result. When
an element has been selected, it is automatically clicked or used
(depending on mode) and hint mode ends.
The filtering of hints by text splits the query at ' ' and use the sin‐
gle parts as separate queries to filter the hints. This is useful for
hints that have a lot of filterable chars in common and it needs many
chars to make a distinct selection. For example ';over tw' will easily
select the second hint out of {'very long link text one', 'very long
link text two'}.
Following keys have special meanings in Hints mode:
<CR> Selects the first highlighted element, or the current focused.
<Tab> Moves the focus to the next hint element.
<S-Tab>
Moves the focus to the previous hint element.
<Esc>, CTRL-C, CTRL-[
Exits Hints mode without selecting an element
Hint modes:
f Is an alias for the ;o hint mode.
F Is an alias for the ;t hint mode.
;o Open hint's location in the current window.
;t Open hint's location in a new window.
;s Saves the hint's destination under the configured `down‐
load-path'.
;O Generate an `:open' prompt with hint's URI.
;T Generate an `:tabopen' prompt with hint's URI.
;e Open the configured editor (`editor-command') with the
hinted form element's content. If the file in editor is
saved and the editor is closed, the file content will be
put back in the form field.
;i Open hinted image into current window.
;I Open hinted image into new window.
;p Push the hint's URI to the end of the read it later queue
like the `:qpush' command. This is only available if vimb
was compiled with QUEUE feature.
;P Push the hint's URI to the beginning of the read it later
queue like the `:qunshift' command. This is only avail‐
able if vimb was compiled with QUEUE feature.
;x Hints like ;o, but instead of opening the hinted URI, the
`x-hint-command' is run in vimb.
;y Yank hint's destination location into primary and sec‐
ondary clipboard.
;Y Yank hint's text description or form text into primary
and secondary clipboard.
Syntax: g;{mode}{hint}
Start an extended hints mode and stay there until <Esc> is
pressed. Like the normal hinting except that after a hint is
selected, hints remain visible so that another one can be
selected with the same action as the first. Note that the
extended hint mode can only be combined with the following hint
modes I p P s t y Y.
Searching
/QUERY, ?QUERY
Start searching for QUERY in the current page. / start search
forward, ? in backward direction.
*, # Start searching for the current selected text, or if no text is
selected for the content of the primary or secondary clipboard.
* start the search in forward direction and # in backward direc‐
tion.
Note that this commands will yank the text selection into the
clipboard and may remove other content from there!
[N]n Search for Nnth next search result depending on current search
direction.
[N]N Search for Nnth previous search result depending on current
search direction.
Zooming
[N]zi Zoom-In the text of the page by N steps.
[N]zo Zoom-Out the text of the page by N steps.
[N]zI Full-Content Zoom-In the page by N steps.
[N]zO Full-Content Zoom-Out the page by N steps.
zz Reset Zoom.
Yank
["x]y Yank the URI or current page into register x and clipboard.
["x]Y Yank the current selection into register x and clipboard.
COMMAND MODE
Command Line Editing
<Esc>, CTRL-[, CTRL-C
Ignore all typed content and switch back to normal mode.
<CR> Submit the entered ex command or search query to run it.
CTRL-H Deletes the char before the cursor.
CTRL-W Deletes the last word before the cursor.
CTRL-U Remove everything between cursor and prompt.
CTRL-B Moves the cursor direct behind the prompt `:'.
CTRL-E Moves the cursor after the char in inputbox.
CTRL-V Pass the next key press directly to gtk.
CTRL-R {a-z%:/;}
Insert the content of given register at cursor position. See
also section REGISTERS.
Command Line History
<Tab> Start completion of the content in inputbox in forward direc‐
tion.
<S-Tab>
Start completion of the content in inputbox in backward direc‐
tion.
<Up> Step backward in the command history.
<Down> Step forward in the command history.
Open
:o[pen] [URI]
Open the give URI into current window. If URI is empty the con‐
figured 'home-page' is opened.
:t[abopen] [URI]
Open the give URI into a new window. If URI is empty the config‐
ured 'home-page' is opened.
Key Mapping
Key mappings allow to alter actions of key presses. Each key mapping is
associated with a mode and only has effect when the mode is active.
Following commands allow the user to substitute one sequence of key
presses by another.
Syntax: :{m}map {lhs} {rhs} Note that the lhs ends with the first found
space. If you want to use space also in the {lhs} you have to escape
this with a single `\' like shown in the examples.
Standard key mapping commands are provided for these modes m:
n Normal mode: When browsing normally.
i Insert mode: When interacting with text fields on a website.
c Command Line mode: When typing into the vimbs command line.
Most keys in key sequences are represented simply by the character that
you see on the screen when you type them. However, as a number of these
characters have special meanings, and a number of keys have no visual
representation, a special notation is required.
As special key names have the format <...>. Following special keys can
be used <Left>, <Up>, <Right>, <Down> for the cursor keys, <Tab>,
<Esc>, <CR>, <F1>-<F12> and <C-A>-<C-Z>.
:nm[ap] {lhs} {rhs}
:im[ap] {lhs} {rhs}
:cm[ap] {lhs} {rhs}
Map the key sequence lhs to rhs for the modes where the map com‐
mand applies. The result, including rhs, is then further scanned
for mappings. This allows for nested and recursive use of map‐
pings.
Examples:
:cmap <C-G>h /home/user/downloads/
Adds a keybind to insert a file path into the input box.
This could be useful for the `:save' command that could
be used as ":save ^Gh".
:nmap <F1> :set scripts=on<CR>:open !glib<Tab><CR>
This will enable scripts and lookup the first bookmarked
URI with the tag `glib' and open it immediately if F1 key
is pressed.
:nmap \ \ 50G;o
Example which mappes two spaces to go to 50% of the page,
start hinting mode.
:nn[oremap] {lhs} {rhs}
:ino[remap] {lhs} {rhs}
:cno[remap] {lhs} {rhs}
Map the key sequence lhs to rhs for the mode where the map com‐
mand applies. Disallow mapping of rhs, to avoid nested and
recursive mappings. Often used to redefine a command.
:nu[nmap] {lhs}
:iu[nmap] {lhs}
:cu[nmap] {lhs}
Remove the mapping of lhs for the applicable mode.
Bookmarks
:bma [tags]
Save the current opened URI with tags to the bookmark file.
:bmr [URI]
Removes all bookmarks for given URI or if not given the current
opened page.
Handlers
Handlers allow specifying external scripts to handle alternative URI
methods.
:handler-add handler=cmd
Adds a handler to direct handler links to the external cmd. The
cmd can contain one placeholder %s that will be filled by the
full URI given when the command is called.
Examples:
:handler-add magnet=xdg-open %s
to open magnet links with xdg-open.
:handler-add magnet=transmission-gtk %s
to open magnet links directly with Transmission.
:handler-add irc=irc-handler.sh %s
to direct irc://<host>:<port>/<channel> links to a wrap‐
per for your irc client.
:handler-remove handler
Remove the handler for the given URI handler.
Shortcuts
Shortcuts allows to open URI build up from a named template with addi‐
tional parameters. If a shortcut named 'dd' is defined, you can use it
with `:open dd list of parameters' to open the generated URI.
Shortcuts are a good to use with search engines where the URI is nearly
the same but a single parameter is user defined.
:shortcut-add shortcut=URI
Adds a shortcut with the shortcut and URI template. The URI can
contain multiple placeholders $0-$9 that will be filled by the
parameters given when the shortcut is called. The parameters
given when the shortcut is called will be split into as many
parameters like the highest used placeholder.
To use spaces within the parameters, the parameters can be
grouped by surrounding them with single- or double quotes like
shown in example shortcut `map'.
Examples:
:shortcut-add dl=https://duckduckgo.com/lite/?q=$0
to setup a search engine. Can be called by `:open dl my
search phrase'.
:shortcut-add gh=https://github.com/$0/$1
to build URIs from given parameters. Can be called `:open
gh fanglingsu vimb'.
:shortcut-add map=https://maps.google.com/maps?saddr=$0&daddr=$1
to search for a route, all but the last parameter must be
quoted if they contain spaces like `:open map "city hall,
London" railway station, London'
:shortcut-remove shortcut
Remove the search engine to the given shortcut.
:shortcut-default shortcut
Set the shortcut for given shortcut as the default. It doesn't
matter if the shortcut is already in use or not to be able to
set it.
Settings
:se[t] var=value
Set configuration values named by var. To set boolean variable
you should use 'on', 'off' or 'true' and 'false'. Colors are
given as hexadecimal value like '#f57700'.
:se[t] var+=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.
:se[t] var^=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.
:se[t] var-=value
Subtract the value from a number option, or remove the value
from a string option, if it is there. When the option is a comma
separated list, a comma is deleted, unless the option becomes
empty.
:se[t] var?
Show the current set value of variable VAR.
:se[t] var!
Toggle the value of boolean variable var and display the new set
value.
Queue
The queue allows to mark URIs for later reading (something like a read
it later list). This list is shared between the single instances of
vimb. Only available if vimb has been compiled with QUEUE feature.
:qpu[sh] [URI]
Push URI or if not given current URI to the end of the queue.
:qun[shift] [URI]
Push URI or if not given current URI to the beginning of the
queue.
:qp[op]
Open the oldest queue entry in current browser window and remove
it from the queue.
:qc[lear]
Removes all entries from queue.
Automatic commands
An autocommand is a command that is executed automatically in response
to some event, such as a URI being opened. Autocommands are very power‐
ful. Use them with care and they will help you avoid typing many com‐
mands.
Note: The ":autocmd" command cannot be followed by another command,
since any '|' is considered part of the command.
Autocommands are built with following properties.
group When the [group] argument is not given, Vimb uses the current
group as defined with ':augroup', otherwise, vimb uses the group
defined with [group]. Groups are useful to remove multiple
grouped autocommands.
event You can specify a comma separated list of event names. No white
space can be used in this list.
Events:
LoadProvisional
Fired if a new page is going to opened. No data has been
received yet, the load may still fail for transport
issues. Out of this reason this event has no associated
URL to match.
LoadCommited
Fired if first data chunk has arrived, meaning that the
necessary transport requirements are established, and the
load is being performed. This is the right event to tog‐
gle content related setting like 'scripts', 'plugins' and
such things.
LoadFirstLayout
fired if the first layout with actual visible content is
shown.
LoadFinished
Fires when everything that was required to display on the
page has been loaded.
LoadFailed
Fired when some error occurred during the page load that
prevented it from being completed.
DownloadStart
Fired right before a download is started. This is fired
for vimb downloads as well as external downloads if
'download-use-external' is enabled.
DownloadFinished
Fired if a vimb managed download is finished. For exter‐
nal download this event is not available.
DownloadFailed
Fired if a vimb managed download failed. For external
download this event is not available.
pat Comma separated list of patterns, matches in order to check if a
autocommand applies to the URI associated to an event. To use
',' within the single patterns this must be escaped as '\,'.
Patterns:
* Matches any sequence of characters. This includes also
'/' in contrast to shell patterns.
? Matches any single character except of '/'.
{one,two}
Matches 'one' or 'two'. Any '{', ',' and '}' within this
pattern must be escaped by a '\'. '*' and '?' have no
special meaning within the curly braces.
\ Use backslash to escape the special meaning of '?*{},' in
the pattern or pattern list.
cmd Any ex command vimb understands. The leading ':' is not
required. Multiple commands can be separated by '|'.
:au[tocmd] [group] {event} {pat} {cmd}
Add cmd to the list of commands that vimb will execute automati‐
cally on event for a URI matching pat autocmd-patterns. Vimb
always adds the cmd after existing autocommands, so that the
autocommands are executed in the order in which they were given.
:au[tocmd]! [group] {event} {pat} {cmd}
Remove all autocommands associated with event and which pattern
match pat, and add the command cmd. Note that the pattern is not
matches literally to find autocommands to remove, like vim does.
Vimb matches the autocommand pattern with pat.
:au[tocmd]! [group] {event} {pat}
Remove all autocommands associated with event and which pattern
matches pat.
:au[tocmd]! [group] * {pat}
Remove all autocommands with patterns matching pat for all
events.
:au[tocmd]! [group] {event}
Remove all autocommands for event.
:au[tocmd]! [group]
Remove all autocommands.
:aug[roup] {name}
Define the autocmd group name for the following ":autocmd" com‐
mands. The name "end" selects the default group.
:aug[roup]! {name}
Delete the autocmd group name.
Example
:aug github
: au LoadCommited * set scripts=off|set cookie-accept=never
: au LoadCommited http{s,}://github.com/* set scripts=on
:aug end
Misc
:sh[ellcmd] cmd
Runs given shell cmd syncron and print the output into inputbox.
Following pattern in cmd are expanded, '~username', '~/', '$VAR'
and '${VAR}'. A '\' before these patterns disables the expan‐
sion.
Example: :sh ls -l $HOME
:sh[ellcmd]! cmd
Like :shellcmd, but asyncron.
Example: :sh! /bin/sh -c 'echo "`date` $VIMB_URI" >> myhis‐
tory.txt'
:s[ave] [path]
Download current opened page into configured download directory.
If path is given, download under this file name or path. path is
expanded and can therefore contain '~/', '${ENV}' and '~user'
pattern.
:q[uit]
Close the browser. This will be refused if there are running
downloads.
:q[uit]!
Close the browser independent from an running download.
:e[val] javascript
Runs the given javascript in the current page and display the
evaluated value.
This comman cannot be followed by antoher command, since any '|'
is considered part of the command.
Example: :eval document.cookie
:e[val]! javascript
Like :eval, but there is nothing print to the input box.
:no[rmal] [cmds]
Execute normal mode commands cmds. This makes it possible to
execute normal mode commands typed on the input box.
cmds cannot start with a space. Put a count of 1 (one) before
it, "1 " is one space. This comman cannot be followed by anto‐
her command, since any '|' is considered part of the command.
Example: :set scripts!|no! R
:no[rmal]! [cmds]
Like :normal, but no mapping is applied to cmds.
:ha[rdcopy]
Print current document. Open a GUI dialog where you can select
the printer, number of copies, orientation, etc.
INPUT MODE
<Esc>, CTRL-[
Switch back to normal mode.
CTRL-O Executes the next command as normal mode command and return to
input mode.
CTRL-T Open configured editor with content of current form field.
CTRL-V Pass the next key press directly to gtk.
CTRL-Z Enter the pass-through mode.
REGISTERS
There are different types of registers.
"a - "z
26 named registers "a to "z. Vimb fills these registers only
when you say so.
"% Contains the curent opened URI.
": Contains the most recent executed ex command.
"/ Contains the most recent search-pattern.
"; Contains the last hinted URL. This can be used in `x-hint-com‐
mand' to get the URL of the hint.
COMPLETIONS
The completions are triggered by pressing `<Tab>` or `<shift-tab>` in
the activated inputbox. Depending of the current inserted content dif‐
ferent completions are started. The completion takes additional typed
chars to filter the completion list that is shown.
commands
The completion for commands are started when at least `:` is
shown in the inputbox. If there are given some sore chars the
completion will lookup those commands that starts with the given
chars.
settings
The setting name completion is started if at least `:set ` is
shown in inputbox and does also match settings that begins with
already typed setting prefix.
history
The history of URIs is shown for the `:open ` and `:tabopen `
commands. This completion looks up for every given word in the
history URI and titles. Only those history items are shown,
where the title or URI contains all tags.
Example
:open foo bar<Tab>
will complete only URIs that contain the words foo and
bar.
bookmarks
The bookmark completion is similar to the history completion,
but does match only the tags of the bookmarks. The bookmark com‐
pletion ist started by `:open !` or `:tabopen !` and does a pre‐
fix search for all given words in the bookmark tags.
Example
:open !foo ba
will match all bookmark that have the tags "foo" or
"foot" and tags starting with "ba" like "ball".
boomark tags
The boomark tag completion allows to insert already used book‐
marks for the `:bma ` commands.
search The search completion allow to get a filtered list of already
done searches. This completion starts by `/` or `?` in inputbox
and performs a prefix comparison for further typed chars.
SETTINGS
All settings listed below can be set with the `:set' command.
Webkit-Settings
accelerated-compositing (bool)
Enable or disable support for accelerated compositing on pages.
Accelerated compositing uses the GPU to render animations on
pages smoothly and also allows proper rendering of 3D CSS trans‐
forms.
auto-load-images (bool)
Load images automatically.
auto-resize-window (bool)
Indicates if vimb will honor size and position changes of the
window by various DOM methods.
auto-shrink-images (bool)
Automatically shrink standalone images to fit.
caret (bool)
Whether to enable accessibility enhanced keyboard navigation.
cursivfont (string)
The font family used as the default for content using cursive
font.
defaultencoding (string)
The default text charset used when interpreting content with an
unspecified charset.
defaultfont (string)
The font family to use as the default for content that does not
specify a font.
dns-prefetching (bool)
Indicates if vimb prefetches domain names.
dom-paste (bool)
Whether to enable DOM paste. If set to TRUE, document.execCom‐
mand("Paste") will correctly execute and paste content of the
clipboard.
file-access-from-file-uris (bool)
Boolean property to control file access for file:// URIs. If
this option is enabled every file:// will have its own security
unique domain.
fontsize (int)
The default font size used to display text.
frame-flattening (bool)
Whether to enable the Frame Flattening. With this setting each
subframe is expanded to its contents, which will flatten all the
frames to become one scrollable page.
html5-database (bool)
Whether to enable HTML5 client-side SQL database support.
Client-side SQL database allows web pages to store structured
data and be able to use SQL to manipulate that data asyn‐
chronously.
html5-local-storage (bool)
Whether to enable HTML5 localStorage support. localStorage pro‐
vides simple synchronous storage access.
hyperlink-auditing (bool)
Enable or disable support for <a ping>.
images (bool)
Determines whether images should be automatically loaded or not.
insecure-content-show (bool)
Whether pages loaded via HTTPS should load subresources such as
images and frames from non-HTTPS URIs. Only for webkit>=2.0.
insecure-content-run (bool)
Whether pages loaded via HTTPS should run subresources such as
CSS, scripts, and plugins from non-HTTPS URIs. Only for
webkit>=2.0.
java-applet (bool)
Enable or disable support for the Java <applet> tag. Keep in
mind that Java content can be still shown in the page through
<object> or <embed>, which are the preferred tags for this task.
javascript-can-access-clipboard (bool)
Whether JavaScript can access Clipboard.
javascript-can-open-windows-automatically (bool)
Whether JavaScript can open popup windows automatically without
user intervention.
media-playback-allows-inline (bool)
Whether media playback is full-screen only or inline playback is
allowed. Setting it to false allows specifying that media play‐
back should be always fullscreen.
media-playback-requires-user-gesture (bool)
Whether a user gesture (such as clicking the play button) would
be required to start media playback or load media. Setting it on
requires a gesture by the user to start playback, or to load the
media.
media-stream (bool)
Enable or disable support for MediaSource on pages. MediaSource
is an experimental proposal which extends HTMLMediaElement to
allow JavaScript to generate media streams for playback.
mediasource (bool)
Enable or disable support for MediaSource on pages. MediaSource
is an experimental proposal which extends HTMLMediaElement to
allow JavaScript to generate media streams for playback.
minimumfontsize (int)
The minimum font size used to display text.
monofont (string)
The font family used as the default for content using monospace
font.
monofontsize (int)
Default font size for the monospace font.
offlinecache (bool)
Whether to enable HTML5 offline web application cache support.
Offline web application cache allows web applications to run
even when the user is not connected to the network.
pagecache (bool)
Enable or disable the page cache. Disabling the page cache is
generally only useful for special circumstances like low-memory
scenarios or special purpose applications like static HTML view‐
ers.
print-backgrounds (bool)
Whether background images should be printed.
private-browsing (bool)
Whether to enable private browsing mode. This suppresses print‐
ing of messages into JavaScript Console. At the time this is the
only way to force webkit to not allow a page to store data in
the windows sessionStorage.
plugins (bool)
Determines whether or not plugins on the page are enabled.
print-backgrounds (bool)
Whether background images should be drawn during printing.
resizable-text-areas (bool)
Whether text areas are resizable.
respect-image-orientation (bool)
Whether vimb should respect image orientation.
sansfont (string)
The font family used as the default for content using sans-serif
font.
scripts (bool)
Determines whether or not JavaScript executes within a page.
seriffont (string)
The font family used as the default for content using serif
font.
site-specific-quirks (bool)
Enables the site-specific compatibility workarounds.
smooth-scrolling (bool)
Enable or disable support for smooth scrolling.
spacial-navigation (bool)
Whether to enable the Spatial Navigation. This feature consists
in the ability to navigate between focusable elements in a Web
page, such as hyperlinks and form controls, by using Left,
Right, Up and Down arrow keys. For example, if an user presses
the Right key, heuristics determine whether there is an element
he might be trying to reach towards the right, and if there are
multiple elements, which element he probably wants.
spell-checking (bool)
Whether to enable spell checking while typing.
spell-checking-languages (string)
The languages to be used for spell checking, separated by com‐
mas.
The locale string typically is in the form lang_COUNTRY, where
lang is an ISO-639 language code, and COUNTRY is an ISO-3166
country code. For instance, sv_FI for Swedish as written in Fin‐
land or pt_BR for Portuguese as written in Brazil.
If no value is specified the default value for gtk is used.
tab-key-cycles-through-elements (bool)
Whether the tab key cycles through elements on the page.
If true, pressing the tab key will focus the next element in the
web view. Else the wen view will interpret tab key presses as
normal key presses. If the selected element is editable, the tab
key will cause the insertion of a tab character.
universal-access-from-file-uris (bool)
Whether to allow files loaded through file:// URIs universal
access to all pages.
useragent (string)
The user-agent string used by WebKit.
webaudio (bool)
Enable or disable support for WebAudio on pages. WebAudio is an
experimental proposal for allowing web pages to generate Audio
WAVE data from JavaScript.
webgl (bool)
Enable or disable support for WebGL on pages.
webinspector (bool)
Determines whether or not developer tools, such as the Web
Inspector, are enabled.
xssauditor (bool)
Whether to enable the XSS auditor. This feature filters some
kinds of reflective XSS attacks on vulnerable web sites.
Vimb-Settings
ca-bundle (string)
The path to the crt file for the certificate validation. The
given path is expanded with standard file expansion.
completion-bg-active (color)
Background color for selected completion item.
completion-bg-normal (color)
Background color for none selected completion items.
completion-fg-active (color)
Foreground color for the selected completion item.
completion-fg-normal (color)
Foreground color for the none selected completion items.
completion-font (string)
Font used for the completion items.
cookie-accept (string)
Cookie accept policy {`always', `never', `origin' (accept all
non-third-party cookies)}.
cookie-timeout (int)
Cookie timeout in seconds.
download-command (string)
A command with placeholder '%s' that will be invoked to download
a uri.
Following additional environment variable are available:
$VIMB_URI
The URI of the current opened page, normally the page
where the download was started from, also known as ref‐
erer.
$VIMB_FILE
The target file that is calculated by vimb according to
the `download-path'. Note that this file might already
exists, so it's strongly recommended to check the path in
this variable before usage.
$VIMB_COOKIES
Path to the cookie file vimb uses. This is only available
if vimb is compiled with COOKIE feature.
$VIMB_USER_AGENT
Holds the user agent string that vimb uses.
$VIMB_MIME_TYPE
The mime-type of the download. This variable is only
available when der server sent the mime-type header with
the response and only if the download was not start by
the `:save' command or the `;s' hinting.
$VIMB_USE_PROXY
Indicates if the proxy is enabled in vimb. If enable this
variable is `1', otherwise `0'. Note that this variable
gives no hint if the proxy settings apply to the URL to
be downloaded, only if proxy is enabled in general.
Example
:set download-command=/bin/sh -c "wget -c %s -O $VIMB_FILE
--load-cookies $VIMB_COOKIES"
download-path (string)
Path to the default download directory. If the directory is not
set download will be written into current directory. Following
pattern will be expanded if the download is started '~/',
'~user', '$VAR' and '${VAR}'.
download-use-external (bool)
Indicates if the external download tool set as `download-com‐
mand' should be used to handle downloads. If this is disabled
vimb will handle the download.
editor-command (string)
Command with placeholder '%s' called if form filed is opened
with editor to spawn the editor like `x-terminal-emulator -e vi
%s'.
fullscreen (bool)
Show the current window full-screen.
header (list)
Comma separated list of headers that replaces default header
sent by webkit or new headers. The format for the header list
elements is `name[=[value]]'.
Note that these headers will replace already existing headers.
If there is no '=' after the header name, then the complete
header will be removed from the request, if the '=' is present
means that the header value is set to empty value.
To use '=' within a header value the value must be quoted like
shown in Example for the Cookie header.
Example:
:set header=DNT=1,User-Agent,Cookie='name=value'
Send the 'Do Not Track' header with each request and
remove the User-Agent Header completely from request.
hint-timeout (int)
Timeout before automatically following a non-unique numerical
hint. To disable auto fire of hints, set this value to 0.
history-max-items (int)
Maximum number of unique items stored in search-, command or URI
history. If history-max-items is set to 0, the history file will
not be changed.
home-page (string)
Homepage that vimb opens if started without a URI.
hsts (bool)
Enable or disables the HSTS (HTTP Strict Transport Security)
feature.
input-autohide (bool)
If enabled the inputbox will be hidden whenever it contains no
text.
input-bg-error (color)
Background color for the inputbox if error is shown.
input-bg-normal (color)
Background color of the inputbox.
input-fg-error (color)
Foreground color of inputbox if error is shown.
input-fg-normal (color)
Foreground color of inputbox.
input-font-error (string)
Font user in inputbox if error is shown.
input-font-normal (string)
Font used for inputbox.
nextpattern (list)
Patterns to use when guessing the next page in a document. Each
pattern is successively tested against each link in the page
beginning from the last link. Default
"/\bnext\b/i,/^(>|>>|»)$/,/^(>|>>|»)/,/(>|>>|»)$/,/\bmore\b/i".
Note that you have to escape the '|' as '\|' else the '|' will
terminate the :set command and start a new command.
maximum-cache-size (int)
Size in kB used to cache various page data. This caching is
independent from `pagecache' or `offlinecache'. To disable
caching, the size could be set to '0'.
previouspattern (list)
Patterns to use when guessing the previous page in a document.
Each pattern is successively tested against each link in the
page beginning from the last link. Default
"/\bnext\b/i,/^(>|>>|»)$/,/^(>|>>|»)/,/(>|>>|»)$/,/\bmore\b/i"
proxy (bool)
Indicates if the environment variable `http_proxy' is evaluated.
scrollstep (int)
Number of pixel vimb scrolls if 'j' or 'k' is used.
statusbar (bool)
Indicates if the statusbar should be shown.
status-color-bg (color)
Background color of the statusbar.
status-color-fg (color)
Foreground color of the statusbar.
status-font (string)
Font used in statusbar.
status-ssl-color-bg (color)
Background color of statusbar if current page uses trusted https
certificate.
status-ssl-color-fg (color)
Foreground color for statusbar for https pages.
status-ssl-font (string)
Statusbar font for https pages.
status-sslinvalid-color-bg (color)
Background color of the statusbar if the certificate if the
https page isn't trusted.
status-sslinvalid-color-fg (color)
Foreground of statusbar for untrusted https pages.
status-sslinvalid-font (string)
Statusbar font for untrusted https pages.
strict-focus (bool)
Indicates if vimb follows the instruction of the page to focus a
form field without user interaction. If set the true, vimb will
no switch to input mode if the pages say so and vimb will remove
the focus from the form field.
strict-ssl (bool)
If 'on', vimb will not load a untrusted https site.
stylesheet (bool)
If 'on' the user defined styles-sheet is used.
timeoutlen (int)
The time in milliseconds that is waited for a key code or mapped
key sequence to complete.
x-hint-command (string)
Command used if hint mode ;x is fired. The command can be any
vimb command string. Note that the command is run through the
mapping mechanism of vimb so it might change the behaviour by
adding or changing mappings.
:set x-hint-command=50G
Not really useful. If the hint is fired, scroll to the
middle of the page.
:set x-hint-command=:sh! curl -e <C-R>% <C-R>;
This fills the inputbox with the prefilled download com‐
mand and replaces `<C-R>%' with the current URI and `<C-
R>;' with the URI of the hinted element.
FILES
$XDG_CONFIG_HOME/vimb/
Default directory for configuration data.
config Configuration file to set webkit setting, some GUI styles
and keybindings.
cookies
Cookie store file.
closed Holds the URI of the last closed browser window.
history
This file holds the history of unique opened URIs.
command
This file holds the history of commands and search
queries performed via input box.
search This file holds the history of search queries.
bookmark
Holds the bookmarks saved with command `bma'.
queue Holds the read it later queue filled by `qpush' if vimb
has been compiled with QUEUE feature.
hsts Holds the known hsts hosts if vimb is compiled with HTTP
strict transport security feature.
scripts.js
This file can be used to run user scripts, that are
injected into every paged that is opened.
style.css
File for userdefined css styles. These file is used if
the config variable `stylesheet' is enabled.
$XDG_CACHE_HOME/vimb/
Default directory for cache data.
ENVIRONMENT
VIMB_URI
This variable is set by vimb everytime a new page is opened to
the URI of the page.
VIMB_TITLE
Contains the title of the current opened page.
VIMB_PID
Contains the pid of the running vimb instance.
VIMB_XID
Holds the X-Window id of the vim window or of the embedding win‐
dow if vimb is started with -e option.
http_proxy
If this variable is set to an none empty value, and the configu‐
ration option `proxy' is enabled, this will be used as http
proxy.
no_proxy
A comma separated list of domains and/or ips which should not be
proxied. Note that an IPv6 address must appear in brackets if
used with a port "[::1]:443".
Example: "localhost,127.0.0.1,::1,fc00::/7,example.com:8080"
REPORTING BUGS
Report bugs to the main project page on https://github.com/fan‐
glingsu/vimb/issues
or on the mailing list https://lists.source‐
forge.net/lists/listinfo/vimb-users.
AUTHOR
Daniel Carl
vimb/VERSION DATE vimb(1)
