Use cowboy_app.asciidoc as manual entry point for Cowboy 2.0

1 files changed, 84 insertions, 210 deletions

diff --git a/docs/index.xml b/docs/index.xml
index 994f3669..09ef6b82 100644
--- a/docs/index.xml
+++ b/docs/index.xml
@@ -14,288 +14,162 @@
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
       <guid>https://ninenines.eu/docs/en/cowboy/2.0/manual/</guid>
-      <description>&lt;div class=&#34;ulist&#34;&gt;&lt;ul&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_app&#34;&gt;cowboy(7)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy&#34;&gt;cowboy(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_handler&#34;&gt;cowboy_handler(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_handler.terminate&#34;&gt;cowboy_handler:terminate(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_http2&#34;&gt;cowboy_http2(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_http&#34;&gt;cowboy_http(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_loop&#34;&gt;cowboy_loop(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_middleware&#34;&gt;cowboy_middleware(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req&#34;&gt;cowboy_req(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.binding&#34;&gt;cowboy_req:binding(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.bindings&#34;&gt;cowboy_req:bindings(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.body_length&#34;&gt;cowboy_req:body_length(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.delete_resp_header&#34;&gt;cowboy_req:delete_resp_header(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.has_body&#34;&gt;cowboy_req:has_body(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.has_resp_body&#34;&gt;cowboy_req:has_resp_body(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.has_resp_header&#34;&gt;cowboy_req:has_resp_header(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.header&#34;&gt;cowboy_req:header(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.headers&#34;&gt;cowboy_req:headers(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.host&#34;&gt;cowboy_req:host(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.host_info&#34;&gt;cowboy_req:host_info(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.match_cookies&#34;&gt;cowboy_req:match_cookies(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.match_qs&#34;&gt;cowboy_req:match_qs(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.method&#34;&gt;cowboy_req:method(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.parse_cookies&#34;&gt;cowboy_req:parse_cookies(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.parse_header&#34;&gt;cowboy_req:parse_header(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.parse_qs&#34;&gt;cowboy_req:parse_qs(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.path&#34;&gt;cowboy_req:path(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.path_info&#34;&gt;cowboy_req:path_info(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.peer&#34;&gt;cowboy_req:peer(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.port&#34;&gt;cowboy_req:port(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.push&#34;&gt;cowboy_req:push(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.qs&#34;&gt;cowboy_req:qs(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.read_body&#34;&gt;cowboy_req:read_body(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.read_part&#34;&gt;cowboy_req:read_part(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.read_part_body&#34;&gt;cowboy_req:read_part_body(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.read_urlencoded_body&#34;&gt;cowboy_req:read_urlencoded_body(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.reply&#34;&gt;cowboy_req:reply(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

-&lt;li&gt;

-&lt;p&gt;

-&lt;a href=&#34;cowboy_req.scheme&#34;&gt;cowboy_req:scheme(3)&lt;/a&gt;

-&lt;/p&gt;

-&lt;/li&gt;

+      <description>&lt;div class=&#34;sect1&#34;&gt;

+&lt;h2 id=&#34;_name&#34;&gt;Name&lt;/h2&gt;

+&lt;div class=&#34;sectionbody&#34;&gt;

+&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;cowboy - Small, fast, modern HTTP server for Erlang/OTP&lt;/p&gt;&lt;/div&gt;

+&lt;/div&gt;

+&lt;/div&gt;

+&lt;div class=&#34;sect1&#34;&gt;

+&lt;h2 id=&#34;_description&#34;&gt;Description&lt;/h2&gt;

+&lt;div class=&#34;sectionbody&#34;&gt;

+&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;Cowboy is an HTTP server for Erlang/OTP with support for the

+HTTP/1.1, HTTP/2 and Websocket protocols.&lt;/p&gt;&lt;/div&gt;

+&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;Cowboy aims to provide a complete HTTP stack. This includes

+the implementation of the HTTP RFCs but also any directly

+related standards, like Websocket or Server-Sent Events.&lt;/p&gt;&lt;/div&gt;

+&lt;/div&gt;

+&lt;/div&gt;

+&lt;div class=&#34;sect1&#34;&gt;

+&lt;h2 id=&#34;_modules&#34;&gt;Modules&lt;/h2&gt;

