home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / enterprs / cpm / utils / f / rootsm.arc / CLEANUP.DOC < prev    next >
Encoding:
Text File  |  1979-12-31  |  4.0 KB  |  135 lines
  1.                  ROOTS Cleanup Utility
  2.    
  3.    
  4.    
  5.    Using CLEANUP
  6.    
  7.    
  8.    The  ROOTS  Cleanup Utility is designed to remove
  9.    superfluous  data  from  a  ROOTS89   or  ROOTS/M
  10.    basefile  and reorganize the  remaining  data  so
  11.    that  a  maximum  amount  of  memory   space   is
  12.    available for new data.  Make  certain  that  you
  13.    always have a backup copy of your basefile before
  14.    running CLEANUP.
  15.    
  16.    The  Cleanup utility does not run as part of  the
  17.    ROOTS  program,  but is called directly from  the
  18.    operating system.  If using  the  HDOS  operating
  19.    system, type:
  20.    
  21.                    CLEANUP SYn:BASEFILE.BIN
  22.    
  23.    to  start  the  Cleanup utility.  Use  the  drive
  24.    number,  n,  on  which the copy  of  BASEFILE.BIN
  25.    resides.  If you have renamed  your basefile, any
  26.    valid file name can be used as long as the format
  27.    of  the  data  file  is  correct   (having   been
  28.    generated with ROOTS89).
  29.    
  30.    Use  the  procedure  described above for the CP/M
  31.    version of CLEANUP.  A typical  command  to start
  32.    the utility might be:
  33.    
  34.                    B:CLEANUP C:JONES.BIN
  35.    
  36.    After the utility has completed its  assignment--
  37.    which  may  take  over ten minutes  for  a  large
  38.    basefile--a new BIN file  will  be  created.  The
  39.    old  file  will  also  be on the  disk  with  the
  40.    extension "BAK".
  41.    
  42.    As  CLEANUP  is  running,  a  report of  basefile
  43.    status  will  be  displayed  on  the   computer's
  44.    screen.
  45.    
  46.    
  47.    
  48.    What CLEANUP does to the basefile
  49.    
  50.    
  51.    The  routine goes through the four ROOTS basefile
  52.    sub-files in sequence.  The sequence is important
  53.    because records deleted in one sub-file may cause
  54.    records in a subsequent file  to  be  deleted.  A
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.    deleted  marriage  might delete  a  spouse  which
  68.    might delete a name only used by that spouse and,
  69.    finally, delete a placename or two. The following
  70.    paragraphs describe the screens  performed on the
  71.    four sub-files:
  72.    
  73.    MARRIAGES: Marriage records will be retained only
  74.    if they contain TWO spouses. Thus, users who have
  75.    created  a marriage record  to  document  that  a
  76.    marriage has
  77.    taken place on a given date or  at a given place,
  78.    but with an unknown partner, should create a "no-
  79.    name"  record  for  the  unknown   spouse  before
  80.    running the utility.
  81.    
  82.    SUBJECTS:  Subject  records  will be retained  if
  83.    they  have either or both parents,  if  they  are
  84.    referred  to by a marriage record  surviving  the
  85.    previous test, or if they are  referred  to  as a
  86.    parent.
  87.    
  88.    NAMES:  Name records are retained if referred  to
  89.    as one of the five name strings  for  any subject
  90.    record.
  91.    
  92.    PLACENAMES:  Place names are retained if referred
  93.    to by any subject birthplace or  deathplace or by
  94.    any marriage as a marriage-place.  Second  string
  95.    placenames  are  also  saved  when  tied  to  any
  96.    surviving  first string placename,  even  if  not
  97.    directly  referred to by a  subject  or  marriage
  98.    record.
  99.    
  100.    
  101.    The utility not only deletes records in the  four
  102.    subfiles  but  it  repacks all data  into  a  new
  103.    output  file with no gaps. This  recovers  memory
  104.    space  at the rate of 8 bytes  per  marriage,  20
  105.    bytes per subject, 8 or 16 bytes per name, and 16
  106.    bytes per placename string.  THE  CLEANUP UTILITY
  107.    WILL  RENUMBER SUBJECT RECORDS as they appear  in
  108.    the  ROOTS  editor  if  a superfluous  record  is
  109.    deleted.
  110.    
  111.    
  112.    
  113.    Preparing the Basefile
  114.    
  115.    
  116.    Before  using CLEANUP, it is wise to  check  your
  117.    data base for entries which  are  not consistent.
  118.    The easiest way to check for multiple entries  of
  119.    the  same  file  is by using the  COMMSOFT  ROOTS
  120.    Basefile Print Utility to generate a hard copy of
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.    all data in your basefile.  Hints on what to look
  134.    for are given in the DOC file for that utility.
  135.