diff options
author | Loïc Hoguin <[email protected]> | 2019-07-18 12:04:17 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2019-07-18 12:04:17 +0200 |
commit | f6830fecd00bc9041057ddeec7453b640863d8f5 (patch) | |
tree | 6de3c2d1fe897986f11f4c3bb7ea3834fc2b578c /docs | |
parent | 136d443b5c38bee96f5d995dfea3629ef07564c3 (diff) | |
download | ninenines.eu-f6830fecd00bc9041057ddeec7453b640863d8f5.tar.gz ninenines.eu-f6830fecd00bc9041057ddeec7453b640863d8f5.tar.bz2 ninenines.eu-f6830fecd00bc9041057ddeec7453b640863d8f5.zip |
Fix the Ranch 2.0 manual landing page
Diffstat (limited to 'docs')
-rw-r--r-- | docs/en/ranch/2.0/manual/index.html | 89 | ||||
-rw-r--r-- | docs/index.xml | 7 |
2 files changed, 42 insertions, 54 deletions
diff --git a/docs/en/ranch/2.0/manual/index.html b/docs/en/ranch/2.0/manual/index.html index 5f466c74..85b6aeec 100644 --- a/docs/en/ranch/2.0/manual/index.html +++ b/docs/en/ranch/2.0/manual/index.html @@ -62,67 +62,50 @@ <h1 class="lined-header"><span>Ranch Function Reference</span></h1> -<ul><li><a href="ranch_app">ranch(7)</a> +<h2 id="_name">Name</h2> +<p>ranch - Socket acceptor pool for TCP protocols</p> +<h2 id="_description">Description</h2> +<p>Ranch is a socket acceptor pool for TCP protocols.</p> +<p>Ranch manages listeners which are a set of processes that accept and manage connections. The connection's transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service.</p> +<h2 id="_modules">Modules</h2> +<p>Functions:</p> +<ul><li><a href="ranch">ranch(3)</a> - Socket acceptor pool </li> -<li><a href="ranch">ranch(3)</a> +<li><a href="ranch_proxy_header">ranch_proxy_header(3)</a> - PROXY protocol </li> -<li><a href="ranch.child_spec">ranch:child_spec(3)</a> -</li> -<li><a href="ranch.get_addr">ranch:get_addr(3)</a> -</li> -<li><a href="ranch.get_max_connections">ranch:get_max_connections(3)</a> -</li> -<li><a href="ranch.get_port">ranch:get_port(3)</a> -</li> -<li><a href="ranch.get_protocol_options">ranch:get_protocol_options(3)</a> -</li> -<li><a href="ranch.get_status">ranch:get_status(3)</a> -</li> -<li><a href="ranch.get_transport_options">ranch:get_transport_options(3)</a> -</li> -<li><a href="ranch.handshake">ranch:handshake(3)</a> -</li> -<li><a href="ranch.info">ranch:info(3)</a> -</li> -<li><a href="ranch.procs">ranch:procs(3)</a> -</li> -<li><a href="ranch_protocol">ranch_protocol(3)</a> -</li> -<li><a href="ranch_proxy_header">ranch_proxy_header(3)</a> -</li> -<li><a href="ranch_proxy_header.header">ranch_proxy_header:header(3)</a> -</li> -<li><a href="ranch_proxy_header.parse">ranch_proxy_header:parse(3)</a> -</li> -<li><a href="ranch.recv_proxy_header">ranch:recv_proxy_header(3)</a> -</li> -<li><a href="ranch.remove_connection">ranch:remove_connection(3)</a> -</li> -<li><a href="ranch.resume_listener">ranch:resume_listener(3)</a> -</li> -<li><a href="ranch.set_max_connections">ranch:set_max_connections(3)</a> -</li> -<li><a href="ranch.set_protocol_options">ranch:set_protocol_options(3)</a> -</li> -<li><a href="ranch.set_transport_options">ranch:set_transport_options(3)</a> -</li> -<li><a href="ranch_ssl">ranch_ssl(3)</a> -</li> -<li><a href="ranch.start_listener">ranch:start_listener(3)</a> -</li> -<li><a href="ranch.stop_listener">ranch:stop_listener(3)</a> -</li> -<li><a href="ranch.suspend_listener">ranch:suspend_listener(3)</a> +</ul> +<p>Transports:</p> +<ul><li><a href="ranch_ssl">ranch_ssl(3)</a> - SSL transport </li> -<li><a href="ranch_tcp">ranch_tcp(3)</a> +<li><a href="ranch_tcp">ranch_tcp(3)</a> - TCP transport </li> -<li><a href="ranch_transport">ranch_transport(3)</a> +</ul> +<p>Behaviors:</p> +<ul><li><a href="ranch_protocol">ranch_protocol(3)</a> - Protocol modules </li> -<li><a href="ranch_transport.sendfile">ranch_transport:sendfile(3)</a> +<li><a href="ranch_transport">ranch_transport(3)</a> - Transport modules </li> -<li><a href="ranch.wait_for_connections">ranch:wait_for_connections(3)</a> +</ul> +<h2 id="_dependencies">Dependencies</h2> +<ul><li>ssl - Secure communication over sockets </li> </ul> +<p>All these applications must be started before the <code>ranch</code> application. To start Ranch and all dependencies at once:</p> +<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>{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">application:ensure_all_started</font></b>(<font color="#FF6600">ranch</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_environment">Environment</h2> +<p>The <code>ranch</code> application defines one application environment configuration parameter.</p> +<dl><dt>profile (false)</dt> +<dd><p>When enabled, Ranch will start <code>eprof</code> profiling automatically.</p> +<p>You can use the <code>ranch_app:profile_output/0</code> function to stop profiling and output the results to the files <em>procs.profile</em> and <em>total.profile</em>. Do not use in production.</p> +</dd> +</dl> +<h2 id="_see_also">See also</h2> +<p>ssl(7)</p> diff --git a/docs/index.xml b/docs/index.xml index dd9f08cd..e49942e9 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -2908,7 +2908,12 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> <guid>https://ninenines.eu/docs/en/ranch/2.0/manual/</guid> - <description>ranch(7) ranch(3) ranch:child_spec(3) ranch:get_addr(3) ranch:get_max_connections(3) ranch:get_port(3) ranch:get_protocol_options(3) ranch:get_status(3) ranch:get_transport_options(3) ranch:handshake(3) ranch:info(3) ranch:procs(3) ranch_protocol(3) ranch_proxy_header(3) ranch_proxy_header:header(3) ranch_proxy_header:parse(3) ranch:recv_proxy_header(3) ranch:remove_connection(3) ranch:resume_listener(3) ranch:set_max_connections(3) ranch:set_protocol_options(3) ranch:set_transport_options(3) ranch_ssl(3) ranch:start_listener(3) ranch:stop_listener(3) ranch:suspend_listener(3) ranch_tcp(3) ranch_transport(3) ranch_transport:sendfile(3) ranch:wait_for_connections(3) </description> + <description>Name ranch - Socket acceptor pool for TCP protocols +Description Ranch is a socket acceptor pool for TCP protocols. +Ranch manages listeners which are a set of processes that accept and manage connections. The connection&apos;s transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service. +Modules Functions: +ranch(3) - Socket acceptor pool ranch_proxy_header(3) - PROXY protocol Transports: +ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</description> </item> <item> |