@DATABASE "SwazBlanker"
@AUTHOR David Swasbrook
@(C) Copyright (C)1992-96 David Swasbrook. All Rights Reserved.
@$VER: SwazBlanker 2.30 (01.01.96)

@INDEX Index


@NODE MAIN "SwazBlanker (01.01.96)"


	SWAZBLANKER : Documentation Contents
	====================================

	(C) 1992-96 David Swasbrook,
	     All Rights Reserved.

  @{" Disclaimer         "	LINK Disclaimer		}    Legal information

  @{" Shareware          "	LINK Conditions		}    Shareware information

  @{" Requirements       "	LINK Requirements		}    What you needed

  @{" Introduction       "	LINK Introduction		}    Introduction to SwazBlanker

  @{" Installation       "	LINK Installation		}    How to install SwazBlanker

  @{" Usage              "	LINK Usage		}    How to use SwazBlanker

  @{" Updates            "    LINK Updates                  }    Support and updates

  @{" Special Thanks     "	LINK Thanx		}    Thankyou for your ideas/support

  @{" History            "	LINK History		}    A very brief history of SwazBlanker



@ENDNODE



@NODE Disclaimer

	SwazBlanker/Disclaimer
	======================

	I hereby reject any liability or responsibility for these or any other
	consequences from the use of SwazBlanker whatsoever. This includes, but
	is not limited to, damage to your equipment, to your data, personal
	injuries, financial loss or any other kinds of side effects.

	Although SwazBlanker has been tested thoroughly on several different
	machines, I cannot rule out the possibility that SwazBlanker:

	   o is somehow incompatible to your equipment

	   o has bugs that show up on your equipment

	   o does not do what it is supposed to do on your equipment

	It is your responsibility to take any precautions necessary to protect
	yourself from these or any other effects. I explicitly reject any liability
	or responsibility from the consequences of you using SwazBlanker.

	Swaz.

@ENDNODE




@NODE Conditions "Shareware distribution info..."

	SwazBlanker/Shareware
	=====================

	SwazBlanker is @{b}SHAREWARE@{ub}. The program may be freely distributed and
	copied, as long as the following conditions are fulfilled:

	   o The sales price must not be higher than the cost of an (empty) disk
	     plus a nominal copying fee plus costs for shipping. The total price
	     must not be higher than 5 US$.

	   o All parts of the program and the documentation must be complete. The
	     distribution of single parts or incomplete subsets of the original
	     distribution is NOT ALLOWED.

	   o SwazBlanker or parts of it may not be sold in combination with or
	     as part of commercial software.

	   o Program and documentation may not be changed in any way.

	   o Permission has been given for distribution through Aminet and Fred
	     Fish.

	SwazBlanker is shareware, this means I request those users, who use
	SwazBlanker, to send me the shareware fee of 10 US$ (or any other
	contributions gratefully accepted) to the following address:

	Postal:       David Swasbrook,
	              PO Box 54134,
	              Bucklands Beach,
	              Auckland,
	              New Zealand.

	See also @{" email and www addresses " LINK Author }.

	Please include the following information in your registration:

	   o your name, address (electronic mail addresses preferred)

	   o your Amiga model(s)

	   o Kickstart and Workbench versions

	   o the SwazBlanker version number


	I assure you that the information you send me will be treated
	confidentially.

	I will try and inform everybody, who has registered with me as described
	above, when a new version of SwazBlanker becomes available.

	If you have sent a shareware donation, if possible, you will receive an
	update through mail (preferably email).

	Thank you very much in advance !

@ENDNODE

@NODE Author "Contacting the author..."

	SwazBlanker/Author
	==================

	I can be contacted via the following media:

	Postal:               David Swasbrook,
	                      PO Box 54134,
	                      Bucklands Beach,
	                      Auckland,
	                      New Zealand.

	Email:                swaz@pobox.com
	                      swaz@ait.ac.nz

	Internet Relay Chat:  #amiga:Swaz

	World Wide Web:       http://www.pobox.com/~swaz/
	                      http://www.ait.ac.nz/~swaz/


@ENDNODE

@NODE Requirements "Whats needed to run SwazBlanker"

	SwazBlanker/Requirements
	========================

	The following are required for SwazBlanker to run:

	  o Kickstart V39 or higher

	  o @{" swazblanker.library " LINK SBLib} version 44 or higher

	  o @{" swazconfig.library " LINK SCLib} version 2 or higher

	  o @{" matrix.library " LINK MxLib} version 25 or higher

	  o @{" textfield.gadget " LINK TextFieldGadget} version 2 or higher

	  o @{" tabs.gadget " LINK TabsGadget} version 42 or higher.


	The above libraries amd gadgets are all included in the
	distribution archive.

@ENDNODE


