Merge remote-tracking branch 'origin' into sasl

4 files changed, 45 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/perl.txt b/docs/perl.txt
index 79ab5820..560fcaec 100644
--- a/docs/perl.txt
+++ b/docs/perl.txt
@@ -1185,3 +1185,11 @@ Client->{}
   connected - whether the client is connected and ready
   want_ctcp - whether the client wants to receive CTCPs
   ircnet - network tag of the network we proxy
+
+
+
+
+ Bugs and Limitations
+ --------------------
+* Calling die in 'script error' handler causes segfault (#101)
+* Storing and later using any Irssi object may result in use-after-free related crash
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