Mercurial > irccd
changeset 405:31837008f7e2
Docs: document the authentication support (man, html)
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Mon, 16 Jan 2017 10:36:49 +0100 |
| parents | 91fc587ddae0 |
| children | a8da63738428 |
| files | doc/html/irccd/configuring.md doc/html/irccdctl/configuring.md doc/man/irccd.conf.5.in doc/man/irccdctl.conf.5.in |
| diffstat | 4 files changed, 11 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/html/irccd/configuring.md Wed Jan 11 15:10:36 2017 +0100 +++ b/doc/html/irccd/configuring.md Mon Jan 16 10:36:49 2017 +0100 @@ -202,7 +202,8 @@ The available options: - - **type**: (string) type of listener "ip" or "unix" + - **type**: (string) type of listener "ip" or "unix". + - **password**: (string) an authentication password (Optional, default: none). The options for **ip** type:
--- a/doc/html/irccdctl/configuring.md Wed Jan 11 15:10:36 2017 +0100 +++ b/doc/html/irccdctl/configuring.md Mon Jan 16 10:36:49 2017 +0100 @@ -29,7 +29,8 @@ The available options: - - **type**: (string) type of listener "ip" or "unix" + - **type**: (string) type of listener "ip" or "unix". + - **password**: (string) an authentication password (Optional, default: none). The options for **internet** type:
--- a/doc/man/irccd.conf.5.in Wed Jan 11 15:10:36 2017 +0100 +++ b/doc/man/irccd.conf.5.in Mon Jan 16 10:36:49 2017 +0100 @@ -181,7 +181,9 @@ .Pp .Bl -tag -width XXXXXXXXXXXXXXXXXXX -compact .It type -(string) type of listener "ip" or "unix" +(string) type of listener "ip" or "unix". +.It password +(string) an authentication password (Optional, default: none). .El .Pp The following parameters are available for type "ip": @@ -191,7 +193,7 @@ (int) port number. .It address (string) address to bind or "*" for any (Optional, default: *). -.It familty +.It family (list) ipv6, ipv4. Both are accepted (Optional, default: ipv4) .El .Pp
--- a/doc/man/irccdctl.conf.5.in Wed Jan 11 15:10:36 2017 +0100 +++ b/doc/man/irccdctl.conf.5.in Mon Jan 16 10:36:49 2017 +0100 @@ -65,7 +65,9 @@ .Pp .Bl -tag -width PARAMETERXXX -compact .It type -(string) type of listener "ip" or "unix" +(string) type of listener "ip" or "unix". +.It password +(string) an authentication password (Optional, default: none). .El .Pp The following parameters are available for type "ip":