X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=README;h=9b4d8cf1d8d193e947824f68abf88d52e6be3b49;hb=8702ace766119effc2c2ec4afa284bec6f24c4da;hp=6b764186106fd8b8b7717b9b04d7a6769e59f62f;hpb=dfe9f27ec9cdfbc4c58b7c8f78a980d6416f0229;p=goircd.git

diff --git a/README b/README
index 6b76418..9b4d8cf 100644
--- a/README
+++ b/README
@@ -13,7 +13,7 @@ It does not aim to replace full featured mass scalable IRC networks:
 
 * It can not connect to other servers. Just standalone installation
 * It has few basic IRC commands
-* There is not support for channel operators, modes, votes, invites
+* There is no support for channel operators, modes, votes, invites
   and so on
 * No ident lookups, reverse DNS queries
 
@@ -23,23 +23,24 @@ But it has some convincing features:
 * Single executable binary
 * No configuration file, just few command line arguments
 * IPv6 out-of-box support
+* Ability to listen on TLS-capable ports
 * Optional channel logging to plain text files
 * Optional permanent channel's state saving in plain text files
   (so you can reload daemon and all channels topics and keys won't
   disappear)
+* Optional ability to authenticate users by nickname↔password
 
 Some remarks and recommendations related to it's simplicity:
 
 * Use either nohup or similar tools to daemonize it
-* Use either crywrap or similar tools for TLS-capable connections
 * Just plain logging on stderr, without syslog support
 
 SUPPORTED IRC COMMANDS
 
-* NICK/USER during registration workflow
+* PASS/NICK/USER during registration workflow
 * PING/PONGs
 * NOTICE/PRIVMSG
-* MOTD, LUSERS, WHO, WHOIS, QUIT
+* AWAY, MOTD, LUSERS, WHO, WHOIS, VERSION, QUIT
 * LIST, JOIN, TOPIC, +k/-k channel MODE
 
 USAGE
@@ -55,6 +56,29 @@ Just execute goircd daemon. It has following optional arguments:
 * -statedir: directory where all channels states will be saved and
              loaded during startup. If omitted, then states will be
              lost after daemon termination
+* -tlsbind/-pem: enable TLS, specify address to listen on and path
+                 to PEM file with certificate and private key
+* -passwords: enable client authentication and specify path to
+              passwords file
+* -verbose: increase log messages verbosity
+
+TLS
+
+If you specify -bind and -tlsbind simultaneously, then you will have
+both raw and encrypted listening sockets. You can use -bind "" to
+disable raw socket.
+
+AUTHENTICATION
+
+You can turn on optional client authentication by preparing passwords
+file and using the -passwords argument. Format of passwords file is:
+
+    login1:password1\n
+    login2:password2\n
+    …
+
+You can force rereading of passwords file without server interruption by
+sending HUP signal to him.
 
 LICENCE