]> sipb.mit.edu Git - wiki.git/blobdiff - doc/UsingZephyr
(no commit message)
[wiki.git] / doc / UsingZephyr
index a896c3c910c3c90cce6d749e357a7d3b428ace6a..d0423276b8263688802a08f8415e95334c1cfac3 100644 (file)
@@ -12,13 +12,35 @@ The information in this wiki about Barnowl just barely touches the surface.  Mor
 
 Today the majority of Zephyr users use the barnowl client.  There are other clients as well (for example, Pidgin supports Zephyr).  The following sections will go into detail about how to install, use, and customize barnowl.
 
+=== Other Clients ===
+
+There are other clients besides Barnowl, however their use is not nearly as widespread.  Some of these include:
+
+* Owl (unmaintained, Barnowl evolved from this)[[BR]]
+* vt / jervt[[BR]]
+* zwgc (see TraditionalZephyr)[[BR]]
+* Pidgin[[BR]]
+* zephyr-mode for emacs[[BR]]
+
+Using Barnowl is recommended, as it is better supported and more documentation exists for it.
+
 === Using Barnowl ===
 
+You will need access to an Athena machine to run barnowl.  The easiest way to do this would be to SSH into linerva.mit.edu.  
+
+On a Debian-based linux distro, open up a terminal and type {{{ssh <username>@linerva.mit.edu}}}.  
+
+On Windows, download a SSH client (such as PuTTY, at http://chiark.greenend.org.uk/~sgtatham/putty/download.html) and install it.  Once you've opened it, type {{{<username>@linerva.mit.edu}}} into the prompt and hit enter.  
+
+On a Mac, open Terminal from the Utilities Folder in Applications. Type {{{kinit <username>@ATHENA.MIT.EDU && ssh -K <username>@linerva.mit.edu}}} If this command fails (saying -K is invalid), then just do {{{ssh <username>@linerva.mit.edu}}}
+
+(In all these cases, don't include the angle brackets, just replace <username> with your MIT username).  You will then be prompted for your password.  Enter it, and then carry on with running barnowl!
+
 To start barnowl, run the command {{{add barnowl; barnowl}}} at the prompt on any Athena machine or dialup, such as linerva.mit.edu.
 
 The simplest use of Zephyr is to send personal zephyrs to other users. To send a zephyr, type : to bring up a command line, and run the command {{{zwrite USERNAME}}}. You can also start a {{{zwrite}}} command by simply typing z.
 
-You can then enter your message, and then enter a {{{.}}} on a line by itself to finish the zephyr. By convention, zephyrs are usually word-wrapped to 70-character lines or so; Pressing M-q (Alt-q) will word-wrap the text you've entered for you.
+You can then enter your message, and then enter a {{{.}}} on a line by itself to finish the zephyr. By convention, zephyrs are usually word-wrapped to 70 characters or so per line; barnowl will wrap at about 10 characters less than the width of your terminal window, so if you have a large window, you may need to press M-q (Alt-q, or Escape then q) to word-wrap the current paragraph to a smaller width.
 
 Once you've sent and received zephyrs, you can navigate the message list with the arrow keys. Press {{{d}}} to mark a message as deleted, {{{u}}} to undelete it, and {{{x}}} to expunge all messages that have been marked as deleted.
 
@@ -61,24 +83,35 @@ Some common classes include:
 '''Personal Classes'''::
  By convention, nearly every Zephyr user has a "personal" class that is the same as their username. How this class is used varies from person to person, but it's often a sort of mini-blog, a place to report what one is working on or up to, or ask friends questions, or just rant about something.
 
-'''"un" Classes'''::
- Many people use "un" classes in addition to their personal class, for example {{{johndoe}}} might use {{{-c unjohndoe}}}.  Sometimes there are nested un-classes as well, such as {{{-c ununjohndoe}}} or {{{-c unununjohndoe}}}.  It is extremely rare to see anything more than three "un"s.  Un-classes are generally used for snarking about a conversation going on in the next class up ({{{-c unjohndoe}}} snarking about {{{-c johndoe}}}), or for more intense ranting.  The more "un"s, the more intense the snarking/ranting generally becomes.
-
 === Zephyr Slang ===
 
 If you spend enough time on Zephyr, you'll begin noticing some strange phrases and words being thrown around.  Some of these include:
 
-'''i,i foo''':  originated from CMU and means "I have no point here, I just like to say".  Sometimes people simply use quotes: {{{"foo"}}}
+'''i,i foo''':  picked up from CMU zephyrland and means "I have no point here, I just like saying:".  Sometimes people simply use quotes: {{{"foo"}}}.
 
 '''mix''':  If somebody accidentally sends a Zephyr to the wrong class or person, they will send another Zephyr to that wrong/class person simply saying "mix".  This basically just means, "oops, sorry, I didn't mean to send that Zephyr here".  You might also see "-i mix", which is the same thing, only with instances.
 
 '''.d''':  You may see an instance change from {{{-i foo}}} to {{{-i foo.d}}}.  This indicates a deviation or tangent from the the original topic.
 
+'''starking''': Answering a question or replying to a topic to a topic several hours (or days, occasionally) later. The term originates from Greg Stark, who would often reply to zephyrs hours or occasionally days later without seeing if anyone had answered yet, or worse, if the instance had moved on to an entirely different topic.
+
 '''ttants''':  Literally, "Things That Are Not The Same".
 
 '''prnf''':  Literally, "Pseudo-Random Neuron Firings".
 
-There are many other acronyms that are used; if you don't know what it means, try using the {{{whats foo}}} command at an Athena terminal.
+There are many other acronyms that are used; if you don't know what it means, try using the {{{whats foo}}} command at an Athena terminal. If you don't have the command, run {{{add sipb}}} first.
+
+=== Zephyr Etiquette ===
+
+There are rules that people tend to use on Zephyr.  These include:
+
+Good grammar, spelling, and punctuation.  Not everybody uses capitalization, but they will still use good English.  Please do not say things such as "hey wut r u up to???".  It makes you look like an idiot.  Really.
+
+You don't need multiple question marks or exclamation points.  Usually.
+
+There are a few abbreviations people use, such as YMMV (Your Mileage May Vary) or IIRC (If I Remember Correctly), as well as some nerdier ones like DTRT (Do The Right Thing, in reference to a computer command).  Try running `add outland; whats dtrt` to look up an abbreviation.  Common abbreviations that you might find on AIM, however, are not often used.  People tend to look down upon "lol", "rofl", and such.
+
+Personal classes are by convention considered a little more private than non-personal (public) classes. Although most people don't mind people they've met subscribing to their personal class and lurking, it's poor form to talk loudly on the personal class of someone you don't know.
 
 === Startup ===
 
@@ -96,16 +129,25 @@ It is handy to be able to log your conversations so you can refer back to them l
 
 {{{
 :set classlogging on
-:set classlogpath ~/path/to/class/log
 }}}
 
 And to log personals:
 
 {{{
 :set logging on
-:set logpath ~/path/to/people/log
 }}}
 
+This will log to the "zlog" directory in your locker. You probably don't want people to see what classes you're on or what people you talk to, so you can run the Athena commands
+
+{{{
+mkdir -p ~/zlog
+fs sa ~/zlog system:anyuser none
+mkdir -p ~/zlog/people
+mkdir -p ~/zlog/class
+}}}
+
+to create the necessary directories and make them completely hidden.
+
 === Colors ===
 
 By default, there are seven colors you may use in the terminal:  red, green, yellow, blue, magenta, cyan, and white.  In order to use color in Zephyr, you can use the following notation:  {{{@(@color(red)This is some red text))}}}
@@ -133,11 +175,13 @@ You can update your settings and filters without restarting your Barnowl session
 :source ~/path/to/config/file
 }}}
 
