(no commit message)
[wiki.git] / doc / UsingZephyr
index 55d9fd77a1be8031f09a059ab6f27d412e0d5d4e..ee3c0ca2360dbed66eccc0c30d6e99bb7d197eb8 100644 (file)
@@ -4,45 +4,7 @@
 
 Zephyr was a system designed to let system administrators send important messages to users in an easily noticeable format. It was meant to have a low volume of traffic and be used only for official notices. This is obviously not what Zephyr is today. It can still be used in the way it was intended: notice that you get official zephyrgrams as you log in, with important information about Athena services and planned outages. However, the most common usage is by average users exchanging information about classes, how their days are going, and talking on Zephyr classes and instances about everything from the latest episode of Battlestar Galactica to the next 18.03 problem set. The usage of Zephyr has far exceeded original expectations. Over time, people have also created programs that give Zephyr a graphical interface, and programs that give zephyr a purely textual interface, that can be used entirely within a ssh 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.
 
-== Traditional Zephyr (archaic) ==
-
-When you log into Athena, you may occasionally see a white box pop up with text on it.  This is Zephyr in it's traditional form.
-
-=== Terminology ===
-
-# '''windowgrams''' are the small windows that appear on your screen with a message from another person.
-
-# '''Zephyrgrams''' are the messages that you send and receive when you are using Zephyr. They can appear as windowgrams or in other forms, depending on which client you are using. 
-
-# '''zwgc''' is the basic, traditional Zephyr client.
-
-=== Basic Commands ===
-
-'''zlocate''' '''''friend''''' is the command used to find out if user "friend" is logged in and subscribing to zephyrgrams. If they are logged in and subscribing to messages you will receive information about where they are logged in. If they are not logged in you will receive the message "Hidden or not logged-in." This means they either do not want to be found or are not logged in.
-
-'''zwrite''' '''''friend''''' is used to send a message to {{{friend}}}. Just follow the instructions given. If you get an error saying the person is hidden or not logged in then your message has not been sent and the person you are trying to reach is not logged in or is not subscribing to messages and you should try sending e-mail instead.
-
-'''zctl hide''' can be used to "hide" yourself. When hidden you are not {{{zlocatable}}}, but if someone tries to zwrite you anyway they will succeed. 
-
-'''zctl wg_shutdown''' should be used if you want to stop receiving zephyrgrams for this session.
-
-'''zctl set zwrite-signature "foo"''' (quotes are mandatory) will change your Zephyr signature, or zsig, to foo. By default your zsig is your name as it exists in your finger information. It shows up in a zephyrgram before your username. You can change it to almost anything you like, although you should avoid very long zsigs since they tend to annoy people. 
-
-'''zaway''' is used to let people know you are away from the terminal and not deliberately ignoring their messages. It sends a message to whoever sends you a personal zephyrgram that lets them know that you are away (and will probably respond later). 
-
-'''zwgc -ttymode''' will start up a Zephyr client when you are logged in remotely. Zephyrs appear as plain text on your screen. 
-
-'''znol''' will let you know which people on a list are logged in. Your {{{~/.anyone}}} file should contain the list of usernames you want to know about (it should have one name per line and no spaces). You will also be sent login and logout notices in the form of a zephyrgram whenever one of the users in your list logs in or out (if they are announced, see below) after you have run {{{znol}}} during a session. 
-
-'''zctl set exposure exposurelevel''' will set your exposure (how other people know when you are logged in). An exposure level of {{{net-announced}}} causes login and logout notices to be sent to people who have you in their {{{.anyone}}} file, and you will be zlocatable. {{{net-visible}}} is the same except login and logout notices are not sent. The {{{realm-announced}}}  and {{{realm-visible}}} settings require authentication before your information is divulged, but behave in most situations in the same way as {{{net-announced}}} and {{{net-visible}}}, respectively. The {{{opstaff}}}  setting makes you unable to be zlocated and does not send login and logout notices. Finally the {{{none}}} setting provides no information about you and '''you will not be able to receive zephyrgrams'''.
-
-'''zctl sub message foo *''' will subscribe you to a Zephyr "instance" named foo. Zephyr instances (and classes) allow groups of people to have conversations via Zephyr. The above {{{zctl}}} command will subscribe you to the instance {{{foo}}} for your current login only; to make it more permanent replace {{{sub}}} with {{{add}}}. To unsubscribe for this login only change {{{sub}}} to {{{unsub}}}, and to unsubscribe permanently use {{{delete}}} instead. 
-
-'''zwrite -i foo''' will send a message to the Zephyr instance {{{foo}}}.
-
-'''zctl sub foo * *''' subscribes you to the Zephyr class {{{foo}}}. Zephyr classes are slightly more private than instances as you must know the name of the class to subscribe to it. {{{unsub}}}, {{{add}}} and {{{delete}}} work the same way for classes as for instances. 
-
-'''zwrite -c foo''' sends a zephyr(gram) to class {{{foo}}}. 
+The information in this wiki about Barnowl just barely touches the surface.  More for in-depth functionality, visit the Barnowl wiki at https://barnowl.scripts.mit.edu:444/wiki.
 
 == Modern Zephyr ==
 
