From 37b771210f94b9b692d0417d79483b9927d46ba2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Sun, 22 Sep 2019 15:04:37 +0200
Subject: Document Socks support

Also correct various Socks related types. This commit also
adds a new gun:protocols/0 type as a simpler way of describing
preferred protocols. The protocol/opts tuple is also documented.

This commit also fixes an issue with the default value for the
preferred protocols when using CONNECT over TLS. It was
mistakenly not enabling http2 by default.
---
 doc/src/manual/gun.open_unix.asciidoc | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'doc/src/manual/gun.open_unix.asciidoc')

diff --git a/doc/src/manual/gun.open_unix.asciidoc b/doc/src/manual/gun.open_unix.asciidoc
index 4ea8d2b..441bfa8 100644
--- a/doc/src/manual/gun.open_unix.asciidoc
+++ b/doc/src/manual/gun.open_unix.asciidoc
@@ -12,7 +12,9 @@ open_unix(SocketPath, Opts) -> {ok, pid()} | {error, Reason}
 
 SocketPath :: string()
 Opts       :: gun:opts()
-Reason     :: {options, OptName} | {options, {http | http2, OptName}} | any()
+Reason     :: {options, OptName}
+            | {options, {http | http2 | socks | ws, OptName}}
+            | any()
 OptName    :: atom()
 ----
 
@@ -59,4 +61,5 @@ message will be sent for that.
 link:man:gun(3)[gun(3)],
 link:man:gun:open(3)[gun:open(3)],
 link:man:gun:await_up(3)[gun:await_up(3)],
+link:man:gun_socks_up(3)[gun_socks_up(3)],
 link:man:gun_up(3)[gun_up(3)]
-- 
cgit v1.2.3

