ii.1 (2999B)
1 .TH II 1 ii-VERSION 2 .SH NAME 3 ii - irc it or irc improved 4 .SH SYNOPSIS 5 .B ii 6 .RB [ -46 ] 7 .B -s 8 .I host 9 .RB [ -t ] 10 .RB [ -v ] 11 .RB [ -p 12 .I port 13 | 14 .B -u 15 .IR sockname ] 16 .RB [ -i 17 .IR ircdir ] 18 .RB [ -n 19 .IR nickname ] 20 .RB [ -f 21 .IR realname ] 22 .RB [ -k 23 .IR env_pass ] 24 .SH DESCRIPTION 25 .B ii 26 is a minimalistic FIFO and filesystem based IRC client. 27 It creates an irc directory tree with server, channel and 28 nick name directories. 29 In every directory a FIFO file (in) and normal file (out) 30 is placed. This will be for example ~/irc/irc.freenode.net/. 31 The in file is used to communicate with the servers and the out 32 files includes the server messages. For every channel and every nick 33 name there will be new in and out files. 34 The basic idea of this is to be able to communicate with an IRC 35 server with basic command line tools. 36 For example if you will join a channel just do echo "/j #channel" > in 37 and ii creates a new channel directory with in and out file. 38 .SH OPTIONS 39 .TP 40 .BI -4 41 only connect to some IPv4 host 42 .TP 43 .BI -6 44 only connect to some IPv6 host 45 .TP 46 .BI -s " host" 47 server/host to connect to, for example: irc.freenode.net 48 .TP 49 .BI -t 50 connect using TLS 51 .TP 52 .BI -v 53 do not verify TLS certificate 54 .TP 55 .BI -p " port" 56 lets you override the default port (6667) 57 .TP 58 .BI -u " sockname" 59 connect to a UNIX domain socket instead of directly to a server. 60 If set, the 61 .B -p 62 option will be ignored. 63 .TP 64 .BI -i " ircdir" 65 lets you override the default irc path (~/irc) 66 .TP 67 .BI -n " nickname" 68 lets you override the default nick ($USER) 69 .TP 70 .BI -f " realname" 71 lets you specify your real name associated with your nick 72 .TP 73 .BI -k " env_pass" 74 lets you specify an environment variable that contains your IRC password, 75 e.g. IIPASS="foobar" ii -k IIPASS. 76 This is done in order to prevent other users from eavesdropping the server 77 password via the process list. 78 .SH DIRECTORIES 79 .TP 80 .B ~/irc 81 In this directory the irc tree will be created. In this directory you 82 will find a directory for your server (default: irc.freenode.net) in 83 which the FIFO and the output file will be stored. 84 If you join a channel a new directory with the name of the channel 85 will be created in the 86 .BI ~/irc/ servername / 87 directory. 88 .SH COMMANDS 89 .TP 90 .BI /a " [message]" 91 mark yourself as away, 92 with the optional 93 .I message 94 as an away reason. 95 .TP 96 .BI /j " #channel [password]" 97 join a 98 .IR #channel , 99 with the optional 100 .IR password . 101 .TP 102 .BI /j " nickname [message]" 103 open private conversation with user 104 .I nickname 105 and directly send the optional 106 .IR message . 107 .TP 108 .BI /l " [reason]" 109 leave a channel or query, 110 giving the optional 111 .I reason 112 message. 113 .TP 114 .BI /n " nick" 115 change the nick name to 116 .IR nick . 117 .TP 118 .BI /q " [reason]" 119 quit ii, 120 giving the optional 121 .I reason 122 message. 123 .TP 124 .BI /t " topic" 125 set the topic of a channel with 126 .IR topic. 127 .SH RAW COMMANDS 128 Everything which is not a command will be posted into the channel or to the 129 server. So if you need /who just write /WHO as described in RFC#1459 to the 130 server in FIFO. 131 .SH SEE ALSO 132 .BR echo (1), 133 .BR tail (1)