1
0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-01-07 01:14:12 +01:00

Merge Vimperator's docs with Xulmus.

This commit is contained in:
Doug Kearns
2009-06-01 19:34:06 +10:00
parent 494cfc6e84
commit 0c5fde8ebf
26 changed files with 526 additions and 343 deletions

File diff suppressed because one or more lines are too long

View File

@@ -1,6 +1,4 @@
HEADER
|autocommands| +
heading:Automatic{nbsp}commands[autocommands]
Autocommands are a way to automatically execute code when certain events
happen.

View File

@@ -1,4 +1,4 @@
HEADER
heading:Browsing[surfing,browsing]
|surfing| |browsing| +
@@ -51,7 +51,7 @@ Each token is analyzed and in this order:
to set a custom name, you can change it with [c]:dialog searchengines[c].
3. Opened with the default search engine or keyword (specified with the
'defsearch' option) if the first word is no search engine ([c]:open linus
torvalds[c] opens a Google search for linux torvalds).
torvalds[c] opens a Google search for linus torvalds).
4. Passed directly to Songbird in all other cases ([c]:open www.osnews.com,
www.slashdot.org[c] opens OSNews in the current, and Slashdot in a new
background tab).
@@ -78,8 +78,8 @@ ________________________________________________________________________________
|T| +
||T||
________________________________________________________________________________
Open one or more URLs in a new tab based on current location. Works like
[m]t[m] but preselects current URL in the [c]:tabopen[c] query.
Show a [c]:tabopen[c] prompt containing the current URL. Useful if you want to
go somewhere by editing the URL of the current page.
________________________________________________________________________________
@@ -95,8 +95,24 @@ ________________________________________________________________________________
|O| +
||O||
________________________________________________________________________________
Open one or more URLs in the current tab based on current location. Works
like [m]o[m] but preselects current URL in the [c]:open[c] query.
Show an [c]:open[c] prompt containing the current URL. Useful if you want to
go somewhere by editing the URL of the current page.
________________________________________________________________________________
|:winopen| |:wopen| |:winedit|
||:wino[pen][!] [a][arg1][a], [a][arg2][a], ...|| +
||w||
________________________________________________________________________________
Just like [c]:tabopen[c] but opens the resulting web page(s) in a new window.
________________________________________________________________________________
|W| +
||W||
________________________________________________________________________________
Open one or more URLs in a new window based on current location. Works like
[m]w[m] but preselects current URL in the [c]:winopen[c] query.
________________________________________________________________________________
@@ -153,7 +169,7 @@ ________________________________________________________________________________
section:Navigating[navigating]
|H| |<C-o>| |CTRL-O| |:ba| |:back|
||:[count]ba[ck] [url]|| +
||:[count]ba[ck] [a][url][a]|| +
||:ba[ck]!|| +
||CTRL-o||
________________________________________________________________________________
@@ -164,7 +180,7 @@ ________________________________________________________________________________
|L| |<C-i>| |CTRL-i| |:fo| |:fw| |:forward|
||:[count]fo[rward] [url]|| +
||:[count]fo[rward] [a][url][a]|| +
||:fo[rward]!|| +
||CTRL-i||
________________________________________________________________________________
@@ -224,22 +240,22 @@ section:Reloading[reloading]
|r|
||r||
________________________________________________________________________________
Force reloading of the current page.
Force reloading of the current web page.
________________________________________________________________________________
|R|
||R||
________________________________________________________________________________
Force reloading of the current page skipping the cache.
Force reloading of the current web page skipping the cache.
________________________________________________________________________________
|:re| |:reload| +
||:re[load][!]||
________________________________________________________________________________
Reload current page. Forces reloading of the current page. If [!] is
given, skip the cache.
Reload current web page. Forces reloading of the current page. If [!] is given,
skip the cache.
________________________________________________________________________________
@@ -261,7 +277,13 @@ ________________________________________________________________________________
|:st| |:stop|
||:st[op]||
________________________________________________________________________________
Stop loading. Stop loading current web page.
Stop loading the current web page.
________________________________________________________________________________
|:stopa| |:stopall| +
||:stopa[ll]||
________________________________________________________________________________
Stop loading all web pages.
________________________________________________________________________________
section:Writing[writing,save-file]

View File

@@ -1,6 +1,4 @@
HEADER
|buffer| |document| +
heading:Buffer[buffer,document]
Xulmus holds exactly one buffer object for each tab. It is usually an
(X)HTML document with advanced features.
@@ -54,6 +52,14 @@ source of that document. When [!] is given, it is opened with the external
editor.
________________________________________________________________________________
|\| +
||\||
________________________________________________________________________________
Toggle between rendered and source view. Alternates the page in the current tab
between a normally rendered view and the internal editor source view.
________________________________________________________________________________
section:Motion{nbsp}commands[motion,scrolling]
|^| |0| +
@@ -123,6 +129,16 @@ set).
________________________________________________________________________________
|<Right>| |l| +
||[count]l||
________________________________________________________________________________
Scroll document to the right. If [count] is specified then move [count] times
as much to the right. +
If the document cannot scroll more, a beep is emitted (unless 'visualbell' is
set).
________________________________________________________________________________
|<C-d>| +
||[count]<C-d>||
________________________________________________________________________________
@@ -141,16 +157,6 @@ first set to this value.
________________________________________________________________________________
|<Right>| |l| +
||[count]l||
________________________________________________________________________________
Scroll document to the right. If [count] is specified then move [count] times
as much to the right. +
If the document cannot scroll more, a beep is emitted (unless 'visualbell' is
set).
________________________________________________________________________________
|<S-Space>| |<PageUp>| |<C-b>| +
||[count]<C-b>||
________________________________________________________________________________
@@ -233,9 +239,12 @@ zoom range (default: 30%--300%). The zoom levels are used by
default zoom levels are 30%, 50%, 67%, 80%, 90%, 100%, 110%, 120%, 133%, 150%,
170%, 200%, 240%, 300%.
The available zoom range can be changed by setting the \'zoom.minPercent' and
\'zoom.maxPercent' Songbird preferences. The zoom levels can be changed using
the \'toolkit.ZoomManager.zoomLevels' preference.
The available zoom range can be changed by setting the
\'http://kb.mozillazine.org/Zoom.minPercent[zoom.minPercent]' and
\'http://kb.mozillazine.org/Zoom.maxPercent[zoom.maxPercent]' Firefox
preferences. The zoom levels can be changed using the
\'http://kb.mozillazine.org/Toolkit.zoomManager.zoomValues[toolkit.ZoomManager.zoomLevels]'
preference.
Note: \'toolkit.ZoomManager.zoomLevels' is specified as a list of values
between 0 and 1, not as a percentage.
@@ -271,7 +280,7 @@ ________________________________________________________________________________
|zz| +
||[count]zz||
________________________________________________________________________________
Set text zoom value of current web page. Zoom value can be between 30 and 300%.
Set text zoom value of current web page. Zoom value can be between 30% and 300%.
If it is omitted, text zoom is reset to 100%.
________________________________________________________________________________
@@ -317,13 +326,21 @@ ________________________________________________________________________________
||:zo[om][!] +{value} | -{value}|| +
________________________________________________________________________________
Set zoom value of current web page. [a][value][a] can be an absolute value
between 30 and 300% or a relative value if prefixed with "-" or "+". If
between 30% and 300% or a relative value if prefixed with "-" or "+". If
[a][value][a] is omitted, zoom is reset to 100%.
Normally this command operates on the text zoom; if used with [!], it
operates on full zoom.
________________________________________________________________________________
section:Working{nbsp}with{nbsp}frames[frames]
|:frameo| |:frameonly|
||:frameo[nly]|| +
________________________________________________________________________________
Show only the current frame's page.
________________________________________________________________________________
section:Copying{nbsp}text[copying,yanking]
When running in X11, the text of the following commands is not only

