updates.
[runtime.git] / apps / irssi / docs / startup-HOWTO.txt
index cf989546379beed27130a88d63eb3ec99aeabbb7..611965bc8b0d5a52befa123e82a650d85b75d0c1 100644 (file)
@@ -2,14 +2,15 @@ Startup HOWTO
 
   To new Irssi users (not to new IRC users ..)
 
-   Copyright (c) 2000-2001 by Timo Sirainen
+   Copyright (c) 2000-2002 by Timo Sirainen
 
    Index with some FAQ questions that are answered in the chapter:
     1. For all the lazy people
     2. Basic user interface usage
+          + Split windows work in weird way
     3. Server and channel automation
-          + how do I automatically connect to servers at startup?
-          + how do I automatically join to channels at startup?
+          + How do I automatically connect to servers at startup?
+          + How do I automatically join to channels at startup?
     4. Setting up windows and automatically restoring them at startup
     5. Status and msgs windows & message levels
           + I want /WHOIS to print reply to current window
@@ -23,8 +24,10 @@ Startup HOWTO
     7. /LASTLOG and jumping around in scrollback
           + How can I save all texts in a window to file?
     8. Logging
-    9. Proxies and IRC bouncers
-   10. Irssi's settings
+    9. Changing keyboard bindings
+          + How do I make F1 key do something?
+   10. Proxies and IRC bouncers
+   11. Irssi's settings
 
   1. For all the lazy people
 
@@ -257,7 +260,7 @@ Startup HOWTO
    Instead of the /SERVER which disconnects the existing connection. To
    see list of all active connections, use /SERVER without any
    parameters. You should see a list of something like:
-     -!- IRCNet: irc.telia.fi:6667 (IRCNet)
+     -!- IRCNet: irc.song.fi:6667 (IRCNet)
      -!- OPN: tolkien.openprojects.net:6667 (OPN)
      -!- RECON-1: 192.168.0.1:6667 () (02:59 left before reconnecting)
 
@@ -331,9 +334,9 @@ Startup HOWTO
      /LASTLOG word 10  - print last 10 occurances of "word"
      /LASTLOG -topics  - print all topic changes
 
-   If there's more lines to be printed than 1000, irssi doesn't thinks
-   that you probably made some mistake and won't print them without
-   -force option. If you want to save the full lastlog to file, use
+   If there's more than 1000 lines to be printed, irssi thinks that you
+   probably made some mistake and won't print them without -force option.
+   If you want to save the full lastlog to file, use
      /LASTLOG -file ~/irc.log
 
    With -file option you don't need -force even if there's more than 1000
@@ -377,7 +380,30 @@ Startup HOWTO
 
    For logging only some specific channels or nicks, see /HELP log
 
-  9. Proxies and IRC bouncers
+  9. Changing keyboard bindings
+
+   You can change any keyboard binding that terminal lets irssi know
+   about. It doesn't let irssi know everything, so for example
+   shift-backspace can't be bound unless you modify xterm resources
+   somehow.
+
+   /HELP bind tells pretty much everything there is to know about
+   keyboard bindings. However, there's the problem of how to bind some
+   non-standard keys. They might differ a bit with each terminal, so
+   you'll need to find out what exactly the keypress produces. Easiest
+   way to check that would be to see what it prints in "cat". Here's an
+   example for pressing F1 key:
+[cras@hurina] ~% cat
+^[OP
+
+   So in irssi you would use /BIND ^[OP /ECHO F1 pressed. If you use
+   multiple terminals which have different bindings for the key, it would
+   be better to use eg.:
+/BIND ^[OP key F1
+/BIND ^[11~ key F1
+/BIND F1 /ECHO F1 pressed.
+
+  10. Proxies and IRC bouncers
 
    Irssi supports connecting to IRC servers via a proxy. All proxies have
    these settings in common:
@@ -391,6 +417,26 @@ Startup HOWTO
      /SET -clear proxy_password
      /EVAL SET proxy_string CONNECT %s:%d\n\n
 
+   BNC
+     /SET proxy_password your_pass
+     /SET -clear proxy_string
+     /SET proxy_string conn %s %d
+
+   dircproxy
+
+   dircproxy separates the server connections by passwords. So, if you
+   for example have ircnet connection with password ircpass and
+   openprojects connection with opnpass, you would do something like
+   this:
+     /SET -clear proxy_password
+     /SET -clear proxy_string
+
+     /SERVER ADD -auto -ircnet ircnet fake.ircnet 6667 ircpass
+     /SERVER ADD -auto -ircnet opn fake.opn 6667 opnpass
+
+   The server name and port you give isn't used anywhere, so you can put
+   anything you want in there.
+
    Irssi proxy
 
    Irssi contains it's own proxy which you can build giving --with-proxy
@@ -406,7 +452,7 @@ Startup HOWTO
    ports, like you can share ircnet in port 2777 and efnet in port 2778.
 
    Usage in proxy side:
-     /LOAD irc_proxy (/LOAD proxy in irssi 0.7.98.3 and older)
+     /LOAD proxy
      /SET irssiproxy_password <password>
      /SET irssiproxy_ports <ircnet>=<port> ... (eg. ircnet=2777 efnet=2778)
 
@@ -414,7 +460,7 @@ Startup HOWTO
    lists with /SERVER ADD and /IRCNET ADD. ..Except if you really don't
    want to for some reason, and you only use one server connection, you
    may simply set:
-     /SET irssiproxy_ports *=2777 (irssi 0.7.99 and later only)
+     /SET irssiproxy_ports *=2777
 
    Usage in client side:
 
@@ -436,12 +482,15 @@ Startup HOWTO
    can give it with:
      /SET proxy_password <password>
 
-   Irssi's default for connect string is
+   Irssi's defaults for connect strings are
      /SET proxy_string CONNECT %s %d
+     /SET proxy_string_after
 
-   which you can modify according to your bouncer's needs.
+   The proxy_string is sent before NICK/USER commands, the
+   proxy_string_after is sent after them. %s and %d can be used with both
+   of them.
 
-  10. Irssi's settings
+  11. Irssi's settings
 
    You probably don't like Irssi's default settings. I don't like them.
    But I'm still convinced that they're pretty good defaults. Here's some
@@ -561,9 +610,6 @@ Startup HOWTO
           Show quit message only once in some of the channel windows the
           nick was in instead of in all windows.
 
-   /SET topicbar ON
-          Show the channel's topic in top of screen.
-
    /SET lag_min_show 100
           Show the server lag in status bar if it's bigger than this, the
           unit is 1/100 of seconds (ie. the default value of 100 = 1
@@ -582,17 +628,12 @@ Startup HOWTO
           message for you appears in that window, this setting is ignored
           and the activity is shown.
 
-   /SET mail_counter ON
-          Show the number of mails in your mbox in status bar. The mbox
-          file is taken from $MAIL environment setting. Only mbox format
-          works for now.
-
-   Nick completion
+          Nick completion
 
-   /SET completion_auto OFF
-          Automatically complete the nick if line begins with start of
-          nick and the completion character. Learn to use the
-          tab-completion instead, it's a lot better ;)
+        /SET completion_auto OFF
+                Automatically complete the nick if line begins with start
+                of nick and the completion character. Learn to use the
+                tab-completion instead, it's a lot better ;)
 
-   /SET completion_char :
-          Completion character to use.
+        /SET completion_char :
+                Completion character to use.