(no commit message)
[wiki.git] / doc / zephyr.mdwn
1 [[!meta title="Using Zephyr (a.k.a. Zephyr For Dummies)"]]
2
3 <!-- For information on the archaic way of using Zephyr, see TraditionalZephyr.-->
4
5 ## Introduction to Zephyr
6
7 Zephyr is a general purpose chat system for MIT.
8
9 People use it to exchange information about classes, how their days are
10 going, and talk on Zephyr classes and instances about everything
11 from the latest episode of Game of Thrones to the next 18.03
12 problem set.
13
14 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.
15
16 ## Major clients
17
18 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.
19
20 ### Barnowl
21
22 [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.
23
24 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.
25
26 See [Getting Started with Barnowl](http://barnowl.mit.edu/wiki/GettingStarted) for more information.
27
28 ### Roost
29
30 [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.
31
32 Roost makes use of [Webathena](https://webathena.mit.edu/) to keep you subscribed to Zephyr. This makes for a much easier setup.
33
34 ### Zulip
35
36
37 [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.
38 Zulip, like Roost, is easy to set up because it uses Webathena for authentication.
39
40 See [Zulip for MIT setup](http://zulip.com/zephyr) for details.
41
42 <!-- merge to http://zephyr.1ts.org/wiki/ZephyrClients (I would do this, except I can't log in…)
43
44 ## Other Clients
45
46 There are other clients besides the above, but their use is not
47 nearly as widespread.  Some of these include:
48
49 * Owl (unmaintained, BarnOwl evolved from this)
50 * vt / jervt
51 * zwgc (see TraditionalZephyr)
52 * Pidgin
53 * zephyr-mode for emacs
54 * [ZephyrPlus web client](https://zephyrplus.mit.edu)
55
56 -->
57
58 ## Culture
59
60 ### Classes and Instances
61
62 Generally the most interesting discussion on Zephyr happens
63 on so-called Zephyr <em>classes</em>. A class is a bit like a chat
64 room in other IM systems. Anyone can send a zephyr to a class, and
65 anyone who is subscribed to that class will receive it. There is no
66 security on classes -- anyone who knows the name of a class can
67 subscribe, and there is no way to determine who is subscribed to a
68 given class.
69
70 To subscribe to a class, use the subscribe command:
71
72     :subscribe CLASSNAME * * 
73
74 To send a zephyr to a class, use the zwrite command with the -c option:
75
76     :zwrite -c CLASSNAME
77
78 Zephyrs to classes usually have an instance attached. An instance is a
79 short &ldquo;topic&rdquo; or &ldquo;subject&rdquo; that indicates the
80 context of a zephyr.  Different instances are often used to multiplex
81 multiple conversations on a high-traffic class. You can specify an
82 instance with the -i option to zwrite:
83
84     :zwrite -c CLASSNAME -i INSTANCE
85
86 A message without an instance specified will default to the instance
87 &ldquo;personal&rdquo;.
88
89 Some common classes include:
90
91 <strong>help</strong>:
92 > -c help is a class for asking (and answering) questions on virtually
93 > any topic imaginable. Be sure to use an instance (such as
94 > &ldquo;linux&rdquo;, &ldquo;barnowl&rdquo;, &ldquo;campus&rdquo;, or
95 > so on) when asking questions, since it's a fairly high-traffic
96 > class.
97
98 <strong>sipb</strong>:
99 > -c sipb is where most SIPB members hang out. It's a place for
100 > technical discussion, questions, support, and organizing SIPB events
101 > or projects. You should also always use an instance when sending to
102 > -c sipb.
103
104 <strong>Personal Classes</strong>:
105 > By convention, nearly every Zephyr user has a "personal" class that
106 > is the same as their username. How this class is used varies from
107 > person to person, but it's often a sort of mini-blog, a place to
108 > report what one is working on or up to, or ask friends questions, or
109 > just rant about something.
110
111 ### Zephyr Slang
112
113 If you spend enough time on Zephyr, you'll begin noticing some strange
114 phrases and words being thrown around.  Some of these include:
115
116 <strong>i,i foo</strong>:
117 > picked up from CMU zephyrland and means "I have no point here, I
118 > just like saying:".  Sometimes people simply use quotes: `"foo"`.
119
120 <strong>mix</strong>:
121 > If somebody accidentally sends a Zephyr to the wrong class or
122 > person, they will send another Zephyr to that wrong/class person
123 > simply saying "mix".  This basically just means, "oops, sorry, I
124 > didn't mean to send that Zephyr here".  You might also see "-i mix",
125 > which is the same thing, only with instances.
126
127 <strong>.d</strong>:
128 > You may see an instance change from `-i foo` to `-i foo.d`.  This
129 > indicates a deviation or tangent from the the original topic.
130
131 <strong>starking</strong>:
132 > Answering a question or replying to a topic to a topic several hours
133 > (or days, occasionally) later. The term originates from Greg Stark,
134 > who would often reply to zephyrs hours or occasionally days later
135 > without seeing if anyone had answered yet, or worse, if the instance
136 > had moved on to an entirely different topic.
137
138 <strong>ttants</strong>:
139 >  Literally, "Things That Are Not The Same".
140
141 <strong>prnf</strong>:
142 >  Literally, "Pseudo-Random Neuron Firings".
143
144 There are many other acronyms that are used; if you don't know what it
145 means, try using the `whats foo` command at an Athena terminal. If you
146 don't have the command, run `add sipb` first.
147
148 ### Zephyr Etiquette
149
150 There are rules that people tend to use on Zephyr.  These include:
151
152 Good grammar, spelling, and punctuation.  Not everybody uses
153 capitalization, but they will still use good English.  Please do not say
154 things such as "hey wut r u up to???".  It makes you look like an idiot.
155 Really.
156
157 You don't need multiple question marks or exclamation points.  Usually.
158
159 There are a few abbreviations people use, such as YMMV (Your Mileage May
160 Vary) or IIRC (If I Remember Correctly), as well as some nerdier ones
161 like DTRT (Do The Right Thing, in reference to
162 [ The Rise of "Worse Is
163 Better"](http://www.jwz.org/doc/worse-is-better.html)).  Try running `add sipb; whats dtrt` to look up an
164 abbreviation.  Common abbreviations that you might find on AIM, however,
165 are not often used.  People tend to look down upon "lol", "rofl", and
166 such.
167
168 Personal classes are by convention considered a little more private than
169 non-personal (public) classes. Although most people don't mind people
170 they've met subscribing to their personal class and lurking, it's poor
171 form to talk loudly on the personal class of someone you don't know.
172
173
174 ## Interaction with Traditional Zephyr
175
176 The default Athena startup scripts launch `zwgc`  on login. `zwgc` displays a popup for each message, so if you are subscribed to many classes and use Zephyr as many do today, `zwgc`'s behavior is not very desirable. To disable `zwgc` startup, add:
177
178     setenv ZEPHYR_CLIENT false
179
180 to your `~/.environment` file if you use `tcsh` or
181
182     ZEPHYR_CLIENT=false
183
184 to your `~/.bash_environment` if you use `bash`. This will cause your
185 shell to launch the `false` executable instead of `zwgc` which does
186 nothing.