home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archives / ForCLI / DD.lha / DD / DD.doc < prev    next >
Encoding:
Text File  |  1993-08-28  |  15.0 KB  |  427 lines
  1.  
  2.                         DD - Directory Scanner 1.0
  3.  
  4.                (c) 1993 Martin Mares, MJSoft System Software
  5.  
  6. ============================================================================
  7.  
  8.  
  9.   Preface
  10.   =======
  11.  
  12.    DD and its documentation is Copyright (c) Martin Mares, MJSoft System
  13. Software, Prague, Czech Republic.
  14.  
  15.    This  archive  can be freely redistributed, as long as all of its files are
  16. included   in   their  original  form  without  any  additions,  deletions  or
  17. modifications, and no more than a nominal fee is charged for its distribution.
  18. All  copyright  notices  in  the programs and accompanying documentation files
  19. must  remain  on  their places.  Also '.displayme' and other similar files may
  20. not be added.  This is generally known as FREEWARE.
  21.  
  22.    Special  permission is given to Fred Fish to distribute this program on his
  23. "Fish Disks".
  24.  
  25.    This  software  is  provided  "AS  IS" without warranty of any kind, either
  26. expressed  or implied.  The author is not responsible for any damage caused by
  27. it.
  28.  
  29.  
  30.   Contents
  31.   ========
  32.  
  33.     1. Introduction
  34.     2. Command line syntax
  35.     3. Display options
  36.     4. Analysis options
  37.     5. Sort options
  38.     6. Other options
  39.     7. Abbreviations
  40.     8. Output format
  41.     9. Statistics
  42.    10. Remarks
  43.  
  44.  
  45.   1. Introduction
  46.   ===============
  47.  
  48.    DD  is something like DIR or LIST.  But it does much more.  It can use many
  49. different types of file lists, sort file lists, analyse file contents, display
  50. statistics, search for identical files and so on.  Unless otherwise specified,
  51. DD scans and displays full subdirectory structure.
  52.  
  53.    DD can work in two modes:  quick and normal.  Quick mode uses direct access
  54. to the disk and is significantly faster, but it can be used only with standard
  55. Amiga  formats (OFS and FFS).  DD will choose this mode automatically whenever
  56. it's  possible.   Normal mode uses standard DOS calls and can be used with any
  57. filesystem.  You can force DD to use this mode using option NOFAST.
  58.  
  59.    DD  requires  kickstart  1.0  or  higher  and the arp.library (true arp, it
  60. doesn't  work  with  suspicious  arp  replacements  for  kickstart 2.0).  File
  61. analysis requires the analyser.library, which is included in this archive.
  62.  
  63.  
  64.   2. Command line syntax
  65.   ======================
  66.  
  67.    DD can be run only from CLI, not from Workbench. All parameters are
  68. supplied in the command line in one of following formats:
  69.  
  70.    (1)   DD [<options>]          (lists current directory)
  71.    (2)   DD <path> [<options>]        (lists specified directory)
  72.    (3)   DD <path+pattern> [<options>]    (find files, which match the pattern)
  73.    (4)   DD <filename> [<options>]    (analyse specified file)
  74.  
  75.      - If you want to search for one file, you can specify it using
  76.        character classes.  For example:  file "Columns" can be found using
  77.        "Column[s]".
  78.  
  79.    DD  also  supports  definition  of a default environment variable called
  80. DDOPT  (both  standard  and  ARP  variables).  You can store your favourite
  81. options  to  this  variable and DD will use them as defaults.  The defaults
  82. can  be overriden by command line options (if you have DDOPT=sort n and you
  83. wish  to  sort  by  size, simply enter DD sort s).  Default switches can be
  84. disabled using '-' followed by switch name (for example DD -HIDESUB)).
  85.  
  86.  
  87.   3. Display options
  88.   ==================
  89.  
  90.    You can use any of following display options:
  91.  
  92.    (1)   NAMES - Display only file names. Followed by type of names:
  93.                  R (Relative) - display names with path relative to current dir.
  94.                  F (Full) - display file names with full path.
  95.                  P (Plain) - display only file names
  96.  
  97.    (2)     COL - Display file names in columns. Directories will be enclosed
  98.                  in '[' and ']'.
  99.  
  100.    (3) LFORMAT - User-defined display type. Followed by string, which
  101.                  describes this format. String can contain:
  102.                    %f (Full) - insert file name with full path on this place
  103.            %r (Relative) - insert file name with relative path
  104.            %s - same as %r (for compatibility with LFORMAT option
  105.             in LIST command)
  106.                    %p (Plain) - insert file name without path
  107.                    %a (Analysis) - insert result of analysis
  108.                    %c (Comment) - insert file comment
  109.                    %% - Insert single '%' character
  110.  
  111.    (4)   QUIET - Don't display any file list.
  112.  
  113.    (5)    TREE - Display files and directories with "tree" structure.
  114.  
  115.    (6)         - Default is the full display. It consists of file/dir names in
  116.          the first column, sizes (or <DIR> or <ContentsSize> if it's a
  117.          directory) and comments. In the "comments" column can be
  118.          displayed standard filenotes (introduced by the ":" sign) or
  119.          the analysis results.
  120.  
  121.         - Empty directories won't be displayed in pattern searching mode.
  122.  
  123.    The  file/directory  links  (with kickstart 2.0 or higher) are displayed
  124. only  in  modes  (5)  and  (6), but they are properly included in the final
  125. statistics independently on their visibility.
  126.  
  127.  
  128.   4. Analysis options
  129.   ===================
  130.  
  131.    If  you  decide to use the analysis, you should specify your requirement by
  132. using  "ANA"  option  followed  by  single  letter  indicating the type of the
  133. analysis and (optionally) by the list of letters specifying requested analysis
  134. reports.
  135.  
  136.   Types of analysis:
  137.      (for better informations on speed see the Speed Statistics section)
  138.  
  139.    (1) S (Simple) - analyses only file names. It may cause some mistakes in
  140.             analysis result (for example if you have an executable file
  141.             named ghost.asm). But it's very fast - it adds only few
  142.             seconds to the directory scan time.
  143.  
  144.    (2) C (Contents)-analyses only file contents. It is the most reliable method
  145.             of analysis, but it doesn't find all file types. It's very
  146.             slow in Normal mode (because a lot of file operations must
  147.             be done).
  148.  
  149.    (3) G (Good)   - mostly analyses only file names, but if it doesn't give
  150.             any usable result, the file contents analysis is used.
  151.             Faster than Contents mode.
  152.  
  153.    (4) F (Full)   - both analysis methods (file names and file contents) are
  154.             used. Then the analyser selects better of the results.
  155.  
  156.       These analysis types can be followed by the 'R' (Reliable) option. It
  157.     disables all non-reliable analysis results (PCX Picture etc.).
  158.  
  159.   Types of reports:
  160.  
  161.    (1) S (Stat)   - display all used file types in alphabetical order,
  162.             followed by number of files of this type and percentage.
  163.  
  164.    (2) Q (Quantity) display all used file types as in S(tat) report, but
  165.             sorted in quantity order.
  166.  
  167.    (3) M (Max)    - as Q(uantity) report, but displays only file types with
  168.             number of files greater than 5 percent of scanned area.
  169.  
  170.    (4) D (Dir)      - display mostly used file type in each directory. Can be
  171.             used only in default display mode.
  172.  
  173.    (5) Y (System) - analyse system files. Test, if they are present on the
  174.             system disk.
  175.  
  176.  
  177.   5. Sort options
  178.   ===============
  179.  
  180.    Sorting  can  be  switched  on  using the SORT option followed by a string,
  181. which  describes  sort  order.  The string consists of letters specifying data
  182. items,  which  can  be  prefixed  by the '^' character indicating reverse sort
  183. order.
  184.  
  185.    (1) D (Dirs)   - sort directories first, files last.
  186.  
  187.    (2) S (Size)   - sort files incrementally by the size. Directories are
  188.                     sorted by size of their contents in the STAT mode, else are
  189.                     placed first (their size is assumed as 0)
  190.  
  191.    (3) N (Name)   - sort by file name.
  192.  
  193.    (4) E (Ext.)   - sort by file extension (file name part after '.'),
  194.             files without extension are at first places.
  195.  
  196.    (5) P (Path)   - sort by file name with full path.
  197.  
  198.    (6) A (Analysis)-sort by analysis result, files without analysis report
  199.             are at last places.
  200.  
  201.  
  202.   6. Other options
  203.   ================
  204.  
  205.    (1) NOFAST  - don't use Quick mode. Mostly usable for speed comparisons.
  206.          Also can be used if the Quick mode doesn't work (it should
  207.          NOT happen).
  208.  
  209.    (2) NOHEAD  - don't print the header and footer of the dump.
  210.  
  211.    (3) HIDESUB - don't display contents of subdirectories.
  212.  
  213.    (4) STAT    - display size of files in subdirectories. Only for Full
  214.          display mode.
  215.  
  216.    (5) BYTES   - display all file/media sizes in bytes instead of KB or MB
  217.          (choosen automatically)
  218.  
  219.    (6) DIRS    - display names of subdirectories in the dump.
  220.  
  221.    (7) MERGE   - merge all subdirectories to the main directory. Can be used
  222.          to sort ALL files by size and so on.
  223.  
  224.    (8) NOCOM   - don't scan file comments.
  225.  
  226.    (9) FIDENT  - find identical files on the disk.
  227.  
  228.   (10) ANAFILT - use analysis filter. Display only files with analysis result
  229.                  matching given pattern. Don't forget that '*' sometimes has
  230.                  special meaning in ARP argument parsing.
  231.  
  232.  
  233.   7. Abbreviations
  234.   ================
  235.  
  236.    The most of options can be abbreviated:
  237.  
  238.      NOFAST -> NF        NOHEAD -> NH        ANAFILT -> AF
  239.       NAMES -> N           COL -> C        LFORMAT -> L
  240.       QUIET -> Q          TREE -> T           STAT -> ST
  241.     HIDESUB -> H         BYTES -> B           SORT -> S
  242.         ANA -> A          DIRS -> D          MERGE -> M
  243.       NOCOM -> NC        FIDENT -> FI
  244.  
  245.  
  246.   8. Output format
  247.   ================
  248.  
  249.    DD output consists of:
  250.  
  251.     (1) The header in form "Analysis of <dir> on volume <vol>"
  252.         <dir> - directory name
  253.         <vol> - volume name
  254.  
  255.     (2) The subheader in form "Device: <dvc>,<fs>,<acc> - Size <sz> - Free <fr>"
  256.         <dvc> - name of device which contains the volume
  257.          <fs> - identification of used file system
  258.             OFS - standard (old) file system
  259.             FFS - FastFileSystem
  260.         OFS-I,FFS-I - international version of OFS/FFS
  261.         OFS-C,FFS-C - directory cache version of OFS/FFS
  262.              FFS-1K - FastFileSystem with 1K data blocks (RAM: on 2.0)
  263.               MSDOS - MSDOS File System (CrossDos ...)
  264.            MSDOS/DD - MSDOS File System with Double Stepping (5.25", DD)
  265.             ?FS - unknown file system
  266.              /QUICK - Quick mode will be used
  267.         <acc> - access type
  268.              READ/WRITE - you can do everything you can
  269.               READ ONLY - you can only READ this volume
  270.               NOT VALIDATED - this volume is not validated, the volume
  271.                       free space information isn't available
  272.          <sz> - volume size in bytes (or KB or MB)
  273.          <fr> - free volume space in bytes (/KB/MB) and percents of
  274.             the volume capacity
  275.  
  276.     (3) The file list in format selected by Display options
  277.  
  278.     (4) The analysis reports selected by Analysis options
  279.  
  280.     (5) The analysis statistics (if there's any analysis report), which
  281.     contains number and percentage of classified files.
  282.  
  283.     (6) The system files analysis report. It's a list of system modules
  284.     (libraries, devices, handlers, ...) found in scanned area. Each of the
  285.     files can be described by:
  286.            Length: <ll>        - file size
  287.        Id: <id>        - resident module identification string
  288.        SysId: <id>        - id. string of this module on the system disk
  289.                   (displayed only in some cases)
  290.        Version: <ver>    - resident module version
  291.     It is followed by a message saying something about presence of this
  292.     file on your system disk.
  293.  
  294.     On the end, there can be a final classification if there's some file
  295.     newer than on your system disk or if DD can't say it's same or older.
  296.  
  297.     (7) The file identity report. It consists of a list of empty files and a
  298.     list of duplicates followed by statistics saying how many duplicates
  299.     are there and how many bytes is in them.
  300.  
  301.     (8) The final statistics in form
  302.       "<f> files in <d> dirs - <s> - <p> % of disk - <sl> in slacks"
  303.           <f> - number of files
  304.           <d> - number of directories
  305.           <s> - total size of files
  306.           <p> - how many percents of the disk occupies analysed
  307.             file and directory structure
  308.          <sl> - how many bytes and percents of data area are in "slacks"
  309.             (Slacks are the fragments of data blocks, which contain
  310.             no data)
  311.  
  312.     <p> and <sl> is displayed only for standard OFS and FFS devices, but
  313.         not for the 1.3 RAM: device.
  314.  
  315.       - the <sl> field may contain slightly non-reliable results for
  316.         disks with 1.3 FFS (especially harddisks), but only when the
  317.         QUICK mode is not used.
  318.  
  319.  
  320.   9. Statistics
  321.   =============
  322.  
  323.    This section describes how fast and how memory intensive are the tasks
  324. performed by DD.
  325.  
  326.  
  327.                            *** SPEED STATISTICS ***
  328.  
  329.    All  time  values  include  DD  loading  time  and are measured by the Stat
  330. utility  with DD in QUIET mode.  (These values are for some ancient version of
  331. DD, this version should give better results)
  332.  
  333.  
  334.   Pure scanning:
  335.  
  336.   Quick Mode    Normal Mode    Media
  337.   ---------------------------------------------------------------------------
  338.   50.5 s    93.2 s        HD,FFS,43M,93% full,5739 files,259 dirs
  339.   12.8 s    43.9 s        FD,OFS,838K,98% full,124 files,12 dirs
  340.   10.4 s    28.9 s        FD,OFS,838K,98% full,55 files,19 dirs
  341.   14.4 s    69.4 s        FD,OFS,838K,79% full,197 files,12 dirs
  342.    0.5 s     8.4 s        FD,OFS,838K,84% full,2 files,2 dirs
  343.    2.2 s     2.3 s        FD,FFS,902K,99% full,10 files,2 dirs
  344.  
  345.  
  346.   Sorting of HD (43M,93% full,5739 files,259 dirs):
  347.  
  348.   Criteria    Sort Time
  349.   ---------------------------------------------------------------------------
  350.   Name         9.8 s
  351.   Extension    15.8 s
  352.   Path        38.9 s
  353.   Size         3.7 s
  354.   Ext,Size    20.9 s
  355.  
  356.  
  357.   Analysis of HD (43M,93% full,5739 files,259 dirs):
  358.  
  359.   Analysis Type        Quick Mode    Normal Mode
  360.   ---------------------------------------------------------------------------
  361.   Simple         69.0 s        111.5 s
  362.   Contents        125.0 s        590.4 s
  363.   Good            115.8 s        452.3 s
  364.   Full            143.0 s        <not measured>
  365.   Simple + Sort         74.4 s        <not measured>
  366.  
  367.  
  368.   Searching for Identical Files (Output to RAM:)
  369.  
  370.   Quick Mode    Normal Mode    Media
  371.   ---------------------------------------------------------------------------
  372.   362.0 s    731.5 s        HD,FFS,43M,93% full,5739 files,259 dirs
  373.    21.5 s     51.2 s        FD,OFS,838K,98% full,124 files,12 dirs
  374.  
  375.  
  376.                        *** MEMORY USAGE STATISTICS ***
  377.  
  378.   (Measured by the Stat utility, includes size of DD)
  379.  
  380.   Pure scanning of HD (43M,93% full,5739 files,259 dirs,Quick):    310218 B
  381.   Pure scanning of HD (43M,93% full,5739 files,259 dirs):    287566 B
  382.   Pure scanning of FD (OFS,79% full, 197 files, 12 dirs,Quick):     33612 B
  383.   Pure scanning of FD (OFS,79% full, 197 files, 12 dirs):     32622 B
  384.   Any Analysis  of HD (43M,93% full,5739 files,259 dirs,Quick): 437690 B
  385.   Any Analysis  of HD (43M,93% full,5739 files,259 dirs):    415038 B
  386.   FIDENT        on HD (43M,93% full,5739 files,259 dirs,Quick):    442130 B
  387.   FIDENT        on HD (43M,93% full,5739 files,259 dirs):    314662 B
  388.  
  389.  
  390. 10. Remarks
  391. ===========
  392.  
  393.  - Send all comments and bug reports to mjsoft@k332.feld.cvut.cz.
  394.  
  395.  
  396.                           ??? IN FUTURE VERSIONS ???
  397.  
  398.  - There will be some output buffers -> faster output.
  399.  
  400.  - Analyser will recognise more file types.
  401.  
  402.  - Report of the FIDENT option will be sorted by file name instead of file
  403.    size.
  404.  
  405.  - There will be some file output (?)
  406.  
  407.  
  408.                                 *** THANKS ***
  409.  
  410.  - To Vojtech Pavlik for some ideas in his DD for PC.
  411.  
  412.  - To Tomas Zikmund, Pavel Troller, Petr Cisar, Karel Zatloukal, Jan Kratochvil
  413.    and many other people for beta-testing and suggestions.
  414.  
  415.  - To Amiga hardware for all...
  416.  
  417.  - To Amiga operating system for his geniality.
  418.  
  419.  - To BCPL for a lot of suspicious things.
  420.  
  421.  - To the slow movement of drive heads for the idea of my caching algorithms.
  422.  
  423.  
  424.                                  *** END ***
  425.  
  426. ================================================================================
  427.