View File

@@ -1,9 +1,7 @@
HEADER
heading:Command-line{nbsp}mode[Command-line-mode,Command-line,mode-cmdline]
|Command-line-mode| |Command-line| |mode-cmdline| +
Command-line mode is used to enter Ex commands (":") and text search patterns
("/" and "?").
Command-line mode is used to enter Ex commands ("[m]:[m]") and text search patterns
("[m]/[m]" and "[m]?[m]").
|:| +
||:||
@@ -25,7 +23,7 @@ ________________________________________________________________________________
|c_<C-]>| +
||<C-]>||
________________________________________________________________________________
Expand a Command-line abbreviation.
Expand a command-line abbreviation.
________________________________________________________________________________

View File

@@ -1,4 +1,4 @@
HEADER
heading:Developer{nbsp}information[developer-information]
section:Writing{nbsp}documentation[writing-docs,documentation]

View File

@@ -1,6 +1,4 @@
HEADER
|expression| |expr| |eval| +
heading:Expression{nbsp}evaluation[expression,expr,eval]
INTRO TO BE WRITTEN...
@@ -70,7 +68,7 @@ ________________________________________________________________________________
________________________________________________________________________________
Sets or lists a variable. Sets the variable {var-name} to the value of the
expression {expr1}. If no expression is given, the value of the variable is
displayed.Without arguments, displays a list of all variables.
displayed. Without arguments, displays a list of all variables.
________________________________________________________________________________

View File

@@ -1,6 +1,4 @@
HEADER
|gui| +
heading:Vimperator's{nbsp}GUI[gui]
Although Xulmus offers the most frequently used Songbird functionality via
Ex and Normal mode commands there may be times when directly accessing the GUI

View File

