ii

git clone https://orangeshoelaces.net/git/ii.git

/ii.1

   1 .TH II 1 ii\-VERSION
   2 .SH NAME
   3 ii \- irc it or irc improved
   4 .SH DESCRIPTION
   5 .B ii
   6 is a minimalistic FIFO and filesystem based IRC client.
   7 It creates an irc directory tree with server, channel and
   8 nick name directories.
   9 In every directory a FIFO file (in) and normal file (out)
  10 is placed. This will be for example ~/irc/irc.freenode.net/.
  11 The in file is used to communicate with the servers and the out
  12 files includes the server messages. For every channel and every nick
  13 name there will be new in and out files.
  14 The basic idea of this is to be able to communicate with an IRC
  15 server with basic command line tools.
  16 For example if you will join a channel just do echo "/j #channel" > in
  17 and ii creates a new channel directory with in and out file.
  18 Connection to server is expected on standard input for server messages
  19 and standard output for ii messages.
  20 .SH SYNOPSIS
  21 .B ii
  22 .RB < \-s
  23 .IR servername >
  24 .RB [ \-i
  25 .IR prefix ]
  26 .RB [ \-n
  27 .IR nickname ]
  28 .RB [ \-k
  29 .IR "environment variable" ]
  30 .RB [ \-x ]
  31 .RB [ \-f
  32 .IR realname ]
  33 .SH OPTIONS
  34 .TP
  35 .BI \-s " servername"
  36 server name, for example: irc.freenode.net
  37 .TP
  38 .BI \-i " prefix"
  39 lets you override the default irc path (~/irc)
  40 .TP
  41 .BI \-n " nickname"
  42 lets you override the default nick ($USER)
  43 .TP
  44 .BI \-k " environment variable"
  45 lets you specify an environment variable that contains your IRC password, e.g. IIPASS="foobar" ii -k IIPASS.
  46 This is done in order to prevent other users from eavesdropping the server password via the process list.
  47 .TP
  48 .BI \-x
  49 authenticate with SASL EXTERNAL
  50 .TP
  51 .BI \-f " realname"
  52 lets you specify your real name associated with your nick
  53 .SH DIRECTORIES
  54 .TP
  55 .B ~/irc
  56 In this directory the irc tree will be created. In this directory you
  57 will find a directory for your server (default: irc.freenode.net) in
  58 which the FIFO and the output file will be stored.
  59 If you join a channel a new directory with the name of the channel
  60 will be created in the ~/irc/$servername/ directory.
  61 .SH COMMANDS
  62 .TP
  63 .BI /a " [<message>]"
  64 mark yourself as away
  65 .TP
  66 .BI /j " #channel/nickname [<message>]"
  67 join a channel or open private conversation with user
  68 .TP
  69 .BI /l " [reason]"
  70 leave a channel or query
  71 .TP
  72 .BI /n " nick"
  73 change the nick name
  74 .TP
  75 .BI /q " [reason]"
  76 quit ii
  77 .TP
  78 .BI /t " topic"
  79 set the topic of a channel
  80 .SH RAW COMMANDS
  81 .LP
  82 Everything which is not a command will be posted into the channel or to the server.
  83 So if you need /who just write /WHO as described in RFC#1459 to the server in FIFO.
  84 .SH CONTACT
  85 .LP
  86 Subscribe to the mailinglist and write to dev (at) suckless (dot) org for suggestions, fixes, etc.
  87 .SH AUTHORS
  88 ii engineers, see LICENSE file
  89 .SH SEE ALSO
  90 .BR echo (1),
  91 .BR tail (1),
  92 .BR socat (1),
  93 .BR nc(1)
  94 .SH BUGS
  95 Please report them!