summaryrefslogtreecommitdiff
path: root/xulmus/locale/en-US/intro.xml
blob: 8d58b802302f6c35625e3206fb1f39b625c7b10c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="chrome://liberator/content/help.xsl"?>

<!DOCTYPE document SYSTEM "chrome://liberator/content/liberator.dtd">

<document
    name="gui"
    title="&liberator.appname; GUI"
    xmlns="http://vimperator.org/namespaces/liberator"
    xmlns:html="http://www.w3.org/1999/xhtml">

    <logo/>

<h2 tag="intro">Introduction</h2>

<link topic="http://vimperator.org/%liberator.name;">&liberator.appname;</link>
is a free media player add-on for &liberator.hostapp;, which
combines the best features of the
<link topic="http://cmus.sourceforge.net">CMus</link>
music player and the http://www.vim.org[Vim] text editor.

|warning| +
<warning tag="warning">
    To provide the most authentic CMus/Vim experience, the &liberator.hostapp; toolbar
    is hidden.
    If you really need it, type: <ex>:set guioptions+=T</ex> to get it back.
    If you don't like &liberator.appname; at all, you can uninstall it by typing
    <ex>:extdelete &liberator.appname;</ex> or <ex>:extdisable &liberator.appname;</ex> to disable it.
    If you like it but can't remember the shortcuts, then press <k>F1</k> or
    <ex>:help</ex> to get this help window back.
</warning>

<tags>author donation</tags>
<p>
    &liberator.appname; was written by
    mailto:prathyushthota@gmail.com[Prathyush Thota].  If you
    appreciate my work on &liberator.appname; and want to encourage
    me working on it more, you can either send me greetings, patches
    or make a donation:
</p>

