+ pwants
[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 pag-screen` will set up ticket renewal, and `athrun barnowl` after that will run BarnOwl itself.
23
24 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.
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 &mdash; 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. (For secure or private zephyring, consider [[zcrypt]].)
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 You can send zephyrs to individuals (as opposed to classes) with:
90
91     :zwrite USERNAME
92
93 It is possible to `zwrite` to multiple individuals at once, by listing the
94 usernames separated by spaces:
95
96     :zwrite USERONE USERTWO USERTHREE
97
98 When doing this, it is customary to include the line `CC: USERONE USERTWO
99 USERTHREE` in the body of the zephyr, although this is not required or
100 enforced.
101
102 ### Aside: zephyr triplets
103
104 All messages are actually sent to a "zephyr triplet" &mdash; a class, instance, and recipient. Subscriptions are also made to zephyr triplets. The recipient can be either "*" &mdash; to indicate a broadcast message &mdash; or a specific individual.
105
106 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` &mdash; the two examples above use the defaults for the parts that aren't specified.
107
108 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%").)
109
110 ### Common classes
111
112 Some common classes include:
113
114 <strong>help</strong>:
115 > -c help is a class for asking (and answering) questions on virtually
116 > any topic imaginable. Be sure to use an instance (such as
117 > &ldquo;linux&rdquo;, &ldquo;barnowl&rdquo;, &ldquo;campus&rdquo;, or
118 > so on) when asking questions, since it's a fairly high-traffic
119 > class.
120
121 <strong>sipb</strong>:
122 > -c sipb is where most SIPB members hang out. It's a place for
123 > technical discussion, questions, support, and organizing SIPB events
124 > or projects. You should also always use an instance when sending to
125 > -c sipb.
126
127 <strong>Personal Classes</strong>:
128 > By convention, nearly every Zephyr user has a "personal" class that
129 > is the same as their username. How this class is used varies from
130 > person to person, but it's often a sort of mini-blog, a place to
131 > report what one is working on or up to, or ask friends questions, or
132 > just rant about something.
133
134 <strong>unclasses</strong>:
135 > Most classes have an unclass, formed by prefixing "un" to the name. For
136 > example, -c help has the unclass -c unhelp. The unclass is generally used for
137 > snarky or unproductive replies; the prototypical example that first inspired
138 > their creation was telling somebody with computer issues to run
139 > `sudo rm -rf /`. Rarely, un- prefixes are stacked for even snarkier
140 > discussion, on -c ununhelp and so on.
141
142 <strong>.d classes</strong>:
143 > Classes like -c help.d are sometimes used for discussions that deviate from
144 > the conversation on the main class. .d instances are more common, though;
145 > see below.
146
147 ### Zephyr Slang
148
149 If you spend enough time on Zephyr, you'll begin noticing some strange
150 phrases and words being thrown around.  Some of these include:
151
152 <strong>i,i foo</strong>:
153 > USENET saying picked up from CMU zephyrland that expands to "I have no point here, I
154 > just like saying:".  Sometimes people use
155 > [scare quotes](https://en.wikipedia.org/wiki/Scare_quotes) (e.g. `"foo"`) 
156 > for similar purposes.
157
158 <strong>mix</strong>:
159 > If somebody accidentally sends a Zephyr to the wrong class or
160 > person, they will send another Zephyr to that wrong/class person
161 > simply saying "mix".  This basically just means, "oops, sorry, I
162 > didn't mean to send that Zephyr here".  You might also see "-i mix",
163 > which is the same thing, only with instances. The specific invocation "unmix"
164 > is used when accidentally sending a Zephyr to a class instead of its unclass
165 > or vice versa.
166
167 <strong>to Stark</strong>:
168 > To answer a question or replying to a topic to a topic several hours
169 > (or days, occasionally) later. The term originates from Greg Stark,
170 > who would often reply to zephyrs hours or occasionally days later
171 > without seeing if anyone had answered yet, or worse, if the instance
172 > had moved on to an entirely different topic.
173
174 <strong>.d</strong>:
175 > You may see an instance change from `-i foo` to `-i foo.d`.  This
176 > indicates a deviation or tangent from the the original topic.
177
178 <strong>.q</strong>:
179 > Similarly, `.q` at the end of an instance name indicates a quote.
180
181 <strong>ttants</strong>:
182 > Literally, "Things That Are Not The Same". When the things are people,
183 > <strong>pwants</strong> for "People Who Are Not The Same" may be used.
184
185 <strong>prnf</strong>:
186 > Literally, "Pseudo-Random Neuron Firing".
187
188 <strong>eiz</strong> or <strong>eip</strong> or <strong>else</strong>:
189 > Instances used to comment on discussions on other classes in Zephyr without
190 > linking to the original source for reasons of privacy or discretion. "eiz"
191 > means "Elsewhere in Zephyr", "eip" means "Elsewhere in Personals".
192
193 <strong>eim</strong>:
194 > "Elsewhere in Meatspace": instance used to comment on events not on Zephyr.
195
196 <strong>doxp</strong>:
197 > "Do X predicate", from Lisp naming convention. A discussion on whether one
198 > should do X.
199
200 Many of the acronyms may be suffixed onto normal instance topics with a period
201 to indicate relation. There are many other acronyms that are used; if you don't
202 know what it means, try using the `whats foo` command at an Athena terminal. If
203 you don't have the command, run `add sipb` first. Alternatively, running the
204 single command `athrun sipb whats foo` works as well.
205
206 ### Zephyr Etiquette
207
208 There are rules that people tend to use on Zephyr.  These include:
209
210 Good grammar, spelling, and punctuation.  Not everybody uses
211 capitalization, but they will still use good English.  Please do not say
212 things such as "hey wut r u up to???".  It makes you look like an idiot.
213 Really.
214
215 You don't need multiple question marks or exclamation points.  Usually.
216
217 There are a few abbreviations people use, such as YMMV (Your Mileage May
218 Vary) or IIRC (If I Remember Correctly), as well as some nerdier ones
219 like DTRT (Do The Right Thing, in reference to
220 [ The Rise of "Worse Is
221 Better"](http://www.jwz.org/doc/worse-is-better.html)).  Try running `add sipb; whats dtrt` to look up an
222 abbreviation.  Common abbreviations that you might find on AIM, however,
223 are not often used.  People tend to look down upon "lol", "rofl", and
224 such.
225
226 Personal classes are by convention considered a little more private than
227 non-personal (public) classes. Although most people don't mind people
228 they've met subscribing to their personal class and lurking, it's poor
229 form to talk loudly on the personal class of someone you don't know.
230
231
232 ## Interaction with Traditional Zephyr
233
234 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:
235
236     setenv ZEPHYR_CLIENT false
237
238 to your `~/.environment` file if you use `tcsh` or
239
240     ZEPHYR_CLIENT=false
241
242 to your `~/.bash_environment` if you use `bash`. This will cause your
243 shell to launch the `false` executable instead of `zwgc`, thereby disabling it ('false' does nothing).