@database Eyes.guide
@author "Mark Rigby-Jones"
@$VER: mrjEyes.guide 2.01 (19.09.96)
@wordwrap
@smartwrap

@node Main "mrjEyes v2.0 by Mark Rigby-Jones"
@{par} #### ####   #####
@{par}########### #######
@{par}########### ######
@{par}### ### ### ###         @{fg shine}               EEEEE@{fg text}
@{par}### ### ### ###  #      @{fg shine}             j E@{fg text}
@{par}### ### ### ### ###     @{fg shine}               E     y   y  eee   ssss@{fg text}
@{par} #   #   #   #  ###     @{fg shine} mm mm   rrr j EEE   y   y e   e s@{fg text}
@{par}                ###     @{fg shine}m  m  m r    j E      yyyy eeeee  sss@{fg text}
@{par} #####  # #  ######     @{fg shine}m  m  m r    j E         y e         s@{fg text}
@{par}#######  #  #######     @{fg shine}m  m  m r    j EEEEE yyyy   eeee ssss@{fg text}
@{par}######  # #  #####      @{fg shine}          jjj@{fg text}
@{par}###                                    v2.01 19th September 1996
@{par}######   #   #   #
@{par}####### ### ### ###
@{par} ###### ### ### ###
@{par}    ### ### ### ###
@{par} ###### ###########
@{par}####### ###########
@{par} #####   #### ####
@{par}
@{par}============================================================================
@{par}
@{par}          @{" Introduction        " link Introduction}          @{" The Main Window     " link Eyes}
@{par}
@{par}          @{" The Options Window  " link Options}          @{" Use as a Commodity  " link Commodity}
@{par}
@{par}          @{" System Requirements " link System}          @{" Files Included      " link Files}
@{par}
@{par}          @{" Distribution        " link Distribution}          @{" The Author          " link Author}
@{par}
@{par}          @{" Disclaimer          " link Disclaimer}          @{" History             " link History}
@{par}
@endnode

@node Introduction "Introduction"
@{par}@{b}Introduction@{ub}
@{par}~~~~~~~~~~~~
@{par}LOOK OUT!  YOUR AMIGA IS WATCHING YOU!
@{par}
@{par}Welcome to this second edition of my clone of xeyes (for the X Window
System).  An attack of creeping featurism may be noticable, as this version
is vastly more configurable and has many new features but the binary is
somewhat larger - for this reason a slightly cut down version without the GUI
@{"options window" link Options} or @{"commodities interface" link Commodity} is also included.
@{par}
@{par}Written in the excellent Blitz Basic 2.1 by Acid Software.
@endnode

@node Eyes "The Main Window"
@{par}@{b}The Main Window@{ub}
@{par}~~~~~~~~~~~~~~~
@{par}Probably the first thing which you will notice about the main window is that
it is entirely borderless.  It can, however be easily moved and resized by
dragging in the appropriate place with the left mouse button.  Imagine the
window divided into nine egual rectangles: the central one is used for
moving the window, and the outer ones for resizing in the appropriate
direction.  The easiest way to understand this is to try it for yourself.
Pressing the right mouse button at any time during a move or resize will
abort the operation.
@{par}
@{par}@{b}The Menu:@{ub}
@{par}
@{par}@{b}Options -@{ub} This will pop up the GUI @{"options window" link Options} (not in mrjEyesLite)
@{par}@{b}Redraw  -@{ub} Redraws the main window (useful with snapped background)
@{par}@{b}State   -@{ub} Deactivates or activates the eyes (use to save CPU time)
@{par}@{b}About   -@{ub} Pops up a standard about requester.
@{par}@{b}Quit    -@{ub} Hmmm.... Why did I include this...?
@endnode

