doc/ii.in.1

   1 .Dd $Mdocdate$
   2 .Dt II 1
   3 .Os
   4 .Sh NAME
   5 .Nm ii
   6 .Nd IRC it or IRC improved
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Op Fl d Ar directory
  10 .Op Fl f Ar realname
  11 .Op Fl i Ar prefix
  12 .Op Fl k Ar password
  13 .Op Fl n Ar nickname
  14 .Op Fl p Ar port
  15 .Op Fl s Ar servername
  16 .Sh DESCRIPTION
  17 .Nm
  18 is a minimalistic FIFO and file system based IRC client.
  19 Upon connection, it creates an IRC directory
  20 .Ar prefix
  21 which contains the server directory that can be overridden by
  22 .Ar directory .
  23 Beyond the path, inside the server directory, there are channel and nickname
  24 directories together with a FIFO file named "ii" and a regular one called
  25 "out".
  26 These two latter files do also occur inside each channel and nickname
  27 directory, which themselves are created upon joining a channel or opening of a
  28 private conversation.
  29 .Pp
  30 The FIFO files "in" are used to communicate with the server, while the regular
  31 "out" files carry the server messages.
  32 If the data sent to an "in" file is not an IRC command, in other words not
  33 starting with a slash "/", it will be interpreted as a regular message (PRIVMSG)
  34 which later pops up in the "out" file in the same directory level.
  35 .Pp
  36 The idea of this file system structure, is to be able to communicate with an
  37 IRC server using basic command line tools.
  38 For example, if the desired action is to join a channel, the command
  39 .Cm echo "/j #channel" > in
  40 will do the trick no matter which "in" FIFO file it is addressed to, as long as
  41 the file is in use by the current instance of
  42 .Nm .
  43 For more information about available commands, see further down in this
  44 section.
  45 .Pp
  46 The arguments are as follows, with the default value enclosed within brackets:
  47 .Bl -tag -width Ds
  48 .It Fl d Ar directory
  49 Overrides the
  50 .Ar servername
  51 part within the directory structure that
  52 .Nm
  53 creates.
  54 .It Fl f Ar realname
  55 The real name that is to be associated with the
  56 .Ar nickname .
  57 .It Fl i Ar prefix
  58 The directory in which
  59 .Nm
  60 will create its server directory.
  61 (irc)
  62 .It Fl k Ar password
  63 A password used to authenticate the
  64 .Ar nickname
  65 with the server. Be aware of the problem that it will be visible in the process
  66 list.
  67 If this is not a desired side-effect, then simply use a query to submit the
  68 password.
  69 .It Fl n Ar nickname
  70 The used nickname during the IRC session.
  71 This is of course also possible to change in a later stage by querying the
  72 server using the
  73 .Cm /n
  74 command.
  75 (anonymous)
  76 .It Fl p Ar port
  77 The port that
  78 .Nm
  79 will connect to on the specific
  80 .Ar servername .
  81 (6667)
  82 .It Fl s Ar servername
  83 The server to which
  84 .Nm
  85 will connect.
  86 (irc.freenode.net)
  87 .El
  88 .Pp
  89 The commands that
  90 .Nm
  91 understands are as follows:
  92 .Bl -tag -width Ds
  93 .It Cm /a [message]
  94 Used in order to mark oneself as away.
  95 The server will send the
  96 .Ar message
  97 automatically in reply to a PRIVMSG directed at the user (you).
  98 If
  99 .Ar message
 100 is omitted, the away status is removed.
 101 .It Cm /j #channel/nickname [message]/message
 102 Join a channel or open a private conversation with another user having the nick
 103 .Ar nickname .
 104 If the purpose is to join a channel, then the
 105 .Ar message
 106 is meaning the key that is needed in order to join the password protected
 107 channel.
 108 When opening a private conversation, then the
 109 .Ar message
 110 (compulsory) is sent to the
 111 .Ar nickname
 112 as a PRIVMSG.
 113 .It Cm /l [comment]
 114 Causes the user to leave the current channel with an optional
 115 .Ar comment .
 116 This must be sent to the "in" FIFO file located within the channel directory.
 117 .It Cm /n nickname
 118 Change the nick to
 119 .Ar nickname .
 120 .It Cm /t [#channel] [topic]
 121 Change the topic of the specified channel, or the current one if omitted, to
 122 .Ar topic .
 123 If
 124 .Ar topic
 125 is skipped, the server will report what the current topic is to the "out" file
 126 which is in the server directory.
 127 .El
 128 .Sh FILES
 129 .Bl -tag -width Ds
 130 .It Cm in
 131 The FIFO files "in" are used to communicate with the server.
 132 .It Cm irc
 133 Inside this directory is the server directory and within the last one, there
 134 are channel and nickname directories together with a FIFO file named "ii" and a
 135 regular one called "out".
 136 These two latter files do also occur inside each channel and nickname
 137 directory, which themselves are created upon joining a channel or opening of a
 138 private conversation.
 139 .Pp
 140 It is possible to override
 141 .Cm irc
 142 by specifying the
 143 .Ar prefix
 144 argument.
 145 .It Cm out
 146 These files carry the server messages.
 147 .El
 148 .Sh SEE ALSO
 149 .Xr echo 1 ,
 150 .Xr tail 1
 151 .Sh AUTHORS
 152 .An Copyright \(co 2005-2006 by Anselm R. Garbe <garbeam (at) gmail (dot) com>
 153 .An Copyright \(co 2005-2008 by Nico Golde <nico (at) ngolde (dot) de>
 154 .Sh CAVEATS
 155 .Nm
 156 cannot tell whether a specific user exists when the
 157 .Cm /j
 158 command is used to open a private conversation.
 159 This means that it always succeeds if the syntax is correct, even if nobody
 160 will receive the
 161 .Ar message .
 162 However, the server will, in these cases, report when a specific user is not
 163 available, so a check in the "out" file, in the server directory, works as a
 164 solution to this problem.