Merged Irssi 0.8.2 from irssi.org cvs.
[silc.git] / apps / irssi / docs / startup-HOWTO.html
index ddd5d025ba1de271fbf93d4d1e467fc23dfdc411..af92b83e4a30660951d0371a03acb8ef4ad99c82 100644 (file)
@@ -9,6 +9,9 @@
 
 <ol>
 <li><a href="#c1">For all the lazy people</a></li>
+    <ul>
+    <li>This window management is just weird, I want it exactly like ircII</li>
+    </ul>
 <li><a href="#c2">Basic user interface usage</a>
     <ul>
     <li>Split windows work in weird way</li>
     </ul></li>
 <li><a href="#c10">Proxies and IRC bouncers</a></li>
 <li><a href="#c11">Irssi's settings</a></li>
+<li><a href="#c12">Statusbar</a>
+    <ul>
+    <li>I loaded a statusbar script but it's not visible anywhere!</li>
+    </ul></li>
 </ol>
 
 <h3><a id="c1">1. For all the lazy people</a></h3>
 
 <p>These settings should give you pretty good defaults (the ones I use):</p>
 
+<p>If colors don't work, and you know you're not going to use some
+weird non-VT compatible terminal (you most probably aren't), just
+say:</p>
+
+<pre>
+     /SET term_force_colors ON
+</pre>
+
 <p>I don't like automatic query windows, I don't like status window, I do
 like msgs window where all messages go:</p>
 
@@ -67,6 +82,22 @@ query:</p>
      /SET reuse_unused_windows ON
 </pre>
 
+<p>Here's the settings that make irssi work exactly like ircII in window
+management (send me a note if you can think of more):</p>
+
+<pre>
+     /SET autocreate_own_query OFF
+     /SET autocreate_query_level NONE
+     /SET use_status_window OFF
+     /SET use_msgs_window OFF
+     /SET reuse_unused_windows ON
+     /SET windows_auto_renumber OFF
+
+     /SET autostick_split_windows OFF
+     /SET autoclose_windows OFF
+     /SET print_active_channel ON
+</pre>
+
 <p>And example how to add servers:</p>
 
 <p>(openprojects network, identify with nickserv and wait for 2 seconds before
@@ -202,6 +233,13 @@ automatic creating of them with</p>
      /SET autocreate_windows OFF
 </pre>
 
+<p>And if you keep all channels in one window, you most probably want
+the channel name printed in each line:</p>
+
+<pre>
+     /SET print_active_channel ON
+</pre>
+
 <p>If you want to group only some channels or queries in one window,
 use</p>
 
@@ -539,8 +577,44 @@ be better to use eg.:</p>
 
 <h3><a id="c10">10. Proxies and IRC bouncers</a></h3>
 
-<p>Irssi supports connecting to IRC servers via a proxy. All proxies have
-these settings in common:</p>
+<p>Irssi supports connecting to IRC servers via a proxy. All server
+connections are then made through it, and if you've set up everything
+properly, you don't need to do any /QUOTE SERVER commands manually.</p>
+
+<p>Here's an example: You have your bouncer (lets say, BNC or BNC-like)
+listening in irc.bouncer.org port 5000. You want to use it to connect
+to servers irc.dalnet and irc.efnet.org. First you'd need to setup the
+bouncer:</p>
+
+<pre>
+     /SET use_proxy ON
+     /SET proxy_address irc.bouncer.org
+     /SET proxy_port 5000
+
+     /SET proxy_password YOUR_BNC_PASSWORD_HERE
+     /SET -clear proxy_string
+     /SET proxy_string_after conn %s %d
+</pre>
+
+<p>Then you'll need to add the server connections. These are done
+exactly as if you'd want to connect directly to them. Nothing special
+about them:</p>
+
+<pre>
+     /SERVER ADD -auto -ircnet dalnet irc.dal.net
+     /SERVER ADD -auto -ircnet efnet irc.efnet.org
+</pre>
+
+<p>With the proxy /SETs however, irssi now connects to those servers
+through your BNC. All server connections are made through them so you
+can just forget that your bouncer even exists.</p>
+
+<p>If you don't want to use the proxy for some reason, there's -noproxy
+option which you can give to /SERVER and /SERVER ADD commands.</p>
+
+<p><strong>Proxy specific settings:</strong></p>
+
+<p>All proxies have these settings in common:</p>
 
 <pre>
      /SET use_proxy ON
@@ -562,7 +636,7 @@ these settings in common:</p>
 <pre>
      /SET proxy_password your_pass
      /SET -clear proxy_string
-     /SET proxy_string conn %s %d
+     /SET proxy_string_after conn %s %d
 </pre>
 
 <p><strong>dircproxy</strong></p>
@@ -583,6 +657,26 @@ this:</p>
 <p>The server name and port you give isn't used anywhere, so you can
 put anything you want in there.</p>
 
+<p><strong>psyBNC</strong></p>
+
+<p>psyBNC has internal support for multiple servers. However, it could
+be a bit annoying to use, and some people just use different users for
+connecting to different servers. You can manage this in a bit same way
+as with dircproxy, by creating fake connections:</p>
+
+<pre>
+    /SET -clear proxy_password
+    /SET -clear proxy_string
+
+    /IRCNET ADD -user ircnetuser ircnet
+    /SERVER ADD -auto -ircnet ircnet fake.ircnet 6667 ircpass
+    /IRCNET ADD -user opnuser opn
+    /SERVER ADD -auto -ircnet opn fake.opn 6667 opnpass
+</pre>
+
+<p>So, you'll specify the usernames with /IRCNET ADD command, and the
+user's password with /SERVER ADD.</p>
+
 <p><strong>Irssi proxy</strong></p>
 
 <p>Irssi contains it's own proxy which you can build giving
@@ -796,6 +890,7 @@ of them you might want to change (the default value is shown):</p>
   or queries, list them here. For example "#boringchannel =bot1 =bot2".
   If any highlighted text or message for you appears in that window, this
   setting is ignored and the activity is shown.</dd>
+</dl>
 
 <p><strong>Nick completion</strong></p>
 
@@ -808,3 +903,50 @@ of them you might want to change (the default value is shown):</p>
 <dt>/SET completion_char :</dt>
   <dd>Completion character to use.</dd>
 </dl>
+
+<h3><a id="c12">12. Statusbar</a></h3>
+
+<p><strong>/STATUSBAR</strong> displays a list of statusbars:</p>
+
+<pre>
+Name                           Type   Placement Position Visible
+window                         window bottom    0        always
+window_inact                   window bottom    1        inactive
+prompt                         root   bottom    100      always
+topic                          root   top       1        always
+</pre>
+
+<p><strong>/STATUSBAR &lt;name&gt;</strong> prints the statusbar
+settings and it's items. <strong>/STATUSBAR &lt;name&gt;
+ENABLE|DISABLE</strong> enables/disables the statusbar.
+<strong>/STATUSBAR &lt;name&gt; RESET</strong> resets the statusbar to
+it's default settings, or if the statusbar was created by you, it will be
+removed.</p>
+
+<p>Type can be window or root, meaning if the statusbar should be
+created for each split window, or just once. Placement can be top or
+bottom. Position is a number, the higher the value the lower in screen
+it is. Visible can be always, active or inactive. Active/inactive is
+useful only with split windows, one split window is active and the rest
+are inactive. These settings can be changed with:</p>
+
+<ul>
+<li>STATUSBAR &lt;name&gt; TYPE window|root</li>
+<li>STATUSBAR &lt;name&gt; PLACEMENT top|bottom</li>
+<li>STATUSBAR &lt;name&gt; POSITION &lt;num&gt;</li>
+<li>STATUSBAR &lt;name&gt; VISIBLE always|active|inactive</li>
+</ul>
+
+<p>When loading a new statusbar scripts, you'll need to also specify
+where you want to show it. Statusbar items can be modified with:</p>
+
+<ul>
+<li>10:52 STATUSBAR &lt;name&gt; ADD [-before | -after &lt;item&gt;] [-priority #] [-alignment left|right] &lt;item&gt;</li>
+<li>10:52 STATUSBAR &lt;name&gt; REMOVE &lt;item&gt;</li>
+</ul>
+
+<p>The item name with statusbar scripts is usually same as the script's
+name. Script's documentation should tell if this isn't the case. So, to
+add mail.pl before the window activity item (see the list with
+/STATUSBAR window), use: <strong>/STATUSBAR window ADD -before act
+mail</strong>.</p>