(no commit message)
authorJessica Hamrick <jhamrick@mit.edu>
Sun, 14 Sep 2008 18:26:26 +0000 (13:26 -0500)
committerTrac <sipb-www@mit.edu>
Sun, 1 Feb 2009 07:24:46 +0000 (02:24 -0500)
doc/UsingZephyr

index d2806976f3201fb5bdbaa97f2fcca2a28d015eec..b1010f97f4f9ccc216f206a36beca89d3edd5d1c 100644 (file)
@@ -64,6 +64,22 @@ For more documentation on the built-in commands and keybindings, you can press h
 
 === Classes and Instances ===
 
+Generall the most interesting discussion on Zephyr, however, happens on so-called Zephyr ''classes''. A class is a bit like a chat room in other IM systems. Anyone can send a zephyr to a class, and anyone who is subscribed to that class will receive it. There is no security on classes -- anyone who knows the name of a class can subscribe, and there is no way to determine who is subscribed to a given class.
+
+To subscribe to a class, use the subscribe command:
+
+{{{:subscribe CLASSNAME * *}}}
+
+To send a zephyr to a class, use the zwrite command with the -c option:
+
+{{{:zwrite -c CLASSNAME}}}
+
+Zephyrs to classes usually have an instance attached. An instance is a short \93topic\94 or \93subject\94 that indicates the context of a zephyr. Different instances are often used to multiplex multiple conversations on a high-traffic class. You can specify an instance with the -i option to zwrite:
+
+{{{:zwrite -c CLASSNAME -i INSTANCE}}}
+
+A message without an instance specified will default to the instance \93personal\94
+
 === Colors ===
 
 === Filters ===
\ No newline at end of file