From 8b4c6f4bf9880d59bbc012b6ba9d5e60c4f62b3a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Wed, 18 Jul 2018 17:24:41 +0200
Subject: Add one manual per function for the ranch module

Also review and update the ranch(7) manual and fix a few specs.
---
 doc/src/manual/ranch.get_status.asciidoc | 46 ++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 doc/src/manual/ranch.get_status.asciidoc

(limited to 'doc/src/manual/ranch.get_status.asciidoc')

diff --git a/doc/src/manual/ranch.get_status.asciidoc b/doc/src/manual/ranch.get_status.asciidoc
new file mode 100644
index 0000000..eb45614
--- /dev/null
+++ b/doc/src/manual/ranch.get_status.asciidoc
@@ -0,0 +1,46 @@
+= ranch:get_status(3)
+
+== Name
+
+ranch:get_status - Get a listener's running state
+
+== Description
+
+[source,erlang]
+----
+get_status(Ref :: ranch_ref()) -> running | suspended
+----
+
+Get a listener's running state.
+
+== Arguments
+
+Ref::
+
+The listener name.
+
+== Return value
+
+An atom is returned indicating the running status of the listener.
+
+== Changelog
+
+* *1.6*: Function introduced.
+
+== Examples
+
+.Get a listener's running state
+[source,erlang]
+----
+ranch:get_status(example).
+----
+
+== See also
+
+link:man:ranch:start_listener(3)[ranch:start_listener(3)],
+link:man:ranch:stop_listener(3)[ranch:stop_listener(3)],
+link:man:ranch:suspend_listener(3)[ranch:suspend_listener(3)],
+link:man:ranch:resume_listener(3)[ranch:resume_listener(3)],
+link:man:ranch:set_transport_options(3)[ranch:set_transport_options(3)],
+link:man:ranch:wait_for_connections(3)[ranch:wait_for_connections(3)],
+link:man:ranch(3)[ranch(3)]
-- 
cgit v1.2.3