+&lt;div class=&#34;sectionbody&#34;&gt;

+&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;Functions:&lt;/p&gt;&lt;/div&gt;

+&lt;div class=&#34;ulist&#34;&gt;&lt;ul&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_req.set_resp_body&#34;&gt;cowboy_req:set_resp_body(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy&#34;&gt;cowboy(3)&lt;/a&gt; - Listener management

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_req.set_resp_cookie&#34;&gt;cowboy_req:set_resp_cookie(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_req&#34;&gt;cowboy_req(3)&lt;/a&gt; - Request and response

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_req.set_resp_header&#34;&gt;cowboy_req:set_resp_header(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_router&#34;&gt;cowboy_router(3)&lt;/a&gt; - Router

 &lt;/p&gt;

 &lt;/li&gt;

+&lt;/ul&gt;&lt;/div&gt;

+&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;Protocols:&lt;/p&gt;&lt;/div&gt;

+&lt;div class=&#34;ulist&#34;&gt;&lt;ul&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_req.stream_body&#34;&gt;cowboy_req:stream_body(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_http&#34;&gt;cowboy_http(3)&lt;/a&gt; - HTTP/1.1

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_req.stream_reply&#34;&gt;cowboy_req:stream_reply(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_http2&#34;&gt;cowboy_http2(3)&lt;/a&gt; - HTTP/2

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_req.uri&#34;&gt;cowboy_req:uri(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_websocket&#34;&gt;cowboy_websocket(3)&lt;/a&gt; - Websocket

 &lt;/p&gt;

 &lt;/li&gt;

+&lt;/ul&gt;&lt;/div&gt;

+&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;Handlers:&lt;/p&gt;&lt;/div&gt;

+&lt;div class=&#34;ulist&#34;&gt;&lt;ul&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_req.version&#34;&gt;cowboy_req:version(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_static&#34;&gt;cowboy_static(3)&lt;/a&gt; - Static file handler

 &lt;/p&gt;

 &lt;/li&gt;

+&lt;/ul&gt;&lt;/div&gt;

+&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;Behaviors:&lt;/p&gt;&lt;/div&gt;

+&lt;div class=&#34;ulist&#34;&gt;&lt;ul&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_rest&#34;&gt;cowboy_rest(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_handler&#34;&gt;cowboy_handler(3)&lt;/a&gt; - Plain HTTP handlers

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_router&#34;&gt;cowboy_router(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_loop&#34;&gt;cowboy_loop(3)&lt;/a&gt; - Loop handlers

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_router.compile&#34;&gt;cowboy_router:compile(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_middleware&#34;&gt;cowboy_middleware(3)&lt;/a&gt; - Middlewares

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy.set_env&#34;&gt;cowboy:set_env(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_rest&#34;&gt;cowboy_rest(3)&lt;/a&gt; - REST handlers

+

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy.start_clear&#34;&gt;cowboy:start_clear(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_websocket&#34;&gt;cowboy_websocket(3)&lt;/a&gt; - Websocket handlers

 &lt;/p&gt;

 &lt;/li&gt;

+&lt;/ul&gt;&lt;/div&gt;

+&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;Middlewares:&lt;/p&gt;&lt;/div&gt;

+&lt;div class=&#34;ulist&#34;&gt;&lt;ul&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy.start_tls&#34;&gt;cowboy:start_tls(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_router&#34;&gt;cowboy_router(3)&lt;/a&gt; - Router middleware

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_static&#34;&gt;cowboy_static(3)&lt;/a&gt;

+&lt;a href=&#34;cowboy_handler&#34;&gt;cowboy_handler(3)&lt;/a&gt; - Handler middleware

 &lt;/p&gt;

 &lt;/li&gt;

+&lt;/ul&gt;&lt;/div&gt;

+&lt;/div&gt;

+&lt;/div&gt;

+&lt;div class=&#34;sect1&#34;&gt;

+&lt;h2 id=&#34;_dependencies&#34;&gt;Dependencies&lt;/h2&gt;

+&lt;div class=&#34;sectionbody&#34;&gt;

+&lt;div class=&#34;ulist&#34;&gt;&lt;ul&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy.stop_listener&#34;&gt;cowboy:stop_listener(3)&lt;/a&gt;