@NODE SCLib "SwazConfig Library"

	SwazBlanker/swazconfig.library
	===============================

	Copyright ©1995-96 David Swasbrook, All Rights Reserved.

	o Another library for your libs drawer :)

	o swazconfig.library routines for text based configuration file
	  maintenance. Able to load/save separate named sections of
	  the configuration file, so several applications can share the
	  same data file.

	o Programming documentation is included with the SwazBlanker distribution :

	    @{" include:clib/swazconfig_protos.h     " LINK include:clib/swazconfig_protos.h/MAIN }
	    @{" include:libraries/swazconfig.h       " LINK include:libraries/swazconfig.h/MAIN }
	    @{" include:pragmas/swazconfig_pragmas.h " LINK include:pragmas/swazconfig_pragmas.h/MAIN }
	    @{" include:proto/swazconfig.h           " LINK include:proto/swazconfig.h/MAIN }
	    @{" include:doc/swazconfig.doc           " LINK include:doc/swazconfig.doc/MAIN }
	    @{" include:fd/swazconfig_lib.fd         " LINK include:fd/swazconfig_lib.fd/MAIN }


@ENDNODE

@NODE SBLib "SwazBlanker Library"

	SwazBlanker/swazblanker.library
	===============================

	Copyright ©1994-96 David Swasbrook, All Rights Reserved.

	o Another library for your libs drawer :)

	o swazblanker.library provides general purpose blanker routines,
	  plus several crucial routines for writing SwazBlanker compatable
	  blanker modules.

	o Programming documentation is included with the SwazBlanker distribution :

	    @{" include:clib/swazblanker_protos.h     " LINK include:clib/swazblanker_protos.h/MAIN }
	    @{" include:libraries/swazblanker.h       " LINK include:libraries/swazblanker.h/MAIN }
	    @{" include:pragmas/swazblanker_pragmas.h " LINK include:pragmas/swazblanker_pragmas.h/MAIN }
	    @{" include:proto/swazblanker.h           " LINK include:proto/swazblanker.h/MAIN }
	    @{" include:SwazBlanker.doc               " LINK autodoc:SwazBlanker.doc/MAIN }
	    @{" include:SwazBlanker_lib.fd            " LINK fd:SwazBlanker_lib.fd/MAIN }
		

@ENDNODE

@NODE MxLib "Matrix Library"

	SwazBlanker/matrix.library
	==========================

	Copyright ©1992-96 David Swasbrook, All Rights Reserved.

	o Yet another library to put in your LIBS: drawer.

	o Matrix.library provides general purpose routines which are commonly
	  used through out my programs. Some of the key features are the GUI,
	  preferences, and IFF routines.

	o The name "matrix" came from "The Matrix" - The computer system used
	  by the TimeLords (Re: Dr Who).

	o Please contact me if you'd like programming documentation.

@ENDNODE

@NODE TextFieldGadget "Text Field Gadget Class"

	SwazBlanker/textfield.gadget
	============================

	Copyright ©1995 Mark Thomas, All Rights Reserved.

	The textfield class allows you create an area on your screen for text
	entry.  The class supports a number of features including unlimited
	or limited size text entry, specifying the font and style to use,
	specifying the colors for different parts (text, background, and
	lines), two types of borders (with option to invert the borders for a
	total of 4 types of borders) or no border, text left/center/right
	justification, vertical centering, IntuiText labels, attached Images,
	line spacing, limited character acceptance, insertion or block cursor,
	cursor blinking speed or no blinking, read-only mode, modified buffer
	flag, lined paper, cut/copy/paste/erase while editing or program-
	matically, undo buffer, and settable word delimiter characters for
	word wrapping.

	Mark Thomas
	1515 Royal Crest Dr. #3259
	Austin, TX  78741

	mthomas@zilker.net

@ENDNODE

@NODE TabsGadget "Tabs Gadget Class"

	SwazBlanker/tabs.gadget
	=======================

	Copyright ©1994 Commodore Amiga, All Rights Reserved.

@ENDNODE


@NODE Introduction

	SwazBlanker/Introduction
	========================

	SwazBlanker is a modular screen/mouse blanker providing the
	following fetures:

		o  Blanking of the screen when computer is inactive

		o  Blanking of the mouse pointer when you are typing

		o  Screen can be blanked by pressing a hotkey

		o  Several different blanker modules are provided

		o  Auto-sense @{" reblanking/unblanking " LINK Reblank} when blanker
		   screen is not visible.

		o  @{" OverBlanking " LINK Overblanking} if blanker is not receiving CPU

	Other features:

	  @{" App Window          " LINK AppWin		} Drop icons into the preferences window
	  @{" Arexx               " LINK Arexx		} Send commands via arexx
	  @{" Commodities         " LINK Comodity	} Standard commodities interface
	  @{" Locale              " LINK Locale		} Interface available in different languages
	  @{" Task Management     " LINK TaskManage	} Monitoring of CPU usage of a blanker
@ENDNODE

