home *** CD-ROM | disk | FTP | other *** search
/ Freelog 13 / Freelog_13_septembre_2000.mdx / Bas / Systeme / RamPage / README.TXT < prev    next >
Encoding:
Text File  |  2000-02-18  |  14.5 KB  |  308 lines
  1. RAMpage 1.4
  2. ===========
  3. 02/19/2000
  4.  
  5. **** IMPORTANT NOTE ****
  6.  
  7. If you have a previous version of RAMpage running on your machine,
  8. you should uninstall it before installing this version.
  9.  
  10. License:
  11. ========
  12. This program is FREEWARE.
  13. You may distribute it freely provided the distribution is not for profit.
  14.  
  15. (You CAN use it at work, but you CANNOT SELL it.) If you would like a 
  16. distribution or support license for this software please contact the author.
  17.  
  18. Purpose:
  19. ========
  20. RAMpage is a small Windows utility that displays the amount of available memory in
  21. an icon in the System Tray. When the icon is double clicked, the program attempts to
  22. free a predefined amount of memory. RAMpage can also be configured to free memory
  23. automatically when the amount of available memory drops below a predefined level.
  24.  
  25. Installation:
  26. =============
  27. This software comes as a zipped setup file.
  28. It has install/uninstall programs and a configuration screen.
  29.  
  30. Users who do not wish to use the installation tools can download the RAMpage 
  31. executables directly from the author's web site. You may wish to do this for 
  32. any of the following reasons:
  33. - You don't have administrator rights on NT, (required to do a full install).
  34. - You are running a version of Windows that the installation program does not
  35.   recognize. (The installer runs on Windows 95, 98, 2000 and NT 4.0)
  36. - You do not want/need the uninstall program in your system directory, or you
  37.   want more control over the locations and shortcuts for this software.
  38.  
  39. File and Registry details are given in the User Guide below to help with 
  40. manual uninstalls.
  41.  
  42. Author/Technical Contact:
  43. =========================
  44. John Fitzgibbon
  45. email: fitz@jfitz.com
  46. web: http://www.jfitz.com/software/RAMpage
  47.  
  48.  
  49. ====================================================================================
  50.  
  51. RAMpage USER GUIDE
  52.  
  53. ====================================================================================
  54.  
  55. 1. Quick Start
  56. ==============
  57.  
  58. Most of the features of RAMpage can be controlled by the configuration screen that 
  59. is displayed when RAMpage is selected from the Programs Menu. The default values
  60. should work well for most users.
  61.  
  62. After clicking "OK", the RAMpage tray program is started. This creates a System Tray
  63. icon that shows the number of MB of free RAM.
  64.  
  65. Double-clicking the icon attempts to free the amount of memory you specified in the
  66. configuration screen. Right-clicking the icon accesses a popup menu. The options are:
  67.  
  68.   Free Memory    - Same as double-clicking the icon.
  69.   Details        - Lists total/available physical, page, (swap), and virtual memory.
  70.   Help / Config  - Displays the configuration screen.
  71.   Exit           - Quits RAMpage.
  72.  
  73. If you set the "Free memory automatically" value to a non-zero value in the 
  74. configuration screen, RAMpage will free memory automatically when available memory 
  75. falls below the level you set.
  76.  
  77. If you find RAMpage is slow to free memory, or you still have problems with
  78. applications running out of memory, please read the FAQs at: 
  79. http://www.jfitz.com/software/RAMpage/RAMpage_FAQS.html
  80. The FAQs give some good starting points for tweaking your Windows settings. In many
  81. cases, a few basic tweaks can have a major impact on performance and reliability.
  82.  
  83. The rest of this User Guide is mainly aimed at advanced users who do not want to use
  84. the installation and configuration features. The rest of us can stop reading here!
  85.  
  86. ====================================================================================
  87.  
  88.  
  89. 2. Introduction
  90. ===============
  91.  
  92. RAMpage is a small Windows utility that displays memory status information in an 
  93. icon in the System Tray. In addition, it can be used to force Windows to free unused
  94. memory, either manually or automatically. I have found this particularly useful when 
  95. doing heavy graphics processing - for instance my, (old), version of Paint Shop Pro 
  96. sometimes runs out of memory after processing a file, but before saving it. RAMpage 
  97. usually frees enough memory to allow me to save files in these emergency situations.
  98.  
  99. The idea for the program came from J.Pajula's RamBooster which offers similar
  100. functionality. I wanted a "lean" version that could free memory with one double 
  101. click, and which shows the current memory status all the time - RAMpage is it.
  102.  
  103.  
  104. 3. Using RAMpage
  105. ================
  106.  
  107. When RAMpage is running, a System Tray icon shows the number of MB of free RAM.
  108.  
  109. A Green Bar below the number means > 20% free RAM.
  110. A Yellow Bar means between 5% and 20% free RAM.
  111. A Red Bar means < 5% free RAM.
  112.  
  113. Note: If your machine has over 1000M of RAM, a Green Bar indicates 1000M or more 
  114. free RAM and Yellow indicates < 1000M. This is to compensate for the fact that there 
  115. is only room to display 3 digits in the icon. In this case, "400" with a Green bar 
  116. would indicate 1400M free, (or 2400M, 3400M, etc.), while "400" with a Yellow bar 
  117. would actually mean 400M free. (To be honest, if you have over 1000M of RAM you 
  118. probably don't need this program anyway.)
  119.  
  120. Double-clicking on the icon attempts to free extra RAM. 
  121.  
  122. By default, RAMpage attempts to free 10M with each double-click, though this 
  123. can be changed from the configuration screen or with a command line parameter.
  124.  
  125. Right-clicking on the icon accesses a popup menu. The menu options are:
  126.  
  127.   Free Memory    - Same as double-clicking the icon.
  128.   Details        - Lists total/available physical, page, (swap), and virtual memory.
  129.   Help / Config  - Displays the configuration screen.
  130.   Exit           - Quits RAMpage.
  131.  
  132.  
  133. 4. Command Line Parameters
  134. ==========================
  135. Note: All the values described here can be controlled from the configuration 
  136. screen. You can skip the rest of this document if you are not interested in 
  137. removing or bypassing the configuration screen.
  138.  
  139. NOTE: THE VAST MAJORITY OF USERS DO NOT NEED TO USE COMMAND LINE PARAMETERS OR
  140. WORRY ABOUT CREATING STARTUP SHORTCUTS. IF YOU DO INTEND TO USE COMMAND LINE
  141. PARAMETERS PLEASE READ THIS SECTION FULLY. IN ADDITION PLEASE CONSULT THE FAQS 
  142. IF YOU HAVE PROBLEMS. MOST PROBLEMS REPORTED TO ME ARE A RESULT OF 
  143. MISUNDERSTANDINGS THAT ARE COVERED HERE OR IN THE FAQS.
  144.  
  145. The command line may include any of the following parameters:
  146.  
  147. B:       Show values in the "Details" window in Bytes, (default is MBytes).
  148. LG, LW:  Add LG or LW to default to "Luminous" Green or "Luminous" White digits.
  149. S:       "Sound" - Beep when freeing memory automatically.
  150. O:       "run Once" - performs a memory freeing operation then exits.
  151.          (Useful for including in scripts/batch files.)
  152. U=X:     X is number of seconds between updates, (default=5).
  153. M=Y:     Y is number of MBytes to attempt to free, (default=10).
  154. T=Z:     If RAM falls to, or below, Z MBytes the program attempts to free RAM.
  155. D=Y/N:   Defragment freed memory into a single free chunk (Yes/No)
  156.          (Default is to defragment if memory to free is less than 1/3 of total memory.)
  157. P=PATH:  "PATH" specifies the path to the folder where RAMpageConfig.exe resides.
  158.          If specified the Help/Config menu option will run RAMpageConfig.exe. The default
  159.          is to display a short help message box. Normally, this option is only required
  160.          if you are running the fully installed version of the program.
  161.          Everything after the "P=" is included in the path. No quotes are required.
  162.          NOTE: IF INCLUDED, THIS MUST BE THE LAST PARAMETER ON THE COMMAND LINE.
  163.  
  164. Sample Command Line
  165.  
  166. C:\Program Files\Accessories\RAMpage.exe LG U=2 M=20 T=3
  167.  
  168. This command line tells the program to use luminous green numbers, to update the 
  169. status every 2 seconds, to attempt to free an additional 20 MBytes or RAM when 
  170. requested, and to automatically attempt to free RAM if the current free RAM is at
  171. or below 3 MBytes.
  172.  
  173. Usage Notes: 
  174.  
  175. If the automated freeing feature does not succeed in freeing RAM, it will
  176. try less and less frequently to free RAM, (until memory is freed up, or the 
  177. computer, or RAMpage, is restarted). This prevents a situation arising where the 
  178. computer is maxed out but RAMpage keeps slowing things down by trying to free RAM
  179. every few seconds. When the interval between attempts to free RAM reaches 10 
  180. minutes, RAMpage will continue to try to free memory once every 10 minutes. This 
  181. is useful for fully automated systems, where memory may be (genuinely) tied up 
  182. for a long time, but an app. is not freeing memory correctly. In this case, 
  183. RAMpage will clean things up within 10 minutes of the app stopping.
  184.  
  185. The "luminous" numbers may be easier to read if you've selected a very high
  186. resolution display on a small monitor.
  187.  
  188. RAMpageH.exe is the "Hidden" version of the program. It takes the same parameters,
  189. but runs without the tray icon. This reduces the amount of memory required.
  190.  
  191. To start the program automatically when Windows starts, place a shortcut to the 
  192. executable in the Start Menu/Programs/StartUp folder. (Note: the configuration
  193. utility achieves the same effect with a Registry entry in HKEY_LOCAL_MACHINE.)
  194.  
  195. DO NOT place a shortcut in the StartUp folder if you are using the fully installed
  196. version of the program - use the "Start when Windows starts" option in the 
  197. configuration screen. This is a common mistake and causes the program to run 
  198. twice at startup.
  199.  
  200. If you ARE putting a shortcut in the Startup folder, remember that you MUST specify
  201. all the required parameters on the command line. You cannot run the configuration
  202. program, then place a shortcut with no parameters in the Startup folder. The 
  203. configuration program does store parameters in the Registry, but the tray program
  204. DOES NOT read the Registry.
  205.  
  206.  
  207. 5. Manual Uninstall Information
  208. ===============================
  209.  
  210. If you've messed up an install, or done a partial uninstall, or just want to 
  211. "uninstall the uninstallers", here are the details you may need to clean up your 
  212. system. (If you're not comfortable deleting system files and editing the registry, 
  213. I'd strongly recommend leaving well enough alone.)
  214.  
  215. 5.1 Files:
  216. ==========
  217. C:\WINDOWS\SYSTEM\Gksui16.exe - This 56K program stays even after a clean uninstall.
  218.  
  219. You can remove it if you do not have other programs that were installed with the GK 
  220. installation kit. (If in doubt, I'd recommend leaving this file to avoid possible 
  221. problems with other uninstalls.)
  222.  
  223. The program directory and its contents can be removed:
  224. GKDeReg.exe
  225. RAMpage.exe
  226. RAMpageH.exe
  227. RAMpageConfig.exe
  228. ReadMe.txt
  229. Uninstal.dat
  230.  
  231. 5.2 Registry:
  232. =============
  233. All settings under: HKEY_CURRENT_USER/software/RAMpage can be removed.
  234.  
  235. A value called "RAMpage" can be removed, (if it exists) from the following key: 
  236. HKEY_LOCAL_MACHINE\software\Microsoft\Windows\CurrentVersion\Run
  237. (This is the key that supports the "Start RAMpage when Windows Starts" feature.)
  238.  
  239. All settings under:
  240. HKEY_LOCAL_MACHINE\software\Microsoft\Windows\CurrentVersion\Uninstall\RAMpage
  241.  
  242. If you removed C:\WINDOWS\SYSTEM\GKSUI16.EXE, then you can also remove
  243. a corresponding value "C:\WINDOWS\SYSTEM\GKSUI16.EXE" in:
  244. HKEY_LOCAL_MACHINE\software\Microsof\Windows\CurrentVersion\SharedDLLs
  245.  
  246.  
  247. 6. Credits and Acknowledgments
  248. ===============================
  249.  
  250. The code for controlling the tray icon is based on an example by Michael T. Smith/ 
  251. R.A.M. Technology. 
  252.  
  253. Jonathan Teh, author of the excellent, (and free), MBProbe set me straight on how 
  254. to make the tray bitmaps work on NT. 
  255.  
  256. The install/uninstall program, GKSetUp, is a freeware application by Gero Kuehn.
  257.  
  258. The "official" testers for version 1.3 were Alex Schoenmakers, (NT) and 
  259. Andrew Murphy, (Win 98). They showed great patience, and gave excellent feedback 
  260. on the early prototypes. 1.4 evolved from user feedback. Thanks to all those users
  261. who brought bugs to my attention, and worked with me to test patches.
  262.  
  263. Finally, many thanks to everyone who emailed me with comments and suggestions. I
  264. probably wouldn't have bothered without your support.
  265.  
  266.  
  267. 7. Revision History
  268. ===================
  269.  
  270. 08/30/1999 1.0 - Original Version.
  271. 11/02/1999 1.1 - Fixed NT display problem. 
  272.                - Added "Luminous" digits. 
  273.                - Improved "Help" window, (but not much).
  274. 11/12/1999 1.2 - Optimized the code, (memory footprint now about 180K).
  275.                - Rounds up/down to nearest MByte, (was truncating).
  276.                - Added option to display "Details" in Bytes, (default is MBytes).
  277. 11/27/1999 1.3 - Added ability to automatically free RAM.
  278.                - Added logic to prevent excessive automatic attempts to free RAM 
  279.                  when memory is not being freed.
  280.                - Added a configuration screen.
  281.                - Added a help screen for choosing parameters.
  282.                - Added standard install/uninstall, with Registry documentation.
  283.                - Further optimized the core executable. Footprint is now 156K.
  284.                - Fixed a bug that could cause a small memory leak. (Embarrassing!)
  285. 02/19/2000 1.4 - Default values in the configuration screen are now calculated more
  286.                  "intelligently". (They are based on the machines total memory.)
  287.                - Added "Hidden" option, (allows program to run without tray icon).
  288.                  Running hidden means automated free only, but memory footprint is smaller.
  289.                - Added Sound, ("S"), option. (Beeps when freeing memory automatically.)
  290.                - Added memory Defragmentation, ("D"), option. 
  291.                  "D=Y" means always defragment memory.
  292.                  "D=N" means never defragment. 
  293.                  Default is to defragment only when freeing less than 1/3 of total memory.
  294.                - Added Path, ("P"), option. If included the "Help/Config" menu item runs 
  295.                  RAMpageConfig.exe using the specified Path. (Otherwise, the existing 
  296.                  Help/About box is displayed.) Note: Path MUST be the last parameter.
  297.                - Added option to run Once, ("O"). This does a free, then exits immediately.
  298.                  (Threshold, display and update intervals have no effect in this mode.)
  299.                - Changed color definition for "white" from RGB=(0xFF,0xFF,0xFF) to 
  300.                  (0xF0,0xF0,0xF0) to fix NT display of white as dark gray. 
  301.                  Note: 256 color display on NT still shows up dark gray. 
  302.                  Workaround is to use more colors or use the green digit type.
  303.                - Fixed bug that caused tray icon to display upside down for some users.
  304.                - Automatic freeing is never called if Threshold=0. 
  305.                  (Previous version would do freeing if free memory was actually 0 bytes).
  306.  
  307. ====================================================================================
  308.