<!-- the PAYPAL code -->
<div xmlns="http://www.w3.org/1999/xhtml">
<form style="text-align: center;" action="https://www.paypal.com/cgi-bin/webscr" method="post"><fieldset class="paypal">
<input type="hidden" name="cmd" value="_s-xclick"/>
<input type="image" src="chrome://liberator/content/x-click-but21.gif" name="submit" alt="Make payments with PayPal - it\'s fast, free and secure!"/>
<input type="hidden" name="encrypted" value="-----BEGIN PKCS7-----MIIHPwYJKoZIhvcNAQcEoIIHMDCCBywCAQExggEwMIIBLAIBADCBlDCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20CAQAwDQYJKoZIhvcNAQEBBQAEgYBDDJfc+lXLBSAM9XSWv/ebzG/L7PTqYiIXaWVg8pfinDsfYaAcifcgCTuApg4v/VaZIQ/hLODzQu2EvmjGXP0twErA/Q8G5gx0l197PJSyVXb1sLwd1mgOdLF4t0HmDCdEI9z3H6CMhsb3xVwlfpzllSfCIqzlSpx4QtdzEZGzLDELMAkGBSsOAwIaBQAwgbwGCSqGSIb3DQEHATAUBggqhkiG9w0DBwQI8ZOwn5QkHgaAgZjjtPQxB7Vw2rS7Voap9y+xdVLoczUQ97hw+bOdZLcGykBtfoVjdn76MS51QKjGp1fEmxkqTuQ+Fxv8+OVtHu0QF/qlrhmC3fJBRJ0IFWxKdXS+Wod4615BDaG2X1hzvCL443ffka8XlLSiFTuW43BumQs/O+6Jqsk2hcReP3FIQOvtWMSgGTALnZx7x5c60u/3NSKW5qvyWKCCA4cwggODMIIC7KADAgECAgEAMA0GCSqGSIb3DQEBBQUAMIGOMQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDU1vdW50YWluIFZpZXcxFDASBgNVBAoTC1BheVBhbCBJbmMuMRMwEQYDVQQLFApsaXZlX2NlcnRzMREwDwYDVQQDFAhsaXZlX2FwaTEcMBoGCSqGSIb3DQEJARYNcmVAcGF5cGFsLmNvbTAeFw0wNDAyMTMxMDEzMTVaFw0zNTAyMTMxMDEzMTVaMIGOMQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDU1vdW50YWluIFZpZXcxFDASBgNVBAoTC1BheVBhbCBJbmMuMRMwEQYDVQQLFApsaXZlX2NlcnRzMREwDwYDVQQDFAhsaXZlX2FwaTEcMBoGCSqGSIb3DQEJARYNcmVAcGF5cGFsLmNvbTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAwUdO3fxEzEtcnI7ZKZL412XvZPugoni7i7D7prCe0AtaHTc97CYgm7NsAtJyxNLixmhLV8pyIEaiHXWAh8fPKW+R017+EmXrr9EaquPmsVvTywAAE1PMNOKqo2kl4Gxiz9zZqIajOm1fZGWcGS0f5JQ2kBqNbvbg2/Za+GJ/qwUCAwEAAaOB7jCB6zAdBgNVHQ4EFgQUlp98u8ZvF71ZP1LXChvsENZklGswgbsGA1UdIwSBszCBsIAUlp98u8ZvF71ZP1LXChvsENZklGuhgZSkgZEwgY4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzEUMBIGA1UEChMLUGF5UGFsIEluYy4xEzARBgNVBAsUCmxpdmVfY2VydHMxETAPBgNVBAMUCGxpdmVfYXBpMRwwGgYJKoZIhvcNAQkBFg1yZUBwYXlwYWwuY29tggEAMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADgYEAgV86VpqAWuXvX6Oro4qJ1tYVIT5DgWpE692Ag422H7yRIr/9j/iKG4Thia/Oflx4TdL+IFJBAyPK9v6zZNZtBgPBynXb048hsP16l2vi0k5Q2JKiPDsEfBhGI+HnxLXEaUWAcVfCsQFvd2A1sxRr67ip5y2wwBelUecP3AjJ+YcxggGaMIIBlgIBATCBlDCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20CAQAwCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTA3MDMyMTIyMzI1OFowIwYJKoZIhvcNAQkEMRYEFCirrvlwYVHQiNEEbM6ikfx9+Dm5MA0GCSqGSIb3DQEBAQUABIGAtbsR8GdCdURLziozXLSdtY+zJZUPPeQFXXy2V1S/3ldiN+pRvd4HI7xz8mOY1UaKJZpwZnOosy9MflL1/hbiEtEyQ2Dm/s4jnTcJng/NjLIZu+0NYxXRJhB+zMJubnMMMjzNrGlqI4F2HAB/bCA1eOJ5B83Of3dA4rk/T/8GoSQ=-----END PKCS7-----"/>
</fieldset></form>
</div>
<p>
    Of course as a believer in free open source software, only make
    a donation if you really like &liberator.appname; and the money
    doesn't hurt -- otherwise just use it, recommend it and like it
    :)
</p>

<h2 tag="overview">Help topics</h2>

<ul>
    <li><link topic="starting">Starting &liberator.appname;</link>: How &liberator.appname; starts up, where it reads the config file... </li>
    <li><link topic="player">Player mode</link>: Interacting with the media player.</li>
    <li><link topic="browsing">Browsing</link>: Basic mappings and commands needed for a browsing session (how to open a web page or go back in history).</li>
    <li><link topic="buffer">Buffer</link>: Operations on the current document like scrolling or copying text.</li>
    <li><link topic="cmdline">Command-line mode</link>: Command-line editing.</li>
    <li><link topic="insert">Insert mode</link>: Insert-mode editing.</li>
    <li><link topic="options">Options</link>: A description of all options.</li>
    <li><link topic="pattern">Text search commands</link>: Searching for text in the current buffer.</li>
    <li><link topic="tabs">Tabs</link>: Managing your tabbed browsing session.</li>
    <li><link topic="hints">Hints</link>: Selecting hyperlinks and other page elements.</li>
    <li><link topic="map">Key mappings, abbreviations, and user-defined commands</link>: Defining new key mappings, abbreviations and user commands.</li>
    <li><link topic="eval">Expression evaluation</link>: Executing JavaScript.</li>
    <li><link topic="marks">Marks</link>: Using bookmarks, QuickMarks, history and local marks.</li>
    <li><link topic="repeat">Repeating commands</link>: Using macros to repeat recurring workflows.</li>
    <li><link topic="autocommands">Automatic commands</link>: Automatically executing code on certain events.</li>
    <li><link topic="print">Printing</link>: Printing pages.</li>
    <li><link topic="gui">&liberator.appname;'s GUI</link>: Accessing &liberator.hostapp; menus, dialogs and the display panels.</li>
    <li><link topic="styling">Styling the GUI and web pages</link>: Changing the styling of content pages and &liberator.appname; itself.</li>
    <li><link topic="message">Error and informational messages</link>: A description of messages and error messages.</li>
    <li><link topic="developer">Developer information</link>: How to write docs or plugins.</li>
    <li><link topic="various">Various commands</link>: Other help which didn't fit into any other category.</li>
    <li><link topic="index">Index</link>: An index of all commands and options.</li>