@NODE TaskManage "Monitoring the CPU usage of a blanker..."

	SwazBlanker/Task Management
	===========================

	The blanker task is managed by SwazBlanker. If the blanker module
	uses too much CPU time or is unable to gain enough CPU time (other
	tasks at higher priority may be using it all) then SwazBlanker
	will shutdown the blanker module and perform the @{" Normal " LINK Mod_Internal_Normal	} blanking
	method of a standard blank screen.

@ENDNODE


@NODE Installation

	SwazBlanker/Installation
	========================

	Double click on the "install" icon.


@ENDNODE


@NODE Usage "How to use SwazBlanker"

	SwazBlanker/Usage
	=================

	Ok, assuming you have already @{" installed " LINK Installation } SwazBlanker
	it now needs to be configured.

	You may wish to change the @{" CLI Args and Tool Types " LINK CLIArgs} before
	running SwazBlanker.

	Double Click on the SwazBlanker icon, if you have set @{" CX_POPUP " LINK CLIArgs} or if
	SwazBlanker is already running the @{" preferences window " LINK Config} should be displayed.
	If not then double click again and the window should appear.

@ENDNODE

@NODE Config "Preferences window..."

	SwazBlanker/Preferences Window
	==============================

	This is where you configure SwazBlanker and the blanker modules.
	Simply change the settings to suit your preferences and save. A brief
	outline on what each gadget in the window does it listed below:

	@{b}Options@{ub}

	    Module Path - sets the path to where you store your blanker modules.
	                  This may also be set by dropping a drawer icon into the
	                  preferences window. See @{" AppWindow " LINK AppWin} support.
	                  @{i}Default : Path as set in the tooltypes.@{ui}

	    Font        - this is the font that you would like to use for the gadgets
	                  in SwazBlanker and the Blanker Module interfaces.
	                  @{i}Default : Screen default font.@{ui}

	    Sounds      - turns @{" sound effects " LINK Sound} on or off.
	                  @{i}Default : Off.@{ui}

	    Reblanking  - if set then if while blanking the blankers screen is
	                  not visible the blankers screen will be made visible.
	                  If this is not set then the blanker will be stopped.
	                  See @{" Reblanking " LINK Reblank} for more details.
	                  @{i}Default : Off.@{ui}

	    Caps Lock   - if ticked, then the blanker will not unblank while the
	                  @{" caps lock " LINK CapsLock} key is down.
	                  @{i}Default : Off.@{ui}

	    Timeout     - sets the number of minutes:seconds of @{" inactivity " LINK DefinitionOfInactivity}
	                  before the screen is blanked using the desired blanking
	                  method as you have selected in the @{" listview " LINK ListView}.
	                  @{i}Default : 3 minutes.@{ui}

	    Keys        - this is the number of key-presses required before
	                  the mouse pointer is blanked. See @{" KeyBlanking " LINK KeyBlanking}.
	                  @{i}Default : Off.@{ui}

	@{b}Blankers@{ub}

	    Listview    - This is a @{" list of available blanker methods " LINK ListView}.

	    Mode        - The "Mode" button lets you choose what action is
	                  performed when you double click on a blanker module
	                  in the listview:
	                        @{"  Configure  " LINK Mode_Config	} brings up the configuration window for the blanker
	                        @{"    Test     " LINK Mode_Test	} tests the banker
	                        @{" Information " LINK Mode_Info	} displays information about the blanker chosen


	There are also a few @{" Keyboard Shortcuts and Special Keys " LINK SpecialKeys} for additional
	features that you may wish to know about.

@ENDNODE