@node Options "The Options Window"
@{par}@{b}The Options Window
@{par}~~~~~~~~~~~~~~~~~~
@{par}The options window of mrjEyes (but not mrjEyesLite) allows you to change
many features of the program desribed below.  Get the window from the menu
in the @{"main window" link Eyes} or via the @{"commodities interface" link Commodity}.
@{par}
@{par}@{b}Gadgets:@{ub}
@{par}
@{par}@{b}GUI Font    -@{ub} This pops up a requester allowing you to select the font used
by the GUI interface and menus (you may need to resize the window after
changing this to avoid text overlapping)
@{par}@{b}Hotkey      -@{ub} The hotkey used to pop up the options window
@{par}@{b}Win. Depth  -@{ub} The number of bitplanes in the main window.  Lower numbers
will slightly decrease memory usage, but higher numbers give a larger
palette, and this should be the same as the depth of the Workbench screen if
you use the Background snap mode.
@{par}@{b}Background  -@{ub} This cycle gadget allows you to switch between having the
background of the main window a solid colour, or snapshotted from the screen
beneath it.  This use useful if (for example) you have a pattern on your
workbench window.  It will NOT, however be automatically updated - you may
need to Redraw the window under some circumstances.
@{par}@{b}Edge Size   -@{ub} This allows you to set the width of the edge of an eye as a
percentage of the eyes overall width.
@{par}@{b}Pupil Size  -@{ub} This gadget sets the size of the eyes' pupils as a percentage
of the width of the 'white' of the eye.
@{par}@{b}Palettes    -@{ub} These gadgets will set the colours of various parts of the
eye.  The 'White' is the area in which the pupil moves, and the blink colour
is the one used by the 'eyelids' in blink mode.
@{par}@{b}Blink Mode  -@{ub} This cycle gadget not only turns blinking on and off, but
allows you to choose between straight-edged eyelids and ones which curve
nicely.  Try both and pick your favourite, or turn off blinking to save
memory.
@{par}@{b}Blink Meet  -@{ub} This alows you to select where the eyebrows will meet.  A
setting of 100% will have on coming all the way down from the top, 0% one
all the way up from the bottom and 50% will have them meet halfway.
@{par}@{b}Blink Steps -@{ub} This sets the number of steps in the blink animation.  Higher
nubers give a smoother effect, but eat up more memory.
@{par}@{b}Blink Delay -@{ub} This is an alternative method of increasing the length of a
blink by altering the number of redraws for which each frame is shown.
@{par}@{b}Blink Wait  -@{ub} This sets the time between blinks (theoretically in 50ths of a
second except for large windows and/or slow machines)
@{par}@{b}Save        -@{ub} Save the current options to ENV: and ENVARC:
@{par}@{b}Use         -@{ub} Save options to ENV:mrjsw/eyes only
@{par}@{b}Test        -@{ub} Test current options
@{par}@{b}Cancel      -@{ub} Revert to last-saved options
@{par}@{b}Quit        -@{ub} Oops.  Slipped that one in again...
@{par}
@{par}@{b}Menu:@{ub}
@{par}
@{par}@{b}About                         -@{ub} Pops up an about requester.
@{par}@{b}Save, Use, Test, Cancel, Quit -@{ub} Same as the gadgets of the same name
@endnode

@node Commodity "Use as a Commodity"
@{par}@{b}Use as a Commodity@{ub}
@{par}~~~~~~~~~~~~~~~~~~
@{par}mrjEyes will normally install itself as a commodity.  This allows you to pop 
up the GUI with a hotkey and control the progran via the commodities exchange.  
mrjEyesLite does not have a commodities interface.
@{par}
@{par}@{b}Default Hotkey:@{ub} (this can be changed from the @{"options window" link Options})
@{par}
@{par}@{b}Pop up options window:@{ub} alt control E
@{par}
@{par}@{b}Control via the exchange:@{ub}
@{par}
@{par}Activate/deacticate the eyes.
@{par}Show or Hide the options window.
@{par}Remove mrjEyes.
@endnode

@node System "System Requirements"
@{par}@{b}System Requirements@{ub}
@{par}~~~~~~~~~~~~~~~~~~~
@{par}Any Amiga with Workbench 2.0 or better (I hope)
@{par}
@{par}Tested on an A1200/020/28MHz with 4 megs Fast RAM and a hard disk.
@endnode

