source: doc/intro.txt @ bde7714

barnowl_perlaimdebianowlrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since bde7714 was bde7714, checked in by James M. Kretchmar <kretch@mit.edu>, 18 years ago
Started updating the intro document Small changes to help / about The 'subscribe' and 'unsubscribe' commands (and their aliases) update .zephyr.subs by default. If either is given the '-t' (for "temporary") option the .zephyr.subs will not be updated
  • Property mode set to 100644
File size: 7.5 KB
RevLine 
[bde7714]1                     ========================
2                     Quick Guide To Using Owl
3                     ========================
[61d27fb]4
[bde7714]5=======================
6Section 1: INTRODUCTION
7=======================
[61d27fb]8
[bde7714]9Owl is a tty, curses-based instant messaging client.  This is a quick
10guide to learning how to use it.  Currently it supports only zephyr,
11but other messaging protocols, including AIM and Jabber, are on the
12way.  Some major features of owl include:
[7d4fbcd]13
[bde7714]14   o) As a tty client it can be run over telnet, rlogin or text ssh
15      sessions
[7d4fbcd]16
[bde7714]17   o) It uses a perl configuration file for setting preferences and
18      formatting messages
[7d4fbcd]19
[bde7714]20   o) Emacs style editing of messages
[7d4fbcd]21
[bde7714]22   o) It is easy to use and runs without a configfile.
[7d4fbcd]23
[bde7714]24   o) Advanced sorting and coloring of messages
[7d4fbcd]25
[bde7714]26==========================
27Section 2: GETTING STARTED
28==========================
[7d4fbcd]29
30Owl will run happily without a configfile, so to get started just run
[bde7714]31the program.  Owl will take over the terminal window it's started in,
32so you may wish to have another terminal around at the same time.
33
34On Athena you can find owl in the ktools locker.  So to run it you can
35type:
36
37        add ktools
38        owl
39
40at the Athena% prompt.  If you wish to run the latest beta release of
41owl type 'owl-beta' instead of 'owl'.
[7d4fbcd]42
[bde7714]43The Screen Layout
44-----------------
45There are three main parts to the owl screen.  The large top portion
46of the screen is where zephyrs are displayed.  The status bar
47separates this area from the one below and displays some status
48information.  The space below that is used to type in messages and is
49also used by owl to give warnings and information to the user.
50
51On Line Help
52------------
53Owl has a full on line help system.  Pressing the 'h' key will bring
54up the basic help screen.  Further help can be obtained using the help
55command.
[7d4fbcd]56
57Sending a Zephyr
58----------------
[bde7714]59To send a zephyr to yourself press the 'z' key.  This will start a
[7d4fbcd]60zwrite command, which you can finish by typing the name of the user
61you wish to send to, followed by enter.  Begin typing your message.
62You will notice that most emacs-style editing is available.  When you
[bde7714]63are ready to send the message type Control-D or a dot ('.') on a line
64by itself.  If instead you wish to cancel the message type Control-C.
[7d4fbcd]65
[bde7714]66If you wish to send to a class/instance pair simply supply -c and -i
67arguments to the zwrite command as you normally would.
[7d4fbcd]68
69Manipulating Messages
70---------------------
71When there are one or more zephyrs in the message window, one of them
72will be the 'current' message.  Owl will indicate which one it is with
[bde7714]73an arrow that looks like this: -> .  The following keys will move you
74to different messages:
[7d4fbcd]75
76        n               move to the next non-deleted message
77        p               move to the previous non-deleted message
78        C-n , down      move to the next message
79        C-p , up        move to the previous message
80        <               move to the first message
81        >               move to the last message
[bde7714]82        C-v             page down
83        M-v             page up
[7d4fbcd]84        right           scroll the screen to the right
85        left            scroll the screen to the left
86        P               move to the next personal message
87        M-P             move to the previous personal message
88
89When you are ready to delete a message you can mark it for deletion
90and a 'D' will appear to the left of the message.  Messages will not
[bde7714]91actually be removed until you perform an expunge.  The following keys
92are used to delete, undelete and expunge messages:
[7d4fbcd]93
94        d               mark a message for deletion
95        u               unmark a message for deletion
96        x               expunge deleted messages
[bde7714]97        T               mark all 'trash' messages for deletion
98        M-D             mark all messages in the view for deletion
99        M-u             unmark all messages in the view for deletion
[7d4fbcd]100
101If you would like to respond to a zephyr sent to you there is a reply
[bde7714]102shortcut.
[7d4fbcd]103
[bde7714]104        r               Reply.  Personal zephyrs get a personal reply,
105                        class/instance zephyrs get a public reply.
106        R               Reply to sender.  Always replies personally
107                        to the user.
108        M-r             Reply but allow editing of the command line.
109        M-R             Reply to sender but allow editing of the
110                        command line.
[7d4fbcd]111
[bde7714]112In the event that the current message is too large to fit on the
113screen, you can scroll within the message using the following keys:
[7d4fbcd]114
115        SPACE           page down
116        b               page up
117        RETURN          line down
118        BACKSPACE       line up
119
[bde7714]120The message pointer will change to indicate that the message is not
121starting at the first line.
[7d4fbcd]122
123Two other keys that relate to the current message:
124
125        i               print detailed information about the message
126        w               instruct netscape to visit a URL in the message
127
128
129Other Functions
130----------------
131Some other funcions that can be performed with a single keystroke:
132
[bde7714]133        A               toggle zaway on or off
[7d4fbcd]134        C-l             refresh and resize the screen
135        C-z             suspend
136
137Command Mode
138------------
139Owl has a command mode where you can enter more detailed commands for
[bde7714]140owl to process.  To enter command press the color (':') key:
[7d4fbcd]141
142        :               begin command mode
143
144Owl will give you a command prompt and you can begin typing your
145command.  Type Enter to execute the command, Control-C to cancel.
[bde7714]146There are many commands.  The basic commands are listed on the basic
147help screen (by pressing 'h').  If you'd like a list of all commands
148you can use the command "show commands".  To get detailed information
149on the syntax and use of a command you can use the command 'help
150<command>' as in:
151
152        help zwrite
[7d4fbcd]153
154Variables
155---------
[bde7714]156
157Owl has a number of internal variables that can be used to change the
158behavior the program.  The 'print' command will let you view the value
159of a variable and the 'set' commmand will let you set the value of a
160variable.  For example:
161
162        set personalbell on
163
164will set the value of the variable 'personalbell' to on.  The command:
165
166        print personalbell
167
168will show you the current value.  The 'print' command with no
169arguments will show you the value of all variables.  A list of all
170variables is available on the basic help screen, or by using the
171command "show variables".  The command "show variable <variablename>"
172will show you detailed information about a variable and how to use it.
173As in:
174
175        show variable personalbell
176
177=============================
178Section 3: FILTERS AND COLORS
179=============================
180
181
182
183==========================
184Section 4: THE CONFIG FILE
185==========================
[7d4fbcd]186
187*** WARNING: This interface may change substantially in the near future ***
188
189This file is interpreted by the perl interpreter.
190If you wish to execute an owl command use the
191function owl::command().  i.e.
192
193     owl::command("set zsigproc \"/mit/kretch/bin/getzsig foo\"");
194
195will set the owl variable zsigproc.  Note that commands will currently
196be executed in order after the called configuration subroutine exits.
197
198Subroutines created with the names below will be executed at the
199specified times:
200
201    subroutine name    properties
202    ---------------    ----------
203    owl::startup()     run when owl first starts
204    owl::shutdown()    run when owl exits
205    owl::format_msg()  run when a new message arrives, the return
206                          value is used to display the message on the
207                          screen
208    owl::receive_msg() run when a message is received, and after
209                       it has been added to the message list
210
211
212The following variables will be set each time a message is recevied:
213
214    $owl::class, $owl::instance, $owl::recipient,
215    $owl::sender, $owl::opcode, $owl::zsig,
216    $owl::msg, $owl::time, $owl::host, @owl::fields, $owl::id
217
218The "appendtosepbar" variable may be set in owl::format_msg()
219to set text to be appended to sepbar that separates the received
220message list from the edit window.
221
222
[bde7714]223==============================
224Section 5: FURTHER INFORMATION
225==============================
226
227$Id$
Note: See TracBrowser for help on using the repository browser.