@NODE SpecialKeys "Keyboard Shortcuts and Special Keys"

	SwazBlanker/Keyboard Shortcuts and Special Keys
	===============================================

	Each gadget has a key equivalent (this is shown by placing a
	"_" character under the letter that is equivalent to selecting
	the gadget. Additionally the following keys may be used in the
	preferences interface:

	@{b}ARROW KEYS@{ub}
	  Moves you up and down the @{" list of blanker methods " LINK ListView }.

	@{b}RETURN@{ub}
	  Performs the currently selected mode on the selected blanker
	  method.

	@{b}SPACE@{b}
	  Toggles the state of the tick box for the hilighted module.

	@{b}HELP@{ub}
	  This will show you the SwazBlanker Guide (this document).
	  If you haved moved this from the original place it was
	  installed you will need to set the @{" HELPFILE tooltype " LINK CLIArgs } to
	  refer to the correct filename and path.

	@{b}DEL@{ub}
	  This deletes the currently selected blanker module from the disk.
	  You can only get the module back if you re-install SwazBlanker. To
	  use this feature you need to set the @{" DELETABLEMODULES tooltype " LINK  CLIArgs }
	  to YES.

@ENDNODE

@NODE KeyBlanking "Blanking the mouse pointer after X many keypresses"

	SwazBlanker/KeyBlanking
	=======================

	Ever been typing away and found the mouse pointer in the way?

	Well here is the soloution - you may configure the number of
	keypresses after which the mouse pointer will be blanked until it is
	moved again.

	You may configure the number of keypresses between 1 and 10 or if
	you do not wish to have this feature enabled you may set it to Off.

@ENDNODE


@NODE Overblanking "What happens when no CPU cycles left for blanker?"

	SwazBlanker/Overblanking
	========================

	To ensure that a blanker module receives enough CPU time to
	perform its blanking SwazBlanker monitors how much time the
	blanker module receives. If this is not enough SwazBlanker
	will blank the screen completely until such a time that the
	blanker module starts receiving enough CPU time to run
	effectively.

	See also @{" Reblanking " LINK Reblank}

@ENDNODE

@NODE Reblank "What happens when the blankers screen is not visible?"

	SwazBlanker/Reblanking
	======================

	During the blanking process the blankers screen may become obscured by
	another screen :- another task may open its screen or make its screen
	visible when a certain event occurs.

	This causes problems with the actual screen blanker, as its screen is no
	longer visible. To solve this SwazBlanker has a "reblank" option. Every
	few seconds SwazBlanker checks to make sure that the blankers screen
	is visible on the display. If the screen is not visible then one of two
	actions follows:

		 o  If "reblank" @{b}is set@{ub} then the blankers screen will be brought
		    to the front of the display to make it visible, and blanking
		    continues normally.

		 o  If "reblank" @{b}is not set@{ub} then the blanker will be stopped and
		    SwazBlanker waits for the @{" inactivity " LINK DefinitionOfInactivity} timeout to occur.

	See @{" preferences configuration " LINK Config} for setting the "reblank" option.

	See also @{" Overblanking " LINK Overblanking}

@ENDNODE


@NODE CapsLock "Caps Lock feature..."

	SwazBlanker/Caps Lock Feature
	=============================

	This enables a blanker method to continue while you are moving the
	mouse and/or typing. This is intended to be used with blankers that
	are to be interactive, Eg. There might be a space-invader blanker,
	and if you have caps lock down you can have a game. Its just an
	idea, currently there are no interactive blankers for SwazBlanker.

@ENDNODE


@NODE Sound "Sound effects..."

	SwazBlanker/Sound Effects
	=========================

	Sound effects are played through an external player daemon such as UPD
	or MSD. The following sound id's are currently used, all start with the
	class name of "SwazBlanker/" :

		BlankerFail - played when the blanker failure method is invoked.

		BlankerOn   - played when a blanker method is invoked.

		BlankerOff  - when a blanker method has finished this sound is
		              played.

		MouseHidden - if the mouse pointer is blanked by SwazBlanker
		              then this sound will be played.


	@{b}Acknowledgements@{ub}

	UPD - Universal Player Daemon
	      (C) Copyright 1991 Jonas Petersson & Absolut Software (aka Sirius Soft)

	MSD - Matrix Sound Daemon
	      (C) Copyright 1992-96 David Swasbrook.

@ENDNODE

@NODE Mode_Config "Configuring a blanker method..."

	SwazBlanker/Listview Mode : Configure
	=====================================

	When you double click on a blanker method in the @{" listview " LINK ListView}
	SwazBlanker will ask the selected method to open its preferences window.
	The internal blanker methods do not require configuration.

@ENDNODE

@NODE Mode_Test "Testing a blanker method..."

	SwazBlanker/Listview Mode : Test
	================================

	When you double click on a blanker method in the @{" listview " LINK ListView}
	SwazBlanker will use the selected method to blank the screen.

@ENDNODE

@NODE Mode_Info "Information about a blanker method..."

	SwazBlanker/Listview Mode : Information
	=======================================

	When you double click on a blanker method in the @{" listview " LINK ListView}
	SwazBlanker will display the information it knows about the method.

	  @{b}Name@{ub}
	    Name of the blanker module.

	  @{b}Description@{ub}
	    A brief one line description about the blanker.

	  @{b}Author@{ub}
	    Name of the author of the blanker.

	  @{b}Email@{ub}
	    This is the email address for contacting the author of the blanker.

	  @{b}System@{ub}
	    A description of system requirements for the blanker. This should
	    tell you the minimum required kickstart and CPU and also the expected
	    CPU load (Low, Medium, High).

	  @{b}Notes@{ub}
	    A more detailed description about the blanker. This should tell you
	    what the blanker does, and perhaps how it is achieved etc.

@ENDNODE


@NODE DefinitionOfInactivity "Definition Of Inactivity"

	SwazBlanker/Definition Of Inactivity
	====================================

	SwazBlanker defines a state of inactivity as being a failure of occurrence
	of any @{" activity " LINK DefinitionOfActivity} for a duration of
	preferred timeout.

@ENDNODE

@NODE DefinitionOfActivity "Definition Of Activity"

	SwazBlanker/Definition Of Activity
	==================================

	SwazBlanker defines a state of activity as being events such as a
	keypress or a mouse movement. If no activity occurs for the length
	of timeout as set in the preferences, then a state of @{" inactivity " LINK DefinitionOfInactivity}
	has been attained and the screen should be blanked using the
	preferred blanking method as set in the @{" listview " LINK ListView}.

@ENDNODE


@NODE ListView "Description of modules listview..."

	SwazBlanker/Module List-View
	============================

	This lists the available modules. There are two blankers built into
	SwazBlanker, these are separated in the listview by a horizontal-bar to
	distinguish them from the @{" disk based blankers " LINK DBB}. Additionally the disk
	based modules have a checkbox gadget beside them in the listview, if the
	checkbox is ticked then the module is available for @{" random " LINK Mod_Internal_Random} selection.

	The highlighted blanker will be used for blanking the screen when
	@{" inactivity " LINK DefinitionOfInactivity} occurs.

	Double clicking on an entry in the listview will invoke the action
	specified by the "Mode" cycle gadget:

		@{"    Configure    " LINK Mode_Config	} brings up the configuration window for the blanker
		@{"      Test       " LINK Mode_Test	} tests the banker
		@{"   Information   " LINK Mode_Info	} displays information about the blanker chosen

	The SwazBlanker installation the listview should contain the following
	list of blanker methods:

		@{" Normal          " LINK Mod_Internal_Normal	} Just a normal blank screen
		@{" Random          " LINK Mod_Internal_Random	} Picks a ticked module randomly

@REMARK SB-Listview-Begin : Do not remove this line!
		@{" Alerts          " LINK Alerts/MAIN       } Blank with a guru
		@{" ALoad           " LINK ALoad/MAIN        } Monitor CPU loading
		@{" Crumble         " LINK Crumble/MAIN      } Crumble Blanker
		@{" Dark            " LINK Dark/MAIN         } Dark Blanker
		@{" Dimmer          " LINK Dimmer/MAIN       } Dims the screen
		@{" Energy          " LINK Energy/MAIN       } Energy cloulds
		@{" Explosion       " LINK Explosion/MAIN    } Explosions on the screen
		@{" Goats           " LINK Goats/MAIN        } Goats and Herders Blanker
		@{" Gravity         " LINK Gravity/MAIN      } Gravity
		@{" Headlines       " LINK Headlines/MAIN    } Displays news headlines
		@{" IFS             " LINK IFS/MAIN          } IFS Blanker
		@{" Interference    " LINK Interference/MAIN } Interference Blanker
		@{" Labyrinth       " LINK Labyrinth/MAIN    } Find the way through a maze
		@{" Lines           " LINK Lines/MAIN        } Coloured lines
		@{" Melt            " LINK Melt/MAIN         } Melts the screen
		@{" Mig             " LINK Mig/MAIN          } Magnetic flux color cycling
		@{" Pattern         " LINK Pattern/MAIN      } Colorful pattern cycling
		@{" Plazma          " LINK Plazma/MAIN       } Plazma color cycling
		@{" Pop             " LINK Pop/MAIN          } Pop explosions
		@{" Pyro            " LINK Pyro/MAIN         } Fireworks explosions
		@{" Quotes          " LINK Quotes/MAIN       } Displays Quotes
		@{" Rainfall        " LINK Rainfall/MAIN     } Raindrops
		@{" Rotor           " LINK Rotor/MAIN        } Rotor Blanker
		@{" Shuffle         " LINK Shuffle/MAIN      } Shuffle Screen
		@{" Spliner         " LINK Spliner/MAIN      } Spliner
		@{" Stars           " LINK Stars/MAIN        } 3D Rotating Starfield
		@{" Swarmer         " LINK Swarmer/MAIN      } Bees chasing Wasps
		@{" Toasters        " LINK Toasters/MAIN     } Flying toasters
		@{" Worms           " LINK Worms/MAIN        } Worms eating away the screen
@REMARK SB-Listview-End : Do not remove this line!


@ENDNODE

@NODE Mod_Internal_Normal "Normal"
@TOC Listview

	SwazBlanker/Internal Blanker : Normal
	=====================================

	This is probably the most effective screen blanker method to date. It
	makes the screen go blank, which is after-all what a screen blanker is
	supposed to do.

@ENDNODE

@NODE Mod_Internal_Random "Random"
@TOC Listview

	SwazBlanker/Internal Blanker : Random
	=====================================

	This picks a disk based blanker at random from the @{" listview " LINK ListView}.
	Only ticked blankers can be chosen for the blanker, they are also
	chosen without replacement so you can have a different blanker each
	time.

	If no blankers are ticked then the @{" Normal " LINK Mod_Internal_Normal} blanker will be used.

@ENDNODE

@NODE DBB "Disk based blanker..."

	SwazBlanker/Disk Based Blankers
	===============================

	These are Blanker Modules which are themselves executable programs.
	They may be run externally to SwazBlanker from workbench. If this
	is done then they will bring up their configuration interface.

@ENDNODE



@NODE AppWin "Application window features..."

	SwazBlanker/App Window
	======================

	You may drop a drawer icon into the SwazBlanker @{" preferences window " LINK Config}.

	This will set the ModulePath to this directory and the @{" listview " LINK ListView} will be
	updated to reflect the blanker modules found in that path.

@ENDNODE


@NODE Comodity "Commodities interface"

	SwazBlanker/Commodities Support
	===============================

	SwazBlanker is a commodity and supports standard commodities features.

	The following @{" command line arguments or tooltypes " LINK CLIArgs} are available:	

	  CX_POPKEY

	  CX_POPUP

	  CX_PRIORITY

@ENDNODE


@NODE CLIArgs "Command Line Arguments and Tool Types"

	SwazBlanker/CLI Arguments and Tool Types
	========================================

	SwazBlanker accepts the following either as Command Line Arguments if
	run from CLI or as ToolTypes if you are running SwazBlanker from
	Workbench or the WBStartup drawer.

	CX_POPKEY=<string>
		This is the string describing the key combination that will
		show the SwazBlanker @{" preferences interface " LINK Config}.
		@{i}Default = None.@{ui}

	CX_POPUP=<yes|no>
		If set to YES then the SwazBlanker @{" preferences interface " LINK Config}
		will be opened as soon as SwazBlanker is run.
		@{i}Default = NO.@{ui}

	CX_PRIORITY=<number>
		This sets the priority of the commodities broker.
		@{i}Default = 0.@{ui}

	BLANKKEY=<string>
		This is the string describing the key combination that will
		tell SwazBlanker to blank the screen and mouse pointer.
		@{i}Default = Never.@{ui}

	DEFBLANKERPATH=<path>
		This sets the default path to the blanker modules. This
		gets set to where you installed the blanker modules when
		you ran the install script. The setting in @{" preferences " LINK Config}
		will override this setting.
		@{i}Default = "blankers".@{ui}

	DOCPATH=<path>
		This sets the path to the documentation. This gets set to
		where you installed the SwazBlanker documentation when you
		ran the install script.
		@{i}Default = "docs".@{ui}

	HELPFILE=<filename>
		This is the name of the help file. It will be searched for
		initially in the DOCPATH (@{i}see above@{ui}).
		@{i}Default = "SwazBlanker".@{ui}

	DELETABLEMODULES=<yes|no>
		If set to YES then then you may delete modules from your
		disk by pressing DEL in the preferences window when a module
		is selected.
		@{i}Default = NO.@{ui}


@ENDNODE



@NODE Arexx "How to use SwazBlanker via Arexx..."

	SwazBlanker/Arexx
	=================

	SwazBlanker adds an arexx port to the system named "SwazBlanker" you
	may use the following commands to control certain features:

	  BLANK            - do the preferred blank method

	  BLANK Normal     - blank using the normal blanker.

	  BLANK Random     - blank using a random blanker.

	  BLANK <filename> - blank using a specified blanker module.

	  BLANKMOUSE       - blank the mouse pointer [Not implemented]

	  DISABLE          - disable SwazBlanker [Not implemented]

	  ENABLE           - enable SwazBlanker [Not implemented]

	  HIDE             - hides the about window.

	  QUIT             - will try to remove SwazBlanker from the system.

	  SHOW             - displays the SwazBlanker about window.

	  UNBLANK          - cease blanking



	Examples:

	  o To blank the screen send the "BLANK" command:

		rx ' address SwazBlanker BLANK

	  o To un-blank the screen send the "UNBLANK" command:

		rx ' address SwazBlanker UNBLANK

	  o To show the SwazBlanker preferences interface:

		rx ' address SwazBlanker SHOW

@ENDNODE


@NODE Locale "Language support..."

	SwazBlanker/Locale
	==================

	The SwazBlanker interface supports locale, the built in language is
	english.

	Translations available:

	  deutsch         Christian Krapp
	  español         José Roberto González Rocha
	  íslenska        Sigurbjörn Lárusson
	  suomi           Hekki Kantola

	The @{" SwazBlankerCatalog.cd " LINK "dev/catalogs/SwazBlanker.cd/MAIN"} has been provided so you may make your
	own catalog translation files.

@ENDNODE


@NODE Updates

	SwazBlanker/Support and Updates
	===============================

	The latest version of SwazBlanker should be available on Aminet.
	Beta versions are available for evaluation off the SwazBlanker
	Home Page (see below). I have an account on POBox.Com so if I
	move to a different ISP you can easily find me! The below
	addresses are valid as of 1-Jan-1996.


	SwazBlanker Home Page:

		http://www.pobox.com/~swaz/amiga/swazblanker/

		or

		http://eis1.ait.ac.nz/~swaz/amiga/swazblanker/



	Please email suggestions, comments, ideas and bug reports to:

		swaz@pobox.com

		or

		swaz@ait.ac.nz

@ENDNODE

@NODE Thanx "List of contributors"

	SwazBlanker/Contributors
	========================

	Beta testing and ideas supplied by:

	  Andreas Otte
	  Barry McConnell
	  Christian Krapp
	  Daryl Jay               Mouldy
	  Derek Seaman
	  Edward Lawford
	  Heikki Kantola          Hezu
	  José Roberto González   Rocha
	  Jim Huls                Cappy
	  Ken Krebs
	  Kimmo Veijalainen
	  Luke Chastain           Cloud9
	  Marcel Offermans
	  Matthew Buchanin
	  Michael Lorant
	  Mike Latinovich         SkyGuy
	  Osma Ahvenlampi         Tau
	  Sam Yee
	  Sigurbjörn Lárusson     Sibbi


	Tau also designed all the icons.

@ENDNODE




@NODE History

	SwazBlanker/History Information
	===============================

`2.40'	o Aminet release 1.Jan.96

`2.30'	o Minor bug fixes and improvements

`2.21'	o Update to include latest libraries and stuff.
	o Minor code changes and bug fixes.
	o Locate catalog files renamed

`2.20'	o Major re-write in all modules and main program. Now they
	  all share the same configuration file.

`2.15'	o Updated blankers to support localized descriptions
	o KeyFile support implemented.

`2.13'	o V42.0 swazblanker.library
	o Directory heirachy rationalized, now have the following
	  format:
	      SwazBlanker/SwazBlanker     ... main executable
	      SwazBlanker/Blankers/       ... blanker executables
	      SwazBlanker/Blankers/Data/  ... blanker data files
	      SwazBlanker/Catalogs/       ... locale catalog files
	      SwazBlanker/Documentation/  ... documentation
	      SwazBlanker/Programmer/     ... programming documentation

`2.12'	o Blanker information window uses the HilightTextPen for
	  drawing the labels.
	o Checks to see if a "Monitor" task is required, if a process
	  scheduler is running then this task will not be created.
	  Currently uses "sysinfo.library" to check.

`2.11'	o Improved locale support in interface layout
	o General beta distribution version

`2.9'	o Upgraded to V25 matrix.library

`2.8'	o Sound has not been working since version 2.0 was written.
	  Now Fixed

`2.7'	o Several complaints about the offensiveness of some Headlines
	  phrases and Quotes files. I have edited the data files and
	  modified the install script to query and warn about the
	  installation of the data files.	  
	o Added Deutsch locale and some data files for Quotes blanker.

`2.6'	o Aminet release.

`2.5'	o Changed name to SwazBlanker since someone else has written a
	  modular screen blanker called Blankers Server. This should avoid
	  any confusion between the two programs.
	o Fixed spelling mistakes in SwazBlanker Guide.
	o Setting DOCPATH/K and HELPFILE/K now works.
	o Now writes a ANNO chunk to the prefs file. This just consists of
	  the version string.
	o Unblanking improved, will keep requesting that the blanker module
	  abort until it aborts. Also when a blanker is to abort its task
	  priority is raised to the same level of the server.
	o Key blanking enabled, only works with amiga screen modes.
	o The 'Test' button working in blanker module interfaces, need to
	  work on the sensitivity of it somewhat.
	o Can delete modules by pressing DEL
	o Finally tracked down bug in Quotes text layout engine.

`2.4'	o Localization now consists of a separate catalog for each blanker.
	o Will need to rename BlankerServer as the name now conflicts with
	  another blanker system.

`2.3'	o General beta distribution version

`2.2'	o New rewrite of BlankerServer main program and all blanker
	  modules. Now have a blankerserver.library as well.

`2.1'	o General beta distribution version

`2.0'	o Initial rewrite from original BlankerServer.

@ENDNODE


@NODE Index "Index..."

	SWAZBLANKER : Documentation Index
	=================================

	(C) 1992-96 David Swasbrook,
	     All Rights Reserved.

  @{" Activity                " LINK DefinitionOfActivity	} Definition of activity
  @{" App Window              " LINK AppWin		} Dropping icons into the preferences window
  @{" Arexx                   " LINK Arexx		} Control SwazBlanker through arexx
  @{" Author                  " LINK Author		} Contacting the author
  @{" Caps Lock               " LINK CapsLock		} Caps Locking a blanker
  @{" CLI Arguments           " LINK CLIArgs		} Configuring SwazBlanker
  @{" Commodities             " LINK Comodity		} Standard commodities interface
  @{" Conditions              " LINK Conditions		} Shareware information
  @{" Configuration           " LINK Config		} Configuring SwazBlanker
  @{" Disclaimer              " LINK Disclaimer		} Legal information
  @{" Disk based blanker      " LINK DBB		} About the blanker modules
  @{" Email and WWW Addresses " LINK Author		} Contact addresses for Author
  @{" Inactivity              " LINK DefinitionOfInactivity	} Definition of inactivity
  @{" Installation            " LINK Installation		} How to install SwazBlanker
  @{" Introduction            " LINK Introduction		} Introduction to SwazBlanker
  @{" History                 " LINK History		} A very brief history of SwazBlanker
  @{" KeyBlanking             " LINK KeyBlanking		} Blanking the mouse after X many keypresses
  @{" Keyboard Shortcuts      " LINK SpecialKeys		} Use keys to do certain operations
  @{" Locale                  " LINK Locale		} Interface available in different languages
  @{"   SwazBlankerCatalog.cd " LINK "dev/catalogs/SwazBlanker.cd/MAIN" } Locale catalog description file
  @{" Matrix Library          " LINK MxLib		} Yet another library
  @{" Modules Listview        " LINK ListView		} Description of modules listview
  @{"   Mode : Configure      " LINK Mode_Config		} Configuring a blanker module
  @{"   Mode : Test           " LINK Mode_Test		} Testing a blanker
  @{"   Mode : Information    " LINK Mode_Info		} Informtion about a blanker
  @{"   Normal                " LINK Mod_Internal_Normal	} Just a normal blank screen
  @{"   Random                " LINK Mod_Internal_Random	} Picks a ticked module randomly
@REMARK SB-Index-Listview-Begin : Do not remove this line!
  @{"   Alerts                " LINK Alerts/MAIN       } Blank with a guru
  @{"   ALoad                 " LINK ALoad/MAIN        } Monitor CPU loading
  @{"   Crumble               " LINK Crumble/MAIN      } Crumble Blanker
  @{"   Dark                  " LINK Dark/MAIN         } Dark Blanker
  @{"   Dimmer                " LINK Dimmer/MAIN       } Dims the screen
  @{"   Energy                " LINK Energy/MAIN       } Energy cloulds
  @{"   Explosion             " LINK Explosion/MAIN    } Explosions on the screen
  @{"   Goats                 " LINK Goats/MAIN        } Goats and Herders Blanker
  @{"   Gravity               " LINK Gravity/MAIN      } Gravity
  @{"   Headlines             " LINK Headlines/MAIN    } Displays news headlines
  @{"   IFS                   " LINK IFS/MAIN          } IFS Blanker
  @{"   Interference          " LINK Interference/MAIN } Interference Blanker
  @{"   Labyrinth             " LINK Labyrinth/MAIN    } Find the way through a maze
  @{"   Lines                 " LINK Lines/MAIN        } Coloured lines
  @{"   Melt                  " LINK Melt/MAIN         } Melts the screen
  @{"   Mig                   " LINK Mig/MAIN          } Magnetic flux color cycling
  @{"   Pattern               " LINK Pattern/MAIN      } Colorful pattern cycling
  @{"   Plazma                " LINK Plazma/MAIN       } Plazma color cycling
  @{"   Pop                   " LINK Pop/MAIN          } Pop explosions
  @{"   Pyro                  " LINK Pyro/MAIN         } Fireworks explosions
  @{"   Quotes                " LINK Quotes/MAIN       } Displays Quotes
  @{"   Rainfall              " LINK Rainfall/MAIN     } Raindrops
  @{"   Rotor                 " LINK Rotor/MAIN        } Rotor Blanker
  @{"   Shuffle               " LINK Shuffle/MAIN      } Shuffle Screen
  @{"   Spliner               " LINK Spliner/MAIN      } Spliner
  @{"   Stars                 " LINK Stars/MAIN        } 3D Rotating Starfield
  @{"   Swarmer               " LINK Swarmer/MAIN      } Bees chasing Wasps
  @{"   Toasters              " LINK Toasters/MAIN     } Flying toasters
  @{"   Worms                 " LINK Worms/MAIN        } Worms eating away the screen
@REMARK SB-Index-Listview-End : Do not remove this line!
  @{" Overblanking            " LINK Overblanking		} Overblank when CPU in use
  @{" Preferences Window      " LINK Config		} How to configure
  @{" Reblanking              " LINK Reblank		} What happens if blanker screen not visible
  @{" Requirements            " LINK Requirements		} Whats needed
  @{" Shareware               " LINK Conditions		} Shareware information
  @{" Sound Effects           " LINK Sound		} Sounds while blanking
  @{" Special Keys            " LINK SpecialKeys		} Use keys to do additional operations
  @{" Special Thanks          " LINK Thanx		} Thanks
  @{" SwazBlanker Library     " LINK SBLib		} Swaz Blanker Library
  @{" SwazConfig Library      " LINK SCLib                  } Swaz Configuration Library
  @{" tabs.gadget             " LINK TabsGadget		} Tabs Gadget Class
  @{" Task Management         " LINK TaskManage		} Monitoring of CPU usage of a blanker
  @{" textfield.gadget        " LINK TextFieldGadget	} Text Field Gadget Class
  @{" ToolTypes               " LINK CLIArgs		} Configuring SwazBlanker
  @{" Updates                 " LINK Updates		} Support and Updates
  @{" Usage                   " LINK Usage		} How to use SwazBlanker

@ENDNODE

