34 lines
1.4 KiB
HTML
34 lines
1.4 KiB
HTML
<h2 id="iron-documentation">iron documentation</h2>
|
|
<p>iron provides documentation in the form of a markdown document. This can be used however is deemed necessary, such as with pandoc to automatically write man pages, HTML and other formats.</p>
|
|
<h2 id="commands">Commands</h2>
|
|
<p>Full list of all commands in iron by default. More may be added through patches available on the website.</p>
|
|
<ul>
|
|
<li>':q' - Quit iron</li>
|
|
<li>':l' - Leave the instance</li>
|
|
<li>':r' - Refresh</li>
|
|
<li>':e' - Compose a message in $EDITOR (or Vi if none is specified)</li>
|
|
<li>':reset' - Reset all settings (including instance) to default.</li>
|
|
<li>':set instance' - Set the instance</li>
|
|
<li>':set instance default' - Set the instance to the default</li>
|
|
<li>':set captcha' - Set the captcha.</li>
|
|
</ul>
|
|
<h2 id="keybinds">Keybinds</h2>
|
|
<p>Full list of all keybinds in iron</p>
|
|
<ul>
|
|
<li>i - Enter insert mode</li>
|
|
<li>r - Refresh messages</li>
|
|
<li>: - Enter command mode</li>
|
|
<li>e - Compose a message in $EDITOR</li>
|
|
<li>q - Leave the instance</li>
|
|
<li>l - Leave the instance</li>
|
|
<li>ZQ - Quit iron</li>
|
|
<li>ZZ - Leave the instance</li>
|
|
</ul>
|
|
<h2 id="usage">Usage</h2>
|
|
<ul>
|
|
<li>iron - Runs iron</li>
|
|
</ul>
|
|
<p>If an instance is not set, it must be set before iron can be used.</p>
|
|
<h2 id="more">More</h2>
|
|
<p>See iron.md for the rest of the documentation.</p>
|