mrpd: add start of documenation
authorAndrew Elder <aelder@audioscience.com>
Thu, 4 Oct 2012 12:48:35 +0000 (08:48 -0400)
committerAndrew Elder <aelder@audioscience.com>
Fri, 5 Oct 2012 10:48:14 +0000 (06:48 -0400)
daemons/mrpd/readme.rst [new file with mode: 0644]

diff --git a/daemons/mrpd/readme.rst b/daemons/mrpd/readme.rst
new file mode 100644 (file)
index 0000000..1ea2cbc
--- /dev/null
@@ -0,0 +1,33 @@
+
+====================================
+MMRP, MVRP, MSRP documentation
+====================================
+
+General command string format
+=============================
+
+CCC:X=12233,Y=34567
+
+where CCC is the 3 character command and X and Y are parameters followed by their values.
+
+
+MSRP
+====
+
+S??: query MSRP Registrar database
+
+S+?: (re)JOIN a stream
+
+S++: NEW a stream
+       
+S--: LV a stream
+
+S+L: Report a listener status
+
+S-L: Withdraw a listener status
+
+S+D: Report a domain status
+
+S-D: Withdraw a domain status
+
+