home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 468.lha / FlashDisk_v0.3 / FlashDisk!.dox < prev    next >
Text File  |  1991-02-08  |  21KB  |  463 lines
  1.     
  2.                        FlashDisk! (TM) V0.3  ALPHA
  3.                          "Floppy Disk Optimizer"
  4.                                 ShareWare
  5.                                 
  6.                             *** RELEASE 3 ***
  7.                                 
  8.                          Release Date:  05/10/90
  9.                          
  10.               (C)1990 NiteWing! (TM) -- All Rights Reserved.
  11.  
  12.                     ****** WORKS ON THE A3000!!! ******
  13.  
  14.     DEVELOPERS:  This version WORKS! under V1.4B3 03/20/90!  Please read
  15.     the extra documentation at the end of this document before using it!
  16.  
  17.     RELEASE 3 [05/10/90]:  Ok, this version has some more bugs fixed --
  18.     including the problem with the 'Loading' optimization option.  This
  19.     release also adds support for SINGLE DRIVES, and QUICK KEYS.  I'm
  20.     sure there are other things, but those were the main additions.
  21.  
  22.     RELEASE 2 [05/07/90]:  Some of you that were unfortunate enough to
  23.     run FlashDisk! V0.1 ALPHA (release date 05/05/90) only to find that
  24.     it GURU'd will be happy know that that problem is FIXED!  I am truly
  25.     sorry if the old version caused any problems -- it was MY error and I
  26.     am still kicking myself for not noticing it.  There are also a few
  27.     changes made to this release -- refer to the CHANGES section below.
  28.     
  29.     RELEASE 1 [05/05/90]:  First release.  Forget that it happened!  It
  30.     was brand new and it showed!
  31.  
  32.                             *******************
  33.                          ****  W A R N I N G  ****
  34.                             *******************
  35.  
  36.     Before you run this program, observe one obvious caution:  this is an
  37.     *ALPHA* release.  For those who do not understand what that means,
  38.     let me put it another way:  do *not* count on it working reliably! 
  39.     However, I have spent MANY hours using FlashDisk! V0.3, and at this
  40.     point in time I am having no problems with its functioning (knock on
  41.     wood ;^).  You have been warned...
  42.  
  43.     DISCLAIMER:  Yes, it's the same old song and dance, but being sued is
  44.     not good for business.  NiteWing! (TM) makes no warranties either
  45.     express or implied as to the suitability or performance of this
  46.     software.  This software is placed into the ShareWare market 'as
  47.     is'...
  48.  
  49.     I apologize if this thing formats your hard drive, it doesn't on my
  50.     system ("Sebastian") :^).  (SIWY)
  51.  
  52.         All material contained with this software and the software 
  53.                 itself is Copyright 1990 by NiteWing! (TM)
  54.                        ** All Rights are Reserved! **
  55.  
  56.  
  57.     8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<
  58.  
  59.  
  60.     NOTE:  I am sorry about the sketchy documentation -- I am very busy
  61.     with OTHER projects and did not spend much time on writing this
  62.     script.  I am releasing FlashDisk! (TM) for the purpose of feedback
  63.     and bug reports.  I thank you for trying FlashDisk! and I would
  64.     appreciate *any* comments: good and bad.  Now on with it...
  65.  
  66.  
  67.     CHANGES FROM V0.2 ALPHA 05/07/90:
  68.     
  69.     Below is a brief list of changes made to RELEASE 3:
  70.  
  71.         o   The 'Loading' optimization no longer sends your drive
  72.             into strange loops and drops files.  Although the
  73.             directories under this option are slower, it works!
  74.  
  75.         o   This release works with single drives -- this way, you
  76.             can optimize that funny drive (5.25"?  3.5" HD?) without
  77.             having a second available.  If anyone has problems with
  78.             FlashDisk! working on their drives, LET ME KNOW!!  It has
  79.             been tested thoroughly on the 5.25" 440K drive and should
  80.             work with ANY trackdisk device mounted in the DF0: - DF3:
  81.             positions.
  82.  
  83.         o   There are now Quick Keys associated with the gadgets.  The
  84.             corresponding key is bracketed in the name of the gadget.
  85.             (ie [F]ormat uses the key 'F').  Return is equivalent to the
  86.             'GO!' and 'STOP!' gadget.  ESCape is abort/close like the
  87.             close gadget and ^C.
  88.  
  89.  
  90.     CHANGES FROM V0.1 ALPHA 05/05/90:
  91.     
  92.     Below is a brief list of changes made to RELEASE 2:
  93.     
  94.         o   It no longer GURU's!  The problem was with my memory
  95.             management routines -- everything works smoothly now;
  96.             even under V1.4B3 for other developers ;^).
  97.  
  98.         o   Verify now works!  FlashDisk! will report verify errors 
  99.             and continue to run -- at the end, the number of errors
  100.             is reported.  If you get errors, the chances are that
  101.             the destination disk will NOT be useable.
  102.  
  103.         o   Required stack space VASTLY reduced -- I now recommend
  104.             4K instead of 50K.  Should work from a default system
  105.             CLI.  WorkBench users should verify that the .info
  106.             for FlashDisk! contains at least 4K for the stack.
  107.  
  108.     
  109.     FLASHDISK! (TM)  WHAT IS IT?
  110.  
  111.     FlashDisk! is a floppy disk optimizer for all models of the Amiga
  112.     computer.  It is NOT a cache -- it merely reorganizes the information
  113.     on the disk to make directories and loading more efficient.  The
  114.     changes are permanent and will usually increase the loading speed of
  115.     directories between 3 and 5 times -- increase depends on how badly the
  116.     original disk was fragmented.  In addition, loading time of large
  117.     programs is often reduced.  The resulting disk is still an AmigaDOS
  118.     disk and is 100% compatible!
  119.     
  120.     
  121.     LIMITATIONS OF FLASHDISK! V0.3 ALPHA:
  122.     
  123.     At this time, FlashDisk! V0.3 ALPHA does not work on hard disks.  It
  124.     WILL however work with any FLOPPY trackdisk compatible device that is
  125.     in the slots DF0: - DF3: (I hope!).  When doing a TWO drive flash, the
  126.     source and destination *must* be of the same format.  Basically the same
  127.     restriction that 'diskcopy' poses on a two drive copy.  This WILL
  128.     change -- remember this is an ALPHA release!
  129.     
  130.     FlashDisk! will NOT work on COPY-PROTECTED disks! It will also fail
  131.     if the source disk is corrupt -- in this case, run DiskDoctor on the
  132.     source disk and try again.
  133.  
  134.     You may also notice that FlashDisk! can be very picky about minor
  135.     errors that it encounters -- THIS WILL CHANGE.  For now, the disks
  136.     must be without defects.
  137.  
  138.  
  139.     8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<
  140.  
  141.  
  142.     USING FLASHDISK!
  143.     
  144.     FlashDisk! (from now on FD!) will run from the WorkBench or the
  145.     CLI.  There are currently no command line options (there will be). 
  146.     So, to use FD!, put 'FlashDisk!' into a directory accessible by your
  147.     path and run it as you would any other program (or tool).  CLI users:
  148.     I hope you rename 'FlashDisk!' to 'fd' like I do :^).
  149.     
  150.     NOTE:  When running FD! from the CLI, it will *not* detach itself. 
  151.     Manx Aztec C 5.0a conveniently forgot the chapter on using their
  152.     detach.oss and I haven't gotten around to calling them yet -- this
  153.     will change!  Simply 'RUN' FD! if you desire it to detach...
  154.  
  155.     ANOTHER NOTE:  FlashDisk! V0.2 requires a stack size of about 4K
  156.     bytes.  Verify that either the CLI or .info file has this setting. 
  157.     The supplied icon for WorkBench users has this setting.
  158.  
  159.     FD! will open a window with a few gadgets thrown about its interior. 
  160.     The color scheme that is used is for V2.0 of the operating system
  161.     (that's what this is being written for!).  They are (as of this
  162.     writing) as follows (or close to it!):
  163.     
  164.             Register:   Color:          R:  G:  B:
  165.             -----------------------------------------
  166.                 0       Light Grey      10  10  10
  167.                 1       Black            0   0   0
  168.                 2       White           15  15  15
  169.                 3       Light Blue       6   8  10
  170.  
  171.     PLEASE! look at FD! with these colors to see what it is supposed to
  172.     look like.  If you do not like these colors, I am sorry -- you may
  173.     want to get used to them though ;^).  Also, FD! will use the topaz
  174.     font that most closely resembles the default font you have chosen for
  175.     the WorkBench screen.  Try it with topaz 8, 9, and 11 -- I hope you
  176.     like this feature!  This is a result of my toolbox library that I am
  177.     working on -- all modules in the Flash! package use this.  It is also
  178.     designed to bridge the gap between V2.0 of the OS and V1.x.
  179.     
  180.     Now, select the source and destination disks by pressing the big
  181.     gadgets beneath the 'Source:' and 'Destination:' headers.  Select the
  182.     optimization method: Directories, Loading, or MegaFlash!  These are
  183.     described below.  Select any other options: Chip Hog!, Prolix,
  184.     Format, and Verify.  These are also described below.  Once you have
  185.     chosen the options that you desire, make sure the disks are in the
  186.     correct drives and select 'GO!'
  187.  
  188.  
  189.     8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<
  190.  
  191.  
  192.     OPTIMIZATION METHODS:
  193.     
  194.     DIRECTORIES:  This option tells FlashDisk! to make the directories as
  195.     fast as possible.  This includes placing the *.info files in the best
  196.     location for WorkBench users.  This option is good for both CLI and
  197.     WorkBench users.  Note: After optimizing, leave the write protect tab
  198.     off and let WorkBench validate the disk (snapshot if you will). 
  199.     Although not necessary, WorkBench works smoother if it can validate
  200.     the disk.
  201.     
  202.     LOADING:  This option tells FlashDisk! to make every attempt to put
  203.     large files in as contiguous of an order possible.  It also tries to
  204.     optimize directories and is a good option for big programs.
  205.     
  206.     MEGAFLASH!:  This option tells FlashDisk! to do anything and
  207.     everything to optimize the performance of the disk.  At this time, it
  208.     only does a few more things than the 'Loading' option.  I have some
  209.     ideas that are not implemented yet (for all of these options!)...
  210.  
  211.  
  212.     8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<
  213.  
  214.  
  215.     OPTION SWITCHES:
  216.     
  217.     CHIP HOG!:  This option, when enabled, tells FlashDisk! that it may
  218.     use as much memory as it wants.  For speed reasons, this is mostly
  219.     CHIP memory -- the more memory, the faster that FlashDisk! works.  It
  220.     will make every attempt to stay above ~100K -- this way, other tasks
  221.     are not completely gronked.  However! I advise you *not* to use this
  222.     option if you plan on using another program at the same time, it just
  223.     makes things go a lot faster.  When disabled, FlashDisk! will use as
  224.     little memory as it can (50K - 100K) -- this slows FlashDisk! down
  225.     considerably, but makes running other programs at the same time less
  226.     dangerous.  You may turn this option on and off at ANY time.  For
  227.     kicks: run a memory watch program and toggle this option -- I hope you
  228.     find this useful!  Also note, that in low memory conditions and when
  229.     the Chip Hog option is turned OFF, FlashDisk! will sometimes have
  230.     to search all over the source disk for information -- this can make
  231.     the drive sound like it is falling apart (like what WorkBench does to
  232.     badly fragmented disks :^).  This is normal -- there is no need to
  233.     worry.  When FlashDisk! is done, the final disk will work much
  234.     smoother in all environments.
  235.     
  236.     PROLIX:  This option, when enabled, tells FlashDisk! to print
  237.     meaningless information on the screen.  Mostly it is used to verify
  238.     that the program is in fact working -- a heart beat.  This option may
  239.     be turned on and off at ANY time.  Also note that FlashDisk! works a
  240.     little bit faster when this option is disabled.  Why 'Prolix'? 
  241.     That's the word I used to describe one of my old professor's lectures
  242.     and it seemed appropriate ;^).
  243.     
  244.     FORMAT:  This option, when enabled, tells FlashDisk! to format the
  245.     destination disk as it goes.  You MUST have this option enabled if
  246.     you are flashing to a NEW disk.  It is a good idea to always have
  247.     this enabled!  However, if the destination was previously formatted
  248.     successfully as an AmigaDOS disk with NO ERRORS, then this is
  249.     optional.  When disabled, the flashing process is noticeably faster. 
  250.     This option may also be turned on and off at ANY time.  I may change
  251.     this because it is potentially dangerous to the novice user.  Should
  252.     I keep this feature?
  253.     
  254.     VERIFY:  This option, when enabled, tells FlashDisk! to verify the
  255.     destination with the source.  It may also be turned on and off at ANY
  256.     time.  If a verify error occurs, FlashDisk! will report the error and
  257.     continue.  At the end, the number of verify errors encountered will
  258.     be displayed.  If there were any errors, the odds are that the
  259.     destination disk will not be useable.  Try it again.
  260.  
  261.  
  262.     8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<
  263.  
  264.  
  265.     STOPPING FLASHDISK!
  266.     
  267.     You may stop FlashDisk! at any time by pressing the STOP! gadget,
  268.     hitting ^C, sending a 'break' to its process, selecting the close
  269.     gadget of the window, or pressing the ESCape key.  At times, there is
  270.     a brief pause before terminating, but nothing unreasonable.  It just
  271.     depends on what FlashDisk! is doing at the time you try to stop it --
  272.     some sections are critical.
  273.     
  274.     NOTE:  ^C, ESCape, and the close window gadget are treated the same! 
  275.     Also, if FlashDisk! is flashing a disk, the first ^C, ESCape, or
  276.     close window event is regarded as an abort -- a second will close
  277.     FlashDisk! down.
  278.  
  279.  
  280.     8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<
  281.  
  282.  
  283.     THE FUTURE OF FLASHDISK!
  284.     
  285.         FlashDisk! (TM) is being developed as a module of my upcoming
  286.     AmigaDOS utilities package called 'Flash! (TM).' Although its intent
  287.     is to take advantage of the upcoming operating system, I am making
  288.     every attempt to keep it compatible with both V1.x and V2.0.  V2.0
  289.     will undoughtedly give you more power.  Flash!, for those who are
  290.     curious, currently contains the following modules (in the works):
  291.     
  292.                       Flash! (TM) by NiteWing! (TM)
  293.                       -----------------------------
  294.     
  295.     FlashDisk! (TM):    A disk optimizer for all AmigaDOS compatible
  296.                         devices (including hard drives soon).
  297.             
  298.     FlashManager! (TM): A file manager with features far too numerous
  299.                         to mention here.  It does allow transferring
  300.                         files between MS-DOS, the BridgeBoard, and I
  301.                         hope Atari ST and A-Max disks in the future.
  302.  
  303.     FlashBack! (TM):    A hard drive backup utility that allows backups
  304.                         to ANY AmigaDOS compatible device.  Also
  305.                         includes options to save in standard formats
  306.                         or a faster FlashBack! unique format.
  307.  
  308.     FlashCopy! (TM):    A very fast diskcopy program that will also
  309.                         copy MS-DOS and Atari ST disks (possibly
  310.                         others).
  311.  
  312.     FlashDoctor! (TM):  A disk doctoring program that allows easy
  313.                         data recovery and disk repairs.  Done in
  314.                         a manner that anyone can understand with enough
  315.                         extras to please even the most envolved hacker.
  316.  
  317.     Flash! is designed to work from the WorkBench or CLI and interact
  318.     with other software.  There are no fancy bitmapped graphics screens,
  319.     cute sounds, or corporate takeovers!  Flash!  is intended for real
  320.     users with real needs.  I am putting all of my efforts into making
  321.     Flash! as functional as possible.  And of course, Flash! fully
  322.     supports the ARexx language :^).
  323.  
  324.  
  325.     NOTE TO POTENTIAL INVESTORS:
  326.     
  327.     NiteWing! is desperately looking for financial backing (we are a
  328.     brand new company) to help bring Flash! and other great products into
  329.     the commercial market.  If you have any interest in supporting such a
  330.     venture, I would be very glad to talk with you and give you some
  331.     demonstrations.  Please contact me at the address and phone number
  332.     below.  Sorry about the informal nature of this address.
  333.  
  334.  
  335.     8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<
  336.  
  337.  
  338.     NOTES TO V1.4B3 TESTERS (DEVELOPERS):
  339.     
  340.                     ****** WORKS ON THE A3000!!! ******
  341.     
  342.     FlashDisk! V0.3 ALPHA works reliably(?) under the V1.4B3 release of
  343.     the operating system with one exception that I have found:
  344.     
  345.         o   You can not 'Execute' FlashDisk! from the WorkBench.
  346.             For some reason, it hangs -- why?  Instead, use the
  347.             supplied icon or run it from a CLI.
  348.  
  349.  
  350.     For those of you that read the possible 'FreeMem()' error in my last
  351.     release, I am happy(?) to say that it was MY error!  I am truly sorry
  352.     if I caused any worrys -- I jumped to a conclusion that I hadn't fully
  353.     tested.
  354.  
  355.  
  356.     I would appreciate ANY feedback from developers on any problems (and
  357.     would like even more for Commodore to send Beta 5! to me ;^) Please,
  358.     any suggestions or help would be greatly appreciated!  Call me
  359.     anytime!  I can not afford an account on BIX (mostly due to long
  360.     distance charges) at this time and am therefore quite secluded from
  361.     the mainstream -- any help you can give me is appreciated!
  362.  
  363.  
  364.     8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<
  365.  
  366.  
  367.     SOME FINAL NOTES:
  368.     
  369.     The purpose for releasing FlashDisk! V0.3 ALPHA into the ShareWare
  370.     market at this time is for two reasons:
  371.     
  372.         1.  To get feedback on its performance and possible
  373.             enhancements -- from the people that will be using
  374.             it!  Please, any comments are appreciated.
  375.  
  376.         2.  To give Amiga users a sample (small) of what is
  377.             coming in the near future.  I figured that the
  378.             FlashDisk! module wouldn't be too detrimental
  379.             to the final commercial Flash! package.  Enjoy!
  380.  
  381.  
  382.     ENHANCEMENTS:
  383.     
  384.     The following is a list of enhancements that will be added shortly
  385.     (any others you can think of?):
  386.     
  387.         o   Faster!  I can make it faster -- this release was
  388.             an 'investigation' into the problem.  The final
  389.             release will be noticeably faster!
  390.     
  391.         o   The memory management routines need to be worked
  392.             over.  FD! is far too hungry for memory.
  393.             
  394.         o   Hard drive support!
  395.         
  396.         o   The algorithms for the different methods need to
  397.             be refined.  MegaFlash! needs a few more tricks
  398.             implemented (I have many ideas for these :^)
  399.  
  400.         o   Support for minor disk error recoveries!  Possibly
  401.             work around bad tracks on the destination disk?
  402.  
  403.         o   Retry/Cancel support for errors!
  404.  
  405.     That is what my 'to do' list contains -- I would appreciate any other
  406.     comments or improvements you might have.  I would also like to know
  407.     about successes with other than 3.5" 880K floppy drives.  I don't
  408.     have all formats available to me (yet!).
  409.  
  410.  
  411.     8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<
  412.  
  413.  
  414.     CLOSING COMMENTS:
  415.     
  416.     Remember that FlashDisk! V0.3 ALPHA is ShareWare.  Any donations
  417.     would be more than appreciated (any amount).  I can not offer
  418.     upgrades or any other 'Registered User' policies for various reasons.
  419.     I will however send an availability notice to all who send a
  420.     donation.  Please, donations are very important to the release of
  421.     Flash!  The less I have to work at other jobs, the sooner Flash! hits
  422.     the market.  (If I have to write one more Windows application for
  423.     people who do not understand what multitasking is about, I will
  424.     scream!)
  425.     
  426.     
  427.         Send donations (any amount) and comments to:
  428.         
  429.                 Curtis J. Palmer
  430.                 c/o NiteWing!
  431.                 840 Wallowa Drive
  432.                 Walla Walla, WA  99362
  433.  
  434.     And for the time being, my phone number is (509) 529-7590.  Call me
  435.     if you have any problems or other comments (developers??).  Even
  436.     though the phone number might change, the address will be valid -- so
  437.     please write.  The phone number should still be valid until the
  438.     middle of June -- possibly later...
  439.  
  440.  
  441.     8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<
  442.  
  443.  
  444.     THANK YOU:
  445.  
  446.     I would like to thank all of the people who place software into the
  447.     PD and ShareWare market -- especially those who release their source
  448.     code.  There are times when the RKM just doesn't quite cut the
  449.     mustard!  (Thanks to Brian Conrad (SimCity) for some great code).
  450.  
  451.     I would also like to thank "Sebastian" (my machine) for putting up
  452.     with my seemingly endless stupidity!
  453.  
  454.     Thanks to GVP for a great hard drive and their excellent 3001 board!
  455.     Thanks for the new PALS!
  456.     
  457.     And finally, special thanks to Paladin, Jim, Rick, Doc, Gamesman,
  458.     Jerry, and the rest of the crew on the Conclave BBS (509) 529-6499! 
  459.                         (I can be reached there...)
  460.  
  461.          Commodore:  What exactly *is* a "Recoverable Alert?"  ;^)
  462.  
  463.     /** EOF: FlashDisk!.dox **/