home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 6 File / 06-File.zip / free15.zip / free.doc next >
Text File  |  1994-01-27  |  3KB  |  95 lines
  1. ===========================================================================
  2. FREE 1.5                                                        26-Jan-1994
  3. ===========================================================================
  4. Copyright (C) 1994 by Harald Bögeholz
  5.  
  6.  
  7. FREE is a free command line utility program that shows the free space
  8. on one or more drives. Color is used to allow you to see at a glance
  9. when disk space gets critically low. FREE also shows the amount of
  10. free memory as returned by DosMemAvail(), which is pretty useless
  11. under OS/2 2.x.
  12.  
  13.  
  14. Installation
  15. ============
  16.  
  17. Very simple. Just copy FREE.EXE to a directory in your PATH. FREE is
  18. a bound 16-bit program, so it can be called from DOS sessions, too. You
  19. will probably want to add a line to CONFIG.SYS for configuration (see
  20. below).
  21.  
  22.  
  23. Usage
  24. =====
  25.  
  26. Just type FREE to see the free space on all drives (except floppies)
  27. that FREE can find. If FREE has been configured properly, it will show
  28. only the drives you configured in addition to the current drive.
  29.  
  30. Use
  31.  
  32.   FREE <drive>:
  33.  
  34. to show the free space on that drive only, or
  35.  
  36.   FREE .
  37.  
  38. to just display the free space on the current drive.
  39.  
  40. When FREE is used to display the free space on a single drive, it
  41. sets the ERRORLEVEL to the free space in megabytes. It will however
  42. not set ERRORLEVEL to values greater than 255. This can be used in
  43. batch files to determine if there is enough disk space available.
  44.  
  45.  
  46. Configuration
  47. =============
  48.  
  49. To configure FREE, set the environment variable FREECFG in your
  50. CONFIG.SYS (and AUTOEXEC.BAT if you use DOS sessions). FREECFG
  51. contains a comma separated list of all drives to be displayed, for
  52. example:
  53.  
  54. SET FREECFG=C,D,E,F,G,X
  55.  
  56. By default, FREE uses colors for displaying the free space: green, if
  57. more than 10 percent are free, yellow if between 5 and 10 percent are
  58. free, and red otherwise. The colors are generated by using ANSI escape
  59. sequences, so you need to have the ANSI.SYS driver or equivalent
  60. installed for your DOS sessions. ANSI.SYS is not required for OS/2
  61. sessions.
  62.  
  63. If you don't want colors, use an asterisk (*) as the first character
  64. of the variable, like this:
  65.  
  66. SET FREECFG=*C,D,E,F,G,X
  67.  
  68. To specify absolute threshold values for the display colors, you can
  69. use the following syntax:
  70.  
  71. SET FREECFG=C[2M/1M],D[20M/10M],E[20M/10M],H[1M/50K]
  72.  
  73. The first of the two numbers in brackets is the "yellow threshold",
  74. and the second is the "red threshold". Be sure to use exactly the
  75. characters shown and no spaces since FREE is very picky about the
  76. syntax of this variable.
  77.  
  78. In the above example, drive C will display in red if <=1M is free, in
  79. yellow if >1M and <=2M is free, and green otherwise. For small drives
  80. like RAM disks you can also use KBytes as shown in the above example
  81. for drive H:.
  82.  
  83.  
  84. License
  85. =======
  86.  
  87. Everybody is allowed to use FREE freely, as the name suggests. Have
  88. fun with it.
  89.  
  90. For comments, bug reports, corrections to my English etc. I can be
  91. reached at <hwb@mathematik.uni-stuttgart.de>.
  92.  
  93.  
  94. Harald Bögeholz
  95.