diff options
| author | Lukas Mai <l.mai@web.de> | 2016-02-18 01:17:24 +0100 |
|---|---|---|
| committer | Lukas Mai <l.mai@web.de> | 2016-02-18 01:20:33 +0100 |
| commit | effb00b858db17b3abf27661682255bd8139a95a (patch) | |
| tree | 9d0580bf5ec085ad473e4451aa3e042b59b7e3ef | |
| parent | 4732e33ca9c9f9a48b57062ab254bf3aa90078bf (diff) | |
| download | irssi-effb00b858db17b3abf27661682255bd8139a95a.zip | |
add some documentation
| -rw-r--r-- | docs/proxy.txt | 12 | ||||
| -rw-r--r-- | docs/startup-HOWTO.html | 17 |
2 files changed, 29 insertions, 0 deletions
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 <network>:<password> 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:</p> /SET irssiproxy_ports *=2777 </pre> +<p>The special network name <code>?</code> allows the client to select the +network dynamically on connect (see below):</p> + +<pre> +/SET irssiproxy_ports ?=2777 +</pre> + <p>Usage in client side:</p> <p>Just connect to the irssi proxy like it is a normal server with password @@ -745,6 +752,16 @@ specified in <code>/SET irssiproxy_password</code>. For example:</p> /SERVER ADD -network efnet my.irssi-proxy.org 2778 secret </pre> +<p>Or, if you used <code>?</code> in <code>irssiproxy_ports</code>:</p> + +<pre> +/SERVER ADD -network IRCnet my.irssi-proxy.org 2777 IRCnet:secret +/SERVER ADD -network efnet my.irssi-proxy.org 2777 efnet:secret +</pre> + +<p>I.e. the network to connect to is specified as part of the password, +separated by <code>:</code> from the actual proxy password.</p> + <p>Irssi proxy works fine with other IRC clients as well.</p> <p><strong>SOCKS</strong></p> |