+You can see all the filters by using {{{:show filters}}}, and narrow to a particular filter with, e.g., {{{:view personal}}}. You can use {{{:view all}}} or the keyboard shortcut {{{V}}} to see all messages again.
+
 For more detailed information on filters, visit https://barnowl.scripts.mit.edu:444/wiki/Filters.
 
 == Running Barnowl in Screen ==
 
-It can be very annoying to have to close Barnowl when you turn off your computer.  During the time your computer is off, you're missing many (possibly important) zephyrs.  It can also be frustrating if you leave your computer on with Zephyr up, but go to a different computer and want to check your zephyrs - how do you do this?  These problems can be solved with the magic of screen.
+It can be very annoying to have to close Barnowl when you turn off your computer.  During the time your computer is off, you're missing many (possibly important) zephyrs.  It can be aggravating to be using zephyr via an unreliable network connection.  It can also be frustrating if you leave your computer on with Zephyr up, but go to a different computer and want to check your zephyrs - how do you do this?  These problems can be solved with the magic of screen.
 
 A more detailed and extensive explanation of this can be found at http://web.mit.edu/kchen/bin/owl-screen.txt.
 
@@ -147,7 +191,7 @@ You should find a computer or server on which to run your screen session(s) that
 
 === Quickstart ===
 
