diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/help/in/proxy.in | 14 | ||||
-rw-r--r-- | docs/proxy.txt | 22 | ||||
-rw-r--r-- | docs/signals.txt | 1 |
3 files changed, 37 insertions, 0 deletions
diff --git a/docs/help/in/proxy.in b/docs/help/in/proxy.in new file mode 100644 index 00000000..2dc61f43 --- /dev/null +++ b/docs/help/in/proxy.in @@ -0,0 +1,14 @@ + +@SYNTAX:proxy@ + +%9Description:%9 + + Displays the list of clients connected to the proxy. + +%9Examples:%9 + + /PROXY + /PROXY STATUS + +%9See also:%9 LOAD PROXY, SET irssiproxy + diff --git a/docs/proxy.txt b/docs/proxy.txt index 41875aab..759ef1dc 100644 --- a/docs/proxy.txt +++ b/docs/proxy.txt @@ -12,6 +12,11 @@ In irssi, say: /LOAD proxy +If you want the proxy to be loaded automatically at startup, add the +load command to ~/.irssi/startup: + + echo "load proxy" >> ~/.irssi/startup + You really should set some password for the proxy with: /SET irssiproxy_password secret @@ -24,3 +29,20 @@ something like: 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. + +By default, the proxy binds to all available interfaces. To make it +only listen on (for example) the loopback address: + + /SET irssiproxy_bind 127.0.0.1 + +Note that bind address changes won't take effect until the proxy is +disabled and then reenabled. + +Once everything is set up, you can enable / disable the proxy: + + /TOGGLE irssiproxy + +When the proxy is configured and running, the following command will +show all the currently connected clients: + + /PROXY status diff --git a/docs/signals.txt b/docs/signals.txt index f0860d3e..bd5849f1 100644 --- a/docs/signals.txt +++ b/docs/signals.txt @@ -220,6 +220,7 @@ notifylist.c: proxy/listen.c: + "proxy client connecting", CLIENT_REC "proxy client connected", CLIENT_REC "proxy client disconnected", CLIENT_REC "proxy client command", CLIENT_REC, char *args, char *data |