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

Update help files for Xulmus.

This commit is contained in:
Doug Kearns
2009-03-28 02:13:18 +11:00
parent d3a5d3d229
commit 2c352c285b
19 changed files with 133 additions and 131 deletions

View File

@@ -116,7 +116,7 @@ const config = { //{{{
function () { window.BrowserViewSourceOfDocument(content.document); }],
["places", "Places Organizer: Manage your bookmarks and history",
function () { PlacesCommandHook.showPlacesOrganizer(ORGANIZER_ROOT_BOOKMARKS); }],
["preferences", "Show Firefox preferences dialog",
["preferences", "Show Songbird preferences dialog",
function () { window.openPreferences(); }],
/*
["printpreview", "Preview the page before printing",
@@ -138,14 +138,14 @@ const config = { //{{{
//TODO : Write intro.html and tutorial.html
// they are sorted by relevance, not alphabetically
helpFiles: [ "player.html", "options.html", "autocommands.html" ],
/* "intro.html", "tutorial.html", "starting.html", "browsing.html",
"buffer.html", "cmdline.html", "insert.html", "options.html",
"pattern.html", "tabs.html", "hints.html", "map.html", "eval.html",
"marks.html", "repeat.html", "autocommands.html", "print.html",
"gui.html", "styling.html", "message.html", "developer.html",
"various.html", "index.html", "version.html"
], */
helpFiles: [
"intro.html", /*"tutorial.html",*/ "starting.html", "player.html",
"browsing.html", "buffer.html", "cmdline.html", "insert.html",
"options.html", "pattern.html", "tabs.html", "hints.html", "map.html",
"eval.html", "marks.html", "repeat.html", "autocommands.html",
"print.html", "gui.html", "styling.html", "message.html",
"developer.html", "various.html", "index.html", "version.html"
],
scripts: [
"bookmarks.js",
@@ -155,8 +155,6 @@ const config = { //{{{
init: function ()
{
options["helpfile"] = "player.html";
//Adding a mode for Player
//modes.addMode("PLAYER"); // Player mode for songbird
@@ -375,7 +373,7 @@ const config = { //{{{
"Show " + config.hostApplication + " preferences",
function (args)
{
if (args.bang) // open Firefox settings GUI dialog
if (args.bang) // open Songbird settings GUI dialog
{
liberator.open("about:config",
(options["newtab"] && options.get("newtab").has("all", "prefs"))

View File

@@ -2,15 +2,15 @@ HEADER
|surfing| |browsing| +
Vimperator overrides nearly all Firefox keys in order to make browsing more
Xulmus overrides nearly all Songbird keys in order to make browsing more
pleasant for Vim users. On the rare occasions when you want to pass a keystroke
to Firefox, or to the web page, and have it retain its original meaning you
to Songbird, or to the web page, and have it retain its original meaning you
have 2 possibilities:
|pass-through| |<C-z>| |CTRL-Z| +
||CTRL-Z||
________________________________________________________________________________
Disable all Vimperator keys except [m]<Esc>[m] and pass them to the next event
Disable all Xulmus keys except [m]<Esc>[m] and pass them to the next event
handler. This is especially useful, if JavaScript controlled forms like the
RichEdit form fields of Gmail don't work anymore. To exit this mode, press
[m]<Esc>[m]. If you also need to pass [m]<Esc>[m] in this mode to the web page,
@@ -21,10 +21,10 @@ ________________________________________________________________________________
||CTRL-V||
________________________________________________________________________________
If you only need to pass a single key to a JavaScript form field or another
extension prefix the key with [m]<C-v>[m]. Also works to unshadow Firefox
shortcuts like [m]<C-o>[m] which are otherwise hidden in Vimperator. When
Vimperator mode is temporarily disabled with [m]<C-z>[m], [m]<C-v>[m] will pass
the next key to Vimperator instead of the web page.
extension prefix the key with [m]<C-v>[m]. Also works to unshadow Songbird
shortcuts like [m]<C-o>[m] which are otherwise hidden in Xulmus. When
Xulmus mode is temporarily disabled with [m]<C-z>[m], [m]<C-v>[m] will pass
the next key to Xulmus instead of the web page.
________________________________________________________________________________
section:Opening{nbsp}web{nbsp}pages[opening]
@@ -52,7 +52,7 @@ Each token is analyzed and in this order:
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).
4. Passed directly to Firefox in all other cases ([c]:open www.osnews.com,
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).
@@ -286,7 +286,7 @@ section:Quitting[quitting,save-session]
||:q[uit]||
________________________________________________________________________________
Quit current tab. If this is the last tab in the window, close the window. If
this was the last window, close Vimperator. When quitting Vimperator, the
this was the last window, close Xulmus. When quitting Xulmus, the
session is not stored.
________________________________________________________________________________
@@ -294,7 +294,7 @@ ________________________________________________________________________________
|:qa| |:qall| |:quita| |:quitall| +
||:quita[ll]||
________________________________________________________________________________
Quit Vimperator. Quit Vimperator, no matter how many tabs/windows are open.
Quit Xulmus. Quit Xulmus, no matter how many tabs/windows are open.
The session is not stored.
________________________________________________________________________________
@@ -310,7 +310,7 @@ ________________________________________________________________________________
||:wqa[ll]|| +
||:xa[ll]||
________________________________________________________________________________
Save the session and quit. Quit Vimperator, no matter how many tabs/windows
Save the session and quit. Quit Xulmus, no matter how many tabs/windows
are open. The session is stored. [c]:wq[c] is different from Vim, as it
closes the window instead of just one tab by popular demand. Complain on the
mailing list, if you want to change that.
@@ -327,7 +327,7 @@ ________________________________________________________________________________
|ZZ|
||ZZ||
________________________________________________________________________________
Quit and save the session. Quit Vimperator, no matter how many tabs/windows
Quit and save the session. Quit Xulmus, no matter how many tabs/windows
are open. The session is stored. Works like [c]:xall[c].
________________________________________________________________________________

View File

@@ -2,7 +2,7 @@ HEADER
|buffer| |document| +
Vimperator holds exactly one buffer object for each tab. It is usually an
Xulmus holds exactly one buffer object for each tab. It is usually an
(X)HTML document with advanced features.
section:Buffer{nbsp}information[buffer-information]
@@ -234,7 +234,7 @@ 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' Firefox preferences. The zoom levels can be changed using
\'zoom.maxPercent' Songbird preferences. The zoom levels can be changed using
the \'toolkit.ZoomManager.zoomLevels' preference.
Note: \'toolkit.ZoomManager.zoomLevels' is specified as a list of values

View File

@@ -60,7 +60,7 @@ Some notes about the code above:
automatically marked up as an argument.
There are also some additional asciidoc commands specifically for writing
Vimperator documentation:
Xulmus documentation:
- *$$section:Writing{nbsp}documentation[writing-docs,documentation]$$* Creates
a new section like _Writing Documentation_ in this help file with 2 tags.

View File

@@ -53,10 +53,10 @@ passing the argument to `eval()`.
is found, and interpret them with the JavaScript _eval()_ function.
The special version [c]:javascript![c] opens the JavaScript console of
Firefox.
Songbird.
[m]<Tab>[m] completion is available for [c]:javascript {cmd}<Tab>[c] (but not
yet for the [c]:js <<EOF[c] multiline widget). Be aware that Vimperator needs
yet for the [c]:js <<EOF[c] multiline widget). Be aware that Xulmus needs
to run {cmd} through eval() to get the completions, which could have unwanted
side effects.
________________________________________________________________________________

View File

@@ -2,7 +2,7 @@ HEADER
|gui| +
Although Vimperator offers the most frequently used Firefox functionality via
Although Xulmus offers the most frequently used Songbird functionality via
Ex and Normal mode commands there may be times when directly accessing the GUI
is required. There are commands for accessing the menu system, standard dialogs
and the sidebar.
@@ -11,7 +11,7 @@ and the sidebar.
||:emenu {menu}||
________________________________________________________________________________
Execute {menu} from the command line. This command provides command-line access
to all menu items available from the main Firefox menubar. {menu} is a
to all menu items available from the main Songbird menubar. {menu} is a
hierarchical path to the menu item with each submenu separated by a period.
E.g. [c]:emenu File.Open File...[c]
________________________________________________________________________________
@@ -20,39 +20,32 @@ ________________________________________________________________________________
|:addo| |:addons| +
||:addo[ns]||
________________________________________________________________________________
Show available Browser Extensions and Themes.
You can add/remove/disable browser extensions from this dialog.
Be aware that not all Firefox extensions work, because Vimperator overrides
some key bindings and changes Firefox's GUI.
Show available Songbird Extensions and Themes.
You can add/remove/disable extensions from this dialog.
Be aware that not all Songbird extensions work, because Xulmus overrides
some key bindings and changes Songbird's GUI.
________________________________________________________________________________
|:dia| |:dialog|
||:dia[log] [a][firefox-dialog][a]|| +
________________________________________________________________________________
Open a Firefox dialog.
Open a Songbird dialog.
Available dialogs:
`------------------`-----------------------------------
*about* About Firefox
*addbookmark* Add bookmark for the current page
*about* About Songbird
*addons* Manage Add-ons
*bookmarks* List your bookmarks
*checkupdates* Check for updates
*cleardata* Clear private data
*cookies* List your cookies
*console* JavaScript console
*customizetoolbar* Customize the Toolbar
*dominspector* DOM Inspector
*downloads* Manage Downloads
*history* List your history
*import* Import Preferences, Bookmarks, History, etc. from other browsers
*openfile* Open the file selector dialog
*pageinfo* Show information about the current page
*pagesource* View page source
*places* Places Organizer: Manage your bookmarks and history
*preferences* Show Firefox preferences dialog
*printpreview* Preview the page before printing
*preferences* Show Songbird preferences dialog
*printsetup* Setup the page size and orientation before printing
*print* Show print dialog
*saveframe* Save frame to disk
@@ -67,24 +60,8 @@ ________________________________________________________________________________
|:dl| |:downl| |:downloads| +
||:downl[oads]||
________________________________________________________________________________
Show progress of current downloads. Open the original Firefox download dialog
Show progress of current downloads. Open the original Songbird download dialog
in a new tab. Here, downloads can be paused, canceled and resumed.
________________________________________________________________________________
|:sbcl| |:sbclose| +
||:sbcl[ose]||
________________________________________________________________________________
Close the sidebar window.
________________________________________________________________________________
|:sbope| |:sbopen| |:sb| |:sbar| |:sideb| |:sidebar| +
||:sidebar {name}||
________________________________________________________________________________
Open the sidebar window. {name} is any of the menu items listed under the
standard Firefox View->Sidebar menu. Add-ons, Preferences and Downloads are
also available in the sidebar.
________________________________________________________________________________
// vim: set filetype=asciidoc:

View File

@@ -25,7 +25,7 @@ ________________________________________________________________________________
Start QuickHint mode, but open link in a new tab. Like normal QuickHint
mode (activated with [m]f[m]) but opens the link in a new tab. The new
tab will be loaded in background according to the
\'browser.tabs.loadInBackground' Firefox preference.
\'browser.tabs.loadInBackground' Songbird preference.
________________________________________________________________________________

View File

@@ -4,6 +4,25 @@ HEADER
This file contains a list of all available commands.
section:Player{nbsp}mode[player-index]
||[m]x[m]|| Play the current track +
||[m]z[m]|| Play the previous track +
||[m]b[m]|| Play the next track +
||[m]c[m]|| Pause/unpause the current track +
||[m]v[m]|| Stop playing the current track +
||[m]t[m]|| Toggle shuffle mode +
||[m]r[m]|| Toggle repeat mode +
||[m]i[m]|| Select the currently playing track +
||[m]f[m]|| Filter and play tracks +
||[m]F[m]|| Filter and show the tracks as a view +
||[m]h[m]|| Seek -10s +
||[m]l[m]|| Seek +10s +
||[m]H[m]|| Seek -1m +
||[m]L[m]|| Seek +1m +
||[m]+[m]|| Increase volume by 10% +
||[m]-[m]|| Decrease volume by 10% +
section:Insert{nbsp}mode[insert-index]
||[m]<C-i>[m]|| Launch the external editor +
@@ -24,7 +43,7 @@ section:Normal{nbsp}mode[normal-index]
||[m]<C-u>[m]|| Scroll window upwards in the buffer +
||[m]<C-v>[m]|| Pass through next key +
||[m]<C-x>[m]|| Decrement last number in URL +
||[m]<C-z>[m]|| Temporarily ignore all Vimperator key bindings +
||[m]<C-z>[m]|| Temporarily ignore all Xulmus key bindings +
||[m]<Esc>[m]|| Focus content +
@@ -141,6 +160,18 @@ section:Command-line{nbsp}editing[ex-edit-index]
section:Ex{nbsp}commands[ex-cmd-index,:index]
||[c]:playerplay[c]|| Play the current track +
||[c]:playerprev[c]|| Play the previous track +
||[c]:playernext[c]|| Play the next track +
||[c]:playerpause[c]|| Pause/unpause the current track +
||[c]:playerstop[c]|| Stop playing the current track +
||[c]:filter[c]|| Filter and play tracks +
||[c]:Filter[c]|| Filter and show the tracks as a view +
||[c]:seek[c]|| Seek to an absolute or relative position in a track +
||[c]:volume[c]|| Set the player volume +
||[c]:load[c]|| Load a playlist +
||[c]:mediaview[c]|| Change the media view +
||[c]:![c]|| Run a command +
||[c]:abbreviate[c]|| Abbreviate a key sequence +
||[c]:abclear[c]|| Remove all abbreviations +
@@ -184,7 +215,7 @@ section:Ex{nbsp}commands[ex-cmd-index,:index]
||[c]:forward[c]|| Go forward in the browser history +
||[c]:hardcopy[c]|| Print current document +
||[c]:help[c]|| Display help +
||[c]:highlight[c]|| Style Vimperator +
||[c]:highlight[c]|| Style Xulmus +
||[c]:history[c]|| Show recently visited URLs +
||[c]:iabbrev[c]|| Abbreviate a key sequence in Insert mode +
||[c]:iabclear[c]|| Remove all abbreviations in Insert mode +
@@ -203,7 +234,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]:mkvimperatorrc[c]|| Write current key mappings and changed options to the config file +
||[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 +
||[c]:normal[c]|| Execute Normal mode commands +
@@ -212,7 +243,7 @@ section:Ex{nbsp}commands[ex-cmd-index,:index]
||[c]:pageinfo[c]|| Show various page information +
||[c]:pagestyle[c]|| Select the author style sheet to apply +
||[c]:play[c]|| Replay a recorded macro +
||[c]:preferences[c]|| Show Firefox preferences dialog +
||[c]:preferences[c]|| Show Songbird preferences dialog +
||[c]:pwd[c]|| Print the current directory name +
||[c]:qmark[c]|| Mark a URL with a letter for quick access +
||[c]:qmarks[c]|| Show all QuickMarks +
@@ -230,7 +261,7 @@ section:Ex{nbsp}commands[ex-cmd-index,:index]
||[c]:setglobal[c]|| Set global option +
||[c]:setlocal[c]|| Set local option +
||[c]:sidebar[c]|| Open the sidebar window +
||[c]:style[c]|| Style Vimperator and web sites +
||[c]:style[c]|| Style Xulmus and web sites +
||[c]:source[c]|| Read Ex commands from a file +
||[c]:stop[c]|| Stop loading +
||[c]:tab[c]|| Execute a command and tell it to output in a new tab +

View File

@@ -1,31 +1,25 @@
LOGO
+++<div style="text-align: center;">+++
*First there was a Navigator, then there was an Explorer.
Later it was time for a Konqueror. Now it's time for an Imperator, the
VIMperator :)*
+++</div>+++
section:Introduction[intro]
http://vimperator.org[Vimperator] is a free browser add-on for Firefox,
which makes it look and behave like the http://www.vim.org[Vim]
text editor. It has similar key bindings, and you could call it a modal
web browser, as key bindings differ according to which mode you are in.
http://vimperator.org/Xulmus[Xulmus] is a free media player add-on for
Songbird, which combines the best features of the
http://cmus.sourceforge.net[cmus] music player and the http://www.vim.org[Vim]
text editor.
|warning| +
Warning:
To provide the most authentic Vim experience, the Firefox menubar and toolbar
are hidden. +
If you really need them, type: [c]:set guioptions+=mT[c] to get them back. +
If you don't like Vimperator at all, you can uninstall it by typing
To provide the most authentic cmus/Vim experience, the Songbird toolbar
is hidden. +
If you really need it, type: [c]:set guioptions+=T[c] to get it back. +
If you don't like Xulmus at all, you can uninstall it by typing
[c]:addons[c] and remove/disable it. +
If you like it but can't remember the shortcuts, then press [m]F1[m] or
[c]:help[c] to get this help window back.
|author| |donation| +
Vimperator was written by mailto:stubenschrott@gmx.net[Martin Stubenschrott].
If you appreciate my work on Vimperator and want to encourage me working on it
Xulmus was written by mailto:prathyushthota@gmail.com[Prathyush Thota].
If you appreciate my work on Xulmus and want to encourage me working on it
more, you can either send me greetings, patches or make a donation:
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -38,14 +32,15 @@ more, you can either send me greetings, patches or make a donation:
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Of course as a believer in free open source software, only make a donation
if you really like Vimperator and the money doesn't hurt -- otherwise just use
if you really like Xulmus and the money doesn't hurt -- otherwise just use
it, recommend it and like it :)
section:Help{nbsp}topics[overview]
- help:Tutorial[tutorial.html]: A quick-start tutorial for new users.
- help:Initialization[starting.html]: How Vimperator starts up, where it reads
//- help:Tutorial[tutorial.html]: A quick-start tutorial for new users.
- help:Initialization[starting.html]: How Xulmus starts up, where it reads
the config file...
- help:Player[player.html]: Interacting with the media player.
- help:Browsing[browsing.html]: Basic mappings and commands needed for a
browsing session (how to open a web page or go back in history).
- help:Buffer{nbsp}commands[buffer.html]: Operations on the current document
@@ -65,8 +60,8 @@ section:Help{nbsp}topics[overview]
- help:Autocommands[autocommands.html]: Automatically executing code on certain
events.
- help:Print[print.html]: Printing pages.
- help:GUI[gui.html]: Accessing Firefox menus, dialogs and the sidebar.
- help:Styling[styling.html]: Changing the styling of content pages and Vimperator itself.
- help:GUI[gui.html]: Accessing Songbird menus, dialogs and the sidebar.
- help:Styling[styling.html]: Changing the styling of content pages and Xulmus itself.
- help:Messages[message.html]: A description of messages and error messages.
- help:Developer{nbsp}information[developer.html]: How to write docs or
plugins.
@@ -87,11 +82,11 @@ section:Features[features]
* Advanced completion of bookmark and history URLs (searching also in title, not only URL)
* Vim-like statusline with a wget-like progress bar
* Minimal GUI (easily hide useless menubar and toolbar with [c]:set guioptions=[c])
* Ability to [c]:source[c] JavaScript files, and to use a [a]~/.vimperatorrc[a] file
with syntax highlighting if you install scripts/vimperator.vim
* Ability to [c]:source[c] JavaScript files, and to use a [a]~/.xulmusrc[a] file
with syntax highlighting if you install scripts/xulmus.vim
* Easy quick searches ([c]:open foo[c] will search for "foo" in google,
[c]:open ebay terminator[c] will search for "terminator" on ebay)
with support for Firefox keyword bookmarks and search engines
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)

View File

@@ -172,7 +172,7 @@ ________________________________________________________________________________
section:Abbreviations[abbreviations]
Vimperator can automatically replace words identified as abbreviations,
Xulmus can automatically replace words identified as abbreviations,
which may be used to save typing or to correct commonly misspelled
words. An abbreviation can be one of three types that are defined by the
types of constituent characters. Whitespace and quotes are non-keyword
@@ -319,7 +319,7 @@ Completion can be enabled by specifying one of the following arguments to the
*buffer* buffers
*color* color schemes
*command* Ex commands
*dialog* Firefox dialogs
*dialog* Songbird dialogs
*dir* directories
*environment* environment variables
*event* autocommand events
@@ -330,8 +330,8 @@ Completion can be enabled by specifying one of the following arguments to the
*macro* named macros
*mapping* user mappings
*menu* menu items
*option* Vimperator options
*preference* Firefox preferences
*option* Xulmus options
*preference* Songbird preferences
*search* search engines and keywords
*shellcmd* shell commands
*sidebar* sidebar panels

View File

@@ -2,14 +2,14 @@ HEADER
|different-marks| |marks| +
Vimperator supports a number of different marks:
Xulmus supports a number of different marks:
- Bookmarks which allow you to mark a web page as one of your favorites for
easy access.
- QuickMarks allow you to define up to 62 (a-zA-Z0-9) web sites (or groups of
web sites) which you visit most often.
- Local marks to store the position within a web page.
- History is also a special type of marks, as Vimperator automatically
- History is also a special type of marks, as Xulmus automatically
remembers sites which you have visited in the past.
section:Bookmarks[bookmarks]

View File

@@ -2,7 +2,7 @@ HEADER
|message-history| +
Vimperator stores all info and error messages in a message history. The type of
Xulmus stores all info and error messages in a message history. The type of
info messages output can be controlled by the 'verbose' option.
|:mes| |:messages| +

View File

@@ -2,9 +2,9 @@ HEADER
|text-search-commands| +
Vimperator provides a Vim-like interface to Firefox's standard text search
Xulmus provides a Vim-like interface to Songbird's standard text search
functionality. There is no support for using regular expressions in search
commands as Firefox does not provide native regexp support. It is unlikely that
commands as Songbird does not provide native regexp support. It is unlikely that
this will ever be available.
|/| +

View File

@@ -18,7 +18,7 @@ As above, but write the output to {filename}.
Note: Not available on Windows.
________________________________________________________________________________
section:Firefox{nbsp}printing{nbsp}dialogs[firefox-print-dialogs]
section:Songbird{nbsp}printing{nbsp}dialogs[songbird-print-dialogs]
The "Print Preview" and "Page Setup" dialogs can be opened via the [c]:dialog[c]
command

View File

@@ -2,7 +2,7 @@ HEADER
|repeat| +
Vimperator can repeat a number of commands and record macros.
Xulmus can repeat a number of commands and record macros.
section:Macros[macros,complex-repeat]
@@ -52,7 +52,7 @@ ____________________________________________________________________________
||[count].||
____________________________________________________________________________
Repeat the last keyboard mapping [count] times. Note that, unlike in Vim, this
does not apply solely to editing commands, mainly because Vimperator doesn't
does not apply solely to editing commands, mainly because Xulmus doesn't
have them.
____________________________________________________________________________
@@ -99,7 +99,7 @@ Load all unloaded plugins immediately. Because plugins are automatically
loaded after vimperatorrc is sourced, this command must be placed early
in the vimperatorrc file if vimperatorrc also includes commands that are
implemented by plugins. Additionally, this command allows for sourcing
new plugins without restarting Vimperator.
new plugins without restarting Xulmus.
________________________________________________________________________________
@@ -123,7 +123,7 @@ ________________________________________________________________________________
|:fini| |:finish|
||:fini[sh]|| +
________________________________________________________________________________
Stop sourcing a script file. This can only be called from within a Vimperator
Stop sourcing a script file. This can only be called from within a Xulmus
script file.
________________________________________________________________________________
@@ -136,7 +136,7 @@ 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.
If {code} starts with a [c]:[c], it is executed as a Vimperator command.
If {code} starts with a [c]:[c], it is executed as a Xulmus command.
Use the special version with [!] if you just want to run any command multiple
times without showing profiling statistics.

View File

@@ -1,13 +1,13 @@
HEADER
Vimperator does not yet read any command-line options. When it does, they will
Xulmus does not yet read any command-line options. When it does, they will
be documented here.
section:Initialization[initialization,startup]
At startup, Vimperator completes the following tasks in order.
At startup, Xulmus completes the following tasks in order.
1. Vimperator can perform user initialization commands. When
1. Xulmus can perform user initialization commands. When
one of the following is successfully located, it is executed, and no
further locations are tried.
@@ -31,7 +31,7 @@ command).
The user's ~ (i.e., "home") directory is determined as follows:
* On Unix and Mac, the environment variable _$HOME_ is used.
* On Windows, Vimperator checks for the existence of _%HOME%_, then
* On Windows, Xulmus checks for the existence of _%HOME%_, then
_%USERPROFILE%_, and then _%HOMEDRIVE%%HOMEPATH%_. It uses the first one
it finds.
@@ -54,7 +54,7 @@ section:Restarting[restarting]
|:res| |:restart| +
||:res[tart]||
________________________________________________________________________________
Force the browser to restart. Useful when installing extensions.
Force Xulmus to restart. Useful when installing extensions.
________________________________________________________________________________
// vim: set filetype=asciidoc:

View File

@@ -2,7 +2,7 @@ HEADER
|styling| +
Vimperator allows you to style both the browser and any web pages you view. All
Vimperator 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
via the [c]:style[c] command, most Vimperator elements can be styled with the
[c]:highlight[c] command, for convenience.
@@ -102,7 +102,7 @@ ________________________________________________________________________________
|:sty| |:style| +
||:sty[le][!] [-name={name}] [-append] {filter} [{css}]|| +
________________________________________________________________________________
Add CSS styles to the browser or to web pages. {filter} is a comma
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

View File

@@ -199,20 +199,21 @@ Like [m]d[m] but selects the tab to the left of the deleted tab.
________________________________________________________________________________
|u| |:u| |:undo|
||:[count]u[ndo] [a][url][a]|| +
||[count]u||
________________________________________________________________________________
Undo closing of a tab. If a count is given, don't undo the last but the
[count]th last closed tab. With [a][url][a] restores the tab matching the URL.
________________________________________________________________________________
|:undoa| |:undoall| +
||:undoa[ll]||
________________________________________________________________________________
Undo closing of all closed tabs. Firefox stores up to 10 closed tabs, even
after a browser restart.
________________________________________________________________________________
// FIXME: No undo in Songbird for now.
//|u| |:u| |:undo|
//||:[count]u[ndo] [a][url][a]|| +
//||[count]u||
//________________________________________________________________________________
//Undo closing of a tab. If a count is given, don't undo the last but the
//[count]th last closed tab. With [a][url][a] restores the tab matching the URL.
//________________________________________________________________________________
//
//
//|:undoa| |:undoall| +
//||:undoa[ll]||
//________________________________________________________________________________
//Undo closing of all closed tabs. Songbird stores up to 10 closed tabs, even
//after a browser restart.
//________________________________________________________________________________
// vim: set filetype=asciidoc:

View File

@@ -34,14 +34,14 @@ Run a command. Runs {cmd} through system() and displays its output. Any \'!' in
backslash before the \'!', then that backslash is removed.
Warning: Input redirection (< foo) not done, also do not run commands which
require stdin or it will hang Firefox!
require stdin or it will hang Songbird!
________________________________________________________________________________
|:ve| |:version| +
||:ve[rsion][!]||
________________________________________________________________________________
Show version information. You can show the Firefox version page with
Show version information. You can show the Songbird version page with
[c]:version![c].
________________________________________________________________________________