@node Files "Files Included"
@{par}@{b}Files Included@{ub}
@{par}~~~~~~~~~~~~~~
@{par}mrjEyes
@{par}|
@{par}+- Eyes               The program itself
@{par}|
@{par}+- Eyes.bb2           Blitz Basic II source code
@{par}|
@{par}+- Eyes.bb2.info
@{par}|
@{par}+- Eyes.guide         This thing that you're reading now
@{par}|
@{par}+- Eyes.guide.info
@{par}|
@{par}+- EyesLite           The small version
@{par}|
@{par}+- EyesLite.bb2       Blitz Basic II source code
@{par}|
@{par}+- EyesLite.bb2.info
@{par}|
@{par}+- EyesLite.info
@{par}
@{par}mrjEyes.info
@endnode

@node Distribution "Distribution"
@{par}@{b}Distribution@{ub}
@{par}~~~~~~~~~~~~
@{par}This program is Giftware.  Feel free to give it to your friends, force it on
your enemies or feed it to your dog (but only if you've first transferred it
to some suitably edible media). If you really like this program, feel free to
send me any form of gift (money, disks, bug reports, parcelbombs etc), or
just an email to let me know that you like the program. If you send me an
email address, I'll try to keep you informed of any updates or other programs
that I write.
@{par}
@{par}This archive can be placed on Aminet, and any similar free-access FTP sites,
BBSs, Aminet CDs and Fred Fish's AmigaLibrary.
It can be included in other public domain collections, provided that charges
made are minimal (I would suggest no more than £1.50 per floppy, £15 per CD)
You can also include it on the coverdisk/CD of a magazine provided that you
send me a copy.
@{par}
@{par}The latest version of this, and any other programs I have written, can be
found using the World Wide Web at:
@{par}
@{par}http://users.ox.ac.uk/~kebl0206/mrjsw/
@endnode

@node Author "The Author"
@{par}@{b}The Author@{ub}
@{par}~~~~~~~~~~
@{par}This program was written by Mark Rigby-Jones.
@{par}
@{par}@{b}You can contact me in the following methods:@{ub}
(term-time is October '96 - June '97 (minus a fortnight at Xmas and Easter)
@{par}
@{par}email (term-time only)  mark.rigby-jones@keble.oxford.ac.uk
@{par}World Wide Web          http://users.ox.ac.uk/~kebl0206/
@{par}
@{par}Snail mail:       Home: Top 'O' the Hill
@{par}                        Kirk Ireton
@{par}                        Derby
@{par}                        DE6 3JW
@{par}                        UK
@{par}
@{par}            University: Keble College
@{par}                        Oxford
@{par}                        OX1 3PG
@{par}                        UK
@endnode

@node Disclaimer "Disclaimer"
@{par}@{b}Disclaimer@{ub}
@{par}~~~~~~~~~~
@{par}You use this program entirely at your own risk.  I provide no guarantee that
it will work properly, or even at all, on your machine.  I hereby reject any
responsibility or liability for any damage that use of this program may
cause to  your computer, data, finances, self, sanity or any other part of
the universe (or elsewhere), real or imagined.
@{par}
@{par}So there.
@endnode

@node History "History"
@{par}@{b}History@{ub}
@{par}~~~~~~~
@{par}v1.00  First release. 'nuff said.
@{par}
@{par}v1.01  Erm....  I changed the name and ... and ...
@{par}
@{par}v1.02  Fixed to work with any size title font.
@{par}
@{par}v1.10  First test of new window system.
@{par}
@{par}v1.11  Vaguely working version.
@{par}
@{par}v1.12  Fully working version (except for blink).
@{par}
@{par}v1.13  Abort window move/size with right mouse button.
@{par}
@{par}v1.14  Blinking functional, memory usage much lower.
@{par}
@{par}v1.15  Blinking now fully adjustable in five ways.
@{par}
@{par}v1.20  GUI options window, installs as commodity.
@{par}
@{par}v1.21  Options can now be used and saved.
@{par}
@{par}v1.22  All options can be changed 'on the fly'.
@{par}
@{par}v1.23  Colours can be changed, background snapped.
@{par}
@{par}v1.24  Palette added to redsigned GUI.
@{par}
@{par}v1.25  Eyes can be dis-/enabled.
@{par}
@{par}v1.26  GUI resizing etc smoothed and speeded up
@{par}
@{par}v2.00  Second Release.
@{par}
@{par}v2.01  Runtime error debugger disabled -> smaller executables
@endnode