home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_disks / 500-599 / ff597.lzh / ShadowMaster / docs / shadowmaster < prev    next >
Text File  |  1992-02-01  |  3KB  |  55 lines
  1. Format:        ShadowMaster [USE=file] [COMMAND=command] [SECONDS=seconds]
  2.  
  3. Template:    None
  4.  
  5. Purpose:    Monitors input stream activity, and triggers the
  6.         ShadowMaster module specified by the tooltype COMMAND
  7.         if SECONDS time passes with no activity.
  8.  
  9. Specification:    If USE is specified, it is loaded as a preferences file;
  10.         otherwise shadowmaster.prefs in the current directory is
  11.         used. If that file is not present, then the file
  12.         env:shadowmaster/shadowmaster.prefs is loaded. SECONDS and
  13.         COMMAND in the ToolTypes are argument list override
  14.         any values from those files. If none of these are present,
  15.         SECONDS will be set to 300; COMMAND will be set to "black".
  16.         The programn name specified in COMMAND is loaded and run as
  17.         needed, so long as there is not one currently running. When
  18.         there is input activity, the module is sent CTRL-C
  19.         signal indicating that it should exit. ShadowMaster will
  20.         note when it actually exits, and behave appropriately.
  21.         If run from the workbench, COMMAND, SECONDS and USE are
  22.         recognized as tooltypes. In addition, the standard
  23.         Commodity tooltypes are recognized and used.
  24.  
  25. Configuration:    Use the preferences editor screensaver like any other
  26.         preferences editor to edit ShadowMasters behavior.
  27.         See the documentation on screensaver for details on
  28.         these. Besides the usual preferences editor gadgets and
  29.         menus, screensaver has the following gadgets:
  30.  
  31.       Seconds:    Number gadget which says how long to wait with no activity
  32.         before blanking the screen.
  33.  
  34. Rexx Interface:    The following commands are supported as Rexx messages.
  35.         It is assumed that you're familiar with ARexx.
  36.  
  37.        version:    Returns the version string as a RESULT.
  38.         enable:    Enables the ShadowMaster object via commodities.
  39.        disable:    Disables the ShadowMaster object via commodities.
  40.          blank:    Runs the current saver module immediately.
  41.        unblank:    Tries to stop any currently running saver module.
  42.        seconds:    Changes the SECONDS setting to its argument. No action
  43.         is taken if there is no argument. In either case, the
  44.         setting BEFORE the change is returned via RESULT.
  45.        command:    Changes the COMMAND string to the rest of the command.
  46.         No change is made if that string is empty. In either
  47.         case, it command string BEFORE the change is returned
  48.         in RESULT.
  49.       quit:    Causes ShadowMaster to exit immediately.
  50.  
  51.         The Rexx script SMCONFIG demonstrates how the saver could
  52.         be configured from a Rexx script. It has been replaced by
  53.         screensaver (see above), and all parts may not work properly.
  54.         It requires RexxArpLib version 3.0 
  55.