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