Added SILC Thread Queue API
[crypto.git] / apps / irssi / docs / manual.txt
index 7c25c7bc54c7b421fa42552bd97c8be0bd5aa904..d66930fc1f3e3df6208b97325090500ddedc4e51 100644 (file)
@@ -1,7 +1,7 @@
 
  Irssi 0.8 documentation - http://irssi.org/
 
- Copyright(c) 2000 Timo Sirainen <tss@iki.fi>
+ Copyright(c) 2000 Timo Sirainen <cras@irssi.org>
 
 
  Index
        --enable-memdebug  Enable memory debugging, great for finding
                           memory leaks
 
-       --enable-perl=static  Build Perl support statically to irssi binary
+       --with-perl=static Build Perl support statically to irssi binary
                           (default is to build a module)
-       --enable-perl-path=dir  Specify installation dir for Perl libraries
-       --disable-perl     Disable Perl support
+       --with-perl-lib=[site|vendor|DIR]  Specify installation dir for
+                          Perl libraries. Site is the default (usually
+                          /usr/local/lib/perl/...), vendor uses the path
+                          where the base of the perl is installed
+                          (/usr/lib/perl/...), or DIR specifies exactly
+                          where you want to install it.
+       --without-perl     Disable Perl support
 
        --with-socks       Build with socks library
        --with-bot         Build irssi-bot
 
        Servers are referenced by a "server tag". If the server is known
        to belong to some IRC network, the tag is the IRC network's name,
-       like "ircnet". If the IRC network is unknown, the tag is created
+       like "IRCnet". If the IRC network is unknown, the tag is created
        from the server's name, like irc.funet.fi -> funet. If the tag
        already exists, a number is added to the end of it and raised until
        unused tag is found.
        or the safe defaults will be used. The default configuration file
        contains the settings for the biggest IRC networks.
 
-       /IRCNET ADD [-kicks <count>] [-msgs <count>] [-modes <count>]
+       /NETWORK ADD [-kicks <count>] [-msgs <count>] [-modes <count>]
                    [-whois <count>] [-cmdspeed <ms>] [-cmdmax <count>]
                    [-nick <nick>] [-user <user>] [-realname <name>]
                    [-host <host>] [-autosendcmd <cmd>] <name>
            -autosendcmd: Command to send after connecting to a server
 
        With -autosendcmd argument you can automatically run any commands
-       after connecting to ircnet. This is useful for automatically 
+       after connecting to the network. This is useful for automatically 
        identifying yourself to NickServ, for example
 
-       /IRCNET ADD -autosendcmd "/msg NickServ identify secret" OPN
+       /NETWORK ADD -autosendcmd "/msg NickServ identify secret" freenode
 
-       /IRCNET REMOVE <name>
+       /NETWORK REMOVE <name>
 
  5.3 Manually connecting and disconnecting
 
        To connect to a new server, use:
-       /CONNECT [-ircnet <ircnet>] [-host <hostname>] <address>|<ircnet>
+       /CONNECT [-network <network>] [-host <hostname>] <address>|<network>
                 [<port> [<password> [<nick>]]]
 
        If there's no password, set it to -. You can directly connect to
 
  5.4 Server settings
 
-       /SERVER ADD [-auto | -noauto] [-ircnet <ircnet>] [-host <hostname>]
+       /SERVER ADD [-auto | -noauto] [-network <network>] [-host <hostname>]
                    [-cmdspeed <ms>] [-cmdmax <count>] [-port <port>]
                    <address> [<port> [<password>]]
 
            -auto: Automatically connect to server at startup
            -noauto: Don't connect to server at startup (default)
-           -ircnet: Specify what IRC network this server belongs to
+           -network: Specify what IRC network this server belongs to
+           -ircnet: Same as -network. Deprecated. Do not use.
            -host: Specify what host name to use, if you have multiple
            -cmdspeed: Same as /SET cmd_queue_speed, see section 3.1
            -cmdmax: Same as /SET cmd_max_at_once, see section 3.1
        manually joining to channel without specifying the password.
 
        /CHANNEL ADD [-auto | -noauto] [-bots <masks>] [-botcmd <command>]
-                <channel> <ircnet> [<password>]
+                <channel> <network> [<password>]
 
        With -bots and -botcmd arguments you can automatically send
        commands to someone in channel. This is useful for automatically
        can be removed by setting it to - (or actually, "" works too).
 
        You can remove the channels with
-       /CHANNEL REMOVE <channel> <ircnet>
+       /CHANNEL REMOVE <channel> <network>
 
        /CHANNEL LIST displays list of channels with settings.
        /CHANNEL without any arguments displays list of channels you have
        are in IRC all the time. So I made a bit more featureful notify
        list:
 
-       /NOTIFY [-list] [-away] [-idle [minutes]] <mask> [ircnet [ircnet...]]
+       /NOTIFY [-list] [-away] [-idle [minutes]] <mask> [network [network...]]
 
            -away: Notifies about away-status changes
            -idle: Notifies if idle time is first larger than <minutes>
            -regexp: <text> is a regular expression
            -word: <text> must match to full words
            -nick: Hilight only the nick, not the whole line
-           -color: Print the reply with <color> - see below
+           -color: Print the reply with <color>. color is in %code format
+                   (see docs/formats.txt)
            -level: Match only for <level> messages, default is
                    publics,msgs,notices,actions
            -channels: Match only in <channels>
 
        /HILIGHT without any arguments displays list of the hilights.
 
-       By default the highlighted line will be printed with white color.
-       You can change this with the -color argument. If <color> is a
+If <color> is a
        number, Irssi will treat it as a MIRC color code. You can also use
        bolds (^B), underlines (^_) etc. as <color> if you like.