ii(1) - f30

1ii(1)                       General Commands Manual                      ii(1)
2
3
4

NAME

6       ii - irc it or irc improved
7
8

DESCRIPTION

10       ii  is a minimalistic FIFO and filesystem based IRC client.  It creates
11       an irc directory tree with server, channel and nick  name  directories.
12       In  every  directory  a  FIFO  file  (in)  and and normal file (out) is
13       placed. This will be for example ~/irc/irc.freenode.net/.  The in  file
14       is  used to communicate with the servers and the out files includes the
15       server messages. For every channel and every nick name  there  will  be
16       new in and out files.  The basic idea of this is to be able to communi‐
17       cate with an IRC server with basic command line tools.  For example  if
18       you  will join a channel just do echo "/j #channel" > in and ii creates
19       a new channel directory with in and out file.
20

SYNOPSIS

22       ii [-s servername] [-p port] [-k environmentvariable] [-i  prefix]  [-n
23       nickname] [-f realname]
24
25

OPTIONS

27       -s servername
28              lets you override the default servername (irc.freenode.net)
29
30       -p port
31              lets you override the default port (6667)
32
33       -k environment variable
34              lets  you specify an environment variable that contains your IRC
35              password, e.g. IIPASS="foobar" ii -k FOOBAR.  This  is  done  in
36              order to prevent other users from eavesdropping the server pass‐
37              word via the process list.
38
39       -i prefix
40              lets you override the default irc path (~/irc)
41
42       -n nickname
43              lets you override the default nick ($USER)
44
45       -f realname
46              lets you specify your real name associated with your nick
47
48

DIRECTORIES

50       ~/irc  In this directory the irc tree will be created. In  this  direc‐
51              tory  you  will  find  a  directory  for  your  server (default:
52              irc.freenode.net) in which the FIFO and the output file will  be
53              stored.   If you join a channel a new directory with the name of
54              the channel will be created in the ~/irc/$servername/ directory.
55
56

COMMANDS

58       /a [<message>]
59              mark yourself as away
60
61       /j #channel/nickname [<message>]
62              join a channel or open private conversation with user
63
64       /l #channel/nickname
65              leave a channel or query
66
67       /n nick
68              change the nick name
69
70       /t topic
71              set the topic of a channel
72
73       Everything which is not a command will simply be posted into the  chan‐
74       nel or to the server.
75              So  if  you need /who just write /WHO as described in the RFC to
76              the server in FIFO.
77
78       out file usage
79              Write wrappers, pagers or use your tools of  choice  to  display
80              the out file contents (loco, multitail, etc.).
81

CONTACT

83       Write  to  ii  (at) modprobe (dot) de for suggestions, fixes, 7|-|>< ;)
84       etc.
85

AUTHORS

87       Copyright © 2005-2006 by Anselm R. Garbe <garbeam (at) gmail (dot) com>
88       and Copyright © 2005-2008 by Nico Golde <nico (at) ngolde (dot) de>
89