home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / CLIPPER / DATABASE / DBRX14.ZIP / DBRX.DOC < prev    next >
Encoding:
Text File  |  1993-07-08  |  13.6 KB  |  574 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                     dbRX version 1.04  Users Manual
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                       Manual Last Updated July 8, 1993
  18.  
  19.  
  20.  
  21.  
  22.                    Copyright (C) 1993, by Gerald P. Doyon
  23.                             All Rights Reserved
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.     dbRX v1.04  User Documentation
  63.  
  64.  
  65.  
  66.     ▓▒░                      SOFTWARE REGISTRATION                     ░▒▓
  67.     ──────────────────────────────────────────────────────────────────────
  68.  
  69.     dbRX version 1.04 has been released to the public at no cost for
  70.     un-limited PERSONAL use.  All subsequent versions will not
  71.     necessarily be free.
  72.  
  73.     The following statement applies to companies who wish to bundle
  74.     this software with their own, or other proprietary software
  75.  
  76.     *****
  77.  
  78.     dbRX is copyrighted (C) 1993, by  Gerald  P.   Doyon  and  is
  79.     protected  by  United  States  Copyright  Law  and International
  80.     Treaty provisions.  All rights are reserved.  Non-registered  users
  81.     of dbRX are licensed ONLY to use the program on a EVALUATION basis
  82.     for the  sole  purpose  of  determining  whether  or  not  it meets
  83.     their requirements.  All other use requires registration.
  84.  
  85.     Any other use of non-registered copies of dbRX by any person,
  86.     BUSINESS,  CORPORATION, OR GOVERNMENT ORGANIZATION, or any OTHER
  87.     entity is strictly forbidden and is a violation of this license
  88.     agreement.
  89.  
  90.     Registration permits a user a license to use dbRX on a single
  91.     computer.
  92.  
  93.     dbRX may NOT be distributed in  conjunction  with  any  other
  94.     product, hardware or software without the express written
  95.     permission from Gerald P. Doyon.
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.     dbRX v1.04   User Documentation                           Page  02
  127.  
  128.  
  129.  
  130.     ▓▒░                            WARRANTY                            ░▒▓
  131.     ──────────────────────────────────────────────────────────────────────
  132.  
  133.     Gerald P.  Doyon makes no warranty of any kind, expressed  or  implied,
  134.     including  without limitation, any warranties of merchantability and/or
  135.     fitness for a particular purpose.  Gerald P. Doyon shall not be  liable
  136.     for  any  damages,  whether  direct, indirect, special or consequential
  137.     arising from a failure of this program to operate in the manner desired
  138.     by the user.  Gerald P. Doyon will not be liable for any damage to data
  139.     or property which may be caused directly or indirectly by  use  of  the
  140.     program.
  141.  
  142.     IN NO EVENT WILL GERALD P. DOYON BE LIABLE FOR ANY  DAMAGES,  INCLUDING
  143.     ANY  LOST  PROFITS,  LOST  SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL
  144.     DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE THE PROGRAM, OR FOR
  145.     ANY CLAIM BY ANY OTHER PARTY.
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.     dbRX v1.04  User Documentation                            Page  03
  190.  
  191.  
  192.  
  193.     ▓▒░                        TABLE OF CONTENTS                       ░▒▓
  194.     ──────────────────────────────────────────────────────────────────────
  195.  
  196.     Registration . . . . . . . . . . . . . . . . . . . . . . . . . . 02
  197.  
  198.     Warranty . . . . . . . . . . . . . . . . . . . . . . . . . . . . 03
  199.  
  200.     This Page !. . . . . . . . . . . . . . . . . . . . . . . . . . . 04
  201.  
  202.     Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . 05
  203.  
  204.     How dbRX Works . . . . . . . . . . . . . . . . . . . . . . . . . 06
  205.  
  206.     dbRX At Work . . . . . . . . . . . . . . . . . . . . . . . . . . 07
  207.  
  208.     Test Driving dbRX. . . . . . . . . . . . . . . . . . . . . . . . 08
  209.  
  210.     What's Next ?. & Suggestions Welcome . . . . . . . . . . . . . . 08
  211.  
  212.     Revision History & How To Contact The Author . . . . . . . . . . 09
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.     dbRX v1.04  User Documentation                            Page  04
  255.  
  256.  
  257.  
  258.     ▓▒░                        INTRODUCTION                            ░▒▓
  259.     ──────────────────────────────────────────────────────────────────────
  260.  
  261.     dbRX was developed from a need to repair corrupted database files
  262.     quickly, without having to go through numerous steps in order to
  263.     get your application back up and runnning.
  264.  
  265.     dbRX is FAST !  On my computer I can repair almost 30 databases in
  266.     approximately ONE SECOND.  No user intervention is needed after
  267.     dbRX has started.  There are no menus to flip through. dbRX makes
  268.     one pass through each database.
  269.  
  270.     Unlike several other database repair utilites, dbRX does not
  271.     reconstruct/re-write the records contained in the database.  The
  272.     vast majority of databases are corrupted only in it's header.
  273.  
  274.     The header contains info pertaining to such things as the type of
  275.     the database, how many records are in it, where the data begins,
  276.     etc.  More information concerning the header will be explained
  277.     futher in this manua.  By repairing the header only you can be up
  278.     and running in seconds, literally !
  279.  
  280.  
  281.     Database Types Supported
  282.     ------------------------
  283.  
  284.     dbRX, at this time, can only repair the following database types:
  285.  
  286.         dBASE III Plus & dBASE IV
  287.         FoxBASE+
  288.         FoxPro
  289.  
  290.     Although database files created by Clipper are for the most part
  291.     compatible I cannot guarrantee dbRX will work flawlessly with them.
  292.     I am working on getting sample clipper files and associated
  293.     structure breakouts to better repair them.
  294.  
  295.  
  296.     What dbRX CAN do:
  297.     -----------------
  298.  
  299.      - Repair an invalid total record count in DBF header
  300.      - Replace missing End-Of-File character
  301.  
  302.  
  303.     What dbRX CAN'T do (Yet!)
  304.     -------------------------
  305.  
  306.      - Does not repair record data corruptionm
  307.  
  308.      - Does not go through every item in the header of the DBF
  309.        to check for invalid data or inconsistencies
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.     dbRX v1.04  User Documentation                            Page  05
  318.  
  319.  
  320.  
  321.     ▓▒░                        HOW dbRX WORKS                          ░▒▓
  322.     ──────────────────────────────────────────────────────────────────────
  323.  
  324.     To run dbRX simply type the following at the DOS prompt:
  325.  
  326.         DBRX <filename>
  327.  
  328.     where 'filename' is the name of the database file you wish to
  329.     repair.  The filename can include a path AND wildcards. For
  330.     instance these are all valid examples:
  331.  
  332.  
  333.     EXAMPLE #1:  DBRX INVENTRY.DBF
  334.  
  335.     EXAMPLE #2:  DBRX C:\FOXPRO\DBFS\INVENTRY.DBF
  336.  
  337.     EXAMPLE #3:  DBRX C:\FOXPRO\DBFS\INV*.DBF
  338.  
  339.     EXAMPLE #4:  DBRX D:\FOXPRO\DBFS\INV?????.DBF
  340.  
  341.     EXAMPLE #5:  DBRX D:\FOXPRO\DBFS\*.DBF
  342.  
  343.     EXAMPLE #6:  DBRX *.DBF
  344.  
  345.  
  346.     I think you get the idea now !  dbRX does NOT assume a file
  347.     extension of '.DBF' if you do not enter one.  Consequently the
  348.     database file may have ANY extension you wish !
  349.  
  350.     Through my own experiences I have found that nearly all of the
  351.     database files that have become 'corrupted' are damaged only in the
  352.     database files header, NOT in the actual data records.
  353.  
  354.     A database file can be broken up into three sections:
  355.  
  356.         1.  Data File Header Record
  357.         2.  Field Subrecords
  358.         3.  Data records
  359.  
  360.     When a database becomes corrupted, in MANY instances, the total
  361.     record count in bytes 04-07 of the header does not match the actual
  362.     number of records in the database.
  363.  
  364.     This can occurr if a new record is added to the database but
  365.     the header has not been updated to reflect the new record count,
  366.     possibly due to a power failure, disk error, etc..
  367.  
  368.     In this instance it is very easy to correct the problem.  You need
  369.     only determine the actual number of records in the database and
  370.     overwrite the incorrect one.
  371.  
  372.     After a database record has been added an end-of-file (EOF)
  373.     character is appended, CONTROL-Z, or 01A hex.  dbRX will make sure
  374.     this character is present.  If it is not one will be appended.
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.     dbRX v1.04  User Documentation                            Page  06
  382.  
  383.  
  384.  
  385.     ▓▒░                        dbRX AT WORK                            ░▒▓
  386.     ──────────────────────────────────────────────────────────────────────
  387.  
  388.     Assumptions Made:
  389.     -----------------
  390.  
  391.     As of this release dbRX assumes that atleast the very first byte of
  392.     the databases header has not been corrupted. The DBF files first
  393.     byte, which contains the DBF type, i.e.  Foxpro, dBASE, etc, must
  394.     NOT be corrupted.  Also, the record size also cannot be corrupted.
  395.  
  396.     If after dbRX reads in the first 32-bytes and a VALID DBF type was
  397.     not found the program will end.
  398.  
  399.     I used a HEX editor and corrupted a bunch of DBF's that came with
  400.     FoxPro.  I then invoked dbRX using the following syntax:
  401.  
  402.         DBRX *.DBF
  403.  
  404.     This was the result:
  405.  
  406.         ╓────────────────────────────────────────────╖
  407.         ║             ■■ dbRX  v1.04 ■■              ║
  408.         ║                                            ║
  409.         ║    Copyright (c) 1993 by Gerald P. Doyon   ║
  410.         ╙────────────────────────────────────────────╜
  411.  
  412.         CARDUSER.DBF - Repairs made:
  413.                End Of File Marker Appended
  414.         CLIENTS.DBF - Ok
  415.         CREDCARD.DBF - Ok
  416.         DETAILS.DBF - Repairs made:
  417.                Total Record Count Adjusted
  418.         FACTORS.DBF - Ok
  419.         LABELS.DBF - Ok
  420.         LETTERS.DBF - Ok
  421.         ORGHELP.DBF - Ok
  422.         ORGUSER.DBF - Ok
  423.         PERSONAL.DBF - Repairs made:
  424.                Total Record Count Adjusted
  425.                End Of File Marker Appended
  426.         REPORTS.DBF - Ok
  427.         RESTAURS.DBF - Ok
  428.         STATES.DBF - Repairs made:
  429.                Total Record Count Adjusted
  430.         UNITS.DBF - Ok
  431.  
  432.         C:\TASM\DBRX\TEST>
  433.  
  434.     As you can see, a simple report is generated for each item that is
  435.     repaired.  If no repairs were necessary then an 'Ok' is reported.
  436.  
  437.     If a file/disk error occurs while dbRX is in the process of reading
  438.     or writing to disk dbRX will halt and report the type of error that
  439.     occurred.
  440.  
  441.     As of this version dbRX does NOT return an error code that can be
  442.     used in batch files.  The NEXT version due out VERY soon will do
  443.     that.
  444.  
  445.     dbRX v1.04  User Documentation                            Page  07
  446.  
  447.  
  448.  
  449.     ▓▒░                    TEST DRIVING dbRX                           ░▒▓
  450.     ──────────────────────────────────────────────────────────────────────
  451.  
  452.     I have included a corrupted database file, BAD_DBF.DBF, which has
  453.     an invalid record count and missing end-of-file marker.  First,
  454.     attempt to access this database with either dBASE, FoxBase, or
  455.     Foxpro.  Of course, you will be unable to do so.  Now use dbRX to
  456.     repair it:
  457.  
  458.     dbRX BAD_DBF.DBF
  459.  
  460.     Voila, it has been repaired !  Now you can access the data.
  461.  
  462.  
  463.  
  464.     ▓▒░                        WHAT'S NEXT ??                          ░▒▓
  465.     ──────────────────────────────────────────────────────────────────────
  466.  
  467.     -  In the next version, due out soon, dbRX will return error codes
  468.        so that you can use it in a batch file type operation.
  469.  
  470.     -  The ability to BACK-UP and RESTORE a DBF header in the event of
  471.        a masssivly corrupted header that can't be repaired.  This will
  472.        then allow you full access to your otherwise un-recoverable data.
  473.  
  474.     -  Several cosmetic enhancements.
  475.  
  476.  
  477.     Suggestions ???!!!
  478.     ------------------
  479.  
  480.     Since the first public release of dbRX is free I would really
  481.     appreciate some input, good OR bad, in lieu of money. I welcome ANY
  482.     suggestions on how I might improve dbRX !  If your suggestion is
  483.     implemented I will give you credit for it in this documentation.
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.     dbRX v1.04  User Documentation                            Page  08
  509.  
  510.  
  511.  
  512.     ▓▒░                      REVISION HISTORY                          ░▒▓
  513.     ──────────────────────────────────────────────────────────────────────
  514.  
  515.         05/13/93  v1.0     - Not released to public.  Allowed user to
  516.                              only repair one DBF at a time.
  517.  
  518.         05/16/93  v1.01    - Optimized several routines for best speed.
  519.  
  520.         05/22/93  v1.02    - Cleaned up more code.  Made dbRX easier to
  521.                              add numerouse features.  Added ability to
  522.                              use paths.
  523.  
  524.         06/01/93  v1.03    - Added ability to use wildcards.
  525.  
  526.         07/08/93  v1.04    - After a small siesta the documentation was
  527.                              written and some text output cleaned up.
  528.                              First release is FREE to the public !
  529.  
  530.  
  531.  
  532.     How To Contact the Author
  533.     -------------------------
  534.  
  535.     You can leave message for me, GERRY DOYON, on the Northern Lights 
  536.     BBS, located in Maine, at the following numbers:
  537.  
  538.     Node #1: (207) 761-4782 2400 baud (Public line)
  539.          #2: (207) 761-4565 HST D/S v.32/v.42bis
  540.          #3: (207) 761-4540   9600 bps USR Courier HST (opens at 19,200)
  541.          #4: (207) 761-4431   9600 bps USR Courier HST (opens at 19,200)
  542.  
  543.     Nodes 2-4 are for subscribers only.  As a new caller you are
  544.     allowed 15 minutes per day with all priveleges accept downloading.
  545.  
  546.     The most current version of dbRX will always be uploaded to the
  547.     Northern Lights BBS first.
  548.  
  549.     You can try to contact me via the U.S.  mail at:
  550.  
  551.         Gerald P. Doyon
  552.         P.O. Box 133
  553.         Westbrook, ME  04098-0133
  554.  
  555.     Or at home, (207) 854-2906 between 6:00pm to 11:00pm EST.
  556.     Unfortunately, I do not have a Compuserve or GEnie account.
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.     dbRX v1.04  User Documentation                            Page  09
  572.  
  573.  
  574.