Simtel MSDOS 1992 June

home *** CD-ROM | disk | FTP | other *** search

/ Simtel MSDOS 1992 June / SIMTEL_0692.cdr / msdos / dskutl / ibuv2.arc / IBU.DOC < prev next >

Wrap

Text File | 1988-03-26 | 62.6 KB | 1,893 lines

INTERACTIVE BACKUP UTILITY V2.00 03-26-1988 Mike Hodapp 5609 Apache Road Louisville, KY 40207 INTERACTIVE BACKUP UTILITY V2.00 CONTENTS INTERACTIVE BACKUP UTILITY USERS GUIDE ...................... 1 INTRODUCTION ................................................ 1 OVERVIEW .................................................. 1 CAPABILITIES .............................................. 2 BENEFITS .................................................. 4 HARDWARE REQUIREMENTS ..................................... 4 SOFTWARE REQUIREMENTS ..................................... 4 HOW TO USE THE PROGRAM ...................................... 5 INVOCATION ................................................ 5 DRIVE SELECTION ........................................... 6 CUSTOMIZING THE PROGRAM OPTIONS. ......................... 7 FUNCTIONS AVAILABLE WHILE DISPLAYING FILE NAMES .......... 10 OTHER KEYS SUPPORTED WHILE DISPLAYING FILE NAMES ......... 13 COLOR ADAPTER CONTROL WHILE DISPLAYING FILE NAMES ........ 15 Appendix A: FILE NAME DISPLAY SCREEN ....................... 17 Appendix B: RESTART DISPLAY SCREEN ......................... 19 Appendix C: MESSAGES ....................................... 20 Appendix D: USER SUPPORTED SOFTWARE CONCEPT ................ 26 AVAILABILITY ............................................. 26 COPYING .................................................. 26 DISCLAIMER ............................................... 26 PERMISSION TO COPY ....................................... 26 THE USER-SUPPORTED CONCEPT ............................... 27 Contents ii INTERACTIVE BACKUP UTILITY V2.00 INTERACTIVE BACKUP UTILITY USERS GUIDE INTRODUCTION OVERVIEW The Interactive Backup Utility provides an easy method for backing up new or modified disk and diskette files. Some of it's features include: * Operates as a DOS command. * Displays the space required on the target disk/diskette for the backup operation. * Displays the amount of free space on both the source and the target disk/diskette. * Provides a full screen display of the file names selected for backup, and provides for scrolling of the display. * Provides 7 sorting sequences for the file display. * Allows files selected for backup to be marked for exclusion from backup. * Allows files selected for backup to be marked for deletion. * Allows files marked for exclusion or deletion to be unmarked prior to actually being excluded or deleted. * Provides a display of the function key definitions; functions assigned to shifted function keys, Ctrl-function keys, and Alt-function keys are displayed when the shift, Ctrl or Alt keys are held down. * Can be invoked once and used any number of times without having to be invoked again. * Will copy any valid DOS file including those with the hidden file attribute; zero length files, including volume labels and sub-directory entries are not copied. * Allows paths to be specified for both source and target disk/diskettes. INTERACTIVE BACKUP UTILITY USERS GUIDE 1 INTERACTIVE BACKUP UTILITY V2.00 * Allows permanent or temporary modification of the function key definitions. * Allows permanent or temporary modification of the colors displayed if a color monitor is being used. * Allows permanent and temporary specification of backup based on the file's date, the file's archive attribute or both the file's date and archive attribute. * Allows permanent and temporary specification of the default source and target drives. * Allows permanent and temporary specification of the amount of memory to reserve for DOS's COMMAND.COM. CAPABILITIES This utility is designed to be an extension to DOS and is invoked like any other DOS command. As with many of the other DOS commands, file specifications and an optional parameter may be entered on the command line when invoking the program. The file specifications are used to qualify the names of the files to be backed up as well as the names of the backup files themselves. The backup copy of a file may be on the same disk or diskette as the original file if its filename or extension is different than the original file. The names of all files which are candidates for backup are displayed for you to examine. A file becomes a candidate based on: 1. its directory date and time compared to the date and time of its backup file, 2. its archive attribute, or 3. both of the these. You can customize the program for one of these options. Files may be excluded from the display and as candidates for backup via function key. It is also possible to delete files that have been selected for backup by pressing a function key. The exclusion and deletion actions are "marked" on the display and do not actually take place until you press the "Process" function key or the "RUN" function key. This two step procedure reduces the possibility of accidents, especially in the case of INTERACTIVE BACKUP UTILITY USERS GUIDE 2 INTERACTIVE BACKUP UTILITY V2.00 deletions. Files marked for exclusion or deletion may also be "Unmarked". The unmarking may be done individually or all marks can be "Reset" at the same time. The display heading reflects the file specifications entered at invocation or restart time, the amount of space required for the backup, the amount of free space on both the source and the target disk/diskette, and the invocation time and date. See "Appendix A: FILE NAME DISPLAY SCREEN" on page 17. The body of the display contains a line for each file selected for backup and a second line for the backup file. Each of these display lines contains the date and time of the file as well as its size and file attributes. The last line of the display shows the function key definitions. The last line of the display will also be used to display messages generated by the utility. You can sort the display into any of seven sequences via function keys. The Esc key is a "Quit" key; it takes you up a level in the hierarchy of display screens or terminates the program if you are at the restart screen. You may also define a function key as a "Quit" key for the file display screen. The utility can be restarted without having to be invoked again. The restart screen allows you to reuse or modify previous backup file specifications, or terminate the utility. This eliminates having to reload the program from disk/diskette for each use when you have several diskettes or subdirectories to backup. See "Appendix B: RESTART DISPLAY SCREEN" on page 19. Any valid DOS file may be copied for backup. Zero length files are not considered valid files and will not be copied. Any attempt to backup a zero length file will be ignored during the actual copy processing. Subdirectory entries will not be copied since they are zero length files. Paths are fully supported allowing you to copy from any subdirectory to any other subdirectory. Some care is required when using the Interactive Backup Utility to backup or copy the two files IBMBIO.COM and IBMDOS.COM. These two files are the DOS system modules loaded into memory when you start DOS. They need to be the first files physically on a volume; they are normally placed properly by the DOS FORMAT or SYS commands. While the Interactive Backup Utility will copy these files, it cannot guarantee copying them to their required locations for creating a DOS system. They will be copied to the first "available" sectors on the target disk/diskette. INTERACTIVE BACKUP UTILITY USERS GUIDE 3 INTERACTIVE BACKUP UTILITY V2.00 BENEFITS The major benefit of the Interactive Backup Utility is its display of the files selected for backup. This allows you to override and refine the selection process prior to any backup action. You are informed about the space requirements and alerted if enough space is not available on the backup disk/diskette. HARDWARE REQUIREMENTS The Interactive Backup Utility requires two diskette drives (or one diskette drive and one disk) and an eighty column display. SOFTWARE REQUIREMENTS The Interactive Backup Utility has been written in assembler language to minimize its size and maximize its speed. The Interactive Backup Utility requires the IBM Personal Computer Disk Operating System (DOS) version 2.00 or later. It has been tested with DOS versions 2.00, 2.10, 3.20 and 3.30. INTERACTIVE BACKUP UTILITY USERS GUIDE 4 INTERACTIVE BACKUP UTILITY V2.00 HOW TO USE THE PROGRAM INVOCATION The Interactive Backup Utility is invoked like any other DOS external command by keying in its name, IBU. The command may be qualified by keying in one or two file specifications and an optional parameter. The command format is: IBU [d:][path][filename[.ext]] [d:][path][filename[.ext]] [/O] The first parameter you specify identifies the source file(s). The second parameter identifies the target file(s). You may use the global characters ? and * in the filename and in the extension of both the source and target files. If you use the /O parameter the Interactive Backup Utility will display and allow modification of various program options (see "CUSTOMIZING THE PROGRAM OPTIONS." on page 7). Examples: 1. IBU will display all the files on the default source disk/diskette drive which are candidates for backup to the default target drive. 2. IBU b: will display all the files on the B drive which are candidates for backup to the default target drive. 3. IBU *.bas will display all the files on the default source drive with an extension of BAS which are candidates for backup to the default target drive. 4. IBU *.abc *.cba will display all the files on the default source drive with an extension of ABC which are candidates for backup to the default target drive with the same file name, but with extension CBA. INTERACTIVE BACKUP UTILITY USERS GUIDE 5 INTERACTIVE BACKUP UTILITY V2.00 5. IBU xyz*.* will display all the files on the default source drive with names beginning XYZ which are candidates for backup to the default target drive. 6. IBU xyz*.* zyx*.* will display all the files on the default source drive with names beginning XYZ which are candidates for backup to the default target drive with names beginning ZYX. 7. IBU ab??ef will display all the files on the default source drive with names beginning AB followed by any two characters and ending with EF which are candidates for backup to the default target drive. Note that there is no extension. 8. IBU a:*.pas a:*.pab will display all the files on the A drive with an extension of PAS which are candidates for backup to the A drive with an extension of PAB. 9. IBU c:\sub1\sub2\sub3\*.* c:\sub4\*.* will display all the files in path \sub1\sub2\sub3\ on the C drive which are candidates for backup in path \sub4\ on the C drive. DRIVE SELECTION The source and target drives may be specified in one of several ways: 1. You may permanently select default drives for the program using the /O invocation parameter, selecting the desired source and target default drives and then saving the program. These defaults will then be the defaults used each time the program is invoked unless overridden as specified below. If you tend to always have the same source and target drives, you will want to utilize this facility. 2. You may select default drives for this invocation of the program using the /O invocation parameter, selecting the desired source and target default drives and then NOT saving the program. 3. You may select default drives each time the restart screen is displayed. This sets the source and target default drives INTERACTIVE BACKUP UTILITY USERS GUIDE 6 INTERACTIVE BACKUP UTILITY V2.00 for the program until overridden on a succeeding restart screen. 4. You may explicitly specify the source and the target drive as part of a file specification parameter either at invocation time or at restart time. 5. The program as distributed uses an algorithm to determine the source and target drives when none of the above methods apply. The algorithm is retained from previous versions of the program. It is used when either or both of the program's default source and target drives are set to "0", i.e., zero. a. If your system does not have a C drive (your system has only two diskette drives and no hard disk or RAM disk) then: * If neither source nor target drive is specified as part of the file specifications the backup will be from the DOS system default drive to the other drive. * If either drive is explicitly specified the other drive will be the non-specified drive. b. If your system has a C drive then: * If neither source nor target drive is specified as part of the file specifications then: - If A is the DOS system default drive the backup will be from drive A to drive C. - If A is not the DOS system default drive the backup will be from the default drive to drive A. * If either drive is explicitly specified and the other is not specified then: - If the explicitly specified drive is not the DOS system default drive, the other drive will be the DOS system default drive. - If A is not the DOS system default drive, and the explicitly specified drive is the DOS system default drive, the other drive will be the A drive. - If A is the DOS system default drive, and the explicitly specified drive is the A drive, the other drive will be the C drive. CUSTOMIZING THE PROGRAM OPTIONS. If you key the /O parameter when invoking the program the current default options are displayed. You can change the defaults to suit your needs. Changes are made by rotating valid alternatives for each default. Forward and backward rotation is controlled by function keys. You move the cursor from field to field and area to area using the cursor movement keys: INTERACTIVE BACKUP UTILITY USERS GUIDE 7 INTERACTIVE BACKUP UTILITY V2.00 Up-arrow - move the cursor up one field. Down-arrow - move the cursor down one field. Left-arrow - move the cursor left one field. Right-arrow - move the cursor right one field. Tab - move the cursor right one field. Shift-tab - move the cursor left one field. Enter - move the cursor to the first field on the next row. There are three major areas on the customizing screen, each area contained within a box. Movement of the cursor from one area to another can only occur when the cursor is in the first or last row of an area. You can move the cursor up or down to the next area. You may restore the settings to their values upon entry to the customizing screen at any time by pressing the Esc key. When you have completed your modifications you may save them permanently by pressing F9 and then modifying, as desired, the program file name (of course, the file extension must remain "COM" or the program will not be executable.) If you press F10 after making any changes the modifications will be for this session only, i.e., only for this invocation of the program. THE PROGRAM OPTIONS. BACKUP CONTROL: used to control selection of backup candidate files. It can be set to: * DATE - select backup candidates based on their directory date and time compared to the date and time of the backup file, * ARCHIVE ATTRIBUTE - select a file for backup if its DOS directory archive attribute is on, implying that the file has been modified or is new, * DATE AND ARCHIVE ATTRIBUTE - select a file for backup if both its date and archive attribute imply it needs to be backed up. BACKUP CONTROL can also be changed at restart time. DEFAULT SOURCE DRIVE and DEFAULT TARGET DRIVE: can be set to zero (0) to indicate the DOS system default drive or any valid letter, A-Z. If you tend to always backup from the same source drive to the same target drive, e.g., from your "C:" drive to your "A:" drive, you will want to set the default source drive to "C" and the default target drive to "A". DEFAULT SOURCE DRIVE and DEFAULT TARGET DRIVE can also be changed at restart time. INTERACTIVE BACKUP UTILITY USERS GUIDE 8 INTERACTIVE BACKUP UTILITY V2.00 SPACE TO BE RESERVED FOR "COMMAND.COM": can be set in increments of 1,024 to be from 0 to 655,360 (640K) bytes. The program uses as much memory as it needs, and is available, to copy files. This leads to the possibility of overlaying the resident portion of the DOS COMMAND.COM; if a program overlays COMMAND.COM, then DOS must reload COMMAND.COM when the program terminates. In a diskette only system, reloading COMMAND.COM frequently means having to insert the DOS system disk in the drive used to boot your PC - a minor nuisance. The amount of memory required by the resident portion of COMMAND.COM varies by DOS version. If after terminating this program you frequently get a message something like "Insert COMMAND.COM disk in drive A: and strike any key when ready," then you should experiment by setting this default to 3,072 and increasing it until you no longer get the message. SPACE TO BE RESERVED FOR "COMMAND.COM" can also be changed at restart time, but this will not preserve "COMMAND.COM" if it has already been overlayed. FUNCTION KEYS: can be set to the functions defined in "FUNCTIONS AVAILABLE WHILE DISPLAYING FILE NAMES" on page 10. The unshifted function keys are identified as F1 to F0, the shift-function keys as S1 to S0, the Ctrl-function keys as C1 to C0, and the Alt-function keys as A1 to A0. COLORS: can be set for the different areas of the display screens if you are using a color adapter. These options are not displayed unless you are using a color adapter. Foreground and background colors can be rotated for each area. The different areas are: * HEADING - refers to the heading area of the file display screen where the source and target file specifications and space statistics are displayed. * MESSAGES - refers primarily to the last line of the screen when error messages are being displayed. * FILES 1,3,... - refers to the file display area of the file display screen where the odd numbered files are displayed. * FILES 2,4,... - refers to the file display area of the file display screen where the even numbered files are displayed. * INPUT - refers to any area that can be modified by rotating a valid entry into it or which can be keyed into. * FUNCTION KEYS - refers to the last line of the file display screen where the function key definitions are normally displayed. * OTHER - refers to any area not defined above. Colors for FILES 1,3,... and FILES 2,4,... may also be changed when the file display screen is being displayed by pressing the "Color" function key. INTERACTIVE BACKUP UTILITY USERS GUIDE 9 INTERACTIVE BACKUP UTILITY V2.00 FUNCTIONS AVAILABLE WHILE DISPLAYING FILE NAMES The following functions may be assigned to functions keys. Forty function keys are supported by the program: the normal unshifted function keys, the shift-function keys, the Ctrl-function keys and the Alt-function keys. Function key assignments are displayed on the last line of the screen; holding down a shift key, Ctrl or Alt key displays the functions assigned to the combination of those keys and the function keys. The program is distributed with each of these functions assigned. You may change the assignments after specifying the /O parameter when invoking the Interactive Backup Utility (see "CUSTOMIZING THE PROGRAM OPTIONS." on page 7). Adate = Sort by Date and Time. Sort the display by the source file date and time, i.e., the oldest file first. Asize = Sort by Size. Sort the display by the source file size, i.e., the smallest file first. Color = Modify the color adapter display attributes. You will be prompted to modify the display attributes for the monitor(s) attached to your color adapter. This gives you the opportunity to determine the attributes which are most pleasant on the monitor you are using. See message number 701 and COLOR ADAPTER CONTROL. Note. Unless you are actually using a color adapter this function is undefined even though the word Color appears on your display. Colors for all areas may be modified after specifying the /O invocation parameter (see "CUSTOMIZING THE PROGRAM OPTIONS." on page 7). Dates = Sort Descending by Date and Time. Sort the display into descending order by the source file date and time, i.e., the latest date and time first. INTERACTIVE BACKUP UTILITY USERS GUIDE 10 INTERACTIVE BACKUP UTILITY V2.00 Delet = Mark for deletion. Mark the file on the line where the cursor resides for deletion. A character D is placed on the line with the file to be deleted. The deletion can be reset and the D removed by using the "Unmrk" function key. All the files marked for deletion using the "Delet" function key may be unmarked by using the "Reset" function key. A file marked for deletion is actually deleted after pressing the "ProcM" function key or the "RUN" function key. eXcld = Exclude. Mark the file on the line where the cursor resides for exclusion from backup. An X is placed on the line with the file to be excluded. The exclusion can be reset and the X removed by using the "Unmrk" function key. All the files marked for exclusion using the "eXcld" function key may be unmarked by using the "Reset" function key. A file marked for exclusion will be excluded from the display after pressing the "ProcM" function key. Once excluded from the display a file may not be re-displayed or otherwise processed without restarting the utility. Exts = Sort by Extension, Filename. Sort the display by the source file extension and filename. Help. Display the help screen. Names = Sort by Filename, Extension. Sort the display by the source filename and extension. INTERACTIVE BACKUP UTILITY USERS GUIDE 11 INTERACTIVE BACKUP UTILITY V2.00 Paths = Display the source and target paths. The file name display will be replaced by a screen which: * Displays the current source path if different from the its default path, i.e., if you specified a source path. * Displays the default source path, i.e., the path in effect when the utility was invoked. * Displays the current target path if different from the its default path, i.e., if you specified a target path. * Displays the default target path, i.e., the path in effect when the utility was invoked. The default paths will always be displayed, the current paths only if you specified a path. This function is useful when you need to know the status of the paths to the active subdirectories. The file name display is reinitialized by pressing any non-control key. ProcM = Process all the currently marked files. Press this key if files marked for exclusion are to be excluded from any further display or if files marked for deletion are to actually be deleted. The number of files to be copied and the number of clusters required will also be updated in the heading lines. Quit. Terminate the current display activity. Reset = Reset all marks. This will unmark all files currently marked for either exclusion or deletion. A sub-function sorts the files to their original order, i.e., the order in which they exist in the directory of the source disk/diskette. RUN = Backup any unmarked file. Perform the backup operation. A sub-function first processes all the marked files. Sizes = Sort Descending by Size. Sort the display into descending order by the size of the source file, i.e., the largest file first. INTERACTIVE BACKUP UTILITY USERS GUIDE 12 INTERACTIVE BACKUP UTILITY V2.00 Unmrk = Unmark. Unmark the file on the line where the cursor resides. When a file has been previously marked for exclusion or deletion, this key may be used to reset the mark. The use of marks for exclusion and deletion and the ability to reset the marks gives you a chance to change your mind about excluding or deleting a file. OTHER KEYS SUPPORTED WHILE DISPLAYING FILE NAMES The cursor control keys and the page control keys are used to manipulate the display screen. HOME - Re-display the first page and position the cursor at the first file. END - Display or re-display the last page and position the cursor at the last file. PgUp - Scroll up one full page, displaying those files closer to the beginning of the current sorting sequence. PgDn - Scroll down one full page, displaying those files closer to the end of the current sorting sequence. Cursor Down - Move the cursor down to the next displayed file. If at the bottom of the display page scroll the current display a half page. Cursor Up - Move the cursor up to the next displayed candidate file. If at the top of the display page scroll the current display a half page. Return - Same as the Cursor Down key. Esc - provides the same function as the "Quit" function key while displaying files. If you use the Esc key while a file is being copied, the backup operation will be terminated after the active copy completes. INTERACTIVE BACKUP UTILITY USERS GUIDE 13 INTERACTIVE BACKUP UTILITY V2.00 Ctrl-Break - Terminate the current processing. You may use the Ctrl-Break anytime you wish to interrupt the utility. In most cases you will be immediately presented with message number 302 which allows you to exit to DOS or restart the utility. If you use the Ctrl-Break key while a file is being copied, the backup copy will be deleted from the target disk/diskette. This means that neither the old backup copy, which has already been deleted, nor the new copy will exist on the target disk/diskette. Once the copy process has started, it is not possible to recover the previous backup copy of a file. INTERACTIVE BACKUP UTILITY USERS GUIDE 14 INTERACTIVE BACKUP UTILITY V2.00 COLOR ADAPTER CONTROL WHILE DISPLAYING FILE NAMES You can control the colors used by the program for all screens and all areas by specifying the /O parameter at invocation time. Older versions of this program allowed for changing the colors only on the file display screen and that capability is described below. The file display screen can have different colors for alternating pairs of source and target file specifications. You have the option of modifying the display attributes so that you can find a combination that works well with your monitor. To change the color adapter attributes you must first press the "Color" function key. This causes message 701 to be displayed: 701 : CURRENT C/G ATTRIBUTES ARE ABCD.4321 The current color attributes are displayed in place of the characters ABCD. The characters 4321 are not part of the message but are used here to represent where you key in new attributes. The cursor will initially be where the 4 is. The character positions above represent the following: A is the first background color. B is the first foreground or character color. C is the second background color. D is the second foreground or character color. 4 will become the first background color. 3 will become the first foreground color. 2 will become the second background color. 1 will become the second foreground color. Any of the above character positions may contain or have keyed into it a valid hexadecimal digit, i.e., in the range 0-9,A-F. Both uppercase and lowercase alphabetic characters may be keyed, but all characters will be displayed in uppercase. Once a valid character has been keyed and displayed you may not change it; complete the current entry and press the "Color" function key again to make any changes. There are over 65,000 combinations available. Some are great --- some are awful --- and some will display nothing! INTERACTIVE BACKUP UTILITY USERS GUIDE 15 INTERACTIVE BACKUP UTILITY V2.00 CODE BACKGROUND FOREGROUND ---- ------------------------------- ------------- 0 BLACK BLACK 1 BLUE BLUE 2 GREEN GREEN 3 CYAN CYAN 4 RED RED 5 MAGENTA MAGENTA 6 BROWN BROWN 7 LIGHT GRAY LIGHT GRAY 8 BLACK, BLINKING FOREGROUND DARK GRAY 9 BLUE, BLINKING FOREGROUND LIGHT BLUE A GREEN, BLINKING FOREGROUND LIGHT GREEN B CYAN, BLINKING FOREGROUND LIGHT CYAN C RED, BLINKING FOREGROUND LIGHT RED D MAGENTA, BLINKING FOREGROUND LIGHT MAGENTA E BROWN, BLINKING FOREGROUND YELLOW F LIGHT GRAY, BLINKING FOREGROUND WHITE A complete discussion of the C/G display attributes is beyond the scope of this documentation. The PC Technical Reference manual contains that information. INTERACTIVE BACKUP UTILITY USERS GUIDE 16 INTERACTIVE BACKUP UTILITY V2.00 APPENDIX A: FILE NAME DISPLAY SCREEN The file name screen for the Interactive Backup Utility is composed of three major areas. The first two lines of the screen are the area for displaying * the source and target file specifications. The source is displayed on line 1 and the target on line 2. The file specifications include the drive, file name and file extension. The path, if one exists, can be displayed by pressing the "Paths" function key. A "?" character in the source file name or extension indicates a "wild card" position, i.e., one not checked when determining which source files are candidates for backup. In the case of the target file specification a "?" means this position in the name or extension is or will be a duplicate of the same position in the source file name or extension. * the DOS date, MM/DD/YY, and time, HH:MM, when the program was invoked or restarted. * the free space for the source and target volumes in total bytes and cluster count. * the number of files selected as candidates for backup. * the clusters required to copy the backup candidates to the target volume. If this number is greater than the number of clusters available on the target disk/diskette, then you must exclude one or more files before pressing the "RUN" key; otherwise an error will occur when the target disk/diskette becomes full during the copying of one of the files (see message 902). The field for this number will be treated as a message area when it is greater than the number of available clusters on the target disk/diskette. The number will be followed by a minus sign (-) if the number of clusters required to backup the selected files is negative, indicating that the free space on the target volume will increase after the copying is complete. The middle portion of the screen is used to display the files selected for backup. The source file is displayed on one line and the target file is displayed on the next line. The first position of each source file line is used as an area to place an "X" or a "D" if the file has been marked for exclusion or deletion. The remainder of the source line and the target line contain * the file name and extension. Appendix A: FILE NAME DISPLAY SCREEN 17 INTERACTIVE BACKUP UTILITY V2.00 Note: if a file must be created on the target volume in order to copy a file from the source volume, only the target file name and extension will be displayed. * the date and time the file was last modified. Note: while only hours and minutes are displayed, the time used internally is in two second increments which is what DOS stores in the disk/diskette directory. * the file size in bytes and number of clusters. * the file's directory attributes. The file attributes are 00 - no special attributes 01 - read only file 02 - hidden file (not displayed by the DIR command.) 04 - system file (normally a DOS system file.) 08 - volume label entry 10 - sub-directory entry 20 - archive bit The attributes are stored in the disk/diskette directory in a single byte. The above represents the hexadecimal mapping of the bits in the attribute byte. The attributes will frequently be combined, e.g., 26 indicates 20 + 02 + 04 and 1A (if legitimate) would indicate 10 + 02 + 08. The following words and mnemonics are used to explain the attribute: RO - Read Only. H - Hidden S - System LABEL - Volume Label SUBDIR - Subdirectory A - Archive bit The last line of the screen is used to display function key definitions and error messages. Appendix A: FILE NAME DISPLAY SCREEN 18 INTERACTIVE BACKUP UTILITY V2.00 APPENDIX B: RESTART DISPLAY SCREEN The restart display is provided to enable you to continue using the utility without having to reinvoke it from DOS. In a diskette only system, this will reduce the number of times you must insert a diskette containing the utility as well as reduce the number of diskettes which must contain a copy of the utility. Lines 1 and 2 contain the parameters you keyed on the DOS command line or that you specified during the previous restart. You may edit this area to provide new file specifications for another backup operation. The keys available for editing are defined on the screen. Line 4 displays the backup option in effect following the words BACKUP OPTION: The backup option may be changed by positioning the cursor and rotating forward or backward to a different option. Line 5 displays the default source drive following the words DEFAULT SOURCE DRIVE: The default may be changed by positioning the cursor and rotating forward or backward to a different drive. Line 6 displays the default target drive following the words DEFAULT TARGET DRIVE: The default may be changed by positioning the cursor and rotating forward or backward to a different drive. The rest of the screen except for the last line, which displays message 302, defines the keys which may be used to modify the file specification area, the backup option and the default drives. Appendix B: RESTART DISPLAY SCREEN 19 INTERACTIVE BACKUP UTILITY V2.00 APPENDIX C: MESSAGES All messages generated by the Interactive Backup Utility will be displayed on the last line of the screen. Each message will have the following format: ### : MESSAGE where ### is a unique number. Unless prompted otherwise, all messages require that you press a non-control key such as the space bar or return key in order for the program to proceed. 001 : DOS VERSION 2.0 OR HIGHER REQUIRED This version of the Interactive Backup Utility requires DOS version 2.0 or higher. 002 : PRESS Esc TO BYPASS SAVE, F1 FOR HELP, ENTER TO PROCESS. This message appears after you have requested a permanent change to the program's function key definitions and other options. Pressing the Esc key will bypass the save and return you to the option modification screen. Pressing the F1 key will provide additional help. Pressing the ENTER key will save the program using the displayed file specification. 201 : INSERT DISKETTES AS INDICATED ABOVE AND PRESS ANY KEY. The source drive and the target drive are displayed immediately above this message. If you need to change the diskettes currently in either of the drives you must do so now. 202 : INVALID SOURCE/TARGET PATH SPECIFICATION. PRESS ANY KEY. The path specified was not acceptable to DOS. Press any non-control key and the utility will return you to the restart screen where the path specification will be displayed as part of your previous specifications. Appendix C: MESSAGES 20 INTERACTIVE BACKUP UTILITY V2.00 203 : SOURCE/TARGET PATH HAS BECOME INVALID. The utility has attempted to issue a DOS CHDIR (Change Directory Command) for the source or target path as indicated and DOS has returned an invalid path response. This might occur if you have changed diskettes after responding to message 201. Press any non-control key and the utility will return you to the restart screen. 204 : PRESS ANY KEY TO CONTINUE. The utility requires that you press some non-control key before it will resume. This message appears following the display of the current and default paths resulting from pressing the "Path" function key or while displaying a "HELP" screen. 301 : PATH COULD NOT BE RESTORED FOR SOURCE/TARGET. PRESS ANY KEY. Any time paths have been specified for a backup operation the Interactive Backup Utility will attempt to restore the path as it existed at the time the utility was invoked. It attempts this restoration prior to displaying the restart screen. If restoration fails the path for the specified device will be its root directory. 302 : PRESS Esc TO TERMINATE, F1 FOR HELP, ENTER TO PROCESS. All current processing has completed or you have pressed Ctrl-Break, Esc or the "Quit" function key. Pressing Esc will terminate the utility and return you to DOS. Pressing the F1 key will provide additional help. Modifying the previous source and target file specifications and pressing the ENTER key restarts the utility. 501 : TOO MANY SOURCE/TARGET FILES FOR AVAILABLE MEMORY. PRESS ANY KEY. The program utilizes all the memory available to it, up to 64K bytes, in building tables of filenames. However, in this case, while building either source or target directory tables, an out-of-memory condition has been detected. It is suggested that you qualify the relevant filespec to reduce the number of directory entries that need to be processed, or increase the amount of memory available to the program if it is currently less than 80K bytes. Appendix C: MESSAGES 21 INTERACTIVE BACKUP UTILITY V2.00 Press any non-control key and the utility will return you to the restart screen. 502 : TOO MANY FILES FOR AVAILABLE MEMORY. PRESS ANY KEY. The program utilizes all the memory available to it, up to 64K bytes, in building tables of filenames. However in this case, while building the table of backup candidates, an out-of-memory condition has been detected. It is suggested that you qualify the source filespec to reduce the number of files which are backup candidates, or increase the amount of memory available to the program if it is currently less than 80K bytes. Press any non-control key and the utility will return you to the restart screen. 601 : NO BACKUP CANDIDATE FILES. PRESS ANY KEY. No files on the source disk/diskette are candidates for backup. Press any non-control key and the utility will return you to the restart screen. 602 : FILE TO BE DELETED DOES NOT EXIST ON INPUT DISKETTE. The displayed file, previously marked for deletion can not be found on the input disk/diskette during processing of the marked files. You must have changed diskettes. Press any non-control key to continue. 603 : SUBDIRECTORIES CAN NOT BE DELETED. You have attempted to delete a DOS subdirectory entry. Deletion of subdirectories is not supported. Press any non-control key to continue. 604 : DELETE READ-ONLY FILE? (Y/N): This prompt is presented prior to actual deletion of a read-only file. Pressing the "Y" key, either upper or lower case, will confirm the deletion. Pressing the "N" key will prevent the deletion of the file. Any other response will be ignored. Appendix C: MESSAGES 22 INTERACTIVE BACKUP UTILITY V2.00 701 : CURRENT COLOR ATTRIBUTES ARE abcd. You have pressed function key F2. The current color attributes are displayed where the characters "abcd" are. You will be able to enter new attributes following the period in the message. See "COLOR ADAPTER CONTROL WHILE DISPLAYING FILE NAMES" on page 15. 802 : OUTPUT DISKETTE IS FULL. The output disk/diskette has become full while copying the displayed file. Press any non-control key and the utility will return you to the restart screen. Any partially copied file will have the current date and time and a file size of 0 on the target disk/diskette. Be sure to delete any partially copied file on the target disk/diskette. This message can occur even when the space requirements for all the candidate files are less than the space available on the target: the clusters required by the file being copied when this message occurs are greater than the space currently available; files further down the candidate list are smaller than their predecessors on the target and will free space when copied. If the clusters available field on line 2 of the display is not highlighted as a message, this is what has happened. You should sort the candidate list into a different sequence to eliminate this condition or "eXclude" some candidates from the list and perform multiple copies using the restart capability of the utility. 803 : Ctrl-Break = IMMEDIATE QUIT, Esc = QUIT AFTER CURRENT FUNCTION. This message will display while files are being copied. The CTRL-BREAK will cause the copy function to be terminated and the backup file being created to be deleted from the target disk/diskette. The Esc key will cause the copy function to be terminated following completion of the current file copy. Use of either key will return you to the restart screen. 901 : SOURCE/TARGET INVALID FUNCTION NUMBER. An invalid DOS function has been requested. This is DOS error return code 01. This should only occur if there is a programming error. If you do get this message let me know about it, please. Press any non-control key and the utility Appendix C: MESSAGES 23 INTERACTIVE BACKUP UTILITY V2.00 will return you to the restart screen. 902 : SOURCE/TARGET FILE NOT FOUND. An attempt to process either a source or target file has failed because the file can not be found. This is DOS error return code 02. You have probably swapped diskettes in a drive since the directory of that drive was read by the program. Press any non-control key and the utility will return you to the restart screen. 903 : SOURCE/TARGET PATH NOT FOUND. A path specification has become invalid. This is DOS error return code 03. You have probably swapped diskettes in a drive since the path on that drive was validated by the program. Press any non-control key and the utility will return you to the restart screen. 904 : SOURCE/TARGET, TOO MANY OPEN FILES (NO HANDLES LEFT). An invalid handle condition has occurred. This is DOS error return code 04. The FILES= parameter in your CONFIG.SYS system file probably needs to be increased. Press any non-control key and the utility will return you to the restart screen. 905 : SOURCE/TARGET ACCESS DENIED. Access to a file has been denied by DOS. This is DOS error return code 05. Press any non-control key and the utility will return you to the restart screen. 906 : SOURCE/TARGET, INVALID HANDLE. A file handle has become invalid. This is DOS error return code 06. Press any non-control key and the utility will return you to the restart screen. 912 : SOURCE/TARGET, INVALID ACCESS CODE. This is DOS error return code 0C. Press any non-control key and the utility will return you to the restart screen. Appendix C: MESSAGES 24 INTERACTIVE BACKUP UTILITY V2.00 999 : SOURCE/TARGET, xxH, UNDEFINED ERROR CODE. A DOS error return code other than one of those defined above has occurred. The hexadecimal error code replaces the "xx" in the message. Press any non-control key and the utility will return you to the restart screen. Appendix C: MESSAGES 25 INTERACTIVE BACKUP UTILITY V2.00 APPENDIX D: USER SUPPORTED SOFTWARE CONCEPT AVAILABILITY Available from Mike Hodapp under the "user supported software" concept. See below. COPYING The Interactive Backup Utility can be copied onto your diskettes for use on your machine. DISCLAIMER In no event will the author be liable to you for any damages, including any lost profits, lost savings or other incidental or consequential damages arising out of the use of or inability to use this program, even if the author has been advised of the possibility of such damages, or for any claim by any other party. PERMISSION TO COPY Clubs and other non-profit organizations are granted permission by the author to freely copy this program and documentation and share it with their members, so long as: 1. No price is charged for the software or documentation. However, a distribution cost may be charged for the cost of the diskette. 2. Club members are informed of the user-supported concept and encouraged to support it with their donations. 3. The program or documentation is not modified in any way and are distributed together. Appendix D: USER SUPPORTED SOFTWARE CONCEPT 26 INTERACTIVE BACKUP UTILITY V2.00 THE USER-SUPPORTED CONCEPT User-Supported Software If you are using this program and find it to be of value your contribution will be appreciated. ($20 is suggested) Mike Hodapp 5609 Apache Road Louisville, KY 40207 Regardless of whether you make a contribution, you are encouraged to copy and share this program. User-supported software is an experiment in distributing computer programs, based on these beliefs: 1. That the value and utility of software is best assessed by the user on his/her own system. 2. That the creation of personal computer software can and should be supported by the computing community. 3. That copying of programs should be encouraged, rather than restricted. Anyone may request a copy of a user-supported program by sending a blank, formatted disk to the author of the program. An addressed, postage-paid return mailer must accompany the disk (no exceptions, please). A copy of the program, with documentation on the disk, will be sent by return mail. The program will carry a notice suggesting a contribution to the program's author. Making a contribution is completely voluntary on the part of each user. Free distribution of software and voluntary payment for its use eliminates costs for advertising and copy protection schemes. Users obtain quality software at reduced cost. They can try it out before buying, and do so at their own pace and in the comfort of their own home or office. The best programs will survive, based purely on their quality and usefulness. Please join the experiment. If you believe in these ideals, your contribution is solicited to help make them work. For those of you requiring an invoice in order to initiate payment through your company accounting system, the following Appendix D: USER SUPPORTED SOFTWARE CONCEPT 27 INTERACTIVE BACKUP UTILITY V2.00 invoice is provided. Those who wish an invoice for their tax records may also find it useful. Appendix D: USER SUPPORTED SOFTWARE CONCEPT 28 INTERACTIVE BACKUP UTILITY V2.00 -------------------- INVOICE -------------------- Purchased from: Mike Hodapp 5609 Apache Road Louisville, KY 40207 DATE: / / ---------------------------------------------------------------- PRICE PRICE PRODUCT QTY EACH EXTENDED ------------------------- --- ----- -------- INTERACTIVE BACKUP UTILITY program and documentation 1 $20 $20 SALES TAX 0 -------------------------------------- PLEASE PAY THIS AMOUNT $20 TOTAL ---------------------------------------------------------------- Please make check payable to : Mike Hodapp You may retain this Invoice for your tax records.