irctk

commit d73c98a385fc94e1d5dae8e4d01a001b5d0a57ae
parent 171cbd896d0df0cc502b8eac70e683f73e8bccf9
Author: Antoine Amarilli <a3nm@a3nm.net>
Date:   Mon,  9 Mar 2015 14:31:53 +0100

clarify

Diffstat:
README
 | 
10
+++++++---

1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/README b/README
@@ -436,7 +436,7 @@ If you have GNU parallel and if your IRC server isn't afraid of many connections
 from a single IP, you can run the tests in parallel: ./tests_parallel.sh. This
 isn't guaranteed to work.
 
-== 5. Caveats ==
+== 5. Caveats, limitations and FAQ ==
 
 irctk has not been thoroughly audited for bugs or security vulnerabilities. Be
 cautious if you intend to connect it to an IRC server with untrusted users.
@@ -450,8 +450,8 @@ server throttles it, then it might exit before all messages have been
 delivered, and some may get lost. Use -i and -I, or sleep for a few seconds
 before closing stdin.
 
-You need to use tail -f /dev/null as input to background irctk without having it
-suspend or exit (see above).
+You need to use tail -f /dev/null as input if you want to background irctk
+without having it suspend or exit (see above).
 
 irctk may say greedily the first things it sees on stdin while things to say in
 parallel might be available later.
@@ -460,6 +460,10 @@ irctk can have trouble with buffering. When writing pipelines involving irctk,
 be sure to disable all buffering (sed -u, awk's fflush, python -u, stdbuf in
 some cases, etc.).
 
+If you get a "LIBIRC_ERR_SSL_NOT_SUPPORTED not declared" error when compiling,
+it means you are not compiling against the right version of libircclient (see
+section 2).
+
 == 6. Related projects ==
 
   * ii <http://tools.suckless.org/ii/>