home *** CD-ROM | disk | FTP | other *** search
/ Best Objectech Shareware Selections / UNTITLED.iso / boss / util / disk / 005 / dcat.doc next >
Text File  |  1993-05-05  |  16KB  |  340 lines
  1.  
  2.  
  3.                         ######   #####                 
  4.                         #     # #     #    ##     #####
  5.                         #     # #         #  #      #  
  6.                         #     # #        #    #     #  
  7.                         #     # #        ######     #  
  8.                         #     # #     #  #    #     #  
  9.                         ######   #####   #    #     #  
  10.  
  11.  
  12.  
  13.  
  14. You can get part of the following documentation by invoking the program with
  15. the switches -v, -h, or -H . See README.TXT for more information.
  16.  
  17. -----------------------------------   -v   ------------------------------------
  18. DCAT v1.0 -- Disk Cataloger
  19. Copr (c) 1993 Richard Breuer. DCAT is freeware. No warranties.
  20.  
  21. This is DCAT v1.0 (from RUTILS 4).
  22.  
  23. Author: Richard Breuer
  24.         Brunssumstrasse 6
  25.         5100 Aachen
  26.         (after Jul 1, 1993: 52074 Aachen)
  27.         Germany
  28.         Europe
  29.  
  30. Phone:  +49/241/85605
  31. Fax:    +49/241/8021329
  32.  
  33. Email:  ricki@pool.informatik.rwth-aachen.de (Preferred!)
  34.  
  35. -----------------------------------   -h   ------------------------------------
  36. DCAT v1.0 -- Disk Cataloger
  37. Copr (c) 1993 Richard Breuer. DCAT is freeware. No warranties.
  38.  
  39. Usage:   DCAT [-acf:hHnqv*] command [parameter]
  40.  
  41. Commands (default d: is A:):
  42.    Add/Update   [d:]    Read the diskette in drive d: and update the catalog
  43.    Cat/Volumes  [vol]   Display a list of all catalogued diskettes named vol*
  44.    Dir/List     [vol]   List all diskettes with a label vol*
  45.    Find         str     Find *str* in Filenames or comments (case insensitive)
  46.    Multi        [d:]    Do a multiple "DCAT Add", asking for disk changes
  47.    Remove    vol    Remove all diskettes with label vol* from the catalog
  48.    Sum                Some statistics
  49.  
  50. Options (default is -fC:\RUTILS\NEWUTILS\DCAT.DAT):
  51.    -a        Find/Dir give as much info as possible (instead of a nice format)
  52.    -c         Check all files for archive comments, regardless of extensions
  53.    -f<catf>  Use catf as catalog file
  54.    -h,-H     Display a help screen (-h: this) (-H: notes and examples)
  55.    -n        Don't extract comments from archive files or DESCRIPT.ION
  56.    -q        Be quiet. Supress informative messages
  57.    -v        Display version info and information about the author
  58.    -*        Display internal information (for debugging purposes)
  59.  
  60. -----------------------------------   -H   ------------------------------------
  61. DCAT v1.0 -- Disk Cataloger
  62. Copr (c) 1993 Richard Breuer. DCAT is freeware. No warranties.
  63.  
  64. Notes:
  65.    The output is always directed to stdout. Each diskette which shall be
  66.    cataloged, must have a label. DCAT automagically extracts comments from
  67.    some archive files (currently ARJ, ZIP, ZOO). Besides, it scans 4DOS
  68.    DESCRIPT.ION files. The errorlevel is set to 1 if help has been displayed.
  69.    It is set to 255 in case of an error and 0 on normal completion. The
  70.    commands may be abbreviated, as long as they are not ambiguous. 'Remove' may
  71.    not be abbreviated. Only drives A: and B: are supported. The maximum number
  72.    of files per disk is 512.
  73.  
  74. Examples:
  75.    DCAT Add
  76.       Add A: to the catalog.
  77.    DCAT dir uTiL
  78.       Show all diskettes whose label starts with UTIL, ie. UTIL1, UTILITIES...
  79.    DCAT Multi B:
  80.       Add several disks to the catalog, starting with drive B:. You may inter-
  81.       actively change the drive whenever the disk must be changed.
  82.    DCAT CAT a
  83.       List all diskettes which names begin with 'A'.
  84.  
  85. -------------------------------------------------------------------------------
  86. Additional information:
  87. -----------------------
  88.    It was Jari Kokko (jkokko@snakemail.hut.fi) who inspired me to write DCAT.
  89.    He sent me his public domain FLOP program, which has a similar commands. I
  90.    used his ideas of an ASCII catalog file and a command driven interface and
  91.    rewrote the program from scratch, mainly for these reasons:
  92.  
  93.         - it was fun
  94.         - I extended the catalog file format by the following data:
  95.           disk size, used bytes on a disk, free bytes, number of files,
  96.           file size, file date, file attributes, archive file comments
  97.         - I was able to use my basic programming layer containing the
  98.           user interface modules, so that DCAT behaves like every other
  99.           RUTILS program
  100.     - I extended the program by the archive file comment extraction
  101.           and the DESCRIPT.ION file scanning (thanks to Jouni Miettunen
  102.           (jon@stekt.oulu.fi) for the latter suggestion)
  103.  
  104.  
  105. Comment extraction:
  106. -------------------
  107.    DCAT has the ability to find comments for files which are catalogued. It
  108.    can handle two different comment types:
  109.  
  110.         - Some archive formats allow so-called "archive file comments", as
  111.           there are ZIP, ZOO, and ARJ archives (others are currently not
  112.           supported - if you got information on how to extract comments from
  113.           other file types, feel free to contact me). DCAT reads these files
  114.           and tries to extract the archive file comment, unless the -n option
  115.           is given. If this is successful, the comment is stored in the
  116.           catalog file and can be used to DCAT FIND strings.
  117.  
  118.         - Another possibility for file comments is the 4DOS DESCRIPT.ION file,
  119.           which is (optionally) created in a directory and contains information
  120.           about all the files in it. If DCAT locates such a file on a diskette
  121.           directory, it reads it and assigns the comments contained in it to
  122.           the files. NOTE, that the DESCRIPT.ION comments OVERRIDE the archive
  123.           file comments (since they are definitly placed there on purpose
  124.           whereas the archive file comments may be put there by someone else).
  125.  
  126.  
  127. Using more than one catalog file:
  128. ---------------------------------
  129.    There are two ways of using different catalog files. The first is to use
  130.    the -f option to specify it (this should be clear).
  131.  
  132.    The second way is based on the fact that DCAT always uses the catalog file
  133.    which (1) stands on the same directory as DCAT.EXE and (2) has the same file
  134.    name as the executable, ie. DCAT by default. Now consider the following: You
  135.    rename C:\BIN\DCAT.EXE (which uses the catalog file C:\BIN\DCAT.DAT) to, say,
  136.    D:\SYS\CATALOG.EXE. The 'new' executable does now expect its catalog file
  137.    to be D:\SYS\CATALOG.DAT. Therefore C:\BIN\DCAT.DAT should be renamed in the
  138.    appropriate way, ie. to D:\SYS\CATALOG.DAT.
  139.  
  140.    The consequences of this be behaviour are the following
  141.  
  142.         - <name>.EXE and <name>.DAT do always belong together (which I
  143.           find is a nice feature)
  144.         - You can use several catalog files by duplicating DCAT.EXE to eg.
  145.           DCUTIL.EXE, DCGAMES.EXE, and DCMISC.EXE, which will then use
  146.           the catalog files DCUTIL.DAT, DCGAMES.DAT, and DCMISC.DAT
  147.           respectively
  148.         - If you doubt which catalog file is used if you invoke DCAT, simply
  149.           call DCAT SUM, which tells you the name
  150.  
  151.  
  152. Trouble shooting:
  153. -----------------
  154.         - DCAT creates temporary files for certain commands. If you interrupt
  155.           it, eg. with CTRL/C, these files may remain on your harddisk. You
  156.           should delete them. They are named xxxxxxxx.TMP, where x are randomly
  157.           chosen decimal digits.
  158.  
  159.         - If you want to find out which catalog file is currently used by the
  160.           EXE file you start, type DCAT SUM, and you will see.
  161.  
  162.  
  163. An example session:
  164. -------------------
  165.    The following example session will show you DCATs features. We assume that
  166.    you have not used DCAT before. In this case you start without having a
  167.    catalog file. We assume further that you have 2 diskettes, one 5,25"
  168.    diskette for disk drive A:, and one 3,5" disk for drive B: (That's my
  169.    current configuration, BTW). We want to catalog two diskettes, which have
  170.    labels 'MISC 003' and 'UTILS 001':
  171.  
  172. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  173. C:> DCAT Add A:
  174. The catalog C:\RUTILS\NEWUTILS\DCAT.DAT does not exist!
  175. Ok to create a new catalog file ? [Yes No!] Yep
  176. Scanning Disk a