retarget
[wiki.git] / doc / traditional-zephyr.mdwn
1 [[!meta title="Traditional Zephyr (archaic)"]]
2
3 For information on using Barnowl, see [[Using Zephyr|doc/zephyr]].
4
5 When you log into Athena, you may occasionally see a white box pop up
6 with text on it.  This is Zephyr in its traditional form.
7
8 ## Terminology
9
10 **windowgrams** are the small windows that appear on your screen with
11 a message from another person.
12
13 **Zephyrgrams** are the messages that you send and receive when you
14 are using Zephyr. They can appear as windowgrams or in other forms,
15 depending on which client you are using.
16
17 **zwgc** is the basic, traditional Zephyr client.
18
19 ## Basic Commands
20
21 **zlocate** _**friend**_ is the command used to find out if user
22 "friend" is logged in and subscribing to zephyrgrams. If they are
23 logged in and subscribing to messages you will receive information
24 about where they are logged in. If they are not logged in you will
25 receive the message "Hidden or not logged-in." This means they either
26 do not want to be found or are not logged in.
27
28 **zwrite** _**friend**_ is used to send a message to `friend`. Just
29 follow the instructions given. If you get an error saying the person
30 is hidden or not logged in then your message has not been sent and the
31 person you are trying to reach is not logged in or is not subscribing
32 to messages and you should try sending e-mail instead.
33
34 **zctl hide** can be used to "hide" yourself. When hidden you are not
35 `zlocatable`, but if someone tries to zwrite you anyway they will
36 succeed.
37
38 **zctl wg_shutdown** should be used if you want to stop receiving
39 zephyrgrams for this session.
40
41 **zctl set zwrite-signature "foo"** (quotes are mandatory) will change
42 your Zephyr signature, or zsig, to foo. By default your zsig is your
43 name as it exists in your finger information. It shows up in a
44 zephyrgram before your username. You can change it to almost anything
45 you like, although you should avoid very long zsigs since they tend to
46 annoy people.
47
48 **zaway** is used to let people know you are away from the terminal
49 and not deliberately ignoring their messages. It sends a message to
50 whoever sends you a personal zephyrgram that lets them know that you
51 are away (and will probably respond later).
52
53 **zwgc -ttymode** will start up a Zephyr client when you are logged in
54 remotely. Zephyrs appear as plain text on your screen.
55
56 **znol** will let you know which people on a list are logged in. Your
57 `~/.anyone` file should contain the list of usernames you want to know
58 about (it should have one name per line and no spaces). You will also
59 be sent login and logout notices in the form of a zephyrgram whenever
60 one of the users in your list logs in or out (if they are announced,
61 see below) after you have run `znol` during a session.
62
63 **zctl set exposure exposurelevel** will set your exposure (how other
64 people know when you are logged in). An exposure level of
65 `net-announced` causes login and logout notices to be sent to people
66 who have you in their `.anyone` file, and you will be
67 zlocatable. `net-visible` is the same except login and logout notices
68 are not sent. The `realm-announced` and `realm-visible` settings
69 require authentication before your information is divulged, but behave
70 in most situations in the same way as `net-announced` and
71 `net-visible`, respectively. The `opstaff` setting makes you unable to
72 be zlocated and does not send login and logout notices. Finally the
73 `none` setting provides no information about you and **you will not be
74 able to receive zephyrgrams'''.
75
76 __zctl sub message foo *__ will subscribe you to a Zephyr "instance"
77 named foo. Zephyr instances (and classes) allow groups of people to
78 have conversations via Zephyr. The above `zctl` command will subscribe
79 you to the instance `foo` for your current login only; to make it more
80 permanent replace `sub` with `add`. To unsubscribe for this login only
81 change `sub` to `unsub`, and to unsubscribe permanently use `delete`
82 instead.
83
84 **zwrite -i foo** will send a message to the Zephyr instance `foo`.
85
86 __zctl sub foo * *__ subscribes you to the Zephyr class `foo`. Zephyr
87 classes are slightly more private than instances as you must know the
88 name of the class to subscribe to it. `unsub`, `add` and `delete` work
89 the same way for classes as for instances.
90
91 **zwrite -c foo** sends a zephyr(gram) to class `foo`.