-
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
- TabOpenNew
- WinOpenNew
- TabCloseCurrent
- NextSearch
- PrevSearch
- TabFocusNext
- TabFocusPrev
- TabFocusFirst
- TabFocusLast
- TabFocusNextHistory
- TabFocusPrevHistory
- TabSwitchLast
- TabCloseAll
- TabList
- TabReload
- TabReloadAll
- BackHist
- ForwardHist
- GoCommandMode
- GoSearchModeForward
- GoSearchModeBackward
- GoLinkTextSearchMode
- GoFMode
- GoExtFMode
- GoEmergencyMode
- FocusOnFirstInput
- RestoreTab
- BackToPageMark
- NMap
- IMap
- Alias
- OpenOptionPage
- Readability
- BarrelRoll
- HideJimmy
- Copy
- Escape
- FocusNextCandidate
- FocusPrevCandidate
- ToggleImageSize
- Search Mode
- f Mode
- Command Mode
- Emergency Mode
-
Options
-
Basics
- Scroll Step Size
- Command Wait Timeout Interval
- Default New Tab Page
- Disable auto focus when page is opened
- Smooth Scroll
- Enable Completion
- Search Engine
- Notify Update Succeeded (Open release history page in a new tab)
- Wrap Scan
- Incremental Search
- Ignore Case
- Minimum Length For Incremental Search
- Use Migemo Search
- Minimum Length For Migemo Search
- f Mode Keys
- Ignore Case for f-Mode
- Ignored URLs
- Appearance
-
Basics
- 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
-b : Same as -i option but given completion candidates are only bookmarks
-h : Same as -i option but given completion candidates are only history
-w : Same as -i option but given completion candidates are only web suggests
URL to open
[example]
:Open http://www.google.com
If :Open is executed with g, Vichrome opens Google search result page instead of opening URL.
[example]
:Open g vichrome
In the above example, google search result page will be opened.
Off cause you can use g prefix in interactive open mode(-i).
(in interactive mode)
g vichrome
Plus, g and -i can be used together.
:Open -i g
In this example, Interactive Open mode will start with google suggest showed up as completion candidate.
- if this command is triggered with no arguments, the command would be ignored.
- URL is opened in the same tab
:TabOpenNew [options] URL1 URL2 ...
Create new tab and open URL specified by the argument.
-i : Enter interactive open mode
-b : Same as -i option but given completion candidates are only bookmarks
-h : Same as -i option but given completion candidates are only history
-w : Same as -i option but given completion candidates are only web suggests
--background, -b : Open new tabs in background
--pinned, -p : Pin open tabs
--next : Open new tab next to the current tab
URLs to open. You can specify 2 or more URLs.
[example]
:TabOpenNew http://www.google.com
:TabOpenNew --background --pinned http://mail.google.com http://www.google.com/reader http://www.twitter.com
:TabOpenNew --background
Same as g of :Open.
- if this command is triggered with no URLs, new tab will be created with default page specified by the setting Default New Tab Page.
Close the current focused tab.
--focusprev : focus the previous tab after closing the focused tab
none
none
:WinOpenNew [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]
:WinOpenNew http://www.google.com
:WinOpenNew http://mail.google.com http://www.google.com/reader http://www.twitter.com
:WinOpenNew --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 specified tab index.
the index focus move to.the index starts from 1.If no arguments specified, tab focus will move to the right side tab.
none
Change tab focus to the left side tab.
none
none
Change tab focus to the first tab.
none
none
Change tab focus to the last tab.
none
none
Go forward the tab selected history.
none
none
Go backward the tab selected history.
none
none
Select the previously selected tab.
none
none
Close all tabs in the current window.
--only : do not close the current tab
none
none
Shows tab list with interactive dialog
none
none
none
Reload current page
none
none
Reload all tabs within the selected window.
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.
Enter extended f-Mode. In extended f-Mode, you can choose action for the hint by pressing key:
-
fto just focus the hint -
oto open link in the same tab -
Oto open link in new tab -
yto yank link address -
Yto yank link text
You can specify action by the following option without pressing successive key
--yank : yank link address
--open : open link in the same tab
--opentab : open link in new tab
none
Enter Emergency Mode.
none
none
Focus on input text form which appears first in the current page.
none
To focus on the Nth input text field, type the number N before the shortcut. eg. 2i for the second text field, 3i, for third input field, etc.
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 :TabOpenNew 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.
Opens Vichrome Option Page.
-k, --key : opens key mapping page directly.
none
none
Execute Readability Redux.
To use this command, Readability Redux must be installed and activated.
none
none
none
DO A BARREL ROLL !!!
none
none
none
Hides Jimmy. Sorry Jimmy, But actually I donated for wikipedia so please forgive me.
none
none
none
Copy specified text to clipboard.
syntax
:Copy [text]
text : text to copy to clipboard
useful variables are available:
-
%url: URL of a page that you are currently watching -
%title: A title of a page that you are currently watching
Example:
:Copy '%title - %url'
The above example is useful for e.g. tweeting a web page.
none
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 cmap-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 cmap-ed key in Command/Search mode
Toggles image display size if the current tab displays an image file.
none
none
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.
by executing a command GoCommandMode(key : by default), Vichrome enters command mode.
In command mode you can execute all commands listed up in Commands.
by executing a command GoEmergencyMode(key <C-ESC> by default), Vichrome enters emergency mode.
In emergency mode All Vichrome key bindings are disabled except for <C-ESC> to escape emergency mode and enter normal mode.
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 TabOpenNew('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
Search engine URL for web search(:Open,:TabOpenNew with g prefix)
[default]
www.google.com
If true, Vichrome notifies its major version update opening release history page in a new tab.
[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
if this option is set to on, Migemo Search is enabled.
[default]
off
This option decides minimum length for Migemo search. if this option is set to 2, migemo search do not start with first input but second input.
[default]
3
List of keys which is used for f Mode hints
[default]
fdsaghjklwertyuiovbcnm
If this option is set to on, f-Mode ignores letter case of inputted characters. And hint characters are always displayed as upper case.
[default]
off
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
Sets hint font size in f-Mode
[default]
10px
If true, Use f-Mode Animation (hint fade-in/fade-out)
[default]
on
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, imap, cmap and emap, 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 and emap is for emergency mode.
nmap d x
In default key setting, TabCloseCur 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 :TabCloseCurrent
this example is completely same as the before example.Note that : before command name is required.
nmap <Space>tw :TabOpenNew 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> :TabOpenNew
nmap <A-o> :TabOpenNew
nmap <M-o> :TabOpenNew
nmap <M-A-C-o> :TabOpenNew
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 TabOpenNew
this example create an alias ot which is the second name of TabOpenNew. With this setting, you can use ot instead of TabOpenNew in command mode.
Note that you DON'T need : before both command name and alias name
alias ext TabOpenNew chrome://extensions/
alias also accepts a command with arguments.this example means to create an alias ext which is same as TabOpneNew 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> :TabFocusNext
pagecmd * nmap <C-h> :TabFocusPrev
# 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>
Some keys can't be handled by Vichrome as the keys are handled by Chrome directly.
[Windows/Linux]
- <C-t>
- <C-T>
- <C-n>
- <C-N>
- <C-w>
- <C-W>
[Mac]
- <M-t>
- <M-T>
- <M-n>
- <M-N>
- <M-w>
- <M-W>
M- means Cmd key for Mac.
[Normal Mode]
- j : ScrollDown
- k : ScrollUp
- h : ScrollLeft
- l : ScrollRight
- <C-e> : ScrollDown
- <C-y> : ScrollUp
- <C-f> : PageDown
- <C-b> : PageUp
- <C-d> : PageHalfDown
- <C-u> : PageHalfUp
- gg : GoTop
- G : GoBottom
- t : TabOpenNew
- x : TabCloseCurrent
- X : TabCloseCurrent --focusprev
- n : NextSearch
- N : PrevSearch
- gt : TabFocusNext
- gT : TabFocusPrev
- <C-l> : TabFocusNext
- <C-h> : TabFocusPrev
- r : TabReload
- H : BackHist
- L : ForwardHist
- : : GoCommandMode
- / : GoSearchModeForward
- ? : GoSearchModeBackward
- a : GoLinkTextSearchMode
- f : GoFMode
- F : GoFMode --newtab
- ; : GoExtFMode
- i : FocusOnFirstInput
- yy : copyurl
- u : RestoreTab
- gp : WinOpenNew --pop
- '' : BackToPageMark
- o : Open -i
- O : TabOpenNew -i
- b : Open -b
- B : TabOpenNew -b
- s : Open -i g
- S : TabOpenNew -i g
- <C-^> : TabSwitchLast
- ,z : ToggleImageSize
- <ESC> : Escape
- <C-[> : Escape
- <C-ESC> : GoEmergencyMode
[Insert Mode]
- <C-l> : TabFocusNext
- <C-h> : TabFocusPrev
- <ESC> : Escape
- <C-[> : Escape
[Search/Command Mode]
- <TAB> : FocusNextCandidate
- <S-TAB> : FocusPrevCandidate
- <UP> : FocusNextCandidate
- <DOWN> : FocusPrevCandidate
[Emergency Mode]
- <ESC> : Escape
[Command Aliases]
- o : Open
- ot TabOpenNew
- help : TabOpenNew http://github.com/k2nr/ViChrome/wiki/Vichrome-User-Manual
- opt : OpenOptionPage
- map : NMap
- tabe : TabOpenNew
- tabnew : TabOpenNew
- tabn : TabFocusNext
- tabp : TabFocusPrev
- tabN : TabFocusPrev
- tabr : TabFocusFirst
- tabl : TabFocusLast
- tabc : TabCloseCurrent
- tabo : TabCloseAll --only
- tabs : TabList
- q : TabCloseAll
- copyurl : Copy %url
- copytitle : Copy %title