aniani/irssi
1
0
Fork 0
mirror of https://github.com/irssi/irssi.git synced 2024-06-23 06:35:36 +00:00
Code

add some documentation

Browse Source
This commit is contained in:
Lukas Mai 2016-02-18 01:17:24 +01:00
parent 4732e33ca9
commit effb00b858
2 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/proxy.txt
View File

@ -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 you'll have to make the correct /IRCNET ADD and /SERVER ADD commands to
make it work properly. 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 By default, the proxy binds to all available interfaces. To make it
only listen on (for example) the loopback address: only listen on (for example) the loopback address:

17
docs/startup-HOWTO.html
View File

@ -735,6 +735,13 @@ reason, and you only use one server connection, you may simply set:</p>
/SET irssiproxy_ports *=2777 /SET irssiproxy_ports *=2777
</pre> </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>Usage in client side:</p>
<p>Just connect to the irssi proxy like it is a normal server with password <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 /SERVER ADD -network efnet my.irssi-proxy.org 2778 secret
</pre> </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>Irssi proxy works fine with other IRC clients as well.</p>
<p><strong>SOCKS</strong></p> <p><strong>SOCKS</strong></p>