+&lt;a href=&#34;https://ninenines.eu/docs&#34;&gt;ranch(7)&lt;/a&gt; - Socket acceptor pool for TCP protocols

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_sub_protocol&#34;&gt;cowboy_sub_protocol(3)&lt;/a&gt;

+&lt;a href=&#34;https://ninenines.eu/docs&#34;&gt;cowlib(7)&lt;/a&gt; - Support library for manipulating Web protocols

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;cowboy_websocket&#34;&gt;cowboy_websocket(3)&lt;/a&gt;

+ssl - Secure communication over sockets

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;li&gt;

 &lt;p&gt;

-&lt;a href=&#34;http_status_codes&#34;&gt;HTTP status codes(7)&lt;/a&gt;

+crypto - Crypto functions

 &lt;/p&gt;

 &lt;/li&gt;

 &lt;/ul&gt;&lt;/div&gt;

+&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;All these applications must be started before the &lt;code&gt;cowboy&lt;/code&gt;

+application. To start Cowboy and all dependencies at once:&lt;/p&gt;&lt;/div&gt;

+&lt;div class=&#34;listingblock&#34;&gt;

+&lt;div class=&#34;content&#34;&gt;&lt;!-- Generator: GNU source-highlight 3.1.8

+by Lorenzo Bettini

+http://www.lorenzobettini.it

+http://www.gnu.org/software/src-highlite --&gt;

+&lt;pre&gt;&lt;tt&gt;{&lt;span style=&#34;color: #FF6600&#34;&gt;ok&lt;/span&gt;, &lt;span style=&#34;color: #990000&#34;&gt;_&lt;/span&gt;} &lt;span style=&#34;color: #990000&#34;&gt;=&lt;/span&gt; &lt;span style=&#34;font-weight: bold&#34;&gt;&lt;span style=&#34;color: #000000&#34;&gt;application:ensure_all_started&lt;/span&gt;&lt;/span&gt;(&lt;span style=&#34;color: #FF6600&#34;&gt;cowboy&lt;/span&gt;)&lt;span style=&#34;color: #990000&#34;&gt;.&lt;/span&gt;&lt;/tt&gt;&lt;/pre&gt;&lt;/div&gt;&lt;/div&gt;

+&lt;/div&gt;

+&lt;/div&gt;

+&lt;div class=&#34;sect1&#34;&gt;

+&lt;h2 id=&#34;_environment&#34;&gt;Environment&lt;/h2&gt;

+&lt;div class=&#34;sectionbody&#34;&gt;

+&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;The &lt;code&gt;cowboy&lt;/code&gt; application does not define any application

+environment configuration parameters.&lt;/p&gt;&lt;/div&gt;

+&lt;/div&gt;

+&lt;/div&gt;

+&lt;div class=&#34;sect1&#34;&gt;

+&lt;h2 id=&#34;_see_also&#34;&gt;See also&lt;/h2&gt;

+&lt;div class=&#34;sectionbody&#34;&gt;

+&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;&lt;a href=&#34;https://ninenines.eu/docs&#34;&gt;ranch(7)&lt;/a&gt;,

+&lt;a href=&#34;https://ninenines.eu/docs&#34;&gt;cowlib(7)&lt;/a&gt;&lt;/p&gt;&lt;/div&gt;

+&lt;/div&gt;

+&lt;/div&gt;

 </description>
     </item>
     
@@ -1486,7 +1360,7 @@ and the Websocket options in
 &lt;div class=&#34;sect1&#34;&gt;

 &lt;h2 id=&#34;_see_also&#34;&gt;See also&lt;/h2&gt;

 &lt;div class=&#34;sectionbody&#34;&gt;

-&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;&lt;a href=&#34;../cowboy_app&#34;&gt;cowboy(7)&lt;/a&gt;,

+&lt;div class=&#34;paragraph&#34;&gt;&lt;p&gt;&lt;a href=&#34;..&#34;&gt;cowboy(7)&lt;/a&gt;,

 &lt;a href=&#34;../ranch&#34;&gt;ranch(3)&lt;/a&gt;&lt;/p&gt;&lt;/div&gt;

 &lt;/div&gt;

 &lt;/div&gt;