ii.1 - ii - FIFO and filesystem based IRC client
 (HTM) git clone git://git.codemadness.org/ii
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
 (DIR) LICENSE
       ---
       ii.1 (2939B)
       ---
            1 .TH II 1 ii-VERSION
            2 .SH NAME
            3 ii - irc it or irc improved
            4 .SH SYNOPSIS
            5 .B ii
            6 .B -s
            7 .I host
            8 .RB [ -p
            9 .I port
           10 |
           11 .B -u
           12 .IR sockname ]
           13 .RB [ -i
           14 .IR ircdir ]
           15 .RB [ -n
           16 .IR nickname ]
           17 .RB [ -f
           18 .IR realname ]
           19 .RB [ -k
           20 .IR env_pass ]
           21 .SH DESCRIPTION
           22 .B ii
           23 is a minimalistic FIFO and filesystem based IRC client.
           24 It creates an irc directory tree with server, channel and
           25 nick name directories.
           26 In every directory a FIFO file (in) and normal file (out)
           27 is placed. This will be for example ~/irc/irc.freenode.net/.
           28 The in file is used to communicate with the servers and the out
           29 files includes the server messages. For every channel and every nick
           30 name there will be new in and out files.
           31 The basic idea of this is to be able to communicate with an IRC
           32 server with basic command line tools.
           33 For example if you will join a channel just do echo "/j #channel" > in
           34 and ii creates a new channel directory with in and out file.
           35 .SH OPTIONS
           36 .TP
           37 .BI -s " host"
           38 server/host to connect to, for example: irc.freenode.net
           39 .TP
           40 .BI -p " port"
           41 lets you override the default port (6667)
           42 .TP
           43 .BI -u " sockname"
           44 connect to a UNIX domain socket instead of directly to a server.
           45 If set, the
           46 .B -p
           47 option will be ignored.
           48 .TP
           49 .BI -i " ircdir"
           50 lets you override the default irc path (~/irc)
           51 .TP
           52 .BI -n " nickname"
           53 lets you override the default nick ($USER)
           54 .TP
           55 .BI -f " realname"
           56 lets you specify your real name associated with your nick
           57 .TP
           58 .BI -k " env_pass"
           59 lets you specify an environment variable that contains your IRC password,
           60 e.g. IIPASS="foobar" ii -k IIPASS.
           61 This is done in order to prevent other users from eavesdropping the server
           62 password via the process list.
           63 .SH DIRECTORIES
           64 .TP
           65 .B ~/irc
           66 In this directory the irc tree will be created. In this directory you
           67 will find a directory for your server (default: irc.freenode.net) in
           68 which the FIFO and the output file will be stored.
           69 If you join a channel a new directory with the name of the channel
           70 will be created in the
           71 .BI ~/irc/ servername /
           72 directory.
           73 .SH COMMANDS
           74 .TP
           75 .BI /a " [message]"
           76 mark yourself as away,
           77 with the optional
           78 .I message
           79 as an away reason.
           80 .TP
           81 .BI /j " #channel [password]"
           82 join a
           83 .IR #channel ,
           84 with the optional
           85 .IR password .
           86 .TP
           87 .BI /j " nickname [message]"
           88 open private conversation with user
           89 .I nickname
           90 and directly send the optional
           91 .IR message .
           92 .TP
           93 .BI /l " [reason]"
           94 leave a channel or query,
           95 giving the optional
           96 .I reason
           97 message.
           98 .TP
           99 .BI /n " nick"
          100 change the nick name to
          101 .IR nick .
          102 .TP
          103 .BI /q " [reason]"
          104 quit ii,
          105 giving the optional
          106 .I reason
          107 message.
          108 .TP
          109 .BI /t " topic"
          110 set the topic of a channel with
          111 .IR topic.
          112 .SH RAW COMMANDS
          113 Everything which is not a command will be posted into the channel or to the
          114 server.  So if you need /who just write /WHO as described in RFC#1459 to the
          115 server in FIFO.
          116 .SH SSL/TLS PROTOCOL SUPPORT
          117 For SSL/TLS protocol support you can connect to a local tunnel, for example
          118 with stunnel or socat.
          119 .SH SEE ALSO
          120 .BR echo (1),
          121 .BR tail (1)