From 078d686a0ac0aed212db97d73bd1e4a9387a4956 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sun, 6 Jul 2014 13:10:35 +0200 Subject: Provide installable man pages make docs: generate Markdown and man pages in doc/ make install-docs: install man pages to be usable directly Docs are generated from the ezdoc files in doc/src/. --- doc/src/manual/cowboy_app.ezdoc | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 doc/src/manual/cowboy_app.ezdoc (limited to 'doc/src/manual/cowboy_app.ezdoc') diff --git a/doc/src/manual/cowboy_app.ezdoc b/doc/src/manual/cowboy_app.ezdoc new file mode 100644 index 0000000..2e2b877 --- /dev/null +++ b/doc/src/manual/cowboy_app.ezdoc @@ -0,0 +1,23 @@ +::: The Cowboy Application + +Small, fast, modular HTTP server. + +:: Dependencies + +The `cowboy` application uses the Erlang applications `ranch` +for listening and accepting TCP connections, `crypto` for +establishing Websocket connections, and `cowlib` for parsing and +building messages for Web protocols. These dependencies must +be loaded for the `cowboy` application to work. In an embedded +environment this means that they need to be started with the +`application:start/{1,2}` function before the `cowboy` +application is started. + +The `cowboy` application also uses the Erlang applications +`asn1`, `public_key` and `ssl` when listening for HTTPS connections. +These are started automatically if they weren't before. + +:: Environment + +The `cowboy` application does not define any application +environment configuration parameters. -- cgit v1.2.3