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