git clone https://orangeshoelaces.net/git/ii.git


   1 Abstract
   2 --------
   3 This is a fork of ii acting as a pure protocol handler. Messages from the
   4 server are expected on the standard input and standard output is used to
   5 send messages to the server. Tools like socat, nc or tcpclient can be used
   6 to provide network connectivity.
   8 ii is a minimalistic FIFO and filesystem based IRC client.  It creates an irc
   9 directory tree with server, channel and nick name directories. In every
  10 directory a FIFO file (in) and normal file (out) is placed.
  12 The in file is used to communicate with the servers and the out files include
  13 the server messages. For every channel and every nick name there will be new in
  14 and out files.
  16 The basic idea of this is to be able to communicate with an IRC server with
  17 standard command line tools.  For example if you want to join a channel just do
  18 echo "/j #channel" > in and ii creates a new channel directory with in and out
  19 file.
  22 Installation
  23 ------------
  24 Edit config.mk to match your local setup. ii is installed into
  25 /usr/local by default.
  27 Afterwards enter the following command to build and install ii (if
  28 necessary as root):
  30     $ make clean install
  33 Running ii
  34 ------------
  35 Here's how you can run ii with socat:
  37     $ socat EXEC:'ii -s irc.freenode.net' OPENSSL:irc.freenode.net:6697
  39 To make ii a bit more comfortable use it in combination with the multitail
  40 program and for example with vim. Run vim in the server directory and use
  41 key mapping like:
  42 map w1 :.w >> \#ii/in<cr>
  43 map w2 :.w >> \#wmii/in<cr>
  44 to post to channels.
  46 If you use the next editor line for a new posting you can use ctrl-p for nick
  47 completion if you wrote the nick in the past.
  48 Thanks to Matthias Kopfermann for this hint.
  50 You can find an example of how this nested environment could look like on:
  51 http://nion.modprobe.de/blog/archives/440-Using-the-ii-irc-client.html
  54 Configuration
  55 -------------
  56 No configuration is needed.
  59 Changelog
  60 ---------
  61 Since I missed the chance to add a proper changelog right from the beginning,
  62 please have a look at the commit messages on http://git.suckless.org/ii/
  63 they are fairly descriptive on releases prior to 1.2.