home *** CD-ROM | disk | FTP | other *** search
/ Frostbyte's 1980s DOS Shareware Collection / floppyshareware.zip / floppyshareware / GLEN / ORG217SW.ZIP / ORG21.DOC < prev    next >
Text File  |  1991-07-03  |  49KB  |  1,162 lines
  1.  
  2.  
  3.           Documentation for ORG V:2.1         Copyright 90/91, M.H. Greve
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.                         ORG - Hard Disk Organizer Utility
  25.  
  26.                               Copyright (1990/1991)
  27.                              M.H. Greve + D. Rifkind
  28.                                All Rights Reserved
  29.  
  30.  
  31.  
  32.                         Distributed by:
  33.  
  34.                                Greve Computer Systems
  35.                                Aubrigstrasse 23
  36.                                CH 8804 AU
  37.                                Switzerland
  38.  
  39.  
  40.  
  41.                         Date:  April 6. 1991
  42.  
  43.  
  44.  
  45.  
  46.  
  47.           Documentation for ORG V:2.1         Copyright 90/91, M.H. Greve
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.                                      TABLE OF CONTENTS
  56.  
  57.  
  58.        1. Introduction                                               1
  59.        2. Getting Started - Installation                             2
  60.        3. About ORG                                                  4
  61.        4. The Configuration File                                     6
  62.        5. Command Line Switches                                     12
  63.        6. Limitations and Restrictions                              14
  64.        7. Acknowledgment                                            15
  65.  
  66.           Appendix A - Program Termination codes                    16
  67.           Appendix B - Error Messages                               17
  68.           Appendix C - Bugs                                         19
  69.           Appendix D - Techincal Support                            20
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.                                        Page 1
  77.           
  78.           Documentation for ORG V:2.1         Copyright 90/91, M.H. Greve
  79.  
  80.  
  81.  
  82.  
  83.        1. INTRODUCTION
  84.        ---------------
  85.  
  86.           ORG is a Disk Organizer with a lot of features not found in
  87.           other similar programs. In addition to the traditional function
  88.           of un-fragmenting your disk, ORG will allow you to customize the
  89.           sequence in which files are placed on the disk, let you "lock"
  90.           (leave unchanged) any file or group of files, sort files in any
  91.           directory and delete temporary files on the fly, all in a single
  92.           pass.  Moreover, ORG does this as fast or faster than most
  93.           commercially available unfragmentation software. As you will
  94.           discover when you use the program:
  95.  
  96.           "ORG is the only Disk Organizer that truly deserves the name!"
  97.  
  98.  
  99.  
  100.           User Supported Software:
  101.           ------------------------
  102.  
  103.           ORG is distributed as "Shareware" or "User Supported Software"
  104.           and is fully copyrighted.  You may have received a copy of ORG
  105.           free from a friend or a bulletin board or (for a nominal fee)
  106.           from a user's group or Shareware library.  However you received
  107.           ORG, you have a perfectly legal copy of the software.  You are
  108.           encouraged to make as many copies of the software and this
  109.           documentation as you like and distribute it to anyone you want,
  110.           as long as you do not charge a fee (other than to cover your own
  111.           distribution cost) and distribute only complete, unaltered copies
  112.           of the package, exactly as you received it.  If, after trying the
  113.           program for a few weeks, you find it useful and use it regularly,
  114.           you must register your copy by completing the form included in the
  115.           file "ORG21.REG" included in the distribution package.
  116.  
  117.           As a registered user you will receive a copy of the very latest
  118.           version of ORG and will be entitled to free support and will
  119.           receive upgrade notices and "bug fixes" as and when these become
  120.           available (for one full year from the date of purchase).
  121.  
  122.  
  123.  
  124.  
  125.  
  126.                                        Page 2
  127.           
  128.           Documentation for ORG V:2.1         Copyright 90/91, M.H. Greve
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.        2. GETTING STARTED & INSTALLATION
  137.        ---------------------------------
  138.  
  139.           This section provides step by step instructions for running ORG
  140.           on any drive of a standard IBM PS/2, IBM PC, XT, AT, or any 100%
  141.           compatible running under MSDOS 2.10, or higher.
  142.  
  143.           If you are eager to run ORG right away, you need only read this
  144.           chapter now and can revert to the rest of the documentation for
  145.           a detailed description of the program's features and options
  146.           later.
  147.  
  148.           Note that you should never attempt to run ORG under a multi-
  149.           tasking operating system or OS-shell such as OS/2, Windows,
  150.           DesqView or Software Carousel, nor activate any "pop-up" program
  151.           (eg. SideKick) while the program is running.
  152.  
  153.           1. Before you start, use the DOS DISKCOPY command to make a
  154.              duplicate of the distribution disk or, if you downloaded ORG
  155.              from a bulletin board, save the archive file onto two
  156.              diskettes and store one (the original) in a safe place.
  157.  
  158.           2. ORG does not require any special installation procedure. You
  159.              may run ORG from the backup floppy disk or from a subdirectory
  160.              on your hard disk.  If you wish to run the program from your
  161.              hard disk, copy the ORG.EXE program file to a subdirectory
  162.              which is included in your DOS PATH (see your DOS User's Guide)
  163.              and place the ORG.CFG file in the same directory or in the
  164.              root directory of the drive you wish to "unfragment".
  165.  
  166.           3. If you are running ORG for the first time, make sure you have
  167.              a current backup of the drive you wish to unfragment. You may
  168.              also wish to remove any resident utilities such as disk-cache
  169.              programs in order to avoid any potential conflicts.
  170.  
  171.           4. Run the DOS CHKDSK program on the drive and correct any errors
  172.              reported by it before proceeding further. If there are lost
  173.              clusters or cross-linked files on the disk, ORG will detect
  174.              this and refuse to run.
  175.  
  176.           5. Make the drive and/or directory containing ORG.EXE the current
  177.              drive/directory. (Not necessary if ORG.CFG is in a directory
  178.              contained in your PATH).
  179.  
  180.  
  181.                                        Page 3
  182.           
  183.           Documentation for ORG V:2.1         Copyright 90/91, M.H. Greve
  184.  
  185.  
  186.  
  187.  
  188.           6. Start ORG from the DOS prompt by typing:
  189.  
  190.                      ORG [d:] [/F] [/SIM] <Enter>
  191.  
  192.           The parameter d: is any valid drive specifier known to your system
  193.           (except a RAM disk or Network drive). ORG assumes the current
  194.           default drive if you omit the drive specifier.  Normally, ORG will
  195.           only unfragment the files without regard to their sequence on the
  196.           drive.  The /F parameter causes ORG to perform a complete disk
  197.           organization, placing files in the sequence specified in the
  198.           configuration file (see chapter 4:  The Configuration File).  In
  199.           default mode, ORG will normally optimize a 30MB drive in less than
  200.           two minutes.  The /SIM parameter (simulation mode) prevents ORG
  201.           from actually writing anything to disk.  As a first time user, you
  202.           may wish to use /SIM to uncover any potential conflicts with your
  203.           computer setup.
  204.  
  205.           ORG first reads the configuration file, evaluates the disk's drive
  206.           parameters, reads the FAT (File allocation Table) and directory
  207.           structure and, if necessary, sorts your files.  A window displays
  208.           ORG's progress through these steps.  ORG will pause and wait for
  209.           you to press the <Enter> key before proceeding to unfragment the
  210.           drive. If you did not copy the configuration file, ORG will warn
  211.           you of this and will use its own internal default settings.  You
  212.           may view these defaults and the configuration settings by pressing
  213.           the <F1> key.  If you decide you don't want to run ORG right now,
  214.           press <Esc>, and ORG will return you to the DOS environment.
  215.  
  216.           If you have used other unfragmentation programs before, the screen
  217.           layout with the large symbolic map of your disk will look
  218.           familiar.  To the right of the drive map,  ORG displays some of
  219.           the drive's parameters, a description of the symbols used, and
  220.           it's memory usage.  The %-completed and elapse-time displays in
  221.           the lower right corner provide an indication of ORG's progress.
  222.  
  223.           ORG can take anywhere from a few seconds to several minutes to
  224.           unfragment your disk.  Typically, it will take 1 to 2 minutes
  225.           to unfragment a 32MB partition with about 20MB of data.  You may
  226.           abort ORG at any time by simply pressing the <Esc> key.  The
  227.           integrity of your data is guaranteed if you exit in this manner.
  228.  
  229.           After optimization is completed, ORG will ask whether you wish to
  230.           re-boot the system.  Certain resident programs retain information
  231.           about the previous state of the disk.  Unless you are sure that
  232.           you have no such programs in your system, you should type "Y" to
  233.           allow ORG to initiate a system reset. (The re-boot query is not
  234.           displayed if you have used ORG on a removeable diskette).
  235.  
  236.                                        Page 4
  237.           
  238.           Documentation for ORG V:2.1         Copyright 90/91, M.H. Greve
  239.  
  240.  
  241.  
  242.  
  243.           Laptop users:
  244.           -------------
  245.  
  246.           If you are running ORG on a laptop computer you may find the
  247.           display difficult to read.  This is because Laptops often emulate
  248.           color displays on the built in monochrome screen, making certain
  249.           colors hard to distinguish.  In such cases, re-start ORG using
  250.           the /L command line switch which forces ORG to use its monochrome
  251.           display settings irrespective of the type of video adaptor in-
  252.           stalled  (see chapter 5: Command Line Switches).
  253.  
  254.           WARNING!
  255.           --------
  256.  
  257.           NEVER re-boot or switch off the computer while ORG is running, as
  258.           this may cause loss of data. As a precaution, it is a good idea
  259.           to run ORG after you have made a backup of your hard disk,
  260.           particularly if you live in an area where power dips are common.
  261.  
  262.  
  263.  
  264.        3. ABOUT ORG
  265.        ------------
  266.  
  267.           You may run ORG on any valid drive in your system. This may be
  268.           a floppy, a hard disk, or a logical partition on your hard disk.
  269.           ORG should not be run on virtual (RAM) drives or Network drives
  270.           and will issue a warning if you specify one accidentally.  If
  271.           your computer is equipped with an EGA or VGA screen, ORG will
  272.           detect when the screen is set to 43/50 line and automatically use
  273.           the full screen display.  You may force ORG to display in either
  274.           25-line or 43/50-line mode by using the appropriate command line
  275.           switches (see Chapter 5).  If available, ORG will use expanded or
  276.           extended memory for its tables and buffers.  It requires the EMS
  277.           driver version 3.2 or above to access expanded memory.  Extended
  278.           memory requires the Microsoft XMS interface (HIMEM.SYS) to be
  279.           loaded in your system.
  280.  
  281.  
  282.           How ORG works:
  283.           --------------
  284.  
  285.           After you start ORG, the program notes any command line options
  286.           and then searches for the configuration file ORG.CFG. ORG searches
  287.           for this file in the root directory of the target drive you
  288.           specified and then in the drive/directory from which ORG was
  289.           loaded.  ORG does not search your system's PATH.  This somewhat
  290.  
  291.                                        Page 5
  292.           
  293.           Documentation for ORG V:2.1         Copyright 90/91, M.H. Greve
  294.  
  295.  
  296.  
  297.  
  298.           restrictive search ensures good control over the configuration
  299.           file used and prevents ORG from accidentally loading an old
  300.           version that may be "visible" in your DOS PATH.  ORG.CFG contains
  301.           a list of special commands that allow you to control the way in
  302.           which ORG organizes the files on your disk. (Refer to chapter 4:
  303.           The Configuration File).
  304.  
  305.           ORG reads and analyses the parameters, directory structure and
  306.           FAT (File Allocation Table) of the drive and processes the
  307.           "delete" and "sort" command functions in memory, WITHOUT writing
  308.           to your hard disk.  ORG pauses at this stage and waits for you to
  309.           press the <Enter> key before beginning to organize the files.  If
  310.           you abort the program by pressing the <Esc> key at this stage, no
  311.           data on the disk will have been modified.
  312.  
  313.           By pressing the <F1> key you can view the configuration settings
  314.           before proceeding, to assure yourself that ORG will perform the
  315.           desired operations.
  316.  
  317.           Once ORG has started organizing the drive, you can still safely
  318.           interrupt the process at any time by pressing the <Esc> key. The
  319.           consistency and integrity of your files is guaranteed if you exit
  320.           ORG in this way, however ALL files which you flagged for deletion
  321.           will have been erased.
  322.  
  323.           WARNING: NEVER power off or re-boot your computer while ORG is
  324.                    running as this may cause loss of data integrity which
  325.                    can be very difficult to recover even with programs such
  326.                    as the Norton (TM) Utilites.
  327.  
  328.  
  329.           While ORG runs, it displays its progress on a disk-map in a window
  330.           of your screen.  In this map, each visible block corresponds to
  331.           one or more physical clusters on the drive.  The blocks that have
  332.           already been processed are highlighted.  Special symbols are used
  333.           to indicate locked or bad clusters.  The blocks being moved are
  334.           highlighted with an 'r' (read) or 'W' (write).  Note that ORG will
  335.           always move the largest possible contiguous block of clusters.  If
  336.           it can, it will move them to the final destination immediately. If
  337.           not, it will write them to the end of the disk temporarily.  This
  338.           process is very efficient since it ensures that each cluster on
  339.           the disk is never moved more than twice in a session.
  340.  
  341.           Frequently, ORG will detect that it already has the clusters it
  342.           needs in memory and will not re-read them.  This feature not only
  343.           saves time, but also prevents a lot of unnecessary "head-
  344.           thrashing" action.
  345.  
  346.                                        Page 6
  347.           
  348.           Documentation for ORG V:2.1         Copyright 90/91, M.H. Greve
  349.  
  350.  
  351.  
  352.  
  353.           ORG updates the FAT and directory areas after writing each group
  354.           of blocks, ensuring disk integrity as far as technically possible.
  355.           In fact, loss of data is only possible during the relatively
  356.           short time when the directories and FAT are "out of synch".  This
  357.           is important, because ORG will retain data integrity at all other
  358.           times, even if a power dip were to occur during a "write" to the
  359.           data area.
  360.  
  361.           You will notice that ORG often appears to read or write to a
  362.           protected area or an area that has already been processed. This
  363.           is normal and is because each block usually represents several
  364.           clusters.
  365.  
  366.           The highlighted box to the right of the disk-map displays the
  367.           currently available command(s).  A "percent completed" counter
  368.           above this box keeps track of ORG's progress.
  369.  
  370.  
  371.           File order and sequence:
  372.           ------------------------
  373.  
  374.           In its default mode ORG ignores file order and sequence on the
  375.           drive.  The algorithm used ensures that only a minimal number of
  376.           files will be moved to fully unfragment the drive and fill any
  377.           gaps between files.  By filling gaps ORG prevents the drive from
  378.           becoming rapidly fragmented again, since new files will be created
  379.           at the end of the existing contiguous data area.  When the /f
  380.           option is specified, ORG will order all files sequentially on the
  381.           drive:  It places all directories first on the drive and then
  382.           places remaining files in the sequence in which it encounters the
  383.           file name entries in the (sub)directories.  You may override or
  384.           modify these default settings by using the "sort" and "order"
  385.           commands in the configuration file, ORG.CFG (see Chapter 4: The
  386.           Configuration File).
  387.  
  388.           If you were to compare the result of organizing a disk under ORG
  389.           with that of other similar programs, you might find that some
  390.           programs will start organizing the disk over again.  This does not
  391.           mean that ORG failed to optimize your disk, it merely indicates
  392.           that there is more than one valid way (and no right way) to
  393.           organize directories and files on the disk.
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.                                        Page 7
  402.           
  403.           Documentation for ORG V:2.1         Copyright 90/91, M.H. Greve
  404.  
  405.  
  406.  
  407.  
  408.        4. THE CONFIGURATION FILE
  409.        -------------------------
  410.  
  411.           The features available to you through use of the configuration
  412.           file make ORG the most powerful and versatile Disk Organizer
  413.           available today.
  414.  
  415.           The configuration file is an ASCII text file containing special
  416.           ORG commands, similar to a DOS batch file. When you run ORG
  417.           without specifying a configuration file name, it searches for
  418.           the ORG.CFG file in the root directory of the target drive you
  419.           selected when you started the program and then in the drive/path
  420.           where the ORG.EXE program resides.  This restrictive search
  421.           lets you keep a customized configuration file for each drive in
  422.           the root directory of your hard disk.
  423.  
  424.           NOTE:
  425.           Under DOS versions earlier than 3.0, ORG will search for the
  426.           configuration file in the current default directory (CWD) instead
  427.           of in the directory from which ORG.EXE was loaded.
  428.  
  429.           ORG allows you to override the default name of the configuration
  430.           file (ORG.CFG), by simply specifying a file name of the form
  431.           "/@[d:][\pathspec\]filename" on the ORG command line. If you only
  432.           specify a filename, ORG will search the root directory of the
  433.           target drive and directory where the ORG.EXE program resides.
  434.           The configuration filespec must be immediately preceded by the
  435.           "@" sign.
  436.  
  437.           ORG.CFG uses a simple command structure similar to that used in
  438.           compiler MAKE files.  A sample configuration file (ORG.CFG) is
  439.           included in the ORG package. Each line in the configuration file
  440.           represents a command for ORG.  The command syntax is:
  441.  
  442.           <function> [\path\][filename]  [qualifier]  [#<comment>]
  443.  
  444.           The first element on each line is the function to be performed.
  445.           This is followed by a file specifier in the form "path\filename".
  446.           Each command can take a qualifier that tells ORG which file
  447.           attributes are to be used to further specify the file(s). If you
  448.           specified the "sort" command (see below), the qualifier has a
  449.           different meaning: it indicates the type and sequence of the sort
  450.           keys.
  451.  
  452.  
  453.  
  454.  
  455.  
  456.                                        Page 8
  457.           
  458.           Documentation for ORG V:2.1         Copyright 90/91, M.H. Greve
  459.  
  460.  
  461.  
  462.  
  463.           Here are a few examples of valid commands:
  464.  
  465.           lock     *.* +s           # lock all system files
  466.           delete   \TEMP\*.back     # delete all .BACK files
  467.           sort     +n-t             # sort by filename, newest files first
  468.           order    *.EXE            # place all .EXE files first
  469.           In the following you will find a detailed description of each
  470.           element of the configuration command:
  471.  
  472.  
  473.           Commands:
  474.           ---------
  475.  
  476.           lock -   prevents ORG from moving a specified file or group of
  477.                    files on the drive. This is essential to avoid moving
  478.                    files such as your DOS system files on the bootable
  479.                    partition of your disk.  It may also be necessary to
  480.                    lock the identification files used by certain copy-
  481.                    protected software. The "lock" function takes an optional
  482.                    attribute parameter.  ORG's default setting locks all
  483.                    "system" files.  You may disable this default setting
  484.                    using the /nod command line option.
  485.  
  486.  
  487.           sort -   allows you to sort the contents of the directory in
  488.                    ascending or descending order by filename, extension,
  489.                    date & time, or size. A sort is always performed on an
  490.                    entire directory; if a filename is given, it is ignored
  491.                    by ORG for the sort operation. The qualifier determines
  492.                    the type and sequence of the sort operation.
  493.  
  494.                    The command always places subdirectories first and then
  495.                    sorts directory names and filenames in two consecutive
  496.                    passes.
  497.  
  498.                    Note:  ORG processes directories and files in the order
  499.                    in which they are encountered.  Using the "sort" command
  500.                    thus affects the sequence in which ORG will place the
  501.                    files on the drive.  The "order" command described below
  502.                    allows you to override this sequence by specifying that
  503.                    certain files (or groups of files) be processed first.
  504.  
  505.  
  506.           order -  allows you to force certain files, or groups of files
  507.                    (specified using DOS style wild selections) to be placed
  508.                    first on the disk.  If you use several "order" commands,
  509.  
  510.  
  511.                                        Page 9
  512.           
  513.           Documentation for ORG V:2.1         Copyright 90/91, M.H. Greve
  514.  
  515.  
  516.  
  517.  
  518.                    they are processed in the sequence in which they appear
  519.                    in the configuration file.  If a group of files is
  520.                    specified, they are processed in sequence, by directory
  521.                    and in the sequence in which they appear in the directory
  522.                    structure.
  523.  
  524.                    Do not confuse this command with the "sort" command
  525.                    described above, which sorts directory and file names
  526.                    and thus implicitly determines the sequence of files.
  527.  
  528.                    As with the lock and delete options, you may specify one
  529.                    or more file attributes as qualifiers for the path\
  530.                    filename spec.  Note that ORG's default settings will
  531.                    place all directories first on the disk (behind the
  532.                    system files and/or the Volume identifier).  You may
  533.                    disable this default setting using the /nod command line
  534.                    option.
  535.  
  536.           delete - allows you to specify a file or group of files that you
  537.                    wish to delete from the drive.  For example, you might
  538.                    want to delete .BAK or .TMP files on your drive prior to
  539.                    unfragmenting. The default setting only allows ORG to
  540.                    delete normal files that is, files that have either no
  541.                    attributes or only the "archive" attribute set.  You may
  542.                    override this default by explicitly specifying one or
  543.                    more file attributes.
  544.  
  545.                    NOTE: Use this command with care, because if you
  546.                    accidentally delete a file with ORG, you will NOT be able
  547.                    to "un-erase" it any more later! For this reason, ORG
  548.                    will ignore a command to delete all files on the disk.
  549.                    ORG will also ignore requests to delete directories.
  550.  
  551.           The order in which commands are executed by ORG is fixed in the
  552.           program. Irrespective of where they appear in the configuration
  553.           file, commands are processed in the following sequence:
  554.  
  555.                 1.  lock
  556.                 2.  delete
  557.                 3.  sort
  558.                 4.  order
  559.  
  560.           Because any "lock" commands are processed first, they will take
  561.           precedence over "delete" commands that occur later, ie. ORG will
  562.           NOT delete files that have been "frozen" by a previous lock
  563.           command.
  564.  
  565.  
  566.                                        Page 10
  567.  
  568.        Documentation for ORG V:2.1            Copyright 90/91, M.H. Greve
  569.  
  570.  
  571.  
  572.  
  573.           If several similar commands occur, they are processed in the order
  574.           in which they appear in the configuration file, eg:
  575.  
  576.             order  \command.com
  577.             order  *.COM
  578.             order  *.EXE
  579.  
  580.  
  581.           The Path/Filename Specifier:
  582.           ----------------------------
  583.  
  584.           The second element in a command is the filename specifier. This
  585.           element follows MS-DOS conventions for directory and filenames.
  586.           You may specify any valid path (commands with invalid paths are
  587.           ignored; no error message is generated).
  588.  
  589.           The filename may contain the "wild-card" symbols '*' and '?'. The
  590.           filename may be omitted entirely if the pathname is terminated
  591.           by a backslash (\). ORG will then assume you specified all files
  592.           in this directory.  The following are some examples of valid
  593.           filename specifiers:
  594.  
  595.           delete   \brief\backup\   # delete all files in \BRIEF\BACKUP
  596.           order    \*.WK1           # place all Lotus 2.xx files first
  597.           delete   *.tmp  +r        # delete .TMP files, including read-only
  598.  
  599.           Note that the path\filename specifier is optional, however it may
  600.           only be omitted if you provide a qualifier on the line. This means
  601.           you must EITHER include a filename OR a qualifier (see below) and
  602.           may not omit both; a command containing a function only is
  603.           flagged as an error.
  604.  
  605.  
  606.  
  607.           The Command Qualifier:
  608.           ----------------------
  609.  
  610.           The qualifier has two functions.  For the "lock", "delete" and
  611.           "order" options it specifies the desired file attributes. For the
  612.           "sort" option, it defines the type, sequence and order (ascending
  613.           or descending) of sorting.  The qualifier is always optional.
  614.           Valid file attribute qualifiers are:
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.                                        Page 11
  622.           
  623.        Documentation for ORG V:2.1            Copyright 90/91, M.H. Greve
  624.  
  625.  
  626.  
  627.  
  628.               +r        # Read-only files
  629.               +h        # Hidden files
  630.               +s        # System files
  631.               +d        # subdirectories
  632.               +a        # archive files
  633.  
  634.           A '+' (plus) or '-' (minus) sign must precede the attribute.  The
  635.           sign is used solely as a separator between consecutive attributes
  636.           and has no other meaning: it does NOT qualify the attribute. Both
  637.           signs are allowed for consistency with the sort qualifiers
  638.           described below and for possible future enhancement.  Attributes
  639.           may be combined on a command line. Some attributes are invalid
  640.           for certain commands and are ignored.  For example, the command
  641.           "delete *.* +d" will NOT cause subdirectories to be deleted.
  642.  
  643.           File attributes are of little or no significance in file sorting
  644.           operations.  The meaning of the qualifier is therefore quite
  645.           different for the "sort" option.  The four sort qualifiers
  646.           determine the type and order of the sort.  The following are valid
  647.           "sort" qualifiers:
  648.  
  649.               +n | -n   # sort by name
  650.               +e | -e   # sort by extension
  651.               +t | -t   # sort by date/time field
  652.               +s | -s   # sort by file size
  653.  
  654.           The sign preceding the qualifier acquires meaning in that it now
  655.           determines the direction of the sort, viz. ascending (+) or
  656.           descending (-) order.  You may specify multiple sort options; the
  657.           sequence of qualifiers determines the sort order.  Sorts are
  658.           performed on the entire directory, ie. any filenames you specify
  659.           are ignored. The following sort commands are identical:
  660.  
  661.               sort  \DOCS\*.DOC  +e-s
  662.               sort  \DOCS\*.*    +e-s
  663.               sort  \DOCS\       +e-s
  664.  
  665.           They each cause all files in the \DOCS subdirectory to be sorted
  666.           in ascending order by extension, placing the largest files first.
  667.  
  668.           Note that some combinations of sort qualifiers are mutually
  669.           exclusive: a sort by name, extension AND size is meaningless
  670.           because all files are uniquely defined by 'filename.ext'.
  671.           Similarly, subdirectories cannot be sorted by size.
  672.  
  673.  
  674.  
  675.  
  676.                                        Page 12
  677.           
  678.        Documentation for ORG V:2.1            Copyright 90/91, M.H. Greve
  679.  
  680.  
  681.  
  682.  
  683.           Commenting the configuration file:
  684.           ---------------------------------
  685.  
  686.           You may include comments in the configuration file to help you
  687.           document your commands.  Comments must be preceded by a '#' sign.
  688.           They may be placed after a command or on a separate line in the
  689.           configuration file.  If comments are placed after a command, you
  690.           must leave at least one blank space (or TAB) behind the command.
  691.  
  692.             order *.COM           # This is a comment following a command.
  693.             # Comments are also allowed on empty lines.
  694.  
  695.  
  696.  
  697.        5. COMMAND LINE SWITCHES
  698.        ------------------------
  699.  
  700.           ORG supports a small set of command line switches that control
  701.           ORG's global settings.  The complete command line is shown here:
  702.  
  703.           ORG [d:] [/a] [/e] [/q] [/f] [/d] [/l] [/25|/50] [/h]
  704.               [/nod] [/sim] [/nox] [/@configfile]
  705.  
  706.           where:
  707.  
  708.           d:      is any valid drive specifier (A: - Z:).
  709.  
  710.           /a      Automatic mode: ORG runs without pausing for confirmation
  711.                   and exits to DOS without pausing at the end of the run.
  712.                   This option will also suppress the re-boot query message
  713.                   normally displayed by ORG at the end of each run.
  714.  
  715.           /e      Exit to DOS: At the end of each run, ORG will normally
  716.                   display a query message, asking if you wish to re-boot
  717.                   your system to reset any programs which may have retained
  718.                   information about the drive's previous state.  The /e
  719.                   option suppresses this message and causes ORG to exit to
  720.                   DOS immediately.  (The re-boot query is not displayed if
  721.                   you have used ORG on a removeable diskette).
  722.  
  723.           /q      Silent mode: disables sound.
  724.  
  725.           /f      Full ORG: This option causes ORG to sort all files on the
  726.                   drive in the sequence in which they are encountered in
  727.                   the directories. You can modify this sequence by either
  728.                   sorting the directory contents or explicitly specifying
  729.  
  730.  
  731.                                        Page 13
  732.           
  733.        Documentation for ORG V:2.1            Copyright 90/91, M.H. Greve
  734.  
  735.  
  736.  
  737.  
  738.                   which files are to be placed on the drive.
  739.                   (See Chapter 4: The Configuration File).
  740.  
  741.           /d      Directories only: ORGanizes directories only.
  742.  
  743.           /l      Laptop mode: forces a monochrome display on laptops that
  744.                   emulate color video adaptors.
  745.  
  746.           /25     Forces ORG to use a 25 line (text) display, irrespective
  747.                   of the initial display mode.  Use either /25 or /50.
  748.  
  749.           /50     Forces ORG to use the 43-line (EGA) or 50-line (VGA)
  750.                   display, irrespective of the initial display mode.  Use
  751.                   either /25 or /50.
  752.  
  753.           /h      Help: This switch overrides all others and simply causes
  754.                   a list of all available options to be displayed.
  755.  
  756.           /sim    Simulation mode: Selecting this option will allow you to
  757.                   test ORG on unknown systems without actually writing to
  758.                   the disk.  All other functionality remains unaffected.
  759.                   The message "Simulaton" is displayed in the lower right
  760.                   corner of the screen.
  761.                   This option can be very useful if you are trying to
  762.                   optimize your system and would like to add TSR programs
  763.                   which you think may work with ORG.
  764.  
  765.           /nod    No defaults: turns off all default configuration options.
  766.                   ORG's default configuration locks system files and places
  767.                   directories first on the drive.  Disabling these defaults
  768.                   may cause certain otherwise unmovable system files to be
  769.                   moved and should only be used by experienced users. You
  770.                   will have to enter every option explicitly.
  771.                   The /nod option may be used to make room for, or replace
  772.                   the system files on the bootable drive without recourse
  773.                   to the DOS SYS command.
  774.  
  775.                   WARNING:  Use the "/nod" switch with great care,
  776.                   particularly on your bootable drive (C:).
  777.  
  778.           /nox    Do NOT use Extended/Expanded meory. Forces use of
  779.                   conventional (DOS) memory only.
  780.  
  781.           /@fname Used to specify an alternate path\filename to override
  782.                   the default configuration file name (ORG.CFG).
  783.                   Example: "ORG /@MYCONFIG.CFG"
  784.  
  785.  
  786.                                        Page 14
  787.           
  788.        Documentation for ORG V:2.1            Copyright 90/91, M.H. Greve
  789.  
  790.  
  791.  
  792.  
  793.           Switches may be used alone or together (except /h) and may be
  794.           placed in any order on the command line.  Blank separators are
  795.           optional except before the drive specifier.  You may use a UNIX
  796.           style dash '-' as a delimiter if you prefer. Thus any of the
  797.           following commands are valid:
  798.  
  799.  
  800.                 ORG /q/a A: /sim
  801.                 ORG C: -nod -l
  802.                 ORG /a/l A:-nod -@D:\MYDIR\MYCONFIG.CFG
  803.  
  804.  
  805.  
  806.        6. LIMITATIONS AND RESTRICTIONS
  807.        -------------------------------
  808.  
  809.           Operating System:
  810.           -----------------
  811.  
  812.           ORG requires MS-DOS 2.1 or higher to run. It must NOT be run
  813.           under a multitasking Environment such as OS/2, Windows, DesqView
  814.           or Software Carousel because you can never be sure that other
  815.           programs are not using any of the files on the drive that ORG is
  816.           processing.  ORG will refuse to run under Windows or DesqView.
  817.           Popular memory management enhancers for 80386 processors such as
  818.           386MAX and QEMM are however compatible with ORG.
  819.  
  820.  
  821.           RAM- and Network drives:
  822.           ------------------------
  823.  
  824.           ORG will not run with RAM drives or Network drives.  If the
  825.           program detects either of these two devices, it will abort with
  826.           an appropriate error message.
  827.  
  828.  
  829.           Large partition support:
  830.           ------------------------
  831.  
  832.           ORG places no restrictions on the size of the drive and will
  833.           handle volumes greater than 32MB if you are using MS-DOS 4 or
  834.           higher or Compaq DOS 3.31.  The only limit is the amount of free
  835.           memory in your system: there must be enough room for ORG to keep
  836.           a complete copy of the directory structure resident in memory.
  837.           If extended or expanded memory is used, there are NO practical
  838.           restrictions to the partition size ORG can handle.
  839.  
  840.  
  841.                                        Page 15
  842.           
  843.        Documentation for ORG V:2.1            Copyright 90/91, M.H. Greve
  844.  
  845.  
  846.  
  847.  
  848.  
  849.           Compatibility:
  850.           --------------
  851.  
  852.           Certain of ORG's options may change the order of files on your
  853.           disk and/or delete files without using DOS functions. Certain
  854.           disk utilities such as QDOS or the PC-TOOLS UNERASE or DOS's
  855.           FASTOPEN may retain information about the drive's previous state.
  856.           As a result, these programs may fail to operate correctly after
  857.           ORG has been run.  At the end of each run, ORG will query if you
  858.           want to re-boot the system in order to reset these programs'
  859.           buffers.  Unless you are quite sure that you are not using any
  860.           programs of this type, you should always allow ORG to re-boot the
  861.           computer.  Use the /e command line option to suppress ORG's
  862.           re-boot query message.  A System Reset is normally required only
  863.           for hard disks.  Thus, if you have used ORG on a removeable
  864.           diskette, the query message is not displayed.
  865.  
  866.           If you are using utilities which maintain a reference file with
  867.           disk status information, you may have to re-run these programs to
  868.           force them to rebuild the database.
  869.  
  870.           There are no other known incompatibilities with ORG.  Many
  871.           resident programs such as popular disk cache programs will not
  872.           interfere with ORG's operation, however you should avoid running
  873.           ORG in the presence of such resident utilites unless you
  874.           understand their function well and test them carefully first!
  875.  
  876.  
  877.        7. ACKNOWLEDGMENT
  878.        -----------------
  879.  
  880.           The original idea for ORG is by David Rifkind, Newbury Park, CA.
  881.           Dave's "cluster-mover" concept is largely responsible for the
  882.           awesome speed with which ORG unfragments your hard disk! I am
  883.           very grateful to Dave for having donated me his code, without
  884.           which, I doubt I would have been able to complete ORG.
  885.  
  886.                                        Page 16
  887.           
  888.        Documentation for ORG V:2.1            Copyright 90/91, M.H. Greve
  889.  
  890.  
  891.  
  892.  
  893.        APPENDIX A - PROGRAM TERMINATION CODES
  894.        --------------------------------------
  895.  
  896.           When ORG finishes a run, it sets the system ERRORLEVEL code
  897.           before exiting to DOS.  You may use these codes to determine
  898.           whether or not ORG completed the pass successfully and glean
  899.           some information about the cause of an abnormal termination,
  900.           for example if you are running ORG from a batch file.
  901.  
  902.           ORG generates the following ERRORLEVEL codes:
  903.  
  904.           ERRORLEVEL
  905.  
  906.               0  -  Normal program termination.
  907.  
  908.               1  -  Program aborted by user. Issued when you interrupt
  909.                     execution with the <ESC> key or exit in response to
  910.                     a warning error message.
  911.  
  912.               2  -  Bad option on ORG command line
  913.  
  914.              -1  -  All other errors and abnormal end conditions.
  915.  
  916.  
  917.  
  918.  
  919.        APPENDIX B - ERROR MESSAGES
  920.        ---------------------------
  921.  
  922.           If an error occurs, ORG will generate one of three types of error
  923.           messages.
  924.  
  925.           User Errors:
  926.           ------------
  927.  
  928.           These will warn you of operating problems that are usually fairly
  929.           easy to correct, such as the use of an invalid drive letter or
  930.           that there is not enough memory for ORG to run. The following is
  931.           a list of "User Errors". Most messages are self-explanatory.
  932.  
  933.            1. "There is insufficient DOS memory for ORG to run. Remove
  934.                resident programs to increase available memory.
  935.  
  936.  
  937.            2. "Request for Expanded Memory failed. ORG requires at least
  938.                16K LIM 3.2 Expanded Memory per megabyte of data on your
  939.                disk to run.
  940.  
  941.            3. "Request for XMS Extended Memory failed. ORG requires at
  942.                least 16K XMS Extended Memory per megabyte of data on your
  943.                disk to run.
  944.  
  945.            4. "There are too many options in the configuration file.
  946.                ORG is limited to 50 configuration options."
  947.  
  948.            5. "The sector size of this disk is not 512 bytes. Under DOS
  949.                versions 2, ORG works only on disks with 512-byte sectors."
  950.  
  951.  
  952.  
  953.  
  954.                                        Page 17
  955.           
  956.        Documentation for ORG V:2.1            Copyright 90/91, M.H. Greve
  957.  
  958.  
  959.  
  960.  
  961.            6. "The boot record of this disk does not contain an
  962.                MS-DOS signature. This may not be a DOS disk.
  963.                       Continue anyway ? [Y/N]
  964.  
  965.            7. "The specified drive identifier is not known to your
  966.                system.  Re-try with a valid drive identifier."
  967.  
  968.            8. "The specified drive is probably RAM-drive or Network
  969.                drive.  ORG should only be used on local disks!
  970.                       Continue anyway ? [Y/N]
  971.  
  972.            9. "The boot record of this disk shows an invalid number
  973.                of sectors."
  974.  
  975.           10. "The media descriptor in this disk's file allocation
  976.                table does not match the one in the boot record."
  977.                       Continue anyway ? [Y/N]
  978.  
  979.           11. "The file allocation table has a bad link entry."
  980.  
  981.  
  982.           12. "There are cross-linked clusters on this disk."
  983.  
  984.  
  985.           13. "There is not enough free space on this disk for
  986.                ORG to work. You may need to delete some files."
  987.  
  988.  
  989.           14. "A cluster being used by a file is marked as available
  990.                in the file allocation table."
  991.  
  992.  
  993.           15. "A cluster being used by a file is marked as bad
  994.                in the file allocation table."
  995.  
  996.  
  997.           16. "There are lost clusters on this disk.
  998.  
  999.  
  1000.           17. "A subdirectory contains a bad entry."
  1001.  
  1002.  
  1003.           18. "Cluster allocation error(s) found."
  1004.  
  1005.                                        Page 18
  1006.           
  1007.        Documentation for ORG V:2.1            Copyright 90/91, M.H. Greve
  1008.  
  1009.  
  1010.  
  1011.  
  1012.           Notes:
  1013.           (i)    Errors 2 through 4 occur when ORG attempts to allocate
  1014.                  Expanded or Extended memory.  If you are suree you have
  1015.                  sufficient Extended or Expanded memory for ORG to run
  1016.                  successfully but still get one of these error messages,
  1017.                  please contact the author. You may still be able to use
  1018.                  ORG by using the /c command line switch to force ORG to
  1019.                  use conventional DOS memory only.
  1020.  
  1021.           (ii)   Error 7 frequently occurs when you attempt to ORGanize a
  1022.                  RAM drive.
  1023.  
  1024.           (iii)  Errors 11, 12, 14, 15, 16, 17 and 18 can usually be
  1025.                  corrected with DOS's CHKDSK program (see your MS-DOS User's
  1026.                  Guide for a detailed description of the CHKDSK command).
  1027.  
  1028.           (iv)   Error 8 may indicate a serious problem with the drive.
  1029.                  Normally the problem can be fixed with a disk utility
  1030.                  such as the "Norton Disk Doctor" (TM).
  1031.  
  1032.           (v)    Errors 4 and 6 are warning errors only. You may force
  1033.                  ORG to continue by answering "Y" at the prompt.
  1034.  
  1035.  
  1036.           Disk Errors:
  1037.           ------------
  1038.  
  1039.           All Disk Errors reported by ORG (other than the trivial 'drive not
  1040.           ready' or 'diskette write protected') are serious errors that may
  1041.           indicate a deterioration of your hard disk.  They are always
  1042.           caused by a failure to read or write to a given sector on the
  1043.           disk. Depending on where and when they occurred, these errors may
  1044.           be recoverable.  If the bad sector is in the FAT (File Allocation
  1045.           Table) area of your disk, you risk losing data.
  1046.  
  1047.           If ORG reports a DISK ERROR, exit and run DOS's CHKDSK program to
  1048.           verify the error and then run a disk diagnostics/repair program
  1049.           to recover as much data as possible and try to restore the files
  1050.           from your backup.
  1051.  
  1052.           If ORG reports a "FATAL" error, it has failed during an attempt
  1053.           to update the FAT or root directory areas.  In this case, there
  1054.           is a serious risk of losing a significant amount of data.
  1055.  
  1056.           Org displays the DOS internal error number (xxxx) and the sector
  1057.           number (nnnn) where the problem occured.  In possible, ORG
  1058.           displays a message corresponding to the error.  If a FAT write
  1059.           error occurred in FAT #2, it is very likely you will able to
  1060.  
  1061.                                        Page 19
  1062.           
  1063.        Documentation for ORG V:2.1            Copyright 90/91, M.H. Greve
  1064.  
  1065.  
  1066.  
  1067.  
  1068.           recover all your data.  The following messages may be reported by
  1069.           ORG in the event of a disk access error:
  1070.  
  1071.            1. "Recoverable error #xxxx,
  1072.                reading sector #nnnn in the data area."
  1073.  
  1074.            2. "Recoverable error #xxxx,
  1075.                writing sector #nnnn in the data area"
  1076.            3. "CRITICAL error #xxxx, reading sector #nnnn in FAT #m.
  1077.                The Disk may be unusable."
  1078.  
  1079.            4. "FATAL error #xxxx, writing sector #nnnn in FAT #m.
  1080.                Data may be destroyed!"
  1081.  
  1082.            5. "CRITICAL error #xxxx, reading sector #nnnn in the ROOT area.
  1083.                The Disk may be unusable."
  1084.  
  1085.  
  1086.            6. "FATAL error #xxxx, writing sector #nnnn in the Root area.
  1087.                Data may be destroyed!"
  1088.  
  1089.  
  1090.            Internal Errors:
  1091.            ----------------
  1092.  
  1093.            This last category of errors should NEVER occur. They are always
  1094.            associated with programming bugs and have been included solely
  1095.            to help with debugging. If you ever get an "Internal Error",
  1096.            please report it immediately and I will try and find the cause
  1097.            of the problem.
  1098.  
  1099.  
  1100.  
  1101.  
  1102.        APPENDIX C - BUGS
  1103.        -----------------
  1104.  
  1105.           Although ORG has been tested thoroughly, I cannot guarantee that
  1106.           it is truly free of bugs.  If you encounter what you believe to
  1107.           be a bug in ORG, you should try the following steps before calling
  1108.           or sending in a "Bug Report":
  1109.  
  1110.           Remove all TSR programs from your system, especially programs such
  1111.           as disk cache software or RAM drives or, better still, re-boot the
  1112.           computer from a "virgin" DOS diskette and try to run ORG again. If
  1113.           ORG runs in this environment but not in your normal DOS
  1114.           environment, try reconstructing the system under which ORG failed
  1115.  
  1116.                                        Page 20
  1117.           
  1118.        Documentation for ORG V:2.1            Copyright 90/91, M.H. Greve
  1119.  
  1120.  
  1121.  
  1122.  
  1123.           by adding drivers and TSR's one by one until the problem re-
  1124.           appears.  If you find the particular software which causes the
  1125.           trouble, please let me know about it, so that I can warn other
  1126.           users and try to find a "workaround" and send you an upgrade.
  1127.  
  1128.  
  1129.  
  1130.        APPENDIX D - TECHNICAL SUPPORT
  1131.        ------------------------------
  1132.  
  1133.           If the above approach does not work, please send a detailed report
  1134.           including a full description of your system to either Dave Rifkind
  1135.           or myself (addresses shown below) and we will try to help you find
  1136.           and solve the problem.
  1137.  
  1138.           NORTH AMERICA (U.S., CANADA, AND MEXICO):
  1139.  
  1140.                David Rifkind
  1141.                1800 West Hillcrest Drive, #287
  1142.                Newbury Park, CA  91320
  1143.                USA
  1144.  
  1145.           OUTSIDE NORTH AMERICA:
  1146.  
  1147.                Michael H. Greve
  1148.                Aubrigstrasse 23
  1149.                CH 8804 AU
  1150.                Switzerland
  1151.  
  1152.  
  1153.           Compuserve and BIX on-line support:
  1154.           -----------------------------------
  1155.  
  1156.           If you have access to Compuserve you can contact Dave Rifkind
  1157.           under the Compuserve ID: 72510,2214.
  1158.  
  1159.           If you have access to BIX, you can contact Mike Greve under the
  1160.           BIXname "mike123" or  Dave Rifkind under the BIXname "drifkind".
  1161.  
  1162.