typo fix (extra closing parenth for @color example)

[wiki.git] / doc / zephyr.mdwn

diff --git a/doc/zephyr.mdwn b/doc/zephyr.mdwn
index 21e4cbb4dbed2f5a8aefaf0b6e37750666e59a71..35a0108efab374ef21f487d495603ce6cd05e7ac 100644 (file)
--- a/doc/zephyr.mdwn
+++ b/doc/zephyr.mdwn
@@ -50,6 +50,25 @@ Using Barnowl is recommended, as it is better supported and more
 documentation exists for it.
 
 ### Using Barnowl
 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](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.
 
 To start barnowl, run the command `add barnowl; barnowl` at the prompt
 on any Athena machine or dialup, such as linerva.mit.edu.


@@ -61,8 +80,10 @@ 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
 
 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, or
-Escape then q) will word-wrap the text you've entered for you.
+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`
 
 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`


@@ -129,16 +150,6 @@ Some common classes include:
 > report what one is working on or up to, or ask friends questions, or
 > just rant about something.
 
 > report what one is working on or up to, or ask friends questions, or
 > just rant about something.
 

-<strong>"un" Classes</strong>:
-> 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
 ### Zephyr Slang
 
 If you spend enough time on Zephyr, you'll begin noticing some strange


@@ -176,6 +187,31 @@ 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.
 
 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
+[ The Rise of "Worse Is
+Better"](http://www.jwz.org/doc/worse-is-better.html)).  Try running `add sipb; 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
 
 There might be some options that you want to be consistent from
 ### Startup
 
 There might be some options that you want to be consistent from


@@ -203,19 +239,21 @@ And to log personals:
 
 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
 
 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 command
+talk to, so you can run the Athena commands

 
     mkdir -p ~/zlog
     fs sa ~/zlog system:anyuser none
 
     mkdir -p ~/zlog
     fs sa ~/zlog system:anyuser none

+    mkdir -p ~/zlog/people
+    mkdir -p ~/zlog/class

 
 

-to make this directory completely hidden.
+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
 
 ### 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))`
+some red text)`

 
 Colors may vary from machine to machine, as different terminal
 profiles may have different shades of the seven colors.
 
 Colors may vary from machine to machine, as different terminal
 profiles may have different shades of the seven colors.


@@ -247,7 +285,7 @@ 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
 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.
+[https://barnowl.scripts.mit.edu:444/wiki/Filters](https://barnowl.scripts.mit.edu:444/wiki/Filters).

 
 ## Running Barnowl in Screen
 
 
 ## Running Barnowl in Screen
 


@@ -260,7 +298,9 @@ 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
 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.
+[http://web.mit.edu/kchen/arch/common/bin/owl-screen.txt](http://web.mit.edu/kchen/arch/common/bin/owl-screen.txt). Basic commands are [Ctrl-a] followed by [c] to open a new window (like a tab), [Ctrl-a][w] to see a list of open windows, and [Ctrl-a] followed by a number to go to that window.
+
+Do note that running `owl-screen` as apposed to just runnning `screen` and then a barnowl instance provides niceties such as reminders to renew your tickets (the process /mit/kchen/arch/i386_rhel4/bin/cont-renew-notify). Also, Barnowl will always be located on the `0` tab of an `owl-screen` instance, so [Ctrl-a][0] will always take you back to Barnowl.

 
 ### Screen
 
 
 ### Screen
 


@@ -317,3 +357,19 @@ currently attached, run:
 
 `screen` can do a whole lot more.  To find out about it, see
 [UsingScreen](https://sipb-www.scripts.mit.edu:444/doc/wiki/UsingScreen).
 
 `screen` can do a whole lot more.  To find out about it, see
 [UsingScreen](https://sipb-www.scripts.mit.edu:444/doc/wiki/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 your `~/.bash_environment` if you use `bash`. This will cause your
+shell to launch the `false` executable instead of zwgc which does
+nothing.