-
Notifications
You must be signed in to change notification settings - Fork 40
Vichrome User Manual
-
Commands
- ScrollDown
- ScrollUp
- ScrollLeft
- ScrollRight
- PageDown
- PageUp
- PageHalfDown
- PageHalfUp
- GoTop
- GoBottom
- Open
- OpenNewTab
- OpenNewWindow
- CloseCurTab
- NextSearch
- PrevSearch
- MoveToNextTab
- MoveToPrevTab
- ReloadTab
- BackHist
- ForwardHist
- GoCommandMode
- GoSearchModeForward
- GoSearchModeBackward
- GoLinkTextSearchMode
- GoFMode
- FocusOnFirstInput
- RestoreTab
- BackToPageMark
- NMap
- IMap
- Alias
- Escape
- FocusNextCandidate
- FocusPrevCandidate
- Search Mode
- f Mode
- Command Mode
- Options
- Key mapping / Command Aliases Customization
All of actions triggered by key stroke sequence(see Default Key Bindings) are a command. In other words, Vichrome assigns key sequences to a specific command.
Here's all commands list:
scroll the current page one step down.
none
the step size is defined by the option Scroll Step Size.
scroll the current page one step up.
none
step size is defined by the option Scroll Step Size.
scroll the current page one step left.
none
the step size is defined by the option Scroll Step Size.
scroll the current page one step right.
none
the step size is defined by the option Scroll Step Size.
scroll the current page one page down.
none
none
scroll the current page one page up.
none
none
scroll the current page a half page down.
none
none
scroll the current page a half page up.
none
none
Go to top of the current page
none
Horizontal position does not change with this command.
Go to bottom of the current page
none
Horizontal position does not change with this command.
open URL specified by the argument.
-i : Enter interactive open mode
URL to open
[example]
:Open http://www.google.com
- if this command is triggered with no arguments, the command would be ignored.
- URL is opened in the same tab
:OpenNewTab [options] URL1 URL2 ...
Create new tab and open URL specified by the argument.
-i : Enter interactive open mode
--background, -b : Open new tabs in background
--pinned, -p : Pin open tabs
URLs to open. You can specify 2 or more URLs.
[example]
:OpenNewTab http://www.google.com
:OpenNewTab --background --pinned http://mail.google.com http://www.google.com/reader http://www.twitter.com
:OpenNewTab --background
- if this command is triggered with no URLs, new tab would be created with default page specified by the setting Default New Tab Page.
Close the current focused tab.
none
none
:OpenNewWindow [options] URL1 URL2 ...
Create new window and open URL specified by the argument in new tabs.
--pop, -p : Pop out the current tab to the new window
URLs to open in new window. You can specify 2 or more URLs.
[example]
:OpenNewWindow http://www.google.com
:OpenNewWindow http://mail.google.com http://www.google.com/reader http://www.twitter.com
:OpenNewWindow --pop
- if this command is triggered with no URLs, new window would be created with default tab page specified by the setting Default New Tab Page.
Go to next search hit
none
- Before executing this command, a search command(EnterSearchModeForward / EnterSearchModeBackward) should be done.otherwise this command just ignored.
Go to previous search hit
none
- Before executing this command, a search command(EnterSearchModeForward / EnterSearchModeBackward) should be done.otherwise this command just ignored.
Change tab focus to the right side tab.
none
none
Change tab focus to the right side tab.
none
none
Reload current page
none
none
Back history
none
none
Forward history
none
none
Enter command mode
none
none
Enter search mode. the search direction is forward.
none
none
Enter search mode. the search direction is backward.
none
none
Enter linked-text search mode.this search mode searches only texts that have a link and focus it. With this mode you can search links and open it by pressing enter key.
none
none
Enter f-Mode.
--newtab : open links with new tab
--continuous : enable contious f-Mode. see also f-Mode
[Example]
:GoFMode --newtab --continuous
none
Focus on input text form which appears first in the current page.
none
none
Restores closed tab
none
none
Back position to specified page mark.
Page mark ID. if the argument is undefined, ID unnamed would be used.
[Example]
:BackToPageMark
with this example, position is moved to unnamed page mark.
:BackToPageMark a
with this example, position is moved to a page mark.
none
Assign the key sequence to the specified command. assigned key sequence only available in normal mode.
arg1 : key sequence
arg2 : command to be assigned
[Example]
:NMap <SPACE>g :Open http://www.google.com
with this example key sequence <SPACE>g is assigned to the command :Open http://www.google.com
- The key sequence set by this command won't be stored in local storage.So a key sequence defined by this command will be lost by shutting down Chrome or reloading Vichrome extension.
Same as NMap but assigned key sequence is only available in Insert mode
Same as NMap
Same as NMap
:Alias [alias] [command with arguments]
Assign alias to the command. See also alias setting.
arg1 : alias
arg2 : command to be assigned
[Example]
:Alias g :OpenNewTab http://www.google.com
with this example alias :g is assigned to the command :Open http://www.google.com
- The alias set by this command won't be stored in local storage.So an alias defined by this command will be lost by shutting down Chrome or reloading Vichrome extension.
Cancel all command, leave insert/search/command/f mode
none
none
Move focus to next candidate item in command mode.
none
- This command is only available for cmap, and therefore you can only use this by hitting cmapp-ed key in Command/Search mode
Move focus to previous candidate item in command mode.
none
- This command is only available for cmap, and therefore you can only use this by hitting cmapp-ed key in Command/Search mode
You can enter search mode with GoSearchModeForward or GoSearchModeBackward(key / or ? by default).
There's some options for search mode. see also Search Options.
With executing a command GoFMode(key f or F by default), Vichrome enters f Mode.
In f Mode you will see many hints on each link/input form.
with inputting string showed on hints Vichrome simulates to click the element.
Character showed on a hint is able to be customized. see also f Mode Keys
if you enter f-Mode with --newtab option, links will open in a new tab.
if you enter f-Mode with --continuous option, f-Mode will not exit when you hit a hint so you can continuously open 2 or more links.
Note that --continuous option may not work fine without --newtab option.
With executing a command GoCommandMode(key : by default), Vichrome enters command mode.
In command mode you can execute all commands listed up in Commands.
Scroll Step Size is used by ScrollDown,ScrollUp,ScrollLeft,ScrollRight.
[default]
40
This option decides how long Vichrome wait for next key pressing(milli second order) e.g. 2nd g of a key sequence gg in default key binding.
[default]
2000
This option decides what page Vichrome open when OpenNewTab('t' by default) is executed without arguments.
- Home : Chrome Home page set by Chrome setting
- Chrome New Tab : chrome://newtab
- Blank Page : about:blank
[Default]
Home
If this option is set to on, Vichrome will try to disable auto focus when page is opened
Note that this option is not always affected fine as this option is still beta. e.g. http://www.google.com
[default]
off
Enable smooth scroll feature
[default]
off
Enable completion in Command/Search mode
[default]
on
if this option is set to on, Vichrome moves to the first search result when "NextSearch" is triggered at the last of search results.
[default]
on
if this option is set to on, Incremental Search is enabled.
[default]
on
it this option is set to on, search mode ignores letter case.
[default]
on
This option decides minimum character count for incremental search. if this option is set to 2, incremental search do not start with first input but second input.
[default]
2
List of keys which is used for f Mode hints
[default]
fdsaghjklwertyuiovbcnm
patterns for URLs where Vichrome does not run.
you can use * as wild card.
[Example]
http*://*google.com/*
http*://*google.co.jp/*
with this example, Vichrome is disabled on all of the google.com and google.co.jp sites.
[default]
http*://mail.google.com/*
http*://www.google.com/reader/*
Position of Vicrome Command Box
[default]
Right Bottom
Width of Vichrome Command Box
[default]
350
Writing your own setting in Vichrome Option->Key Mapping, You can customize Vichrome key binding and make alias to any Vichrome commands as you like. In this option page, you can use nmap/imap/cmap/alias/pagecmd.
Using nmap and imap, you can define your own Vichrome key bindings.Here's some example and tips.
nmap is for normal mode mapping, imap is for insert mode, cmap is for command/search mode.
nmap d x
In default key setting, CloseCurTab command is assigned to key x.If you prefer to use this command with d, the above example works fine.the example means to assign d key to the same functionality as x.
And of course you can assign a key to a command directly:
nmap d :CloseCurTab
this example is completely same as the before example.Note that : before command name is required.
nmap <Space>tw :OpenNewTab http://www.twitter.com
You can also assign a key sequence to a command with arguments.this example assign <Space>tw to open twitter page with new tab.
nmap <C-o> :OpenNewTab
nmap <A-o> :OpenNewTab
nmap <M-o> :OpenNewTab
nmap <M-A-C-o> :OpenNewTab
you can use Control/Alt/Meta key like this example.Meta key means Windows key for PC,Command key
for Mac.
<NOP> key is ignored by Vichrome and is passed to Chrome's default key binding.
nmap <C-f> <NOP>
By default, <C-f> is assigned to :PageDown. If you want to use <C-f> for Chrome's default search(windows, linux), try this example.With the example, Vichrome remove <C-f> from its own keybinding therefore you can use Chrome's default key binding.
<DISCARD> key is ignored by both Vichrome and Chrome.
nmap <BS> <DISCARD>
By Chrome's default, <BS> is assigned to back page history. This example set <BS> to invalid key so <BS> will be just ignored both Vichrome and Chrome.
A command alias is a nickname of a command. Some commands' name are too long to write so you can create other name for a command.
alias ot OpenNewTab
this example create an alias ot which is the second name of OpenNewTab. With this setting, you can use ot instead of OpenNewTab in command mode.
Note that you DON'T need : before both command name and alias name
alias ext OpenNewTab chrome://extensions/
alias also accepts a command with arguments.this example means to create an alias ext which is same as OpneNewTab chrome://extensions/.With this example you can open Chrome's extensions page by typing ext in command mode.
[syntax]
pagecmd [target url] [nmap/imap/cmap/alias] [argumets] ...
pagecmd offers you a web page specific key mapping.
pagecmd http*://twitter.com* nmap f <NOP>
pagecmd http*://twitter.com* nmap r <NOP>
For example, twitter.com has some useful shortcut keys like f for favorite, r for reply.If you want to disable only f and r of vichrome key mapping on the twitter web page, the above example works perfectly.
Furthermore, pagecmd's priority is higher than Ignored URLs setting so if you want to use <C-l> and <C-h> for moving between tabs on any web pages and disable other key bindings on GMail, you can write your settings like this:
[Ignored URLs]
http*://mail.google.com/*
...
[Key Mapping/Aliases]
pagecmd * nmap <C-l> :MoveToNextTab
pagecmd * nmap <C-h> :MoveToPrevTab
# at the head of each line is treated as comment.
# This is comment
# This is comment
nmap o t # This is NOT comment
If you want to assign special keys, use the following key name.
- <C-x> : Control key + 'x' key
- <SPACE>
- <LEFT>
- <DOWN>
- <UP>
- <RIGHT>
- <CR>
- <BS>
- <DEL>
- <TAB>
- <F1>
- <F2>
- <F3>
- <F4>
- <F5>
- <F6>
- <F7>
- <F8>
- <F9>
- <F10>
- <F11>
- <F12>
- <ESC>
- <HOME>
- <END>
- <PAGEDOWN>
- <PAGEUP>
- <CAPSLOCK>
- <NOP>
- <DISCARD>
[Normal Mode]
- j : ScrollDown
- k : ScrollUp
- h : ScrollLeft
- l : ScrollRight
- <C-f> : PageDown
- <C-b> : PageUp
- <C-d> : PageHalfDown
- <C-u> : PageHalfUp
- gg : GoTop
- G : GoBottom
- t : OpenNewTab
- x : CloseCurTab
- n : NextSearch
- N : PrevSearch
- <C-l> : MoveToNextTab
- <C-h> : MoveToPrevTab
- r : ReloadTab
- H : BackHist
- L : ForwardHist
- : : GoCommandMode
- / : GoSearchModeForward
- ? : GoSearchModeBackward
- a : GoLinkTextSearchMode
- f : GoFMode
- F : GoFMode --newtab
- i : FocusOnFirstInput
- u : RestoreTab
- gp : OpenNewWindow --pop
- '' : BackToPageMark
- o : Open -i
- O : OpenNewTab -i
- <ESC> : Escape
- <C-[> : Escape
[Insert Mode]
- <ESC> : Escape
- <C-[> : Escape
[Search/Command Mode]
- : FocusNextCandidate
- : FocusPrevCandidate
- : FocusNextCandidate
- : FocusPrevCandidate
- : FocusNextCandidate
- : FocusPrevCandidate
[Command Aliases]
- o : Open
- ot OpenNewTab
- help : OpenNewTab http://github.com/k2nr/ViChrome/wiki/Vichrome-User-Manual
- map : NMap