summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Carl <danielcarl@gmx.de>2015-02-21 21:39:47 +0100
committerDaniel Carl <danielcarl@gmx.de>2015-02-21 22:03:58 +0100
commit3360a5b2d836eca6eec1397da48e309bafd728b5 (patch)
tree8db7db7681aae11aabd625044752f37dd6e67dc8 /doc
parent87ddae9ebd8b1ff5ad0b0d3a1d1d674e31dc96d6 (diff)
Cleanup for manual page.
Rationale, major points: - Esr's man-ext .SY macro is not portable. Even esr himself recommends to copy the implementation into the manual page itself if you *must* use it. But in the case at hand, it does almost nothing, so just use the portable .B instead. - The glyph names \[char34] and \[char92] are not portable at all, but internal, undocumented groff features at best, and i'm surprised they work at all even with groff. Better use the portable \(dq and \e. Rationale, minor points: - The first .TH argument is by convention ALL CAPS. - Use .PP and .sp as appropriate rather than blank lines. - Drop useless .RS 0. - New sentence, new line (sorry, that causes some churn). - Some typos. Thanks Ingo Schwarze for this patch.
Diffstat (limited to 'doc')
-rw-r--r--doc/vimb.1751
1 files changed, 410 insertions, 341 deletions
diff --git a/doc/vimb.1 b/doc/vimb.1
index b7dbce8..57393af 100644
--- a/doc/vimb.1
+++ b/doc/vimb.1
@@ -1,6 +1,6 @@
.\" vim: ft=groff
.ad l
-.TH vimb 1 "DATE" "vimb/VERSION" "Vimb Manual"
+.TH VIMB 1 "DATE" "vimb/VERSION" "Vimb Manual"
.de EX
.nf
.ft CW
@@ -13,35 +13,36 @@
vimb - Vim Browser - A modal web browser based on webkit, inspired by vim the
great editor.
.SH SYNOPSIS
-.SY vimb
+.B vimb
.OP OPTIONS
.RI [ URI "|" file "|" - ]
-.YS
.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 and pleasurable
-browsing-experience.
+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.
.SH OPTIONS
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.
-
+home-page.
+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
.BI "\-C, \-\-cmd " "CMD"
Run \fICMD\fP as ex command line right before the first page is loaded.
If the flag is used more than one time, the ordering is preserved when
-\fICMD\fP are executed. You could also pass several ex commands in one
-\fICMD\fP, if there are separated by "|".
-
+\fICMD\fP are executed.
+You could also pass several ex commands in one \fICMD\fP,
+if they are separated by "|".
+.sp
Example:
.EX
vimb --cmd "set cookie-accept=origin|set header=Referer,DNT=1"
.EE
.TP
.BI "\-c, \-\-config " "CONFIG-FILE"
-Use custom configuration given as \fICONFIG-FILE\fP. This will also be applied
-on new spawned instances.
+Use custom configuration given as \fICONFIG-FILE\fP.
+This will also be applied on new spawned instances.
.TP
.BI "\-e, \-\-embed " "WINID"
.I WINID
@@ -50,7 +51,7 @@ of an XEmbed-aware application, that vimb will use as its parent.
.B \-d, \-\-dump
Dump the current used socket path to stdout in case vimb is started with \-s
option.
-
+.sp
Example:
.EX
sh -c "./vimb -s -d > ~/vimb.socket" &
@@ -73,7 +74,8 @@ Print build and version information.
Vimb is modal an has following main modes:
.TP
.B Normal Mode
-The default mode. Pressing Escape always enter normal mode.
+The default mode.
+Pressing Escape always enter normal mode.
.TP
.B Input Mode
Used for editing text elements in a webpage.
@@ -83,13 +85,13 @@ 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 be swallowed
-by vimb else.
+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.
.SH 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
-\fB[N]\fP.
+effect of the command.
+If a command supports the count this is shown as \fB[N]\fP.
.SS General
.TP
.B :
@@ -143,10 +145,10 @@ Open the last closed page into a new window.
Open the oldest entry from read it later queue in current browser window, if
vimb has been compiled with QUEUE feature.
.TP
-.BI [ \[char34]x ]p
+.BI [ \(dqx ]p
Open the URI out of the register \fIx\fP or if not given from clipboard.
.TP
-.BI [ \[char34]x ]P
+.BI [ \(dqx ]P
Open the URI out of the register \fIx\fP or if not given from clipboard into
new window.
.TP
@@ -166,9 +168,9 @@ Go to the domain of the current opened page.
Increments the last number in URL by 1, or by \fIN\fP if given.
.TP
.BI [ N ]CTRL\-X
-Decrements the last number in URL by 1, or by \fIN\fP if given. Negative
-numbers are not supported as trailing numbers in URLs are often preceded by
-hyphens.
+Decrements the last number in URL by 1, or by \fIN\fP if given.
+Negative numbers are not supported as trailing numbers in URLs
+are often preceded by hyphens.
.TP
.B r
Reload the website.
@@ -193,12 +195,12 @@ Scroll \fIN\fP half pages down.
Scroll \fIN\fP half pages up.
.TP
.BI [ N ]gg
-Scroll to the top of the current page. Or if \fIN\fP is given to \fIN\fP% of
-the page.
+Scroll to the top of the current page.
+Or if \fIN\fP is given to \fIN\fP% of the page.
.TP
.BI [ N ]G
-Scroll to the bottom of the current page. Or if \fIN\fP is given to \fIN\fP%
-of the page.
+Scroll to the bottom of the current page.
+Or if \fIN\fP is given to \fIN\fP% of the page.
.TP
.BI [ N ]0
Scroll \fIN\fP steps to the left of current page.
@@ -225,9 +227,9 @@ Follow the last \fIN\fPth link matching `nextpattern'.
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, if the page is left, all marks will be
-removed.
+Set a page mark {\fIa-z\fP} 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.
.TP
.BI '{ a-z }
Jump to the mark {\fIa-z\fP} on current page.
@@ -236,32 +238,34 @@ Jump to the mark {\fIa-z\fP} on current page.
Jumps to the position before the latest jump, or where the last "m'" command
was given.
.SS 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 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. If <enter> is pressed, the
-current active hint will be fired. If only one possible hint remains, this
-will be fired automatically.
-
+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
+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.
+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}"
-
-Start hint 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. When an
-element has been selected, it is automatically clicked or used (depending on
-\fImode\fP) and hint mode ends.
-
+.PP
+Start hint 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.
+When an element has been selected, it is automatically clicked
+or used (depending on \fImode\fP) and hint mode ends.
+.PP
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. For example ';over tw' will easily select the second hint out of
+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'}.
-.RS 0
-.TP
-Following keys have special meanings in Hints mode:
+.PP
+The following keys have special meanings in Hints mode:
.PD 0
.IP \fB<CR>\fP
Selects the first highlighted element, or the current focused.
@@ -270,9 +274,8 @@ Moves the focus to the next hint element.
.IP "\fB<S-Tab>\fP"
Moves the focus to the previous hint element.
.IP "\fB<Esc>, CTRL\-C, CTRL\-[\fP"
-Exits Hints mode without selecting an element
+Exits Hints mode without selecting an element.
.PD
-.RE
.TP
.B Hint modes:
.RS
@@ -301,7 +304,8 @@ Generate an `:tabopen' prompt with hint's URI.
.TP
.B ;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.
+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
@@ -312,45 +316,48 @@ Open hinted image into new window.
.TP
.B ;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.
+command.
+This is only available if vimb was compiled with QUEUE feature.
.TP
.B ;P
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.
+`:qunshift' command.
+This is only available if vimb was compiled with QUEUE feature.
.TP
.B ;x
Hints like ;o, but instead of opening the hinted URI, the
`x-hint-command' is run in vimb.
.TP
-.BI [ \[char34]x ];y
+.BI [ \(dqx ];y
Yank hint's destination location into primary and secondary clipboard and into
the register \fIx\fP.
.TP
-.BI [ \[char34]x ];Y
+.BI [ \(dqx ];Y
Yank hint's text description or form text into primary and secondary clipboard
and into the register \fIx\fP.
.PD
.RE
.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 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
-\fII p P s t y Y\fP.
+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 \fII p P s t y Y\fP.
.SS Searching
.TP
.BI / QUERY ", ?" QUERY
-Start searching for \fIQUERY\fP in the current page. \fI/\fP start search
-forward, \fI?\fP in backward direction.
+Start searching for \fIQUERY\fP in the current page.
+\fI/\fP start search forward, \fI?\fP in backward direction.
.TP
.B *, #
Start searching for the current selected text, or if no text is selected for
-the content of the primary or secondary clipboard. \fI*\fP start the search in
-forward direction and \fI#\fP in backward direction.
-
-Note that this commands will yank the text selection into the clipboard and
+the content of the primary or secondary clipboard.
+\fI*\fP start the search in forward direction and \fI#\fP in backward
+direction.
+.sp
+Note that these commands will yank the text selection into the clipboard and
may remove other content from there!
.TP
.BI [ N ]n
@@ -378,34 +385,38 @@ Full-Content Zoom-Out the page by \fIN\fP steps.
Reset Zoom.
.SS Yank
.TP
-.BI [ \[char34]x ]y
+.BI [ \(dqx ]y
Yank the URI or current page into register \fIx\fP and clipboard.
.TP
-.BI [ \[char34]x ]Y
+.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
-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.
-
+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.
+.PP
.BI Syntax: " :[:| ][N]cmd[name][!][ lhs][ rhs]"
-
-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.
-.br
-Commands that are typed interactive (from 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.
+.sp
+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.
+.sp
+Commands that are typed interactive (from 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.
.PP
Multiple commands, separated by a `|' can be given in a single command line
-and will be executed consecutively. The pipe can be included as an argument to
-a command by escaping it with a backslash.
+and will be executed consecutively.
+The pipe can be included as an argument to a command by escaping it with a
+backslash.
.br
-Following commands process the entire command-line string literally. These
-commands will include any `|' as part of their argument string and so cannot
-be followed by another command.
+Following commands process the entire command-line string literally.
+These commands will include any `|' as part of their argument string and so
+cannot be followed by another command.
.PP
.PD 0
.IP - 2
@@ -448,8 +459,8 @@ Moves the cursor after the char in inputbox.
Pass the next key press directly to gtk.
.TP
.B CTRL\-R {a-z"%:/;}
-Insert the content of given register at cursor position. See also section
-about `:reg[ister]' command.
+Insert the content of given register at cursor position.
+See also section about `:reg[ister]' command.
.SS Command Line History
.TP
.B <Tab>
@@ -466,28 +477,30 @@ Step forward 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 into 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 into 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. 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.
-.TP
+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.
+The following commands allow the user to substitute one sequence
+of key presses by another.
+.PP
.BI Syntax: " :{m}map {lhs} {rhs}"
-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.
-.br
+.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.
+.sp
The \fIrhs\fP starts with the first none space char. If you want a \fIrhs\fP
that starts with a space, you have to use "<Space>".
-.RS 0
-.TP
-.PD 0
+.PP
Standard key mapping commands are provided for these modes \fIm\fP:
+.PD 0
.IP \fBn\fP
Normal mode: When browsing normally.
.IP \fBi\fP
@@ -495,16 +508,15 @@ Insert mode: When interacting with text fields on a website.
.IP \fBc\fP
Command Line mode: When typing into the vimbs command line.
.PD
-.P
-.RE
+.PP
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 \fI<...>\fP. Following special keys can
-be used <Left>, <Up>, <Right>, <Down> for the cursor keys, <Tab>, <Esc>, <CR>,
-<Space>, <F1>-<F12> and <C-A>-<C-Z>.
+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.
+.PP
+As special key names have the format \fI<...>\fP.
+The following special keys can be used: <Left>, <Up>, <Right>, <Down>
+for the cursor keys, <Tab>, <Esc>, <CR>, <Space>, <F1>-<F12> and <C-A>-<C-Z>.
.TP
.BI ":nm[ap] {" lhs "} {" rhs }
.TP
@@ -512,15 +524,17 @@ be used <Left>, <Up>, <Right>, <Down> for the cursor keys, <Tab>, <Esc>, <CR>,
.TP
.BI ":cm[ap] {" lhs "} {" rhs }
Map the key sequence \fIlhs\fP to \fIrhs\fP for the modes where the map
-command applies. The result, including \fIrhs\fP, is then further scanned for
-mappings. This allows for nested and recursive use of mappings.
+command applies.
+The result, including \fIrhs\fP, is then further scanned for mappings.
+This allows for nested and recursive use of mappings.
.RS
.P
Examples:
.PD 0
.IP ":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".
+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".
.IP ":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.
@@ -535,8 +549,9 @@ Example which mappes two spaces to go to 50% of the page, start hinting mode.
.TP
.BI ":cno[remap] {" lhs "} {" rhs }
Map the key sequence \fIlhs\fP to \fIrhs\fP for the mode where the map command
-applies. Disallow mapping of \fIrhs\fP, to avoid nested and recursive
-mappings. Often used to redefine a command.
+applies.
+Disallow mapping of \fIrhs\fP, to avoid nested and recursive mappings.
+Often used to redefine a command.
.TP
.BI ":nu[nmap] {" lhs }
.TP
@@ -576,19 +591,20 @@ to direct irc://<host>:<port>/<channel> links to a wrapper for your irc client.
Remove the handler for the given URI \fIhandler\fP.
.SS Shortcuts
Shortcuts allows to open URI build up from a named template with additional
-parameters. If a shortcut named 'dd' is defined, you can use it with `:open dd
+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.
.TP
.BI ":shortcut-add " "shortcut" "=" "URI"
-Adds a shortcut with the \fIshortcut\fP and \fIURI\fP template. The \fIURI\fP
-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.
-
+Adds a shortcut with the \fIshortcut\fP and \fIURI\fP template.
+The \fIURI\fP 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.
+.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
`map'.
@@ -597,9 +613,11 @@ surrounding them with single- or double quotes like shown in example shortcut
Examples:
.PD 0
.IP ":shortcut-add dl=https://duckduckgo.com/lite/?q=$0"
-to setup a search engine. Can be called by `:open dl my search phrase'.
+to setup a search engine.
+Can be called by `:open dl my search phrase'.
.IP ":shortcut-add gh=https://github.com/$0/$1"
-to build URIs from given parameters. Can be called `:open gh fanglingsu vimb'.
+to build URIs from given parameters.
+Can be called `:open gh fanglingsu vimb'.
.IP ":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'
@@ -610,28 +628,32 @@ contain spaces like `:open map "city hall, London" railway station, London'
Remove the search engine to the given \fIshortcut\fP.
.TP
.BI ":shortcut-default " "shortcut"
-Set the shortcut for given \fIshortcut\fP as the default. It doesn't matter if
-the \fIshortcut\fP is already in use or not to be able to set it.
+Set the shortcut for given \fIshortcut\fP as the default.
+It doesn't matter if the \fIshortcut\fP is already in use or not
+to be able to set it.
.SS Settings
.TP
.BI ":se[t] " var = value
-Set configuration values named by \fIvar\fP. To set boolean variable you
-should use 'on', 'off' or 'true' and 'false'. Colors are given as hexadecimal
-value like '#f57700'.
+Set configuration values named by \fIvar\fP.
+To set boolean variable you should use 'on', 'off' or 'true' and 'false'.
+Colors are given as hexadecimal value like '#f57700'.
.TP
.BI ":se[t] " var += value
Add the \fIvalue\fP to a number option, or append the \fIvalue\fP to a string
-option. When the option is a comma separated list, a comma is added, unless
+option.
+When the option is a comma separated list, a comma is added, unless
the value was empty.
.TP
.BI ":se[t] " var ^= value
Multiply the \fIvalue\fP to a number option, or prepend the \fIvalue\fP to a
-string option. When the option is a comma separated list, a comma is added,
+string option.
+When the option is a comma separated list, a comma is added,
unless the value was empty.
.TP
.BI ":se[t] " var -= value
Subtract the \fIvalue\fP from a number option, or remove the \fIvalue\fP from
-a string option, if it is there. When the option is a comma separated list, a
+a string option, if it is there.
+When the option is a comma separated list, a
comma is deleted, unless the option becomes empty.
.TP
.BI ":se[t] " var ?
@@ -642,8 +664,9 @@ Show the current set value of variable
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
-list). This list is shared between the single instances of vimb. Only
-available if vimb has been compiled with QUEUE feature.
+list).
+This list is shared between the single instances of vimb.
+Only available if vimb has been compiled with QUEUE feature.
.TP
.BI ":qpu[sh] [" URI ]
Push \fIURI\fP or if not given current URI to the end of the queue.
@@ -659,34 +682,35 @@ queue.
Removes all entries from queue.
.SS 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 powerful. Use them
-with care and they will help you avoid typing many commands.
-.RS 0
-.TP
+event, such as a URI being opened.
+Autocommands are very powerful.
+Use them with care and they will help you avoid typing many commands.
+.PP
Autocommands are built with following properties.
.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
-[\fIgroup\fP]. Groups are useful to remove multiple grouped autocommands.
+[\fIgroup\fP].
+Groups are useful to remove multiple grouped autocommands.
.TP
.I event
-You can specify a comma separated list of event names. No white space can be
-used in this list.
+You can specify a comma separated list of event names.
+No white space can be used in this list.
.RS
.PP
.PD 0
Events:
.TP
.B LoadProvisional
-Fired if a new page is going to opened. No data has been received yet, the load
-may still fail for transport issues.
+Fired if a new page is going to opened.
+No data has been received yet, the load may still fail for transport issues.
.TP
.B 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 toggle content related setting like 'scripts', 'plugins' and
-such things.
+requirements are established, and the load is being performed.
+This is the right event to toggle content related setting
+like 'scripts', 'plugins' and such things.
.TP
.B LoadFirstLayout
fired if the first layout with actual visible content is shown.
@@ -699,57 +723,62 @@ Fired when some error occurred during the page load that prevented it from
being completed.
.TP
.B 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.
+Fired right before a download is started.
+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. For external download this event
-is not available.
+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. For external download this event
-is not available.
+Fired if a vimb managed download failed.
+For external download this event is not available.
.PD
.RE
.TP
.I 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 '\[char92],'.
+applies to the URI associated to an event.
+To use ',' within the single patterns this must be escaped as '\e,'.
.RS
.PP
.PD 0
Patterns:
.IP "\fB*\fP"
-Matches any sequence of characters. This includes also '/' in contrast to
-shell patterns.
+Matches any sequence of characters.
+This includes also '/' in contrast to shell patterns.
.IP "\fB?\fP"
Matches any single character except of '/'.
.IP "\fB{one,two}\fP"
-Matches 'one' or 'two'. Any '{', ',' and '}' within this pattern must be
-escaped by a '\\'. '*' and '?' have no special meaning within the curly braces.
-.IP "\fB\[char92]\fP"
+Matches 'one' or 'two'.
+Any '{', ',' and '}' within this pattern must be escaped by a '\\'.
+\&'*' and '?' have no special meaning within the curly braces.
+.IP "\fB\e\fP"
Use backslash to escape the special meaning of '?*{},' in the pattern or
pattern list.
.PD
.RE
.TP
.I cmd
-Any ex command vimb understands. The leading ':' is not required. Multiple
-commands can be separated by '|'.
+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
-\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.
+\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.
.TP
.BI ":au[tocmd]! [" group "] {" event "} {" pat "} {" cmd "}"
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. Vimb matches the
-autocommand pattern with \fIpat\fP. If [\fIgroup\fP] is not given, deletes
-autocommands in current group, as noted above.
+\fIpat\fP, and add the command \fIcmd\fP.
+Note that the pattern is not matches literally to find autocommands
+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.
.TP
.BI ":au[tocmd]! [" group "] {" event "} {" pat "}"
Remove all autocommands associated with \fIevent\fP and which pattern matches
@@ -767,13 +796,13 @@ by default).
Remove all autocommands in given group (current group by default).
.TP
.BI ":aug[roup] {" name "}"
-Define the autocmd group \fIname\fP for the following ":autocmd" commands. The name
-"end" selects the default group.
+Define the autocmd group \fIname\fP for the following ":autocmd" commands.
+The name "end" selects the default group.
.TP
.BI ":aug[roup]! {" name "}"
Delete the autocmd group \fIname\fP.
.PP
-Example
+Example:
.EX
:aug github
: au LoadCommited * set scripts=off|set cookie-accept=never
@@ -783,13 +812,15 @@ Example
.SS Misc
.TP
.BI ":sh[ellcmd] " cmd
-Runs given shell \fIcmd\fP syncron and print the output into inputbox.
-Following pattern in \fIcmd\fP are expanded, '~username', '~/', '$VAR'
-and '${VAR}'. A '\\' before these patterns disables the expansion.
+Runs the given shell \fIcmd\fP syncron and print the output into inputbox.
+The following patterns in \fIcmd\fP are expanded: '~username', '~/', '$VAR'
+and '${VAR}'.
+A '\\' before these patterns disables the expansion.
+.PP
.RS
.PP
.PD 0
-Following environment variables are set for called shell commands.
+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
@@ -818,19 +849,21 @@ Example:
.TP
.BI ":sh[ellcmd]! " cmd
Like :sh[ellcmd], but asyncron.
-
+.sp
Example:
.EX
:sh! /bin/sh -c 'echo "`date` $VIMB_URI" >> myhistory.txt'
.EE
.TP
.BI ":s[ave] [" path "]"
-Download current opened page into configured download directory. If \fIpath\fP
-is given, download under this file name or path. \fIpath\fP is expanded and
-can therefore contain '~/', '${ENV}' and '~user' pattern.
+Download current opened page into configured download directory.
+If \fIpath\fP is given, download under this file name or path.
+\fIpath\fP is expanded and can therefore contain '~/', '${ENV}'
+and '~user' pattern.
.TP
.B :q[uit]
-Close the browser. This will be refused if there are running downloads.
+Close the browser.
+This will be refused if there are running downloads.
.TP
.B :q[uit]!
Close the browser independent from an running download.
@@ -842,50 +875,52 @@ Display the contents of all registers.
.PD 0
Registers:
.TP
-.BR \[char34]a " - " \[char34]z
-26 named registers "a to "z. Vimb fills these registers only when you say so.
+.BR \(dqa " - " \(dqz
+26 named registers "a to "z.
+Vimb fills these registers only when you say so.
.TP
-.B \[char34]:
+.B \(dq:
Last executed ex command.
.TP
-.B \[char34]"
+.B \(dq"
Last yanked content.
.TP
-.B \[char34]%
+.B \(dq%
Curent opened URI.
.TP
-.B \[char34]/
+.B \(dq/
Last search phrase.
.TP
-.B \[char34];
-Contains the last hinted URL. This can be used in `x-hint-command' to get the
-URL of the hint.
+.B \(dq;
+Contains the last hinted URL.
+This can be used in `x-hint-command' to get the URL of the hint.
.PD
.RE
.TP
.BI :e[val] " javascript"
Runs the given \fIjavascript\fP in the current page and display the evaluated
value.
-
+.sp
Example: :eval document.cookie
.TP
.BI :e[val]! " javascript"
Like :eval, but there is nothing print to the input box.
.TP
.BI ":no[rmal] [" cmds ]
-Execute normal mode commands \fIcmds\fP. This makes it possible to execute
-normal mode commands typed on the input box.
-.br
-\fIcmds\fP cannot start with a space. Put a count of 1 (one) before it, "1 "
-is one space.
-
+Execute normal mode commands \fIcmds\fP.
+This makes it possible to execute normal mode commands typed on the input box.
+.sp
+\fIcmds\fP cannot start with a space.
+Put a count of 1 (one) before it, "1 " is one space.
+.sp
Example: :set scripts!|no! R
.TP
.BI ":no[rmal]! [" cmds ]
Like :normal, but no mapping is applied to \fIcmds\fP.
.TP
.B :ha[rdcopy]
-Print current document. Open a GUI dialog where you can select the printer,
+Print current document.
+Open a GUI dialog where you can select the printer,
number of copies, orientation, etc.
.SH INPUT MODE
.TP
@@ -905,13 +940,15 @@ Pass the next key press directly to gtk.
Enter the pass-through mode.
.SH COMPLETIONS
The completions are triggered by pressing `<Tab>` or `<S-Tab>` in the
-activated inputbox. Depending of the current inserted content different
-completions are started. The completion takes additional typed chars to filter
+activated inputbox.
+Depending of the current inserted content different completions are started.
+The completion takes additional typed chars to filter
the completion list that is shown.
.TP
.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
+inputbox.
+If there are given some sore chars the completion will lookup those
commands that starts with the given chars.
.TP
.B settings
@@ -920,11 +957,11 @@ inputbox and does also match settings that begins with already typed setting
prefix.
.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. Only
-those history items are shown, where the title or URI contains all tags.
-
-Example
+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.
+.sp
+Example:
.RS
.PD 0
.IP ":open foo bar<Tab>"
@@ -934,11 +971,12 @@ will complete only URIs that contain the words foo and bar.
.TP
.B bookmarks
The bookmark completion is similar to the history completion, but does match
-only the tags of the bookmarks. The bookmark completion ist started by `:open
-\fB!\fP` or `:tabopen \fB!\fP` and does a prefix search for all given words in
+only the tags of the bookmarks.
+The bookmark completion ist started by `:open \fB!\fP`
+or `:tabopen \fB!\fP` and does a prefix search for all given words in
the bookmark tags.
-
-Example
+.sp
+Example:
.RS
.PD 0
.IP ":open \fB!\fPfoo ba"
@@ -960,9 +998,9 @@ All settings listed below can be set with the `:set' command.
.SS Webkit-Settings
.TP
.B 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 transforms.
+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 transforms.
.TP
.B auto-load-images (bool)
Load images automatically.
@@ -992,29 +1030,31 @@ font.
Indicates if vimb prefetches domain names.
.TP
.B dom-paste (bool)
-Whether to enable DOM paste. If set to TRUE, document.execCommand("Paste")
+Whether to enable DOM paste.
+If set to TRUE, document.execCommand("Paste")
will correctly execute and paste content of the clipboard.
.TP
.B 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.
+Boolean property to control file access for file:// URIs.
+If this option is enabled every file:// will have its own security
+unique domain.
.TP
.B fontsize (int)
The default font size used to display text.
.TP
.B 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.
+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.
.TP
.B 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 asynchronously.
+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 asynchronously.
.TP
.B html5-local-storage (bool)
-Whether to enable HTML5 localStorage support. localStorage provides simple
-synchronous storage access.
+Whether to enable HTML5 localStorage support.
+localStorage provides simple synchronous storage access.
.TP
.B hyperlink-auditing (bool)
Enable or disable support for <a ping>.
@@ -1024,16 +1064,18 @@ Determines whether images should be automatically loaded or not.
.TP
.B 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.
+frames from non-HTTPS URIs.
+Only for webkit>=2.0.
.TP
.B 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.
+and plugins from non-HTTPS URIs.
+Only for webkit>=2.0.
.TP
.B 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.
+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.
.TP
.B javascript-can-access-clipboard (bool)
Whether JavaScript can access Clipboard.
@@ -1049,18 +1091,19 @@ fullscreen.
.TP
.B 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
+start media playback or load media.
+Setting it on requires a gesture by the
user to start playback, or to load the media.
.TP
.B 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.
+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.
.TP
.B 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.
+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.
.TP
.B minimumfontsize (int)
The minimum font size used to display text.
@@ -1072,21 +1115,23 @@ The font family used as the default for content using monospace font.
Default font size for the monospace font.
.TP
.B 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.
+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.
.TP
.B 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
+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 viewers.
.TP
.B print-backgrounds (bool)
Whether background images should be printed.
.TP
.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
+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
not allow a page to store data in the windows sessionStorage.
.TP
.B plugins (bool)
@@ -1117,9 +1162,11 @@ Enables the site-specific compatibility workarounds.
Enable or disable support for smooth scrolling.
.TP
.B 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
+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.
@@ -1129,21 +1176,21 @@ Whether to enable spell checking while typing.
.TP
.B spell-checking-languages (string)
The languages to be used for spell checking, separated by commas.
-
+.sp
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 Finland or pt_BR for Portuguese as written in
-Brazil.
-
+ISO-639 language code, and COUNTRY is an ISO-3166 country code.
+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.
.TP
.B tab-key-cycles-through-elements (bool)
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.
+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.
.TP
.B universal-access-from-file-uris (bool)
Whether to allow files loaded through file:// URIs universal access to all
@@ -1153,8 +1200,9 @@ pages.
The user-agent string used by WebKit.
.TP
.B 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.
+Enable or disable support for WebAudio on pages.
+WebAudio is an experimental proposal for allowing web pages
+to generate Audio WAVE data from JavaScript.
.TP
.B webgl (bool)
Enable or disable support for WebGL on pages.
@@ -1164,13 +1212,14 @@ Determines whether or not developer tools, such as the Web Inspector, are
enabled.
.TP
.B xssauditor (bool)
-Whether to enable the XSS auditor. This feature filters some kinds of
-reflective XSS attacks on vulnerable web sites.
+Whether to enable the XSS auditor.
+This feature filters some kinds of reflective XSS attacks
+on vulnerable web sites.
.SS Vimb-Settings
.TP
.B ca-bundle (string)
-The path to the crt file for the certificate validation. The given path is
-expanded with standard file expansion.
+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.
@@ -1195,17 +1244,18 @@ cookies)}.
Cookie timeout in seconds.
.TP
.B cookie-expire-time (int)
-Enforce expire-time on cookies. The default value `-1' keep expire-time as
-defined by server side. The value `0' convert all cookies as session-only
-cookies (`cookie-timeout' setting is used as for any other session-cookie). Any
-other value enforce the expire-time (the expire-time value will be the lower
-between server-side request and time defined with `cookie-expire-time').
+Enforce expire-time on cookies.
+The default value `-1' keep expire-time as defined by server side.
+The value `0' convert all cookies as session-only cookies
+(`cookie-timeout' setting is used as for any other session-cookie).
+Any other value enforce the expire-time (the expire-time value will be the
+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.
.RS
.TP
-Following additional environment variable are available:
+The following additional environment variable are available:
.PD 0
.TP
.B $VIMB_URI
@@ -1218,54 +1268,62 @@ 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 COOKIE feature.
.TP
.B $VIMB_USER_AGENT
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 with the response and only if the download was not
-start by the `:save' command or the `;s' hinting.
+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.
.TP
.B $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
+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.
-
+.PD
.PP
-Example
-.IP ":set download-command=/bin/sh -c \[char34]wget -c %s -O $VIMB_FILE --load-cookies $VIMB_COOKIES\[char34]"
+Example:
+.PD 0
+.IP ":set download-command=/bin/sh -c\
+ ""wget -c %s -O $VIMB_FILE --load-cookies $VIMB_COOKIES"""
.PD
.RE
.TP
.B 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}'.
+Path to the default download directory.
+If the directory is not set download will be written into current directory.
+The following pattern will be expanded if the download
+is started '~/', '~user', '$VAR' and '${VAR}'.
.TP
.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.
+used to handle downloads.
+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 in foreground.
+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
+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
-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.
-
+new headers.
+The format for the header list elements is `name[=[value]]'.
+.sp
+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.
+.sp
To use '=' within a header value the value must be quoted like shown in
Example for the Cookie header.
.RS
@@ -1280,19 +1338,22 @@ Header completely from request.
.TP
.B auto-response-header (list)
Prepend HTTP-Header to responses received from server, based on pattern
-matching. The purpose of this setting is to enforce some security setting in
-the client. For example, you could set Content-Security-Policy (see
+matching.
+The purpose of this setting is to enforce some security setting in the client.
+For example, you could set Content-Security-Policy (see
`http://www.w3.org/TR/CSP/') for implement a whitelist policy, or set
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
-applied. You could also specified differents headers for same pattern.
-
-The format is a list of `pattern header-list`. If `header-list` has not than
-one element, enclosing with QUOTE is mandatory: `"pattern header-list"`. The
-header-list format is the same as `header` setting.
+applied.
+You could also specified differents headers for same pattern.
+.sp
+The format is a list of `pattern header-list`.
+If `header-list` has not than one element, enclosing with QUOTE
+is mandatory: `"pattern header-list"`.
+The header-list format is the same as `header` setting.
.RS
.PP
Example:
@@ -1305,16 +1366,18 @@ Example:
.RE
.TP
.B hint-timeout (int)
-Timeout before automatically following a non-unique numerical hint. To disable
-auto fire of hints, set this value to 0.
+Timeout before automatically following a non-unique numerical hint.
+To disable auto fire of hints, set this value to 0.
.TP
.B hintkeys (string)
-The keys used to label and select hints. With its default value, each hint has
-a unique number which can be typed to select it, while all other characters
-are used to filter hints based on their text. With a value such as asdfg;lkjh,
+The keys used to label and select hints.
+With its default value, each hint has a unique number which can be typed
+to select it, while all other characters are used to filter hints based
+on their text.
+With a value such as asdfg;lkjh,
each hint is `numbered' based on the characters of the home row.
-Note that the hint matching by label built of hintkeys is case sensitive. In
-this vimb differs from some other browsers that show hint labels in upper
+Note that the hint matching by label built of hintkeys is case sensitive.
+In this vimb differs from some other browsers that show hint labels in upper
case, but match them lowercase.
.RS
To have upper case hint labels, it's possible to add following css to the
@@ -1323,8 +1386,8 @@ To have upper case hint labels, it's possible to add following css to the
.RE
.TP
.B 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.
+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.
.TP
.B home-page (string)
Homepage that vimb opens if started without a URI.
@@ -1354,21 +1417,24 @@ Font user in inputbox if error is shown.
Font used for inputbox.
.TP
.B 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.
+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.
.TP
.B 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'.
+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'.
.TP
.B 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"
+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"
.TP
.B proxy (bool)
Indicates if the environment variable `http_proxy' is evaluated.
@@ -1408,10 +1474,11 @@ Foreground of statusbar for untrusted https pages.
Statusbar font for untrusted https pages.
.TP
.B strict-focus (bool)
-Vimb checks if an editable element is focused and switch to input mode. If
-strict-focus is enabled, this isn't done for focused element on page load
+Vimb checks if an editable element is focused and switch to input mode.
+If strict-focus is enabled, this isn't done for focused element on page load
(without user interaction), instead the focus is removed from the focused
-element. Focus changed that appear after the page was completely loaded are
+element.
+Focus changed that appear after the page was completely loaded are
not affected by this setting.
.TP
.B strict-ssl (bool)
@@ -1425,14 +1492,16 @@ The time in milliseconds that is waited for a key code or mapped key sequence
to complete.
.TP
.B 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
+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.
.RS
.P
.PD 0
.IP ":set x-hint-command=50G"
-Not really useful. If the hint is fired, scroll to the middle of the page.
+Not really useful.
+If the hint is fired, scroll to the middle of the page.
.IP ":set x-hint-command=:sh! curl -e <C-R>% <C-R>;"
This fills the inputbox with the prefilled download command and replaces
`<C-R>%' with the current URI and `<C-R>;' with the URI of the hinted element.
@@ -1481,8 +1550,8 @@ This file can be used to run user scripts, that are injected into every paged
that is opened.
.TP
.I style.css
-File for userdefined css styles. These file is used if the config variable
-`stylesheet' is enabled.
+File for userdefined css styles.
+These file is used if the config variable `stylesheet' is enabled.
.PD
.RE
.TP
@@ -1495,15 +1564,15 @@ Directory where the control sockets are placed.
.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.
+`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. Note
-that an IPv6 address must appear in brackets if used with a port "[::1]:443".
+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
Example: "localhost,127.0.0.1,::1,fc00::/7,example.com:8080"
-.IP
.SH "REPORTING BUGS"
Report bugs to the main project page on https://github.com/fanglingsu/vimb/issues
.br