@database UMSWatch.guide
@master UMSWatch.guide
@$VER: 1.3
@author "Peter Stegemann"
@(c) "Peter Stegemann"

@node "Main" "UMSWatch"

                                 UMSWatch V1.3

            Nice to tool to show if new mail arrived in your UMS-MB.

                                @{" Description  " link "Description" 0}
                                @{"  Copyright   " link "Copyright" 0}
                                @{"  Disclaimer  " link "Disclaimer" 0}
                                @{"   Contents   " link "Contents" 0}
                                @{"    Usage     " link "Usage" 0}
                                @{"   Vecfiles   " link "Vecfiles" 0}
                                @{"    Thanx     " link "Thanx" 0}
                                @{"   History    " link "History" 0}
                                @{"     Bugs     " link "Bugs" 0}
                                @{"   Contact    " link "Contact" 0}
                                @{"    Lyrics    " link "Lyrics" 0}
@endnode
@node "Copyright" "Copyright"
@next "Disclaimer"
@prev "Lyrics"

                    UMSWatch is Funware 1995 by @{"Peter Stegemann" link "Contact" 0}.

     If you like and use this programm, you don't have to send me anything.

 BUT NEVER FORGET: Supporting the public domain is supporting yourself. The
                   authors of pd are spending loads of time in their work, so
                   honor it by supporting them.

                              All Rights Reserved.

            Kickstart 2.04 and Workbench 2.0 are Copyright 1985-1992
                            by Commodore-Amiga, Inc.
@endnode
@node "Disclaimer" "Disclaimer"
@next "Contents"
@prev "Copyright"

 This software package is freely distributable, as long as no files are modified
   or removed from the archive. It`s not allowed to raise any money for it`s
      spreading and copying, any distribution trough companies is illegal!
     The distribution trough the AmiNet- and the Fred-Fish-CDs is allowed.

    This software and information is provided "as is". No representations or
  warranties are made with respect to the accuracy, reliability, performance,
 currentness, or operation of this software and information, and all use is at
    your own risk. The author doesn't assume any responsibility or liability
     whatsoever with respect to your use of this software and information.

@endnode
@node "Contents" "Contents"
@next "Description"
@prev "Disclaimer"

 This software package consists of the following files:

