summaryrefslogtreecommitdiffstats
path: root/docs/en/gun/1.3/guide/start.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-10-01 16:35:30 +0200
committerLoïc Hoguin <[email protected]>2018-10-01 16:35:30 +0200
commit24b2e92a06cf6275b972f66373d7bfea7bfc3518 (patch)
tree87ce1f6a58f9d95a69c85f81cd1b45ab6e321ddf /docs/en/gun/1.3/guide/start.asciidoc
parent3d7d9e20fe46ed2839bc582d599abeac3ce19a8b (diff)
downloadninenines.eu-24b2e92a06cf6275b972f66373d7bfea7bfc3518.tar.gz
ninenines.eu-24b2e92a06cf6275b972f66373d7bfea7bfc3518.tar.bz2
ninenines.eu-24b2e92a06cf6275b972f66373d7bfea7bfc3518.zip
Gun 1.3.0
Diffstat (limited to 'docs/en/gun/1.3/guide/start.asciidoc')
-rw-r--r--docs/en/gun/1.3/guide/start.asciidoc43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/en/gun/1.3/guide/start.asciidoc b/docs/en/gun/1.3/guide/start.asciidoc
new file mode 100644
index 00000000..09720dca
--- /dev/null
+++ b/docs/en/gun/1.3/guide/start.asciidoc
@@ -0,0 +1,43 @@
+[[start]]
+== Starting and stopping
+
+This chapter describes how to start and stop the Gun application.
+
+=== Setting up
+
+Specify Gun as a dependency to your application in your favorite
+build tool.
+
+With Erlang.mk this is done by adding `gun` to the `DEPS` variable
+in your Makefile.
+
+.Adding Gun as an Erlang.mk dependency
+[source,make]
+----
+DEPS = gun
+----
+
+=== Starting
+
+Gun is an _OTP application_. It needs to be started before you can
+use it.
+
+.Starting Gun in an Erlang shell
+[source,erlang]
+----
+1> application:ensure_all_started(gun).
+{ok,[crypto,cowlib,asn1,public_key,ssl,gun]}
+----
+
+=== Stopping
+
+You can stop Gun using the `application:stop/1` function, however
+only Gun will be stopped. This is the reverse of `application:start/1`.
+The `application_ensure_all_started/1` function has no equivalent for
+stopping all applications.
+
+.Stopping Gun
+[source,erlang]
+----
+application:stop(gun).
+----