home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / enterprs / cpm / utils / f / gbase.lbr / G-BASE.DZC / G-BASE.DOC
Text File  |  1992-12-03  |  19KB  |  595 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                                      G-BASE
  11.  
  12.                                   Users Manual
  13.  
  14.                                   Version 1.0
  15.  
  16.  
  17.  
  18.                                     Contents
  19.  
  20.  
  21.                       Introduction                           2
  22.                       Files                                  3
  23.                       Enter                                  4
  24.                       Print                                  5
  25.                       Sort                                   6
  26.                       Distribution Policy                    8
  27.                     Appendix                              10
  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.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.                                      G-BASE
  75.  
  76.                                   Users Manual
  77.  
  78.                                   Version 1.0
  79.  
  80.  
  81.           Introduction
  82.  
  83.                G-BASE is an easy to use data base manager available on
  84.           CP/M and MS DOS machines.  This program is distributed free
  85.           to the public and its distribution is encouraged.  Source
  86.           code may be licensed from Jansma Consultants.  See
  87.           Distribution Policy, below.
  88.  
  89.                Every attempt has been made to make this program bug
  90.           free and to function properly.  Jansma Consultants takes no
  91.           responsibility for any problems encountered when using this
  92.           program.  If problems are found and reported they will be
  93.           fixed as quickly as possible.  Notices of upgrades including
  94.           bug fixes will be made to licensees as indicated in the
  95.           section on Distribution Policy.
  96.  
  97.                G-BASE uses menus which are displayed on the top line.
  98.           A menu item is selecte by pressing the first letter of the
  99.           option.  The ESCAPE key is equivalent to the last option
  100.           which is usually Quit.  The menus have the following
  101.           appearance:
  102.  
  103.           G-BASE Menu:  <E>nter  <P>rint  <F>iles  <S>ort  <H>elp
  104.  
  105.           Overview
  106.  
  107.                GBase is capable of handling up to 9000 records.  This
  108.           limitation is due to the size allocated for the sort index.
  109.           If you wish to use a larger file, the souce code can be
  110.           altered, depending on the size of the system you are using
  111.           it on.  The 9000 record limit is about maximum for the Epson
  112.           QX10/16 computers and a file with 9000 records may take a
  113.           while to sort.
  114.  
  115.                The printing capabilities are limited at this time to
  116.           columnar lists with the option to total numeric fields at
  117.           the end of the listing.  You are encouraged to make fancy
  118.           report writers.  See the appendix for the format of the data
  119.           files.
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.           (Field Types: C=Char   N=Numeric    M=Money
  140.           Note: Can't enter type M directly.  Use N & redesign to M)
  141.           Files
  142.  
  143.  
  144.                The Files option brings up the following sub-menu:
  145.  
  146.           Files Menu:  <O>pen  <C>reate  <D>ir  <I>mport  <R>edesign
  147.  
  148.           <C>reate: The create option is used to define a data base
  149.                     dictionary.  When selected you will be asked for a
  150.                     file name which should include 8 characters with
  151.                     no extension.  The .GDF extension will be added
  152.                     automatically.
  153.  
  154.           <O>pen:   The open option allows you to switch from the
  155.                     currently open data file to another.  An open
  156.                     procedure is done on most other procedures if
  157.                     there is not an open data file.  Use this option
  158.                     to switch to another file.
  159.  
  160.           <D>ir:    This displays a list of data files.
  161.                     Note:  the directory is a list of filenames
  162.                     stored in the file GBASE.DIR.  If you delete or
  163.                     rename files, this directory will be out of date.
  164.                     You may want to edit the directory to keep it up
  165.                     to date.
  166.  
  167.  
  168.           <I>mport: The Import option allows you to read in a data
  169.                     file stored in ASCII format.  The file must have
  170.                     the following information, separated by commas:
  171.  
  172.                              First line:       Number of fields,
  173.                                                Number of records.
  174.  
  175.                              Lines 2-Nfields   Field name
  176.                                                Field type (C,N,M)
  177.                                                Width of field
  178.                                                Number of decimals
  179.  
  180.                              Lines Nfields+1   Data for each record
  181.                                 to end         separated by commas
  182.  
  183.  
  184.           <R>edesign: The Redesign option allows you to make minor
  185.                     changes to the data base definitions.  You can
  186.                     change the field name, the field type, but you
  187.                     cannot change the field width.
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.           Enter
  207.  
  208.  
  209.              The Enter option displays the entry screen showing the
  210.           fields of the current data base.  You will be prompted for
  211.           infomation in each field in the order they were defined.
  212.           You may use the normal edit keys including the backspace,
  213.           but not the arrow keys.  If you make a mistake after
  214.           pressing return on a field, you will need to select the EDIT
  215.           option to correct the entered information. (see edit below).
  216.  
  217.                To stop entering data or to make changes in the data
  218.           entered, press the back-slash key (\) and then press RETURN.
  219.           Note, the current release uses the back-slash to exit data
  220.           entry and thus cannot be used in the data base as a valid
  221.           character (since it cannot be entered in the entry screen).
  222.           Later releases will allow you to define the "hot key" or you
  223.           can purchase the source code and change it yourself.  Once
  224.           you enter the "hot key" you will see the following sub-menu:
  225.  
  226.           Edit Menu:  <E>dit  <D>elete  <F>ind  <Q>uit
  227.  
  228.  
  229.           <Q>uit:   This exits the data entry screen option and
  230.                     returns to the main menu.
  231.  
  232.  
  233.           <E>dit:   This option is used to change the information in
  234.                     the data record.  You will be asked for the record
  235.                     number.  The information in the record will be
  236.                     displayed on the screen and you will prompted for
  237.                     new information for each field.  To leave a field
  238.                     unchanged, press RETURN on the field without
  239.                     pressing any other keys.
  240.  
  241.           <D>elete: This option will delete or undelete a record.  You
  242.                     will be prompted for the record number to delete
  243.                     or undelete.  Deleted records are not removed from
  244.                     the data base but are marked "deleted" by
  245.                     inserting a dollar sign as the first character in
  246.                     the first field.  You can delete or undelete a
  247.                     record by editing the the record and adding or
  248.                     removing the dollar sign.  Note, this release uses
  249.                     the dollar sign to mark deleted records, thus you
  250.                     cannot use the dollar sign as the first character
  251.                     in the first field.  Future releases will allow
  252.                     you to change the delete flag or you may purchase
  253.                     the source code and change it yourself.
  254.  
  255.           <F>ind:   The find option is actually a SORT option.  It is
  256.                     included in the EDIT sub-menu for convenience.
  257.                     See <S>ort, <F>ind below for information on this
  258.                     option.
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.           Print
  273.  
  274.  
  275.                The print option is used to list the data records to
  276.           the screen, the printer, or to a file.  Records are listed
  277.           in the current sort order as defined under the SORT option.
  278.  
  279.           <F>orm:  The Form Option on the Print sub-menu allows you to
  280.                    select which fields will be printed.  There is one
  281.                    option to selecting a field for display this is to
  282.                    add a sum at the end of the form for a column.
  283.                    Select fields to print or the sum option by
  284.                    entering the number of the field.  Press RETURN
  285.                    with no value to complete the form.
  286.  
  287.           Note:    A bug is known to exist on Epson QX10/16 computers
  288.                    when selecting print to disk.  In some cases the
  289.                    program will 'hang' and show the banner
  290.                    continuously.  Press Control-C to exit this
  291.                    condition; however, data may be lost so it is a
  292.                    good idea to make backups of your data files
  293.                    before attempting a print to disk operation.
  294.                    We will try to find the source of this problem
  295.                    and provide a correction as soon as possible.
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.           Sort
  338.  
  339.  
  340.                The Sort option brings up the following sub-menu:
  341.  
  342.           Sort Menu:  <S>ort  <F>ind  <M>ake Index  <R>etrieve Index
  343.  
  344.           <S>ort:   This option displays the fields on the screen and
  345.                     asks for the number of the field on which to sort.
  346.                     It creates a sort index based on the field
  347.                     selected.  If the field type is numeric, the
  348.                     records are sorted from the smallest number to the
  349.                     largest.  If the field type is character, the
  350.                     records are sorted from the smallest ASCII code to
  351.                     the largest ASCII code.  ASCII codes can be found
  352.                     in many computer manuals.  The sorting on ASCII
  353.                     codes results in uppercase Z comes before lower
  354.                     case a and numbers come before letters.  Other
  355.                     characters also have specific positions.
  356.  
  357.           <F>ind:   The find option is used to select a record or
  358.                     subset of records from the data base.  The Find
  359.                     option displays an entry screen with the fields
  360.                     for the current data file.  You are asked to enter
  361.                     a search filter.  The search will use all fields
  362.                     in which you entered data and will then display
  363.                     all matches to your filter.  The filter includes
  364.                     any operator which can be any of the following:
  365.  
  366.                                   =   equals
  367.                                   !   not equal to
  368.                                   >   greater than
  369.                                   <   less than
  370.  
  371.                     If you leave a filter field blank, it will ignore
  372.                     that field in the search.  Thus if searching for a
  373.                     last name of Martin without regard for the first
  374.                     name, the filter would be:
  375.  
  376.                                 LAST NAME:   = Martin
  377.                                 FIRST NAME:
  378.  
  379.                     Note that uppper/lower case differences are
  380.                     important.
  381.  
  382.  
  383.           <M>ake Index:  This option prompts for a file name to save
  384.                     the current sort index or current selection subset
  385.                     created with Sort or Find.  Stored indexes are
  386.                     helpful because they can be read quickly and used
  387.                     to display information without waiting for the
  388.                     sort to be done.
  389.  
  390.           <R>etrieve Index:  This option prompts for the file name of
  391.                     a stored index.
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.           Distribution Policy
  405.  
  406.  
  407.                G-BASE was written by Jansma Consultants, Eugene Oregon
  408.           using the basic compiler ZBasic by Zedcor.  G-BASE is
  409.           available in MS DOS format or CPM80 format for computers
  410.           such as the Epson QX-10.  Jansma Consultants provides this
  411.           program free in its compiled form and encourages its free
  412.           distribution.  It is illegal to resell the compiled version.
  413.           The source code can be licensed from Jansma Consultants for
  414.           $50.00.  The users manual is included on the disk.  Please
  415.           send a check or money order payable to Jansma Consultants,
  416.           1200 High Street, Suite #4, Eugene Oregon 97401.  Please
  417.           specify which format you would like to receive.  The
  418.           available formats are:
  419.  
  420.                * Epson QX-10/16 DSDD or DSQD
  421.                * Other CPM80 5.25 DSDD
  422.                * MS DOS 5.25 DDSD or DSQD
  423.                * MS DOS 3.5 DSDD
  424.  
  425.           The source code can be compiled using the Zedcor ZBasic
  426.           compilers.  Contact Zedcor, Tucson, AZ.  Use with BASICA or
  427.           Quick Basic will require changes which Jansma Consultants
  428.           will not support at this time.
  429.  
  430.           Jansma Consultants encourages the improvement of the G-BASE
  431.           system and development of add-on products such as report
  432.           writers.  Jansma Consultants will try to incorporate changes
  433.           and additions which are suggested by users or submitted by
  434.           source code licensees.  Upgrades and add-ons will be
  435.           distribued to all source code licensees at the cost of
  436.           distribution (about $2.50 per disk).  Notices of upgrades
  437.           will be distributed free.
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.           ............................................................
  470.           .                        G-BASE                            .
  471.           .                      Order Form                          .
  472.           .                                                          .
  473.           .   Please Send me the source code for GBase in the        .
  474.           .   following formats:                                     .
  475.           .                         MS DOS DSDD 5.25                 .
  476.           .                         MS DOS DSQD 5.25                 .
  477.           .                         MS DOS DSDD 3.50                 .
  478.           .                         CP/M   DSDD 5.25                 .
  479.           .                         Computer:                        .
  480.           .                         Epson  DSQD 5.25                 .
  481.           .                                                          .
  482.           .        Total Number of copies                            .
  483.           .        Amount enclosed ($50/copy)                        .
  484.           .                                                          .
  485.           .   Send to:                                               .
  486.           .               Name:                                      .
  487.           .                                                          .
  488.           .            Address:                                      .
  489.           .                                                          .
  490.           .   City, State, Zip:                                      .
  491.           .                                                          .
  492.           ............................................................
  493.  
  494.  
  495.  
  496.           ............................................................
  497.           .                        GBASE                             .
  498.           .                     Comment Form                         .
  499.           .                                                          .
  500.           .                                    Good .----. Bad       .
  501.           .                                    ................      .
  502.           .   Program ease of use              .  .  .  .  .  .      .
  503.           .                                    ................      .
  504.           .   Program usefulness               .  .  .  .  .  .      .
  505.           .                                    ................      .
  506.           .   Bugs and problems                .  .  .  .  .  .      .
  507.           .                                    ................      .
  508.           .   Documentation/Help               .  .  .  .  .  .      .
  509.           .                                    ................      .
  510.           .                                                          .
  511.           .                                                          .
  512.           .   Comments:                                              .
  513.           .                                                          .
  514.           .                                                          .
  515.           .                                                          .
  516.           .                                                          .
  517.           .                                                          .
  518.           .                                                          .
  519.           ............................................................
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.           Appendix
  537.  
  538.           GBase File Format
  539.  
  540.                Every GBase data base file consists of two files, the
  541.           header and the data file, these are designated by the
  542.           extensions .GDH and .GDF, respectively.
  543.  
  544.                The header file contains the information on the number
  545.           of fields, the number of records, as well as the name, type,
  546.           width, and number of decimals for each field.
  547.  
  548.                The data file (*.GDF) holds the data according to the
  549.           infomation in the header file.  Each field is stored as an
  550.           ASCII string of n characters where n=width of the field.
  551.           Even the numeric and money fields are stored in this
  552.           fashion.  To read a record you must read t bytes where t=sum
  553.           of width of all fields.  Then you can parse the data into
  554.           the respective fields.  All data is stored by padding to the
  555.           correct field width with blanks (ASCII 32).
  556.  
  557.                Deleted records are marked by adding the dollar sign
  558.           character ($) as the first character of the first field.
  559.           Records can be undeleted by removing this character.
  560.           characters may be lost at the end of the field when the $ is
  561.           added and these cannot be recovered.
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.