diff options
| -rw-r--r-- | _build/Makefile | 36 | ||||
| -rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy/index.html | 2 | ||||
| -rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy_handler/index.html | 2 | ||||
| -rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy_http/index.html | 2 | ||||
| -rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy_http2/index.html | 2 | ||||
| -rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy_loop/index.html | 2 | ||||
| -rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy_middleware/index.html | 2 | ||||
| -rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy_req/index.html | 2 | ||||
| -rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy_rest/index.html | 2 | ||||
| -rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy_router/index.html | 2 | ||||
| -rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy_static/index.html | 2 | ||||
| -rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy_websocket/index.html | 2 | ||||
| -rw-r--r-- | docs/en/cowboy/2.0/manual/index.html | 290 | ||||
| -rw-r--r-- | docs/index.xml | 294 |
14 files changed, 203 insertions, 439 deletions
diff --git a/_build/Makefile b/_build/Makefile index 984b2348..6eb90336 100644 --- a/_build/Makefile +++ b/_build/Makefile @@ -68,11 +68,19 @@ docs-$1-$2: tmp/$1 printf "%s\n" "+++" "title = \"`sed 's/\(.\)/\U\1/' <<< $1` Function Reference\"" \ "project = \"$1\"" "version = \"$3\"" "doctype = \"manual\"" "+++" "" \ > content/docs/en/$1/$3/manual.asciidoc; \ - for f in `ls tmp/$1/doc/src/manual/*.asciidoc | sort`; do \ - echo -n "* link:`basename $$$$f .asciidoc`[" >> content/docs/en/$1/$3/manual.asciidoc; \ - echo -n `sed -En '0,/^= / s/= (.*)/\1/ p' $$$$f` >> content/docs/en/$1/$3/manual.asciidoc; \ - echo "]" >> content/docs/en/$1/$3/manual.asciidoc; \ - done; \ + if [ "$1" = "cowboy" ]; then \ + sed '1,/^$$$$/d' tmp/$1/doc/src/manual/$1_app.asciidoc | sed 's/xref:/link:..\//' \ + | sed 's/link:man:[a-z0-9_]*(7)/link:\/docs/' \ + | sed 's/\(link:man:[a-z0-9_]*\):/\1./' \ + | sed 's/link:man:\([a-z0-9_.]*\)[1-9()]*/link:\1/' \ + >> content/docs/en/$1/$3/manual.asciidoc; \ + else \ + for f in `ls tmp/$1/doc/src/manual/*.asciidoc | sort`; do \ + echo -n "* link:`basename $$$$f .asciidoc`[" >> content/docs/en/$1/$3/manual.asciidoc; \ + echo -n `sed -En '0,/^= / s/= (.*)/\1/ p' $$$$f` >> content/docs/en/$1/$3/manual.asciidoc; \ + echo "]" >> content/docs/en/$1/$3/manual.asciidoc; \ + done; \ + fi; \ for f in tmp/$1/doc/src/manual/*.asciidoc; do \ printf "%s\n" "+++" "project = \"$1\"" "version = \"$3\"" "doctype = \"manual\"" \ > content/docs/en/$1/$3/manual/`basename $$$$f`; \ @@ -81,11 +89,19 @@ docs-$1-$2: tmp/$1 echo "\"" >> content/docs/en/$1/$3/manual/`basename $$$$f`; \ echo "+++" >> content/docs/en/$1/$3/manual/`basename $$$$f`; \ echo >> content/docs/en/$1/$3/manual/`basename $$$$f`; \ - sed '1,/^$$$$/d' $$$$f | sed 's/xref:/link:..\//' \ - | sed 's/link:man:$1(7)/link:..\/$1_app/' \ - | sed 's/\(link:man:[a-z0-9_]*\):/\1./' \ - | sed 's/link:man:\([a-z0-9_.]*\)[1-9()]*/link:..\/\1/' \ - >> content/docs/en/$1/$3/manual/`basename $$$$f`; \ + if [ "$1" = "cowboy" ]; then \ + sed '1,/^$$$$/d' $$$$f | sed 's/xref:/link:..\//' \ + | sed 's/link:man:$1(7)/link:../' \ + | sed 's/\(link:man:[a-z0-9_]*\):/\1./' \ + | sed 's/link:man:\([a-z0-9_.]*\)[1-9()]*/link:..\/\1/' \ + >> content/docs/en/$1/$3/manual/`basename $$$$f`; \ + else \ + sed '1,/^$$$$/d' $$$$f | sed 's/xref:/link:..\//' \ + | sed 's/link:man:$1(7)/link:..\/$1_app/' \ + | sed 's/\(link:man:[a-z0-9_]*\):/\1./' \ + | sed 's/link:man:\([a-z0-9_.]*\)[1-9()]*/link:..\/\1/' \ + >> content/docs/en/$1/$3/manual/`basename $$$$f`; \ + fi \ done \ fi diff --git a/docs/en/cowboy/2.0/manual/cowboy/index.html b/docs/en/cowboy/2.0/manual/cowboy/index.html index 0daef95f..fb306ef9 100644 --- a/docs/en/cowboy/2.0/manual/cowboy/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy/index.html @@ -191,7 +191,7 @@ and the Websocket options in <div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../cowboy_app">cowboy(7)</a>,
+<div class="paragraph"><p><a href="..">cowboy(7)</a>,
<a href="../ranch">ranch(3)</a></p></div>
</div>
</div>
diff --git a/docs/en/cowboy/2.0/manual/cowboy_handler/index.html b/docs/en/cowboy/2.0/manual/cowboy_handler/index.html index 17164fc5..a6df1dd7 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_handler/index.html @@ -156,7 +156,7 @@ custom handlers to execute the optional terminate callback:</p></div> <div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../cowboy_app">cowboy(7)</a></p></div>
+<div class="paragraph"><p><a href="..">cowboy(7)</a></p></div>
</div>
</div>
diff --git a/docs/en/cowboy/2.0/manual/cowboy_http/index.html b/docs/en/cowboy/2.0/manual/cowboy_http/index.html index c98095d9..d6cc0e87 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_http/index.html @@ -233,7 +233,7 @@ request_timeout (5000) <div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../cowboy_app">cowboy(7)</a>,
+<div class="paragraph"><p><a href="..">cowboy(7)</a>,
<a href="../cowboy_http2">cowboy_http2(3)</a>,
<a href="../cowboy_websocket">cowboy_websocket(3)</a></p></div>
</div>
diff --git a/docs/en/cowboy/2.0/manual/cowboy_http2/index.html b/docs/en/cowboy/2.0/manual/cowboy_http2/index.html index 3824a0ff..a273df01 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_http2/index.html @@ -145,7 +145,7 @@ preface_timeout (5000) <div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../cowboy_app">cowboy(7)</a>,
+<div class="paragraph"><p><a href="..">cowboy(7)</a>,
<a href="../cowboy_http">cowboy_http(3)</a>,
<a href="../cowboy_websocket">cowboy_websocket(3)</a></p></div>
</div>
diff --git a/docs/en/cowboy/2.0/manual/cowboy_loop/index.html b/docs/en/cowboy/2.0/manual/cowboy_loop/index.html index 5882a278..0011d461 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_loop/index.html @@ -191,7 +191,7 @@ timeout <div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../cowboy_app">cowboy(7)</a>,
+<div class="paragraph"><p><a href="..">cowboy(7)</a>,
<a href="../cowboy_handler">cowboy_handler(3)</a></p></div>
</div>
</div>
diff --git a/docs/en/cowboy/2.0/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.0/manual/cowboy_middleware/index.html index 2a78e5b6..1c6311d1 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_middleware/index.html @@ -175,7 +175,7 @@ contains the name of the listener for this connection.</p></div> <div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../cowboy_app">cowboy(7)</a></p></div>
+<div class="paragraph"><p><a href="..">cowboy(7)</a></p></div>
</div>
</div>
diff --git a/docs/en/cowboy/2.0/manual/cowboy_req/index.html b/docs/en/cowboy/2.0/manual/cowboy_req/index.html index 744ea672..5215a154 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req/index.html @@ -434,7 +434,7 @@ content-length header.</p></div> <div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../cowboy_app">cowboy(7)</a></p></div>
+<div class="paragraph"><p><a href="..">cowboy(7)</a></p></div>
</div>
</div>
diff --git a/docs/en/cowboy/2.0/manual/cowboy_rest/index.html b/docs/en/cowboy/2.0/manual/cowboy_rest/index.html index 1ca3844b..ec5a2761 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_rest/index.html @@ -703,7 +703,7 @@ accept-language headers when necessary.</p></div> <div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../cowboy_app">cowboy(7)</a>,
+<div class="paragraph"><p><a href="..">cowboy(7)</a>,
<a href="../cowboy_handler">cowboy_handler(3)</a></p></div>
</div>
</div>
diff --git a/docs/en/cowboy/2.0/manual/cowboy_router/index.html b/docs/en/cowboy/2.0/manual/cowboy_router/index.html index 415b178f..47996cad 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_router/index.html @@ -166,7 +166,7 @@ using the <code>...</code> syntax.</p></div> <div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../cowboy_app">cowboy(7)</a>,
+<div class="paragraph"><p><a href="..">cowboy(7)</a>,
<a href="../cowboy_req.binding">cowboy_req:binding(3)</a>,
<a href="../cowboy_req.bindings">cowboy_req:bindings(3)</a>,
<a href="../cowboy_req.host_info">cowboy_req:host_info(3)</a>,
diff --git a/docs/en/cowboy/2.0/manual/cowboy_static/index.html b/docs/en/cowboy/2.0/manual/cowboy_static/index.html index a3c1d750..2410bd9f 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_static/index.html @@ -234,7 +234,7 @@ http://www.gnu.org/software/src-highlite --> <div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../cowboy_app">cowboy(7)</a>,
+<div class="paragraph"><p><a href="..">cowboy(7)</a>,
<a href="../cowboy_router">cowboy_router(3)</a></p></div>
</div>
</div>
diff --git a/docs/en/cowboy/2.0/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.0/manual/cowboy_websocket/index.html index 1d426ebd..7c87a896 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_websocket/index.html @@ -303,7 +303,7 @@ timeout <div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../cowboy_app">cowboy(7)</a>,
+<div class="paragraph"><p><a href="..">cowboy(7)</a>,
<a href="../cowboy_handler">cowboy_handler(3)</a>,
<a href="../cowboy_http">cowboy_http(3)</a>,
<a href="../cowboy_http2">cowboy_http2(3)</a></p></div>
diff --git a/docs/en/cowboy/2.0/manual/index.html b/docs/en/cowboy/2.0/manual/index.html index 0f967f61..0bb0704d 100644 --- a/docs/en/cowboy/2.0/manual/index.html +++ b/docs/en/cowboy/2.0/manual/index.html @@ -69,288 +69,162 @@ <h1 class="lined-header"><span>Cowboy Function Reference</span></h1> +<div class="sect1">
+<h2 id="_name">Name</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>cowboy - Small, fast, modern HTTP server for Erlang/OTP</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_description">Description</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Cowboy is an HTTP server for Erlang/OTP with support for the
+HTTP/1.1, HTTP/2 and Websocket protocols.</p></div>
+<div class="paragraph"><p>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.</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_modules">Modules</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Functions:</p></div>
<div class="ulist"><ul>
<li>
<p>
-<a href="cowboy_app">cowboy(7)</a>
+<a href="cowboy">cowboy(3)</a> - Listener management
</p>
</li>
<li>
<p>
-<a href="cowboy">cowboy(3)</a>
+<a href="cowboy_req">cowboy_req(3)</a> - Request and response
</p>
</li>
<li>
<p>
-<a href="cowboy_handler">cowboy_handler(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_handler.terminate">cowboy_handler:terminate(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_http2">cowboy_http2(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_http">cowboy_http(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_loop">cowboy_loop(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_middleware">cowboy_middleware(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req">cowboy_req(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.binding">cowboy_req:binding(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.bindings">cowboy_req:bindings(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.body_length">cowboy_req:body_length(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.delete_resp_header">cowboy_req:delete_resp_header(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.has_body">cowboy_req:has_body(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.has_resp_body">cowboy_req:has_resp_body(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.has_resp_header">cowboy_req:has_resp_header(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.header">cowboy_req:header(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.headers">cowboy_req:headers(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.host">cowboy_req:host(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.host_info">cowboy_req:host_info(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.match_cookies">cowboy_req:match_cookies(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.match_qs">cowboy_req:match_qs(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.method">cowboy_req:method(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.parse_cookies">cowboy_req:parse_cookies(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.parse_header">cowboy_req:parse_header(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.parse_qs">cowboy_req:parse_qs(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.path">cowboy_req:path(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.path_info">cowboy_req:path_info(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.peer">cowboy_req:peer(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.port">cowboy_req:port(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.push">cowboy_req:push(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.qs">cowboy_req:qs(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.read_body">cowboy_req:read_body(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.read_part">cowboy_req:read_part(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.read_part_body">cowboy_req:read_part_body(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.read_urlencoded_body">cowboy_req:read_urlencoded_body(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.reply">cowboy_req:reply(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.scheme">cowboy_req:scheme(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.set_resp_body">cowboy_req:set_resp_body(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.set_resp_cookie">cowboy_req:set_resp_cookie(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a>
+<a href="cowboy_router">cowboy_router(3)</a> - Router
</p>
</li>
+</ul></div>
+<div class="paragraph"><p>Protocols:</p></div>
+<div class="ulist"><ul>
<li>
<p>
-<a href="cowboy_req.stream_body">cowboy_req:stream_body(3)</a>
+<a href="cowboy_http">cowboy_http(3)</a> - HTTP/1.1
</p>
</li>
<li>
<p>
-<a href="cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a>
+<a href="cowboy_http2">cowboy_http2(3)</a> - HTTP/2
</p>
</li>
<li>
<p>
-<a href="cowboy_req.uri">cowboy_req:uri(3)</a>
+<a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket
</p>
</li>
+</ul></div>
+<div class="paragraph"><p>Handlers:</p></div>
+<div class="ulist"><ul>
<li>
<p>
-<a href="cowboy_req.version">cowboy_req:version(3)</a>
+<a href="cowboy_static">cowboy_static(3)</a> - Static file handler
</p>
</li>
+</ul></div>
+<div class="paragraph"><p>Behaviors:</p></div>
+<div class="ulist"><ul>
<li>
<p>
-<a href="cowboy_rest">cowboy_rest(3)</a>
+<a href="cowboy_handler">cowboy_handler(3)</a> - Plain HTTP handlers
</p>
</li>
<li>
<p>
-<a href="cowboy_router">cowboy_router(3)</a>
+<a href="cowboy_loop">cowboy_loop(3)</a> - Loop handlers
</p>
</li>
<li>
<p>
-<a href="cowboy_router.compile">cowboy_router:compile(3)</a>
+<a href="cowboy_middleware">cowboy_middleware(3)</a> - Middlewares
</p>
</li>
<li>
<p>
-<a href="cowboy.set_env">cowboy:set_env(3)</a>
+<a href="cowboy_rest">cowboy_rest(3)</a> - REST handlers
+
</p>
</li>
<li>
<p>
-<a href="cowboy.start_clear">cowboy:start_clear(3)</a>
+<a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket handlers
</p>
</li>
+</ul></div>
+<div class="paragraph"><p>Middlewares:</p></div>
+<div class="ulist"><ul>
<li>
<p>
-<a href="cowboy.start_tls">cowboy:start_tls(3)</a>
+<a href="cowboy_router">cowboy_router(3)</a> - Router middleware
</p>
</li>
<li>
<p>
-<a href="cowboy_static">cowboy_static(3)</a>
+<a href="cowboy_handler">cowboy_handler(3)</a> - Handler middleware
</p>
</li>
+</ul></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_dependencies">Dependencies</h2>
+<div class="sectionbody">
+<div class="ulist"><ul>
<li>
<p>
-<a href="cowboy.stop_listener">cowboy:stop_listener(3)</a>
+<a href="/docs">ranch(7)</a> - Socket acceptor pool for TCP protocols
</p>
</li>
<li>
<p>
-<a href="cowboy_sub_protocol">cowboy_sub_protocol(3)</a>
+<a href="/docs">cowlib(7)</a> - Support library for manipulating Web protocols
</p>
</li>
<li>
<p>
-<a href="cowboy_websocket">cowboy_websocket(3)</a>
+ssl - Secure communication over sockets
</p>
</li>
<li>
<p>
-<a href="http_status_codes">HTTP status codes(7)</a>
+crypto - Crypto functions
</p>
</li>
</ul></div>
+<div class="paragraph"><p>All these applications must be started before the <code>cowboy</code>
+application. To start Cowboy and all dependencies at once:</p></div>
+<div class="listingblock">
+<div class="content"><!-- Generator: GNU source-highlight 3.1.8
+by Lorenzo Bettini
+http://www.lorenzobettini.it
+http://www.gnu.org/software/src-highlite -->
+<pre><tt>{<span style="color: #FF6600">ok</span>, <span style="color: #990000">_</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">application:ensure_all_started</span></span>(<span style="color: #FF6600">cowboy</span>)<span style="color: #990000">.</span></tt></pre></div></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_environment">Environment</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>The <code>cowboy</code> application does not define any application
+environment configuration parameters.</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_see_also">See also</h2>
+<div class="sectionbody">
+<div class="paragraph"><p><a href="/docs">ranch(7)</a>,
+<a href="/docs">cowlib(7)</a></p></div>
+</div>
+</div>
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><div class="ulist"><ul>
-<li>
-<p>
-<a href="cowboy_app">cowboy(7)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy">cowboy(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_handler">cowboy_handler(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_handler.terminate">cowboy_handler:terminate(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_http2">cowboy_http2(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_http">cowboy_http(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_loop">cowboy_loop(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_middleware">cowboy_middleware(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req">cowboy_req(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.binding">cowboy_req:binding(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.bindings">cowboy_req:bindings(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.body_length">cowboy_req:body_length(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.delete_resp_header">cowboy_req:delete_resp_header(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.has_body">cowboy_req:has_body(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.has_resp_body">cowboy_req:has_resp_body(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.has_resp_header">cowboy_req:has_resp_header(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.header">cowboy_req:header(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.headers">cowboy_req:headers(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.host">cowboy_req:host(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.host_info">cowboy_req:host_info(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.match_cookies">cowboy_req:match_cookies(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.match_qs">cowboy_req:match_qs(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.method">cowboy_req:method(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.parse_cookies">cowboy_req:parse_cookies(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.parse_header">cowboy_req:parse_header(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.parse_qs">cowboy_req:parse_qs(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.path">cowboy_req:path(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.path_info">cowboy_req:path_info(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.peer">cowboy_req:peer(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.port">cowboy_req:port(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.push">cowboy_req:push(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.qs">cowboy_req:qs(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.read_body">cowboy_req:read_body(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.read_part">cowboy_req:read_part(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.read_part_body">cowboy_req:read_part_body(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.read_urlencoded_body">cowboy_req:read_urlencoded_body(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.reply">cowboy_req:reply(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="cowboy_req.scheme">cowboy_req:scheme(3)</a>
-</p>
-</li>
+ <description><div class="sect1">
+<h2 id="_name">Name</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>cowboy - Small, fast, modern HTTP server for Erlang/OTP</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_description">Description</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Cowboy is an HTTP server for Erlang/OTP with support for the
+HTTP/1.1, HTTP/2 and Websocket protocols.</p></div>
+<div class="paragraph"><p>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.</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_modules">Modules</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Functions:</p></div>
+<div class="ulist"><ul>
<li>
<p>
-<a href="cowboy_req.set_resp_body">cowboy_req:set_resp_body(3)</a>
+<a href="cowboy">cowboy(3)</a> - Listener management
</p>
</li>
<li>
<p>
-<a href="cowboy_req.set_resp_cookie">cowboy_req:set_resp_cookie(3)</a>
+<a href="cowboy_req">cowboy_req(3)</a> - Request and response
</p>
</li>
<li>
<p>
-<a href="cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a>
+<a href="cowboy_router">cowboy_router(3)</a> - Router
</p>
</li>
+</ul></div>
+<div class="paragraph"><p>Protocols:</p></div>
+<div class="ulist"><ul>
<li>
<p>
-<a href="cowboy_req.stream_body">cowboy_req:stream_body(3)</a>
+<a href="cowboy_http">cowboy_http(3)</a> - HTTP/1.1
</p>
</li>
<li>
<p>
-<a href="cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a>
+<a href="cowboy_http2">cowboy_http2(3)</a> - HTTP/2
</p>
</li>
<li>
<p>
-<a href="cowboy_req.uri">cowboy_req:uri(3)</a>
+<a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket
</p>
</li>
+</ul></div>
+<div class="paragraph"><p>Handlers:</p></div>
+<div class="ulist"><ul>
<li>
<p>
-<a href="cowboy_req.version">cowboy_req:version(3)</a>
+<a href="cowboy_static">cowboy_static(3)</a> - Static file handler
</p>
</li>
+</ul></div>
+<div class="paragraph"><p>Behaviors:</p></div>
+<div class="ulist"><ul>
<li>
<p>
-<a href="cowboy_rest">cowboy_rest(3)</a>
+<a href="cowboy_handler">cowboy_handler(3)</a> - Plain HTTP handlers
</p>
</li>
<li>
<p>
-<a href="cowboy_router">cowboy_router(3)</a>
+<a href="cowboy_loop">cowboy_loop(3)</a> - Loop handlers
</p>
</li>
<li>
<p>
-<a href="cowboy_router.compile">cowboy_router:compile(3)</a>
+<a href="cowboy_middleware">cowboy_middleware(3)</a> - Middlewares
</p>
</li>
<li>
<p>
-<a href="cowboy.set_env">cowboy:set_env(3)</a>
+<a href="cowboy_rest">cowboy_rest(3)</a> - REST handlers
+
</p>
</li>
<li>
<p>
-<a href="cowboy.start_clear">cowboy:start_clear(3)</a>
+<a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket handlers
</p>
</li>
+</ul></div>
+<div class="paragraph"><p>Middlewares:</p></div>
+<div class="ulist"><ul>
<li>
<p>
-<a href="cowboy.start_tls">cowboy:start_tls(3)</a>
+<a href="cowboy_router">cowboy_router(3)</a> - Router middleware
</p>
</li>
<li>
<p>
-<a href="cowboy_static">cowboy_static(3)</a>
+<a href="cowboy_handler">cowboy_handler(3)</a> - Handler middleware
</p>
</li>
+</ul></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_dependencies">Dependencies</h2>
+<div class="sectionbody">
+<div class="ulist"><ul>
<li>
<p>
-<a href="cowboy.stop_listener">cowboy:stop_listener(3)</a>
+<a href="https://ninenines.eu/docs">ranch(7)</a> - Socket acceptor pool for TCP protocols
</p>
</li>
<li>
<p>
-<a href="cowboy_sub_protocol">cowboy_sub_protocol(3)</a>
+<a href="https://ninenines.eu/docs">cowlib(7)</a> - Support library for manipulating Web protocols
</p>
</li>
<li>
<p>
-<a href="cowboy_websocket">cowboy_websocket(3)</a>
+ssl - Secure communication over sockets
</p>
</li>
<li>
<p>
-<a href="http_status_codes">HTTP status codes(7)</a>
+crypto - Crypto functions
</p>
</li>
</ul></div>
+<div class="paragraph"><p>All these applications must be started before the <code>cowboy</code>
+application. To start Cowboy and all dependencies at once:</p></div>
+<div class="listingblock">
+<div class="content"><!-- Generator: GNU source-highlight 3.1.8
+by Lorenzo Bettini
+http://www.lorenzobettini.it
+http://www.gnu.org/software/src-highlite -->
+<pre><tt>{<span style="color: #FF6600">ok</span>, <span style="color: #990000">_</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">application:ensure_all_started</span></span>(<span style="color: #FF6600">cowboy</span>)<span style="color: #990000">.</span></tt></pre></div></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_environment">Environment</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>The <code>cowboy</code> application does not define any application
+environment configuration parameters.</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_see_also">See also</h2>
+<div class="sectionbody">
+<div class="paragraph"><p><a href="https://ninenines.eu/docs">ranch(7)</a>,
+<a href="https://ninenines.eu/docs">cowlib(7)</a></p></div>
+</div>
+</div>
</description> </item> @@ -1486,7 +1360,7 @@ and the Websocket options in <div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../cowboy_app">cowboy(7)</a>,
+<div class="paragraph"><p><a href="..">cowboy(7)</a>,
<a href="../ranch">ranch(3)</a></p></div>
</div>
</div>
|