ii.1

   1 .de FN
   2 \fI\|\\$1\|\fP\\$2
   3 ..
   4 .TH ii 1
   5 .SH NAME
   6 ii \- irc it or irc improved
   7
   8 .SH DESCRIPTION
   9 .B ii
  10 is a minimalistic FIFO and filesystem based IRC client.
  11 It creates an irc directory tree with server, channel and
  12 nick name directories.
  13 In every directory a FIFO file (in) and and normal file (out)
  14 is placed. This will be for example ~/irc/irc.freenode.net/.
  15 The in file is used to communicate with the servers and the out
  16 files includes the server messages. For every channel and every nick
  17 name there will be new in and out files.
  18 The basic idea of this is to be able to communicate with an IRC
  19 server with basic command line tools.
  20 For example if you will join a channel just do echo "/j #channel" > in
  21 and ii creates a new channel directory with in and out file.
  22 .SH SYNOPSIS
  23 .B ii
  24 .RB [ \-s
  25 .IR servername ]
  26 .RB [ \-p
  27 .IR port ]
  28 .RB [ \-k
  29 .IR password ]
  30 .RB [ \-i
  31 .IR prefix ]
  32 .RB [ \-n
  33 .IR nickname ]
  34 .RB [ \-f
  35 .IR realname ]
  36
  37 .SH OPTIONS
  38 .TP
  39 .BI \-s " servername"
  40 lets you override the default servername (irc.freenode.net)
  41 .TP
  42 .BI \-p " port"
  43 lets you override the default port (6667)
  44 .TP
  45 .BI \-k " password"
  46 lets you use a password to authenticate your nick on the server
  47 (be aware of the problem that this is visible in the process list, if you
  48 don't want this use a query to submit your password)
  49 .TP
  50 .BI \-i " prefix"
  51 lets you override the default irc path (~/irc)
  52 .TP
  53 .BI \-n " nickname"
  54 lets you override the default nick ($USER)
  55 .TP
  56 .BI \-f " realname"
  57 lets you specify your real name associated with your nick
  58
  59 .SH DIRECTORIES
  60 .TP
  61 .FN ~/irc
  62 In this directory the irc tree will be created. In this directory you
  63 will find a directory for your server (default: irc.freenode.net) in
  64 which the FIFO and the output file will be stored.
  65 If you join a channel a new directory with the name of the channel
  66 will be created in the ~/irc/$servername/ directory.
  67
  68 .SH COMMANDS
  69 .TP
  70 .FN /j " #channel/nickname [<message>]"
  71 join a channel or open private conversation with user
  72 .TP
  73 .FN /l " #channel/nickname"
  74 leave a channel or query
  75 .TP
  76 .FN /n " nick"
  77 change the nick name
  78 .TP
  79 .FN /t " topic"
  80 set the topic of a channel
  81 .TP
  82 Everything which is not a command will simply be posted into the channel or to the server.
  83 So if you need /who just write /WHO as described in the RFC to the server in FIFO.
  84 .TP
  85 .FN "out file usage"
  86 Write wrappers, pagers or use your tools of choice to display the out file contents (loco, multitail, etc.).
  87 .SH CONTACT
  88 .TP
  89 Write to ii (at) modprobe (dot) de for suggestions, fixes, 7|-|>< ;) etc.
  90 .SH AUTHORS
  91 Copyright \(co 2005-2006 by Anselm R. Garbe <garbeam (at) gmail (dot) com> and
  92 Copyright \(co 2005-2008 by Nico Golde <nico (at) ngolde (dot) de>
  93 .SH SEE ALSO
  94 .BR echo (1),
  95 .BR tail (1),