@@ -1,21 +1,24 @@
HEADER
heading:Hints[quick-hints,hints]
|quick-hints| |hints| +
INTRO TO BE WRITTEN...
Hints are the way in which Vimperator allows you to follow links on a page. By
providing each link with a suitable hint, you can access all links with a
similar amount of minimal effort. This contrasts strongly with the traditional
approaches offered by the mouse, in which you must first find and then aim for
the link you would like, and by using repeated tabbing which quickly becomes
tedious unless you always visit the first link on a page.
|f| +
||#f#{hint}||
________________________________________________________________________________
Start QuickHint mode. In QuickHint mode, every hintable item (according to the
'hinttags' XPath query) is assigned a unique number. You can now either type
this number or type any part of the URL which you want to follow, and it is
followed as soon as it can be uniquely identified. Often it can be useful to
combine these techniques to narrow down results with some letters, and then
typing a single digit to make the match unique. Pressing [m]<Leader>[m]
(defaults to [c]:let mapleader = "\"[c]) toggles "escape-mode", where numbers
are treated as normal text. +
[m]<Esc>[m] stops this mode at any time.
'hinttags' XPath query) is assigned a unique number. You can either type
this number or type part of the link text as specified by the 'hintmatching'
option, and it is followed as soon as it can be uniquely identified. Often it
can be useful to combine these techniques to narrow down results with some
letters, and then typing a single digit to make the match unique. Pressing
[m]<Leader>[m] (defaults to [c]:let mapleader = "\"[c]) toggles "escape-mode",
where numbers are treated as normal text. + [m]<Esc>[m] stops this mode at any
time.
________________________________________________________________________________
@@ -59,6 +62,9 @@ hint mode. Then press [a]24[a] to copy the hint location.
* |;V| [m]V[m] to view its destination source in the external editor
* |;y| [m]y[m] to yank its destination location
* |;Y| [m]Y[m] to yank its text description
* |;c| [m]c[m] to open its context menu
* |;i| [m]i[m] to open an image
* |;I| [m]I[m] to open an image in a new tab.
Hintable elements for all extended hint modes can be set in the
'extendedhinttags' XPath string.

View File

@@ -1,9 +1,8 @@
heading:Index[index]
This file contains a list of all available commands, mappings and options.
HEADER
|index| +
This file contains a list of all available commands.
section:Player{nbsp}mode[player-index]
||[m]x[m]|| Play the current track +
@@ -49,7 +48,7 @@ section:Normal{nbsp}mode[normal-index]
||[m]<C-^>[m]|| Select the alternate tab or the [count]th tab +
||[m]<C-a>[m]|| Increment last number in URL +
||[m]<C-b>[m]|| Scroll up a full page +
||[m]<C-c>[m]|| Stop loading +
||[m]<C-c>[m]|| Stop loading the current web page +
||[m]<C-d>[m]|| Scroll window downwards in the buffer +
||[m]<C-f>[m]|| Scroll down a full page +
||[m]<C-g>[m]|| Print the current file name +
@@ -85,6 +84,7 @@ section:Normal{nbsp}mode[normal-index]
||[m]R[m]|| Reload while skipping the cache +
||[m]T[m]|| Open one or more URLs in a new tab, based on current location +
||[m]Y[m]|| Copy selected text or current word +
||[m]W[m]|| Open one or more URLs in a new window, based on current location +
||[m]a[m]|| Open a prompt to bookmark the current URL +
||[m]b[m]|| Open a prompt to switch buffers +
@@ -100,10 +100,11 @@ section:Normal{nbsp}mode[normal-index]
||[m]o[m]|| Open one or more URLs +
||[m]p[m]|| Open (put) a URL based on the current clipboard contents in the current buffer +
||[m]q[m]|| Record a key sequence into a macro +
||[m]r[m]|| Reload current page +
||[m]r[m]|| Reload current web page +
||[m]t[m]|| Open one or more URLs in a new tab +
||[m]u[m]|| Undo closing of a tab +
||[m]y[m]|| Yank current location to the clipboard +
||[m]w[m]|| Open one or more URLs in a new window +
||[m];[m]|| Start an extended hint mode +
@@ -111,6 +112,8 @@ section:Normal{nbsp}mode[normal-index]
||[m]~[m]|| Open home directory +
||[m]\[m]|| Toggle between rendered and source view +
||[m]/[m]|| Search forward for a pattern +
||[m]?[m]|| Search backwards for a pattern +
||[m]*[m]|| Find word under cursor +
@@ -123,6 +126,7 @@ section:Normal{nbsp}mode[normal-index]
||[m]@[m]|| Play a macro +
||[m].[m]|| Repeat the last keyboard command +
||[m]@:[m]|| Repeat the last Ex command [count] times +
||[m]]f[m]|| Focus next frame +
||[m][f[m]|| Focus previous frame +
@@ -217,7 +221,7 @@ section:Ex{nbsp}commands[ex-cmd-index,:index]
||[c]:delmarks[c]|| Delete the specified marks +
||[c]:delqmarks[c]|| Delete the specified QuickMarks +
||[c]:delstyle[c]|| Delete any matching styles +
||[c]:dialog[c]|| Open a undefined dialog +
||[c]:dialog[c]|| Open a Songbird dialog +
||[c]:doautoall[c]|| Apply the autocommands matching the specified URL to all buffers +
||[c]:doautocmd[c]|| Apply the autocommands matching the specified URL to the current buffer +
||[c]:downloads[c]|| Show progress of current downloads +
@@ -230,6 +234,7 @@ section:Ex{nbsp}commands[ex-cmd-index,:index]
||[c]:execute[c]|| Execute the argument as an Ex command +
||[c]:exusage[c]|| List all Ex commands with a short description +
||[c]:finish[c]|| Stop sourcing a script file +
||[c]:frameonly[c]|| Show only the current frame's page +
||[c]:forward[c]|| Go forward in the browser history +
||[c]:hardcopy[c]|| Print current document +
||[c]:help[c]|| Display help +
@@ -252,6 +257,7 @@ section:Ex{nbsp}commands[ex-cmd-index,:index]
||[c]:mark[c]|| Mark current location within the web page +
||[c]:marks[c]|| Show all location marks of current web page +
||[c]:messages[c]|| Display previously given messages +
||[c]:messclear[c]|| Clear the message history +
||[c]:mkxulmusrc[c]|| Write current key mappings and changed options to the config file +
||[c]:nohlsearch[c]|| Remove the search highlighting +
||[c]:noremap[c]|| Map a key sequence without remapping keys +
@@ -266,11 +272,11 @@ section:Ex{nbsp}commands[ex-cmd-index,:index]
||[c]:qmark[c]|| Mark a URL with a letter for quick access +
||[c]:qmarks[c]|| Show all QuickMarks +
||[c]:quit[c]|| Quit current tab +
||[c]:quitall[c]|| Quit undefined +
||[c]:quitall[c]|| Quit Xulmus +
||[c]:redraw[c]|| Redraw the screen +
||[c]:reload[c]|| Reload current page +
||[c]:reload[c]|| Reload the current web page +
||[c]:reloadall[c]|| Reload all tab pages +
||[c]:restart[c]|| Force undefined to restart +
||[c]:restart[c]|| Force Xulmus to restart +
||[c]:runtime[c]|| Source the specified file from each directory in 'runtimepath' +
||[c]:saveas[c]|| Save current document to disk +
||[c]:scriptnames[c]|| List all sourced script names +
@@ -280,8 +286,10 @@ section:Ex{nbsp}commands[ex-cmd-index,:index]
||[c]:silent[c]|| Execute a command silently +
||[c]:style[c]|| Style Xulmus and web sites +
||[c]:source[c]|| Read Ex commands from a file +
||[c]:stop[c]|| Stop loading +
||[c]:stop[c]|| Stop loading the current web page +
||[c]:stopall[c]|| Stop loading all tab pages +
||[c]:tab[c]|| Execute a command and tell it to output in a new tab +
||[c]:tabdo[c]|| Execute a command in each tab +
||[c]:tabdetach[c]|| Detach current tab to its own window +
||[c]:tabduplicate[c]|| Duplicate current tab +
||[c]:tablast[c]|| Switch to the last tab +
@@ -300,6 +308,8 @@ section:Ex{nbsp}commands[ex-cmd-index,:index]
||[c]:version[c]|| Show version information +
||[c]:viewsource[c]|| View source code of current document +
||[c]:viusage[c]|| List all mappings with a short description +
||[c]:winclose[c]|| Close window +
||[c]:winopen[c]|| Open one or more URLs in a new window +
||[c]:wqall[c]|| Save the session and quit +
||[c]:zoom[c]|| Set zoom value of current web page +
@@ -307,18 +317,21 @@ section:Options[option-index]
||'activate'|| Define when tabs are automatically activated +
||'cdpath'|| List of directories searched when executing [c]:cd[c] +
||'complete'|| Items which are completed at the [c]:[tab]open prompt[c] +
||'complete'|| Items which are completed at the [c]:[tab]open[c] prompt +
||'defsearch'|| Set the default search engine +
||'editor'|| Set the external text editor +
||'encoding'|| Changes the character encoding of the current buffer +
||'errorbells'|| Ring the bell when an error message is displayed +
||'eventignore'|| List of autocommand event names which should be ignored +
||'exrc'|| Allow reading of an RC file in the current directory +
||'extendedhinttags'|| XPath string of hintable elements activated by [m];[m] +
||'fileencoding'|| Changes the character encoding that Vimperator uses to read and write files +
||'focuscontent'|| Try to stay in Normal mode after loading a web page +
||'followhints'|| Change the behaviour of [m]<Return>[m] in Hints mode +
||'fullscreen'|| Show the current window fullscreen +
||'guioptions'|| Show or hide certain GUI elements like the menu or toolbar +
||'helpfile'|| Name of the main help file +
||'hintinputs'|| How text input fields are hinted +
||'hintmatching'|| How links are matched +
||'hinttags'|| XPath string of hintable elements activated by [m]f[m] and [m]F[m] +
||'hinttimeout'|| Timeout before automatically following a non-unique numerical hint +

View File

@@ -1,6 +1,4 @@
HEADER
|Insert-mode| |Insert| |mode-insert| +
heading:Insert{nbsp}mode[Insert-mode,Insert,mode-insert]
Insert mode is used to enter text in text boxes and text areas. When
'insertmode' is set, focusing on a text area immediately switches to

View File

@@ -89,7 +89,7 @@ section:Features[features]
with support for Songbird keyword bookmarks and search engines
* Count supported for many commands ([m]3<C-o>[m] will go back 3 pages)
* Beep on errors
* Marks support ([m]ma[m] to set mark a on a web page, [m]'a[m] to go there)
* Marks support ([m]m[m][a]a[a] to set mark a on a web page, [m]'[m][a]a[a] to go there)
* QuickMarks support (quickly go to previously marked web pages with [m]go[m][a]\\{a-zA-Z0-9\\}[a])
* [c]:map[c] and [c]:command[c] support (and feedkeys() for script writers)
* [c]:time[c] support for profiling
@@ -101,10 +101,13 @@ section:Features[features]
section:Contact[contact]
Please send comments/bug reports/patches to the mailing list, where I will
properly answer any questions. You can also join the #vimperator IRC channel
on irc.freenode.net or check the Wiki for frequently asked questions. Make
sure, you have read the TODO file first, as I am aware of many things which
can be improved when I find time for it or get patches.
Please send comments/bug reports/patches to the mailing list, where we will
properly answer any questions. You can also join the
+++<a href="irc://irc.freenode.net/vimperator">#vimperator</a>+++ IRC channel
on http://www.freenode.net/[Freenode] or check the
http://vimperator.org/trac/wiki/Xulmus/Wiki[Wiki] for
http://vimperator.org/trac/wiki/Xulmus/FAQ[frequently asked questions
(FAQ)]. Make sure, you have read the TODO file first, as we are aware of many
things which can be improved when we find time for it or receive patches.
// vim: set filetype=asciidoc:

View File

@@ -1,6 +1,4 @@
HEADER
Key mappings, abbreviations, and user-defined commands.
heading:Key{nbsp}mappings,{nbsp}abbreviations,{nbsp}and{nbsp}user-defined{nbsp}commands.[]
section:Key{nbsp}mapping[key-mapping,mapping,macro]
@@ -8,14 +6,144 @@ The key mapping commands can be used to either redefine the standard key
bindings or define new ones. A mapping consists of a key, or sequence of keys,
which are translated to a string of characters. Example:
:map <F2> :echo new Date().toDateString()<CR>
\{nbsp}[c]:map <F2> :echo new Date().toDateString()<CR>[c]
will echo the current date to the command line when [m]<F2>[m] is pressed.
There are separate key mapping tables for each of the Normal, Insert, and
Command-line modes.
|:map-special-chars| +
Please note that, unlike Vim and other applications, mappings containing
the Shift key are specified with the capital letter, so e.g. [m]<C-n>[m] is
different from [m]<C-N>[m], the latter being the only way to map Shift-Ctrl-n.
subsection:Map{nbsp}commands[:map-commands]
|:map|
||:map {lhs} {rhs}|| +
|:nm| |:nmap|
||:nm[ap] {lhs} {rhs}|| +
|:vm| |:vmap|
||:vm[ap] {lhs} {rhs}|| +
|:im| |:imap|
||:im[ap] {lhs} {rhs}|| +
|:cm| |:cmap|
||:cm[ap] {lhs} {rhs}|| +
________________________________________________________________________________
Map the key sequence {lhs} to {rhs} for the applicable mode(s). The {rhs} is
remapped, allowing for nested and recursive mappings.
Warning: Mappings are NOT saved between sessions, make sure you put them in your
vimperatorrc file!
________________________________________________________________________________
|:no| |:noremap|
||:no[remap] {lhs} {rhs}|| +
|:nn| |:nnoremap|
||:nn[oremap] {lhs} {rhs}|| +
|:vn| |:vnoremap|
||:vn[oremap] {lhs} {rhs}|| +
|:ino| |:inoremap|
||:ino[remap] {lhs} {rhs}|| +
|:cno| |:cnoremap|
||:cno[remap] {lhs} {rhs}|| +
________________________________________________________________________________
Map the key sequence {lhs} to {rhs} for the applicable mode(s). No remapping of
the {rhs} is performed.
________________________________________________________________________________
|:unm| |:unmap|
||:map {lhs} {rhs}|| +
|:nun| |:nunmap|
||:nun[map] {lhs} {rhs}|| +
|:vun| |:vunmap|
||:vun[map] {lhs} {rhs}|| +
|:iu| |:iunmap|
||:iu[nmap] {lhs} {rhs}|| +
|:cu| |:cunmap|
||:cu[nmap] {lhs} {rhs}|| +
________________________________________________________________________________
Remove the mapping of {lhs} for the applicable mode(s).
________________________________________________________________________________
|:mapc| |:mapclear|
||:mapc[lear]|| +
|:nmapc| |:nmapclear|
||:nmapc[lear]|| +
|:vmapc| |:vmapclear|
||:vmapc[lear]|| +
|:imapc| |:imapclear|
||:imapc[lear]|| +
|:cmapc| |:cmapclear|
||:cmapc[lear]|| +
________________________________________________________________________________
Remove all mappings for the applicable mode(s). All user-defined mappings are
cleared.
________________________________________________________________________________
|:map|
||:map|| +
|:nm| |:nmap|
||:nm[ap]|| +
|:vm| |:vmap|
||:vm[ap]|| +
|:im| |:imap|
||:im[ap]|| +
|:cm| |:cmap|
||:cm[ap]|| +
________________________________________________________________________________
List all mappings for the applicable mode(s).
________________________________________________________________________________
|:map|
||:map {lhs}|| +
|:nm| |:nmap|
||:nm[ap] {lhs}|| +
|:vm| |:vmap|
||:vm[ap] {lhs}|| +
|:im| |:imap|
||:im[ap] {lhs}|| +
|:cm| |:cmap|
||:cm[ap] {lhs}|| +
________________________________________________________________________________
List all mappings starting with {lhs} for the applicable mode(s).
________________________________________________________________________________
subsection:Special{nbsp}arguments{nbsp}[:map-arguments]
|:map-<silent>| +
When the first argument to one of the mapping commands is [c]<silent>[c], {rhs}
is not echoed to the command line, nor, for that matter, anything else until
the command has completed.
subsection:Mapping{nbsp}and{nbsp}modes[:map-modes]
Keys can be mapped in four distinct modes:
* Normal mode
* Visual mode
* Insert mode
* Command-line mode
|map-overview| |map-modes| +
Below is an overview of which modes each map command applies to:
// TODO: table format
:map :noremap :unmap :mapclear - both Normal and Visual modes
:nmap :nnoremap :nunmap :nmapclear - Normal mode
:vmap :vnoremap :vunmap :vmapclear - Visual mode
:imap :inoremap :iunmap :imapclear - Insert mode
:cmap :cnoremap :cunmap :cmapclear - Command-line mode
subsection:Special{nbsp}characters[:map-special-chars]
|<Nop>| +
||<Nop>||
@@ -48,128 +176,6 @@ it works like +
\{nbsp}[c]:map ,h :echo "Hello"<CR>[c]
________________________________________________________________________________
|:map|
||:map {lhs} {rhs}|| +
||:map {lhs}|| +
||:map||
________________________________________________________________________________
Map the key sequence {lhs} to {rhs}. The {rhs} is remapped, allowing for
nested and recursive mappings.
Warning: Mappings are NOT saved between sessions, make sure you put them in your
xulmusrc file!
________________________________________________________________________________
|:cm| |:cmap|
||:cmap {lhs} {rhs}|| +
||:cmap {lhs}|| +
||:cmap||
________________________________________________________________________________
Map the key sequence {lhs} to {rhs} (in Command-line mode). The {rhs} is
remapped, allowing for nested and recursive mappings.
Warning: Mappings are NOT saved between sessions, make sure you put them in your
xulmusrc file!
________________________________________________________________________________
|:im| |:imap|
||:imap {lhs} {rhs}|| +
||:imap {lhs}|| +
||:imap||
________________________________________________________________________________
Map the key sequence {lhs} to {rhs} (in Insert mode). The {rhs} is remapped,
allowing for nested and recursive mappings.
Warning: Mappings are NOT saved between sessions, make sure you put them in your
xulmusrc file!
________________________________________________________________________________
|:mapc| |:mapclear| +
||:mapc[lear]||
________________________________________________________________________________
Remove all mappings. All user-defined mappings which were set by [c]:map[c] or
[c]:noremap[c] are cleared.
________________________________________________________________________________
|:cmapc| |:cmapclear| +
||:cmapc[lear]||
________________________________________________________________________________
Remove all mappings (in Command-line mode). All user-defined mappings which
were set by [c]:cmap[c] or [c]:cnoremap[c] are cleared.
________________________________________________________________________________
|:imapc| |:imapclear| +
||:imapc[lear]||
________________________________________________________________________________
Remove all mappings (in Insert mode). All user-defined mappings which were set
by [c]:imap[c] or [c]:inoremap[c] are cleared.
________________________________________________________________________________
|:no| |:noremap| +
||:no[remap] {lhs} {rhs}|| +
||:no[remap] {lhs}|| +
||:no[remap]||
________________________________________________________________________________
Map the key sequence {lhs} to {rhs}. No remapping of the {rhs} is performed.
________________________________________________________________________________
|:cno| |:cnoremap| +
||:cno[remap] {lhs} {rhs}|| +
||:cno[remap] {lhs}|| +
||:cno[remap]||
________________________________________________________________________________
Map the key sequence {lhs} to {rhs} (in Command-line mode). No remapping of
the {rhs} is performed.
________________________________________________________________________________
|:ino| |:inoremap| +
||:ino[remap] {lhs} {rhs}|| +
||:ino[remap] {lhs}|| +
||:ino[remap]||
________________________________________________________________________________
Map the key sequence {lhs} to {rhs} (in Insert mode). No remapping of the
{rhs} is performed.
________________________________________________________________________________
|:map-<silent>| +
________________________________________________________________________________
When the first argument to one of the mapping commands is <silent>,
{rhs} is not echoed to the command line, nor, for that matter, anything
else until the command has completed.
________________________________________________________________________________
|:unm| |:unmap| +
||:unm[ap] {lhs}||
________________________________________________________________________________
Remove the mapping of {lhs}.
________________________________________________________________________________
|:cunm| |:cunmap| +
||:cunm[ap] {lhs}||
________________________________________________________________________________
Remove the mapping of {lhs} (in Command-line mode).
________________________________________________________________________________
|:iunm| |:iunmap| +
||:iunm[ap] {lhs}||
________________________________________________________________________________
Remove the mapping of {lhs} (in Insert mode).
________________________________________________________________________________
section:Abbreviations[abbreviations]
Xulmus can automatically replace words identified as abbreviations,
@@ -209,7 +215,7 @@ ________________________________________________________________________________
||:ca[bbrev] {lhs}|| +
||:ca[bbrev]||
________________________________________________________________________________
Abbreviate a key sequence for Command-line mode. Same as [c]:ab[reviate][c],
Abbreviate a key sequence for Command-line mode. Same as [c]:ab[breviate][c],
but for Command-line mode only.
________________________________________________________________________________
@@ -346,7 +352,7 @@ Custom completion
Custom completion can be provided by specifying the "custom,{func}" argument to
-complete. The {func} is called with two arguments, a completion context, and
an object describing the command's arguments. It should set the context's
\'completions' property, or return an object, with \'start' and \'items'
\'completions' property, or return an object, with \'items' and \'start'
properties, describing the completions and where the replacement is to start.
*start* is the index into the word being completed at which the returned values
@@ -406,7 +412,7 @@ section:Examples[command-examples]
Add a :Google command to search via google:
:command -nargs=* Google open google <args>
\{nbsp}[c]:command -nargs=* Google open google <args>[c]
// TODO: add decent examples

View File

@@ -1,6 +1,4 @@
HEADER
|different-marks| |marks| +
heading:Marks[different-marks,marks]
Xulmus supports a number of different marks:
@@ -80,7 +78,7 @@ section:History[history]
||[count]<C-o>||
________________________________________________________________________________
Go to an older position in the jump list. The jump list is just the browser
history for now.
history for now. If [count] is specified go back [count] pages.
________________________________________________________________________________
@@ -88,7 +86,7 @@ ________________________________________________________________________________
||[count]<C-i>||
________________________________________________________________________________
Go to a newer position in the jump list. The jump list is just the browser
history for now.
history for now. If [count] is specified go forward [count] pages.
________________________________________________________________________________

View File

@@ -1,4 +1,4 @@
HEADER
heading:Error{nbsp}and{nbsp}informational{nbsp}messages[messages]
|message-history| +
@@ -12,6 +12,13 @@ Display previously given messages.
________________________________________________________________________________
|:messc| |:messclear| +
||:messc[lear]||
________________________________________________________________________________
Clear the message history.
________________________________________________________________________________
|g<| +
||g<||
________________________________________________________________________________

View File

@@ -1,6 +1,4 @@
HEADER
|options| +
heading:Options[options]
Xulmus has a number of internal variables and switches which can be set to
achieve special effects. These options come in 5 forms:
@@ -189,10 +187,10 @@ they can be changed to a different value in your RC file using
The following preferences are set:
* browser.startup.page
* dom.popup_allowed_events
* accessibility.typeaheadfind.autostart
* accessibility.typeaheadfind
* http://kb.mozillazine.org/Browser.startup.page[browser.startup.page]
* http://kb.mozillazine.org/Dom.popup_allowed_events[dom.popup_allowed_events]
* http://kb.mozillazine.org/Accessibility.typeaheadfind.autostart[accessibility.typeaheadfind.autostart]
* http://kb.mozillazine.org/Accessibility.typeaheadfind[accessibility.typeaheadfind]
// TODO: others?
@@ -217,9 +215,9 @@ ____
|\'cd'| |\'cdpath'|
||'cdpath' 'cd'|| string (default: equivalent to _$CDPATH_ or ",,")
____
List of directories searched when executing the [c]:cd[c] command. This
is only used for relative paths; if an absolute path is specified, then
the option is ignored.
List of directories searched when executing the [c]:cd[c] command. This is
only used for relative paths if an absolute path is specified then the option
is ignored.
____
@@ -233,11 +231,15 @@ Items which are completed at the [c]:[tab]open[c] prompt. Available items:
*f* Local files
*l* Songbird location bar entries (bookmarks and history sorted in an intelligent way)
*b* Bookmarks
*h* History
*S* Suggest engines
-------------------------------------------------------------------------------------
The order is important, so [c]:set complete=bs[c] would list bookmarks first,
and then any available quick searches.
Warning: Using *b* and *h* can make completion very slow if there are many
items.
____
@@ -248,7 +250,7 @@ Sets the default search engine. The default search engine name is used in the
[c]:[tab]open [arg][c] command if [a][arg][a] neither looks like a URL or like
a specified search engine/keyword.
This means, it you set 'defsearch' to "youtube", then [c]:open arnold
This means that if you set 'defsearch' to "youtube", then [c]:open arnold
schwarzenegger[c] will be exactly the same as [c]:open youtube arnold
schwarzenegger[c]. Therefore, you need to add a keyword or search engine
"youtube" first.
@@ -262,7 +264,7 @@ ____
||'editor'|| string (default: "gvim -f")
____
Set the external text editor.
Sets the editor to run when [m]<C-i>[m] is pressed in INSERT and TEXTAREA
Sets the editor to run when [m]<C-i>[m] is pressed in Insert and TextArea
modes.
Warning: Xulmus will not behave correctly if the editor forks its own
@@ -303,6 +305,20 @@ A list of autocommand event names which should be ignored. If the list contains
the value "all" then all events are ignored.
____
|\'enc'| |\'encoding'|
||'encoding'|| string (default: "UTF-8")
____
Changes the character encoding of the current buffer. Valid only for the
current page.
____
|\'fenc'| |\'fileencoding'|
||'fileencoding'|| string (default: "UTF-8")
____
Changes the character encoding that Xulmus uses to read and write files.
____
|\'nofc'| |\'nofocuscontent'| |\'fc'| |\'focuscontent'|
||'focuscontent' 'fc'|| boolean (default: off)
@@ -312,6 +328,22 @@ want to stay in Normal mode when browsing between web sites. When "on", it
blurs any textbox which often is automatically focused on page load.
If you usually like 'focuscontent' but sometimes you'd like to focus the
first input field, you can use [m]gi[m] to jump to it.
____
|\'fh'| |\'followhints'|
||'followhints' 'fh'|| number (default: 0)
____
Change the behaviour of [m]<Return>[m] in Hints mode. Possible values:
`---------`----------------------------------------------------------
*0* Follow the first hint as soon as typed text uniquely identifies it.
*1* Follow the selected hint on [m]<Return>[m].
*2* Follow the selected hint on [m]<Return>[m] only if it's been [m]<Tab>[m]-selected.
---------------------------------------------------------------------
____
@@ -320,6 +352,7 @@ ____
____
Show the current window fullscreen. Also hide certain GUI elements like the
statusline.
____
@@ -336,7 +369,7 @@ Show or hide certain GUI elements like the menu or toolbar. Supported characters
*N* Tab number over image
*b* Bottom scrollbar
*r* Right scrollbar
*l* Left scrollbar
*l* Left scrollbar (*l* and *r* are mutually exclusive)
----------------
You can also hide the tab bar with [c]:set showtabline=0[c].
@@ -351,6 +384,23 @@ displayed in the status line when viewing the page.
____
|\'hin'| |\'hintinputs'|
||'hintinputs' 'hin'|| stringlist (default: "label,value")
____
When generating hints for input elements that do not have an explicit caption,
this specifies the methods to try and generate a textual hint. It tries the
options in the order that you give, and uses the first that it finds.
`--------------------`---------------------------------------------------------
*value* The hint is the value displayed in a text input, or the selected option for a dropdown.
*label* The value of an explicit label for the input, this will not match most manually added labels that are found on sites.
*name* The name of the input will be used, although the name is not designed for user consumption, it is frequently very similar to the label.
-------------------------------------------------------------------------------
____
|\'hm'| |\'hintmatching'|
||'hintmatching' 'hm'|| string (default: contains)
____
@@ -367,22 +417,6 @@ Change the hint matching algorithm during Hints mode. Possible values:
____
|\'fh'| |\'followhints'|
||'followhints' 'fh'|| number (default: 0)
____
Change the behaviour of [m]<Return>[m] in Hints mode. Possible values:
`---------`----------------------------------------------------------
*0* Follow the first hint as soon as typed text uniquely identifies it.
Follow the selected hint on [m]<Return>[m].
*1* Follow the selected hint on [m]<Return>[m].
*2* Follow the selected hint on [m]<Return>[m] only if it's been [m]<Tab>[m]-selected.
---------------------------------------------------------------------
____
|\'ht'| |\'hinttags'|
||'hinttags' 'ht'|| string
____
@@ -468,7 +502,7 @@ ____
|\'nolpl'| |\'lpl'| |\'noloadplugins'| |\'loadplugins'|
||'loadplugins' 'lpl'|| boolean (default on)
||'loadplugins' 'lpl'|| boolean (default: on)
____
Load plugin scripts when starting up. When on, yet unloaded plugins are
automatically loaded after the xulmusrc file has been sourced. To
@@ -484,7 +518,6 @@ Maximum number of items to display at once in a listing.
____
|\'msgs'| |\'messages'|
||'messages' 'msgs'|| number (default: 100)
____
@@ -504,10 +537,10 @@ ____
____
(default: \bnext,^>$,^(>>|»)$,^(>|»),(>|»)$,\bmore\b)
Patterns to use when guessing the \'next' page in a document sequence. Each
pattern, in order, is matched against all links in the page with the first
match being used. The patterns are case insensitive regular expressions and the
link elements are those defined by 'hinttags'.
Patterns to use when guessing the \'next' page in a document sequence when the
user hits [c]]][c]. Each pattern, in order, is matched against all links in the
page with the first match being used. The patterns are case insensitive regular
expressions and the link elements are those defined by 'hinttags'.
____
@@ -531,7 +564,7 @@ ____
|\'noonline'| |\'online'|
||'online'|| boolean (default on)
||'online'|| boolean (default: on)
____
Show and set the \'work offline' behavior.
____
@@ -577,10 +610,10 @@ ____
____
(default: \bprev|previous\b,^<$,^(<<|«)$,^(<|«),(<|«)$)
Patterns to use when guessing the \'previous' page in a document sequence. Each
pattern, in order, is matched against all links in the page with the first
match being used. The patterns are case insensitive regular expressions and the
link elements are those defined by 'hinttags'.
Patterns to use when guessing the \'previous' page in a document sequence when
the user hits [c][[[c]. Each pattern, in order, is matched against all links
in the page with the first match being used. The patterns are case insensitive
regular expressions and the link elements are those defined by 'hinttags'.
____
@@ -755,13 +788,16 @@ ____
____
Use visual bell instead of beeping on errors. The visual bell style is
controlled by [c]:hi Bell[c].
To disable both the audible and visual bells use [c]:set visualbell[c] and
[c]:hi Bell display: none;[c]
____
|\'wildcase'| |\'wic'|
||'wildcase' 'wic'|| string (default: "smart")
____
Defines how completions are matched with regard to character case.
Defines how completions are matched with regard to character case. Possible values:
`---------------`------------------------
"smart" Case is significant when capital letters are typed

View File

@@ -1,6 +1,4 @@
HEADER
|text-search-commands| +
heading:Text{nbsp}search{nbsp}commands[text-search-commands]
Xulmus provides a Vim-like interface to Songbird's standard text search
functionality. There is no support for using regular expressions in search

View File

@@ -1,6 +1,4 @@
HEADER
|player-mode| |player| +
heading:Player{nbsp}mode[player-mode,player]
The following features apply to Player mode which is activated when the media
tab has focus.

View File

@@ -1,6 +1,4 @@
HEADER
|printing| +
heading:Printing[printing]
|:ha| |:hardcopy| +
||:ha[rdcopy][!]||

View File

@@ -1,13 +1,28 @@
HEADER
|repeat| +
heading:Repeating{nbsp}commands[repeating]
Xulmus can repeat a number of commands and record macros.
section:Single{nbsp}repeats[single-repeat]
|.|
||[count].||
____________________________________________________________________________
Repeat the last keyboard mapping [count] times. Note that, unlike in Vim, this
does not apply solely to editing commands, mainly because Xulmus doesn't
have them.
____________________________________________________________________________
|@:|
||[count]@:||
____________________________________________________________________________
Repeat the last Ex command [count] times.
____________________________________________________________________________
section:Macros[macros,complex-repeat]
|q|
||q{0-9a-zA-Z}|| +
||q\\{0-9a-zA-Z}|| +
____________________________________________________________________________
Record a key sequence into a macro.
Available macros are {0-9a-zA-Z} (uppercase to append).
@@ -48,15 +63,6 @@ Replay the last executed macro [count] times.
____________________________________________________________________________
|.|
||[count].||
____________________________________________________________________________
Repeat the last keyboard mapping [count] times. Note that, unlike in Vim, this
does not apply solely to editing commands, mainly because Xulmus doesn't
have them.
____________________________________________________________________________
section:Using{nbsp}scripts[using-scripts]
|:so| |:source|
@@ -132,7 +138,7 @@ section:Profiling[profile,profiling]
|:time|
||:[count]time[!] {code|:command}|| +
________________________________________________________________________________
Profile a piece of code or a command. Run {code} [count] times (default 1)
Profile a piece of code or a command. Run {code} [count] times (default: 1)
and returns the elapsed time. {code} is always passed to JavaScript's eval(),
which might be slow, so take the results with a grain of salt.

View File

@@ -1,7 +1,43 @@
HEADER
heading:Starting{nbsp}Xulmus[starting]
Xulmus does not yet read any command-line options. When it does, they will
be documented here.
|startup-options| +
Command-line options can be passed to Xulmus via the -liberator Firefox
option. These are passed as single string argument.
E.g firefox -liberator "\++cmd=\'set exrc' +u=\'tempRcFile' \++noplugin"
|+c| +
||+c={command}||
________________________________________________________________________________
Execute a single Ex command after all initialization has been performed. See
help:initialization[starting.html#Initialization].
________________________________________________________________________________
|\++cmd| +
||\++cmd={command}||
________________________________________________________________________________
Execute a single Ex command before any initialization has been performed. See
help:initialization[starting.html#Initialization].
________________________________________________________________________________
|+u| +
||+u={rcfile}||
________________________________________________________________________________
The file {rcfile} is used for user initialization commands. If {rcfile} is
"NORC" then no startup initialization is performed except for the loading of
plugins, i.e. steps 1. and 2. in
help:initialization[starting.html#Initialization] are skipped. If {rcfile} is
"NONE" then plugin loading is also skipped.
________________________________________________________________________________
|\++noplugin| +
||\++noplugin||
________________________________________________________________________________
Prevents plugin scripts from being loaded at startup. See 'loadplugins'.
________________________________________________________________________________
section:Initialization[initialization,startup]
@@ -18,15 +54,21 @@ further locations are tried.
are executed and _$MY_XULMUSRC_ set to its path.
c. [a]\~/.xulmusrc[a] -- If this file exists, its contents are executed.
2. If 'exrc' is set, then any RC file in the current directory is also sourced.
2. If 'exrc' is set and the +u command-line option was not specified, then any
RC file in the current directory is also sourced.
3. All directories in 'runtimepath' are searched for a "plugin"
subdirectory and all yet unloaded plugins are loaded. For each plugin
directory, all *.\{js,vimp} files (including those in further
subdirectory and all yet unloaded plugins are loaded. For each
plugin directory, all *.\{js,xulmus} files (including those in further
subdirectories) are sourced alphabetically. No plugins will be sourced
if 'noloadplugins' is set. Any particular plugin will not be loaded if
it has already been loaded (e.g., by an earlier [c]:loadplugins[c]
command).
if:
* 'noloadplugins' is set.
* the \++noplugin command-line option was specified.
* the +u=NONE command-line option specified set.
Any particular plugin will not be loaded if it has already been loaded (e.g.,
by an earlier [c]:loadplugins[c] command).
The user's ~ (i.e., "home") directory is determined as follows:

View File

@@ -1,6 +1,4 @@
HEADER
|styling| +
heading:Styling{nbsp}the{nbsp}GUI{nbsp}and{nbsp}web{nbsp}pages[styling]
Xulmus allows you to style both the player and any web pages you view. All
styling is specified via CSS. Although you may style any user interface element
@@ -18,13 +16,13 @@ sourced.
________________________________________________________________________________
|:hi| |:highlight| +
||:hi[ghlight][!] [-append] {group}[{selector}] [{css}]|| +
||:hi[ghlight][!] [-append] {group} [[{selector}] {css}]|| +
________________________________________________________________________________
Highlight {group} with {css}. Normally, {css} is checked for
valid syntax before it's applied. Once you're certain it's
valid, [!] will override the check, to speed Xulmus startup.
{selector} can be any valid CSS selector, such as [c]:hover[c], and,
if provided, will restrict the match to matching elements.
Highlight {group} with {css}. Normally, {css} is checked for valid
syntax before it's applied. Once you're certain it's valid, [!] can be
used to skip the check to speed up Vimperator startup. {selector} can
be any valid CSS selector, such as [c]:hover[c], and, if provided, will
restrict the match to matching elements.
Valid groups are:
`--------------------`-----------------------------------
@@ -73,6 +71,7 @@ Valid groups are:
*StatusLine* The status bar
*StatusLineBroken* The status bar for a broken web page
*StatusLineSecure* The status bar for a secure web page
*StatusLineExtended* The status bar for a secure web page with an Extended Validation(EV) certificate
*String* A JavaScript String object
*TabClose* The close button of a browser tab
*TabIcon* The icon of a browser tab
@@ -88,11 +87,11 @@ Valid groups are:
Every invocation completely replaces the styling of any previous invocation,
unless *-append* (short option: *-a*) is provided, in which case {css} is
appended to its current value. If {css} is not provided, any styles matching
{group} are listed.
{group} are listed, or all styles if no {group} provided.
________________________________________________________________________________
|:highlight-clear| +
||:hi[light] clear [{group}[{selector}]]|| +
||:hi[ghlight] clear [{group} [{selector}]]|| +
________________________________________________________________________________
Reset the highlighting for {group} to its default value. If
{group} is not given, reset all highlighting groups.
@@ -105,7 +104,7 @@ ________________________________________________________________________________
Add CSS styles to the player or to web pages. {filter} is a comma
separated list of URLs to match. URLs ending with *\** are matched as
prefixes, URLs not containing any *:* or */* characters are
matched as domains. If {name} (short option: [c]-n[c]) is provided, any
matched as domains. If {name} (short option: *-n*) is provided, any
existing style with the same name is overridden, and the style may later
be deleted using {name}. If *-append* (short option: *-a*) is provided
along with *-name*, {css} and {filter} are appended to its current
@@ -118,13 +117,12 @@ ________________________________________________________________________________
||:dels[tyle] [-name={name}] [-index={index}] [{filter}] [{css}]|| +
________________________________________________________________________________
Delete any matching styles. If {filter} is provided, only matching elements of
the filter are disabled. For instance, a filter [c]mozilla.org[c], given a
style for [c]www.google.com,mozilla.org[c], will result in a style for
[c]www.google.com[c]. The available options are:
the filter are disabled. For instance, a filter [a]mozilla.org[a], given a
style for [a]www.google.com,mozilla.org[a], will result in a style for
[a]www.google.com[a]. The available options are:
* [c]-name[c]: The name provided to [c]:style[c] (short option:
*-n*)
* [c]-index[c]: For unnamed styles, the index listed by [c]:style[c]
* *-name*: The name provided to [c]:style[c] (short option: *-n*)
* *-index*: For unnamed styles, the index listed by [c]:style[c]
(short option: *-i*)
________________________________________________________________________________

View File

@@ -1,6 +1,4 @@
HEADER
|tabs| +
heading:Tabs[tabs]
Tabs are used to be able to view many web pages at the same time. Each tab
contains exactly one buffer -- multiple buffers per tab are not supported. As a
@@ -62,30 +60,30 @@ ________________________________________________________________________________
|gt| +
||[count]gt||
________________________________________________________________________________
Go to the next tab. Cycles to the first tab, when the last is selected. +
Go to the next tab. Cycles to the first tab when the last is selected. +
If [count] is specified go to the [count]th tab.
________________________________________________________________________________
|<C-PageDown>| |<C-Tab>| |<C-n>| +
||[count]<C-n>||
________________________________________________________________________________
Go to the next tab. Cycles to the first tab, when the last is selected. +
Go to the next tab. Cycles to the first tab when the last is selected. +
If [count] is specified go to the [count]th next tab.
________________________________________________________________________________
|<C-PageUp>| |<C-S-Tab>| |<C-p>| |gT| +
||[count]gT||
________________________________________________________________________________
Go {count} pages back. Wraps around from the first tab to the last tab. +
If [count] is specified go back [count] tabs.
Go to the previous tab. Cycles to the last tab when the first is selected. +
If [count] is specified go to the [count]th previous tab.
________________________________________________________________________________
|<C-6>| |<C-^>| +
||[count]<C-^>||
________________________________________________________________________________
Select the alternate tab or the [count]th tab. The alternate tab is the last
selected tab. This provides a quick method of toggling between two tabs.
Select the previously selected tab. This provides a quick method of toggling
between two tabs. If [count] is specified, go to the [count]th tab.
________________________________________________________________________________
@@ -134,6 +132,7 @@ ________________________________________________________________________________
Detach the current tab, and open it in its own window.
________________________________________________________________________________
section:Reordering{nbsp}tabs[reordering-tabs]
|:tabm| |:tabmove|
||:tabm[ove] [a][N][a]|| +
@@ -175,8 +174,6 @@ Switch to the previous tab or go [count] tabs back. Wraps around from the
first tab to the last tab.
________________________________________________________________________________
section:Closing{nbsp}tabs[closing-tabs]
|d| |:tabc| |:tabclose| |:bun| |:bunload| |:bw| |:bwipeout| |:bd| |:bdelete|
@@ -216,4 +213,16 @@ ________________________________________________________________________________
//after a browser restart.
//________________________________________________________________________________
section:Looping{nbsp}over{nbsp}tabs[looping-over-tabs]
|:tabd| |:tabdo| |:bufd| |:bufdo| +
||:tabd[o] {cmd}||
________________________________________________________________________________
Execute {cmd} in each tab. {cmd} is executed in each tab starting with the
first and ending with the last which becomes the current tab.
{cmd} should not alter the tab list state by adding, removing or reordering
tabs.
________________________________________________________________________________
// vim: set filetype=asciidoc:

View File

@@ -1,14 +1,12 @@
HEADER
// Initial revision: Sun Jun 8 10:07:05 UTC 2008 (penryu)
heading:Quick-start{nbsp}tutorial[tutorial]
+++<div style="text-align: center;">+++
*This is a quickstart tutorial to help get new users up and running in
Vimperator. It is not intended as a full reference explaining all features.*
+++</div>+++
section:Quick-start{nbsp}tutorial[tutorial]
If you've started using Vimperator from scratch (i.e., without any
customization), you should be looking at this help page in a relatively
bare-looking window. The menubar, navigation bar, and bookmark bars are hidden.
@@ -22,8 +20,8 @@ If you're a veteran Vim user, this may look familiar. It should.
However, in this author's opinion, the best way to get familiar with
Vimperator is to leave these disabled for now. (The above action can be
reversed with [c]:set go=<CR>[c]) You can look at the entry for
[o]guioptions[o] in help:options[options.html] for more information on this.
reversed with [c]:set go=<CR>[c]) You can look at the entry for 'guioptions' in
help:options[options.html] for more information on this.
section:Vimperator's{nbsp}modal{nbsp}interface[modal]
@@ -36,8 +34,8 @@ When Vimperator starts, it is in Normal mode by default. This is probably where
you will spend the majority of your time.
The other core mode of Vimperator, Command-line mode, can be entered from
Normal mode by typing a \':' (colon). You will frequently see Vimperator
commands start with a \':', indicating that what follows is a command.
Normal mode by typing a \'[m]:[m]' (colon). You will frequently see Vimperator
commands start with a \'[m]:[m]', indicating that what follows is a command.
To return to Normal mode from Command-line mode, type [m]<Esc>[m]. Pressing
[m]<Esc>[m] will also return you to Normal mode from most other modes in
@@ -57,7 +55,7 @@ Similarly, help on configurable options is available with [c]:help
'{option_name}'[c]. (Note the single quotes around the option name as in Vim.)
Information on all available options is, predictably, [c]:help options[c].
and you can find out about the [m]gt[m] and [m]gT[m] mapping with
And you can find out about the [m]gt[m] and [m]gT[m] mapping with
\{nbsp}[c]:help gt<CR>[c] +
\{nbsp}[c]:help gT<CR>[c]
@@ -142,7 +140,7 @@ type uniquely identifies any given link, Vimperator will follow that link
immediately without any further user input.
Whichever way you choose to indicate your target link, once Vimperator has
highlighted the link you want, simply hit <Enter> to open it.
highlighted the link you want, simply hit [m]<Enter>[m] to open it.
The most common hint mode is called help:QuickHint{nbsp}mode[various.html,f].
To activate QuickHint mode, press either [m]f[m] or [m]F[m]. The lower-case

View File

@@ -1,4 +1,4 @@
HEADER
heading:Other{nbsp}help[]
section:Various{nbsp}commands[various]
@@ -11,9 +11,9 @@ ________________________________________________________________________________
|<C-l>| |CTRL-L| |:redr| |:redraw| +
||:redr[aw]||
____
________________________________________________________________________________
Redraws the screen. Useful to update the screen halfway executing a script or function.
____
________________________________________________________________________________
|:norm| |:normal|
||:norm[al][!] {commands}|| +
@@ -30,11 +30,12 @@ ________________________________________________________________________________
||:!{cmd}||
________________________________________________________________________________
Run a command. Runs {cmd} through system() and displays its output. Any \'!' in
{cmd} is replaced with the previous external command. But not when there is a
backslash before the \'!', then that backslash is removed.
{cmd} is replaced with the previous external command, but not when there is a
backslash before the \'!', then the backslash is removed.
Warning: Input redirection (< foo) not done, also do not run commands which
require stdin or it will hang Songbird!
require stdin or it will hang Songbird! It is possible to launch background
processes, though (e.g. ':! xterm &').
________________________________________________________________________________
@@ -63,7 +64,9 @@ ________________________________________________________________________________
Open help window. The default page, as specified by 'helpfile' is shown unless
[a][subject][a] is specified. If you need help for a specific topic, try
[c]:help overview[c].
____________________________________________________________________________
All help pages can be viewed in a single page via [c]:help all[c].
________________________________________________________________________________
|:exu| |:exusage| +