"its" -> "it's" for grammar
[wiki.git] / doc / zephyr.mdwn
index 3dd8d24561b172b5615c14f31957f93d77fe54fd..97b3d35d07a324bf5e4928201d64ea4454f06794 100644 (file)
@@ -8,7 +8,7 @@ Zephyr is a general purpose chat system for MIT.
 
 People use it to exchange information about classes, how their days are
 going, and talk on Zephyr classes and instances about everything
-from the latest episode of Battlestar Galactica to the next 18.03
+from the latest episode of Game of Thrones to the next 18.03
 problem set.
 
 Zephyr is an underlying chat system; the built-in tools for exchanging messages via Zephyr are rudimentary. Most people who use Zephyr today take advantage of integrated clients that make the system easy to use.
@@ -17,25 +17,24 @@ Zephyr is an underlying chat system; the built-in tools for exchanging messages
 
 Here are some of the primary clients used at MIT. There's also a listing of [other Zephyr clients](http://zephyr.1ts.org/wiki/ZephyrClients), but their use is generally not recommended.
 
-### Barnowl
+### BarnOwl
 
-[Barnowl](http://barnowl.mit.edu/) is a command-line Zephyr client that supports advanced filtering and customisation. It is probably the most commonly used client, but requires some effort to get started. To use Barnowl effectively, you should connect to an [Athena dialup](http://web.mit.edu/dialup/www/ssh.html) and run Barnowl along with a program to renew your Kerberos tickets. The Athena command `athrun sipb owl-screen` will set this up for you.
+[BarnOwl](http://barnowl.mit.edu/) is a command-line Zephyr client that supports advanced filtering and customisation. It is probably the most commonly used client, but requires some effort to get started. To use BarnOwl effectively, you should connect to an [Athena dialup](http://web.mit.edu/dialup/www/ssh.html) and run BarnOwl along with a program to renew your Kerberos tickets. The Athena command `athrun sipb pag-screen` will set up ticket renewal, and `athrun barnowl` after that will run BarnOwl itself.
 
-In addition to primarily supporting Zephyr, Barnowl also lets you connect to [AIM](http://aim.com) and and [XMPP](http://xmpp.org/) (Google Talk, Facebook, etc.) networks.
+In addition to primarily supporting Zephyr, BarnOwl also lets you connect to [AIM](http://aim.com), [XMPP/Jabber](http://xmpp.org/) (Google Talk, Facebook, etc.), [Twitter](http://twitter.com), and IRC networks.
 
-See [Getting Started with Barnowl](http://barnowl.mit.edu/wiki/GettingStarted) for more information.
+See [Getting Started with BarnOwl](http://barnowl.mit.edu/wiki/GettingStarted) for more information.
 
 ### Roost
 
-[Roost](https://roost.mit.edu/) is a graphical Zephyr client built by [David Benjamin](https://davidben.net/) as part of his [master's thesis](https://davidben.net/thesis.pdf). It is relatively new and currently considered experimental by its author.
+[Roost](https://roost.mit.edu/) is a graphical Zephyr client built by [David Benjamin](https://davidben.net/) (MIT '12, SIPB member) as part of his [master's thesis](https://davidben.net/thesis.pdf). It is relatively new and currently considered experimental by its author.
 
 Roost makes use of [Webathena](https://webathena.mit.edu/) to keep you subscribed to Zephyr. This makes for a much easier setup.
 
 ### Zulip
 
 
-[Zulip](https://zulip.com/zephyr) is a fully-featured web-based Zephyr client that also provides [mobile apps](https://zephyr.zulip.com/apps) for Android and iOS and desktop apps for Linux, Mac, and Windows. Zulip is developed by a group of MIT alums who also developed [Ksplice](https://www.ksplice.com/) (rebootless updates for Linux).
-
+[Zulip](https://zulip.com/zephyr) is a web-based Zephyr client that also provides [mobile apps](https://zephyr.zulip.com/apps) for Android and iOS and desktop apps for Linux, Mac, and Windows. Zulip is developed by a company composed largely of MIT alums and SIPB members.
 Zulip, like Roost, is easy to set up because it uses Webathena for authentication.
 
 See [Zulip for MIT setup](http://zulip.com/zephyr) for details.
@@ -87,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>:
@@ -183,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).