From 4655bd6ca4d99bd6b00179a7b863e306da8ee8e4 Mon Sep 17 00:00:00 2001
From: Dmitry Simonenko <pmwkaa@gmail.com>
Date: Mon, 19 Mar 2018 17:12:13 +0300
Subject: [PATCH] odyssey: document listen section

---
 odyssey.conf | 36 ++++++++++++++++++++++++++++++++++--
 1 file changed, 34 insertions(+), 2 deletions(-)

diff --git a/odyssey.conf b/odyssey.conf
index 1a6c26a8..b0e14ce3 100644
--- a/odyssey.conf
+++ b/odyssey.conf
@@ -91,7 +91,7 @@ log_syslog_facility "daemon"
 # Verbose logging.
 #
 # Enable verbose logging of all events, which will generate a log of
-# information detailed useful for development or testing.
+# detailed information useful for development or testing.
 #
 # It is also possible to enable verbose logging for specific users
 # (see routes section).
@@ -235,22 +235,54 @@ keepalive 7200
 #
 # Global limit of client connections.
 #
-# Comment 'client_max' to disable the limit.
+# Comment 'client_max' to disable the limit. On client limit reach, Odyssey will
+# reply with 'too many connections'.
 #
 client_max 100
 
+###
+### LISTEN
+###
 
+#
+# Listen section defines listening servers used for accepting
+# incoming client connections.
+#
+# It is possible to define several Listen sections. Odyssey will listen on
+# every specified server.
+#
+# Odyssey will fail in case it could not bind on any resolved address.
+#
 listen {
+# 	Bind address.
 	host "*"
+
+#	Listen port.
 	port 6432
+
+#	TCP listen backlog.
 	backlog 128
+
+#	Enable TLS support.
 #	tls "disable"
+
+#	TLS certificate file.
 #	tls_cert_file ""
+
+#	TLS key file.
 #	tls_key_file ""
+
+#	TLS CA file.
 #	tls_ca_file ""
+
+#	TLS protocols to accept.
 #	tls_protocols ""
 }
 
+###
+### ROUTING
+###
+
 storage "local" {
 	type "local"
 }