</ul>
<p>
    You can also jump directly to the help of a specific command
    with <ex>:help o</ex> or <ex>:help :set</ex>.
</p>

<h2 tag="features">Features</h2>

<!-- TODO: make Xulmus specific -->
<ul>
    <li>Vim-like keybindings (<k>h</k>, <k>j</k>, <k>k</k>, <k>l</k>, <k>gg</k>, <k>G</k>, <k>0</k>, <k>$</k>, <k>ZZ</k>, <k name="C-f"/>, etc.)</li>
    <li>Ex commands (<ex>:quit</ex>, <ex>:open www.foo.com</ex>, ...)</li>
    <li>Tab completion available for all commands with support for "longest" matching when set in 'wildmode'</li>
    <li>Hit-a-hint like navigation of links (start with <k>f</k> to follow a link)</li>
    <li>Advanced completion of bookmark and history URLs (searching also in title, not only URL)</li>
    <li>Vim-like statusline with a Wget-like progress bar</li>
    <li>Minimal GUI (easily hide useless menubar and toolbar with <ex>:set guioptions=</ex>)</li>
    <li>Ability to <ex>:source</ex> JavaScript files, and to use a [a]~/.xulmusrc[a] file with syntax highlighting if you install http://code.google.com/p/vimperator-labs/issues/detail?id=50[xulmus.vim]</li>
    <li>Easy quick searches (<ex>:open foo</ex> will search for "foo" in google, <ex>:open ebay terminator</ex> will search for "terminator" on ebay) with support for &liberator.hostapp; keyword bookmarks and search engines</li>
    <li>Count supported for many commands (<em>3</em><k name="C-o"/> will go back 3 pages)</li>
    <li>Beep on errors</li>
    <li>Marks support (<k>m</k><em>a</em> to set mark a on a web page, <k>'</k><em>a</em> to go there)</li>
    <li>QuickMarks support (quickly go to previously marked web pages with <k>go</k><a>a-zA-Z0-9</a>)</li>
    <li><ex>:map</ex> and <ex>:command</ex> support (and feedkeys() for script writers)</li>
    <li><ex>:time</ex> support for profiling</li>
    <li>Move the text cursor and select text with Vim keys and a Visual mode</li>
    <li>External editor support</li>
    <li>Macros to replay key strokes</li>
    <li>AutoCommands to execute actions on certain events</li>
    <li>A comprehensive help system, explaining all commands, mappings and options</li>
</ul>

<h2 tag="contact">Contact</h2>
<p>
    Please send comments/bug reports/patches to the mailing list,
    where we will properly answer any questions. You can also join
    the
    <link topic="irc://irc.freenode.net/vimperator">#vimperator</link>
    IRC channel on
    <link topic="http://www.freenode.net/">Freenode</link> or check the
    <link topic="http://code.google.com/p/vimperator-labs/w/list?q=label%3Aproject-xulmus">Wiki</link>
    for
    <link topic="http://code.google.com/p/vimperator-labs/wiki/&liberator.appname;FAQ">
        frequently asked questions (FAQ)</link>.
    Make sure, you have read the
    <link topic="http://vimperator-labs.googlecode.com/hg/xulmus/TODO">TODO</link>
    file first, as we are aware of many things which can be improved
    when we find time for it or receive patches.
</p>

</document>

<!-- vim:se sts=4 sw=4 et: -->