READBKP.EXE

Release 1.00

May 1, 1989

-----------------------------------------------
(c) 1989 by William F. Plachy Jr.
All Rights Reserved
Limited permission is granted to individual users
for private, non-commercial use and transmission
to other individuals, provided these files
are unaltered in any way.

All other rights are explicitly reserved
by the author.
-----------------------------------------------


READBKP Documentation Page 2/6


READBKP is a program that will read MS/PC DOS(tm) BACKUP diskettes
created under MS/PC DOS 3.1 or later and list the individual files
contained on the diskette.

Output is to stdout or a disk file that uses the same format as the log
file created by the BACKUP command with the /l: option.



DISTRIBUTION
------------

This program is free provided it is used in a non-business or commercial
environment. The general public is encouraged to share and distribute
copies of this program free of charge, provided the archive file is
kept intact, and the files and documentation are not altered in any way.

The full Microsoft C(tm) and MASM(tm) source code, commercial or
multi-user licenses, and custom versions are available from the author
for a modest fee.


DISCLAIMER
----------
This software (including instructions for its use) is provided "as is"
without warranty of any kind. Further, the author does not warrant,
guarantee, or make any representations regarding the use, or the results
of the use, of the software or written materials concerning the software
in terms of correctness, accuracy, reliability, currentness, or
otherwise. The entire risk as to the results and performance of the
software is assumed by you. If the software or written materials are
defective, you, and not the author or its dealers, distributors or
agents, assume the entire cost of all necessary servicing, repair or
correction.

Neither the author nor anyone else who has been involved in the
creation, production, or delivery of this software shall be liable
for any direct, indirect, consequential, or incidental damages
(including damages for loss of business profits, business
interruption, loss of business information, and the like) arising
out of the use of or inability to use such software even if the
author has been advised of the possibility of such damages.

The software is written in Microsoft C 5.1(tm) and MASM 5.0(tm). It
uses MSC supplied functions and VIDEO BIOS (INT 10H) sub-functions.


READBKP Documentation Page 2/6


MINIMUM REQUIREMENTS
--------------------

MS/PC DOS 2.0 or higher.
Approximately 14K RAM for program execution.


USAGE
-----

READBKP [options] [input drive] [output file]

OPTIONS:
--------

All options must be preceded by a slash (/) or a dash (-). They may be
entered seperately or strung together without regard to case. They may
appear anywhere in the command line, and in any order. The following
are valid:

READBKP output.log -mp!w a:

READBKP a: -m -P -!w output.log

All options may be preceded with the logical NOT operator (!) which
causes the option to be reversed.


Option Keyword Used for/Results in:
------ ------- --------------------

more m Multiple backup diskettes. A conformation
message will be issued for each diskette.

The default is a single diskette (!M).

pause p The screen display will pause when full.

The default is a no pause (!P).

wide w Will display only the file name and ext.
With multiple files per line (5 in 80 col
mode, 3 in 40 col mode)

The wide option has no effect if the output
has been directed to a disk file.

The default is a not wide (!W).

If the same option is entered more than once, only the last occurrence
will be in effect. If the following is entered:

READBKP -mp!m

Only a single diskette will be read.


READBKP Documentation Page 3/6


INPUT DRIVE:
------------

The input drive is specified as any valid drive letter (A-Z) followed by
a colon. There may not be any spaces between the drive letter and
ending colon.

If an input drive is not specified the default is the A: drive.



OUTPUT FILE:
------------

Any valid MS/PC DOS drive, path, file name combination may be used. The
following are correct:

BKPREAD c:\junk\backup.log

BKPREAD backup.log

BKPREAD b

NOTE! The last example will result in the file "b" being created in the
current directory. It will not be interpreted as input from the B:
drive because of the absence of the ending colon.

If the output file already exists the user will be given the opportunity
to replace (overwrite) the existing file, append to the end of it, or
abort the program.

If an output file is not specified, output will be written to the
terminal.


READBKP Documentation Page 4/6


RETURN CODES
------------

0 - Normal completion.

4 - Control File Not Found. The file CONTROL.??? was not found on
the input drive.

16 - Error opening or reading the CONTROL.??? file, or invalid data
was found in the control file.

24 - Escape key was used to respond to a program message.

All non-zero conditions are accompanied by an error message.


MISC. INFORMATION:
------------------

The Escape (ESC) key may be used to respond to any program message. If
it is used the program will terminate immediately.

For anything other than normal program termination a return code greater
than zero will be issued.

When output is directed to the screen the program will pause at the
start of each new directory. This will happen no matter what value was
used for the "pause" option.

Re-directing screen (stdout) output will work, but not very well. If it
is re-directed the directory information will be lost and you must still
reply to program pauses but you won't be able to see the message. The
recomendation is to use the "output file" option and then print the
file.

This program was developed on an IBM PS/2 Model 80 (80386) with VGA and
color monitor. I believe it will work on any IBM PC, or compatible.
I wrote the display handling functions as a means of learning MASM and
VIDEO BIOS. The documentation I have states that the BIOS functions
used are supported on all displays and adpaters, but once or twice I've
found documentation to be incorrect. Please let me know if you
encounter any problems.


READBKP Documentation Page 5/6


USAGE EXAMPLES
--------------

READBKP or READBKP a:

Will read the file from the A: drive and output a full file
list to the screen. Output will scroll off the screen.



READBKP -p or READBKP -p a:

Will read the file from the A: drive and output a full file
list to the screen. Output will not scroll off the screen.



READBKP -mp backupf.lst

Will read multiple files from the A: drive and output a full file
list to the file "BACKUPF.LST" in the current directory. Output
will not scroll off the screen.



READBKP -mp d:\list\sublst\backupf.lst b:

Will read multiple files from the B: drive and output a full file
list to the file "BACKUPF.LST" in the sub-directory "sublst" in
the sub-directory "LIST" on the D: drive. Output will not scroll
off the screen.



READBKP Documentation Page 6/6


I hope you find this to be as useful as I have. Any comments or
suggestions (except nasty ones) will be appreciated.

If you encounter any problems or, heaven forbid, program bugs please
let me know. In spite of the DISCLAIMER I take pride in my code and
will attempt to fix any reported bugs. I'll also consider changes or
additions.

I can be reached on COMPUSERVE (although infrequently), the EXEC-PCT
RBBS or at home.

William F. Plachy Jr.
SpareTime Software
9226 Bayberry Ln.
Tinley Park, II 60477

(312) 614-0890

COMPUSERVE ID: 71170,2443