summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorrafa_99 <raroma09@gmail.com>2021-09-25 01:23:25 +0100
committerrafa_99 <raroma09@gmail.com>2021-09-25 01:23:25 +0100
commitb1518d7d72421cae4b157943dd07e2030a918289 (patch)
treeb882d71068852d0de1841b70e68a1ed104e640b4 /doc
parentbc11211ffb6ecc5bed00f144ab03cd8c770035a5 (diff)
Project branch off
Diffstat (limited to 'doc')
-rw-r--r--doc/neovimb.1 (renamed from doc/vimb.1)143
1 files changed, 62 insertions, 81 deletions
diff --git a/doc/vimb.1 b/doc/neovimb.1
index e2c6a40..f62f102 100644
--- a/doc/vimb.1
+++ b/doc/neovimb.1
@@ -1,27 +1,26 @@
.\" vim: ft=groff
-.TH VIMB 1 "DATE" "vimb/VERSION" "Vimb Manual"
+.TH neovimb 1 "DATE" "neovimb/VERSION" "neovimb Manual"
.SH NAME
-Vimb - Vim Browser - A modal web browser based on WebKit, inspired by Vim: the
-great editor.
+neovimb - Vim Browser - A modal web browser based on WebKit, inspired by vimb.
.
.
.SH SYNOPSIS
-.B vimb
+.B neovimb
.OP OPTIONS
.RI [ URI "|" file "|" - ]
.
.
.SH DESCRIPTION
-Vimb is a WebKit based web browser that behaves like the Vimperator
+neovimb 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
+The goal of neovimb 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, neovimb will open the configured
home-page.
-If \fIURI\fP is '-', Vimb reads the HTML to display from stdin.
+If \fIURI\fP is '-', neovimb reads the HTML to display from stdin.
.P
Mandatory arguments to long options are mandatory for short options too.
.TP
@@ -33,7 +32,7 @@ You could also pass several ex commands in one \fICMD\fP,
if they are separated by "|".
.sp
.EX
-vimb --cmd "set dark-mode=on|set header=Referer,DNT=1"
+neovimb --cmd "set dark-mode=on|set header=Referer,DNT=1"
.EE
.TP
.BI "\-c, \-\-config " "FILE"
@@ -42,7 +41,7 @@ This will also be applied on new spawned instances.
.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 neovimb will use as its parent.
.TP
.B "\-i, \-\-incognito"
Start an instance with user data read-only (see \fIFILES\fP section).
@@ -66,7 +65,7 @@ Prints information about used libraries for bug reports and then quit.
.
.
.SH MODES
-Vimb is modal and has the following main modes:
+neovimb is modal and has the following main modes:
.IP "Normal Mode"
The default mode.
Pressing Escape always enter normal mode.
@@ -76,9 +75,9 @@ Used for editing text elements in a webpage.
Execute `ex` commands from the builtin inputbox (commandline).
.IP "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.
+by neovimb, 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.
+be swallowed by neovimb.
.
.
.SH NORMAL MODE COMMANDS
@@ -100,7 +99,7 @@ Set cursor to the last focused element in the page and switch to Input Mode.
If no element was focused before the first element is focused like with `gi'.
.TP
.B CTRL\-Z
-Switch Vimb into Pass-Through Mode.
+Switch neovimb into Pass-Through Mode.
.TP
.B gf
Open the configured editor (`editor-command') with the current page's content.
@@ -233,7 +232,7 @@ Jumps to the position before the latest jump, or where the last "m'" command
was given.
.
.SS Hinting
-Hinting in Vimb is how you accomplish the tasks that you would do with the
+Hinting in neovimb 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 `hint-keys'.
@@ -319,16 +318,16 @@ Kill (remove) hinted element from the page.
.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 the QUEUE feature.
+This is only available if neovimb 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
`:qunshift' command.
-This is only available if Vimb was compiled with the QUEUE feature.
+This is only available if neovimb 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 neovimb.
.TP
.BI [ \(dqx ];y
Yank hint's destination location into primary and secondary clipboard and into
@@ -432,7 +431,7 @@ Yank the current selection into register x 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).
+into the inputbox (the command line of neovimb).
The commands may vary in their syntax or in the parts they allow,
but in general they follow a simple syntax.
.P
@@ -444,8 +443,6 @@ command.
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 interactivly are normally recorded into command
-history and register.
To avoid this, the commands can be prefixed by one or more additional `:' or
whitespace.
.P
@@ -554,7 +551,7 @@ Normal mode: when browsing normally.
Insert mode: when interacting with text fields on a website.
.TP
.B c
-Command Line mode: when typing into Vimb's command line.
+Command Line mode: when typing into neovimb's command line.
.PD
.P
Most keys in key sequences are represented simply by the character that you
@@ -665,7 +662,7 @@ 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'.
+Can be called `:open gh fanglingsu neovimb'.
.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'
@@ -717,7 +714,7 @@ Toggle the value of boolean variable \fIvar\fP and display the new set value.
.
.SS Queue
The queue allows the marking of URIs for later reading.
-This list is shared between the single instances of Vimb.
+This list is shared between the single instances of neovimb.
.TP
.BI ":qpu[sh] [" URI ]
Push \fIURI\fP or, if not given, the current URI to the end of the queue.
@@ -741,8 +738,8 @@ Use them with care and they will help you avoid typing many commands.
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
+When the [\fIgroup\fP] argument is not given, neovimb uses the current group as
+defined with ':augroup', otherwise, neovimb uses the group defined with
[\fIgroup\fP].
Groups are useful to remove multiple grouped autocommands.
.TP
@@ -775,10 +772,10 @@ Fires when everything that was required to display on the page has been loaded.
Fired right after a download is started.
.TP
.B DownloadFinished
-Fired if a Vimb managed download is finished.
+Fired if a neovimb managed download is finished.
.TP
.B DownloadFailed
-Fired if a Vimb managed download failed.
+Fired if a neovimb managed download failed.
.PD
.RE
.TP
@@ -806,14 +803,14 @@ pattern list.
.RE
.TP
.I cmd
-Any `ex` command vimb understands.
+Any `ex` command neovimb 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 neovimb 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
+neovimb 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 "}"
@@ -821,7 +818,7 @@ 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.
+neovimb matches the autocommand pattern with \fIpat\fP.
If [\fIgroup\fP] is not given, deletes autocommands in current group,
as noted above.
.TP
@@ -862,7 +859,7 @@ Asynchronously clears the website data of the given list of \fIdataTypes\fP
modified in the past \fItimespan\fP.
Note that the \fIdataTypes\fP must not contain spaces.
If \fItimespan\fP is not given, all website data will be removed.
-Note that this effects all running instances of vimb.
+Note that this effects all running instances of neovimb.
.RS
.P
.PD 0
@@ -944,7 +941,7 @@ Like :sh[ellcmd] but asynchronous.
.sp
Example:
.EX
-:sh! /bin/sh -c 'echo "`date` $VIMB_URI" >> myhistory.txt'
+:sh! /bin/sh -c 'echo "`date` $neovimb_URI" >> myhistory.txt'
.EE
.TP
.TP
@@ -959,24 +956,24 @@ A '\e' before these patterns disables the expansion.
.PD 0
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
+.B neovimb_URI
+This variable is set by neovimb everytime a new page is opened to the URI of the
page.
.TP
-.B VIMB_SELECTION
+.B neovimb_SELECTION
This variable is set to the current selected text on the page.
.TP
-.B VIMB_TITLE
+.B neovimb_TITLE
Contains the title of the current opened page.
.TP
-.B VIMB_PID
-Contains the pid of the running Vimb instance.
+.B neovimb_PID
+Contains the pid of the running neovimb instance.
.TP
-.B VIMB_WIN_ID
-Holds the X-Window id of the Vimb window.
+.B neovimb_WIN_ID
+Holds the X-Window id of the neovimb window.
.TP
-.B VIMB_XID
-Holds the X-Window id of the Vimb window or of the embedding window if Vimb is
+.B neovimb_XID
+Holds the X-Window id of the neovimb window or of the embedding window if neovimb is
compiled with XEMBED and started with the -e option.
.EE
.RE
@@ -986,7 +983,7 @@ Like :sh[ellcmd] but asynchronous.
.sp
Example:
.EX
-:sh! /bin/sh -c 'echo "`date` $VIMB_URI" >> myhistory.txt'
+:sh! /bin/sh -c 'echo "`date` $neovimb_URI" >> myhistory.txt'
.EE
.TP
.BI ":s[ave] [" path "]"
@@ -1014,7 +1011,7 @@ Registers:
.TP
.BR \(dqa " \(em " \(dqz
26 named registers "a to "z.
-Vimb fills these registers only when you say so.
+neovimb fills these registers only when you say so.
.TP
.B \(dq:
Last executed `ex` command.
@@ -1096,18 +1093,12 @@ 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.
.TP
-.B history
-The history of URIs is shown for the `:open ` and `:tabopen ` commands.
-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.
.RS
.IP ":open foo bar<Tab>"
will complete only URIs that contain the words foo and bar.
.RE
.TP
.B bookmarks
-The bookmark completion is similar to the history completion, but does match
-only the tags of the bookmarks.
The bookmark completion is started by `:open \fB!\fP`, `:tabopen \fB!\fP` or
`:bmr ` and does a prefix search for all given words in the bookmark tags.
.RS
@@ -1190,7 +1181,7 @@ font.
Default Full-Content zoom level in percent. Default is 100.
.TP
.B dns-prefetching (bool)
-Indicates if Vimb prefetches domain names.
+Indicates if neovimb prefetches domain names.
.TP
.B download-command (string)
A command with placeholder '%s' that will be invoked to download a URI in
@@ -1200,17 +1191,17 @@ case 'download-use-external' is enabled.
The following additional environment variable are available:
.PD 0
.TP
-.B $VIMB_URI
+.B $neovimb_URI
The URI of the current opened page, normally the page where the download was
started from, also known as referer.
.TP
-.B $VIMB_DOWNLOAD_PATH
+.B $neovimb_DOWNLOAD_PATH
Setting value of 'download-path' which would be used normally for downloads.
.PD
.P
.PD 0
-.IP ":set download-command=/bin/sh -c ""cd '$VIMB_DOWNLOAD_PATH' \
-&& curl -sLJOC - -e '$VIMB_URI' %s"""
+.IP ":set download-command=/bin/sh -c ""cd '$neovimb_DOWNLOAD_PATH' \
+&& curl -sLJOC - -e '$neovimb_URI' %s"""
.PD
.RE
.TP
@@ -1224,7 +1215,7 @@ started '~/', '~user', '$VAR' and '${VAR}'.
.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 neovimb will handle the download.
.TP
.B editor-command (string)
Command with placeholder '%s' called if form field is opened with $EDITOR to
@@ -1291,7 +1282,7 @@ Header completely from request.
.RE
.TP
.B hint-follow-last (bool)
-If on, vimb automatically follows the last remaining hint on the page.
+If on, neovimb automatically follows the last remaining hint on the page.
If off hints are fired only if enter is pressed.
.TP
.B hint-keys-same-length (bool)
@@ -1315,13 +1306,13 @@ the rules of numeric labeling. So that the ifrst char of the label will never
start with the '0'.
.IP
Note that the hint matching by label built of hint-keys is case sensitive.
-In this vimb differs from some other browsers that show hint labels in upper
+In this neovimb differs from some other browsers that show hint labels in upper
case, but match them lowercase.
.IP
To have upper case hint labels, it's possible to add following css to the
-`style.css' file in vimb's configuration directory.
+`style.css' file in neovimb's configuration directory.
.IP
-"span[vimbhint="label"] {text-transform: uppercase !important;}"
+"span[neovimbhint="label"] {text-transform: uppercase !important;}"
.TP
.B hint-match-element (bool)
If this is set to 'true' typed chars that are not part of the set 'hint-keys'
@@ -1329,13 +1320,8 @@ are used to filter hinted DOM elements by their text value.
If 'hint-keys' are set to chars instead of numbers it might be useful to
disable matching of the elements by 'hint-match-element=false'.
.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.
-This setting has no effect if option \-\-incognito is set.
-.TP
.B home-page (string)
-Homepage that vimb opens if started without a URI.
+Homepage that neovimb opens if started without a URI.
.TP
.B html5-database (bool)
Whether to enable HTML5 client-side SQL database support.
@@ -1431,7 +1417,7 @@ The font family used as the default for content using sans-serif font.
Determines whether or not JavaScript executes within a page.
.TP
.B scroll-step (int)
-Number of pixel vimb scrolls if 'j' or 'k' is used.
+Number of pixel neovimb scrolls if 'j' or 'k' is used.
.TP
.B scroll-multiplier (int)
Multiplier to increase the scroll distance if window is scrolled by mouse
@@ -1485,7 +1471,7 @@ CSS style applied to the status bar on https pages with trusted certificate.
CSS style applied to the status bar on https pages with untrusted certificate.
.TP
.B strict-ssl (bool)
-If 'on', vimb will not load a untrusted https site.
+If 'on', neovimb will not load a untrusted https site.
.TP
.B stylesheet (bool)
If 'on' the user defined styles-sheet is used.
@@ -1522,8 +1508,8 @@ enabled.
.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
+The command can be any neovimb command string.
+Note that the command is run through the mapping mechanism of neovimb so
it might change the behaviour by adding or changing mappings.
.RS
.P
@@ -1548,7 +1534,7 @@ Disabling can help with some older systems (ppc, ppc64, etc.) that don't have co
.
.SH FILES
.TP
-.IR $XDG_CONFIG_HOME/vimb[/PROFILE]
+.IR $XDG_CONFIG_HOME/neovimb[/PROFILE]
Directory for configuration data.
If executed with \fB-p \fIPROFILE\fR parameter, configuration is read from
this subdirectory.
@@ -1569,7 +1555,7 @@ These file is used if the config variable `stylesheet' is enabled.
.RE
.
.TP
-.IR $XDG_DATA_HOME/vimb[/PROFILE]
+.IR $XDG_DATA_HOME/neovimb[/PROFILE]
Directory for runtime data.
If executed with \fB-p \fIPROFILE\fR parameter, data files are written from
this subdirectory.
@@ -1584,15 +1570,11 @@ This file will not be touched if option \-\-incognito is set.
Holds the URIs of last closed browser windows.
This file will not be touched if option \-\-incognito is set.
.TP
-.I history
-This file holds the history of unique opened URIs.
-This file will not be touched if option \-\-incognito is set.
.TP
.I bookmark
This file holds the list of bookmarked URIs with tags.
.TP
.I command
-This file holds the history of commands and search queries performed via input
box.
This file will not be touched if option \-\-incognito is set.
.TP
@@ -1600,7 +1582,6 @@ This file will not be touched if option \-\-incognito is set.
Holds the read it later queue filled by `qpush'.
.TP
.I search
-This file holds the history of search queries.
This file will not be touched if option \-\-incognito is set.
.PD
.RE
@@ -1614,9 +1595,9 @@ HTTP_PROXY=localhost:8118.
.
.
.SH "REPORTING BUGS"
-Report bugs to the main project page on https://github.com/fanglingsu/vimb/issues
+Report bugs to the main project page on https://github.com/fanglingsu/neovimb/issues
.br
-or on the mailing list https://lists.sourceforge.net/lists/listinfo/vimb-users.
+or on the mailing list https://lists.sourceforge.net/lists/listinfo/neovimb-users.
.
.
.SH AUTHOR