home *** CD-ROM | disk | FTP | other *** search
/ rtsi.com / 2014.01.www.rtsi.com.tar / www.rtsi.com / OS9 / MM1 / GRAPHICS / kwsaver25.lzh / kwsaver.readme < prev    next >
Text File  |  1995-03-17  |  8KB  |  164 lines
  1.  
  2. * Marked for release 03/15/95 by JMH via Sub-Etha Software/Midwest Division *
  3.  
  4. KWSaver Version 2.5 for K-Windows
  5. (c) 1994, 1995 by Joel Mathew Hegberg
  6. =====================================
  7.  
  8.     KWSaver is a screen-saver management program for K-Windows.  Because it is 
  9. merely the manager program, you may choose which screen-savers you want on 
  10. your system, and even write your own.  KWSaver looks in the file 
  11. /dd/SYS/kwsaver.list to find a list of the screen-saver programs available on 
  12. the system, and randomly selects a saver from the list.  (NOTE: See 'The 
  13. kwsaver.list File' section below.)
  14.  
  15.     KWSaver monitors your mouse & keyboard activity.  If you do not use your 
  16. mouse or keyboard for a certain amount of time (default setting is 10 
  17. minutes), KWSaver calls one of your screen-saver programs.  To exit a 
  18. screen-saver, simply move the mouse or press a key.
  19.  
  20.     KWSaver is meant to be run in the background from your startup script 
  21. file.  To run KWSaver using its default time delay of 10 minutes, you can use:
  22. kwsaver -n&
  23. (Note that the '&' character runs KWSaver in the background.)
  24. To run KWSaver using a time delay of 30 minutes, you can use:
  25. kwsaver -n 30&
  26.  
  27.     The maximum time delay allowed is 60 minutes.
  28.  
  29.  
  30. KWSaver V2.5 Options:
  31. =====================
  32.  
  33.     Due to the way K-Windows currently works, a window must be allocated for 
  34. KWSaver to monitor mouse activity.  The window must provide unblocked access 
  35. for getstat calls (to read the mouse data).  By default, KWSaver will create a 
  36. tiny little window (with a graphic icon) atop the current window.  This will 
  37. provide an unimpeded path for mouse information to be received through.  If 
  38. you would prefer to have the icon not appear atop the current window, you may 
  39. use the '-n' option, and it will be created on a new screen.  The '-n' option 
  40. is the best way to use KWSaver, since it will create the window and then 
  41. remove it from the window display stack, which means you'll never have to see 
  42. the spare window when flipping through your windows.
  43.  
  44.     If you are not going to be using the screen, you may not want to create 
  45. another window.  By using the '-c' option, you use the 'current' window as 
  46. the mouse-polling window.  This window should never become read-blocked.  You 
  47. may not want to run KWSaver in the background front this window, but rather 
  48. run it in the foreground to ensure the window never becomes read-blocked.
  49.  
  50.     If you are using KWSaver with the MM_ONE startup graphic program, you may 
  51. use the '-s=<val>' option, which will place a the graphic icon in the current 
  52. window.  The icon's location on-screen is based on the <val> used.  (Note 
  53. that this <val> just like the <val> used in the 'install_spooler' program, 
  54. also used for the MM_ONE startup program.)  You may want to use the '-s' 
  55. option in combination with the '-n' option when running in the background from 
  56. the startup file after MM_ONE is run.
  57.  
  58.  
  59. The 'kwsaver.list' File:
  60. ========================
  61.  
  62.     This file must be stored in your /dd/SYS directory.  It may be renamed 
  63. '.kwsaver.list' if you want it to be invisible to avoid cluttering up your 
  64. SYS directory -- KWSaver is smart enough to find it.
  65.  
  66.     The file is merely a listing of all the screen-saver programs (one per 
  67. line) you have on your system.  Whenever you add another saver to your system, 
  68. make sure to place its name here (or else it will never get run).  
  69. Comment-lines start with the '#' character.  This also makes it convenient to 
  70. deselect one of your screen-savers in the list by simply placing a '#' before 
  71. it's name, so you don't have to erase it from the file.
  72.  
  73.     The utility program 'KWSE' can be used to easily edit this file.
  74.  
  75.  
  76. About the KWSaver V2.5 Archive:
  77. ===============================
  78.  
  79.     There are a lot of files in this archive.  If you are only interested in 
  80. running KWSaver on your system, you only need to do the following:
  81.  
  82. 1) Move the 'kwsaver' program to your CMDS directory.
  83. 2) Move the 'kwsaver_lines', 'kwsaver_lines2', 'kwsaver_mm1s', 'kwsaver_mm1b', 
  84. 'kwsaver_rain', 'kwsaver_box', 'kwsaver_puzzle16', and 'kwsaver_puzzle64' 
  85. files to your CMDS directory.
  86. 3) Move the 'kwsaver.list' file to your SYS directory.
  87. 4) Edit your 'startup' file to run KWSaver when you power-up your system.
  88.    (Probably by adding the line 'kwsaver -n&')
  89.  
  90.     The rest of the files are provided for people who may be interested in 
  91. writing their own screen savers for KWSaver.  Here's what they are for:
  92.  
  93. kwsaver.programmers.notes - Notes (rules) on how to write screen-savers.
  94. kwsaver_lines.c           - A sample type-1 screen-saver program.
  95. kwsaver_mm1s.c            - A sample type-2 screen-saver program.
  96. kwsaver_mm1s.h            - A header file needed to compile kwsaver_mm1s.c.
  97. kwsaver_rain.c            - A sample type-3 screen-saver program.
  98.  
  99.  
  100. Technical Notes:
  101. ================
  102.  
  103.     When the screen-saver is run, the window it runs in is placed atop the 
  104. current screen.  However, it's window is not the currently 'selected' 
  105. window... this is why you return to the screen you were working on when the 
  106. screen-saver deactivates.  However, what would happen if you used the F9/F10 
  107. keys (which are undetectable to KWSaver) to switch screens while the 
  108. screen-saver is running?  This generally is not a problem... when the 
  109. screen-saver is deactivated, then its window disappears (where ever it may 
  110. be) -- big deal.  BUT, if you happen to have selected (switched to) the 
  111. actual screen-saver screen itself and deactivate the screen-saver, an evil 
  112. K-Windows bug would normally occur!  The problem is, it's the selected window, 
  113. and now it's dying.  Because of this, K-Windows dies, and with it, essentially 
  114. your entire system requiring you to reboot.  To prevent this from happening 
  115. to nice people like yourself, KWSaver will check to see if you've selected the 
  116. saver's screen (using pt_valid info from mouse data) before killing the 
  117. window.  If the window has been selected, a message is displayed requesting 
  118. the user switch to another screen.  KWSaver then waits for the user to change 
  119. screens, and then waits another full second.  After this, KWSaver checks all 
  120. over again, and once it's safe, the saver's window is killed.
  121.  
  122.     When KWSaver activates, it actually opens a very small window in the 
  123. upper-left corner of the current screen (by using window type 'FF') and then 
  124. polls the screen for information such as screen size.  The small window is 
  125. then closed and a new window, the exact size of the current screen, is opened 
  126. atop the current screen (again, but using window type 'FF').  This window has 
  127. certain guaranteed properties, listed below.  This is the window the 
  128. screen-saver program is run in, and is defined to be the screen-saver's 
  129. standard in, out, and error paths.  The screen-saver is guaranteed to run for 
  130. at least 2 seconds (for initialization, if needed) before KWSaver will 
  131. interrupt it due to user interaction.  When the user begins interacting with 
  132. the computer, KWSaver will send a signal (of value 4444 decimal) to the 
  133. screen-saver program.  KWSaver waits for the screen-saver program to die, and 
  134. then deallocates the saver window.
  135.  
  136.     The saver window is guaranteed to have these properties before the 
  137. screen-saver program is run:
  138. 1) Graphics scaling is ON.  [ScaleSw(PATH,1);]
  139. 2) Foreground color is MAX. (15 for 16-color screens, 255 for 256-color)
  140. 3) Background color is 0.
  141. 4) Cursor is OFF. **
  142. 5) Scaling is based off of 640x208 screen coordinates.
  143. 6) Logic is OFF.            [LSet(PATH,0);]
  144. 7) No pattern is selected.  [PSet(PATH,0,0);]
  145. 8) ^C and ^E from keyboard are disabled.
  146.  
  147. ** Even though the cursor is turned off in the saver's window, a cursor may 
  148. be visible.  This is the cursor of the window beneath the screen-saver's 
  149. window, which is the selected window.  Just ignore it.
  150.  
  151. PLEASE BE SURE TO READ THE ADDITIONAL NOTES IN THE FILE 'VER25.NOTES'!
  152.  
  153. KWSaver has been written and tested very carefully.  However, use of this 
  154. program (and its related files) are at your own risk.  The author is not 
  155. liable in any way.
  156.  
  157. KWSaver may not be sold.
  158.  
  159. KWSaver is copyright 1994, 1995 by Joel Mathew Hegberg.
  160.  
  161.  
  162. This program and its archive are freely distributable.
  163.  
  164.