home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / compress / dred2307.lha / DRED.doc < prev   
Text File  |  1993-04-18  |  22KB  |  465 lines
  1. Please leave the next line intact for update patches to be applied later!
  2. $VER: DRED 2.003.007
  3.  
  4. DISCLAIMER:
  5.  
  6.                                 DISCLAIMER
  7.                                 ----------
  8. ALTHOUGH OUTSTANDING BUGS IN THE CODE HAVE BEEN ELIMINATED, THERE REMAINS
  9. THE POSSIBILITY OF UNFORESEEN PROBLEMS. I RESERVE THE RIGHT TO REFUTE THE
  10. EXISTENCE OF SUCH 'BUGS', BUT IF FOUND, WE WILL ATTEMPT TO FIX SUCH
  11. PROBLEM(S). IF, HOWEVER, UNFORESEEN BUGS ARE FOUND TO CAUSE YOU MENTAL
  12. AND/OR PHYSICAL ANGUISH, THEN THAT IS AS THEY SAY IN THE CLASSICS, BAD
  13. LUCK! I ACCEPT NO BLAME FOR ANY LOSS OR INCONVENIENCE FOUND TO ARISE FROM
  14. THE (MIS)USAGE OF THIS PROGRAM. I RESERVE THE RIGHT TO WITHDRAW SUPPORT
  15. AND UPGRADES AT ANY TIME. I PROBABLY WON'T DO THIS, BUT I HAVE THIS RIGHT.
  16.  
  17. Everything contained in this release of the DRED Disk-REDucer for the Amiga
  18. is USE-AT-OWN-RISK. We, the authors, make no guarantee as to the fitness
  19. for use of this software. We accept no responsibility for possible damages
  20. incurred before, during or after execution of this software.
  21.  
  22. ALL INSTANCES OF COMPANY AND/OR PRODUCT NAMES ARE (C), (R) AND (TM)
  23. RESPECTIVELY, WHERE APPLICABLE. "DRED" IS COPYRIGHT BOB RYE, 1992.
  24.  
  25.  
  26.  #### #    #### #### #### ####   #### #### #### ###    ##### #  # # ####   #
  27.  #  # #    #    #  # #    #      #  # #    #  # #  #     #   #  # # #      #
  28.  #### #    ###  #### #### ###    #### ###  #### #  #     #   #### # ####   #
  29.  #    #    #    #  #    # #      # #  #    #  # #  #     #   #  # #    #
  30.  #    #### #### #  # #### ####   #  # #### #  # ###      #   #  # # ####   #
  31.  
  32. *****************************************************************************
  33.  
  34.                    DID YOU PAY MONEY FOR THIS SOFTWARE?
  35.  
  36.                              DRED is FREEWARE
  37.  
  38.  This software is FREEWARE. This software is free. If you have paid
  39.  money for this software, then you have been ripped off. I have written
  40.  this program for you, for free. If you paid for "support" from where you
  41.  got this file, then you are also getting ripped off. There are only three
  42.  people who can fully help you with the operation of this program:
  43.  Brett O'Callaghan (my ideas man);
  44.  Marcus Mroczkowski (co-coder),
  45.  and myself (Bob Rye, the guy who wrote this program.)
  46.  
  47.  You cannot obtain support from some unqualified desk-doofus hiding behind
  48.  the facade of "a support specialist". All that these people are doing is
  49.  making money from you, the innocent end-user, and ripping me off by
  50.  immorally making money from *MY* programs.
  51.  
  52.  Please take a stand against these companies. Please don't buy *FREE*
  53.  software from these companies. If you would like copies of any (or all)
  54.  of MY software (anything by Bob Rye) you can have them for *FREE*. That's
  55.  right, for nothing. All I ask for is a blank disk, to copy the programs
  56.  onto, and the cost of return postage (and your address!) Then if you want
  57.  "support" for my programs, send Fido Netmail to me (addresses are at the
  58.  bottom of this document) or snail-mail me and you'll get real support.
  59.  
  60.                           STAND UP AND BE COUNTED.
  61.  
  62.                       Say NO! to costly FREE software.
  63.  
  64. *****************************************************************************
  65.  
  66. If you represent a PD/Shareware/Freeware library or electronic distribution
  67. system, then please feel free to contact me to gain written permission to
  68. allow you to legally include this software in your library, for
  69. distribution. The "ADS" electronic distribution system has my written
  70. permission to redistribute this software, as does Fred Fish.
  71.  
  72. You may copy and transfer copies of this package to whoever you like,
  73. provided that this package is transferred completely intact, with all
  74. documentation and executables unmodified therein (modification of
  75. copyrighted works is called "contributory copyright infringement" and
  76. persons found infringing copyright are liable to legal action); however,
  77. if you represent a registered (or otherwise) company, and you wish to
  78. redistribute this package, you MUST obtain my prior written permission.
  79. The copyright to DRED, the documentation, the source-code, and the actual
  80. software remains the explicit property of Bob Rye, © 1992.
  81.  
  82. ANY commercial distribution of this package without the prior written
  83. consent of the author (Bob Rye) is expressly prohibited.
  84.  
  85. DRED © BOB RYE (Thu Sep 24 18:22:34 1992)
  86.  
  87. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  88.                       * DRED - Disk REDucer v1.110 *
  89.                        Bob Rye & Marcus Mroczkowski
  90.                       Conceived by Brett O'Callaghan
  91.  
  92. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  93.  
  94.     What is DRED?
  95.     ~~~~~~~~~~~~~
  96.         DRED stands for Disk REDucer, it's a utility that can save you a
  97. lot of disks.  It does this is by making a list of files that you want to
  98. put onto a number of floppy disks, and working out what files should go
  99. where in order to minimize the number of disks needed.  DRED requires the
  100. superlative Nico François 'reqtools.library' in your LIBS:  directory.
  101.  
  102.     
  103.     What can it do for me?
  104.     ~~~~~~~~~~~~~~~~~~~~~~
  105.         Say that, like me, you're a compulsive collector of files,
  106. pictures, modules, archives, anything really.  Perhaps, like me, you have
  107. these files stored on X number of floppy disks.  Probably, like me, each of
  108. your disks have 5-50k of empty space on each because you couldn't fit
  109. anything else on them.  DRED will take these X number of disks, and reduce
  110. the number of disks to X-Y, with each disk having as little as 512 BYTES
  111. left on it.  Simply put, DRED will take your files and put them on floppy
  112. doing a best-fit as it goes along, so if you have 27K left on a floppy, and
  113. DRED can find three files that add up to 26.5K, it'll put these three files
  114. on the floppy leaving 1 block (512 bytes) free.  This is plainly going to
  115. save you disks.
  116.  
  117. NOTE:  DRED only scans and recognises files in the ROOT directory of a
  118. disk.  Directories and sub-directories from the root will NOT be recognised
  119. and/or scanned.
  120.  
  121.  
  122.     Wow!  How do I do it?
  123.     ~~~~~~~~~~~~~~~~~~~~~
  124.         There are two ways of using DRED, Hard-Disk mode (the default) or
  125. Floppy Mode.  If you have a HD then it is recommended you use it, if you
  126. don't, then floppy mode works, but involves heaps of disk-swapping.  You
  127. can now also obtain a hard-copy of everything that DRED copies for you.
  128.  
  129.     Usage.
  130.     ~~~~~~
  131. DRED [<-options>] <in-drive:/in-path> <out-drive:/out-path> <SFS/FFS>
  132.  
  133. where options =
  134.  
  135.     -f                    --   FLOPPY MODE, also known as DISK-SWAP mode 8^)
  136.  
  137.     -l                    --   LOG MODE, DRED will write a log-file called
  138.                                "LOGS:DRED.log". This means that to use the
  139.                                log mode, you will need to assign the LOGS:
  140.                                to somewhere applicable.
  141.                                (ie. assign LOGS: DH2:MAIL/LOGS) The log
  142.                                file is of this format:
  143.  
  144. # Mon Aug 03 10:44:00 1992  SESSION STARTED
  145. +   Mon Aug 03 10:44:04 1992  WRITING file: "c:scan" to "df0:scan"
  146. +   Mon Aug 03 10:44:54 1992  WRITING file: "c:Fountain" to "df0:Fountain"
  147. +   Mon Aug 03 10:45:02 1992  WRITING file: "c:ConfigOpus" to "df0:ConfigOpus"
  148. +   Mon Aug 03 10:45:25 1992  WRITING file: "c:shrink" to "df0:shrink"
  149. +   Mon Aug 03 10:45:31 1992  WRITING file: "c:CFX" to "df0:CFX"
  150. +   Mon Aug 03 10:45:41 1992  WRITING file: "c:multifind" to "df0:multifind"
  151. +   Mon Aug 03 10:45:47 1992  WRITING file: "c:TLStat" to "df0:TLStat"
  152. +   Mon Aug 03 10:45:51 1992  >> DISKCHANGE <<
  153.   [...]
  154.   [...]
  155.   [...]
  156. # Mon Aug 03 10:48:00 1992  SESSION FINISHED
  157.  
  158.                                "Session started" and "Session finished"
  159.                                starts a log line with the '#' character.
  160.  
  161.                                Standard log lines (incl. DISKCHANGE lines)
  162.                                start with the '+' character.
  163.  
  164.                                Error lines start with the '~' character.
  165.  
  166.                                DRED's log file manipulation is VERY safe
  167.                                and fairly time-inexpensive.
  168.  
  169.     -c                    --   NO COPYNOTE MODE, tells DRED NOT to apply a
  170.                                special filenote to the files that DRED has
  171.                                successfully copied, ie. the origin files.
  172.                                This filenote says "Successfully DREDed
  173.                                day/date/year time". By this filenote, you
  174.                                should be able to tell which files have been
  175.                                successfully DREDed from the origin dir. The
  176.                                default for this option is OFF, which means
  177.                                that DRED will, by default, apply a filenote
  178.                                to successfully copied origin files.
  179.  
  180.     -n                    --   NOCLONE MODE, tells DRED to reset all of the
  181.                                file's attributes after copying it. This
  182.                                means that using the NOCLONE mode, the
  183.                                file's protection flags will be reset to the
  184.                                original ---RWED format. The file's
  185.                                DateStamp will also be reset, showing the
  186.                                exact date and time that the file was DREDed.
  187.                                Also, (maybe importantly?) the file's
  188.                                filenote will be erased.
  189.  
  190.                                ** NOTE: DRED defaults to CLONE mode, meaning
  191.                                that DRED will make an identical copy of the
  192.                                origin file to the destination disk, by
  193.                                default. Special thanks to Chris Hames for
  194.                                lending his expert coding ability to someone
  195.                                without the new DOS RKMs.
  196.  
  197.     -s                    --   SUMMARY MODE, this will give you an idea how
  198.                                many standard AmigaDOS floppy-disks (SAFs)
  199.                                you'll need to store all of the data to be
  200.                                DREDed. This number is always given in SAFs
  201.                                as a measure of consistency. Occasionally
  202.                                when DREDing large files you may need an
  203.                                extra destination floppy. This happens
  204.                                rarely, although it's intelligent to remember
  205.                                that this is possible, so always be prepared
  206.                                to format another destination disk. See
  207.                                "What's in a drive-type?" below.
  208.                                 AKA "dry run".
  209.  
  210.     -v                    --   VERIFY destination file mode. Generally
  211.                                DRED, in conjunction with AmigaDOS (there is
  212.                                no DOS like it *;-) will trap a disk error.
  213.                                Even though this is the case, DRED has the
  214.                                ability to further verify the integrity of a
  215.                                destination file via this option.
  216.                                Immediately after writing the destination
  217.                                file, DRED will read the same file and report
  218.                                any errors found. You will then be given the
  219.                                option of continuing with the DRED process
  220.                                or the ability to quit. If you do decide to
  221.                                continue, the unstable file wil be removed
  222.                                from the destination disk. Please check
  223.                                "ERROR-HANDLING" below...
  224.  
  225.     in-drive:/in-path     --   The path to where your files are.
  226.  
  227.     out-drive:/out-path   --   The path to where your files will go.
  228.  
  229.     SFS/FFS               --   The type of disks you are putting your
  230.                                stuff on, SFS (Standard File System) ie.
  231.                                SLOOOW, or FFS (Fast File System) ie FAAAST.
  232.  
  233.  
  234.     What's in a drive-type?
  235.     ~~~~~~~~~~~~~~~~~~~~~~~
  236.         Generally, DRED thinks it is copying data to standard AmigaDOS
  237. floppy-disks (SAFs).  DRED was designed to be used this way.  DRED always
  238. knows how many free blocks there are available on the current destination
  239. disk/device.  But what happens if someone wants to DRED 20 meg of files
  240. from a hard-disk partition over to their SyQuest 44 megabyte removable
  241. cartridges?  When this person asks DRED for a summary, DRED will tell you
  242. how many SAFs will be needed to contain the outgoing 20 megabytes of data.
  243. Now, if you think hard enough, you will note that 20 megabytes of data WILL
  244. fit onto a 44 megabyte cartridge, so, the number of SAFs needed is not
  245. applicable.
  246.  
  247.          DRED does note the number of free blocks on the destination
  248. device, so when you start DREDing to your 44 meg cartridge, the number of
  249. free blocks will be known, and printed to the screen.  DRED will keep a
  250. block-count to a precision of +/- 1 block per SAF.  You shouldn't, at any
  251. time, run into a "DISK IS FULL" dos error.  If you do ever get a disk full
  252. error, then there is a good chance that you have inserted an SFS disk
  253. during an FFS session [note: DRED v 2.003.006+ now checks each disk
  254. inserted for the correct type. DRED will now inform you if the inserted
  255. media is of the wrong (ie. NOT REQUESTED) format!]. Please check the format
  256. of all disks that you will use with DRED.  DRED should ensure that data
  257. written to a device doesn't top the free blocks count.  You can even DRED
  258. files from one hard-disk partition to another, although this is clearly a
  259. stupid idea.  To summarise, DRED will figure out the size of the device you
  260. are copying to, and will keep a count of how many blocks remain free.  If
  261. this device fills up, and DRED asks you to remove and replace the current
  262. destination disk, you had better be using a removable medium, otherwise,
  263. you're stuck.  If you must manually "diskchange" the device upon insertion
  264. of new media, use a "POPCLI" to get to your system.
  265.  
  266.  
  267.     Suggested HD usage.
  268.     ~~~~~~~~~~~~~~~~~~
  269.         If you've got say, 25 disks of stuff you want to reduce, then copy
  270. as much of it as you can to a partition, if you can copy it all, then do
  271. it, as DRED works best with lots of files.  
  272.  
  273.         Ok, you've got a few hundred files on your HD in the directory
  274. DH3:TEMP (stunningly original name I know).  First, give the command -
  275.  
  276.  
  277.     dred -s DH3:temp df0: FFS
  278.  
  279.     
  280.         ie. Tell me how many disks I'll need if copying all the files in
  281. the directory DH3:temp to FFS disks in drive df0:
  282.  
  283.         DRED will now tell you roughly how many disks you will need.  Now,
  284. go and format that number of disks, plus a couple extra just in case.
  285. Remember to specify FFS format if that's what you're using.
  286.  
  287.         Ok, you've got the disks!  You're now ready to experience the magic
  288. of DRED!  Enter this command -
  289.  
  290.  
  291.     dred DH3:temp df0: FFS
  292.  
  293.  
  294.         Now, sit back and watch DRED do it's stuff, changing disks when
  295. asked/beeped.  That's it!  After DRED is finished doing it's stuff you'll
  296. have a number of disks with very little free on each, hopefully saving
  297. quite a few disks.
  298.  
  299.         The last disk in the sequence might have a fair bit left on it,
  300. just use this disk as the first disk in the sequence when you want to DRED
  301. some more files, as DRED first checks the disk to see how much room it has.
  302.  
  303.  
  304.     
  305.     Floppy usage.
  306.     ~~~~~~~~~~~~~
  307.         If you're a sucker for punishment, or just don't have a HD then you
  308. too can still use DRED, you'll just have to swap disk a lot.  Note, you
  309. MUST have two drives!  Have some disks formatted, then enter the command -
  310.  
  311.     
  312.     dred -f df0: df1: FFS
  313.  
  314.  
  315.         Then keep inserting your source disks until DRED knows about all
  316. your files, and what floppies they are on.  Then you'll have to change the
  317. various disks as the system and DRED ask you to, it's messy, but it DOES
  318. work, I should know, I did it (once).  Note that DRED cleverly uses what
  319. memory you have to reduce disk grinding.
  320.  
  321.  
  322.         Note!  If using floppy mode, then your source disks *MUST* have
  323. different names.
  324.  
  325.  
  326.     Example Result.
  327.     ~~~~~~~~~~~~~~~
  328.         Here's the results of the test I did with my seven archive
  329. floppies, they reduced to six floppies.
  330.  
  331.  
  332.         Disk 1:  2 blocks free (1k)    
  333.         Disk 2:  1 block free
  334.         Disk 3:  4 blocks free    
  335.         Disk 4:  1 block free    
  336.         Disk 5:  1 block free    
  337.         Disk 6:  145K free.
  338.     
  339.         
  340.         It's difficult to get much tighter than that!
  341.  
  342.  
  343.     Requesters.
  344.     ~~~~~~~~~~~
  345.         You may have noticed that DRED uses the sublime ReqTools.library by
  346. Nico François. DRED uses ReqTools because the author *likes* ReqTools. Some
  347. basic conventions for ReqTools "EZ" requests are:
  348.  
  349.  - Hitting {return} on your keyboard chooses the default request choice
  350.    (this is shown in BOLD text on the default button!) DRED uses the LEFT,
  351.    "CONTINUE" request-button as the default.
  352.  
  353.  - Hitting {Escape} will choose the RIGHT, or "NO" button.
  354.  
  355.  - Pressing the initial of either button also selects that button.
  356.  
  357.  
  358.     Error handling.
  359.     ~~~~~~~~~~~~~~~
  360.         If a DOS read or write error occurs on either the origin disk or
  361. the destination disk, DRED will probably inform you of the error before DOS
  362. does.  DRED will show a requester giving you a choice of actions.  You can
  363. do two things when an error occurs:  CONT or QUIT.  If you choose CONT,
  364. DRED will allow you to insert another destination disk. If you DO insert a
  365. new destination disk, the Amiga will complain about the new disk and
  366. display a requester asking for the old disk. Just hit "Cancel" and DRED
  367. will resume DREDing. Hitting QUIT at any time during this passage will
  368. result in DRED quitting altogether. All files copied to the errored disk
  369. BEFORE the error was encountered should be ok, but the file being DREDed to
  370. the errored disk will have been deleted by DRED, since the file was not
  371. intact. This deleted file will be placed onto the next blank disk that you
  372. insert. I would recommend copying the files which have just been DREDed
  373. onto the errored disk onto a new clean disk, however.
  374.  
  375.  
  376.  
  377.     Other stuff.
  378.     ~~~~~~~~~~~~
  379.         Just entering 'dred' will also give you this handy little tit-bit:
  380.  
  381. -----
  382. Available Memory Diagnostics:
  383. Chip = 387112  Fast = 64328  Total = 451440  Max. DRED Entries = 2594
  384. -----                                                            ^^^^
  385.  
  386.         This is how many files it could theoretically cope with on my
  387. vanilla one meg a500, with stuff running in the background.  If you have
  388. 10000 files (extremely hard to believe) then get more memory!  (Note:  On
  389. Bob's nine meg 2000, he can queue ~45000 files for DREDing.) On my test
  390. seven disks I had only ~200 files.
  391.  
  392. One possible problem with a program of this type is running out of free
  393. memory when copying huge files from the origin to the destination.  This
  394. problem has been averted with DRED.  DRED uses a smart memory buffer which
  395. will allow you to copy those monster files, without needing all that
  396. memory.
  397.  
  398. DRED may occasionally may not be able to fill some disks entirely. You may
  399. be attempting to DRED several LARGE archives down to floppy from your hdisk,
  400. and a close fit may not be physically feasible. If this happens, just
  401. remember to write down (on the floppy) how much room is left on this
  402. floppy. Then, when next DREDing, place these slightly-empty floppies in
  403. FIRST. If DRED can fill these disks, then it will. It is intelligent enough
  404. to figure exactly how much free-space is remaining on each floppy.
  405.  
  406. And ALWAYS read the requesters properly! Important information is contained
  407. in each requester, so read them carefully.
  408.  
  409. -------------
  410. Documentation, beta-testing and fantastic book & code recommendations by
  411. Brett O'Callaghan.
  412.  
  413. Additonal hardcore beta-testing by Martin Ozolins.
  414. -------------
  415.  
  416. -------------
  417. ReqTools library (c) 1991 Nico François (everyone say "Thankyou Nico!")
  418. -------------
  419.  
  420.  
  421. A HELLO FROM THE AUTHOR!
  422. ~~~~~~~~~~~~~~~~~~~~~~~~
  423. Umm, hello.  My name is Bob Rye, and you have an Amiga.  We are therefore
  424. friends.  Because you had the better-than-average foresight to buy an
  425. Amiga, I should tell you that this software is FREEWARE.  This means that
  426. if you find DRED unbelievably useful, then hopefully you might find the
  427. time to send me a postcard for my trouble, but you don't really have to!
  428. Other then the postcard, I don't really want anything from you other than a
  429. quick hello via the Fido message network.  My Fido Netmail address is
  430. 3:633/359.7 and I point from Crazy Diamond BBS.  Feel free to do either (or
  431. all) of the above, and let me know what you think of DRED.  This includes
  432. good'n'bad!  BTW, you should also thank Marcus for the coding help (we had
  433. a turd of a time getting the list-sorter going) and Brett for the brilliant
  434. idea, documentation, and beta-testing!
  435.  
  436. Here's the short and concise credit list!
  437.  
  438.  Compiler:
  439.           SAS/C for the Amiga, version 5.10b
  440.           (Brilliant stuff!)
  441.  
  442.  Src-machine:
  443.           Amiga 2000B + GVP Combo axel @ 33mhz
  444.  
  445.  Spiffy requesters:
  446.           ReqTools library (c) 1991 Nico François
  447.  
  448.  Authors / Beta testers:
  449.           Bob Rye (3:633/359.7@Fido Crazy Diamond [Chris Quonoey])
  450.           Marcus Mroczkowski (3:635/509.5@Fido Ballarat Mail [Stephen Walsh])
  451.           Brett O'Callaghan (3:635/509.8@Fido Ballarat Mail [Stephen Walsh])
  452.           Martin Ozolins (3:635/509.8@Fido Crazy Diamond [Chris Quonoey])
  453.  
  454.  Author contact:
  455.  
  456.           BOB RYE
  457.           11 BEAVER STREET
  458.           ST. ALBANS, VICTORIA
  459.           AUSTRALIA, 3021
  460.  
  461.           Bob_Rye@guru.apana.org.au (preferred)
  462.           3:633/359.7@fido          (preferred)
  463.           41:300/359.7@amiganet
  464.           42:8699/8.7@trinet
  465.