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. It creates an IRC
  11 directory tree with server, channel and nickname directories. In every
  12 directory a FIFO file (in) and a normal file (out) is placed. This will be for
  13 example in irc/irc.freenode.net/. The in file is used to communicate with the
  14 servers and the out files include the server messages. For every channel and
  15 every nickname, there will be a new in and out file. The idea of this is to be
  16 able to communicate with an IRC server using basic command line tools.  For
  17 example if you want to join a channel, just echo "/j #channel" > in and ii
  18 will create a new channel directory with an in and out file inside it.
  19
  20 .SH SYNOPSIS
  21 .B ii
  22 .RB [ \-s
  23 .IR servername ]
  24 .RB [ \-p
  25 .IR port ]
  26 .RB [ \-k
  27 .IR password ]
  28 .RB [ \-i
  29 .IR prefix ]
  30 .RB [ \-n
  31 .IR nickname ]
  32 .RB [ \-f
  33 .IR realname ]
  34 .RB [ \-d
  35 .IR directory ]
  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 nickname on the server. (Be aware
  47 of the problem that this is visible in the process list. If you don't want
  48 this, then simply 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 nickname. (anonymous)
  55 .TP
  56 .BI \-f " realname"
  57 Lets you specify your real name associated with your nickname.
  58 .TP
  59 .BI \-d " directory"
  60 Lets you override the servername part in the directory tree structure. Useful
  61 with the wrapper program as the servername then might change.
  62
  63 .SH DIRECTORIES
  64 .TP
  65 .FN irc
  66 In this directory the IRC tree will be created and inside it you will find a
  67 directory for your server (default: irc.freenode.net) in which the FIFO and the
  68 output file will be stored. If you join a channel, a new directory with the
  69 name of it will be created in the irc/$servername/ directory. ($servername can
  70 be overridden with $directory.)
  71
  72 .SH COMMANDS
  73 Everything which is not a command, will simply be posted into the channel or to
  74 the server. So if you need /who just write /WHO as described in the RFC to the
  75 in FIFO file of the server.
  76 .TP
  77 .FN /a " [<message>]"
  78 Mark yourself as away.
  79 .TP
  80 .FN /j " #channel/nickname [<message>]"
  81 Join a channel or open a private conversation with another user.
  82 .TP
  83 .FN /l " #channel/nickname [<message>]"
  84 Leave a channel or query.
  85 .TP
  86 .FN /n " nickname"
  87 Change the nickname.
  88 .TP
  89 .FN /t " topic"
  90 Set the topic of a channel.
  91 .TP
  92 .FN "out file usage"
  93 Write wrappers, pagers or use your tools of choice to display the out file
  94 contents (loco, multitail, etc.).
  95 .SH CONTACT
  96 .TP
  97 Write to ii (at) modprobe (dot) de for suggestions, fixes, 7|-|>< ;) etc.
  98 .SH AUTHORS
  99 Copyright \(co 2005-2006 by Anselm R. Garbe <garbeam (at) gmail (dot) com> and
 100 Copyright \(co 2005-2008 by Nico Golde <nico (at) ngolde (dot) de>
 101 .SH SEE ALSO
 102 .BR echo (1),
 103 .BR tail (1)