home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / screen / strblnk.lha / StarBlanker.doc < prev    next >
Text File  |  1990-02-21  |  7KB  |  175 lines
  1.  
  2.   (*==================================================================*)
  3.     StarBlanker version 1.00              © 1989, 1990 Chris Bailey
  4.     Yet Another ScreenBlanker             All Rights Reserved
  5.   (*==================================================================*)
  6.  
  7.    If you intend to distribute this software further, you must agree
  8.    to the distribution guidelines provided at the end of this
  9.    documentation.  Thanks.
  10.  
  11.  
  12. Overview
  13. --------
  14.   StarBlanker is a screen blanker, pure and simple.  It helps you avoid
  15.   monitor burn-in if you should leave your computer sitting
  16.   with the same display showing for a specified length of time.  It
  17.   operates in the same manner as most screen blankers operate - if no
  18.   keyboard or mouse activity is detected for a specific amount of
  19.   time, the display will do something interesting until you either
  20.   press a key or move the mouse.  
  21.  
  22. When the screen blanks
  23. ----------------------
  24.   When the timeout expires, instead of just making the screen black like
  25.   some other screen blankers do, StarBlanker replaces your current display
  26.   with one of two different scrolling starfields.  The starfield
  27.   will continue to scroll until you either touch a key on the keyboard
  28.   or move the mouse.
  29.  
  30.   To make things interesting, StarBlanker chooses which starfield to
  31.   blank the screen with at random.
  32.   
  33. Setting the timeout
  34. -------------------
  35.  
  36.   StarBlanker needs one number from you before it can start.  It needs
  37.   to know how many seconds of no activity should cause the starfield
  38.   display to pop up.  If you don't specify a number (as outlined below),
  39.   StarBlanker will use an internal default of 4 minutes.  Startup from
  40.   either CLI or Workbench is defined below.
  41.  
  42.   Note : all timeout values are in seconds.
  43.   
  44.   FROM CLI
  45.   --------
  46.     Enter "Starblanker" and the number of seconds you wish the screen
  47.     to blank after.  For example:
  48.     
  49.     ( pretend you're staring at a CLI window )
  50.  
  51.     1> StarBlanker 300
  52.     
  53.     After 5 minutes of no activity, the screen will blank.
  54.     
  55.     Starblanker detaches itself from the CLI, so there is no need for 
  56.     RunBack or anything else.  
  57.     
  58.   FROM WORKBENCH
  59.   --------------
  60.     There is one TOOLTYPE you can set with the Workbench "Info" command.
  61.     That tooltype is "TIMEOUT".  For example:
  62.     
  63.     ( pretend you're in Workbench staring at the Info display )
  64.     
  65.     TOOL TYPES     TIMEOUT=300
  66.     
  67.     If this is entered and StarBlanker is launched from its icon, the
  68.     screen will blank after 5 minutes of no activity.
  69.   
  70.   Further Note : Your timeout can not be less than 10 seconds.  If it
  71.   is, StarBlanker will use the default timeout, which is 4 minutes.
  72.   The 4 minute timeout also is used if you invoke the program from
  73.   CLI or Workbench with no command line arguments or Workbench tool
  74.   types.
  75.   
  76. Killing StarBlanker
  77. -------------------  
  78.   The easiest way to de-install StarBlanker is to re-activate
  79.   the program, either from Workbench or from the CLI.  StarBlanker
  80.   will announce that it is removing itself, and free up all memory
  81.   that it was using.
  82.  
  83.   The following hotkey combination will also remove StarBlanker:
  84.     
  85.      RIGHT SHIFT + RIGHT ALT + "x"
  86.  
  87. Using StarBlanker with DMouse
  88. -----------------------------
  89.   As of this writing, the easiest way to use StarBlanker with DMouse is
  90.   to simply turn DMouse's screen blanker option off before starting 
  91.   StarBlanker.
  92.   
  93.   I have had a request to use Matt Dillon's IPC, so that StarBlanker will
  94.   cooperate with DMouse.  Therefore, some time in the future I will be
  95.   releasing DStars.  This will be a blanking function that operates
  96.   identical to StarBlanker, except it won't have an input handler, and
  97.   will blank the screen when DMouse signals it to.
  98.  
  99. Of Memory And Multitasking
  100. --------------------------
  101.   When StarBlanker is dormant, it doesn't take up very much memory,  but
  102.   when it opens its display, it can take more than a small amount of
  103.   memory.  The starfield display is 2 bitplanes deep, and there are
  104.   also a couple of offscreen bitmaps to make the animation smooth and
  105.   fast.  If there is not enough memory for StarBlanker to open the 
  106.   displays needed, it simply won't blank the screen.
  107.   
  108.   At the request of Martin Taillefer, the starfield display updates with
  109.   IntuiTicks messages.  This means that while the screen is blanked, 
  110.   processor time won't be noticeably degraded.  This also means that
  111.   the starfield isn't going as fast as it could.  In the future, I may
  112.   release a version that gives you the option to use IntuiTicks, or to
  113.   just run in a tight loop.  
  114.  
  115. Distribution
  116. ------------
  117.   
  118.   - This product may not be sold for a profit.
  119.   
  120.   - The contents of this archive may be posted to BIX and to PeopleLink.
  121.   I don't have a PLink account, so if somebody could post it there,
  122.   I would be greatful.  Upgrades (if any) will appear first on BIX.
  123.   
  124.   - The contents of this archive may NOT be posted to any commercial
  125.   network, other than BIX and PLink.
  126.  
  127.   - The contents of this archive may be distributed on any public domain
  128.   disk whose price does not exceed that of the cost of ordering a
  129.   disk from the Fred Fish library of freely distributable software.  This
  130.   is limited by the paragraph below.
  131.   
  132.   - None of the contents of this archive may be used in any manner by
  133.   Amiga Exchange (A.X.) magazine, their public domain disks, or any
  134.   other endeavor they happen to be currently involved in.  (For example,
  135.   Graf-X magazine, or special issues of A.X.)
  136.   
  137.   - This archive may be made available to FTP sites along the Usenet
  138.   lines.  I haven't had my Usenet account long, so I'm not quite sure
  139.   how to do this myself.
  140.   
  141.   - This archive may be posted to any public bulletin board system,
  142.   provided that the use of the system is made available to the
  143.   users without a mandatory fee.  In other words, this archive may
  144.   not be posted to pay BBS systems.
  145.   
  146.   - None of the source code to this program may be placed in print in
  147.   any magazine or other form of printed media without the author's
  148.   written, electronic, or verbal consent.  
  149.   
  150.   - Any of these conditions may be reconsidered by contacting the author
  151.   via written, electronic, or verbal means and asking for explicit
  152.   permission to use the material in such a manner.  
  153.   
  154.   ----------------------------------------
  155.   
  156.   I apologize for the above.  Apparently there have been some 
  157.   misunderstandings as to what "Freely Distributable" means in 
  158.   regards to some of my past work, and I am obliging those
  159.   misunderstandings with these guidelines. 
  160.  
  161.   If you wish to contact me, here's how.  Electronic means are
  162.   preferred.
  163.  
  164.  (*=======================================================================*)
  165.   Chris Bailey                    Phone : 803-794-4933
  166.   2405, Feather Run Trail
  167.   W. Columbia, SC  29169
  168.   
  169.   UUCP:{uunet!ncrlnk, gatech!hubcap}!ncrcae!secola!smoak!avcom!bailey!chris
  170.   BIX : csbailey
  171.   SDI : Starving Developers Incorporated
  172.  
  173.   "They've come to take our beer"
  174.  (*=======================================================================*)
  175.