Changeset bde7714 for doc/intro.txt


Ignore:
Timestamp:
Sep 22, 2002, 3:20:00 PM (19 years ago)
Author:
James M. Kretchmar <kretch@mit.edu>
Branches:
master, barnowl_perlaim, debian, owl, release-1.4, release-1.5, release-1.6, release-1.7, release-1.8, release-1.9
Children:
5a6e6b9
Parents:
f9c43ae
Message:
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
File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/intro.txt

    r61d27fb rbde7714  
    1 
    2 $Id$
    3 
    4 
    5 Owl is a tty, curses-based zephyr client.  This is a quick guide to
    6 learning how to use it.
    7 
    8 ====================
    9 OVERVIEW OF FEATURES
    10 ====================
    11 o) As a tty client it can be run over telnet, rlogin or text ssh sessions
    12 
    13 o) It uses a perl configuration file for setting preferences and
    14    formatting messages
    15 
    16 o) emacs style editing of messages
    17 
    18 o) It is easy to use and runs without a configfile.
    19 
    20 o) There will future support for AIM and ICQ
    21 
    22 o) There will be future support for advanced sorting of messages
    23 
    24 ===============
    25 GETTING STARTED
    26 ===============
     1                     ========================
     2                     Quick Guide To Using Owl
     3                     ========================
     4
     5=======================
     6Section 1: INTRODUCTION
     7=======================
     8
     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:
     13
     14   o) As a tty client it can be run over telnet, rlogin or text ssh
     15      sessions
     16
     17   o) It uses a perl configuration file for setting preferences and
     18      formatting messages
     19
     20   o) Emacs style editing of messages
     21
     22   o) It is easy to use and runs without a configfile.
     23
     24   o) Advanced sorting and coloring of messages
     25
     26==========================
     27Section 2: GETTING STARTED
     28==========================
     29
    2730Owl will run happily without a configfile, so to get started just run
    28 it.  Owl will take over the terminal window it's started in.
    29 
    30 The Screen
    31 ----------
    32 There are three main parts to the screen.  The large top portion of
    33 the screen is where zephyrs are displayed.  The status bar separates
    34 this area from the one below and displays some status information.
    35 The space below that is used to type in messages and is also used by
    36 owl to give warnings and information to the user.
     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'.
     42
     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.
    3756
    3857Sending a Zephyr
    3958----------------
    40 To send a zephyr to yourself hit the 'z' key.  This will start a
     59To send a zephyr to yourself press the 'z' key.  This will start a
    4160zwrite command, which you can finish by typing the name of the user
    4261you wish to send to, followed by enter.  Begin typing your message.
    4362You will notice that most emacs-style editing is available.  When you
    44 are ready to send type Control-D.  If you wish to cancel type
    45 Control-C.
    46 
    47 If instead of a user you wish to send to class/instance simply supply
    48 -c and -i arguments to the zwrite command.
     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.
     65
     66If you wish to send to a class/instance pair simply supply -c and -i
     67arguments to the zwrite command as you normally would.
    4968
    5069Manipulating Messages
     
    5271When there are one or more zephyrs in the message window, one of them
    5372will be the 'current' message.  Owl will indicate which one it is with
    54 an arrow to the left of the message.  The following keys will move you
    55 between messages
     73an arrow that looks like this: -> .  The following keys will move you
     74to different messages:
    5675
    5776        n               move to the next non-deleted message
     
    6180        <               move to the first message
    6281        >               move to the last message
     82        C-v             page down
     83        M-v             page up
    6384        right           scroll the screen to the right
    6485        left            scroll the screen to the left
    6586        P               move to the next personal message
    6687        M-P             move to the previous personal message
    67         T               Mark all 'trash' messages for deletion
    6888
    6989When you are ready to delete a message you can mark it for deletion
    7090and a 'D' will appear to the left of the message.  Messages will not
    71 actually be removed until you perform an expunge.
     91actually be removed until you perform an expunge.  The following keys
     92are used to delete, undelete and expunge messages:
    7293
    7394        d               mark a message for deletion
    7495        u               unmark a message for deletion
    7596        x               expunge deleted messages
    76         T               mark all automated messages for deletion
     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
    77100
    78101If you would like to respond to a zephyr sent to you there is a reply
    79 shortcut.  This will reply to a personal zephyr, or if the zephyr is
    80 sent to a zephyr class it will reply to the zephyr class.
    81 
    82         r               reply to a zephyr
    83 
    84 You can scroll within the current message using:
     102shortcut.
     103
     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.
     111
     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:
    85114
    86115        SPACE           page down
     
    89118        BACKSPACE       line up
    90119
    91 The pointer will change to indicate that the message is not starting
    92 at the first line.
     120The message pointer will change to indicate that the message is not
     121starting at the first line.
    93122
    94123Two other keys that relate to the current message:
     
    102131Some other funcions that can be performed with a single keystroke:
    103132
    104         A               toggle zaway
    105         h               print the help screen
     133        A               toggle zaway on or off
    106134        C-l             refresh and resize the screen
    107135        C-z             suspend
     
    110138------------
    111139Owl has a command mode where you can enter more detailed commands for
    112 owl to process.  To enter command mode:
     140owl to process.  To enter command press the color (':') key:
    113141
    114142        :               begin command mode
     
    116144Owl will give you a command prompt and you can begin typing your
    117145command.  Type Enter to execute the command, Control-C to cancel.
    118 Currently support commands are:
    119 
    120         quit , exit     exit owl
    121         zwrite          send a zephyr
    122         reply           reply to the current zephyr
    123         set             set a variable
    124         print           print a variable
    125         zlog [in|out]   send a login or logout message
    126         version         print the owl version number
    127         subscribe       subscribe to a class, instance, recipient
    128         unsubscribe     unsubscribe from a class, instance, recipient
    129         unsuball        unsubscribe from all messagse
    130         getsubs         print a list of current subscriptions
    131         zlocate         locate a user
    132         info            print detailed information about a message
    133         help            print the help screen
    134         next            move to the next message
    135         prev            move to the previous message
    136         next-notdel     move to the next non-deleted message
    137         prev-notdel     move to the previous not-deleted message
    138         expunge         expunge messages marked for deletion
    139         first           move to the first message
    140         last            move to the last message
    141         resize          resize owl to the current window
    142         suspend         suspend owl
    143         exec            run a shell command
    144         zaway [on|off|<msg>]  Turn zaway on, off, or set the message
    145         load-subs       load subscriptions from a file
    146         status          print info about owl status
    147         about           print info about owl
     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
    148153
    149154Variables
    150155---------
    151 The 'set' and 'print' commands let set and print the values of owl
    152 variables.  The currently supported variables are these:
    153 
    154 Variables:                                                                                       
    155      name            settings  default      meaning                                                 
    156      --------------- --------  -------      -------                                                 
    157      appendtosepbar  <string>            string to append to the end of the sepbar               
    158      bell            on,off    on        enable / disable the terminal bell                       
    159      burningears     on,off    off       [NOT YET IMPLEMENTED] beep on messages matching patterns
    160      classlogging    on,off    off       turn class logging on or off                             
    161      classpath       <path>    ~/zlog/class
    162                                          path for logging class zephyrs                           
    163      debug           on,off    on        whether debugging is enabled                             
    164      debug_file      <path>    /var/tmp/owldebug
    165                                          path for logging debug messages when debugging is enabled
    166      disable-ctrl-d  on,off    off       don't send zephyrs on C-d                               
    167                                                                                                  
    168      displayoutgoing on,off    on        display outgoing messages                               
    169      logging         on,off    off       turn personal logging on or off                         
    170      loginsubs       on,off    on        load logins from .anyone on startup                     
    171      logpath         <path>    ~/zlog/people
    172                                          path for logging personal zephyrs                       
    173      personalbell    on,off    off       ring the terminal bell when personal messages are receive
    174      rxping          on,off    off       display received pings                                   
    175      shutdownlogout  on,off    on        send a logout message when owl exits                     
    176      startuplogin    on,off    on        send a login message when owl starts                     
    177      summarymode     on,off    off       [NOT YET IMPLEMENTED]                                   
    178      txping          on,off    on        send pings                                               
    179      typewinsize     int > 0   8         number of lines in the typing window                     
    180      webbrowser  none,netscape,galeon netscape web browser to use to launch URLs             
    181      zaway_msg         <string>  "I'm sorry..."
    182                                            current zaway msg for responding to zephyrs when away   
    183      zaway_msg_default <string>  "I'm sorry..."
    184                                            default zaway msg for responding to zephyrs when away 
    185      zsig              <string>            zephyr signature                                         
    186      zsigproc          <path>    <null>    name of a program to run that will generate zsigs       
    187 
    188 
    189 ================
    190 THE CONFIG FILE
    191 ================
     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==========================
    192186
    193187*** WARNING: This interface may change substantially in the near future ***
     
    227221
    228222
    229 ===================
    230 FURTHER INFORMATION
    231 ===================
     223==============================
     224Section 5: FURTHER INFORMATION
     225==============================
     226
     227$Id$
Note: See TracChangeset for help on using the changeset viewer.