home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 67 / af067sub.adf / ReOrg / ReOrg.doc < prev    next >
Text File  |  1992-10-04  |  45KB  |  1,111 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.                           ReOrg V2.33
  7.  
  8.                     Shareware disk optimizer
  9.  
  10.                      English documentation
  11.  
  12.                      (C) 1992 Holger Kruse
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.        Contents
  21.        --------
  22.  
  23.        1. Conditions, Disclaimer
  24.  
  25.        2. What is ReOrg ? - Short introduction
  26.  
  27.        3. Hardware, Software needed; Installation
  28.  
  29.        4. Usage
  30.  
  31.        5. Error messages
  32.  
  33.        6. Technical details
  34.  
  35.        7. Option file format
  36.  
  37.        8. Program version, update info
  38.  
  39.        9. Acknowledgements
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.        1. Conditions, Disclaimer
  48.        -------------------------
  49.  
  50.        ReOrg is shareware. The program may be freely distributed
  51.        and copied, as long as the following conditions are
  52.        fulfilled:
  53.  
  54.         - The sales price must not be higher than the cost of
  55.           an (empty) disk plus a nominal copying fee plus
  56.           costs for shipping. The total price must not be higher
  57.           than 6 US$ or 10 DM.
  58.         - All parts of the program and the documentation must
  59.           be complete. The distribution of single parts is not
  60.           allowed.
  61.         - ReOrg or parts of it must not be sold in combination with
  62.           or as part of commercial software.
  63.         - Program and documentation must not be changed in any way.
  64.           Exception (this means: acceptable is:) the use of
  65.           archivers such as LHArc and packers like "Imploder" or
  66.           "Powerpacker", as long as it is possible to retrieve
  67.           the original program/data.
  68.  
  69.  
  70.  
  71.        I want to ask everybody, who uses ReOrg (except for one
  72.        or two test runs), to send the amount of
  73.  
  74.                       10 US$  or  15 DM
  75.  
  76.        to the following address:
  77.  
  78.                       Holger Kruse
  79.                       Ulzburger Str. 387-389
  80.                       2000 Norderstedt
  81.                       Germany
  82.  
  83.        or to my new address in the USA:
  84.  
  85.                       Holger Kruse
  86.                       12006 Coed Drive
  87.                       Orlando, FL 32826
  88.                       USA
  89.                       Phone: (407) 381-3233
  90.  
  91.        Please send only cash, eurocheques, American checks or
  92.        postal money orders (US$ only !). Do not send
  93.        stamps, disks etc. If you write to my address in Germany, please
  94.        allow some time until your mail is answered, because mails send
  95.        there are forwarded to my address in the USA.
  96.  
  97.        Thank you very much in advance !
  98.  
  99.        I will try and inform everybody, who as registered with
  100.        me as described above, when a new version of ReOrg
  101.        becomes available.
  102.  
  103.  
  104.        I have a new internet address:   kruse@eola.cs.ucf.edu
  105.  
  106.        But please note that this address may not be valid at all
  107.        times ! If E-Mail bounces, please try again after a couple
  108.        of weeks or try sack mail.
  109.  
  110.  
  111.        I explicitly do not guarantee for the correct functioning 
  112.        of ReOrg. When you optimize disks, you always run the
  113.        risk of a data loss, of a change of your data or of
  114.        the destruction of your data. I explicitly reject any
  115.        responsibility for these or any other consequences from
  116.        the use of ReOrg whatsoever. This includes, but is not
  117.        limited to, secondary consequences, personal injuries or
  118.        other kinds on side effects.
  119.  
  120.        I hereby explicitly warn each user:
  121.        
  122.        !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  123.        !!! Optimizing a disk is always risky.        !!!
  124.        !!! I strongly recommend each user to backup  !!!
  125.        !!! or copy his disk completely before        !!!
  126.        !!! optimizing it. It is the user's           !!!
  127.        !!! responsibility to check his data for      !!!
  128.        !!! completeness and correctness after        !!!
  129.        !!! optimizing it. I explicitly reject any    !!!
  130.        !!! responsibility for damages or changes.    !!!
  131.        !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  132.  
  133.  
  134.        2. What is ReOrg ? - Short introduction
  135.        ---------------------------------------
  136.  
  137.        ReOrg is a disk optimizer, i.e. a program that
  138.        improves the physical data layout on a floppy
  139.        disk or harddisk, in order to speed up file
  140.        and directory accesses.
  141.        
  142.        ReOrg removes some problems that are caused
  143.        by AmigaDOS:
  144.        
  145.         - file fragmentation:
  146.           When new files are created, it is possible that
  147.           AmigaDOS can not store the file contents in one
  148.           single consecutive block, because there is no
  149.           such block available on the disk. In this case
  150.           AmigaDOS sometimes scatters the file contents over
  151.           the whole disk.
  152.           ReOrg removes this problem by placing the contents
  153.           of each file in a single consecutive block.
  154.  
  155.         - directory fragmentation:
  156.           In contrary to other operating systems (e.g. MSDOS),
  157.           AmigaDOS does not store directory data in a single
  158.           consecutive block. This leads to weak performance
  159.           for directory listings.
  160.           ReOrg tries to store directory data as closely together
  161.           as possible. This considerably speeds up commands like
  162.           "dir" and "lists" and the directory display within
  163.           file requesters.
  164.  
  165.         - differences in disk format:
  166.           When you use disks under Kick1.2/1.3, which have been
  167.           formatted under Kick2.04, directory accesses are often
  168.           even much slower than usual. The reason for this is, that
  169.           placement of "FileList"-blocks has been changed from
  170.           Kick1.2/1.3 to Kick2.04.
  171.           ReOrg has an option where to place "FileList"-blocks.
  172.           This means you can optimize Kick2.04-disks for use
  173.           with Kick1.2/1.3.
  174.  
  175.        ReOrg can be used with the following disk formats:
  176.        
  177.         - all currently available AmigaDOS filesystems, including
  178.          - OldFileSystem (OFS: "DOS\0")
  179.          - FastFileSystem (FFS: "DOS\1")
  180.          - new (Kick2.0)-FileSystem (includes OFS and FFS)
  181.          - International FileSystem (has been in ROM at least
  182.            since Kick2.04 and will (possibly ?) be supported
  183.            from the Shell in WB2.1: "DOS\2", "DOS\3")
  184.  
  185.         - All floppy disk and hard disk sizes are supported.
  186.           However, to optimizer large hard disk partitions,
  187.           you need a lot of memory.
  188.  
  189.         - ReOrg recognizes FileSystems, which support different
  190.           disk capacities (e.g. High-Density-Drives for
  191.           1.76 MB capacity, that are built in some new A3000s).
  192.  
  193.         - ReOrg supports "hard links" and "soft links";
  194.           however, "soft links" are not wholely supported by
  195.           Commodore yet. Therefore, ReOrg only supports the
  196.           (possibly preliminary) "soft link" implementation
  197.           of Kick2.04. I can not guarantee that this version
  198.           of ReOrg correctly handles "soft link" implementation
  199.           of future AmigaDOS versions.
  200.  
  201.         - CAUTION: DYNAMIC Ram disks, like "VD0:" ((C) ASDG)
  202.           must NOT be optimized by ReOrg. Optimizing such disks
  203.           may lead to data loss !
  204.  
  205.         - Of course, ReOrg can not optimize "RAM:". Anyway,
  206.           this would not make much sense.
  207.  
  208.         - You CAN use ReOrg to optimize your resident,
  209.           non-dynamical RAM-Disk "RAD:" ((C) by Commodore).
  210.  
  211.         - ReOrg has a one-disk-mode (optimize a single disk)
  212.           and a two-disk-mode (optimize one disk while copying
  213.           it to a different disk)
  214.  
  215.        In comparison to other disk optimizers available on
  216.        the Amiga market, ReOrg is quite fast.
  217.        Optimizing a 880 kB disk on a standard 68000 Amiga
  218.        with 1 MB of free memory usually takes about 1:30
  219.        to 1:40 minutes. On a 68030 Amiga it takes only
  220.        1:20 to 1:30 minutes.
  221.        Optimizing a 40 MB harddisk on a 68000 Amiga usually
  222.        takes around 10 to 15 minutes, but this time depends very
  223.        much on the amount of free memory, type of controller
  224.        type of processor and the degree of disk fragmentation.
  225.        If you use a 68030 Amiga and have enough memory
  226.        available, the optimization time can be reduced to
  227.        about 4 minutes.
  228.  
  229.  
  230.  
  231.  
  232.        3. Hardware, software needed; Installation
  233.        ------------------------------------------
  234.  
  235.        To use ReOrg, you need an Amiga, Kickstart 2.04
  236.        or above and enough memory.
  237.        There is also a different version of ReOrg (V1.1)
  238.        available that also works under Kickstart 1.2/1.3
  239.        The amount of memory you need is approximately:
  240.        
  241.             220 kB  (needed for the program itself)
  242.           +   7 kB for each MB of disk size
  243.           +   5 * tracksize of your disk
  244.           + 150 kB which are usually not used by ReOrg, but must be
  245.                    left to avoid low-memory situations. (For large
  246.                    partition sizes and much memory available, this
  247.                    number may become higher)
  248.  
  249.  
  250.        Examples:
  251.  
  252.        1) 880 kB floppy disk:                  40 MB harddisk:
  253.           (11 sectors/track)                   (32 sectors/track)
  254.  
  255.            220 kB                                 220 kB
  256.         +    6 kB  (7 kB * 880/1024)           +  280 kB  (7 kB * 40)
  257.         +   28 kB  (11/2 kB * 5)               +   80 kB  (32/2 kb * 5)
  258.         +  150 kB                              +  150 kB
  259.         ---------                              ---------
  260.            404 kB                                 690 kB
  261.  
  262.  
  263.           200 MB hard disk:
  264.           (32 sectors/track)
  265.  
  266.            220 kB
  267.         + 1400 kB  (7 kB * 200)
  268.         +   80 kB  (32/2 kB * 5)
  269.         +  150 kB
  270.         ---------
  271.           1850 kB
  272.  
  273.        These numbers are only rough approximations to give
  274.        you an idea how much memory you need.
  275.  
  276.        Actually for large partition sizes, ReOrg allocates
  277.        most of your memory as a cache.
  278.        This cache is the main reason why ReOrg is so fast.
  279.        For optimum speeds, the cache should have at least
  280.        2 percent of the size of your partition.
  281.  
  282.  
  283.        There is no installation required for ReOrg. In addition
  284.        to the program file "ReOrg", you do not need any
  285.        libraries, fonts etc.
  286.        However if you want to use the built-in help mode of ReOrg
  287.        the file "ReOrg.help" must be copied to the same directory
  288.        as the program file "ReOrg".
  289.  
  290.  
  291.  
  292.        4. Usage
  293.        --------
  294.  
  295.        ReOrg can be started from Shell of Workbench.
  296.        You can specify the following arguments / tool types:
  297.  
  298.          FROM=device name            source device name
  299.          TO=device name              destination device name
  300.          PUBSCREEN=screen name       name of the public screen
  301.                                      you want ReOrg to open on
  302.                                      (works since ReOrg V2.3)
  303.          SCREENMODE=typecode         This option tells ReOrg to open
  304.               e.g. =NTSC:HiRes       an own (custom) screen. As <typecode>
  305.               or   =0x19000          you can specify the name of an
  306.                                      Amiga display-mode (like in Prefs/
  307.                                      ScreenMode), e.g. "NTSC:HiRes".
  308.                                      However I recommend you specify the
  309.                                      hex code (e.g. "0x19000" for
  310.                                      NTSC:HiRes), because the hex code
  311.                                      is not changed for different
  312.                                      languages (WB2.1 ?). Valid code are e.g.:
  313.                                       0x08000:   HiRes
  314.                                       0x19000:   NTSC:HiRes
  315.                                       0x29000:   PAL:HiRes
  316.                                       0x39024:   Productivity
  317.                                       0x41000:   A2024 10Hz
  318.                                      A complete list is located in
  319.                                      the include file "graphics/displayinfo.h".
  320.          OPTFILE=option file name    name of a user-supplied
  321.                                      option file (the format of this
  322.                                      file is described below)
  323.          SETTINGS=settings           name of a settings file, that ReOrg
  324.                   file name          has previously saved (default =
  325.                                      "ReOrg.prefs")
  326.  
  327.        From Workbench ReOrg can also be started by double-clicking
  328.        on an settings file.
  329.  
  330.  
  331.        When you start ReOrg, the main window appears. ReOrg is
  332.        controlled by menus and gadgets.
  333.  
  334.  
  335.  
  336.        Description of menus:
  337.  
  338.        - ReOrg
  339.  
  340.          - About ReOrg     Displays version and copyright information
  341.  
  342.          - Help            Toggle help mode.
  343.                            In help mode the mouse pointer changes its
  344.                            imagery. When you select a menu item or a
  345.                            gadget while in help mode, ReOrg shows you
  346.                            a short explanation. You can leave help mode
  347.                            by selecting the menu item "Help" again.
  348.  
  349.          - Quit ReOrg      Quits the program
  350.  
  351.        - Settings
  352.  
  353.          - Create Icons ?  If this menu item is selected, ReOrg creates
  354.                            a Workbench icon (.info-file) whenever you save
  355.                            a settings file.
  356.  
  357.          - Load            Loads any previously saved settings file
  358.            Settings...
  359.  
  360.          - Save Settings   Saves the settings (state of all gadgets
  361.                            and menu items) in the current settings
  362.                            file (default = "ReOrg.prefs")
  363.  
  364.          - Save Settings   Saves the settings in any settings file
  365.            as...
  366.  
  367.  
  368.  
  369.        Description of gadgets:
  370.  
  371.        - Format            This gadget specifies if the destination
  372.                            disk is to be formatted.
  373.  
  374.            - Off           Do not format the destination disk.
  375.                            For all disk writes CMD_WRITE is used.
  376.                            (This only works if the destination disk
  377.                            has been formatted previously;
  378.                            default in one-disk-mode)
  379.  
  380.            - On            Only used tracks are formatted on the
  381.                            first write access. Should usually not be
  382.                            used for harddisks, but is useful for floppy
  383.                            disks.
  384.  
  385.            - All tracks    All tracks of the destination disk
  386.                            are formatted (necessary, if the
  387.                            destination disk has not been
  388.                            formatted before; default in two-disk-mode)
  389.  
  390.        - Write verify      If this gadget is activated, ReOrg checks
  391.                            if data is written correctly (verify).
  392.                            This slows down the optimization. For
  393.                            hard disks verify ist usually not necessary.
  394.  
  395.        - Workbench Mode    If this gadget is activated, Workbench
  396.                            icons will appear faster after optimization.
  397.  
  398.        - Graphical sector  If this gadget is activated, ReOrg
  399.          display           graphically shows the user which sectors it
  400.                            is currently working on during optimization.
  401.                            This makes the optimization slightly slower.
  402.  
  403.        - Advanced options  This gadget opens a window that
  404.                            contains options which are not needed
  405.                            so often.
  406.  
  407.        - Option file       You can enter the name of an option file
  408.                            in this gadget. Option files allow the
  409.                            user to specify, that certain files should
  410.                            be treated by ReOrg in a different way.
  411.                            The format of the option file is described
  412.                            below.
  413.                            The option file name can be entered
  414.                            immediately, or you can use the "Select"
  415.                            gadget to select an option file in a
  416.                            file requester. The gadget "Clear" clears
  417.                            the option file name.
  418.  
  419.        - Drive /           These gadgets are scrolling lists that
  420.          FROM Drive /      show all available drives. In one-disk-mode
  421.          TO Drive          you must choose one device name, in
  422.                            two-disk-mode, two different devices must
  423.                            be selected.
  424.  
  425.        - Mode              Lets you choose between
  426.                             - One Drive   (one-disk-mode)   and
  427.                             - Two Drives  (two-disk-mode)
  428.  
  429.        - Start             Starts the Optimization
  430.  
  431.        - Cancel            Quits ReOrg
  432.  
  433.  
  434.        Description of gadgets in the "Advanced options" window:
  435.  
  436.        - FileExt blocks    Specifies where FileExt blocks are
  437.                            stored. For a detailed description:
  438.                            See "6. Technical details"
  439.  
  440.        - Partition Half    Specifies where file contents are
  441.                            stored. For a detailed description:
  442.                            See "6. Technical details"
  443.  
  444.        - Update disk date  Normally, ReOrg increments the disk
  445.                            creation data during optimization.
  446.                            This is necessary to prevent ReOrg
  447.                            from mixing up the old disk with the
  448.                            new, optimized disk. If this gadget
  449.                            is deactivated, ReOrg does not change
  450.                            the disk creation date.
  451.                            CAUTION: If you deactivate this gadget,
  452.                            under certain circumstances your Amiga
  453.                            might crash after the optimization !
  454.  
  455.        - SIMULATE          If you activate this gadget, ReOrg does
  456.          optimization      not write the optimized data back to
  457.          only              disk. This means, the optimization is
  458.                            only "simulated". This is useful to
  459.                            find out if ReOrg will issue error messages
  460.                            during the actual optimization.
  461.  
  462.        - Read Drive        This gadget can be used to activate the
  463.          Geometry          command TD_GETGEOMETRY. This command is
  464.                            used by ReOrg to adjust to devices that
  465.                            support multiple disk formats. At this
  466.                            time, only "trackdisk.device" supports
  467.                            multiple formats to support DD disks as
  468.                            well as HD disks. However, ReOrg recognizes
  469.                            HD disks in "trackdisk.device"-based drives
  470.                            even when this gadget is deactivated.
  471.                            So you only need to activate this gadget
  472.                            if you have ANOTHER device that supports
  473.                            multiple disk formats (e.g. special disk
  474.                            drives on your SCSI bus).
  475.                            CAUTION: If you activate this gadget for
  476.                            a device, that does not understand
  477.                            TD_GETGEOMETRY, your Amiga may crash !
  478.                            So, usually, you should switch this gadget
  479.                            off !
  480.                            The function of this gadget has changed
  481.                            since ReOrg V2.1.
  482.  
  483.        - Safety Memory     In this gadget you can specify the
  484.                            amount memory that ReOrg should NOT use
  485.                            as cache. Default is 150000 Bytes, but
  486.                            you can reduce this value to 50000.
  487.                            Or you can increase the value as high
  488.                            as you wish, if you want to spare some
  489.                            of your memory for other programs.
  490.                            Values smaller than 50000 are not allowed,
  491.                            because otherwise there might not be
  492.                            enough memory left when an error occurs.
  493.  
  494.        - Small file limit  ReOrg stores large files in a seperate
  495.                            area on your disk to speed up the access
  496.                            to directory data. However, small files are
  497.                            usually stored within the directory area
  498.                            to speed up the access to those files.
  499.                            This does not affect the speed of
  500.                            directory accesses very much.
  501.                            In the "Small file limit" gadget you can
  502.                            enter the maximum size of files (in
  503.                            blocks), that should be stored within
  504.                            the directory area (default=2). Large
  505.                            values slow down the directory access
  506.                            ("dir", "list"); small values slow down
  507.                            the access to small files. When you
  508.                            optimize boot disks (e.g. for games),
  509.                            larger values can be useful.
  510.  
  511.  
  512.        There is yet another way to control ReOrg: If ReOrg
  513.        is started from Workbench, the ReOrg window becomes an
  514.        "AppWindow". This means, you can drop Workbench icons
  515.        in this window.
  516.  
  517.         - When you drop the icon of a ReOrg settings file in
  518.           the window, ReOrg loads the settings file.
  519.  
  520.         - When you drop a disk icon over one of the device
  521.           scrolling lists (Drive, FROM Drive, TO Drive),
  522.           ReOrg chooses the device name belonging to the
  523.           disk icon.
  524.  
  525.  
  526.  
  527.        When the optimization is started, ReOrg first prompts
  528.        the user to insert the disk(s). After that, a status
  529.        window appears and ReOrg starts reading and processing
  530.        the disk directory.
  531.        During this phase (status = "scanning disk"), ReOrg may
  532.        be interrupted at any time even in one-disk-mode.
  533.        At the end of this phase, ReOrg once again asks the
  534.        user to confirm that the disk should be optimized.
  535.        In one-disk-mode, ReOrg must not be interrupted or
  536.        canceled after this message, or your disk will be
  537.        corrupt.
  538.        During the actual optimization (status = "moving blocks")
  539.        ReOrg shows how much time the optimization will approximately
  540.        need. This display is regularly updated.
  541.        After this phase has been finished, in two-disk-mode ReOrg
  542.        may format unused tracks on the destination disk and copy
  543.        reserved sectors to the destination disk.
  544.        After that, ReOrg asks the user to remove the disk(s).
  545.        Finally, ReOrg shows some statistical information about
  546.        the disk and the optimization.
  547.  
  548.  
  549.        During the optimization, the status window show the
  550.        following information:
  551.  
  552.         - The number of directories and files, which ReOrg has
  553.           already processed ("done") and which ReOrg has
  554.           queued for later processing ("queued").
  555.  
  556.         - The current cache usage. If this value reaches
  557.           100% at any time during the optimization, this
  558.           means that more memory could speed up the
  559.           optimization.
  560.  
  561.         - The cache size (in absolute numbers, and relative
  562.           to the disk size)
  563.  
  564.         - The current status of ReOrg. Possible states are:
  565.           - checking disk       Before the actual optimization
  566.                                 starts, ReOrg checks if your disk
  567.                                 is a valid AmigaDOS disk.
  568.           - scanning disk       ReOrg is reading the disk directory
  569.                                 and is calculating the layout of the
  570.                                 destination disk.
  571.           - awaiting user       ReOrg is waiting for the user to
  572.             response            confirm the start of the
  573.                                 optimization.
  574.           - preparing           ReOrg is creating internal tables that
  575.             optimization        are needed for the optimization.
  576.           - moving blocks       ReOrg is optimizing the disk.
  577.           - writing bitmap      ReOrg is writing the new disk
  578.                                 bitmap.
  579.           - formatting empty    If the user selected "Format: All Tracks",
  580.             tracks              ReOrg formats all unused tracks on the
  581.                                 destination disk.
  582.           - copying reserved    ReOrg is copying reserved blocks
  583.             blocks              (boot blocks etc.).
  584.  
  585.         - The remaining time needed for the optimization (only
  586.           during the phase "moving blocks"). This value is only
  587.           an approximation of the remaining time needed. If source
  588.           and destination devices have a very different speed,
  589.           (e.g. "RAD:" to "DF0:"), the estimation is very inaccurate.
  590.  
  591.         - A graphical display, how many percent of disk blocks
  592.           have already been moved. This percentage also corresponds
  593.           to the percentage of time needed for the optimization.
  594.  
  595.         - If the user selected the gadget "Graphical sector display",
  596.           ReOrg displays on the right side of the window which sectors
  597.           are currently processed.
  598.  
  599.  
  600.  
  601.        5. Error messages
  602.        -----------------
  603.  
  604.        Error code  Meaning
  605.  
  606.          1         AmigaDOS error: The file size does not correspond
  607.                    to the number of data blocks allocated to a file.
  608.  
  609.          2         Device error: I/O error during read
  610.  
  611.          3         Device error: I/O error during write
  612.  
  613.          4         Device error: I/O error during the last write access
  614.  
  615.          5         Device error: I/O error trying to switch the motor
  616.                    of the source drive off
  617.  
  618.          6         Device error: I/O error trying to switch the motor
  619.                    of the destination drive off
  620.  
  621.          7         AmigaDOS error: Invalid block number in
  622.                    directory tree
  623.  
  624.          8         AmigaDOS error: A block is used twice (corresponds
  625.                    to the Disk-Validator error message "Key ### already set")
  626.  
  627.          9         AmigaDOS error: A control block has an invalid
  628.                    identification in the first longword (must equal 2)
  629.  
  630.         10         AmigaDOS error: A control block has an invalid
  631.                    type identification in the last longword (ReOrg
  632.                    currently recognizes types -4, -3, 1, 2, 3, 4)
  633.  
  634.         11         File error: Cannot open option file
  635.  
  636.         12         File error: Cannot read option file
  637.  
  638.         13         File error: Option file has an invalid format
  639.  
  640.         14         File error: Option file has an invalid version
  641.  
  642.         15         File error: Option file is too long (more than
  643.                    65534 lines)
  644.  
  645.         16         File error: Unexpected end of line in option file
  646.  
  647.         17         File error: Invalid option in option file
  648.  
  649.         18         File error: Invalid combination of options in
  650.                    option file
  651.  
  652.         19         Run time error: Not enough memory
  653.  
  654.         20         User mistake: No FROM-device selected
  655.  
  656.         21         User mistake: No device selected
  657.  
  658.         22         User mistake: No TO-device selected
  659.  
  660.         23         User mistake: FROM- and TO-device are the same
  661.  
  662.         24         User mistake: FROM- and TO-device are incompatible
  663.                    to each other
  664.  
  665.         25         Device error: Cannot open device
  666.  
  667.         26         Format error: Disk format unknown
  668.  
  669.         27         Format error: Disk does not have a valid AmigaDOS
  670.                    format
  671.  
  672.         28         File error: Error writing the settings file
  673.  
  674.         29         File error: Error reading the settings file
  675.  
  676.         30         File error: Help file corrupt
  677.  
  678.         31         Device error: I/O error during verify. When this
  679.                    error occurs, you can cancel the optimization,
  680.                    try again to write and read the blocks or ignore
  681.                    the error.
  682.  
  683.         32         User mistake: No disk inserted !
  684.         
  685.         34         User mistake: Disk is write protected !
  686.  
  687.         35         Device error: Difference between read and written
  688.                    data during verify. When this error occurs, you can
  689.                    cancel the optimization, try again to write and read
  690.                    the blocks or ignore the error.
  691.  
  692.        401         Device does not exist (Usually, this error should
  693.                    not occur).
  694.  
  695.        402         Device does not have one of the valid AmigaDOS
  696.                    formats (DOS\0, DOS\1, DOS\2, DOS\3)
  697.  
  698.        403         Block length does not equal 512 bytes.
  699.  
  700.        404         The mountlist entry "SecOrg" is not equal to 0
  701.                    (invalid format ?)
  702.  
  703.        407         The mountlist entry "Reserved" is equal to 0
  704.                    (invalid format ?)
  705.                    
  706.        408         The number of sectors per track is equal to 0
  707.        
  708.        409         Error during 'Inhibit' (Allocating/freeing drive)
  709.  
  710.        502         Warning: Invalid control block encountered while
  711.                    moving blocks.
  712.  
  713.        503         Warning: Invalid data block encountered while
  714.                    moving blocks.
  715.  
  716.        504         The mountlist entry "MaxTrans" is too small to
  717.                    read a whole track. This warning usually just
  718.                    means, that your controller does not initialize
  719.                    its drive description properly.
  720.  
  721.        505         Device error: Error during TD_PROTSTATUS
  722.         
  723.       1xxx         Internal Error: Error numbers larger than 1000
  724.                    are internal errors, that should usually not
  725.                    occur. If you get one of these errors, please
  726.                    inform the author of ReOrg !
  727.  
  728.  
  729.  
  730.  
  731.  
  732.        6. Technical details
  733.        --------------------
  734.  
  735.        - Option "FileExt blocks"
  736.  
  737.          Files larger than 34.3 kB (OFS) or 36 kB (FFS) require
  738.          "FileExt blocks" (also called FileList blocks).
  739.          ReOrg offers three models where to place these blocks
  740.          on the output disk:
  741.  
  742.          1) "Front"      : All FileExt blocks are placed immediately
  743.                            behind the header block. This is the default
  744.                            under Kickstart 1.2/1.3.
  745.  
  746.          2) "Mid"        : All FileExt blocks are placed behind the
  747.                            first sequence of data blocks. This is the
  748.                            default under Kickstart 2.0.
  749.  
  750.          3) "Scatter"    : FileExt blocks are scattered among the
  751.                            data blocks.
  752.  
  753.  
  754.          Recommended Settings:
  755.  
  756.          - If you want to be able to display the directory contents
  757.            of your disk under Kickstart 1.2/1.3: BE SURE TO use the
  758.            setting "FileExt blocks=Front". Otherwise the "dir"-command
  759.            gets even slower than it already is.
  760.  
  761.          - Otherwise: usually "FileExt blocks=Mid" is best for disks
  762.            that are ONLY used under Kickstart 2.0. Sometimes,
  763.            "FileExt blocks=Scatter" can be useful, if large files are
  764.            read only sequentially using small program buffers (most
  765.            C-programs use very small buffers (512 bytes)). For those
  766.            programs sequential file access gets faster, if you
  767.            choose the setting "FileExt blocks=Scatter".
  768.  
  769.          - Exception: When you reorganize Boot disks, for which you
  770.            NEVER read the directory under Kickstart 1.2/1.3 (e.g.
  771.            Game boot disks), the setting "FileExt blocks=Scatter"
  772.            often gives the best results - under Kickstart 1.2/1.3 as
  773.            well as under Kickstart 2.0.
  774.  
  775.          - Another Exception: When the disk contains large files
  776.            which are accessed in relative mode (using Seek()),
  777.            you should NOT use the setting "FileExt blocks=Scatter".
  778.  
  779.  
  780.        - Partition half
  781.  
  782.          It is possible to store file data mainly in the
  783.  
  784.           - Upper or
  785.           - Lower
  786.  
  787.          partition half. Usually there is not much difference
  788.          between both settings. The decision which setting
  789.          is better usually depends on the amount of data
  790.          on the partition.
  791.  
  792.  
  793.  
  794.        - Options "Workbench mode" and "Small file limit"
  795.  
  796.          For each file, ReOrg decides whether to store the file
  797.          contents behind the header block or in the data area.
  798.  
  799.          - data stored after the header block:
  800.            - File access gets faster
  801.            - Directory access gets slower (particularly for
  802.              large files)
  803.  
  804.          - data stored in data area:
  805.            - File access gets slower
  806.            - Directory access may get faster
  807.  
  808.        When you use the option "Workbench mode", ReOrg stores
  809.        all "#?.info" and ".backdrop" files after the header block.
  810.        This makes Workbench icons appear faster. However,
  811.        directory access from the shell may become slower.
  812.  
  813.        The option "Small file limit" makes ReOrg store the contents
  814.        of small files (default: up to 2 blocks size) after the
  815.        header block, to increase file access speed. This does not
  816.        slow down directory accesses considerably, but file access
  817.        to small files gets much faster.
  818.        If you only want to have fast directory access, you can set
  819.        this option to "0".
  820.  
  821.        Directory accesses get fastest, if you switch off "Workbench
  822.        mode" and set "Small file limit" to "0".
  823.  
  824.  
  825.  
  826.        Some details about the technical process of optimization:
  827.  
  828.        - The "bitmap" of the source disk is not needed by ReOrg.
  829.          Therefore it is not necessary to "validate" your disk
  830.          before optimizing it.
  831.  
  832.        - Before ReOrg changes anything on your disk, it
  833.          first checks the structure of your disk. However,
  834.          this check is not complete, i.e. ReOrg does not
  835.          detect all possible structural defects (btw, even
  836.          the AmigaDOS Disk-Validator does not detect and
  837.          correct all defects !).
  838.          When ReOrg reports an error in the first phase, it
  839.          has not destroyed or changed your disk yet in any
  840.          way. But when the phase "moving blocks" starts,
  841.          ReOrg must not be interrupted any more, because
  842.          in this phase ReOrg rearranges the disk layout.
  843.  
  844.        - Anyway I STRONGLY RECOMMEND to THOROUGHLY check your
  845.          disk for structural defects before optimizing it.
  846.          Otherwise ReOrg might report an error in the
  847.          "moving blocks" phase and might even destroy your
  848.          disk (although this is very unlikely).
  849.  
  850.        - If ReOrg stops or is interrupted in the "moving
  851.          blocks" phase, the following things happen:
  852.  
  853.           - Your disk is displayed on Workbench as "DF0:REOR"
  854.             (DF0 being the drive that contains your disk).
  855.           - When you try to access your disk, AmigaDOS reports
  856.             "Not a DOS disk".
  857.           - The contents of your disk are TOTALLY UNUSABLE AND
  858.             COMPLETELY DESTROYED.
  859.  
  860.          In this situation there is only one thing you can do:
  861.  
  862.          !!! Reformat your disk ("format ... quick") and !!!
  863.          !!! restore your backup.                        !!!
  864.  
  865.          Do not trust "hints" from computer magazines telling you,
  866.          you could still repair parts of your disk. I explicitly
  867.          warn you:
  868.  
  869.          !!! Do not try to repair your disk using tools like         !!!
  870.          !!! "disksalv", "fixdisk", "diskdoctor" or any commercial   !!!
  871.          !!! disk tools !                                            !!!
  872.          !!! Although you might by coincidence really restore some   !!!
  873.          !!! of your files, you will most certainly "restore" a lot  !!!
  874.          !!! of corrupt files, but you will not get an error         !!!
  875.          !!! message from your disk recovery tool. This is           !!!
  876.          !!! especially true if your disk has the FFS format.        !!!
  877.          !!! "Repairing" corrupt program files may very well lead to !!!
  878.          !!! MASSIVE computer crashes in the future. So: Always      !!!
  879.          !!! restore your backup when ReOrg does not complete the    !!!
  880.          !!! "moving blocks" phase !                                 !!!
  881.  
  882.  
  883.  
  884.  
  885.  
  886.  
  887.        7. Option file format
  888.        ---------------------
  889.  
  890.        Most users will probably not needed option files.
  891.        However, option files are useful to make some "final"
  892.        optimizations, e.g. before disks are distributed.
  893.        Especially when you optimize game boot disks, a
  894.        "perfect" optimization using option files may save
  895.        you some seconds when you boot from your disk.
  896.  
  897.        Option files allow you to change the settings of
  898.        the "FileExt blocks" option and to specify the
  899.        placement of data blocks for individual files.
  900.        These settings override the global settings for
  901.        single files.
  902.  
  903.        Example: You want to optimize a game boot disk, that
  904.                 contains a lot of files. You therefore used
  905.                 the global setting "FileExt blocks=Scatter"
  906.                 (An explanation, why this makes sense, can be
  907.                 found in the section "6. Technical details").
  908.                 The disadvantage of this setting is, that
  909.                 relative accesses to large files become slower.
  910.                 When you know, that your game often accesses a
  911.                 single large file in relative mode (let's say
  912.                 the name of this file is "graphics/dungeon.gfx"),
  913.                 you should change the setting of "FileExt blocks"
  914.                 to "Front" for this single file only. This kind
  915.                 of settings can be specified in option files.
  916.  
  917.  
  918.        Option files are ordinary ASCII text files. You can use
  919.        any ASCII text editor to create and edit them (e.g. MEmacs).
  920.  
  921.        Format:
  922.  
  923.        1st line:
  924. $1
  925.        (A dollar sign ("$") and the digit One ("1") in the first
  926.        two columns of the line)
  927.  
  928.        all other lines:
  929.  
  930. options:file name:comment
  931.  
  932.        valid options are:
  933.         I0       Data blocks of this file are not placed near
  934.                  the header block (default)
  935.         I1       Data blocks of this file are placed near the
  936.                  header block (file access gets faster, directory
  937.                  access gets slower)
  938.         E0       The same as "FileExt blocks=Front" for a single file.
  939.         E1       The same as "FileExt blocks=Scatter" for a single file.
  940.         E2       The same as "FileExt blocks=Mid" for a single file.
  941.  
  942.         You can combine several options in a single line
  943.         (e.g.: E0I1:file name:comment)
  944.         The above example:
  945. $1
  946. E0:graphics/dungeon.gfx:any comment
  947.  
  948.       Some more notes about the file format
  949.        - The file name must be specified relative to the root
  950.          of the disk, i.e. please do not write "/test/name.doc",
  951.          "sys:test/name.doc" or "diskname:test/name.doc", but
  952.          only "test/name.doc"
  953.        - Spaces and other special characters may occur in the
  954.          file name. You need not (and must not) use quotation
  955.          marks to surround the file name !
  956.        - Patterns (e,g, "*.txt" or "#?.txt") are not allowed !
  957.  
  958.  
  959.  
  960.  
  961.        8. Program version, update info
  962.        -------------------------------
  963.  
  964.        - V2.33 (Rev 99, 30.09.1992, 5th release)
  965.  
  966.            Changes since V2.32:
  967.              - Fixed a bug that could cause deadlocks during
  968.                the "moving blocks" phase at "99% finished"
  969.  
  970.        - V2.32 (Rev 94, 16.07.1992, 4th release)
  971.  
  972.            Changes since V2.31:
  973.              - ReOrg can now handle Kickstart-1.1 compatible
  974.                Mountlist/Rigiddisk entries. This prevents
  975.                problems with A209x controllers and the old
  976.                "prep" program.
  977.  
  978.        - V2.31 (Rev 88, 04.07.1992, 3rd release)
  979.  
  980.            Changes since V2.3:
  981.              - ReOrg no longer crashes, when you move the ReOrg window
  982.                to the far right side of the screen, hit "start" and
  983.                acknowledge the requester
  984.              - The "moving blocks" phase now contains additional
  985.                code to recognize and circumvent deadlock situations
  986.              - Error #33 has become Warning #505 and can now be
  987.                skipped by the user
  988.        
  989.        - V2.3 (Rev 75, 20.06.1992, 2nd release)
  990.        
  991.            Changes since V2.1:
  992.              - ReOrg now correctly works with cache sizes
  993.                larger that 8 MB
  994.              - all windows use the font "topaz 8"
  995.              - ReOrg no longer crashes if an error occurs before
  996.                ReOrg has opened its window (e.g. if you specify
  997.                a wrong name for the initial settings file)
  998.              - ReOrg uses the "DrawInfo" structure to make all
  999.                texts readable even on 2-color screens
  1000.              - obsolete ".info" files are treated like all other
  1001.                "#?.info" files
  1002.              - Real double buffering has been implemented for
  1003.                all read accesses as well ==> speed increase
  1004.              - menu texts are displayed in the screen default
  1005.                font
  1006.              - asynchronous I/O is used even in one-disk mode
  1007.              - slight changes in the "moving blocks" phase to
  1008.                increase speed
  1009.              - Handling of TD_GETGEOMETRY greatly improved.
  1010.                Crashes are much less likely now.
  1011.              - Error messages #406 ("MaxTransfer to small") has
  1012.                become a warning now (#504) and can be skipped by
  1013.                the user
  1014.              - ToolType "PUBSCREEN" works correctly
  1015.              - ToolType "SCREENMODE" implemented to force ReOrg
  1016.                to open on an own custom screen
  1017.              - If read/write errors occur during the "moving
  1018.                blocks" phase, the user can now "repeat" the
  1019.                I/O or "ignore" the error. This means the
  1020.                optimization can be finished even if errors
  1021.                occur.
  1022.              - The mountlist entry "Mask" is used to prevent
  1023.                problems with old DMA controllers in combination
  1024.                with turbo boards.
  1025.              - Compatibility of Verify improved:
  1026.                - No more errors when the device does not recognize
  1027.                  CMD_UPDATE
  1028.                - ReOrg automatically switches to (slower)
  1029.                  synchronous verify if the device does not
  1030.                  support (faster) asynchronous verify.
  1031.              - Fixed a problem at the end of the optimization,
  1032.                that occured if the volume had the same name
  1033.                as the device.
  1034.  
  1035.  
  1036.        - V2.2 (several Revs, intermediate internal version)       
  1037.  
  1038.        - V2.1 (Rev 49, 28.05.1992, 1st release)       
  1039.  
  1040.  
  1041.  
  1042.  
  1043.        In addition to ReOrg V2.33, there is another current
  1044.        ReOrg version, that also runs under Kickstart 1.2/1.3.
  1045.        The version number is V1.1.
  1046.  
  1047.        If you have ReOrg versions V0.9, V0.99 or V1.0,
  1048.        please DELETE them. They are internal beta-test versions.
  1049.  
  1050.        I will try and further improve ReOrg V2.33 if I have
  1051.        time for it. Registered users will get a notification
  1052.        when new versions of ReOrg get available, that contain
  1053.        significant changes or enhancements.
  1054.  
  1055.        But I will probably not change the Kickstart 1.2/1.3-
  1056.        compatible ReOrg version V1.1 any more. I guess that
  1057.        most Users will upgrade to Kickstart 2.04 after some
  1058.        time anyway, so they can use ReOrg V2.33.
  1059.  
  1060.        Besides ReOrg V2.33 contains some improvements that
  1061.        have not been implemented in ReOrg V1.1. One of them
  1062.        is: ReOrg V2.33 needs much less memory to optimize large
  1063.        hard disk partitions than ReOrg V1.1.
  1064.  
  1065.        In order to be able to improve / correct ReOrg, I would like
  1066.        to ask every user to do the following things:
  1067.  
  1068.          - send me the registration fee
  1069.  
  1070.          - send me bug reports, if you find any bugs
  1071.  
  1072.          - give me hints how to improve ReOrg
  1073.  
  1074.        Thank you very much in advance !
  1075.  
  1076.  
  1077.        My personal future plans for ReOrg, if I have time for them:
  1078.  
  1079.          - Implement an option to convert disks between the
  1080.            "ordinary" disk formats to/from the International
  1081.            FileSystem format
  1082.            (i.e. DOS\0 <--> DOS\2, and DOS\1 <--> DOS\3)
  1083.          - Support for "locale.library" to adapt ReOrg to
  1084.            different languages
  1085.  
  1086.        I will be thankful for other ideas.
  1087.  
  1088.  
  1089.  
  1090.        9. Acknowledgements
  1091.        -------------------
  1092.  
  1093.  
  1094.        Thank you to all beta-testers of ReOrg !
  1095.        These are:
  1096.  
  1097.        Thomas Esser, Oliver Kasper, Carsten Lechte, Holger Lubitz,
  1098.        Michael Rohrdrommel, Kai Siering, Christian Soltenborn,
  1099.        Christian Wolf and Michael Zielinski.
  1100.  
  1101.  
  1102.        Thank you to Christian Wolf for distributing
  1103.        ReOrg via FTP !
  1104.  
  1105.  
  1106.        ... last but not least many thanks in advance to all
  1107.        ReOrg users who send me the registration fee !
  1108.  
  1109.  
  1110.        Holger Kruse
  1111.