@@ -64,19 +26,25 @@ For more documentation on the built-in commands and keybindings, you can press h
 
 === Classes and Instances ===
 
-Generall the most interesting discussion on Zephyr, however, happens on so-called Zephyr ''classes''. A class is a bit like a chat room in other IM systems. Anyone can send a zephyr to a class, and anyone who is subscribed to that class will receive it. There is no security on classes -- anyone who knows the name of a class can subscribe, and there is no way to determine who is subscribed to a given class.
+Generally the most interesting discussion on Zephyr, however, happens on so-called Zephyr ''classes''. A class is a bit like a chat room in other IM systems. Anyone can send a zephyr to a class, and anyone who is subscribed to that class will receive it. There is no security on classes -- anyone who knows the name of a class can subscribe, and there is no way to determine who is subscribed to a given class.
 
 To subscribe to a class, use the subscribe command:
 
-{{{:subscribe CLASSNAME * *}}}
+{{{
+:subscribe CLASSNAME * *
+}}}
 
 To send a zephyr to a class, use the zwrite command with the -c option:
 
-{{{:zwrite -c CLASSNAME}}}
+{{{
+:zwrite -c CLASSNAME
+}}}
 
 Zephyrs to classes usually have an instance attached. An instance is a short \93topic\94 or \93subject\94 that indicates the context of a zephyr. Different instances are often used to multiplex multiple conversations on a high-traffic class. You can specify an instance with the -i option to zwrite:
 
-{{{:zwrite -c CLASSNAME -i INSTANCE}}}
+{{{
+:zwrite -c CLASSNAME -i INSTANCE
+}}}
 
 A message without an instance specified will default to the instance \93personal\94
 
@@ -110,6 +78,151 @@ If you spend enough time on Zephyr, you'll begin noticing some strange phrases a
 
 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.
 
