home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / unix / volume18 / geneal / part01 / README < prev    next >
Text File  |  1989-03-08  |  3KB  |  57 lines
  1. The GENEAL Program                 1.Mar.88
  2. Written by Jim McBeath (jimmc) at SCI
  3.  
  4. This is version 3.5 of GENEAL.
  5.  
  6. GENEAL is a genealogy program which can browse data, make individual
  7. and family pages, make birthday and anniversary lists, and (with
  8. the help of the TREEPAR program) make various flavors of family tree plots.
  9.  
  10. This file describes what other files exist and what you will have to
  11. do in order to make geneal useful to you.
  12.  
  13. NOTE: Geneal uses the SPIN package (Simple Programmable INterface).  If you
  14. don't have it, you won't be able to build geneal.
  15.  
  16. Files of interest:
  17.     *.[ch]    The source files for geneal.
  18.     Makefile    Exactly that.
  19.     README    What you are looking at right now.
  20.     History    A Brief history of geneal.
  21.     geneal.n    Source for man page.  Describes (briefly) what
  22.         geneal is all about.  Gives list of switches.
  23.         Use "make man" to create geneal man file (geneal.man).
  24.     PGMR.DOC    Programmer's documentation.  Gives more detail about some
  25.         of the source files.  Read this if you are going to make
  26.         any changes to the program or if you need to look for bugs.
  27.     sample.dat  The data file.  This is a sample file for you to use
  28.         as a template for creating your own data file.
  29.  
  30. What to do (after unpacking):
  31. 1. Use "make man" to create geneal.man from geneal.n.  Read it.
  32. 2. Edit the Makefile and set SPINDIR to point to the directory containing
  33.    the spin files (xalloc.h, spin.h, spin.a, llib-lspin.a.ln).
  34.    By default this is ../spin.
  35. 3. If you are running on something other than sun or bsd, you may have
  36.    trouble with vsprintf.  You should put -DUSG in the CFLAGS in the
  37.    Makefile in this case.
  38. 4. Make the program.  You should be able to simply issue a "make" command.
  39.    If you wish, you can test it out at this point on the sample data file
  40.    and make sure that it works.  (You will have to do a
  41.    "setenv GENEALDAT sample.dat" to do this.)
  42. 5. Make your own data file.  Delete all of the supplied data file except
  43.    record 0 (the description of the data format).  Add your own data in
  44.    the same format.
  45. 6. Run geneal and execute the GConsist command to check for data consistency
  46.    errors.  After correcting all errors uncovered here, you should
  47.    be able to run the other portions of the program without errors.
  48. 7. If you want to make changes, read PGMR.DOC first.
  49. 8. Send me your comments, wishes, and improvements.
  50.  
  51. Geneal was originally written to run on a VAX under BSD4.2.  It has
  52. since been moved to run on a SUN3 under Sun OS3.4.  If you have
  53. problems running on other systems, please let me know.
  54.  
  55.         -Jim McBeath  {decwrl|oliveb|weitek|auspyr}!sci!jimmc
  56.           1.Mar.1988
  57.