home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / UTILS2 / SUM21.ZIP / SUMDISK.HLP < prev    next >
Text File  |  1993-11-28  |  13KB  |  250 lines
  1. --------------------------------------------------------------------------------
  2.  GENERAL INFORMATION
  3.  SumDisk is a utility that audits the space usage on any disk, highlighting
  4.  directories and files that are consuming the bulk of your disk real estate.
  5.  It will help you quickly target items to purge when space gets tight.
  6.  
  7.  SumDisk has several options to customize your disk audit (see topics on
  8.  Command Line Options and Function/Control Key Usage).  Important ones are:
  9.  
  10.  ──────────────────────────────────────────────────────────────────────────
  11.                 OPTION                           HELP FILE TOPIC
  12.  ──────────────────────────────────────────────────────────────────────────
  13.         Marking file duplicates               Quick/Exact Duplicates
  14.         Restricting the Files list            Command Line Options
  15.         Search functions                      Searching
  16.         Deleting files                        Deleting Files
  17.         Viewing files                         Viewing Files
  18.         Outputting audit results              Outputting Results
  19.  ──────────────────────────────────────────────────────────────────────────
  20.  
  21.  You can view sorted lists of the disk's directories; primary directories 
  22.  with their subdirectories' accumulated totals; and (optionally) up to
  23.  3,000 of the largest files.  SumDisk can show each list sorted either by
  24.  size or by name.
  25. --------------------------------------------------------------------------------
  26.  DISPLAY INFORMATION
  27.  The default audit screen displays a list of three pieces of information:
  28.  on the left, a bar that shows the relative size of a directory instance;
  29.  in the middle, the full pathname of that instance; and on the right, the 
  30.  kilobytes of space DOS has assigned to it (see the topic Clusters,
  31.  Sectors, and Bytes).  Directories are sorted by size, in kilobytes.
  32.  SumDisk abbreviates names to a maximum of 39 characters.
  33.  
  34.  You can deviate from the default screen by choosing to:
  35.  
  36.     » Sort the list by name instead of size (F2).
  37.     » Display the Primary Directory list, which includes all directories in
  38.       root totalled with their subdirectories (Ctrl-F1).
  39.     » Display the Files list (Alt-F1).
  40.     » Display full pathnames and erase the size gauge (F5).
  41.     » Express the disk space used in either bytes or percent of disk (F3).
  42.  
  43.  The size gauge always keys on the largest disk unit being displayed, whether
  44.  directory, primary directory, or file.  It is 25 characters wide for the
  45.  largest unit and proportionally smaller on all others.
  46. --------------------------------------------------------------------------------
  47.  FUNCTION/CONTROL KEY USAGE
  48.  F1        Call upon Help Screens.
  49.  Shift-F1  Select the Directories List.
  50.  Ctrl-F1   Select the Primary Directories List.
  51.  Alt-F1    Select the Files List.
  52.  F2        Toggle the list's sorting between By Size and By Name.
  53.  F3        Toggle the disk space units between Kb Space, Bytes, and Disk %.
  54.  F4        Toggle the list's spacing between Double and Single spacing.
  55.  F5        Toggle the display between the Size Gauge with abbreviated names
  56.            and no Size Gauge but full names.
  57.  F6        Display Miscellaneous Information about this drive.
  58.  F7        Search for a Name (sub)string.
  59.  Shift-F7  Search for the next file Duplicate.
  60.  Ctrl-F7   Search for the next file marked to Delete.
  61.  Alt-F7    Repeat the latest Search.
  62.  F8        Do a Quick Duplicate check.
  63.  Shift-F8  Do an Exact Duplicate check.
  64.  F9        Toggle the Color Scheme.
  65.  F10       Initiate Output of audit results to file(s).
  66.  
  67.  Ctrl-D    Select a file to mark/unmark for deletion.
  68.  Ctrl-V    Select a file to view.
  69.  Ctrl-X    Exclude the largest file from the Files list.
  70. --------------------------------------------------------------------------------
  71.  COMMAND LINE OPTIONS
  72.  With one exception, command line switches must begin with a '/' or a '-' 
  73.  token.  SumDisk interprets only the first character in the switch and
  74.  ignores case.  For example, '/D' produces the same results as '-dir'.  Any
  75.  switch without a token is accepted as the requested drive(s) to audit.
  76.  
  77.  C:            Audit drive C:.  (version 2.11 can audit 2 drives at once)
  78.  /Color=n      On color monitors, use color scheme 'n'. ('n' can be 0 to 5)
  79.  /Dir          Produce lists for only directories and primary directories.
  80.  /Exclude=...  Compile a Files list, excluding files matching the comma-
  81.                separated wildcards (up to 5).
  82.  /Files=n      Compile a Files list with a maximum of 'n' entries.
  83.  /Include=...  Compile a Files list, including only files matching the 
  84.                comma-separated wildcards (up to 5).
  85.  /SkipLow      Skip low-level disk access.  Useful for auditing non-standard
  86.                drives, and for maximizing the number of files listed.
  87.  /Xclude=...   Compile a Files list, excluding files matching the wildcards.
  88.  
  89.  Example:  sumdisk c:,d: /c=3 /f=100 /x=*.exe,*.zip
  90.  
  91.  Meaning:  Do an audit on drives C: and D:.  Display it in color scheme 3.
  92.            Develop a list of up to the 100 largest files which are neither
  93.            .EXE nor .ZIP files.
  94. -------------------------------------------------------------------------------
  95.  SEARCHING
  96.  Name Search (F7) will prompt you for a text string.  SumDisk will find
  97.  the next occurrence of that string within the names in the presently
  98.  displayed list.
  99.  
  100.  Duplicate Search (Shift-F7) will locate and display the next marked
  101.  duplicate in the Files list.
  102.  
  103.  Delete Search (Ctrl-F7) will locate and display the next file marked
  104.  for deletion.
  105.  
  106.  Repeat Search (Alt-F7) will repeat the most recent search.  SumDisk
  107.  remembers whether it was a Name Search, Duplicate Search, or Delete Search.
  108. --------------------------------------------------------------------------------
  109.  QUICK/EXACT DUPLICATES
  110.  SumDisk identifies file duplicate sets by marking the file entry with a
  111.  lowercase character.  File neighbors with the same character are probable
  112.  or definite duplicates, depending upon whether Quick Duplicates or Exact
  113.  Duplicates was used.
  114.  
  115.  Quick Duplicates (F8) almost instantly marks probable duplicate file sets.
  116.  It marks files with the same size, time stamp, and date stamp.  This is
  117.  usually, but not always, accurate.  NOTE:  commercial software packages
  118.  often include support files that have subtle differences but pass Quick
  119.  Duplicates' tests (for example, device drivers).
  120.  
  121.  Exact Duplicates (Shift-F8) does a byte-by-byte file comparison of all
  122.  files of the same size.  It will accurately mark duplicate file sets.
  123.  However, the process may take up to several minutes, depending upon how
  124.  many entries must be compared.
  125.  
  126.  In a long Files list, use Duplicate Search (Shift-F7) to review your
  127.  duplicate file sets.
  128. --------------------------------------------------------------------------------
  129.  OUTPUTTING RESULTS
  130.  SumDisk maintains separate lists for directories, primary directories, and
  131.  files.  Each list can be sorted by either name or size.  The Output option
  132.  lets you store the drive's audit results in new files, one for each of the
  133.  lists.  The files may include the by-size sort, the by-name sort, or both.
  134.  The approximate size of the complete output file (with both by-size and
  135.  by-name sorts) is given at the bottom of the box.
  136.  
  137.  The default names for these three files are SUMDISK.DIR, SUMDISK.PRI, and
  138.  SUMDISK.FIL, but you can change them to any valid DOS file name. If you
  139.  don't wish one of the lists, simply blank out its file name in the prompt
  140.  box by pressing <Esc> and then <Enter>.
  141.  
  142.  If you want to print any of the lists, type in the printer device name.
  143.  For most users, this is "PRN" or "LPT1".  If your printer is attached to
  144.  a serial port, the device name is probably "COM1".
  145.  
  146.  
  147.  NOTE:  A complete Files list can be more than a quarter megabyte!  You can
  148.  limit the size by using the /Files switch on the command line, by 
  149.  requesting an output list of only the by-size sort or the by-name sort, or
  150.  by requesting only the duplicate file sets.
  151. --------------------------------------------------------------------------------
  152.  DELETING FILES
  153.  You can use either the mouse or the menus to delete files.  Using the
  154.  mouse is easier!
  155.  
  156.  While viewing a Files list, you may mark a file for deletion simply by
  157.  clicking on its name with the RIGHT mouse button.  SumDisk highlights the
  158.  item and places a 'D' at the left edge.  Clicking a second time removes
  159.  the delete mark.
  160.  
  161.  If you don't have a mouse, call upon the 'Mark/Unmark to Delete' option
  162.  in the Options menu.  Then simply move the highlight bar to the file you
  163.  wish to mark/unmark, using the arrow keys, and press <Enter>. The keyboard
  164.  shortcut for the menu item is Ctrl-D.
  165.  
  166.  After you have marked several files for deletion, you can review them by
  167.  using Delete Search (Ctrl-F7).
  168.  
  169.  When you're ready to delete the files you've picked, select
  170.  'Delete Marked Files' from the Options menu.  SumDisk will ask you to
  171.  confirm that you wish to delete all marked files.
  172. --------------------------------------------------------------------------------
  173.  VIEWING FILES
  174.  You can use either the mouse or the menus to view a file.  Using the
  175.  mouse is easier!
  176.  
  177.  If you have a mouse, simply click on the name of any file in the Files
  178.  list with the LEFT mouse button.  SumDisk will display the file, a
  179.  screenful at a time, in text mode.
  180.  
  181.  If you don't have a mouse, call upon the 'Pick File to View' option in the
  182.  Options menu, move the highlight bar to the file you wish to see, and
  183.  press <Enter>.  You can use Ctrl-V as a keyboard shortcut.
  184. --------------------------------------------------------------------------------
  185.  CLUSTERS, SECTORS, AND BYTES
  186.  Every file on your disk consists of a set of characters, or 'bytes'.  They
  187.  may be common symbols, such as the alphabet, numerals, and punctuation, or
  188.  they may be unfamiliar, specialized characters.  Each letter, numeral, or
  189.  other symbol is stored as a single byte.
  190.  
  191.  DOS, the Disk Operating System, packages your files in chunks it can readily
  192.  access.  These 'sectors' normally contain 512 bytes.  If your file has 513
  193.  bytes, DOS stores it in two sectors.  You lose the use of the remaining 511
  194.  bytes in that second sector.  These lost bytes are 'slack' file space.
  195.  
  196.  On many disks, there may be so many sectors that DOS would have difficulty
  197.  keeping track of every one.  To simplify bookkeeping on your directories and
  198.  files, DOS groups two or more sectors into 'clusters'.  That 513-byte file
  199.  is stored in one cluster, and the space required depends on how large the
  200.  disk's cluster is.  Display Miscellaneous Information (F6) to see the
  201.  present cluster size.  SumDisk converts counts of clusters of any size into
  202.  kilobytes of space, a more familiar measure (two 512-byte sectors).
  203.  
  204.  SumDisk records disk space usage in both kilobytes and bytes.  Since space
  205.  used is most accurately measured in kilobytes, all lists are sorted that
  206.  way.  Directories may APPEAR to be sorted wrong with space usage shown in
  207.  bytes.  Press F3 to show kilobytes to confirm that they are sorted properly.
  208. --------------------------------------------------------------------------------
  209.  SCROLLING THROUGH THE LIST
  210.  With the keyboard:
  211.  
  212.     Home              Top of the list
  213.     End               End of the list
  214.     Page Up           Up one screen
  215.     Page Down         Down one screen
  216.     Up/Down arrows    Up/down one item
  217.  
  218.  With the mouse:
  219.  
  220.     Click and drag the slider to reposition within the list.
  221.  
  222.     Click above/below the slider to move up/down one screen.
  223.  
  224.     Click on the up/down arrow to rapidly scroll through the list.
  225. --------------------------------------------------------------------------------
  226.  SET DEFAULT CONFIGURATION
  227.  SumDisk's audit and presentation format can be customized through command-
  228.  line switches and function key/menu selections.  You can, for example,
  229.  choose to view any of the three disk element lists; use any of six color
  230.  schemes; display in single or double spacing; etc.
  231.  
  232.  If your preferences for initial settings are different than SumDisk's
  233.  defaults, you can define your own.  SumDisk will create a configuration
  234.  file and use it when doing later audits.  Using the Change Default
  235.  Configuration choice in the Options menu, you can set the following items
  236.  when defining your own configuration values:
  237.  
  238.         Color scheme
  239.         Unit of measuring disk space   (bytes, kilobytes of space, percent)
  240.         Disk element list   (directories, primaries, files)
  241.         Line spacing   (single, double)
  242.         Option to skip low-level disk access
  243.         Maximum Files list entries
  244.  
  245.  NOTE:  After you have created your configuration file, you can still
  246.  override all of these items with command-line switches.  The first four
  247.  can also be adjusted while you are reviewing an audit.
  248. --------------------------------------------------------------------------------
  249.  
  250.