From effb00b858db17b3abf27661682255bd8139a95a Mon Sep 17 00:00:00 2001
From: Lukas Mai
Date: Thu, 18 Feb 2016 01:17:24 +0100
Subject: [PATCH] add some documentation
---
docs/proxy.txt | 12 ++++++++++++
docs/startup-HOWTO.html | 17 +++++++++++++++++
2 files changed, 29 insertions(+)
diff --git a/docs/proxy.txt b/docs/proxy.txt
index e6360a82..224d24e3 100644
--- a/docs/proxy.txt
+++ b/docs/proxy.txt
@@ -30,6 +30,18 @@ There we have 3 different irc networks answering in 3 ports. Note that
you'll have to make the correct /IRCNET ADD and /SERVER ADD commands to
make it work properly.
+The special network name "?" allows the client to select the network
+dynamically on connect:
+
+ /SET irssiproxy_ports ?=2777
+
+Now the client can send : as the server password, e.g.
+
+ /CONNECT ... 2777 efnet:secret
+
+to connect to efnet. If there is no irssiproxy_password set, you can
+omit the ":" and just send the network name as the password.
+
By default, the proxy binds to all available interfaces. To make it
only listen on (for example) the loopback address:
diff --git a/docs/startup-HOWTO.html b/docs/startup-HOWTO.html
index deff3116..1b912b96 100644
--- a/docs/startup-HOWTO.html
+++ b/docs/startup-HOWTO.html
@@ -735,6 +735,13 @@ reason, and you only use one server connection, you may simply set:
/SET irssiproxy_ports *=2777
+The special network name ?
allows the client to select the
+network dynamically on connect (see below):
+
+
+/SET irssiproxy_ports ?=2777
+
+
Usage in client side:
Just connect to the irssi proxy like it is a normal server with password
@@ -745,6 +752,16 @@ specified in /SET irssiproxy_password
. For example:
/SERVER ADD -network efnet my.irssi-proxy.org 2778 secret
+Or, if you used ?
in irssiproxy_ports
:
+
+
+/SERVER ADD -network IRCnet my.irssi-proxy.org 2777 IRCnet:secret
+/SERVER ADD -network efnet my.irssi-proxy.org 2777 efnet:secret
+
+
+I.e. the network to connect to is specified as part of the password,
+separated by :
from the actual proxy password.
+
Irssi proxy works fine with other IRC clients as well.
SOCKS