git clone https://orangeshoelaces.net/git/ii.gitAuthor: Vasilii Kolobkov on 01/08/2019
Committer: Vasilii Kolobkov on 01/08/2019
Explain differences from original ii in README
README | 45 ++------
1 file changed, 8 insertions(+), 37 deletions(-)
diff --git a/README b/README
index a26a4e8..4562252 100644
--- a/README
+++ b/README
@@ -1,5 +1,10 @@
Abstract
--------
+This is a fork of ii acting as a pure protocol handler. Messages from the
+server are expected on the standard input and standard output is used to
+send messages to the server. Tools like socat, nc or tcpclient can be used
+to provide network connectivity.
+
ii is a minimalistic FIFO and filesystem based IRC client. It creates an irc
directory tree with server, channel and nick name directories. In every
directory a FIFO file (in) and normal file (out) is placed.
@@ -27,7 +32,9 @@ necessary as root):
Running ii
------------
-Simply invoke the 'ii' command with required arguments
+Here's how you can run ii with socat:
+
+ $ socat EXEC:'ii -s irc.freenode' OPENSSL:irc.freenode.net:6697
To make ii a bit more comfortable use it in combination with the multitail
program and for example with vim. Run vim in the server directory and use
@@ -44,42 +51,6 @@ You can find an example of how this nested environment could look like on:
http://nion.modprobe.de/blog/archives/440-Using-the-ii-irc-client.html
-SSL/TLS support
----------------
-
-Below is an example using OpenBSD relayd which sets up a TCP TLS relay
-connection on localhost. A similar setup can be accomplished using
-stunnel or netcat with TLS support. This also works for other programs
-that don't support TLS natively.
-
-/etc/relayd.conf:
-
- table <freenode> { irc.freenode.net }
- table <oftc> { irc.oftc.net }
-
- protocol "irctls" {
- tcp { nodelay, sack }
- }
-
- relay "freenode" {
- listen on 127.0.0.1 port 6668
- protocol "irctls"
- forward with tls to <freenode> port 6697
- }
-
- relay "oftc" {
- listen on 127.0.0.1 port 6669
- protocol "irctls"
- forward with tls to <oftc> port 6697
- }
-
-
-Then connect:
-
- ./irc -n nick -u name -s 127.0.0.1 -p 6668
- ./irc -n nick -u name -s 127.0.0.1 -p 6669
-
-
Configuration
-------------
No configuration is needed.