home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / dbase / ddu10.arj / DDU.DOC < prev    next >
Text File  |  1992-01-27  |  7KB  |  155 lines
  1.         DDU - The Database Description Utility 1.0
  2.  
  3. This program provides a convenient way to document your dBASE/
  4. Clipper/Foxbase database files.  You may enter descriptions
  5. for each field, comments for each file, and associate index
  6. files with each database file.  You may print the documentation
  7. sheets to printer or to an ASCII file.
  8.  
  9. If you find the program useful, please register the program for
  10. $20.00 to: PractiComp
  11.            6490 Dubois Rd.
  12.            Delaware, OH  43015  USA
  13.            614-548-5043
  14. Registered users will receive 4 additional utility programs for
  15. use with dBASE files.  See the end of this document for details.
  16.  
  17. DDU Installation
  18. Copy the files DDU.EXE and DDU.DOC into a path'ed directory,
  19. such as your utility directory.  To run the program, first
  20. switch to the directory containing the files to be documented
  21. and then type DDU.
  22.  
  23. F1 - Help
  24. Press F1 to view this file from within DDU.  If the file is
  25. not found in the current directory, you will be asked to
  26. specify the directory in which it may be found.
  27.  
  28. M - Mask
  29. Press M to change the Mask which specifies which files are
  30. displayed in the file selection box on the right side of the
  31. screen.  The program will assume a DBF extension, unless
  32. otherwise specified.  For example:
  33.   
  34.   MT*     to display all DBF files beginning with MT.
  35.   MTRPT?  to display DBF files such as MTRPT1,MTRPT2,etc.
  36.   MTRPT8  to display the single file MTRPT8.DBF
  37.   *.DBX   to display all files with the extension .DBX
  38.           (this allows usage of dBASE data files with extensions
  39.           other than .DBF)
  40.  
  41. You may also start DDU with a mask specified on the command line.
  42. For example:    DDU MT*
  43.  
  44. ENTER - Tag/Untag
  45. Press ENTER to tag/untag files in the file selection box.  Tagged
  46. files will be indicated by a marker.  Files must be tagged before
  47. using most other commands.
  48.  
  49. T - Tag All, U - Untag All
  50. Press T to tag, or U to Untag all files in the file selection box.
  51.  
  52. C - Comments
  53. Press C to enter comments for each tagged file.  The comment
  54. window will be displayed with the name of the first tagged
  55. database displayed at the top of the window.  You may enter
  56. free-form comments relevant to this database file.  ALT R will
  57. reformat the text in the comment window.  Press F10 to save the
  58. comment text, or ESC to exit without saving.  A comment window
  59. for the next tagged file will then be displayed.  Repeat this
  60. process until comments have been entered for all tagged files.
  61.  
  62. F - Fields
  63. Press F to enter descriptions for fields in each of the tagged
  64. files.  The field window will be displayed with the name of the
  65. first tagged file displayed at the top of the window.  Move the
  66. highlight bar to a field for which you would like to enter a
  67. description.  You may just begin to type the description, or
  68. press ENTER to edit an existing description.  To quickly erase
  69. a description, press DEL when the field which you would like to
  70. erase is highlighted.  When all descriptions have been entered
  71. for this file, press ESC to exit the window, and the next tagged
  72. file will be displayed.
  73.  
  74. DDU does not sort fields in alphabetical order, but maintains the
  75. order of the fields as defined when created.  Each time you
  76. select the F option DDU automatically adjusts the file DDU.DBF
  77. for changes made to the file structure by adding new fields or
  78. removing fields no longer contained in the file.  DDU only
  79. modifies the file DDU.DBF and will not make any changes to your
  80. database files.
  81.  
  82. I - Indexes
  83. Press I to select the index files associated with each of the
  84. tagged database files.  Select the index type from the list -
  85. Clipper NTX, dBASE NDX, or Foxbase IDX.  A window will appear
  86. listing all index files of the selected type.  The database file
  87. name will appear at the top of the window.  Press ENTER to tag
  88. each index file associated with the named database file.  When
  89. all index files for this database file have been selected, press
  90. ESC.  The index files and index expressions will be displayed.
  91. Press ESC again to continue with the next database file.
  92.  
  93. P - Print
  94. Press P to print DDU sheets for each of the tagged files.  These
  95. sheets will contain the following information for each database
  96. file.
  97.        File name, number of records, date last updated
  98.        File structure - field name, type, size, and description
  99.        Record length
  100.        Associated indexes and index expressions
  101.        File comments
  102.  
  103. You may direct the printout to a printer port by specifying LPT1,
  104. LPT2, etc. or to a text file by typing in a file name.  If the
  105. file name entered already exists you will be warned that you are
  106. about to overwrite the file.  A .TXT extension will be appended
  107. to all print files.
  108.  
  109. K - Pack
  110. Press K to pack the file DDU.DBF.
  111.  
  112. ESC - Quit (Exit to DOS)
  113.  
  114. DEL Key
  115. If database files are deleted you may want to remove those
  116. records from the file DDU.DOC.  Press DEL at the Main Screen
  117. to display all database files currently contained in DDU.DBF.
  118. Tag the files to be removed by pressing ENTER.  Press ESC when
  119. all desired files are tagged.  You will be asked to verify that
  120. you want to remove records for the tagged files. This DOES not
  121. delete any disk files, it only removes the corresponding records
  122. in DDU.DBF.
  123.  
  124. -----------------------------------------------------------------
  125.  
  126. Utility Programs Provided On Registration
  127.  
  128.   DIRD - Directory of dBASE type files
  129.          Lists file name, size, date and time of last update,
  130.          number of records, record length, number of fields,
  131.          and whether a memo field is included.  A file mask
  132.          may be specified on the command line to restrict
  133.          files viewed.
  134.          ie. DIRD ED*    to display all .dbf files beginning
  135.                          with ED
  136.  
  137.   DIRI - Directory of Index files
  138.          Lists all index files - Clipper, dBASE, Foxbase and
  139.          displays the index expressions for each file.
  140.  
  141.   LS   - List Structure
  142.          A quick and easy way to displays the structure of the
  143.          specified dBASE type file.   LS DBF_File_Name
  144.  
  145.   LD   - List Database
  146.          Quickly and easily view the contents of any dBASE type
  147.          file.  Use the following keys to control which record
  148.          is displayed.   LD DBF_File_Name
  149.  
  150.               Next Record               Previous Record
  151.          PgDn  Page Forward         PgUp  Page Backward
  152.          Home  Beginning Of File    End   End Of File
  153.          G     Go To Record#        ESC   Exit
  154. 
  155.