Move door widget script from personal locker to sipb-door locker
[wiki.git] / doc / zephyr.mdwn
index 2dc6fcba46a5ac6f07f28ccc8d1203389d3c7e27..97b3d35d07a324bf5e4928201d64ea4454f06794 100644 (file)
@@ -86,6 +86,20 @@ instance with the -i option to zwrite:
 A message without an instance specified will default to the instance
 “personal”.
 
+You can send zephyrs to individuals (as opposed to classes) with:
+
+    :zwrite USERNAME
+
+### Aside: zephyr triplets
+
+All messages are actually sent to a "zephyr triplet" -- a class, instance, and recipient. Subscriptions are also made to zephyr triplets. The recipient can be either "*" -- to indicate a broadcast message -- or a specific individual.
+
+When sending, the default class is "message", instance is "personal", and recipient is "*". `zwrite` supports sending to arbitrary triples with `:zwrite -c CLASS -i INSTANCE USERNAME` -- the two examples above use the defaults for the parts that aren't specified.
+
+For subscriptions, the class must be specified. You can specify all instances on a class with "\*", or specify just one instance. You can only sub to recipient "\*" or your own personals (indicated by "%me%").)
+
+### Common classes
+
 Some common classes include:
 
 <strong>help</strong>:
@@ -182,5 +196,4 @@ to your `~/.environment` file if you use `tcsh` or
     ZEPHYR_CLIENT=false
 
 to your `~/.bash_environment` if you use `bash`. This will cause your
-shell to launch the `false` executable instead of `zwgc` which does
-nothing.
+shell to launch the `false` executable instead of `zwgc`, thereby disabling it ('false' does nothing).