README

   1 Abstract
   2 --------
   3 ii is a minimalistic FIFO and filesystem based IRC client.  It creates an irc
   4 directory tree with server, channel and nick name directories.  In every
   5 directory a FIFO file (in) and and normal file (out) is placed.
   6
   7 The in file is used to communicate with the servers and the out files include
   8 the server messages. For every channel and every nick name there will be new in
   9 and out files.
  10
  11 The basic idea of this is to be able to communicate with an IRC server with
  12 standard command line tools.  For example if you want to join a channel just do
  13 echo "/j #channel" > in and ii creates a new channel directory with in and out
  14 file.
  15
  16 Installation
  17 ------------
  18 Edit config.mk to match your local setup. ii is installed into
  19 /usr/local by default.
  20
  21 Afterwards enter the following command to build and install ii (if
  22 necessary as root):
  23
  24     $ make clean install
  25
  26 Running ii
  27 ------------
  28 Simply invoke the 'ii' command with required arguments
  29
  30 To make ii a bit more comfortable use it in combination with the multitail
  31 program and for example with vim. Run vim in the server directory and use
  32 key mapping like:
  33 map w1 :.w >> \#ii/in<cr>
  34 map w2 :.w >> \#wmii/in<cr>
  35 to post to channels.
  36
  37 If you use the next editor line for a new posting you can use ctrl-p for nick
  38 completion if you wrote the nick in the past.
  39 Thanks to Matthias Kopfermann for this hint.
  40
  41 You can find an example of how this nested environment could look like on:
  42 http://nion.modprobe.de/blog/archives/440-Using-the-ii-irc-client.html
  43
  44 Configuration
  45 -------------
  46 No configuration is needed.
  47
  48 Changelog
  49 ---------
  50 Since I missed the chance to add a proper changelog right from the beginning,
  51 please have a look at the commit messages on http://code.suckless.org/hg/ii/
  52 they are fairly descriptive on releases prior to 1.2.
  53
  54 Contact
  55 -------
  56 If you want to contact the developers just write a mail to
  57 ii (at) modprobe (dot) de
  58
  59 -- Nico Golde, Anselm R. Garbe