home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / lambda / soundpot / a / check28.lbr / CHECK28.DZC / CHECK28.DOC
Encoding:
Text File  |  1993-10-26  |  15.8 KB  |  393 lines
  1.                        Documentation for CHECK version 2.8
  2.                                 February 24, 1987
  3.                                By Carson R. Wilson
  4.  
  5.         [ This program may be freely copied and distributed for non-
  6.         profit purposes as long as it is accompanied by this 
  7.         documentation and its terminal installer. The author takes no 
  8.         responsibility for the use or inability to use this program. ]
  9.  
  10.                                       FILES
  11.                                       =====
  12.  
  13.         CHECK28.LBR should include the following files:
  14.  
  15.         * CHECK28.CZM  - version 2.8 of the program itself
  16.         * CHECK28.DZC  - this file
  17.           PDTINS.CZN   - Turbo terminal installer
  18.           PDTINS.DZA   - data for installer
  19.         * WHATSFOR.CHK - short description of the library
  20.  
  21.         Only files marked with '*' have been altered since version 2.7. 
  22.         The files with Z's in them need to be decompressed with UNCR.COM 
  23.         version 2.0 or later.
  24.  
  25.                                      UPDATE
  26.                                      ======
  27.         Changes from version 2.7:
  28.                  
  29.         - Now automatically warm boots on exit in low TPA (BDOS begins 
  30.           below B300 hex) systems.
  31.         - Copying files of over 7k is significantly faster.
  32.         - Testing files of over 6k is slightly slower.
  33.         - Whole tagged file names are highlighted, instead of just their 
  34.           flags.
  35.         - 1.75k more Transient Program Area (TPA) is now required, moving 
  36.           the ending address up to AB00 hex from A400 hex.
  37.         - The maximum amount of directory entries has been raised to 310 
  38.           from 192 per directory. (Note--this is greater than or equal to 
  39.           the actual number of files, because large files can take up more 
  40.           than one directory entry).
  41.         - CHECK now aborts with an error message if over the maximum 
  42.           number of directory entries are present on either the Source or 
  43.           the Target directory. 
  44.         - The delete command now removes file names from the display.
  45.         - Shows proper disk space remaining for hard disks.
  46.         - New "K" command added (see "Commands," below).
  47.         - Several other cosmetic changes have been made.
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.          CHECK version 2.8 - Copyright 1987 by Carson Wilson   page 1
  57.                                     IN BRIEF
  58.                                     == =====
  59.         1. What's it for?
  60.  
  61.         CHECK compares the contents of two disk directories, providing an 
  62.         alphabetized display of the filenames occurring on one. These 
  63.         filenames are marked with "flag" characters reflecting which of 
  64.         the files are present on the other directory. Thereafter, you 
  65.         step through the list, performing a variety of functions (below).
  66.  
  67.         2. System Requirements
  68.  
  69.         You will need a CP/M or ZCPR computer with an 80-column display 
  70.         screen. CHECK assumes that memory addresses from 100h to AB00h 
  71.         will be available. All 64k CP/M systems have more than enough 
  72.         memory. 
  73.  
  74.         3. Installation
  75.  
  76.         Try the program on your machine. You may not need to install 
  77.         CHECK at all. Otherwise, use the terminal installer chain file 
  78.         PDTINS.CHN and its data file PDTINS.DTA (included in CHECK28.LBR) 
  79.         to install CHECK for your terminal. Simply make sure all three 
  80.         files are on the current disk directory and type "CHECK INSTALL" 
  81.         at your command line. PDTINS takes over from here, allowing you 
  82.         to install any Turbo Pascal .COM file for your terminal. 
  83.  
  84.         4. Functions
  85.  
  86.         This program has five major functions:
  87.  
  88.              1) compare the contents of disk directories
  89.              2) compare the contents of individual files 
  90.              3) copy files 
  91.              4) delete files 
  92.              5) display files. 
  93.  
  94.         By combining all of these functions into an integrated package, 
  95.         CHECK simplifies the task of maintaining backup copies of 
  96.         important files on another directory.
  97.  
  98.                                    USING CHECK
  99.                                    ===== =====
  100.         1. Terminology
  101.  
  102.         CHECK uses its own terminology to describe the pair of disk 
  103.         directories (drive/user combinations) it is comparing. The 
  104.         "Source" is the directory CHECK normally displays. The "Target" 
  105.         directory is the one being compared with the Source directory. 
  106.  
  107.         The "Route" describes the direction CHECK assumes any copies you 
  108.         make will travel in. That is, the program assumes that you want 
  109.         to use one directory as your work directory, and another as your 
  110.         backup, copying files from the Source to the Target directory 
  111.  
  112.          CHECK version 2.8 - Copyright 1987 by Carson Wilson   page 2
  113.         periodically as a safety measure. A valid Route describes two 
  114.         different disk directories with drive letters from A to P and 
  115.         user numbers from 0 to 15.
  116.  
  117.         2. Starting CHECK
  118.  
  119.         There are two ways of calling up CHECK from your command line. If 
  120.         you simply enter the word CHECK, the program will load and then 
  121.         prompt you for Source and Target directories.
  122.  
  123.         Alternatively, exactly two command line parameters may be entered 
  124.         when calling up CHECK. The first stands for the Source and the 
  125.         second stands for the Target directory. For example, the command 
  126.         line entry "CHECK A2 B15" (no colons allowed) causes CHECK to 
  127.         load and run using the Route A2 ==> B15, regardless of the 
  128.         currently logged drive/user.
  129.  
  130.         3. Operation
  131.  
  132.         Once CHECK has loaded and received a valid Route, it resets the 
  133.         disk system, and compares the directories. It then clears the 
  134.         screen and displays the status line and the name of the first 
  135.         entry in the Source directory. The status line displays the 
  136.         current Route, space left on one or both drives, and the HELP 
  137.         command. Thereafter, CHECK operates much like NewSweep, stepping 
  138.         through an alphabetized list of filenames.  
  139.  
  140.              3a. Flag Characters
  141.              
  142.         Flag characters flag filenames from the Source disk directory, 
  143.         indicating what the status of these files on the Target directory 
  144.         is. Flagged filenames are highlighted, if possible. Flagged 
  145.         filenames appear as:
  146.  
  147.               FILENAME.TYP   Unflagged - no matching filename was found 
  148.                              on the Target directory.
  149.                            
  150.              ?FILENAME.TYP?  Question marks - a matching filename was 
  151.                              found on the Target directory.
  152.  
  153.              <FILENAME.TYP>  Unequal marks - a matching filename was 
  154.                              found on the Target directory, and the two 
  155.                              files are unequal. 
  156.  
  157.              =FILENAME.TYP=  Equal marks - an equal file was found on the 
  158.                              Target directory.
  159.  
  160.         Equal ("=") flags are only produced after the user explicitly 
  161.         commands CHECK to compare two files, and they are found to be 
  162.         equal. Unequal signs may be generated as a consequence of 
  163.         differences in two files' sizes, or as the result of an explicit 
  164.         command by the user to compare files. Question marks indicate 
  165.         that no test has yet been performed on the files, but that they 
  166.         do contain the same number of records. 
  167.  
  168.          CHECK version 2.8 - Copyright 1987 by Carson Wilson   page 3
  169.              3b. Commands
  170.  
  171.         Command keys are simply keyboard characters to which CHECK 
  172.         assigns special meanings. Commands acting on individual files are 
  173.         always applied to the filename to the left of the cursor.
  174.  
  175.                COMMAND:      RESULT:
  176.                =======       ======
  177.  
  178.            H, h, ?, /        Display the help screen.
  179.  
  180.               -, B, b        Step back one filename in list.
  181.  
  182.                  C, c        Copy file from the Source directory to the 
  183.                              Target directory.
  184.  
  185.                  D, d        Delete file from Source directory.
  186.  
  187.                  K, k        Go to the next unflagged file in the list 
  188.                              and delete it. This command enables the user 
  189.                              to easily remove all unmatched files from a 
  190.                              backup directory.
  191.  
  192.                  N, n        Go to next filename flagged with ?? or <>. 
  193.                              Using the 'N' command to step through 
  194.                              CHECK's list of files, the user can test all 
  195.                              sets of matching filenames to determine 
  196.                              which files are equal. 
  197.  
  198.                  O, o        Display other (Target) directory.
  199.  
  200.                  R, r        Reverse Source and Target directories. 
  201.                              Target directory becomes Source and Source 
  202.                              becomes Target.
  203.  
  204.                  T, t        Test a match by comparing a file on the 
  205.                              Target directory with the file on the Source 
  206.                              directory. If the files don't match, tell 
  207.                              where the first difference is and display it 
  208.                              on the screen.
  209.  
  210.                  V, v        View a file. Use ^S or space bar to pause 
  211.                              scrolling, other keys to resume scrolling, 
  212.                              and ^X or ^C to abort viewing.
  213.  
  214.                  W, w        Display wide directory. 
  215.  
  216.            Q, q, X, x        Exit from the current Route and prompt user 
  217.                              to enter another Route or exit the program.
  218.  
  219.          All other keys      Step forwards one filename in list.
  220.  
  221.         All commands that cause disk space to change result in immediate 
  222.         re-calculation and display of the space remaining on one or both 
  223.  
  224.          CHECK version 2.8 - Copyright 1987 by Carson Wilson   page 4
  225.         disk drives. The Help, Reverse, and Wide directory commands also 
  226.         cause CHECK to redisplay the status line.  
  227.  
  228.                                 ERROR PREVENTION
  229.                                 ===== ==========
  230.  
  231.         CHECK has various internal procedures designed to prevent 
  232.         unintended or unnecessary actions:
  233.            
  234.           1) If the user tells CHECK to copy files which have already 
  235.              been copied or proven equal, CHECK cancels the operation.
  236.  
  237.           2) Whenever an erase or copy command would cause a file without 
  238.              a backup to be erased, CHECK prompts the user before 
  239.              proceeding. Therefore files which have no match on the 
  240.              Target directory are copied immediately, but CHECK prompts 
  241.              the user whenever a copy operation will overwrite another 
  242.              file. CHECK also ensures that there is sufficient room on 
  243.              the Target directory for the new copy before proceeding.
  244.  
  245.           3) If a Source directory containing no files is specified, 
  246.              CHECK immediately re-prompts the user for another Route.
  247.  
  248.           4) The delete command works immediately if there is an equal 
  249.              backup of the Source file, but warns the user otherwise.
  250.  
  251.  
  252.                                  SPECIFICATIONS
  253.                                  ==============
  254.  
  255.         CHECK will accommodate disk directories with up to 310 filename 
  256.         entries at one drive/user combination. If you have more entries 
  257.         than this on one directory, CHECK aborts with an error message. 
  258.         The buffer size used for comparing files is 48 records, making 
  259.         CHECK significantly faster than some other file comparing 
  260.         utilities.
  261.  
  262.  
  263.                                  SPECIAL PATCHES
  264.                                  ======= =======
  265.  
  266.         Several locations of CHECK's code may be patched to provide more 
  267.         secure or compatible operation. Normally, patching should be 
  268.         unnecessary. 
  269.  
  270.         1. Legal Drives and User Areas
  271.  
  272.         As distributed, CHECK allows routes with drives from A: through 
  273.         P: and user areas from 1 thorough 15. Other drive/user 
  274.         combinations generate an error message when the Route is first 
  275.         specified. These values may be changed to match your system in 
  276.         high-security or novice-user situations. 
  277.  
  278.         The bytes at addresses 20FF hex through 2102 hex contain CHECK's 
  279.  
  280.          CHECK version 2.8 - Copyright 1987 by Carson Wilson   page 5
  281.         legal drive/user values. The first two bytes are the legal low 
  282.         drive followed by the legal high drive, and the second pair are 
  283.         the legal low user followed by the legal high user. To patch 
  284.         CHECK to allow only drives A: through E: and users 0 through 5, 
  285.         for example, use DDT as follows (excluding comments):
  286.  
  287.         A>ddt check.com
  288.         DDT VERS 2.2
  289.         NEXT  PC
  290.         4900 0100
  291.         -s20ff
  292.         20FF 41              ; this is low drive letter "A"
  293.         2100 50 45           ; change max. drive letter from "P" to "E"
  294.         2101 00              ; this is low user area zero
  295.         2102 0F 5            ; change max. user from 15 hex to 5 hex
  296.         2103 01 .
  297.         -g0
  298.  
  299.         A>save 72 check.com
  300.  
  301.  
  302.         2) Copying Attributes and File Archiving
  303.  
  304.         As distributed, CHECK will copy file tags and attributes when 
  305.         making copies of files. This means that if you copy a read-only 
  306.         or system file, the copy on the other directory will also be 
  307.         read-only, etc. To turn this feature off, change the byte at 
  308.         address 2103 hex (right after the max. user byte above) from one 
  309.         to zero, and save the memory image as above. Thereafter, all 
  310.         copies made by CHECK will be "read-only, directory" files.
  311.  
  312.         When it copies a file, CHECK sets the "archive" attribute of the 
  313.         source file. This function may be de-activated by changing the 
  314.         byte at 2104 hex (one after the "copy attributes" byte) from one 
  315.         to zero, and save the memory image as above. This will de-
  316.         activate the function, and CHECK will now say "file copied" 
  317.         instead of "file copied and archived" after copying files.
  318.  
  319.  
  320.                                  ACKNOWLEDGEMENT
  321.                                  ===============
  322.  
  323.         Thanks go to Rick Charnes of San Francisco for finding a new way 
  324.         to use CHECK.COM to assist in backing up hard disks (see his HD-
  325.         ARCxx.LBR for more on this). Rick also made several 
  326.         recommendations which have been incorporated into version 2.8 of 
  327.         CHECK, and tested version 2.8 on a hard disk.
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.          CHECK version 2.8 - Copyright 1987 by Carson Wilson   page 6
  337.                                    DEDICATION
  338.                                    ==========
  339.  
  340.         I enjoyed designing this program, and hope you find it useful. 
  341.         While Turbo Pascal does not provide the tight, efficient code 
  342.         permitted by assembly language, it is a fertile medium for trying 
  343.         new ideas. While this program is a useful utility of itself, I 
  344.         hope that the ideas it expresses will be adopted by others.
  345.         If you have any questions, comments, or suggestions about 
  346.         CHECK.COM, please leave me a message at Richard Jacobson's 
  347.         Lillipute Z-Node, Chicago, (312) 664-1730 or (312) 649-1730. 
  348.  
  349.         <end of file>
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.          CHECK version 2.8 - Copyright 1987 by Carson Wilson   page 7
  393.