diff options
author | ailin-nemui <ailin-nemui@users.noreply.github.com> | 2015-09-19 02:53:25 +0200 |
---|---|---|
committer | ailin-nemui <ailin-nemui@users.noreply.github.com> | 2015-09-19 02:53:25 +0200 |
commit | 2b13e793c4872711bc046363303cca4bc060e017 (patch) | |
tree | e56c1428a5d474faeb1902541ad4395a48d881f1 /docs | |
parent | 7b46dae1825fc90d97163b40cdca2ffaceb2e13c (diff) | |
parent | 51496cd09f5d2f2da0a4ae678663c66e2ceae17c (diff) | |
download | irssi-2b13e793c4872711bc046363303cca4bc060e017.zip |
Merge pull request #259 from dequis/irssiproxy
Updates for irssiproxy
Diffstat (limited to 'docs')
-rw-r--r-- | docs/help/in/irssiproxy.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/irssiproxy.in b/docs/help/in/irssiproxy.in new file mode 100644 index 00000000..79d75b91 --- /dev/null +++ b/docs/help/in/irssiproxy.in @@ -0,0 +1,14 @@ + +@SYNTAX:irssiproxy@ + +%9Description:%9 + + Displays the list of clients connected to irssiproxy. + +%9Examples:%9 + + /IRSSIPROXY + /IRSSIPROXY STATUS + +%9See also:%9 LOAD PROXY, SET irssiproxy + diff --git a/docs/proxy.txt b/docs/proxy.txt index 41875aab..e6360a82 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: + + /IRSSIPROXY status diff --git a/docs/signals.txt b/docs/signals.txt index 45658b79..5c40ce77 100644 --- a/docs/signals.txt +++ b/docs/signals.txt @@ -225,6 +225,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 |