.fi
..
.SH NAME
-vimb - Vim Browser - A modal web browser based on webkit, inspired by vim the
+Vimb - Vim Browser - A modal web browser based on WebKit, inspired by Vim: the
great editor.
.SH SYNOPSIS
.B vimb
.OP OPTIONS
.RI [ URI "|" file "|" - ]
.SH DESCRIPTION
-vimb 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
+Vimb is a WebKit based web browser that behaves like the Vimperator
+plugin for Firefox and has usage paradigms from the great editor, Vim.
+The goal of Vimb is to build a completely keyboard-driven, efficient
and pleasurable browsing-experience.
.SH OPTIONS
-If no \fIURI\fP or \fIfile\fP is given vimb will open the configured
+If no \fIURI\fP or \fIfile\fP is given, Vimb will open the configured
home-page.
-If \fIURI\fP is '-', vimb reads the html to display from stdin.
+If \fIURI\fP is '-', Vimb reads the HTML to display from stdin.
.PP
Mandatory arguments to long options are mandatory for short options too.
.TP
.TP
.BI "\-e, \-\-embed " "WINID"
.I WINID
-of an XEmbed-aware application, that vimb will use as its parent.
+of an XEmbed-aware application, that Vimb will use as its parent.
.TP
.B \-d, \-\-dump
-Dump the current used socket path to stdout in case vimb is started with \-s
+Dump the current used socket path to stdout in case Vimb is started with \-s
option.
.sp
Example:
Show help options.
.TP
.B \-k, \-\-kiosk
-Run vimb in kiosk mode with nearly no keybindings, not inputbox and no context
+Run Vimb in kiosk mode with nearly no keybindings, not inputbox and no context
menu.
.TP
.B \-s, \-\-socket
-If given vimb will create a control socket in the user runtime directory.
+If given Vimb will create a control socket in the user runtime directory.
.TP
.B "\-v, \-\-version"
Print build and version information.
.SH MODES
-Vimb is modal an has following main modes:
+Vimb is modal and has the following main modes:
.TP
.B Normal Mode
The default mode.
Used for editing text elements in a webpage.
.TP
.B Command Mode
-Execute ex-commands from the builtin inputbox (commandline).
+Execute `ex` commands from the builtin inputbox (commandline).
.TP
.B 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 else
-be swallowed by vimb.
+by Vimb, all other keystrokes are given to the webview to handle them.
+This allows the use of a website's configured keybindings, that might otherwise
+be swallowed by Vimb.
.SH NORMAL MODE COMMANDS
Some of the Normal Model Commands can have a numeric count to multiply the
effect of the command.
Mode.
.TP
.B CTRL\-Z
-Switch vimb into Pass-Through Mode.
+Switch Vimb into Pass-Through Mode.
.TP
.B gf
-Toggle show html source of current page.
+Toggle show HTML source of the current page.
.TP
.B gF
-Open the Web Inspector for current page.
+Open the Web Inspector for the current page.
.TP
.B CTRL\-V
-Pass the next key press directly to gtk.
+Pass the next key press directly to GTK.
.TP
.B CTRL\-Q
Quit the browser if there are no running downloads.
.SS Navigation
.TP
.B o
-Start Command Mode and print `:open ' to input box.
+Start Command Mode and print `:open ' to the input box.
.TP
.B O
-Start Command Mode and print `:open URI' to input box.
+Start Command Mode and print `:open URI' to the input box.
.TP
.B t
-Start Command Mode and print `:tabopen ' to input box.
+Start Command Mode and print `:tabopen ' to the input box.
.TP
.B T
-Start Command Mode and print `:tabopen URI' to input box.
+Start Command Mode and print `:tabopen URI' to the input box.
.TP
.B gh
Open the configured home-page.
.TP
.B gH
-Open the configured home-page into new window.
+Open the configured home-page in a new window.
.TP
.B u
Open the last closed page.
.TP
.B U
-Open the last closed page into a new window.
+Open the last closed page in a new window.
.TP
.B CTRL\-P
-Open the oldest entry from read it later queue in current browser window, if
-vimb has been compiled with QUEUE feature.
+Open the oldest entry from the Read It Later queue in the current browser window (only if
+Vimb has been compiled with QUEUE feature).
.TP
.BI [ \(dqx ]p
-Open the URI out of the register \fIx\fP or if not given from clipboard.
+Open the URI out of the register \fIx\fP or, if not given, from the clipboard.
.TP
.BI [ \(dqx ]P
-Open the URI out of the register \fIx\fP or if not given from clipboard into
+Open the URI out of the register \fIx\fP or, if not given, from the clipboard in a
new window.
.TP
.BI [ N ]CTRL\-O
Follow the last \fIN\fPth link matching `previouspattern'.
.TP
.BI m{ a-z }
-Set a page mark {\fIa-z\fP} at current possition on page.
-Such set marks are only available on the current page,
+Set a page mark {\fIa-z\fP} at the current position on the page.
+Such set marks are only available on the current page;
if the page is left, all marks will be removed.
.TP
.BI '{ a-z }
-Jump to the mark {\fIa-z\fP} on current page.
+Jump to the mark {\fIa-z\fP} on the current page.
.TP
.B ''
Jumps to the position before the latest jump, or where the last "m'" command
was given.
.SS Hinting
-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.
-When hinting is started, the relevant elements on the page will
+Hinting in Vimb is how you accomplish the tasks that you would do with the
+mouse in common mouse-driven browsers: open a URI, yank a URI, save a page and
+so on. When hinting is started, the relevant elements on the page will
be marked by labels generated from configured `hintkeys'.
Hints can be selected by using <Tab>, <C-I> or <C-Tab>, <C-O>,
by typing the chars of the label, or filtering the elements by some text
that is part of the hinted element (like URI, link text, button label)
-and any combination of this methods.
+or any combination of these methods.
If <enter> is pressed, the current active hint will be fired.
If only one possible hint remains, this will be fired automatically.
.PP
.BI Syntax: " ;{mode}{hint}"
.PP
-Start hint mode.
+Start Hints mode.
Different elements depending on \fImode\fP are highlighted and `numbered'.
Elements can be selected either by typing their label, or by typing part
of their text (\fIhint\fP) to narrow down the result.
The filtering of hints by text splits the query at ' ' and use the single 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.
+and many chars are required 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'}.
.PP
-The following keys have special meanings in Hints mode:
+The following keys have special meanings in Hints modes:
.PD 0
.IP \fB<CR>\fP
Selects the first highlighted element, or the current focused.
Generate an `:tabopen' prompt with hint's URI.
.TP
.B ;e
-Open the configured editor (`editor-command') with the hinted form element's
+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
+If the file in $EDITOR is saved and the $EDITOR is closed, the file
content will be put back in the form field.
.TP
.B ;i
-Open hinted image into current window.
+Open hinted image in the current window.
.TP
.B ;I
-Open hinted image into new window.
+Open hinted image in a new window.
.TP
.B ;p
-Push the hint's URI to the end of the read it later queue like the `:qpush'
+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.
+This is only available if Vimb was compiled with the QUEUE feature.
.TP
.B ;P
-Push the hint's URI to the beginning of the read it later queue like the
+Push the hint's URI to the beginning of the Read It Later queue like the
`:qunshift' command.
-This is only available if vimb was compiled with QUEUE feature.
+This is only available if Vimb was compiled with the QUEUE feature.
.TP
.B ;x
Hints like ;o, but instead of opening the hinted URI, the
-`x-hint-command' is run in vimb.
+`x-hint-command' is run in Vimb.
.TP
.BI [ \(dqx ];y
Yank hint's destination location into primary and secondary clipboard and into
.TP
.BI 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
+Like 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
.BI [ \(dqx ]Y
Yank the current selection into register \fIx\fP and clipboard.
.SH COMMAND MODE
-Commands that are listed below are ex-commands like in vim, that are typed
+Commands that are listed below are ex-commands like in Vim, that are typed
into the inputbox (the command line of vimb).
The commands may vary in their syntax or in the parts they allow,
but in general they follow a simple syntax.
Where \fIlhs\fP (left hand side) must not contain any unescaped space.
The syntax of the rhs (right hand side) if this is available depends on the
command.
-At the moment the count parts [N] of commands is parsed, but actual there does
-not exists any command that uses the count.
+At the moment the count parts [N] of commands is parsed, but currently there is
+no command that uses the count.
.sp
-Commands that are typed interactive (from inputbox or from socket) are
+Commands that are typed interactivly (from the inputbox or from socket) are
normally recorded into command history and register.
To avoid this, the commands can be prefixed by one or more additional `:' or
whitespace.
Ignore all typed content and switch back to normal mode.
.TP
.B <CR>
-Submit the entered ex command or search query to run it.
+Submit the entered `ex` command or search query to run it.
.TP
.B CTRL\-H
Deletes the char before the cursor.
Remove everything between cursor and prompt.
.TP
.B CTRL\-B
-Moves the cursor direct behind the prompt `:'.
+Moves the cursor directly behind the prompt `:'.
.TP
.B CTRL\-E
Moves the cursor after the char in inputbox.
.TP
.B CTRL\-V
-Pass the next key press directly to gtk.
+Pass the next key press directly to GTK.
.TP
.B CTRL\-R {a-z"%:/;}
Insert the content of given register at cursor position.
.SS Command Line History
.TP
.B <Tab>
-Start completion of the content in inputbox in forward direction.
+Start completion of the content in the inputbox in forward direction.
.TP
.B <S-Tab>
-Start completion of the content in inputbox in backward direction.
+Start completion of the content in the inputbox in backward direction.
.TP
.B <Up>
Step backward in the command history.
.SS Open
.TP
.BI ":o[pen] [" URI ]
-Open the give \fIURI\fP into current window.
-If \fIURI\fP is empty the configured 'home-page' is opened.
+Open the give \fIURI\fP in the current window.
+If \fIURI\fP is empty, the configured 'home-page' is opened.
.TP
.BI ":t[abopen] [" URI ]
-Open the give \fIURI\fP into a new window.
-If \fIURI\fP is empty the configured 'home-page' is opened.
+Open the give \fIURI\fP in a new window.
+If \fIURI\fP is empty, the configured 'home-page' is opened.
.SS Key Mapping
-Key mappings allow to alter actions of key presses.
+Key mappings allow users to alter the actions of key presses.
Each key mapping is associated with a mode and only has effect
when the mode is active.
The following commands allow the user to substitute one sequence
.PP
Note that the \fIlhs\fP 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.
+with a single `\\', as shown in the examples.
.sp
-The \fIrhs\fP starts with the first none space char. If you want a \fIrhs\fP
+The \fIrhs\fP starts with the first non-space char. If you want a \fIrhs\fP
that starts with a space, you have to use "<Space>".
.PP
Standard key mapping commands are provided for these modes \fIm\fP:
.PD 0
.IP \fBn\fP
-Normal mode: When browsing normally.
+Normal mode: when browsing normally.
.IP \fBi\fP
-Insert mode: When interacting with text fields on a website.
+Insert mode: when interacting with text fields on a website.
.IP \fBc\fP
-Command Line mode: When typing into the vimbs command line.
+Command Line mode: when typing into Vimb's command line.
.PD
.PP
Most keys in key sequences are represented simply by the character that you
This will enable scripts and lookup the first bookmarked URI with the tag
`glib' and open it immediately if F1 key is pressed.
.IP ":nmap \\\\\ \\\\\ 50G;o"
-Example which mappes two spaces to go to 50% of the page, start hinting mode.
+Example which maps two spaces to go to 50% of the page, and start hinting mode.
.PD
.RE
.TP
Save the current opened URI with \fItags\fP to the bookmark file.
.TP
.BI ":bmr [" URI ]
-Removes all bookmarks for given \fIURI\fP or if not given the current opened
+Removes all bookmarks for given \fIURI\fP or, if not given, the current opened
page.
.SS Handlers
Handlers allow specifying external scripts to handle alternative URI methods.
.TP
.BI ":handler-add " "handler" "=" "cmd"
Adds a handler to direct \fIhandler\fP links to the external \fIcmd\fP.
-The \fIcmd\fP can contain one placeholder %s that will be filled by the
+The \fIcmd\fP can contain one placeholder `%s` that will be filled by the
full URI given when the command is called.
.RS
.P
.IP ":handler-add magnet=transmission-gtk %s"
to open magnet links directly with Transmission.
.IP ":handler-add irc=irc-handler.sh %s"
-to direct irc://<host>:<port>/<channel> links to a wrapper for your irc client.
+to direct irc://<host>:<port>/<channel> links to a wrapper for your IRC client.
.PD
.RE
.TP
.BI ":handler-remove " "handler"
Remove the handler for the given URI \fIhandler\fP.
.SS Shortcuts
-Shortcuts allows to open URI build up from a named template with additional
+Shortcuts allow the opening of an URI built up from a named template with additional
parameters.
If a shortcut named 'dd' is defined, you can use it with `:open dd
list of parameters' to open the generated URI.
.PP
-Shortcuts are a good to use with search engines where the URI is nearly the
-same but a single parameter is user defined.
+Shortcuts are convenient to use with search engines where the URI is standardised
+and a single parameter is user defined.
.TP
.BI ":shortcut-add " "shortcut" "=" "URI"
Adds a shortcut with the \fIshortcut\fP and \fIURI\fP template.
into as many parameters like the highest used placeholder.
.sp
To use spaces within the parameters, the parameters can be grouped by
-surrounding them with single- or double quotes like shown in example shortcut
+surrounding them with single-or double quotes-as shown in example shortcut
`map'.
.RS
.P
comma is deleted, unless the option becomes empty.
.TP
.BI ":se[t] " var ?
-Show the current set value of variable
+Show the current set value of variable.
.IR VAR .
.TP
.BI ":se[t] " var !
Toggle the value of boolean variable \fIvar\fP and display the new set value.
.SS Queue
-The queue allows to mark URIs for later reading (something like a read it later
+The queue allows the marking of 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.
+This list is shared between the single instances of Vimb.
+Only available if Vimb has been compiled with the QUEUE feature.
.TP
.BI ":qpu[sh] [" URI ]
-Push \fIURI\fP or if not given current URI to the end of the queue.
+Push \fIURI\fP or, if not given, the current URI to the end of the queue.
.TP
.BI ":qun[shift] [" URI ]
-Push \fIURI\fP or if not given current URI to the beginning of the queue.
+Push \fIURI\fP or, if not given, the current URI to the beginning of the queue.
.TP
.B :qp[op]
-Open the oldest queue entry in current browser window and remove it from the
+Open the oldest queue entry in the current browser window and remove it from the
queue.
.TP
.B :qc[lear]
.TP
.I group
When the [\fIgroup\fP] argument is not given, Vimb uses the current group as
-defined with ':augroup', otherwise, vimb uses the group defined with
+defined with ':augroup', otherwise, Vimb uses the group defined with
[\fIgroup\fP].
Groups are useful to remove multiple grouped autocommands.
.TP
.TP
.B DownloadStart
Fired right before a download is started.
-This is fired for vimb downloads as well as external downloads
+This is fired for Vimb downloads as well as external downloads
if 'download-use-external' is enabled.
.TP
.B DownloadFinished
-Fired if a vimb managed download is finished.
+Fired if a Vimb managed download is finished.
For external download this event is not available.
.TP
.B DownloadFailed
-Fired if a vimb managed download failed.
+Fired if a Vimb managed download failed.
For external download this event is not available.
.PD
.RE
.RE
.TP
.I cmd
-Any ex command vimb understands.
+Any `ex` command vimb understands.
The leading ':' is not required.
Multiple commands can be separated by '|'.
.TP
.BI ":au[tocmd] [" group "] {" event "} {" pat "} {" cmd "}"
-Add \fIcmd\fP to the list of commands that vimb will execute automatically on
+Add \fIcmd\fP to the list of commands that Vimb will execute automatically on
\fIevent\fP for a URI matching \fIpat\fP autocmd-patterns.
Vimb always adds the \fIcmd\fP after existing autocommands, so that the
autocommands are executed in the order in which they were given.
Remove all autocommands associated with \fIevent\fP and which pattern match
\fIpat\fP, and add the command \fIcmd\fP.
Note that the pattern is not matches literally to find autocommands
-to remove, like vim does.
+to remove, like Vim does.
Vimb matches the autocommand pattern with \fIpat\fP.
If [\fIgroup\fP] is not given, deletes autocommands in current group,
as noted above.
The following environment variables are set for called shell commands.
.TP
.B VIMB_URI
-This variable is set by vimb everytime a new page is opened to the URI of the
+This variable is set by Vimb everytime a new page is opened to the URI of the
page.
.TP
.B VIMB_TITLE
Contains the title of the current opened page.
.TP
.B VIMB_PID
-Contains the pid of the running vimb instance.
+Contains the pid of the running Vimb instance.
.TP
.B VIMB_SOCKET
-Holds the full path to the control socket, if vimb is compiled with SOCKET
+Holds the full path to the control socket, if Vimb is compiled with SOCKET
feature and started with `--socket' option.
.TP
.B VIMB_XID
-Holds the X-Window id of the vim window or of the embedding window if vimb is
-started with -e option.
+Holds the X-Window id of the Vimb window or of the embedding window if Vimb is
+started with the -e option.
.PD
.PP
Example:
Vimb fills these registers only when you say so.
.TP
.B \(dq:
-Last executed ex command.
+Last executed `ex` command.
.TP
.B \(dq"
Last yanked content.
Executes the next command as normal mode command and return to input mode.
.TP
.B CTRL\-T
-Open configured editor with content of current form field.
+Open configured $EDITOR with content of current form field.
.TP
.B CTRL\-V
-Pass the next key press directly to gtk.
+Pass the next key press directly to GTK.
.TP
.B CTRL\-Z
Enter the pass-through mode.
.B 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.
+If initial chars are passed, the completion will lookup those
+commands that begin with the given chars.
.TP
.B settings
The setting name completion is started if at least `:set ` is shown in
.TP
.B 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.
+This completion looks up every given word in the history URI and titles.
Only those history items are shown, where the title or URI contains all tags.
.sp
Example:
.RS
.PD 0
.IP ":open \fB!\fPfoo ba"
-will match all bookmark that have tags starting with "foo" and "ba".
+will match all bookmarks that have tags starting with "foo" and "ba".
If the bookmark does not have any tags set, the URL is split on `.' and `/'
into tags.
.PD
.RE
.TP
.B boomark tags
-The boomark tag completion allows to insert already used bookmarks for the
+The boomark tag completion allows the insertion of already used bookmarks for the
`:bma ` commands.
.TP
.B search
-The search completion allow to get a filtered list of already done searches.
+The search completion allows a filtered list of already done searches.
This completion starts by `/` or `?` in inputbox and performs a prefix
comparison for further typed chars.
.SH SETTINGS
All settings listed below can be set with the `:set' command.
-.SS Webkit-Settings
+.SS WebKit-Settings
.TP
.B accelerated-compositing (bool)
Enable or disable support for accelerated compositing on pages.
Load images automatically.
.TP
.B auto-resize-window (bool)
-Indicates if vimb will honor size and position changes of the window by various
+Indicates if Vimb will honor size and position changes of the window by various
DOM methods.
.TP
.B auto-shrink-images (bool)
font.
.TP
.B dns-prefetching (bool)
-Indicates if vimb prefetches domain names.
+Indicates if Vimb prefetches domain names.
.TP
.B dom-paste (bool)
Whether to enable DOM paste.
through <object> or <embed>, which are the preferred tags for this task.
.TP
.B javascript-can-access-clipboard (bool)
-Whether JavaScript can access Clipboard.
+Whether JavaScript can access the clipboard.
.TP
.B javascript-can-open-windows-automatically (bool)
Whether JavaScript can open popup windows automatically without user
.B private-browsing (bool)
Whether to enable private browsing mode.
This suppresses printing of messages into JavaScript Console.
-At the time this is the only way to force webkit to
+At the time this is the only way to force WebKit to
not allow a page to store data in the windows sessionStorage.
.TP
.B plugins (bool)
Whether text areas are resizable.
.TP
.B respect-image-orientation (bool)
-Whether vimb should respect image orientation.
+Whether Vimb should respect image orientation.
.TP
.B sansfont (string)
The font family used as the default for content using sans-serif font.
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.
+a user presses the Right key, heuristics determine whether there is an
+element they might be trying to reach towards the right, and if there are
+multiple elements, which element they probably want.
.TP
.B spell-checking (bool)
Whether to enable spell checking while typing.
For instance, sv_FI for Swedish as written in Finland or pt_BR
for Portuguese as written in Brazil.
.sp
-If no value is specified the default value for gtk is used.
+If no value is specified the default value for GTK is used.
.TP
.B tab-key-cycles-through-elements (bool)
-Whether the tab key cycles through elements on the page.
+Whether the Tab key cycles through elements on the page.
.sp
-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.
+If true, pressing the Tab key will focus the next element in the web view.
+Otherwise, the web 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.
.TP
.B universal-access-from-file-uris (bool)
Whether to allow files loaded through file:// URIs universal access to all
Strict-Transport-Security for server that don't provide this header whereas
they propose https website.
.sp
-Note that this setting will not remplace existing headers, but add a new one.
-If multiple patterns match a request uri, the last matched rule will be
+Note that this setting will not replace existing headers, but add a new one.
+If multiple patterns match a requested URI, the last matched rule will be
applied.
-You could also specified differents headers for same pattern.
+You could also specified differents headers for the same pattern.
.sp
The format is a list of `pattern header-list`.
If `header-list` has not than one element, enclosing with QUOTE
.RE
.TP
.B ca-bundle (string)
-The path to the crt file for the certificate validation.
+The path to the .crt file for the certificate validation.
The given path is expanded with standard file expansion.
.TP
.B completion-bg-active (color)
Background color for selected completion item.
.TP
.B completion-bg-normal (color)
-Background color for none selected completion items.
+Background color for non-selected completion items.
.TP
.B completion-fg-active (color)
Foreground color for the selected completion item.
.TP
.B completion-fg-normal (color)
-Foreground color for the none selected completion items.
+Foreground color for the non-selected completion items.
.TP
.B completion-font (string)
Font used for the completion items.
lower between server-side request and time defined with `cookie-expire-time').
.TP
.B download-command (string)
-A command with placeholder '%s' that will be invoked to download a uri.
+A command with placeholder '%s' that will be invoked to download a URI.
.RS
.TP
The following additional environment variable are available:
started from, also known as referer.
.TP
.B $VIMB_FILE
-The target file that is calculated by vimb according to the `download-path'.
+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.
.TP
.B $VIMB_COOKIES
-Path to the cookie file vimb uses.
-This is only available if vimb is compiled with COOKIE feature.
+Path to the cookie file Vimb uses.
+This is only available if Vimb is compiled with the COOKIE feature.
.TP
.B $VIMB_USER_AGENT
-Holds the user agent string that vimb uses.
+Holds the user agent string that Vimb uses.
.TP
.B $VIMB_MIME_TYPE
The mime-type of the download.
-This variable is only available when der server sent the mime-type header
+This variable is only available when the 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.
.TP
.B $VIMB_USE_PROXY
-Indicates if the proxy is enabled in vimb.
+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.
.B download-use-external (bool)
Indicates if the external download tool set as `download-command' should be
used to handle downloads.
-If this is disabled vimb will handle the download.
+If this is disabled Vimb will handle the download.
.TP
.B 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'.
-To use gvim as editor, it's necessary to call it with `-f' to run it
+Command with placeholder '%s' called if form filler is opened with $EDITOR to
+spawn the editor-like `x-terminal-emulator -e vi %s'.
+To use Gvim as the editor, it's necessary to call it with `-f' to run it
in the foreground.
.TP
.B fullscreen (bool)
Show the current window full-screen.
.TP
.B header (list)
-Comma separated list of headers that replaces default header sent by webkit or
+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]]'.
.sp
.PD 0
.TP
.I config
-Configuration file to set webkit setting, some GUI styles and keybindings.
+Configuration file to set WebKit setting, some GUI styles and keybindings.
.TP
.I cookies
Cookie store file.
`URI<tab><tab>tags` if there is no title.
.TP
.I queue
-Holds the read it later queue filled by `qpush' if
-vimb has been compiled with QUEUE feature.
+Holds the Read It Later queue filled by `qpush' if
+Vimb has been compiled with QUEUE feature.
.TP
.I hsts
-Holds the known hsts hosts if vimb is compiled with HTTP strict transport
+Holds the known hosts hosts if Vimb is compiled with HTTP strict transport
security feature.
.TP
.I scripts.js
that is opened.
.TP
.I style.css
-File for userdefined css styles.
+File for userdefined CSS styles.
These file is used if the config variable `stylesheet' is enabled.
.PD
.RE
.I $XDG_RUNTIME_DIR/vimb/socket/
Directory where the control sockets are placed.
.PP
-There are also some sample scripts installed together with vimb under
+There are also some sample scripts installed together with Vimb under
PREFIX/share/vimb/examples.
.SH ENVIRONMENT
.TP
.B http_proxy
-If this variable is set to an none empty value, and the configuration option
-`proxy' is enabled, this will be used as http proxy.
-If the proxy URL has no scheme set, http is assumed.
+If this variable is set to an non-empty value, and the configuration option
+`proxy' is enabled, this will be used as HTTP proxy.
+If the proxy URL has no scheme set, HTTP is assumed.
.TP
.B no_proxy
-A comma separated list of domains and/or ips which should not be proxied.
+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,
for example "[::1]:443".
.IP
projects / vimb.git / commitdiff
