summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-06-04 13:05:55 +0200
committerLoïc Hoguin <[email protected]>2018-06-04 13:05:55 +0200
commit24247e9145b7b3a5fb8bc0665b2c55d1ace6cd85 (patch)
treee995822fd006e932c5328e002a74d1c0a22029ea
parent2b588340af501825f3ab03f2e76dba0353c98fae (diff)
downloadninenines.eu-24247e9145b7b3a5fb8bc0665b2c55d1ace6cd85.tar.gz
ninenines.eu-24247e9145b7b3a5fb8bc0665b2c55d1ace6cd85.tar.bz2
ninenines.eu-24247e9145b7b3a5fb8bc0665b2c55d1ace6cd85.zip
Gun uses the new manual format
-rw-r--r--_build/Makefile4
-rw-r--r--docs/en/gun/1.0/manual/gun/index.html2
-rw-r--r--docs/en/gun/1.0/manual/index.html200
-rw-r--r--docs/index.xml5
-rw-r--r--index.xml5
5 files changed, 63 insertions, 153 deletions
diff --git a/_build/Makefile b/_build/Makefile
index cf016284..47814d7b 100644
--- a/_build/Makefile
+++ b/_build/Makefile
@@ -68,7 +68,7 @@ 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; \
- if [ "$1" = "cowboy" ]; then \
+ if [ "$1" = "cowboy" -o "$1" = "gun" ]; 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:\1_app/' \
| sed 's/\(link:man:[a-z0-9_]*\):/\1./' \
@@ -89,7 +89,7 @@ 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`; \
- if [ "$1" = "cowboy" ]; then \
+ if [ "$1" = "cowboy" -o "$1" = "gun" ]; then \
sed '1,/^$$$$/d' $$$$f | sed 's/xref:/link:..\//' \
| sed 's/link:man:$1(7)/link:../' \
| sed 's/\(link:man:[a-z0-9_]*\):/\1./' \
diff --git a/docs/en/gun/1.0/manual/gun/index.html b/docs/en/gun/1.0/manual/gun/index.html
index 83aa2a1c..e08aca7f 100644
--- a/docs/en/gun/1.0/manual/gun/index.html
+++ b/docs/en/gun/1.0/manual/gun/index.html
@@ -507,7 +507,7 @@ server that ultimately decides. Defaults to false.
<div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
-<div class="paragraph"><p><a href="../gun_app">gun(7)</a></p></div>
+<div class="paragraph"><p><a href="..">gun(7)</a></p></div>
</div>
</div>
diff --git a/docs/en/gun/1.0/manual/index.html b/docs/en/gun/1.0/manual/index.html
index 63acd4af..241ed25e 100644
--- a/docs/en/gun/1.0/manual/index.html
+++ b/docs/en/gun/1.0/manual/index.html
@@ -62,168 +62,72 @@
<h1 class="lined-header"><span>Gun Function Reference</span></h1>
+<div class="sect1">
+<h2 id="_name">Name</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_description">Description</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Gun is an HTTP client for Erlang/OTP with support for the
+HTTP/1.1, HTTP/2 and Websocket protocols.</p></div>
+<div class="paragraph"><p>Gun aims to provide an easy to use, asynchronous and
+always-connected client. It maintains a permanent connection
+to the server and reconnects automatically when necessary.</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_modules">Modules</h2>
+<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
-<a href="gun_app">gun(7)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun">gun(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.await">gun:await(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.await_body">gun:await_body(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.await_up">gun:await_up(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.cancel">gun:cancel(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.close">gun:close(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun_data">gun_data(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.data">gun:data(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.delete">gun:delete(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun_down">gun_down(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun_error">gun_error(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.flush">gun:flush(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.get">gun:get(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.head">gun:head(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.info">gun:info(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun_inform">gun_inform(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.open">gun:open(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.open_unix">gun:open_unix(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.options">gun:options(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.patch">gun:patch(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.post">gun:post(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun_push">gun_push(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.put">gun:put(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun.request">gun:request(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun_response">gun_response(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun_trailers">gun_trailers(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun_up">gun_up(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun_upgrade">gun_upgrade(3)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="gun_ws">gun_ws(3)</a>
+<a href="gun">gun(3)</a> - Asynchronous HTTP client
</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="gun.ws_send">gun:ws_send(3)</a>
+<a href="cowlib_app">cowlib(7)</a> - Support library for manipulating Web protocols
</p>
</li>
<li>
<p>
-<a href="gun.ws_upgrade">gun:ws_upgrade(3)</a>
+ssl - Secure communication over sockets
</p>
</li>
</ul></div>
+<div class="paragraph"><p>All these applications must be started before the <code>gun</code>
+application. To start Gun and all dependencies at once:</p></div>
+<div class="listingblock">
+<div class="content"><!-- Generator: GNU source-highlight
+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">gun</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>gun</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="cowlib_app">cowlib(7)</a></p></div>
+</div>
+</div>
diff --git a/docs/index.xml b/docs/index.xml
index e93d098e..1089c86f 100644
--- a/docs/index.xml
+++ b/docs/index.xml
@@ -2326,7 +2326,10 @@
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://ninenines.eu/docs/en/gun/1.0/manual/</guid>
- <description> gun(7) gun(3) gun:await(3) gun:await_body(3) gun:await_up(3) gun:cancel(3) gun:close(3) gun_data(3) gun:data(3) gun:delete(3) gun_down(3) gun_error(3) gun:flush(3) gun:get(3) gun:head(3) gun:info(3) gun_inform(3) gun:open(3) gun:open_unix(3) gun:options(3) gun:patch(3) gun:post(3) gun_push(3) gun:put(3) gun:request(3) gun_response(3) gun_trailers(3) gun_up(3) gun_upgrade(3) gun_ws(3) gun:ws_send(3) gun:ws_upgrade(3) </description>
+ <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP
+ Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.
+ Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary.
+ Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description>
</item>
<item>
diff --git a/index.xml b/index.xml
index 6dd6059d..29976704 100644
--- a/index.xml
+++ b/index.xml
@@ -2715,7 +2715,10 @@ Crowdfund my salary or buy The Erlanger Playbook
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://ninenines.eu/docs/en/gun/1.0/manual/</guid>
- <description> gun(7) gun(3) gun:await(3) gun:await_body(3) gun:await_up(3) gun:cancel(3) gun:close(3) gun_data(3) gun:data(3) gun:delete(3) gun_down(3) gun_error(3) gun:flush(3) gun:get(3) gun:head(3) gun:info(3) gun_inform(3) gun:open(3) gun:open_unix(3) gun:options(3) gun:patch(3) gun:post(3) gun_push(3) gun:put(3) gun:request(3) gun_response(3) gun_trailers(3) gun_up(3) gun_upgrade(3) gun_ws(3) gun:ws_send(3) gun:ws_upgrade(3) </description>
+ <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP
+ Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.
+ Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary.
+ Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description>
</item>
<item>