README

   1 Abstract
   2 --------
   3 ii is a minimalistic FIFO and file system based IRC client. Upon connection, it
   4 creates an IRC directory prefix which contains the server directory (its name
   5 can be overridden by directory). Beyond the path, inside the server directory,
   6 there are channel and nickname directories together with a FIFO file named "ii"
   7 and a regular one called "out". These two latter files do also occur inside
   8 each channel and nickname directory, which themselves are created upon joining
   9 a channel or opening of a private conversation.
  10
  11 The FIFO files "in" are used to communicate with the server, while the regular
  12 "out" files carry the server messages. If the data sent to an "in" file is not
  13 an IRC command, in other words not starting with a slash "/", it will be
  14 interpreted as a regular message (PRIVMSG) which later pops up in the "out"
  15 file in the same directory level.
  16
  17 The idea of this file system structure, is to be able to communicate with an
  18 IRC server using basic command line tools. For example, if the desired action
  19 is to join a channel, the command echo /j #channel > in will do the trick no
  20 matter which "in" FIFO file it is addressed to, as long as the file is in use
  21 by the current instance of ii.
  22
  23 Installation
  24 ------------
  25 Edit config.mk to match your local setup. ii and wrapper are installed into
  26 /usr/local by default.
  27
  28 Afterwards, enter the following command to build and install ii and
  29 wrapper (if necessary, as root):
  30
  31     $ make clean install
  32
  33 Running ii
  34 ------------
  35 Simply invoke the 'ii' command with the arguments of your choice. For
  36 information about the available arguments, consult the manpage or pass ii the
  37 option "-h".
  38
  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 mappings like:
  42 map w1 :.w >> \#ii/in<cr>
  43 map w2 :.w >> \#wmii/in<cr>
  44 to post to channels.
  45
  46 If you use the next editor line for a new posting, you can use ctrl-p for nick
  47 completion if you have written the nick in the past.
  48 Thanks to Matthias Kopfermann for this hint.
  49
  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
  52
  53 Configuration
  54 -------------
  55 No configuration is needed.
  56
  57 Changelog
  58 ---------
  59 Since I missed the chance to add a proper changelog right from the beginning,
  60 please have a look at the commit messages on http://code.suckless.org/hg/ii/
  61 they are fairly descriptive on releases prior to 1.2.
  62
  63 Contact
  64 -------
  65 If you want to contact the developers, just write an e-mail to
  66 ii (at) modprobe (dot) de
  67
  68 -- Nico Golde, Anselm R. Garbe