-1.  Pick a machine to host your screen session on.  If you don't know of any options, linerva.mit.edu is a good choice.
+1.  Pick a machine to host your screen session on.  If you don't know of any options, linux.mit.edu (Linerva) is a good choice.
 2.  ssh to that machine.
 3.  Run "add kchen".  You may want to add this to your {{{~/.environment}}} file.
 4.  Run "owl-screen"
@@ -155,12 +199,12 @@ You should find a computer or server on which to run your screen session(s) that
 Your screen session is now ready.  Once you start the screen session, you'll need to get renewable Kerberos tickets in order to run it for any extended period of time.  Press C-a C-c to open a new screen window, and run
 
 {{{
-kinit -l7d
+kinit -l7d -54
 }}}
 
-Press C-a 0 to return back to your Barnowl window.
+(length 7 days, both Kerberos 5 and Kerberos 4). Press C-a 0 to return back to your Barnowl window.
 
-When you're ready to log out, press C-a d to "detach" your screen, and then type {{{exit}}} or {{{logout}}} to log out.  Later, when you want to "reattach" your screen, ssh to the machine again, and run {{{screen -x}}}.
+When you're ready to log out, press C-a d to "detach" your screen, and then type {{{exit}}} or {{{logout}}} to log out.  Later, when you want to "reattach" your screen, ssh to the machine again, and run {{{screen -r}}}.
 
 === Kerberos Tickets and AFS Tokens ===
 
@@ -170,13 +214,33 @@ In order to keep your screen session authenticated, you'll need to keep your Ker
 add kchen
 owl-screen
 C-a C-c
-kinit -l1d -r7d
-cont-renew &
-C-a 0
+kinit -l1d -r7d -54
 }}}
 
 === Attaching and Detaching Sessions ===
 
-To detach a screen session (for example, if you want to log out), press C-a d.  Screen continues to run, but is no longer active.
+To detach a screen session (for example, if you want to log out), press C-a d (Control-A, then D).  Screen continues to run, but is no longer active.
+
+To reattach a screen session, possibly detaching from wherever it's currently attached, run:
+
+{{{
+screen -dr
+}}}
+
+{{{screen}}} can do a whole lot more.   To find out about it, see UsingScreen.
+
+== Interaction with Traditional Zephyr ==
+
+The default athena startup scripts launch zwgc on login. 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:
+
+{{{
+setenv ZEPHYR_CLIENT false
+}}}
+
+to your {{{~/.environment}}} file if you use {{{tcsh}}} or
+
+{{{
+ZEPHYR_CLIENT=false
+}}}
 
-To reattach a screen session, run {{{screen -dR}}}.  There are other options available, run {{{man screen}}} to learn more about them.
\ No newline at end of file
+to your {{{~/.bash_environment}}} if you use {{{bash}}}. This will cause your shell to launch the {{{false}}} executable instead of zwgc which does nothing.
\ No newline at end of file