source: doc/intro.txt @ 1aee7d9

barnowl_perlaimdebianowlrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since 1aee7d9 was 7d4fbcd, checked in by James M. Kretchmar <kretch@mit.edu>, 19 years ago
Initial check in
  • Property mode set to 100644
File size: 8.9 KB
Line 
1Owl is a tty, curses-based zephyr client.  This is a quick guide to
2learning how to use it.
3
4====================
5OVERVIEW OF FEATURES
6====================
7o) As a tty client it can be run over telnet, rlogin or text ssh sessions
8
9o) It uses a perl configuration file for setting preferences and
10   formatting messages
11
12o) emacs style editing of messages
13
14o) It is easy to use and runs without a configfile.
15
16o) There will future support for AIM and ICQ
17
18o) There will be future support for advanced sorting of messages
19
20===============
21GETTING STARTED
22===============
23Owl will run happily without a configfile, so to get started just run
24it.  Owl will take over the terminal window it's started in.
25
26The Screen
27----------
28There are three main parts to the screen.  The large top portion of
29the screen is where zephyrs are displayed.  The status bar separates
30this area from the one below and displays some status information.
31The space below that is used to type in messages and is also used by
32owl to give warnings and information to the user.
33
34Sending a Zephyr
35----------------
36To send a zephyr to yourself hit the 'z' key.  This will start a
37zwrite command, which you can finish by typing the name of the user
38you wish to send to, followed by enter.  Begin typing your message.
39You will notice that most emacs-style editing is available.  When you
40are ready to send type Control-D.  If you wish to cancel type
41Control-C.
42
43If instead of a user you wish to send to class/instance simply supply
44-c and -i arguments to the zwrite command.
45
46Manipulating Messages
47---------------------
48When there are one or more zephyrs in the message window, one of them
49will be the 'current' message.  Owl will indicate which one it is with
50an arrow to the left of the message.  The following keys will move you
51between messages
52
53        n               move to the next non-deleted message
54        p               move to the previous non-deleted message
55        C-n , down      move to the next message
56        C-p , up        move to the previous message
57        <               move to the first message
58        >               move to the last message
59        right           scroll the screen to the right
60        left            scroll the screen to the left
61        P               move to the next personal message
62        M-P             move to the previous personal message
63        T               Mark all 'trash' messages for deletion
64
65When you are ready to delete a message you can mark it for deletion
66and a 'D' will appear to the left of the message.  Messages will not
67actually be removed until you perform an expunge.
68
69        d               mark a message for deletion
70        u               unmark a message for deletion
71        x               expunge deleted messages
72        T               mark all automated messages for deletion
73
74If you would like to respond to a zephyr sent to you there is a reply
75shortcut.  This will reply to a personal zephyr, or if the zephyr is
76sent to a zephyr class it will reply to the zephyr class.
77
78        r               reply to a zephyr
79
80You can scroll within the current message using:
81
82        SPACE           page down
83        b               page up
84        RETURN          line down
85        BACKSPACE       line up
86
87The pointer will change to indicate that the message is not starting
88at the first line.
89
90Two other keys that relate to the current message:
91
92        i               print detailed information about the message
93        w               instruct netscape to visit a URL in the message
94
95
96Other Functions
97----------------
98Some other funcions that can be performed with a single keystroke:
99
100        A               toggle zaway
101        h               print the help screen
102        C-l             refresh and resize the screen
103        C-z             suspend
104
105Command Mode
106------------
107Owl has a command mode where you can enter more detailed commands for
108owl to process.  To enter command mode:
109
110        :               begin command mode
111
112Owl will give you a command prompt and you can begin typing your
113command.  Type Enter to execute the command, Control-C to cancel.
114Currently support commands are:
115
116        quit , exit     exit owl
117        zwrite          send a zephyr
118        reply           reply to the current zephyr
119        set             set a variable
120        print           print a variable
121        zlog [in|out]   send a login or logout message
122        version         print the owl version number
123        subscribe       subscribe to a class, instance, recipient
124        unsubscribe     unsubscribe from a class, instance, recipient
125        unsuball        unsubscribe from all messagse
126        getsubs         print a list of current subscriptions
127        zlocate         locate a user
128        info            print detailed information about a message
129        help            print the help screen
130        next            move to the next message
131        prev            move to the previous message
132        next-notdel     move to the next non-deleted message
133        prev-notdel     move to the previous not-deleted message
134        expunge         expunge messages marked for deletion
135        first           move to the first message
136        last            move to the last message
137        resize          resize owl to the current window
138        suspend         suspend owl
139        exec            run a shell command
140        zaway [on|off|<msg>]  Turn zaway on, off, or set the message
141        load-subs       load subscriptions from a file
142        status          print info about owl status
143        about           print info about owl
144
145Variables
146---------
147The 'set' and 'print' commands let set and print the values of owl
148variables.  The currently supported variables are these:
149
150Variables:                                                                                       
151     name            settings  default      meaning                                                 
152     --------------- --------  -------      -------                                                 
153     appendtosepbar  <string>            string to append to the end of the sepbar               
154     bell            on,off    on        enable / disable the terminal bell                       
155     burningears     on,off    off       [NOT YET IMPLEMENTED] beep on messages matching patterns
156     classlogging    on,off    off       turn class logging on or off                             
157     classpath       <path>    ~/zlog/class
158                                         path for logging class zephyrs                           
159     debug           on,off    on        whether debugging is enabled                             
160     debug_file      <path>    /var/tmp/owldebug
161                                         path for logging debug messages when debugging is enabled
162     disable-ctrl-d  on,off    off       don't send zephyrs on C-d                               
163                                                                                                 
164     displayoutgoing on,off    on        display outgoing messages                               
165     logging         on,off    off       turn personal logging on or off                         
166     loginsubs       on,off    on        load logins from .anyone on startup                     
167     logpath         <path>    ~/zlog/people
168                                         path for logging personal zephyrs                       
169     personalbell    on,off    off       ring the terminal bell when personal messages are receive
170     rxping          on,off    off       display received pings                                   
171     shutdownlogout  on,off    on        send a logout message when owl exits                     
172     startuplogin    on,off    on        send a login message when owl starts                     
173     summarymode     on,off    off       [NOT YET IMPLEMENTED]                                   
174     txping          on,off    on        send pings                                               
175     typewinsize     int > 0   8         number of lines in the typing window                     
176     webbrowser  none,netscape,galeon netscape web browser to use to launch URLs             
177     zaway_msg         <string>  "I'm sorry..."
178                                           current zaway msg for responding to zephyrs when away   
179     zaway_msg_default <string>  "I'm sorry..."
180                                           default zaway msg for responding to zephyrs when away 
181     zsig              <string>            zephyr signature                                         
182     zsigproc          <path>    <null>    name of a program to run that will generate zsigs       
183
184
185================
186THE CONFIG FILE
187================
188
189*** WARNING: This interface may change substantially in the near future ***
190
191This file is interpreted by the perl interpreter.
192If you wish to execute an owl command use the
193function owl::command().  i.e.
194
195     owl::command("set zsigproc \"/mit/kretch/bin/getzsig foo\"");
196
197will set the owl variable zsigproc.  Note that commands will currently
198be executed in order after the called configuration subroutine exits.
199
200Subroutines created with the names below will be executed at the
201specified times:
202
203    subroutine name    properties
204    ---------------    ----------
205    owl::startup()     run when owl first starts
206    owl::shutdown()    run when owl exits
207    owl::format_msg()  run when a new message arrives, the return
208                          value is used to display the message on the
209                          screen
210    owl::receive_msg() run when a message is received, and after
211                       it has been added to the message list
212
213
214The following variables will be set each time a message is recevied:
215
216    $owl::class, $owl::instance, $owl::recipient,
217    $owl::sender, $owl::opcode, $owl::zsig,
218    $owl::msg, $owl::time, $owl::host, @owl::fields, $owl::id
219
220The "appendtosepbar" variable may be set in owl::format_msg()
221to set text to be appended to sepbar that separates the received
222message list from the edit window.
223
224
225===================
226FURTHER INFORMATION
227===================
Note: See TracBrowser for help on using the repository browser.