changeset 407:533f99e95caf

Docs: document SSL based transports
author David Demelier <markand@malikania.fr>
date Mon, 16 Jan 2017 10:45:24 +0100
parents a8da63738428
children 35c40ac0dc26
files doc/html/irccd/configuring.md doc/man/irccd.conf.5.in
diffstat 2 files changed, 11 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/doc/html/irccd/configuring.md	Mon Jan 16 10:40:02 2017 +0100
+++ b/doc/html/irccd/configuring.md	Mon Jan 16 10:45:24 2017 +0100
@@ -208,8 +208,11 @@
 The options for **ip** type:
 
   - **port**: (int) port number.
-  - **address**: (string) address to bind or "*" for any (Optional, default: *).
-  - **family**: (list) ipv6, ipv4. Both are accepted (Optional, default: ipv4)
+  - **address**: (string) address to bind or "\*" for any (Optional, default: \*).
+  - **family**: (list) ipv6, ipv4. Both are accepted (Optional, default: ipv4).
+  - **ssl**: (bool) enable SSL (Optional, default: false).
+  - **key**: (string) path to private key file (Optional, default: none).
+  - **certificate**: (string) path to certificate (Optional, default: none).
 
 The options for **unix** type:
 
--- a/doc/man/irccd.conf.5.in	Mon Jan 16 10:40:02 2017 +0100
+++ b/doc/man/irccd.conf.5.in	Mon Jan 16 10:45:24 2017 +0100
@@ -195,6 +195,12 @@
 (string) address to bind or "*" for any (Optional, default: *).
 .It family
 (list) ipv6, ipv4. Both are accepted (Optional, default: ipv4)
+.It ssl
+(bool) enable SSL (Optional, default: false).
+.It key
+(string) path to private key file (Optional, default: none).
+.It certificate
+(string) path to certificate (Optional, default: none).
 .El
 .Pp
 The following parameters are available for type "unix":