From 4ae8967785f2a01a9eacf12a5ff0710f393ba053 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 27 Mar 2015 20:22:42 +0100 Subject: Update manual A number of @todo also remain in this document. The manual pages have been converted to Asciidoc and they can be installed system-wide using make install-docs. The asciidoc rules will be converted into an erlang.mk plugin in the near future. --- doc/src/manual/gun_app.asciidoc | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/src/manual/gun_app.asciidoc (limited to 'doc/src/manual/gun_app.asciidoc') diff --git a/doc/src/manual/gun_app.asciidoc b/doc/src/manual/gun_app.asciidoc new file mode 100644 index 0000000..e4447d6 --- /dev/null +++ b/doc/src/manual/gun_app.asciidoc @@ -0,0 +1,24 @@ += gun(7) + +== Name + +gun - Erlang HTTP client with support for HTTP/1.1, SPDY and Websocket. + +== Dependencies + +The `gun` application uses the Erlang applications `ranch` +for abstracting TCP and TLS over a common interface, and +the `ssl` application for TLS support, required for HTTPS +and SPDY support. In addition, Gun requires the `crypto` +application (a dependency of `ssl`) for Websocket. + +These dependencies must be started for the `gun` +application to work. In an embedded environment +this means that they need to be started with the +`application:start/{1,2}` function before the `gun` +application is started. + +== Environment + +The `gun` application does not define any application +environment configuration parameters. -- cgit v1.2.3