home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / mems27.zip / memstat.doc next >
Text File  |  1993-06-29  |  13KB  |  390 lines
  1. MEMSTAT - OS/2 Presentation Manager Memory Status Utility, Version 2.07
  2. Copyright (C) 1991, 1992, 1993 The Software Cottage. All rights reserved. 
  3.  
  4. For further information, contact: 
  5.     Greg Jones, 
  6.     The Software Cottage Pty Ltd
  7.     484 Waverley Road
  8.     Mount Waverley, Vic, 3149 
  9.     AUSTRALIA. 
  10.  
  11.     Ph: 61-3-802-7883
  12.     Fidonet: 3:634/384.2 
  13.     CompuServe: 100033,3121
  14.  
  15.  
  16. What is MemStat?
  17. ----------------
  18.  
  19. MemStat Version 2.07 is a utility program which displays the current
  20. amount of available memory, the size of the swap file and the amount
  21. of free space on the swap drive under OS/2 2.x.
  22.  
  23. It has proven to be a useful tool, both in the test environment and
  24. in the production environment.
  25.  
  26.  
  27. Installation 
  28. ------------
  29.  
  30. To install MEMSTAT, place MEMSTAT.EXE in a directory in your path,
  31. MEMSTAT.HLP in a directory pointed to by your HELP environment
  32. variable, and use STARTUP.CMD to start it or place it in your "Startup"
  33. folder.
  34.  
  35.  
  36. Operation 
  37. ---------
  38.  
  39. MEMSTAT commences operation once it is started and displays the memory
  40. and swap file status, updated at the interval specified in the
  41. Settings Dialog Box. 
  42.  
  43. When MEMSTAT receives a WM_SAVEAPPLICATION message, e.g. after
  44. selecting Shutdown from the Workplace Shell Desktop, it saves its current
  45. position and settings to OS2.INI.  The next time it is started MEMSTAT will
  46. move its display window to that position. This allows you to place MEMSTAT
  47. in a position suited to your working environment. 
  48.  
  49.  
  50. Release Notes for Version 2.07
  51. ------------------------------
  52.  
  53.    Enhancements in this release
  54.    -   None
  55.  
  56.    Bug fixes in this release
  57.    -   Fixed the problem with not correctly getting the swap drive id
  58.        when SWAPPATH is set using lower case.
  59.  
  60. Release Notes for Version 2.06
  61. ------------------------------
  62.  
  63.    Enhancements in this release
  64.    -   Reorganized the Help (removed the "Help for..." text from most
  65.        of the panels).
  66.  
  67.    Bug fixes in this release
  68.    -   Fixed the problems with incorrectly restoring color settings
  69.        from drag and drop.
  70.  
  71. Release Notes for Version 2.05
  72. ------------------------------
  73.  
  74.    Enhancements in this release
  75.    -   MemStat now supports dragging and dropping of colors and fonts onto
  76.        its client area.
  77.  
  78.    -   Updated address details of The Software Cottage.
  79.  
  80.    Bug fixes in this release
  81.    -  Fixed the problem of a duplicate line in the help text.
  82.  
  83. Release Notes for Version 2.04
  84. ------------------------------
  85.  
  86.    Enhancements in this release
  87.    -   MemStat now has a 'Hide Frame' option allowing the frame window
  88.        to be hidden. This allows MemStat to take up less room on the screen.
  89.        The frame display can now be toggled by double-clicking on the MemStat
  90.        display window with the left mouse button. When the frame is hidden,
  91.        MemStat can be moved about the screen by dragging the window using
  92.        the left mouse button.
  93.  
  94.    -   MemStat can now be configured to display a Short Description of the
  95.        values it is displaying, rather than the long description. Once again,
  96.        this takes up less screen space.
  97.  
  98.    -   MemStat now has a 'Float to Surface' option which causes MemStat to
  99.        force itself to be the top-most window on the screen. This allows
  100.        MemStat to be visible at all times if required.
  101.  
  102.  
  103. Release Notes for Version 2.03
  104. ------------------------------
  105.  
  106. This is a release to make MemStat a 32-bit application. There have been
  107. no bugs reported in Version 2.02.
  108.  
  109. Release Notes for Version 2.02
  110. ------------------------------
  111.  
  112. This is purely a bug-fix release to fix the problem of MemStat not
  113. updating the memory status after the About... box is displayed.
  114.  
  115. Release Notes for Version 2.01
  116. ------------------------------
  117.  
  118.    Enhancements in this release
  119.    -   MemStat now displays the amount of disk space free on the swap drive.
  120.    -   The MemStat display is now configurable through the Options pulldown
  121.        menu.
  122.    -   MemStat now has on-line context-sensitive help.
  123.  
  124.    Bug fixes in this release
  125.    -  MemStat now displays the swap file size correctly when it is not on
  126.       Drive C:
  127.    -  Fixed a problem with the way MemStat saved its position when
  128.       minimized.
  129.  
  130.  
  131. The MemStat Display
  132. -------------------
  133. The MemStat Display window contains up to three lines of information
  134. in this release. Depending on how you have set up MemStat, the
  135. following information may be displayed:
  136.  
  137.    Available Memory
  138.  
  139.    This is the value returned from the DosMemAvail function call and
  140.    represents the size of the largest consecutive block of free memory
  141.    available when the function was called. Note that this is memory
  142.    available to 16-bit applications and may not be meaningful for 32-bit
  143.    applications running under OS/2 2.x.
  144.  
  145.    Swap File Size
  146.  
  147.    This is the physical size of the swap file, the location of which is
  148.    taken from the SWAPPATH parameter in CONFIG.SYS. Under OS/2 Version 2.x,
  149.    the swap file increases in size as your applications use memory and
  150.    decreases in size as physical memory becomes available so this value
  151.    will go up and down as you work.
  152.  
  153.    Swap Disk Free Space
  154.  
  155.    This value is the amount of free space left on the drive containing
  156.    the swap file. If this value goes too low, it is an indication that
  157.    you may need to make more space on your swap drive or move your swap
  158.    file to another drive.
  159.  
  160.  
  161. MemStat Menus
  162. -------------
  163.  
  164. The following pulldown menus are available for selection from within
  165. MemStat:
  166.  
  167.    Options
  168.    This menu allows the user to change the MemStat configuration, save
  169.    the position of MemStat on the desktop, and exit from MemStat. It contains
  170.    the following options:
  171.  
  172.       Settings
  173.       This menu option brings up the MemStat Settings dialog box which
  174.       allows the user to alter the MemStat display. The user can tell
  175.       MemStat which parameters to display and can change the display
  176.       update interval to reduce the impact of MemStat on the system.
  177.       The settings selected by the user are saved in OS2.INI and retrieved
  178.       by MemStat when it is next loaded.
  179.  
  180.       Save Position
  181.       Selecting this option allows the user to save the current position of
  182.       MemStat on the screen. The next time MemStat is run, it will be
  183.       displayed in the saved position. This option is automatically selected
  184.       when you select Shutdown from the Workplace Shell Desktop.
  185.  
  186.       Exit
  187.       Selecting this option exits from MemStat.
  188.  
  189.    Help
  190.    This menu allows the user to request help, and to display the About
  191.    dialog box. It contains the following options:
  192.  
  193.       Help for help...
  194.       Selecting this option displays general help applicable to the Help
  195.       Manager and its use.
  196.  
  197.       Extended help...
  198.       Selecting this option displays extended help and information for
  199.       MemStat.
  200.  
  201.       Keys help...
  202.       Selecting this option results in the display of help for the keystrokes
  203.       available in MemStat.
  204.  
  205.       Help index...
  206.       Selecting this option displays the Help Index for MemStat, allowing
  207.       the user to quickly find the desired help page.
  208.  
  209.       About...
  210.       This option is used to bring up the MemStat About dialog box, which
  211.       displays copyright information about MemStat, including the current
  212.       version number.
  213.  
  214.  
  215.  
  216. MemStat Settings Dialog Box
  217. ---------------------------
  218.  
  219. To change any of the MemStat settings, click on the check boxes labelled:
  220.  
  221.    Display Available Memory
  222.    Checking this box results in MemStat displaying the amount of physical
  223.    memory available to applications running under OS/2.
  224.  
  225.    Display Swap File Size
  226.    Checking this box results in MemStat displaying the current size of the
  227.    swap file used by OS/2.
  228.  
  229.    Display Swap Disk Free Space
  230.    Checking this box results in MemStat displaying the current amount of 
  231.    free space on the drive on which the swap file is stored.
  232.  
  233.    Hide Window Frame
  234.    Checking this box results in MemStat hiding its frame window when
  235.    displaying the requested information. This allows the MemStat window
  236.    to take up less room on the desktop. The frame display can be toggled
  237.    by double-clicking with the left mouse button on the MemStat display
  238.    window. When the frame window is hidden, the Memstat window may be moved
  239.    by selecting the window with the left mouse button and dragging the
  240.    window to the desired location.
  241.  
  242.    Short Descriptions
  243.    Checking this box results in MemStat displaying shortened descriptions
  244.    of the information it is displaying. This allows the Memstat display
  245.    to take up less room on the desktop.
  246.  
  247.    Float Memstat to Surface
  248.    Checking this box results in the MemStat display floating to the
  249.    surface when it is not the currently active window. This option is
  250.    useful when it is desired to monitor memory status while running
  251.    other applications which may take up the whole desktop.
  252.  
  253.    Timer Interval
  254.    To change the Timer Interval, click on the edit field and enter a
  255.    numeric value between 0 and 65535. A value of 0 will cause the update
  256.    to occur as quickly as possible, that is, about every 1/18 of a second.
  257.  
  258. Any changes made to the above fields will not be reflected in MemStat until
  259. the "OK" push-button is selected.
  260.  
  261.    OK pushbutton
  262.    Selecting the OK pushbutton will result in the contents of the dialog
  263.    fields being checked and, if there is no invalid data, the data entered
  264.    will be saved and used by MemStat in displaying the memory status
  265.    information.
  266.  
  267.    Cancel Push Button
  268.    Selecting the Cancel pushbutton will result in the dialog box closing
  269.    without saving any changes made to its fields.
  270.  
  271.    Help Push Button
  272.    Selecting the Help pushbutton will result in help being displayed for
  273.    this dialog box.
  274.  
  275.  
  276.  
  277. About Dialog Box
  278. ----------------
  279.  
  280. The About Dialog Box gives some general information about MemStat, 
  281. including software copyright notices and the current version number.
  282.  
  283. Select "OK" to close the About Dialog Box.
  284.  
  285.  
  286. Keys
  287. ----
  288.  
  289. The following keys are available for use within MemStat:
  290.  
  291.    General Keys
  292.  
  293.    F1
  294.       Get help
  295.  
  296.    Alt+F4 or F3
  297.       Close MemStat
  298.  
  299.    Alt+F5
  300.       Restore MemStat (when minimized)
  301.  
  302.    Alt+F7 
  303.       Move the MemStat window 
  304.  
  305.    Alt+F9
  306.       Minimize the MemStat window 
  307.  
  308.    Dialog Box Keys
  309.  
  310.    Enter 
  311.       Accept details and close dialog box
  312.  
  313.    Esc 
  314.       Cancel the dialog box
  315.  
  316.    Spacebar 
  317.       Set a check box on/off or perform the task described on the selected 
  318.       pushbutton 
  319.  
  320.    Tab 
  321.       Move to the next entry field or check box 
  322.  
  323.    Editing Keys
  324.  
  325.    Backspace (left arrow delete) 
  326.       Delete the character to the left of the cursor 
  327.  
  328.    Del
  329.       Delete the character at the cursor
  330.  
  331.    End or Ctrl+Right Arrow key 
  332.       Move to the end of a field 
  333.  
  334.    Home or Ctrl+Left Arrow key 
  335.       Move to the beginning of a field. 
  336.  
  337.  
  338. MemStat Error Messages
  339. ----------------------
  340.  
  341. If an error occurs during execution, MemStat will attempt to display
  342. a message reporting the error and will then take appropriate action.
  343.  
  344. Currently, MemStat will report the following errors:
  345.  
  346.    "Unable to create Timer"
  347.    MemStat was unable to start a new system timer. This indicates that
  348.    the system timer limit has been exceeded. To fix this problem, close
  349.    some applications that use system timers and try MemStat again.
  350.  
  351.    "Must select at least one parameter to display"
  352.    At least one Memory Status parameter must be selected for display. Check
  353.    at least one of the check boxes in the Settings dialog box.
  354.  
  355.    "Invalid Timer Interval Entered"
  356.    The timer interval must be set to a value between 0 and 65535. A value
  357.    of 0 will cause the update to occur as quickly as possible, that is, about
  358.    every 1/18 of a second.
  359.  
  360.    "Unable to Save OS2.INI Profile Entry"
  361.    MemStat was unable to save its Profile information to OS2.INI because
  362.    of a system error. Any settings changed in this session will need to be
  363.    changed again, the next time MemStat is run. To fix this problem, check
  364.    the validity of OS2.INI using an OS2.INI editor program to confirm that
  365.    it is readable. If not, restore your latest backup of OS2.INI.
  366.  
  367.  
  368. Registering MemStat
  369. -------------------
  370.  
  371. The easiest way to register that you are using MemStat is to send an
  372. electronic mail note to Greg Jones at any of the addresses above. MemStat
  373. is currently being distributed as freeware. By registering, you are
  374. guaranteeing that you will find out when new releases are made.
  375.  
  376.  
  377. Program License Agreement 
  378. -------------------------
  379.  
  380. MemStat is currently being distributed as a general interest utility.
  381. You are free to copy and use the software for personal use and distribution
  382. in its original, unmodified form provided no fee is charged beyond reasonable
  383. media and/or shipping charges. 
  384.  
  385. Corporate users interested in using MemStat are invited to contact
  386. The Software Cottage regarding licensing.
  387.  
  388.  
  389.  
  390.