+=== Startup ===
+
+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:
+
+{{{
+: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.
+
+=== Logging ===
+
+It is handy to be able to log your conversations so you can refer back to them later.  To log classes, for example:
+
+{{{
+:set classlogging on
+"set classlogpath ~/path/to/class/log
+}}}
+
+And to log personals:
+
+{{{
+:set logging on
+:set logpath ~/path/to/people/log
+}}}
+
 === Colors ===
 
-=== Filters ===
\ No newline at end of file
+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))}}}
+
+Colors may vary from machine to machine, as different terminal profiles may have different shades of the seven colors.
+
+=== Filters ===
+
+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, {{{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:
+
+{{{
+filter personal -c green
+}}}
+
+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 -c blue
+}}}
+
+You can update your settings and filters without restarting your Barnowl session by:
+
+{{{
+:source ~/path/to/config/file
+}}}
+
+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.
+
+=== Screen ===
+
+You should find a computer or server on which to run your screen session(s) that is up all the time, for example, linerva.mit.edu.  Screen allows you to run programs inside of it on one computer, and to access those same programs from other computers via ssh.
+
+=== 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.
+2.  ssh to that machine.
+3.  Run "add kchen".  You may want to add this to your {{{~/.environment}}} file.
+4.  Run "owl-screen"
+
+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
+}}}
+
+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}}}.
+
+=== Kerberos Tickets and AFS Tokens ===
+
+In order to keep your screen session authenticated, you'll need to keep your Kerberos tickets and AFS tokens up-to-date.  There is a script that will do this for you, located in the {{{kchen}}} locker.  After you ssh into the machine that hosts your screen sessions, run the following commands:
+
+{{{
+add kchen
+owl-screen
+C-a C-c
+kinit -l1d -r7d
+cont-renew &
+C-a 0
+}}}
+
+=== 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 reattach a screen session, run one of the following commands (as listed in the screen man page):
+
+'''{{{-d -r}}}'''   Reattach a session and if necessary detach it first.[[BR]]
+'''{{{-d -R}}}'''   Reattach a session and if necessary detach or even create it first.[[BR]]
+'''{{{-d -RR}}}'''  Reattach a session and if necessary detach or create it. Use the first session if more than one session is available.[[BR]]
+'''{{{-D -r}}}'''   Reattach a session. If necessary detach and logout remotely first.[[BR]]
+'''{{{-D -R}}}'''   Attach here and now.  In detail this means: If a session is running, then reattach.  If necessary detach and logout remotely first.  If it was not running create it and notify the user.[[BR]]
+'''{{{-D -RR}}}'''  Attach here and now. Whatever that means, just do it.[[BR]]
+'''{{{-x}}}'''      Attach to a not detached screen session. (Multi display mode).[[BR]]
+
+Note: It is always a good idea to check the status of your sessions by means of "screen -list".
+
+== Traditional Zephyr (archaic) ==
+
+When you log into Athena, you may occasionally see a white box pop up with text on it.  This is Zephyr in it's traditional form.
+
+=== Terminology ===
+
+'''windowgrams''' are the small windows that appear on your screen with a message from another person.
+
+'''Zephyrgrams''' are the messages that you send and receive when you are using Zephyr. They can appear as windowgrams or in other forms, depending on which client you are using. 
+
+'''zwgc''' is the basic, traditional Zephyr client.
+
+=== Basic Commands ===
+
+'''zlocate''' '''''friend''''' is the command used to find out if user "friend" is logged in and subscribing to zephyrgrams. If they are logged in and subscribing to messages you will receive information about where they are logged in. If they are not logged in you will receive the message "Hidden or not logged-in." This means they either do not want to be found or are not logged in.
+
+'''zwrite''' '''''friend''''' is used to send a message to {{{friend}}}. Just follow the instructions given. If you get an error saying the person is hidden or not logged in then your message has not been sent and the person you are trying to reach is not logged in or is not subscribing to messages and you should try sending e-mail instead.
+
+'''zctl hide''' can be used to "hide" yourself. When hidden you are not {{{zlocatable}}}, but if someone tries to zwrite you anyway they will succeed. 
+
+'''zctl wg_shutdown''' should be used if you want to stop receiving zephyrgrams for this session.
+
+'''zctl set zwrite-signature "foo"''' (quotes are mandatory) will change your Zephyr signature, or zsig, to foo. By default your zsig is your name as it exists in your finger information. It shows up in a zephyrgram before your username. You can change it to almost anything you like, although you should avoid very long zsigs since they tend to annoy people. 
+
+'''zaway''' is used to let people know you are away from the terminal and not deliberately ignoring their messages. It sends a message to whoever sends you a personal zephyrgram that lets them know that you are away (and will probably respond later). 
+
+'''zwgc -ttymode''' will start up a Zephyr client when you are logged in remotely. Zephyrs appear as plain text on your screen. 
+
+'''znol''' will let you know which people on a list are logged in. Your {{{~/.anyone}}} file should contain the list of usernames you want to know about (it should have one name per line and no spaces). You will also be sent login and logout notices in the form of a zephyrgram whenever one of the users in your list logs in or out (if they are announced, see below) after you have run {{{znol}}} during a session. 
+
+'''zctl set exposure exposurelevel''' will set your exposure (how other people know when you are logged in). An exposure level of {{{net-announced}}} causes login and logout notices to be sent to people who have you in their {{{.anyone}}} file, and you will be zlocatable. {{{net-visible}}} is the same except login and logout notices are not sent. The {{{realm-announced}}}  and {{{realm-visible}}} settings require authentication before your information is divulged, but behave in most situations in the same way as {{{net-announced}}} and {{{net-visible}}}, respectively. The {{{opstaff}}}  setting makes you unable to be zlocated and does not send login and logout notices. Finally the {{{none}}} setting provides no information about you and '''you will not be able to receive zephyrgrams'''.
+
+'''zctl sub message foo *''' will subscribe you to a Zephyr "instance" named foo. Zephyr instances (and classes) allow groups of people to have conversations via Zephyr. The above {{{zctl}}} command will subscribe you to the instance {{{foo}}} for your current login only; to make it more permanent replace {{{sub}}} with {{{add}}}. To unsubscribe for this login only change {{{sub}}} to {{{unsub}}}, and to unsubscribe permanently use {{{delete}}} instead. 
+
+'''zwrite -i foo''' will send a message to the Zephyr instance {{{foo}}}.
+
+'''zctl sub foo * *''' subscribes you to the Zephyr class {{{foo}}}. Zephyr classes are slightly more private than instances as you must know the name of the class to subscribe to it. {{{unsub}}}, {{{add}}} and {{{delete}}} work the same way for classes as for instances. 
+
+'''zwrite -c foo''' sends a zephyr(gram) to class {{{foo}}}.