README

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