Documented the roster object's structure

diff --git a/doc/roster_format.txt b/doc/roster_format.txt
new file mode 100644 (file)
index 0000000..9094b5a
--- /dev/null
+++ b/doc/roster_format.txt
@@ -0,0 +1,18 @@
+\r
+This file documents the structure of the roster object.\r
+\r
+table roster {\r
+  [string bare_jid] = roster_item\r
+}\r
+\r
+table roster_item {\r
+  string subscription = "none" | "to" | "from" | "both"\r
+  string name = Opaque string set by client. (optional)\r
+  set groups = a set of opaque strings set by the client\r
+}\r
+\r
+The roster is available as\r
+ hosts[host].sessions[username].roster\r
+and a copy is made to session.roster for all sessions.\r
+\r
+All modifications to a roster should be done through the rostermanager.\r