explain the "C-a C-a" notation.
[wiki.git] / doc / zephyr.mdwn
index 480b18bb8c50a111125c9d0aa714c6109916abab..99f443d0b29c0596fa7cc81d92020f94409f9062 100644 (file)
@@ -22,11 +22,11 @@ terminal. Some of these zephyr clients have become so widely used that
 there are users who do not know that there are other ways to send (and
 receive) zephyrgrams. This wiki will cover the traditional commands,
 typed at the athena% prompt, as well as the more common modern zephyr
-client Barnowl.
+client BarnOwl.
 
-The information in this wiki about Barnowl just barely touches the
-surface.  More for in-depth functionality, visit the [Barnowl
-wiki](https://barnowl.scripts.mit.edu:444/wiki).
+The information in this wiki about BarnOwl just barely touches the
+surface.  More for in-depth functionality, visit the [BarnOwl
+wiki](https://barnowl.mit.edu/).
 
 ## Modern Zephyr
 
@@ -37,23 +37,24 @@ customize barnowl.
 
 ### Other Clients
 
-There are other clients besides Barnowl, however their use is not
+There are other clients besides BarnOwl, however their use is not
 nearly as widespread.  Some of these include:
 
-* Owl (unmaintained, Barnowl evolved from this)
+* Owl (unmaintained, BarnOwl evolved from this)
 * vt / jervt
 * zwgc (see TraditionalZephyr)
 * Pidgin
 * zephyr-mode for emacs
+* [ZephyrPlus web client](https://zephyrplus.mit.edu)
 
-Using Barnowl is recommended, as it is better supported and more
+Using BarnOwl is recommended, as it is better supported and more
 documentation exists for it.
 
-### Using Barnowl
+### Using BarnOwl
 You will need access to an Athena machine to run barnowl.  The easiest
 way to do this would be to SSH into linux.mit.edu.
 
-On a Debian-based linux distro, open up a terminal and type `ssh
+On a Debian-based Linux distro, open up a terminal and type `ssh
 <username>@linux.mit.edu`.
 
 On Windows, download a SSH client (such as
@@ -66,7 +67,7 @@ On a Mac, open Terminal from the Utilities Folder in Applications. Type
 <username>@linux.mit.edu` If this command fails (saying -K is
 invalid), then just do `ssh <username>@linux.mit.edu`.
 
-Alternatively, use a Java applet called Mindterm SSH inside any web browser. Use either [http://athena.dialup.mit.edu/ssh.html](one from MIT) or [http://www.netspace.org/ssh/](one from The Netscape Foundation Inc.). For the MIT one, the server is fixed at `athena.mit.edu`, which is  so log in and then ssh again, this time inside athena.dialup.mit.edu, to linux.mit.edu if you want to follow the rest of the instructions exactly (otherwise, you shouldn't need to ssh to linux.mit.edu):
+Alternatively, use a Java applet called Mindterm SSH inside any web browser. MIT makes this available at [athena.dialup.mit.edu](http://athena.dialup.mit.edu/ssh.html); although this will give you an Athena terminal, you may want to ssh from there to linux.mit.edu so as to follow the rest of these instructions exactly:
 
        athena.dialup.mit.edu login: <username>
        <username>@athena.dialup.mit.edu's password: <password>
@@ -74,12 +75,6 @@ Alternatively, use a Java applet called Mindterm SSH inside any web browser. Use
        <username>@<some-server>:~$ ssh <username>@linux.mit.edu
        <username>@<other-server>:~$
        
-For the Netscape one, hit `Settings > New Server...`, then enter the following and hit connect:
-
-       Server: linux.mit.edu
-       Username:<username>
-       Authentication: kbd-interact            
-
 (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!
@@ -232,13 +227,13 @@ There might be some options that you want to be consistent from
 session to session; you don't want to have to set the same variables
 each time.  You can fix this by adding the commands to your "startup"
 file, for example, `.owl/startup`.  This can be done from within
-Barnowl, by using the `startup` command:
+BarnOwl, by using the `startup` command:
 
     :startup set foo bar
 
 Where `foo` is the variable you want to set, and `bar` is the value.
 You do not necessarily have to use the `set` command, either, any
-command you can type in Barnowl can be added to the startup file.
+command you can type in BarnOwl can be added to the startup file.
 
 ### Logging
 
@@ -262,6 +257,15 @@ talk to, so you can run the Athena commands
 
 to create the necessary directories and make them completely hidden.
 
+Note that if you want the logging option to still be set after you
+quit and relaunch BarnOwl, you will need to prefix the "set" command
+with "startup". This is how you would write that:
+
+    :startup set classlogging on
+    :startup set logging on
+
+See the "Startup" section above for more information.
+
 ### Colors
 
 By default, there are seven colors you may use in the terminal: red,
@@ -274,9 +278,9 @@ profiles may have different shades of the seven colors.
 
 ### Filters
 
-Some people like to customize their Barnowl by color-coding classes.
+Some people like to customize their BarnOwl by color-coding classes.
 This makes it easier to tell different classes apart (and minimize
-mixing).  Barnowl has some already existing filters, for example,
+mixing).  BarnOwl has some already existing filters, for example,
 `personal` (for incoming personals), `out` (for outgoing personals),
 and `ping` (for pings).  To assign a color to a filter, add the
 following to your startup file:
@@ -286,11 +290,11 @@ following to your startup file:
 What if you want to color-code your class, or a friends class?  You
 can create and color filters with:
 
-    filter johndoe class johndoe
+    filter johndoe class ^johndoe$
     filter johndoe -c blue
 
 You can update your settings and filters without restarting your
-Barnowl session by:
+BarnOwl session by:
 
     :source ~/path/to/config/file
 
@@ -301,9 +305,9 @@ 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).
 
-## Running Barnowl in Screen
+## <a id="screen">Running BarnOwl in Screen</a>
 
-It can be very annoying to have to close Barnowl when you turn off
+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
@@ -314,7 +318,7 @@ 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/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.
+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
 
@@ -339,7 +343,7 @@ window, and run
     kinit -l7d -54
 
 (length 7 days, both Kerberos 5 and Kerberos 4). Press C-a 0 to return
-back to your Barnowl window.
+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
@@ -356,7 +360,7 @@ the following commands:
     add kchen
     owl-screen
     C-a C-c
-    kinit -l1d -r7d -54
+    kinit -l1d -r7d
 
 ### Attaching and Detaching Sessions