home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / fullpack.zip / OSTSR11.ZIP / OSTSR.DOC < prev    next >
Text File  |  1994-05-11  |  10KB  |  223 lines

  1.  
  2.  
  3.  
  4.                 OSTSR version 1.1 Copyright 1994 by Jay Clegg
  5.  
  6.    OSTSR requires OS/2 version 2.1 to run properly. Please read the legal
  7.    disclaimer at the end of this document before using this program. DO NOT
  8.    run OSTSR unless you are running OS/2 2.1, as running it from straight
  9.    DOS will cause the machine to lock up.  It has not been tested with 2.0,
  10.    and I do not know at this time whether it would work with that version.
  11.  
  12.    OSTSR is an acronym for OS/2 Time Slice Releaser.  It was designed to
  13.    allow programs that are Desqview-aware run smoothly and consume less of
  14.    the system's time when running under OS/2.
  15.  
  16.    If you are currently using OS2SPEED -or- OS2SPEED combined with TAME21,
  17.    this program offers a speed/size enhancement over the capabilities of
  18.    these two programs.
  19.  
  20.    OSTSR is, quite simply, a DOS TSR that, when it is run in an OS/2 2.x DOS
  21.    session, will convert Desqview time-slices to OS/2 timeslices
  22.    (technically, DV-PAUSEs are intercepted and converted to DOSSLEEP calls).
  23.  
  24.    Desqview-aware programs will typically consume FAR less CPU time when
  25.    this program is running. Instead of having a high (up to 100%) CPU
  26.    utilization all the time, OSTSR will cut CPU utilization for most
  27.    DV-aware programs to below 50%, and as low as 0% in some situations. The
  28.    exact amount depends on OSTSR's settings, the speed of the machine, and
  29.    how much work the DV-aware program is doing at any particular time.
  30.  
  31.    OSTSR works by fooling DV-aware programs into thinking that they are
  32.    running under Desqview.  When such a program makes a request to return
  33.    the rest of its timeslice to Desqview, the call is intercepted by OSTSR
  34.    and is turned into a similar request to OS/2.
  35.  
  36.    OSTSR has been tested and is known to work very well with the latest
  37.    versions of the following programs:
  38.  
  39.         Wildcat!    TXZM
  40.         COMMO       DSZ
  41.         Qedit       SHEZ
  42.     List
  43.     SLMR/OLX
  44.  
  45.    ...and should work with any DV-aware program.  It will be ignored and
  46.    have no effect on non-DV-aware programs.  OSTSR will work in full-screen,
  47.    windowed, and minimized sessions.  OSTSR 1.1 takes only 336 bytes from a
  48.    DOS session, and may be loaded into high memory.
  49.  
  50.    OSTSR allows the user to specify the amount of time to give back to OS/2
  51.    when a DV-aware program relenquishes it's time slice.  The command line
  52.    option allows settings from 0 to 65535 milliseconds. The actual amount of
  53.    time taken from the application may vary, and is ultimately determined by
  54.    OS/2's scheduler.  While this limits the actual amount of tweeking a
  55.    person can do using this program, it generally insures that things run
  56.    smoothly no matter what option you select.  Experimentation is the key to
  57.    determining what setting is best for your system.  On tests that I and
  58.    others have conducted, a setting of 2 or 3 seems to work best for almost
  59.    any DV-aware program, although you may find a lower or higher setting
  60.    works better for you. Note that a setting of 0 milliseconds does little
  61.    for overall system performance, but should (I haven't been able to
  62.    confirm this) give up the rest of a timeslice *if* another thread is
  63.    running which has a higher priority.
  64.  
  65.    For starters, try a setting of 3, then go up or down to find what works
  66.    best for you.  If you are running Wildcat! or other DV-aware
  67.    communications programs, try a setting of 2 first, if that causes
  68.    problems, try a setting of 1.
  69.  
  70.    OSTSR has a "monitor" mode that displays two indicators when a DV-aware
  71.    program is running.  They are very usefull for determining which programs
  72.    are DV-aware, and for gaugeing the impact of OSTSR. When in "monitor"
  73.    mode, the indicators are displayed in the upper left-hand corner of the
  74.    screen or window that it is running in.  The first one is a smiley face,
  75.    which appears when OS/2 has taken from the application via OSTSR.  (i.e.
  76.    when the program gives up it's time slice OSTSR displays the smiley, and
  77.    when OS/2 returns to the program, the smiley is erased.)  The character
  78.    to the right of the is a "twirly-bar" which moves one "notch" every time
  79.    OSTSR returns part of a timeslice to OS/2.
  80.  
  81.    Generally, the more the smiley is displayed, the better for total system
  82.    performance.
  83.  
  84.    It should be noted that these indicators will only be displayed if you
  85.    are running a DV-aware program.
  86.  
  87.    Once you have "tweeked" your system, disable the monitor mode.  The
  88.    monitor mode does impact on performance itself (particularly for dos apps
  89.    that a run in a window), and should only be used for testing purposes.
  90.  
  91.  
  92.                                 -------
  93.  
  94.    QuickStart:
  95.  
  96.         Open a Dos session, either windowed or full-screen (full-screen
  97.         is recomended for testing in monitor mode). Run OSTSR with these
  98.         options:
  99.  
  100.         OSTSR 2 /m
  101.  
  102.         This loads OSTSR resident in your DOS session with a 2
  103.         millisecond release setting, with monitor mode ON.
  104.  
  105.         Now run your Desqview-aware application(s) from this session. If
  106.         they are indeed Desqview-aware, you should see the smiley and
  107.         twirly-bar in the upper left-hand corner of the screen or window,
  108.         indicating that OSTSR is doing it's job.
  109.  
  110.         (NOTE, if IDLE_SENSITIVITY in the settings folder for your DOS
  111.         session is set to 100%, OSTSR will may not have a positive impact on
  112.         performance. If it is set to 100%, change it to 99% or lower)
  113.  
  114.         Try running your DV-aware applications in a window, both with and
  115.         without OSTSR loaded, while watching PULSE or another CPU
  116.         utilization monitor.  This will gauge the impact that OSTSR has on
  117.         increasing overall system performance.
  118.  
  119.                                 -------
  120.  
  121.    Usage:
  122.            OSTSR # [/M] [/D]
  123.  
  124.     where # is a number between 0 and 65535.  if # is not specified, a
  125.     value of 1 is assumed.  /M and /D are optional.
  126.  
  127.       /M enables monitor mode.
  128.  
  129.       /D temporarily disables Desqview emulation. This usually has the
  130.          effect that OSTSR will not seem to be present.  This switch was
  131.          added to allow users to temporarily turn OSTSR 'off'.  OSTSR
  132.          can be turned back 'on' by re-running it without the /D switch.
  133.          Note that if the program requests a time-slice release, it will
  134.          still be sent to OS/2, this simply disables the function that
  135.          'fools' other programs into thinking they are running under
  136.          DesqView. (New switch for version 1.1!)
  137.  
  138.  
  139.    Examples:
  140.  
  141.     OSTSR                (running OSTSR with no parameters
  142.                                     specifies a default 1 ms DOSSLEEP,
  143.                                     with no indicators.)
  144.  
  145.     OSTSR 3             ( 3 millisecond DOSSLEEP, no
  146.                      indicators)
  147.  
  148.     OSTSR 2 /m            ( 2 millisecond DOSSLEEP, with
  149.                      "monitor" indicators turned on)
  150.  
  151.    Running OSTSR when it is already installed in memory will change the
  152.    values of the already running copy.  This allows you to change its
  153.    settings "on-the-fly".  If you do not specify otherwise, it will
  154.    default to: Monitor Mode OFF, 1 ms release, DV-faking ON.
  155.  
  156.    You may wish to put OSTSR somewhere in your path so that you can use it
  157.    from any directory.   However, most users will find it easiest to load
  158.    OSTSR via their AUTOEXEC.BAT, so that it will be automatically loaded for
  159.    each DOS session on startup.
  160.  
  161.                   -------
  162.  
  163.    OSTSR is copyrighted free-ware, which means you can use it as you see
  164.    fit (free of charge) as long as you do not modify the program in any
  165.    way.  Please do not distribute it without this documentation file.
  166.  
  167.    I have tested OSTSR to the best of my ability. However, if you find
  168.    any bugs, or programs that cause incompatibilities, I'd appreciate
  169.    hearing about them. I can be contacted at the address below, and also
  170.    through the Wildnet! Programming conference, the FIDO OS/2 DOS support
  171.    conference or via the Madmen & Maniacs BBS (706-860-5781).
  172.  
  173.             Jay Clegg
  174.             P.O. 204201
  175.             Martinez, GA 30907
  176.  
  177.  
  178.                   -------
  179.  
  180.    Warranty: There is no warranty, period.
  181.    Full Legalese follows:
  182.  
  183.                                 DISCLAIMER
  184.  
  185.    Jay Clegg makes no warranty, either express or implied, including but not
  186.    limited to implied warranties of merchantability and fitness for a parti-
  187.    cular purpose with respect to this software.
  188.  
  189.    IN NO EVENT SHALL JAY CLEGG OR ANY OF HIS ASSOCIATES BE LIABLE FOR ANY
  190.    DAMAGES, INCLUDING DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS
  191.    INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR OTHER PECUNIARY LOSS
  192.    ARISING OUT OF THE USE OF OR INABILITY TO USE THIS PROGRAM, EVEN IF
  193.    JAY CLEGG HAS BEEN ADVISED OF THE POSSIBILITY OF DAMAGES.
  194.  
  195.    Program history: OSTSR
  196.  
  197.     0.1  This version was written in C and was much larger
  198.          than the final product.  Just a test program to see if it
  199.          would work.
  200.  
  201.     0.8  ASM version with time slice indicator.  Seperated resident
  202.          code from startup code to squeeze resident size to a
  203.          minimum.  Allowed for specifying DOSSLEEP parameter.
  204.  
  205.     0.9  Beta test.  Added TS indicator switch, and allowed for
  206.          changing parameters of resident program by reruning the program.
  207.          Fixed a few esoteric buglets.
  208.  
  209.     1.0  First public release.
  210.  
  211.         1.1  'Maintenance release'.  Added support for converting MS-Windows
  212.              time slice releases to OS/2 releases. Some programs (SHEZ)
  213.              were calling this instead of the DV call.  Added switch to
  214.              temporarily disable DesqView emulation (/d), when used,
  215.              program will not emulate DV until OSTSR is re-run without
  216.              the switch.  Some programs (Usurper - game door?) were
  217.              trying to use additional DV functions which OSTSR simply
  218.              cannot provide, hence, this allows users to temporarily
  219.              disable OSTSR and re-enable it when a certain program has
  220.              completed.  Refined code so that resident size is still 336
  221.              bytes, despite additions.
  222.  
  223.