home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / UTILITY / DIR / DF202.ZIP / DF.DOC next >
Encoding:
Text File  |  1991-08-25  |  20.3 KB  |  601 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                                        DF
  16.  
  17.                             Disk Free Space Utility
  18.  
  19.                                   Version 2.02
  20.  
  21.                                 August 25, 1991
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.              Copyright (c) 1991 R. E. Faith.  All rights reserved.
  51.  
  52.  
  53.                              CompuServe: 72571,2241
  54.                            InterNet: faith@cs.unc.edu
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      DF Documentation                                       August 25, 1991
  64.  
  65.  
  66.       OVERVIEW OF FEATURES
  67.  
  68.       o Displays disk free space information for all drives on system
  69.  
  70.       o Calculates percent-available space for each drive
  71.  
  72.       o Provides summary of disk space for whole system
  73.  
  74.       o Calculates disk storage "efficiency"
  75.  
  76.       o Identifies JOIN'd, SUBST'd, and Network drives
  77.  
  78.       o Identifies Stacker volumes
  79.  
  80.       o Displays SSWAP mappings
  81.  
  82.       o Calculates system totals not counting the physical STACVOL files
  83.  
  84.       o Provides internal data about Stacker volumes
  85.  
  86.       o Calculates special "efficiency" values for Stacker volumes
  87.  
  88.       o Provides all Stacker-specific data when run under DESQview
  89.  
  90.  
  91.  
  92.  
  93.       INTRODUCTION
  94.  
  95.  
  96.       DF  is  a  UNIX-like Disk Free Space utility.  For each drive on the
  97.       system, it will display the drive letter, volume name, and the total
  98.       number  of kilobytes on the drive.  The number of kilobytes used and
  99.       available is also displayed, as well as a percentage value  indicat-
  100.       ing how much of the disk space is available.
  101.  
  102.       DF  will  identify  Stacker  volumes, Network'd, SUBST'd, and JOIN'd
  103.       drives.
  104.  
  105.       When Stacker volumes are present, an estimate of total "usable" disk
  106.       space  is  generated at the end of the DF output.  The "usable" disk
  107.       space does not include the disk space  which  is  taken  up  by  the
  108.       physical  STACVOL files, and only includes the space which is avail-
  109.       able for actual use on the system.
  110.  
  111.       Command-line  options  are  provided  to  obtain  information  on  a
  112.       specific  drive,  and  to  calculate  statistics regarding how effe-
  113.       ciently the drive is storing data.  This  "efficiency"  rating  com-
  114.       pares  the  actual  number of bytes in all of the files on the drive
  115.       with the number of bytes used to  store  these  files.    Since  the
  116.  
  117.  
  118.  
  119.      Version 2.02                          - 1 -                           
  120.  
  121.  
  122.  
  123.      DF Documentation                                       August 25, 1991
  124.  
  125.  
  126.       smallest  allocation  unit  on a disk drive is the cluster, there is
  127.       some overhead (about 1 kbyte per file  when  2  kbyte  clusters  are
  128.       used).
  129.  
  130.       Command-line  options  are  also  provided  to  obtain  cluster size
  131.       information,  and  to  obtain  Stacker-specific  information.    The
  132.       Stacker  software  compresses  data  and  stores  these  data in the
  133.       STACVOL file using the sector (512 bytes) as the  smallest  unit  of
  134.       allocation.    DF  will  report  the  number  of free sectors in the
  135.       STACVOL file.  When the "efficiency" option (-e) is  used  with  the
  136.       Stacker-specific information option (-S), additional statistics will
  137.       be provided.
  138.  
  139.  
  140.       DEFAULT INFORMATION
  141.  
  142.  
  143.       The default (i.e., with no command line options)  invokation  of  DF
  144.       will provide information in the following form:
  145.  
  146.  
  147.       Drive         total kb     used     free  % avail
  148.       C:Root           37538    30882     6656     18%   
  149.       D:Stac_User      20284    20256       28      0%   
  150.       H:User           40192    37576     2616 S    7%    JOIN C:\USR
  151.         Totals         98014    88714     9300      9%
  152.         Usable         77758    68458     9300     12%
  153.  
  154.  
  155.       The  drive  letter  is  displayed,  followed by the volume label, if
  156.       available.  The "total kb" and "free" information is  from  the  DOS
  157.       "Get  Disk  Free  Space"  function (36h).  The "used" information is
  158.       obtained by subtracting the "free" value from the "total kb" value.
  159.  
  160.       The "used" value may be artificially high on Stacker volumes,  since
  161.       the  Stacker  software  attempts  to provide an accurate estimate of
  162.       disk free space.  The Stacker software will  decrease  the  reported
  163.       free space value when poor compression ratios are detected.
  164.  
  165.       The  "S" following the "free" value for drive H: indicates that this
  166.       drive is a Stacker volume.
  167.  
  168.       The last column shows that drive  H:  has  been  JOIN'd  to  C:\USR.
  169.       SUBST'd and Network drives are also noted in this column.
  170.  
  171.       The   "Totals"   row   is  a  straight  summation  of  the  previous
  172.       information. When a Stacker volume is present, the "Usable" row will
  173.       indicate  similar totals not counting the space used by the physical
  174.       STACVOL file.  In this case, the STACVOL file for  drive  H:  is  on
  175.       drive  D:  and  takes  up 20256 kbytes.  The "Usable" row accurately
  176.  
  177.  
  178.  
  179.      Version 2.02                          - 2 -                           
  180.  
  181.  
  182.  
  183.      DF Documentation                                       August 25, 1991
  184.  
  185.  
  186.       represents the additional space provided  by  Stacker  volumes,  and
  187.       more appropriately calculates the percentage of available space.
  188.  
  189.  
  190.       COMMAND-LINE ARGUMENTS: FILENAMES
  191.  
  192.  
  193.       A  filename can be placed on the command line, and information about
  194.       the drive that the file is on will be displayed.   The  most  common
  195.       filenames  are  drive  letters  (i.e., DF A:) and "."  (i.e., DF .),
  196.       which provides information about the current drive.  This  is  espe-
  197.       cially  useful  if  you have forgotten the drive letter of the drive
  198.       that you are using, or if that drive is JOIN'd.  In the latter case,
  199.       most  directory  programs  will  disregard  the JOIN and report free
  200.       space information for the host drive.
  201.  
  202.  
  203.       COMMAND-LINE OPTIONS: -a
  204.  
  205.  
  206.       Normally, DF does not scan the floppy drives.    This  can  be  time
  207.       consuming,  especially  if  the  drives  are empty.  The "-a" switch
  208.       forces all drives, including floppies to be scanned.  To use DF on a
  209.       single floppy, without getting information on all of the others, use
  210.       "DF A:"
  211.  
  212.  
  213.       COMMAND-LINE OPTIONS: -v
  214.  
  215.  
  216.       The "-v" switch provides verbose information:
  217.  
  218.       Drive         total kb     used     free  % avail
  219.       C:Root           37538    30882     6656     18%   
  220.                     4 sectors per cluster ( 2048 bytes)   PHYS 
  221.       D:Stac_User      20284    20256       28      0%   
  222.                     4 sectors per cluster ( 2048 bytes)   PHYS 
  223.       H:User           40192    37576     2616 S    7%    JOIN C:\USR
  224.                        20256 physical kbytes              D:\STACVOL.000
  225.                    16 sectors per cluster ( 8192 bytes)   PHYS JOIN 
  226.         Totals         98014    88714     9300      9%
  227.         Usable         77758    68458     9300     12%
  228.  
  229.  
  230.       The additional information displayed includes the number of  sectors
  231.       per  cluster and the cluster size.  This can be helpful when setting
  232.       up disk drives, since it  is  less  wasteful  to  use  the  smallest
  233.       cluster  size available (2048 bytes under DOS).  Stacker volumes, in
  234.       general, use 8k clusters.  This may  make  the  Stacker  compression
  235.       algorithm more efficient.
  236.  
  237.  
  238.  
  239.      Version 2.02                          - 3 -                           
  240.  
  241.  
  242.  
  243.      DF Documentation                                       August 25, 1991
  244.  
  245.  
  246.       Flags  from  the  Current  Directory Structure are shown in the last
  247.       column.  The flags are PHYS (for physical), JOIN, SUBST, and NET.
  248.  
  249.       For Stacker volumes, the name and physical size of the STACVOL  file
  250.       is displayed.
  251.  
  252.  
  253.       COMMAND-LINE OPTIONS: -S
  254.  
  255.  
  256.       The "-S" switch provides Stacker-specific free space information:
  257.  
  258.       Stacker version 1.12 installed
  259.  
  260.       Drive            total kb     used     free  % avail
  261.       C(C):Root           37538    30882     6656     18%   
  262.       D(D):Stac_User      20284    20256       28      0%   
  263.       H(H):User           40192    37576     2616 S    7%    JOIN C:\USR
  264.                           40192    33128     7064     18% <= FAT data
  265.                           20102    18599     1503      7% <= STACVOL data
  266.         Totals            98014    88714     9300      9%
  267.         Usable            77758    68458     9300     12%
  268.  
  269.  
  270.       The Stacker driver version number is displayed.  (This is the driver
  271.       loaded in CONFIG.SYS.)
  272.  
  273.       (The current version of DF will not work with Stacker versions other
  274.       that  are  not  currently available for testing.  If you have one of
  275.       these versions, and wish to explore uncharted waters,  you  can  use
  276.       the  "-f"  switch  to force DF to ignore the Stacker version number.
  277.       This may lead to the reporting of incorrect information and/or cause
  278.       DF  to  crash.  The "-f" switch should be considered an undocumented
  279.       feature of DF.  The use of  the  "-f"  switch  is  NOT  recommended.
  280.       Please try to find an updated version of DF as soon as possible.)
  281.  
  282.       In  the  first  column,  after  the  drive letter, another letter is
  283.       present which shows the drive letter for this drive  at  boot  time.
  284.       This  should be the same as the information displayed by the Stacker
  285.       program SWAPMAP.  DF, however, can provide this information when run
  286.       under DESQview.
  287.  
  288.       The  row  labeled  "FAT  data"  is  computed  by  walking  the  File
  289.       Allocation Table and counting the  clusters  in  use.    These  data
  290.       should be identical to the default information for the drive, except
  291.       when poor compression ratios have caused  the  Stacker  software  to
  292.       provide  a  conservative  estimate of disk free space (as in the ex-
  293.       ample above).  These data could also different if the drive has been
  294.       corrupted and CHKDSK and/or SCHECK need to be run.
  295.  
  296.  
  297.  
  298.  
  299.      Version 2.02                          - 4 -                           
  300.  
  301.  
  302.  
  303.      DF Documentation                                       August 25, 1991
  304.  
  305.  
  306.       The  row  labeled  "STACVOL  data" is computed by walking the sector
  307.       allocation table in the STACVOL file.  Although the  Stacker  volume
  308.       is  using  8k  clusters as the smallest allocation unit, the STACVOL
  309.       file uses 512 byte sectors as the smallest allocation  unit.    When
  310.       compression  ratios  are  poor, more sectors will be needed to store
  311.       data.
  312.  
  313.       When the Stacker software runs out of either clusters (FAT  entries)
  314.       or sectors, the drive is full and no more files can be stored.  Many
  315.       short files will use up FAT entries faster, whereas compressed files
  316.       will use more sector space.
  317.  
  318.  
  319.       COMMAND-LINE OPTIONS: -e
  320.  
  321.  
  322.       The  "-e" option evaluates the "efficiency" of storage on the drive.
  323.       The smallest allocation unit on a disk drive is the cluster.    This
  324.       means  that  if a file is only one byte long, it will take up a full
  325.       cluster on the disk drive.  For 2k clusters,  it  follows  that,  on
  326.       average,  approximately  1k  of storage will be "lost" by each file.
  327.       The "-e" option provides information about this loss:
  328.  
  329.       Drive         total kb     used     free  % avail
  330.       C:Root           37538    30882     6656     18%   
  331.                                 29532 kbytes in files     Efficiency =  95%
  332.       D:Stac_User      20284    20256       28      0%   
  333.                                 20256 kbytes in files     Efficiency = 100%
  334.       H:User           40192    37576     2616 S    7%    JOIN C:\USR
  335.                                 23688 kbytes in files     Efficiency =  69%
  336.         Totals         98014    88714     9300      9%
  337.         Usable         77758    68458     9300     12%
  338.  
  339.  
  340.       The value labeled "kbytes in files" is computed by  adding  together
  341.       the  number  of  bytes used by each file (NOT rounded to the nearest
  342.       cluster).  The "Efficiency" represents the ratio of this  number  to
  343.       the  number  of  kbytes  used  when  each filesize IS rounded to the
  344.       nearest cluster.  For this calculation, the sizes of all directories
  345.       are ignored.  In general, the "Efficiency" computed is very close to
  346.       the number found by dividing the "kbytes in  files"  by  the  "used"
  347.       value (which includes the clusters used by directories).
  348.  
  349.       When  the  "-e"  switch  is  used  with  the "-S" switch, additional
  350.       Stacker-specific information is provided:
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.      Version 2.02                          - 5 -                           
  360.  
  361.  
  362.  
  363.      DF Documentation                                       August 25, 1991
  364.  
  365.  
  366.       Drive            total kb     used     free  % avail
  367.       H(H):User           40192    37576     2616 S    7%    JOIN C:\USR
  368.                                    23688 kbytes in files     Efficiency =  69%
  369.                           40192    33128     7064     18% <= FAT data
  370.                           20102    18599     1503      7% <= STACVOL data
  371.                                    24210 kbytes in sectors   Efficiency = 130%
  372.  
  373.  
  374.       Here, the "kbytes in sectors" value is computed from adding together
  375.       the  file  size  for  each  file, ROUNDED to the nearest sector (512
  376.       bytes).  The rounding is performed  on  a  file-by-file  basis,  and
  377.       represents  the amount of space which the files would take up IF the
  378.       cluster size was 512 bytes.  This number  is  then  divided  by  the
  379.       space  used  by the STACVOL sectors, and the "Efficiency" of Stacker
  380.       storage is reported.  Note that this number is  a  bit  conservative
  381.       since  the  STACVOL  "used"  value  includes  space  needed to store
  382.       directories,  whereas  the  "kbytes  in   sectors"   value   ignores
  383.       directories.    (If  directories  where  included  in the "kbytes in
  384.       sectors" figure, the Stacker "Efficiency"  would  probably  be  less
  385.       than 3 to 5 percent higher for most installations.)
  386.  
  387.  
  388.       A NOTE ON Stacker
  389.  
  390.  
  391.       The  Stacker  "compression ratio" (usually about 2:1) is a ratio be-
  392.       tween the number of bytes used on the Stacker volume  (with  cluster
  393.       [8k]  granularity)  and the number of bytes used in the STACVOL file
  394.       (with 512 byte) granularity.  This ratio is excellent for predicting
  395.       how much more data will fit on a Stacker volume, but is artificially
  396.       high in terms of actual "compression."  Consider, for  example,  the
  397.       compression  ratios  which  would be calculated for small files if a
  398.       cluster size of 16k or 32k was used!
  399.  
  400.       The Stacker "Efficiency" value is calculated assuming a  "512  byte"
  401.       cluster,  and  more  accurately  represents  the  amount of physical
  402.       "compression" that the Stacker software  performs.    However,  this
  403.       value  is artifically low in terms of the amount of data that can be
  404.       stored on the Stacker volume compared with the amount of  data  that
  405.       you could store on the same disk before Stacker was installed.  This
  406.       discrepancy is cause by the fact that before Stacker, the drive  was
  407.       using,  at best, 2k clusters instead of the 512 byte "clusters" used
  408.       for the "Efficiency" calculation.
  409.  
  410.  
  411.       COMMAND-LINE OPTIONS: -s
  412.  
  413.  
  414.       The "-s" option will remove the header and footer  information  from
  415.       the output.
  416.  
  417.  
  418.  
  419.      Version 2.02                          - 6 -                           
  420.  
  421.  
  422.  
  423.      DF Documentation                                       August 25, 1991
  424.  
  425.  
  426.       COMMAND-LINE OPTIONS: -o
  427.  
  428.  
  429.       The  "-o" option will provide a more UNIX-like (cryptic) header, and
  430.       display percentile information in terms of the percentage USED.
  431.  
  432.  
  433.       COMMAND-LINE SWITCHES: USING / INSTEAD OF -
  434.  
  435.  
  436.       In the default configuration, DF will accept BOTH  "/"  and  "-"  as
  437.       command-line switches.
  438.  
  439.       PLEASE  NOTE:  When  "/"  is used as a switch, there MUST be a space
  440.       before the switch.  For example, "DF /a/S" will NOT work!   Use  "DF
  441.       /a /S" or "DF /aS" instead.
  442.  
  443.       If  you would like to restrict the switch to a specific character or
  444.       set of characters, set the environment variable SWITCHES to that set
  445.       of characters.  The default is identical to SET SWITCHES=-/
  446.  
  447.       If you SET SWITCHES=- you will be able to use the "/" as a directory
  448.       delimiter in pathnames.  If you SET SWITCHES=/ you will be  able  to
  449.       use "-" as the first character in a filename.
  450.  
  451.       In  any  case,  if  you  desire  to  use  the  switch  characters in
  452.       filenames, just preceed the  filename  with  two  switch  characters
  453.       (i.e., to specify the file "-file" use "DF -- -file").
  454.  
  455.  
  456.       ENVIRONMENT VARIABLES
  457.  
  458.  
  459.       Two   environment  variable  are  available  to  store  command-line
  460.       options:
  461.  
  462.       DF_DEFAULT will be scanned for options if and only if no options  or
  463.       arguments  appear  on  the  command  line.   For example, if you SET
  464.       DF_DEFAULT=-a, then typing "DF" is equivalent to typing "DF -a".
  465.  
  466.       DF_OPTS will force options regardless of the command-line.  The only
  467.       use  for  this  option is "SET DF_OPTS=-o" which will force the old-
  468.       style headings and percentile calculations.
  469.  
  470.       Note: These environment variables CANNOT be used to store pathnames.
  471.  
  472.       For information on the SWITCHES environment variable, see  the  pre-
  473.       vious section.
  474.  
  475.  
  476.  
  477.  
  478.  
  479.      Version 2.02                          - 7 -                           
  480.  
  481.  
  482.  
  483.      DF Documentation                                       August 25, 1991
  484.  
  485.  
  486.       LICENSE INFORMATION
  487.  
  488.  
  489.       DF is NOT in the public domain.
  490.  
  491.       Source  code  is  NOT  in  the  public  domain  and is NOT currently
  492.       available.  (However, in the future, source code may be  distributed
  493.       under a GNU-ish license.)
  494.  
  495.       Copies of DF for personal, corporate, or institutional use are FREE.
  496.  
  497.       This software may NOT be distributed commercially.
  498.  
  499.       This software comes with ABSOLUTELY NO WARRANTY:
  500.             1. This  program  is  provided AS IS without any warranty, ex-
  501.                pressed or implied, including, but not limited to,  fitness
  502.                for a particular purpose.
  503.             2. The  author  is not responsible for the consequences of use
  504.                of this software.  The author will be held harmless for any
  505.                damages,  either  direct or consequential, that might arise
  506.                from the use of DF.
  507.             3. The  author  reserves  the  right  to  change  DF  and  its
  508.                documentation  without  prior notice, with no obligation to
  509.                the end user.
  510.  
  511.  
  512.       CONTACTING THE AUTHOR
  513.  
  514.  
  515.       Please send bug reports, comments, and suggestions  to  one  of  the
  516.       following addresses:
  517.  
  518.       CompuServe: 72571,2241
  519.  
  520.       InterNet: faith@cs.unc.edu
  521.  
  522.  
  523.       OBTAINING FUTURE VERSIONS
  524.  
  525.  
  526.       DF  will  be  periodically updated, but since this is FREE software,
  527.       the updates may be sporadic or non-existent.  The  author  does  not
  528.       intend to spend a great deal of time updating/maintaining DF.
  529.  
  530.       The  current  version  of  DF  will be available on CIS in the IBMHW
  531.       forum, DL library 1 (Disk/Disk Utils); and from Channel 1 BBS.
  532.  
  533.       On the InterNet, DF will also be offered to, and may  become  avail-
  534.       able  via  anonymous  FTP  from, wsmr-simtel20.army.mil (probably in
  535.       <msdos.dskutl>).  If DF becomes available from simtel20,  it  should
  536.  
  537.  
  538.  
  539.      Version 2.02                          - 8 -                           
  540.  
  541.  
  542.  
  543.      DF Documentation                                       August 25, 1991
  544.  
  545.  
  546.       also  be  available  from  sites  which  mirror  simtel20,  such  as
  547.       wuarchive.wustl.edu.
  548.  
  549.  
  550.       TRADEMARKS
  551.  
  552.  
  553.       UNIX is a registered trademark of AT&T.  CompuServe is a  registered
  554.       trademark of CompuServe Incorporated.  IBM is a registered trademark
  555.       of  International  Business  Machines  Corporation.    Stac   is   a
  556.       registered   trademark,   and   Stacker   is  a  trademark  of  Stac
  557.       Electronics.  DESQview is a trademark of Quarterdeck Office Systems.
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.      Version 2.02                          - 9 -                           
  600.  
  601.