home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / database / edb31.zip / EDB.DOC next >
Text File  |  1988-02-21  |  14KB  |  297 lines

  1.      EDB Version 3.1 Copyright (c) 1984 & 1988, Ken Brant
  2.  
  3.  
  4. EDB is an Easy to use menu driven Data Base program.  IF YOU FIND IT
  5. USEFUL, SEND A DONATION OF $10.00 OR WHATEVER YOU THINK IS FAIR TO THE
  6. AUTHOR AT THE ADDRESS BELOW.  Your comments and suggestions are
  7. invited.
  8.  
  9. EDB is a User Supported program.  To promote further development and
  10. improvements to EDB and other inexpensive quality software, support the
  11. concept of Shareware and Freeware.  I WILL SEND YOU A FREE COPY of the
  12. EDBFORMS program, when I receive your donation of $10.00 or more.
  13. EDBFORMS lets you print forms and reports from an EDB Data Base File.
  14. You can use it to print Address Lables, W-2 Forms, Checks, etc.  With
  15. EDB FORMS, you can print most any form.
  16.  
  17. Permission is granted to make copies and distribute EDB.EXE and EDB.DOC,
  18. but they may not be resold under any circumstances without prior written
  19. approval of the author.
  20.  
  21.  
  22.  
  23.                              Ken Brant
  24.                           621 Galerita Way
  25.                         San Rafael, CA 94903
  26.  
  27.  
  28.  
  29.           Enhancements in version 3.1 are:
  30.  
  31.      1. Added Dynamic Memory Allocation for file data.
  32.      2. Substantially increased the record capacity.
  33.      3. Improved Display performance.
  34.      4. Added Directory/Path, Defaults to *. for easy viewing.
  35.      5. Displays Memory Available and Remaining Record Capacity on Menu.
  36.      6. Use the Escape Key to exit from Display option.
  37.      7. Use the Escape Key to exit from Match option.
  38.      8. Hold down any Key to exit from Print option.
  39.      9. Use Pg Up Key to back up one screen in Display option.
  40.      EDB Version 3.1 Copyright (c) 1984 & 1988, Ken Brant       Page  1
  41.  
  42.  
  43. EDB is an Easy to use menu driven Data Base program.  It provides all
  44. the options to Define, Create, Extend, Save, Load, List, Print, Sort,
  45. Search and Update a database file.  The Main Functions which can be
  46. selected from the Menu Screen are:
  47.  
  48.                   EDB V 3.1 Copyright (c) 1984, 1988 - Ken Brant
  49.  
  50.       <C>reate    a new file or Extend the current File
  51.       <L>oad      a File from Disk
  52.       <S>ave      the File to Disk
  53.       <F>iles     Display the Directory
  54.       <D>isplay   Display the File on Video Screen
  55.       <P>rint     Print the File on the Printer
  56.       <E>dit      Edit: Change or Delete a Record
  57.       <O>rder     Sort the File
  58.       <M>atch     Find all Matching Records to any Search String
  59.       <Q>uit      Exit the Program
  60.  
  61. To run the program, type EDB.  The Menu Screen is displayed.  Memory
  62. Available and the Remaining Record Capacity are displayed along with the
  63. Menu so you always know how many new records can be added to the file.
  64. To select a menu option type the first letter of the option.  A complete
  65. description of each option on the Menu Screen follows:
  66.  
  67. Create:
  68. -------
  69. Create is used to define a new data base file.  When creating a new
  70. file, you define the file characteristics to EDB.  EDB will prompt you
  71. for the information it needs to Create the data base:
  72.  
  73.    1.  File Name is the name of your data base.  Some examples are:
  74.  
  75.                   CHECKS.JAN      CHECKS.FEB      MEMOS
  76.                   ADDRESS.LST     INVTY           INVTY.OLD
  77.  
  78.    2.  Field Name: Each record contains one or more fields.  Field names
  79.        are used for headings on displays and reports.  Make them brief
  80.        but meaningful.
  81.  
  82.             Examples of Field Names are: Check No., Date, Payee, Amount,
  83.                         Name, Street, City, Phone Number, etc.
  84.  
  85.        Each field has the following characteristics:
  86.  
  87.           a) Field Type.  The choices are:
  88.  
  89.               A: For alphanumeric data.  The field can contain letters
  90.                  or numbers.  Use "A" for dates, check numbers, age,
  91.                  names, ZIP codes, phone numbers, descriptions, etc.
  92.  
  93.               I: For Integer fields which are to be totaled, but have no
  94.                  decimal places.  DO NOT use "I" for numeric fields like
  95.                  ZIP code, phone number or social security number.  Use
  96.                  "A" unless you want EDB to total the field.
  97.  
  98.               n: The number of decimal places.  The field will contain
  99.                  numeric values with decimal places.  Use 2 for money
  100.                  amounts.  Fields with decimal places will be totaled.
  101.      EDB Version 3.1 Copyright (c) 1984 & 1988, Ken Brant       Page  2
  102.  
  103.  
  104.           b) Field Length.  Just enter the length of the field.  It must
  105.              be at least as long as the Field Name you chose.  If you
  106.              have a field that is one character long, but its Filed Name
  107.              is longer, Field Length must be increased to the length of
  108.              Field Name, or the Field Name should be shortened to one
  109.              character.  Otherwise the columns on the display will not
  110.              line up under the Field Names.
  111.  
  112.    The request for the Field Names, Field Types and Field Lengths is
  113.    repeated until you press the (RETURN) key in response to the prompt
  114.    for another Field Name.
  115.  
  116.    When you have described all of the fields, you will be asked to enter
  117.    the file data, field by field, record by record.
  118.  
  119.    When you have finished entering the data in the file, or you want to
  120.    stop entering, simply press the (RETURN) key instead of entering the
  121.    data for the next record.  In Create mode, the program automatically
  122.    saves the file.
  123.  
  124.    After a file has been Created it will continue to be the Active file
  125.    until you Create another file, Load another file or Exit from the
  126.    program.
  127.  
  128. The Create function is also used to Extend an Active file.  That is, you
  129. can add more records to the end of a file.  To Extend a file, it must be
  130. the Active file (the file that has just been Created or Loaded).  If you
  131. select the Create function when a file is Active, the program will ask
  132. if you want to Create a new file or Extend the Active file.  To Create a
  133. new file, enter a "Y" in response to the question.  If you press any
  134. other key the program will allow you to Add more records to (Extend) the
  135. Active file.
  136.  
  137.  
  138. Files:
  139. ------
  140. When you select Files, "Enter Path name:" displays on the screen so you
  141. can choose which drive\sub-directory to view.  To select the current
  142. drive:\sub-directory and list all files matching wild card "*.   " just
  143. press the enter key.  You may enter a drive:\path\wildcard to select any
  144. sub-directory you want.  The selected Directory Listing displays, and
  145. 'Waiting...' displays at the bottom of the screen.  Press any key to
  146. proceed to the Menu screen.
  147.  
  148.  
  149. Load:
  150. -----
  151. When you select the Load option, it automatically selects the FILES
  152. option first, so you can see the names of the files you have.  After the
  153. selected sub-directory is displayed, enter the name of the file you want
  154. If the file exists, it is Loaded into memory, and the Menu screen
  155. displays.  If the file can not be found, the prompt:
  156.   "'filename' does not Exist!  To Return to Menu without Loading a file,
  157.     PRESS (RETURN) or Enter a File Name :"
  158. displays.  (In this context 'filename' is the name you entered).
  159.  
  160. When a file is Loaded it becomes the Active file.
  161.      EDB Version 3.1 Copyright (c) 1984 & 1988, Ken Brant       Page  3
  162.  
  163.  
  164. Save:
  165. -----
  166. When you select the Save option, EDB gives you the opportunity to change
  167. the name of the file.  It displays the prompt "Is 'filename' the file
  168. name you want (Y/N)?".  To prevent accidental destruction of another
  169. file with the same file name, the program checks the current
  170. drive\sub-directory.  If a file with the same name exists, EDB displays
  171. the prompt:
  172.   "'filename' already Exists.  OK to save (Y/N)?".
  173.  
  174.  
  175. Display:
  176. --------
  177. When you select the Display option, the Active file is displayed on the
  178. screen.  The first 19 records are displayed and the 'Waiting ...' prompt
  179. displays at the bottom of the screen.  Press any key and the next 19
  180. records are displayed, and so on.  Use the PgUp key to back up a screen
  181. at a time, unless you are on the last screen.  To escape back to the
  182. Menu at any time press the Esc key.  If fewer than 20 records are left
  183. to display, a Total Line is displayed.  The Total Line displays the sums
  184. of each of the Integer and decimal fields in the file.  With very large
  185. files there will be a noticeable delay before the total line displays.
  186. When 'Waiting...' displays at the bottom of the screen.  Press any key
  187. to proceed to the Menu screen.
  188.  
  189.  
  190. Print:
  191. ------
  192. When you select the Print option, the Active file is printed on the
  193. Printer.  First, the paper advances to a new page to insure that the
  194. listing starts at the top of the page.  Then the file is listed, each
  195. record on a new line.  A Total Line is printed at the end of the listing
  196. To abort printing hold down the space key.  If you have a large print
  197. buffer, holding down the space bar will not stop the printer until the
  198. buffer empties.
  199.  
  200.  
  201. Edit:
  202. -----
  203. When you select the Edit option, EDB prompts you to enter the Key of the
  204. record to be changed or deleted.  The "Key" is the record number which
  205. displays on the left hand side of the screen when using the "Display"
  206. option.  When you enter the Key, the record will be displayed so you can
  207. verify it is the one you want to change or delete.  The prompt "Enter
  208. <C>hange, <D>elete, or Press any other key to Return" is displayed on
  209. the screen.  To Change the record, enter "C".  To Delete the record,
  210. enter "D".  To Return to the Menu screen without Changing or Deleting
  211. the record press any other key.  When you select "C" for Change, you are
  212. given the option of entering new data for each field, or pressing
  213. (RETURN) to leave the field unchanged.  The process is repeated for each
  214. field in the record.  When you have finished the last field, the Menu
  215. screen is displayed.
  216.      EDB Version 3.1 Copyright (c) 1984 & 1988, Ken Brant       Page  4
  217.  
  218.  
  219. Order:
  220. ------
  221. When you select the Order option, a list of Field Names is displayed,
  222. and you are prompted to select the number of the field to sort by.
  223. After you select the field, the prompt "Ascending or Descending?  enter
  224. (A/D)" is displayed.  Enter "A" for Ascending Order or "D" for
  225. Descending Order.  It may take several seconds for the sort to finish,
  226. depending entirely on the the number of records in the file and the
  227. speed of your micro-processor.  For a file of 200 records, it could take
  228. 5 to 10 seconds.  For a 2000 records, it may take 3 minmutes.  When the
  229. sort is finished the Menu screen is displayed.
  230.  
  231.  
  232. Match:
  233. ------
  234. The Match option prompts you to enter a "Search Field".  A "Search
  235. Field" can be any part of any field.  For example, if you want to
  236. display all the records in the file which have the letters "SMITH" in
  237. any field, enter SMITH as the Search Field.  Note, letters must Match
  238. exactly.  Capital letters must be entered as capital letters and lower
  239. case letters must be entered as lower case letters.  The Search Field of
  240. "SMITH" will not match with mixed case letters like "Smith".  When the
  241. Match function finishes, the 'Waiting ...' prompt is displayed at the
  242. bottom of the screen.  Press any key, and the Menu screen is displayed.
  243. The Esc key functions the same as for the Display option.
  244.  
  245. Quit:
  246. -----
  247. When you have finished with the program and your database files, enter
  248. "Q" to Exit from the program.  The prompt "Save the File (Y/N)?" is
  249. displayed on the screen to make sure you do not forget to save the
  250. file.  This is important if you have made any changes or you have
  251. deleted any records.  If you want to save the file enter "Y" otherwise
  252. enter "N".  The program is ended.
  253.      EDB Version 3.1 Copyright (c) 1984 & 1988, Ken Brant       Page  5
  254.  
  255.  
  256.                      ADDITIONAL NOTES TO REMEMBER:
  257.  
  258.  1. To Add more records to the file it must be the Active file.  Use the
  259.     Create option and press any key except "Y" in response to the
  260.     prompt.  If there is not enough memory to add any more records a
  261.     a message is displayed to that effect.  The Menu Screen displays the
  262.     Memory Available and Remaining Record Capacity.
  263.  
  264.  2. To Delete records from the file, use the Edit option, enter the
  265.     "Key" of the record to be deleted.  When the record is displayed and
  266.     you verify it is the one you want to delete, press the "D" key.
  267.  
  268.  3. To Load files from, or Save files to a disk other than the default
  269.     drive and sub-directory, just precede the filename with the drive
  270.     and path name of the sub-directory you want.  For example, if the
  271.     default drive is A: and you want to save your file which is named
  272.     PHONE# in sub-directory DATA on drive C: be sure to resopnd "N" when
  273.     asked if PHONE# is the FileName you want.  Then when asked to enter
  274.     a new file name, enter C:\DATA\PHONE#.
  275.  
  276.  4. If you happen to select the Display, Print, Edit, Order or Match
  277.     option before you have Loaded or Created a database file, the
  278.     Directory Listing will display on the screen, and you will be asked
  279.     to "Enter File Name", so one can be Loaded.
  280.  
  281.  5. For fast execution, this version of EDB stores the data base in
  282.     dynamically allocated memory.  EDB will use all available memory,
  283.     up to 640K.  Depending on how much memory it can get, EDB will
  284.     handle from 750 to 4000 records of 125 bytes.  It is limited to
  285.     16 fields.  If there is enough interest, the author will consider
  286.     developing a version with maximum records limited only by disk
  287.     capacity.
  288.  
  289.  6. Both "Display" and "Print" options list the fields in the exact
  290.     order in which they were defined by the "Create" option.  When you
  291.     send your registration and $10.00 to the author, you will be sent a
  292.     copy of the EDB FORMS program.  EDB FORMS lets you print forms and
  293.     reports from any EDB Data Base File.  You can use it to print
  294.     address labels, W-2 Forms, Checks, etc.  With EDB FORMS, you can
  295.     print most any form, provided you have the information in an EDB
  296.     Data Base.
  297.