Bin/PingUMSWatch                6008    - the signaller for UMSWatch
Bin/UMSWatch                   15028    - the program itself
Bin/UMSWatch.AT.vec              826    - vector-file for the (faked?) AT-logo
Bin/UMSWatch.Cube.vec            336    - vector-file for a simple cube
Bin/UMSWatch.MK.vec              767    - vector-file for the good old Cobra
Doc/UMSWatch.guide              7249    - english amigaguide
Doc/UMSWatch.guide.info          840    - it`s icon

@endnode
@node "Description" "Description"
@next "Usage"
@prev "Contents"

   UMSWatch shows you how much unread mail, news and foldered mail is in your
   messagebase. If new mail has arrived in your messagebase the color of the
                     Logo changes from color 2 to color 3.

  In this archive there are two versions of UMSWatch.vec:

    UMSWatch.AT.vec - UMSWatch with the (already old?) Amiga Technologies-
                      Logo.
    UMSWatch.MK.vec - UMSWatch with the good old Eagle MK-II from the original
                      Elite.

           To rescan the messagebase, you have to start PingUMSWatch.

   UMSWatch requires @{"Kickstart 2.04" link "Copyright" 0}, @{"Workbench 2.0" link "Copyright" 0} and @{"UMS V11" link "Thanx" 0} or better.

              The UMSWatch contains an embedded version id in CBM
  format which can be shown using the Shell command VERSION of Workbench 2.0.

  All program components are tested with Enforcer V37.28 and MungWall V37.55.

@endnode
@node "Usage" "Usage"
@next "Vecfiles"
@prev "Description"

 UMSWatch N=NAME,P=PASSWORD,S=SERVER,V=VECFILE,X=WINDOWX/N,Y=WINDOWY/N,
          I=SIZE/N,A=AUTOPING/N,R=PRIORITY/N,D=DRAGBAR/S

 NAME           - Name of the user to login.
                  Default: "Sysop"

 PASSWORD       - Password to login.
                  Default: ""

 SERVER         - MsgBase to login.
                  Default: "default"

 VECFILE        - The vector-file to use.
                  Default: "UMSWatch.vec"

 WINDOWX        - Vertical position of the window.
                  Default: 0

 WINDOWY        - Horizontal position of the window.
                  Default: 0

 SIZE           - InnerWidth and InnerHeight of the window.
                  Default: 175

 AUTOPING       - Time in seconds between the rescanning of the messagebase.
                  Default: 0 (Disabled)

                  If you use your UMS-MB with "AutoQuit" you should use a
                  HIGHER value here, otherwise the UMSServer will never quit!
                  AUTOPING will only scan the MB if the UMSServer ist already
                  running, it will not lunch the server.

 PRIORITY       - Taskpriority to use.
                  Default: -100

                  You should set this to a LOW value, otherwise UMSWatch will
                  eat processor-time you need for more important things.

 DRAGBAR        - This  switch adds an dragbar to your window.
                  Default: off.

 PingUMSWatch N=NAME,S=SERVER

 PingUMSWatch forces the already (with the same values) startet UMSWatch to
 rescan the MB. This will launch the UMSServer if he's not already active.

 NAME           - Name of the user to login.
                  Default: "Sysop"

 SERVER         - MsgBase to login.
                  Default: "default"

@endnode
@node "Vecfiles" "Vecfiles"
@next "History"
@prev "Usage"

    The format of the vecfiles is really simple and not very flexible,
    e.g. it's important that before every number there is a space, spaces
    between the "-" and the number are not allowed.

    This is only a little cube, using hidden line mode.

Mode    0;
    -   this selects the draw-mode: 0 = hidden line
                                    1 = "skeleton"

Points
    -   here starts the definition of the edge-points.

   8,

    -   we want to define 8 points...

  -40,   40,   40,
   40,   40,   40,
   40,  -40,   40,
  -40,  -40,   40,
  -40,   40,  -40,
   40,   40,  -40,
   40,  -40,  -40,
  -40,  -40,  -40;

    -   point after point (x,y,z), ended with a semicolon.
        point-coordinates may range from -128 to 127.

Edges
    - here starts the definition of the surfaces (don't ask me why this is
      named edges... I can't remember).

      6,

    - a cube has 6 faces...

      0,   1,   2,   3,
      1,   5,   6,   2,
      5,   4,   7,   6,
      4,   0,   3,   7,
      4,   5,   1,   0,
      3,   2,   6,   7;

    - very important: in hidden line mode, the edges of a surface have to be
                      defined clockwise while facing it.
                      With this simple hidden line mode it's not possible to
                      create concave objects like cups or smthing similar.

@endnode
@node "History" "History"
@next "Bugs"
@prev "Vecfiles"

 V1.0> (18.06.95)

  - initial release

 V1.1> (xx.xx.xx)

  - internal release (can't really remember...)

 V1.2> (22.08.95)

  - changed the display-routines
  - compiled two versions:
    with AT-Logo
    with Eagle MK-II
  - added DRAGBAR-switch
  - added PRIORITY
  - added AUTOPING

 V1.3> (04.01.96)

  - added VECFILE
    and made the logo user-definable

 V1.4> (future)

  - filled vectors
  - star-background
  - multi-color
  - z-correction

@endnode
@node "Bugs" "Bugs"
@next "Thanx"
@prev "History"

   There seem to be some problems between UMS and some Tools when starting an
  UMS-application from startup-sequence/WBStartup. If your systems crashes on
  startup, insert some delay before starting the UMS-program, this will help.

@endnode
@node "Thanx" "Thanx"
@next "Contact"
@prev "Bugs"

 A special Thanx to the following people:

 - Andre Schenk, for beeing my personal UMS-doc.
       ^
       This should be some sort of special character...

 - Mike Witte, for annoying me with feature requests ;-)

@endnode
@node "Contact" "Contact"
@next "Lyrics"
@prev "Thanx"

       For suggestions, bugreports, postcards and gifts contact me under:

                     SnailMail: Peter Stegemann
                                 Unter Stad 56
                                79353 Bahlingen

                         Money: 3260 59-759
                                Postbank Karlsruhe
                                660 100 75

                       Fidonet: 2:2476/775.0@fidonet.org
                      Amiganet: 39:173/101.0@amiganet.ftn
                        Usenet: pst@cocoon.infra.de
                         Voice: +49(0)7723-91023
                          Data: +49(0)7723-91025  (ZyX16k8)
                                                  (X.75/V.110)
@endnode
@node "Lyrics" "Lyrics"
@next "Copyright"
@prev "Contact"

           Lyrics? Who wants to have lyrics? We're men out of steel,
                            we don't need no lyrics!

@endnode
