aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/gun_app.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2015-03-27 20:22:42 +0100
committerLoïc Hoguin <[email protected]>2015-03-27 20:22:42 +0100
commit4ae8967785f2a01a9eacf12a5ff0710f393ba053 (patch)
treeaeba330b7da89f2ba673f30a1b8c5d984c2be801 /doc/src/manual/gun_app.asciidoc
parentba9ff8f5728694c226e5c2d38ac82da8faa0a243 (diff)
downloadgun-4ae8967785f2a01a9eacf12a5ff0710f393ba053.tar.gz
gun-4ae8967785f2a01a9eacf12a5ff0710f393ba053.tar.bz2
gun-4ae8967785f2a01a9eacf12a5ff0710f393ba053.zip
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.
Diffstat (limited to 'doc/src/manual/gun_app.asciidoc')
-rw-r--r--doc/src/manual/gun_app.asciidoc24
1 files changed, 24 insertions, 0 deletions
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.