home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / misc / twilight.lha / TZ / TZ.doc < prev    next >
Text File  |  1992-08-22  |  7KB  |  210 lines
  1.  
  2.  
  3.                     * * *  T W I L I G H T   Z O N E  * * *
  4.  
  5.                          version 1.0, August 21th, 1992
  6.  
  7.                                  User Manual
  8.  
  9.         ***************************************************************
  10.  
  11.                                   Contents
  12.  
  13.                    1. Introduction
  14.                    2. Getting started
  15.                    3. Creating own blanker modules
  16.  
  17.         ***************************************************************
  18.  
  19.  
  20.         1. Introduction
  21.  
  22.  
  23.         What is "Twilight Zone" ?
  24.  
  25.         "Twilight Zone" is a modular screen blanker with a user-friendly
  26.         control panel. In contrast to most ordinary screen blankers
  27.         "Twilight Zone" provides the following features:
  28.  
  29.         * selection of a blanker module out of a list of modules
  30.  
  31.         * "blank now" feature by moving the mouse pointer into a corner
  32.           of the screen
  33.  
  34.         * "blank never" option by moving the mouse pointer into a corner
  35.           of the screen
  36.         
  37.         * time out freely adjustable (quantity, minutes or seconds)
  38.  
  39.         * "wake up event" freely adjustable (mouse, keyboard, disk drive)
  40.  
  41.         With some knowledge in programming it is not difficult to create
  42.         new blanker modules, which can be integrated into "Twilight Zone"
  43.         and displayed in its control panel.
  44.  
  45.  
  46.         Requirements
  47.  
  48.         "TwilightZone" was developed and tested with AmigaOS 1.3. Thus
  49.         it is no commodity. It was also tested with AmigaOS 2.04.
  50.  
  51.  
  52.         ***************************************************************
  53.  
  54.  
  55.         2. Getting started
  56.  
  57.  
  58.         Installation
  59.  
  60.         To install "TwilightZone" double-click the "Install" icon.
  61.         This short shell script will copy the libraries required by
  62.         "TwilightZone" into the LIBS: directory. The program needs
  63.  
  64.         - arp.library (v39.1) and
  65.         - intuisup.library (v4.4 or higher).
  66.         
  67.         Furthermore, you must have a directory from where "Twilight Zone"
  68.         get its blanker modules. If this directory is not the same as
  69.         the one where the program is placed, you must assign the logical
  70.         device "TZ:" to it.
  71.         When "Twilight Zone" starts, first it looks in the current
  72.         directory for blanker modules. If it cannot find any matching file
  73.         (with the extension ".tz"), it tries to get files from "TZ:".
  74.  
  75.  
  76.         Starting "Twilight Zone"
  77.  
  78.         You can start "Twilight Zone" by double-clicking its icon on
  79.         workbench or by creating a background task in the shell with the
  80.         RUN or RUNBACK command.
  81.  
  82.         At each start the program looks for the configuration file named
  83.         "TZConfig" which must be placed in the "S:" directory.
  84.         If there exists no configuration file or the file contains bad
  85.         data, "Twilight Zone" opens its control panel showing the
  86.         standard configuration.
  87.         The control panel consists of following elements:
  88.  
  89.         * "Blanker modules" list *
  90.  
  91.         This list contains all blanker modules which could be found at the
  92.         start of the program. All blankers have the extension ".tz" except
  93.         the built-in module "SimpleBlank", which is the default blanker.
  94.         Whenever no blanker module is available or the blanker specified
  95.         in the configuration file cannot be found, "SimpleBlank" will be
  96.         selected automatically.
  97.  
  98.         * "Sleep delay" adjusting *
  99.  
  100.         The time out period can be adjusted by a counter gadget and a
  101.         cycle gadget, which toggles between seconds and minutes.
  102.  
  103.         * "Blank now" corner *
  104.  
  105.         This mutual exclusive gadget allows you to specify a corner of
  106.         the screen. If the mouse pointer is moved into this corner,
  107.         "Twilight Zone" will blank the screen immediately.
  108.  
  109.         * "Blank never" corner *
  110.  
  111.         This mutual exclusive gadget allows you to specify a corner of
  112.         the screen. If the mouse pointer is moved into this corner,
  113.         "Twilight Zone" will never blank the screen, unless you move the
  114.         pointer away from this corner.
  115.  
  116.         * "When to wake" flags *
  117.  
  118.         When a blanker module is activated, "Twilight Zone" waits for a
  119.         event from the user. This event may be a key stroke, a mouse
  120.         movement or insertion or ejection of a disk.
  121.         There are existing three check boxes for these events, which may
  122.         be combined individually.
  123.  
  124.         * Button "About..." *
  125.  
  126.         Click this button to get short information about "Twilight Zone".
  127.  
  128.         * Button "Show" *
  129.  
  130.         If you click this button, "Twilight Zone" will activate the
  131.         currently selected blanker module.
  132.         (This is a feature I am missing in most blankers ! The action part
  133.         is the one and only interesting feature of a screen blanker. Thus
  134.         I find it stupid to force the user to activate the blanker and then
  135.         to wait a few seconds before he can watch the action part !)
  136.  
  137.         * Button "Use" *
  138.  
  139.         If you click this button, "TwilightZone" will save the current
  140.         settings to its configuration file and then install the last
  141.         selected blanker module.
  142.         You can then return to the control panel by pressing the hot key
  143.         kombination RIGHT ALT + RIGHT SHIFT + ESC.
  144.  
  145.         * Button "Quit" *
  146.  
  147.         Click this button to quit from "Twilight Zone".
  148.  
  149.  
  150.  
  151.         ***************************************************************
  152.  
  153.  
  154.         3. Creating own blanker modules
  155.  
  156.  
  157.         Each blanker module has the following structure:
  158.  
  159.         ********** blanker header **********
  160.  
  161.         0x00  dc.l "TWILIGHTZONE" (12 bytes)
  162.         0x0C  dc.l LocationID     (4 bytes)
  163.  
  164.         ********** blanker module **********
  165.  
  166.       ->0x10  bra  StartBlanker   (4 bytes)
  167.       ->0x14  bra  StopBlanker    (4 bytes)
  168.         0x18  ...
  169.  
  170.         The "LocationID" the following meaning:
  171.  
  172.         1. Most significant bit (MSB, Bit 31) not set:
  173.  
  174.         load blanker to the specified absolute address (if you want
  175.         to use a lamer-intro as a blanker module :-( ).
  176.  
  177.         2. Most significant bit (MSB, Bit 31) set:
  178.  
  179.         2.1 Last significant bit (LSB, Bit 0) not set:
  180.  
  181.         Load blanker to an arbitrary address (normal case :-) ).
  182.  
  183.         2.2 Last significant bit (LSB, Bit 0) set:
  184.  
  185.         Load blanker to an arbitrary address in chip memory (if your
  186.         blanker module uses graphical data).
  187.  
  188.         The pure blanker code itself is all the (relocatable assembly)
  189.         code starting from 0x18 until the end of file.
  190.         The code starting at "StartBlanker" has the task to blank the
  191.         screen or to install an interrupt service routine or to do
  192.         something else. The initialization code must be terminated by a
  193.         RTS command.
  194.         The code starting at "StopBlanker" resets the screen display
  195.         and must also end with a RTS command.
  196.  
  197.  
  198.         ***************************************************************
  199.  
  200.  
  201.         If you find any bugs or you have any ideas how to improve this
  202.         this product, then contact me:
  203.  
  204.               ///   Rainer Koppler
  205.              ///    Stelzhamerstra▀e 9
  206.         \\\ ///     A-4623 Gunskirchen
  207.          \\X//      Austria/Europe
  208.  
  209.         internet: rainer@soft.uni-linz.ac.at
  210.