home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Frostbyte's 1980s DOS Shareware Collection
/
floppyshareware.zip
/
floppyshareware
/
GLEN
/
ORG217SW.ZIP
/
ORG21.DOC
< prev
next >
Wrap
Text File
|
1991-07-03
|
49KB
|
1,162 lines
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
ORG - Hard Disk Organizer Utility
Copyright (1990/1991)
M.H. Greve + D. Rifkind
All Rights Reserved
Distributed by:
Greve Computer Systems
Aubrigstrasse 23
CH 8804 AU
Switzerland
Date: April 6. 1991
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
TABLE OF CONTENTS
1. Introduction 1
2. Getting Started - Installation 2
3. About ORG 4
4. The Configuration File 6
5. Command Line Switches 12
6. Limitations and Restrictions 14
7. Acknowledgment 15
Appendix A - Program Termination codes 16
Appendix B - Error Messages 17
Appendix C - Bugs 19
Appendix D - Techincal Support 20
Page 1
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
1. INTRODUCTION
---------------
ORG is a Disk Organizer with a lot of features not found in
other similar programs. In addition to the traditional function
of un-fragmenting your disk, ORG will allow you to customize the
sequence in which files are placed on the disk, let you "lock"
(leave unchanged) any file or group of files, sort files in any
directory and delete temporary files on the fly, all in a single
pass. Moreover, ORG does this as fast or faster than most
commercially available unfragmentation software. As you will
discover when you use the program:
"ORG is the only Disk Organizer that truly deserves the name!"
User Supported Software:
------------------------
ORG is distributed as "Shareware" or "User Supported Software"
and is fully copyrighted. You may have received a copy of ORG
free from a friend or a bulletin board or (for a nominal fee)
from a user's group or Shareware library. However you received
ORG, you have a perfectly legal copy of the software. You are
encouraged to make as many copies of the software and this
documentation as you like and distribute it to anyone you want,
as long as you do not charge a fee (other than to cover your own
distribution cost) and distribute only complete, unaltered copies
of the package, exactly as you received it. If, after trying the
program for a few weeks, you find it useful and use it regularly,
you must register your copy by completing the form included in the
file "ORG21.REG" included in the distribution package.
As a registered user you will receive a copy of the very latest
version of ORG and will be entitled to free support and will
receive upgrade notices and "bug fixes" as and when these become
available (for one full year from the date of purchase).
Page 2
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
2. GETTING STARTED & INSTALLATION
---------------------------------
This section provides step by step instructions for running ORG
on any drive of a standard IBM PS/2, IBM PC, XT, AT, or any 100%
compatible running under MSDOS 2.10, or higher.
If you are eager to run ORG right away, you need only read this
chapter now and can revert to the rest of the documentation for
a detailed description of the program's features and options
later.
Note that you should never attempt to run ORG under a multi-
tasking operating system or OS-shell such as OS/2, Windows,
DesqView or Software Carousel, nor activate any "pop-up" program
(eg. SideKick) while the program is running.
1. Before you start, use the DOS DISKCOPY command to make a
duplicate of the distribution disk or, if you downloaded ORG
from a bulletin board, save the archive file onto two
diskettes and store one (the original) in a safe place.
2. ORG does not require any special installation procedure. You
may run ORG from the backup floppy disk or from a subdirectory
on your hard disk. If you wish to run the program from your
hard disk, copy the ORG.EXE program file to a subdirectory
which is included in your DOS PATH (see your DOS User's Guide)
and place the ORG.CFG file in the same directory or in the
root directory of the drive you wish to "unfragment".
3. If you are running ORG for the first time, make sure you have
a current backup of the drive you wish to unfragment. You may
also wish to remove any resident utilities such as disk-cache
programs in order to avoid any potential conflicts.
4. Run the DOS CHKDSK program on the drive and correct any errors
reported by it before proceeding further. If there are lost
clusters or cross-linked files on the disk, ORG will detect
this and refuse to run.
5. Make the drive and/or directory containing ORG.EXE the current
drive/directory. (Not necessary if ORG.CFG is in a directory
contained in your PATH).
Page 3
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
6. Start ORG from the DOS prompt by typing:
ORG [d:] [/F] [/SIM] <Enter>
The parameter d: is any valid drive specifier known to your system
(except a RAM disk or Network drive). ORG assumes the current
default drive if you omit the drive specifier. Normally, ORG will
only unfragment the files without regard to their sequence on the
drive. The /F parameter causes ORG to perform a complete disk
organization, placing files in the sequence specified in the
configuration file (see chapter 4: The Configuration File). In
default mode, ORG will normally optimize a 30MB drive in less than
two minutes. The /SIM parameter (simulation mode) prevents ORG
from actually writing anything to disk. As a first time user, you
may wish to use /SIM to uncover any potential conflicts with your
computer setup.
ORG first reads the configuration file, evaluates the disk's drive
parameters, reads the FAT (File allocation Table) and directory
structure and, if necessary, sorts your files. A window displays
ORG's progress through these steps. ORG will pause and wait for
you to press the <Enter> key before proceeding to unfragment the
drive. If you did not copy the configuration file, ORG will warn
you of this and will use its own internal default settings. You
may view these defaults and the configuration settings by pressing
the <F1> key. If you decide you don't want to run ORG right now,
press <Esc>, and ORG will return you to the DOS environment.
If you have used other unfragmentation programs before, the screen
layout with the large symbolic map of your disk will look
familiar. To the right of the drive map, ORG displays some of
the drive's parameters, a description of the symbols used, and
it's memory usage. The %-completed and elapse-time displays in
the lower right corner provide an indication of ORG's progress.
ORG can take anywhere from a few seconds to several minutes to
unfragment your disk. Typically, it will take 1 to 2 minutes
to unfragment a 32MB partition with about 20MB of data. You may
abort ORG at any time by simply pressing the <Esc> key. The
integrity of your data is guaranteed if you exit in this manner.
After optimization is completed, ORG will ask whether you wish to
re-boot the system. Certain resident programs retain information
about the previous state of the disk. Unless you are sure that
you have no such programs in your system, you should type "Y" to
allow ORG to initiate a system reset. (The re-boot query is not
displayed if you have used ORG on a removeable diskette).
Page 4
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
Laptop users:
-------------
If you are running ORG on a laptop computer you may find the
display difficult to read. This is because Laptops often emulate
color displays on the built in monochrome screen, making certain
colors hard to distinguish. In such cases, re-start ORG using
the /L command line switch which forces ORG to use its monochrome
display settings irrespective of the type of video adaptor in-
stalled (see chapter 5: Command Line Switches).
WARNING!
--------
NEVER re-boot or switch off the computer while ORG is running, as
this may cause loss of data. As a precaution, it is a good idea
to run ORG after you have made a backup of your hard disk,
particularly if you live in an area where power dips are common.
3. ABOUT ORG
------------
You may run ORG on any valid drive in your system. This may be
a floppy, a hard disk, or a logical partition on your hard disk.
ORG should not be run on virtual (RAM) drives or Network drives
and will issue a warning if you specify one accidentally. If
your computer is equipped with an EGA or VGA screen, ORG will
detect when the screen is set to 43/50 line and automatically use
the full screen display. You may force ORG to display in either
25-line or 43/50-line mode by using the appropriate command line
switches (see Chapter 5). If available, ORG will use expanded or
extended memory for its tables and buffers. It requires the EMS
driver version 3.2 or above to access expanded memory. Extended
memory requires the Microsoft XMS interface (HIMEM.SYS) to be
loaded in your system.
How ORG works:
--------------
After you start ORG, the program notes any command line options
and then searches for the configuration file ORG.CFG. ORG searches
for this file in the root directory of the target drive you
specified and then in the drive/directory from which ORG was
loaded. ORG does not search your system's PATH. This somewhat
Page 5
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
restrictive search ensures good control over the configuration
file used and prevents ORG from accidentally loading an old
version that may be "visible" in your DOS PATH. ORG.CFG contains
a list of special commands that allow you to control the way in
which ORG organizes the files on your disk. (Refer to chapter 4:
The Configuration File).
ORG reads and analyses the parameters, directory structure and
FAT (File Allocation Table) of the drive and processes the
"delete" and "sort" command functions in memory, WITHOUT writing
to your hard disk. ORG pauses at this stage and waits for you to
press the <Enter> key before beginning to organize the files. If
you abort the program by pressing the <Esc> key at this stage, no
data on the disk will have been modified.
By pressing the <F1> key you can view the configuration settings
before proceeding, to assure yourself that ORG will perform the
desired operations.
Once ORG has started organizing the drive, you can still safely
interrupt the process at any time by pressing the <Esc> key. The
consistency and integrity of your files is guaranteed if you exit
ORG in this way, however ALL files which you flagged for deletion
will have been erased.
WARNING: NEVER power off or re-boot your computer while ORG is
running as this may cause loss of data integrity which
can be very difficult to recover even with programs such
as the Norton (TM) Utilites.
While ORG runs, it displays its progress on a disk-map in a window
of your screen. In this map, each visible block corresponds to
one or more physical clusters on the drive. The blocks that have
already been processed are highlighted. Special symbols are used
to indicate locked or bad clusters. The blocks being moved are
highlighted with an 'r' (read) or 'W' (write). Note that ORG will
always move the largest possible contiguous block of clusters. If
it can, it will move them to the final destination immediately. If
not, it will write them to the end of the disk temporarily. This
process is very efficient since it ensures that each cluster on
the disk is never moved more than twice in a session.
Frequently, ORG will detect that it already has the clusters it
needs in memory and will not re-read them. This feature not only
saves time, but also prevents a lot of unnecessary "head-
thrashing" action.
Page 6
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
ORG updates the FAT and directory areas after writing each group
of blocks, ensuring disk integrity as far as technically possible.
In fact, loss of data is only possible during the relatively
short time when the directories and FAT are "out of synch". This
is important, because ORG will retain data integrity at all other
times, even if a power dip were to occur during a "write" to the
data area.
You will notice that ORG often appears to read or write to a
protected area or an area that has already been processed. This
is normal and is because each block usually represents several
clusters.
The highlighted box to the right of the disk-map displays the
currently available command(s). A "percent completed" counter
above this box keeps track of ORG's progress.
File order and sequence:
------------------------
In its default mode ORG ignores file order and sequence on the
drive. The algorithm used ensures that only a minimal number of
files will be moved to fully unfragment the drive and fill any
gaps between files. By filling gaps ORG prevents the drive from
becoming rapidly fragmented again, since new files will be created
at the end of the existing contiguous data area. When the /f
option is specified, ORG will order all files sequentially on the
drive: It places all directories first on the drive and then
places remaining files in the sequence in which it encounters the
file name entries in the (sub)directories. You may override or
modify these default settings by using the "sort" and "order"
commands in the configuration file, ORG.CFG (see Chapter 4: The
Configuration File).
If you were to compare the result of organizing a disk under ORG
with that of other similar programs, you might find that some
programs will start organizing the disk over again. This does not
mean that ORG failed to optimize your disk, it merely indicates
that there is more than one valid way (and no right way) to
organize directories and files on the disk.
Page 7
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
4. THE CONFIGURATION FILE
-------------------------
The features available to you through use of the configuration
file make ORG the most powerful and versatile Disk Organizer
available today.
The configuration file is an ASCII text file containing special
ORG commands, similar to a DOS batch file. When you run ORG
without specifying a configuration file name, it searches for
the ORG.CFG file in the root directory of the target drive you
selected when you started the program and then in the drive/path
where the ORG.EXE program resides. This restrictive search
lets you keep a customized configuration file for each drive in
the root directory of your hard disk.
NOTE:
Under DOS versions earlier than 3.0, ORG will search for the
configuration file in the current default directory (CWD) instead
of in the directory from which ORG.EXE was loaded.
ORG allows you to override the default name of the configuration
file (ORG.CFG), by simply specifying a file name of the form
"/@[d:][\pathspec\]filename" on the ORG command line. If you only
specify a filename, ORG will search the root directory of the
target drive and directory where the ORG.EXE program resides.
The configuration filespec must be immediately preceded by the
"@" sign.
ORG.CFG uses a simple command structure similar to that used in
compiler MAKE files. A sample configuration file (ORG.CFG) is
included in the ORG package. Each line in the configuration file
represents a command for ORG. The command syntax is:
<function> [\path\][filename] [qualifier] [#<comment>]
The first element on each line is the function to be performed.
This is followed by a file specifier in the form "path\filename".
Each command can take a qualifier that tells ORG which file
attributes are to be used to further specify the file(s). If you
specified the "sort" command (see below), the qualifier has a
different meaning: it indicates the type and sequence of the sort
keys.
Page 8
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
Here are a few examples of valid commands:
lock *.* +s # lock all system files
delete \TEMP\*.back # delete all .BACK files
sort +n-t # sort by filename, newest files first
order *.EXE # place all .EXE files first
In the following you will find a detailed description of each
element of the configuration command:
Commands:
---------
lock - prevents ORG from moving a specified file or group of
files on the drive. This is essential to avoid moving
files such as your DOS system files on the bootable
partition of your disk. It may also be necessary to
lock the identification files used by certain copy-
protected software. The "lock" function takes an optional
attribute parameter. ORG's default setting locks all
"system" files. You may disable this default setting
using the /nod command line option.
sort - allows you to sort the contents of the directory in
ascending or descending order by filename, extension,
date & time, or size. A sort is always performed on an
entire directory; if a filename is given, it is ignored
by ORG for the sort operation. The qualifier determines
the type and sequence of the sort operation.
The command always places subdirectories first and then
sorts directory names and filenames in two consecutive
passes.
Note: ORG processes directories and files in the order
in which they are encountered. Using the "sort" command
thus affects the sequence in which ORG will place the
files on the drive. The "order" command described below
allows you to override this sequence by specifying that
certain files (or groups of files) be processed first.
order - allows you to force certain files, or groups of files
(specified using DOS style wild selections) to be placed
first on the disk. If you use several "order" commands,
Page 9
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
they are processed in the sequence in which they appear
in the configuration file. If a group of files is
specified, they are processed in sequence, by directory
and in the sequence in which they appear in the directory
structure.
Do not confuse this command with the "sort" command
described above, which sorts directory and file names
and thus implicitly determines the sequence of files.
As with the lock and delete options, you may specify one
or more file attributes as qualifiers for the path\
filename spec. Note that ORG's default settings will
place all directories first on the disk (behind the
system files and/or the Volume identifier). You may
disable this default setting using the /nod command line
option.
delete - allows you to specify a file or group of files that you
wish to delete from the drive. For example, you might
want to delete .BAK or .TMP files on your drive prior to
unfragmenting. The default setting only allows ORG to
delete normal files that is, files that have either no
attributes or only the "archive" attribute set. You may
override this default by explicitly specifying one or
more file attributes.
NOTE: Use this command with care, because if you
accidentally delete a file with ORG, you will NOT be able
to "un-erase" it any more later! For this reason, ORG
will ignore a command to delete all files on the disk.
ORG will also ignore requests to delete directories.
The order in which commands are executed by ORG is fixed in the
program. Irrespective of where they appear in the configuration
file, commands are processed in the following sequence:
1. lock
2. delete
3. sort
4. order
Because any "lock" commands are processed first, they will take
precedence over "delete" commands that occur later, ie. ORG will
NOT delete files that have been "frozen" by a previous lock
command.
Page 10
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
If several similar commands occur, they are processed in the order
in which they appear in the configuration file, eg:
order \command.com
order *.COM
order *.EXE
The Path/Filename Specifier:
----------------------------
The second element in a command is the filename specifier. This
element follows MS-DOS conventions for directory and filenames.
You may specify any valid path (commands with invalid paths are
ignored; no error message is generated).
The filename may contain the "wild-card" symbols '*' and '?'. The
filename may be omitted entirely if the pathname is terminated
by a backslash (\). ORG will then assume you specified all files
in this directory. The following are some examples of valid
filename specifiers:
delete \brief\backup\ # delete all files in \BRIEF\BACKUP
order \*.WK1 # place all Lotus 2.xx files first
delete *.tmp +r # delete .TMP files, including read-only
Note that the path\filename specifier is optional, however it may
only be omitted if you provide a qualifier on the line. This means
you must EITHER include a filename OR a qualifier (see below) and
may not omit both; a command containing a function only is
flagged as an error.
The Command Qualifier:
----------------------
The qualifier has two functions. For the "lock", "delete" and
"order" options it specifies the desired file attributes. For the
"sort" option, it defines the type, sequence and order (ascending
or descending) of sorting. The qualifier is always optional.
Valid file attribute qualifiers are:
Page 11
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
+r # Read-only files
+h # Hidden files
+s # System files
+d # subdirectories
+a # archive files
A '+' (plus) or '-' (minus) sign must precede the attribute. The
sign is used solely as a separator between consecutive attributes
and has no other meaning: it does NOT qualify the attribute. Both
signs are allowed for consistency with the sort qualifiers
described below and for possible future enhancement. Attributes
may be combined on a command line. Some attributes are invalid
for certain commands and are ignored. For example, the command
"delete *.* +d" will NOT cause subdirectories to be deleted.
File attributes are of little or no significance in file sorting
operations. The meaning of the qualifier is therefore quite
different for the "sort" option. The four sort qualifiers
determine the type and order of the sort. The following are valid
"sort" qualifiers:
+n | -n # sort by name
+e | -e # sort by extension
+t | -t # sort by date/time field
+s | -s # sort by file size
The sign preceding the qualifier acquires meaning in that it now
determines the direction of the sort, viz. ascending (+) or
descending (-) order. You may specify multiple sort options; the
sequence of qualifiers determines the sort order. Sorts are
performed on the entire directory, ie. any filenames you specify
are ignored. The following sort commands are identical:
sort \DOCS\*.DOC +e-s
sort \DOCS\*.* +e-s
sort \DOCS\ +e-s
They each cause all files in the \DOCS subdirectory to be sorted
in ascending order by extension, placing the largest files first.
Note that some combinations of sort qualifiers are mutually
exclusive: a sort by name, extension AND size is meaningless
because all files are uniquely defined by 'filename.ext'.
Similarly, subdirectories cannot be sorted by size.
Page 12
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
Commenting the configuration file:
---------------------------------
You may include comments in the configuration file to help you
document your commands. Comments must be preceded by a '#' sign.
They may be placed after a command or on a separate line in the
configuration file. If comments are placed after a command, you
must leave at least one blank space (or TAB) behind the command.
order *.COM # This is a comment following a command.
# Comments are also allowed on empty lines.
5. COMMAND LINE SWITCHES
------------------------
ORG supports a small set of command line switches that control
ORG's global settings. The complete command line is shown here:
ORG [d:] [/a] [/e] [/q] [/f] [/d] [/l] [/25|/50] [/h]
[/nod] [/sim] [/nox] [/@configfile]
where:
d: is any valid drive specifier (A: - Z:).
/a Automatic mode: ORG runs without pausing for confirmation
and exits to DOS without pausing at the end of the run.
This option will also suppress the re-boot query message
normally displayed by ORG at the end of each run.
/e Exit to DOS: At the end of each run, ORG will normally
display a query message, asking if you wish to re-boot
your system to reset any programs which may have retained
information about the drive's previous state. The /e
option suppresses this message and causes ORG to exit to
DOS immediately. (The re-boot query is not displayed if
you have used ORG on a removeable diskette).
/q Silent mode: disables sound.
/f Full ORG: This option causes ORG to sort all files on the
drive in the sequence in which they are encountered in
the directories. You can modify this sequence by either
sorting the directory contents or explicitly specifying
Page 13
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
which files are to be placed on the drive.
(See Chapter 4: The Configuration File).
/d Directories only: ORGanizes directories only.
/l Laptop mode: forces a monochrome display on laptops that
emulate color video adaptors.
/25 Forces ORG to use a 25 line (text) display, irrespective
of the initial display mode. Use either /25 or /50.
/50 Forces ORG to use the 43-line (EGA) or 50-line (VGA)
display, irrespective of the initial display mode. Use
either /25 or /50.
/h Help: This switch overrides all others and simply causes
a list of all available options to be displayed.
/sim Simulation mode: Selecting this option will allow you to
test ORG on unknown systems without actually writing to
the disk. All other functionality remains unaffected.
The message "Simulaton" is displayed in the lower right
corner of the screen.
This option can be very useful if you are trying to
optimize your system and would like to add TSR programs
which you think may work with ORG.
/nod No defaults: turns off all default configuration options.
ORG's default configuration locks system files and places
directories first on the drive. Disabling these defaults
may cause certain otherwise unmovable system files to be
moved and should only be used by experienced users. You
will have to enter every option explicitly.
The /nod option may be used to make room for, or replace
the system files on the bootable drive without recourse
to the DOS SYS command.
WARNING: Use the "/nod" switch with great care,
particularly on your bootable drive (C:).
/nox Do NOT use Extended/Expanded meory. Forces use of
conventional (DOS) memory only.
/@fname Used to specify an alternate path\filename to override
the default configuration file name (ORG.CFG).
Example: "ORG /@MYCONFIG.CFG"
Page 14
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
Switches may be used alone or together (except /h) and may be
placed in any order on the command line. Blank separators are
optional except before the drive specifier. You may use a UNIX
style dash '-' as a delimiter if you prefer. Thus any of the
following commands are valid:
ORG /q/a A: /sim
ORG C: -nod -l
ORG /a/l A:-nod -@D:\MYDIR\MYCONFIG.CFG
6. LIMITATIONS AND RESTRICTIONS
-------------------------------
Operating System:
-----------------
ORG requires MS-DOS 2.1 or higher to run. It must NOT be run
under a multitasking Environment such as OS/2, Windows, DesqView
or Software Carousel because you can never be sure that other
programs are not using any of the files on the drive that ORG is
processing. ORG will refuse to run under Windows or DesqView.
Popular memory management enhancers for 80386 processors such as
386MAX and QEMM are however compatible with ORG.
RAM- and Network drives:
------------------------
ORG will not run with RAM drives or Network drives. If the
program detects either of these two devices, it will abort with
an appropriate error message.
Large partition support:
------------------------
ORG places no restrictions on the size of the drive and will
handle volumes greater than 32MB if you are using MS-DOS 4 or
higher or Compaq DOS 3.31. The only limit is the amount of free
memory in your system: there must be enough room for ORG to keep
a complete copy of the directory structure resident in memory.
If extended or expanded memory is used, there are NO practical
restrictions to the partition size ORG can handle.
Page 15
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
Compatibility:
--------------
Certain of ORG's options may change the order of files on your
disk and/or delete files without using DOS functions. Certain
disk utilities such as QDOS or the PC-TOOLS UNERASE or DOS's
FASTOPEN may retain information about the drive's previous state.
As a result, these programs may fail to operate correctly after
ORG has been run. At the end of each run, ORG will query if you
want to re-boot the system in order to reset these programs'
buffers. Unless you are quite sure that you are not using any
programs of this type, you should always allow ORG to re-boot the
computer. Use the /e command line option to suppress ORG's
re-boot query message. A System Reset is normally required only
for hard disks. Thus, if you have used ORG on a removeable
diskette, the query message is not displayed.
If you are using utilities which maintain a reference file with
disk status information, you may have to re-run these programs to
force them to rebuild the database.
There are no other known incompatibilities with ORG. Many
resident programs such as popular disk cache programs will not
interfere with ORG's operation, however you should avoid running
ORG in the presence of such resident utilites unless you
understand their function well and test them carefully first!
7. ACKNOWLEDGMENT
-----------------
The original idea for ORG is by David Rifkind, Newbury Park, CA.
Dave's "cluster-mover" concept is largely responsible for the
awesome speed with which ORG unfragments your hard disk! I am
very grateful to Dave for having donated me his code, without
which, I doubt I would have been able to complete ORG.
Page 16
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
APPENDIX A - PROGRAM TERMINATION CODES
--------------------------------------
When ORG finishes a run, it sets the system ERRORLEVEL code
before exiting to DOS. You may use these codes to determine
whether or not ORG completed the pass successfully and glean
some information about the cause of an abnormal termination,
for example if you are running ORG from a batch file.
ORG generates the following ERRORLEVEL codes:
ERRORLEVEL
0 - Normal program termination.
1 - Program aborted by user. Issued when you interrupt
execution with the <ESC> key or exit in response to
a warning error message.
2 - Bad option on ORG command line
-1 - All other errors and abnormal end conditions.
APPENDIX B - ERROR MESSAGES
---------------------------
If an error occurs, ORG will generate one of three types of error
messages.
User Errors:
------------
These will warn you of operating problems that are usually fairly
easy to correct, such as the use of an invalid drive letter or
that there is not enough memory for ORG to run. The following is
a list of "User Errors". Most messages are self-explanatory.
1. "There is insufficient DOS memory for ORG to run. Remove
resident programs to increase available memory.
2. "Request for Expanded Memory failed. ORG requires at least
16K LIM 3.2 Expanded Memory per megabyte of data on your
disk to run.
3. "Request for XMS Extended Memory failed. ORG requires at
least 16K XMS Extended Memory per megabyte of data on your
disk to run.
4. "There are too many options in the configuration file.
ORG is limited to 50 configuration options."
5. "The sector size of this disk is not 512 bytes. Under DOS
versions 2, ORG works only on disks with 512-byte sectors."
Page 17
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
6. "The boot record of this disk does not contain an
MS-DOS signature. This may not be a DOS disk.
Continue anyway ? [Y/N]
7. "The specified drive identifier is not known to your
system. Re-try with a valid drive identifier."
8. "The specified drive is probably RAM-drive or Network
drive. ORG should only be used on local disks!
Continue anyway ? [Y/N]
9. "The boot record of this disk shows an invalid number
of sectors."
10. "The media descriptor in this disk's file allocation
table does not match the one in the boot record."
Continue anyway ? [Y/N]
11. "The file allocation table has a bad link entry."
12. "There are cross-linked clusters on this disk."
13. "There is not enough free space on this disk for
ORG to work. You may need to delete some files."
14. "A cluster being used by a file is marked as available
in the file allocation table."
15. "A cluster being used by a file is marked as bad
in the file allocation table."
16. "There are lost clusters on this disk.
17. "A subdirectory contains a bad entry."
18. "Cluster allocation error(s) found."
Page 18
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
Notes:
(i) Errors 2 through 4 occur when ORG attempts to allocate
Expanded or Extended memory. If you are suree you have
sufficient Extended or Expanded memory for ORG to run
successfully but still get one of these error messages,
please contact the author. You may still be able to use
ORG by using the /c command line switch to force ORG to
use conventional DOS memory only.
(ii) Error 7 frequently occurs when you attempt to ORGanize a
RAM drive.
(iii) Errors 11, 12, 14, 15, 16, 17 and 18 can usually be
corrected with DOS's CHKDSK program (see your MS-DOS User's
Guide for a detailed description of the CHKDSK command).
(iv) Error 8 may indicate a serious problem with the drive.
Normally the problem can be fixed with a disk utility
such as the "Norton Disk Doctor" (TM).
(v) Errors 4 and 6 are warning errors only. You may force
ORG to continue by answering "Y" at the prompt.
Disk Errors:
------------
All Disk Errors reported by ORG (other than the trivial 'drive not
ready' or 'diskette write protected') are serious errors that may
indicate a deterioration of your hard disk. They are always
caused by a failure to read or write to a given sector on the
disk. Depending on where and when they occurred, these errors may
be recoverable. If the bad sector is in the FAT (File Allocation
Table) area of your disk, you risk losing data.
If ORG reports a DISK ERROR, exit and run DOS's CHKDSK program to
verify the error and then run a disk diagnostics/repair program
to recover as much data as possible and try to restore the files
from your backup.
If ORG reports a "FATAL" error, it has failed during an attempt
to update the FAT or root directory areas. In this case, there
is a serious risk of losing a significant amount of data.
Org displays the DOS internal error number (xxxx) and the sector
number (nnnn) where the problem occured. In possible, ORG
displays a message corresponding to the error. If a FAT write
error occurred in FAT #2, it is very likely you will able to
Page 19
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
recover all your data. The following messages may be reported by
ORG in the event of a disk access error:
1. "Recoverable error #xxxx,
reading sector #nnnn in the data area."
2. "Recoverable error #xxxx,
writing sector #nnnn in the data area"
3. "CRITICAL error #xxxx, reading sector #nnnn in FAT #m.
The Disk may be unusable."
4. "FATAL error #xxxx, writing sector #nnnn in FAT #m.
Data may be destroyed!"
5. "CRITICAL error #xxxx, reading sector #nnnn in the ROOT area.
The Disk may be unusable."
6. "FATAL error #xxxx, writing sector #nnnn in the Root area.
Data may be destroyed!"
Internal Errors:
----------------
This last category of errors should NEVER occur. They are always
associated with programming bugs and have been included solely
to help with debugging. If you ever get an "Internal Error",
please report it immediately and I will try and find the cause
of the problem.
APPENDIX C - BUGS
-----------------
Although ORG has been tested thoroughly, I cannot guarantee that
it is truly free of bugs. If you encounter what you believe to
be a bug in ORG, you should try the following steps before calling
or sending in a "Bug Report":
Remove all TSR programs from your system, especially programs such
as disk cache software or RAM drives or, better still, re-boot the
computer from a "virgin" DOS diskette and try to run ORG again. If
ORG runs in this environment but not in your normal DOS
environment, try reconstructing the system under which ORG failed
Page 20
Documentation for ORG V:2.1 Copyright 90/91, M.H. Greve
by adding drivers and TSR's one by one until the problem re-
appears. If you find the particular software which causes the
trouble, please let me know about it, so that I can warn other
users and try to find a "workaround" and send you an upgrade.
APPENDIX D - TECHNICAL SUPPORT
------------------------------
If the above approach does not work, please send a detailed report
including a full description of your system to either Dave Rifkind
or myself (addresses shown below) and we will try to help you find
and solve the problem.
NORTH AMERICA (U.S., CANADA, AND MEXICO):
David Rifkind
1800 West Hillcrest Drive, #287
Newbury Park, CA 91320
USA
OUTSIDE NORTH AMERICA:
Michael H. Greve
Aubrigstrasse 23
CH 8804 AU
Switzerland
Compuserve and BIX on-line support:
-----------------------------------
If you have access to Compuserve you can contact Dave Rifkind
under the Compuserve ID: 72510,2214.
If you have access to BIX, you can contact Mike Greve under the
BIXname "mike123" or Dave Rifkind under the BIXname "drifkind".