home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / MEM201.ZIP / MEMSTAT.DOC next >
Text File  |  1992-03-17  |  10KB  |  313 lines
  1. MEMSTAT - OS/2 Presentation Manager Memory Status Utility, Version 2.01 
  2. Copyright (C) 1991, 1992 The Software Cottage. All rights reserved. 
  3.  
  4. For further information, contact: 
  5.     Greg Jones, 
  6.     The Software Cottage 
  7.     71 Bruce Street, 
  8.     Mount Waverley, Vic, 3149 
  9.     AUSTRALIA. 
  10.  
  11.     Ph: 61-3-807-4939 
  12.     Fidonet: 3:634/384.2 
  13.     CompuServe: 100033,3121
  14.  
  15.  
  16. What is MemStat?
  17. ----------------
  18.  
  19. MemStat Version 2.01 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 1.x and 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 make it an auto-start
  33. application in one of your groups (or in the "Startup" folder under
  34. OS/2 Version 2.0). 
  35.  
  36.  
  37. Operation 
  38. ---------
  39.  
  40. MEMSTAT commences operation once it is started and displays the memory
  41. and swap file status, updated at one second intervals. 
  42.  
  43. If MEMSTAT receives a WM_SAVEAPPLICATION message, e.g. after
  44. selecting "Desktop->Save" under OS/2 1.3, it saves its current
  45. position to OS2.INI.  The next time it is started MEMSTAT will move
  46. 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.01
  51. ------------------------------
  52.  
  53.    Enhancements in this release
  54.    -   MemStat now displays the amount of disk space free on the swap drive.
  55.    -   The MemStat display is now configurable through the Options pulldown
  56.        menu.
  57.    -   MemStat now has on-line context-sensitive help.
  58.  
  59.    Bug fixes in this release
  60.    -  MemStat now displays the swap file size correctly when it is not on
  61.       Drive C:
  62.    -  Fixed a problem with the way MemStat saved its position when
  63.       minimized.
  64.  
  65.    Cautions
  66.    -  MemStat needs to read CONFIG.SYS from the Boot Drive, so be careful
  67.       if you boot PM from a floppy disk and then run MemStat (It can be
  68.       done under 1.x!).
  69.  
  70.  
  71. The MemStat Display
  72. -------------------
  73. The MemStat Display window contains up to three lines of information
  74. in this release. Depending on how you have set up MemStat, the
  75. following information may be displayed:
  76.  
  77.    Available Memory
  78.  
  79.    This is the value returned from the DosMemAvail function call and
  80.    represents the size of the largest consecutive block of free memory
  81.    available when the function was called. Note that this is memory
  82.    available to 16-bit applications and may not be meaningful for 32-bit
  83.    applications running under OS/2 2.x.
  84.  
  85.    Swap File Size
  86.  
  87.    This is the physical size of the swap file, the location of which is
  88.    taken from the SWAPPATH parameter in CONFIG.SYS. Under OS/2 Version 1.x,
  89.    this parameter will start at 512K and gradually increase depending on the
  90.    memory requirements of the applications you run. Under OS/2 Version 2.x,
  91.    the swap file actually decreases in size as physical memory becomes
  92.    available so this value may go up and down as you work.
  93.  
  94.    Swap Disk Free Space
  95.  
  96.    This value is the amount of free space left on the drive containing
  97.    the swap file. If this value goes too low, it is an indication that
  98.    you may need to make more space on your swap drive or move your swap
  99.    file to another drive.
  100.  
  101.  
  102. MemStat Menus
  103. -------------
  104.  
  105. The following pulldown menus are available for selection from within
  106. MemStat:
  107.  
  108.    Options
  109.    This menu allows the user to change the MemStat configuration, save
  110.    the position of MemStat on the desktop, and exit from MemStat. It contains
  111.    the following options:
  112.  
  113.       Settings
  114.       This menu option brings up the MemStat Settings dialog box which
  115.       allows the user to alter the MemStat display. The user can tell
  116.       MemStat which parameters to display and can change the display
  117.       update interval to reduce the impact of MemStat on the system.
  118.       The settings selected by the user are saved in OS2.INI and retrieved
  119.       by MemStat when it is next loaded.
  120.  
  121.       Save Position
  122.       Selecting this option allows the user to save the current position of
  123.       MemStat on the screen. The next time MemStat is run, it will be
  124.       displayed in the saved position. This option is automatically selected
  125.       if you check the Save check-box on the Desktop Manager's Shutdown
  126.       Dialog Box (OS/2 Version 1.x) or when you select Shutdown from the
  127.       Workplace Shell Desktop (Os/2 Version 2.x).
  128.  
  129.       Exit
  130.       Selecting this option exits from MemStat.
  131.  
  132.    Help
  133.    This menu allows the user to request help, and to display the About
  134.    dialog box. It contains the following options:
  135.  
  136.       Help for help...
  137.       Selecting this option displays general help applicable to the Help
  138.       Manager and its use.
  139.  
  140.       Extended help...
  141.       Selecting this option displays extended help and information for
  142.       MemStat.
  143.  
  144.       Keys help...
  145.       Selecting this option results in the display of help for the keystrokes
  146.       available in MemStat.
  147.  
  148.       Help index...
  149.       Selecting this option displays the Help Index for MemStat, allowing
  150.       the user to quickly find the desired help page.
  151.  
  152.       About...
  153.       This option is used to bring up the MemStat About dialog box, which
  154.       displays copyright information about MemStat, including the current
  155.       version number.
  156.  
  157.  
  158.  
  159. MemStat Settings Dialog Box
  160. ---------------------------
  161.  
  162. To change any of the MemStat settings, click on the check boxes labelled:
  163.  
  164.    Display Available Memory
  165.    Checking this box results in MemStat displaying the amount of physical
  166.    memory available to applications running under OS/2.
  167.  
  168.    Display Swap File Size
  169.    Checking this box results in MemStat displaying the current size of the
  170.    swap file used by OS/2.
  171.  
  172.    Display Swap Disk Free Space
  173.    Checking this box results in MemStat displaying the current amount of 
  174.    free space on the drive on which the swap file is stored.
  175.  
  176.    Timer Interval
  177.    To change the Timer Interval, click on the edit field and enter a
  178.    numeric value between 0 and 65535. A value of 0 will cause the update
  179.    to occur as quickly as possible, that is, about every 1/18 of a second.
  180.  
  181. Any changes made to the above fields will not be reflected in MemStat until
  182. the "OK" push-button is selected.
  183.  
  184.    OK pushbutton
  185.    Selecting the OK pushbutton will result in the contents of the dialog
  186.    fields being checked and, if there is no invalid data, the data entered
  187.    will be saved and used by MemStat in displaying the memory status
  188.    information.
  189.  
  190.    Cancel Push Button
  191.    Selecting the Cancel pushbutton will result in the dialog box closing
  192.    without saving any changes made to its fields.
  193.  
  194.    Help Push Button
  195.    Selecting the Help pushbutton will result in help being displayed for
  196.    this dialog box.
  197.  
  198.  
  199.  
  200. About Dialog Box
  201. ----------------
  202.  
  203. The About Dialog Box gives some general information about MemStat, 
  204. including software copyright notices and the current version number.
  205.  
  206. Select "OK" to close the About Dialog Box.
  207.  
  208.  
  209. Keys
  210. ----
  211.  
  212. The following keys are available for use within MemStat:
  213.  
  214.    General Keys
  215.  
  216.    F1
  217.       Get help
  218.  
  219.    Alt+F4 or F3
  220.       Close MemStat
  221.  
  222.    Alt+F5
  223.       Restore MemStat (when minimized)
  224.  
  225.    Alt+F7 
  226.       Move the MemStat window 
  227.  
  228.    Alt+F9
  229.       Minimize the MemStat window 
  230.  
  231.    Dialog Box Keys
  232.  
  233.    Enter 
  234.       Accept details and close dialog box
  235.  
  236.    Esc 
  237.       Cancel the dialog box
  238.  
  239.    Spacebar 
  240.       Set a check box on/off or perform the task described on the selected 
  241.       pushbutton 
  242.  
  243.    Tab 
  244.       Move to the next entry field or check box 
  245.  
  246.    Editing Keys
  247.  
  248.    Backspace (left arrow delete) 
  249.       Delete the character to the left of the cursor 
  250.  
  251.    Del
  252.       Delete the character at the cursor
  253.  
  254.    End or Ctrl+Right Arrow key 
  255.       Move to the end of a field 
  256.  
  257.    Home or Ctrl+Left Arrow key 
  258.       Move to the beginning of a field. 
  259.  
  260.  
  261. MemStat Error Messages
  262. ----------------------
  263.  
  264. If an error occurs during execution, MemStat will attempt to display
  265. a message reporting the error and will then take appropriate action.
  266.  
  267. Currently, MemStat will report the following errors:
  268.  
  269.    "Unable to create Timer"
  270.    MemStat was unable to start a new system timer. This indicates that
  271.    the system timer limit has been exceeded. To fix this problem, close
  272.    some applications that use system timers and try MemStat again.
  273.  
  274.    "Must select at least one parameter to display"
  275.    At least one Memory Status parameter must be selected for display. Check
  276.    at least one of the check boxes in the Settings dialog box.
  277.  
  278.    "Invalid Timer Interval Entered"
  279.    The timer interval must be set to a value between 0 and 65535. A value
  280.    of 0 will cause the update to occur as quickly as possible, that is, about
  281.    every 1/18 of a second.
  282.  
  283.    "Unable to Save OS2.INI Profile Entry"
  284.    MemStat was unable to save its Profile information to OS2.INI because
  285.    of a system error. Any settings changed in this session will need to be
  286.    changed again, the next time MemStat is run. To fix this problem, check
  287.    the validity of OS2.INI using an OS2.INI editor program to confirm that
  288.    it is readable. If not, restore your latest backup of OS2.INI.
  289.  
  290.  
  291. Registering MemStat
  292. -------------------
  293.  
  294. The easiest way to register that you are using MemStat is to send an
  295. electronic mail note to Greg Jones at any of the addresses below. MemStat
  296. is currently being distributed as freeware. By registering, you are
  297. guaranteeing that you will find out when new releases are made.
  298.  
  299.  
  300. Program License Agreement 
  301. -------------------------
  302.  
  303. MemStat is currently being distributed as a general interest utility.
  304. You are free to copy and use the software for personal use and distribution
  305. in its original, unmodified form provided no fee is charged beyond reasonable
  306. media and/or shipping charges. 
  307.  
  308. Corporate users interested in using MemStat are invited to contact
  309. The Software Cottage regarding licensing.
  310.  
  311.  
  312.  
  313.