home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PROGRAMS / UTILS / HARDDISK / ORG130SW.ZIP / ORG.DOC < prev    next >
Encoding:
Text File  |  1990-07-30  |  44.2 KB  |  1,152 lines

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