home *** CD-ROM | disk | FTP | other *** search
/ Software Du Jour / SoftwareDuJour.iso / BUSINESS / DBASE / DTUN31PC.ARC / DT31PC.DOC next >
Text File  |  1985-08-14  |  10KB  |  209 lines
  1.         ====  Documentation for dTUNE Version 3.1pc  ====
  2.  
  3.                      dTUNE (C) Version 3.1pc
  4.                     (IBM PC and Compatibles)
  5.         A Utility For Use With dBASEII(tm) Command Files
  6.                        by James A. Gronek
  7.  
  8.                 dTUNE is Copyright (C) 1984, 1985
  9.                                by
  10.                             UCS, inc.
  11.                          P.O. Box 23866
  12.                      Phoenix, Arizona 85063
  13.  
  14.                       ALL  RIGHTS  RESERVED
  15.  
  16.  
  17.                      ====  Description ====
  18.  
  19.      dTUNE  is a utility program for use on dBASEII and  dBASEIII 
  20. or  III command files by removing all unnecessary  spaces,  tabs, 
  21. line feeds and comments.  Further, it shortens reserved words and 
  22. phrases  to their minimum four character length.  Because dBASEII 
  23. parses every character of every line prior to executing it, dTUNE 
  24. will  dramatically improve the running speed of almost  any  .PRG 
  25. file.  
  26.  
  27.      dTUNE  has many additional features for the dBASEII and  III 
  28. programmer,  including the ability to uniformly alter the case of 
  29. the .PRG file,  prepare a documentation quality file with nesting 
  30. and indenting, prepare a line numbered file and associated cross-
  31. reference listing of variables,  and other options described more 
  32. fully below. Your original source file will not be altered IN ANY 
  33. WAY.
  34.  
  35.                    ==== Installing dTUNE  ====
  36.  
  37.      dTUNE  has  been pre-installed for an 80x25 b/w display  and 
  38. should run on nearly any true blue or pclone under ms- or pc-dos.
  39.  
  40.                      ====  Using dTUNE ====
  41.  
  42.                
  43.      dTUNE is executed with the command:
  44.  
  45.      A>DTUNE<CR>
  46.  
  47.      dTUNE will sign on,  and ask you for the default  directory.   
  48. This selection tells dTUNE where the command file to be processed 
  49. is located,  and what drive to use for the output files.  If,  at 
  50. this point,  you press <RETURN> the default directory will be the 
  51. one you were logged on when you called up dTUNE.   When selecting 
  52. a  new  directory  path  it is imperative that  you  prefix  your 
  53. directory selection with a backslash ("\").   Thus,  if you  call 
  54. the  program up from the root directory on the "A" drive and wish 
  55. to process a .PRG file in the "B" drive under the "DBASE" subdir-
  56. ectory, you would type "B:\DBASE".  If you wish to process a .PRG 
  57. file  on  the CURRENT drive under the  "DBASE"  subdirectory  you 
  58. would  type  "\DBASE".   You  may  select  any  valid  drive/path 
  59. combination.  
  60.  
  61.      Once  you have selected the default directory,  you will  be 
  62. presented  with  a  list  of the .PRG files  on  that  drive  and 
  63. prompted  for the FILENAME of the file to be processed.  You need 
  64. only  supply  the  PRIMARY  filename,   dTUNE  assumes  the  .PRG 
  65. filetype.
  66.  
  67.      Once  dTUNE  has  verified the existance of the file  to  be 
  68. processed,  you  will be prompted for processing  options.  These 
  69. options are detailed, in the sequence presented, below:
  70.  
  71.             OPTION 1: Cross-Referencing of Variables
  72.  
  73.      dTUNE  will ask if you wish a cross-reference listing of all 
  74. non-reserved words and variables.  Acceptable answers are Y or N, 
  75. either  upper  or lower case.  If you answer Yes to  the  prompt, 
  76. dTUNE will prepare TWO files from the source file. The first will 
  77. be a line numbered file with a filetype of .PRN,  the second will 
  78. be  a  listing  of  all  non-reserved  words  and  variables,  in 
  79. alphabetical  order,  showing  the  line numbers  in  which  they 
  80. appear, saved with a filetype of .XRF.
  81.  
  82.      dTUNE will handle in excess of 300 variables,  if necessary, 
  83. but  the use of so many variables is not  recommended!  dBASEII's 
  84. internal  limitations specify a maximum of 64 variables,  so  you 
  85. can see that there is considerable latitude allowed by dTUNE.
  86.  
  87.                ----  NOTE - KNOWN LIMITATION  ----
  88.  
  89.      The  cross-reference file (type .XRF) cannot be longer  than 
  90. about  14K.  dTUNE's internal memory limitations will cause it to 
  91. abort processing with a reported error code of 'FF', indicating a 
  92. Heap/Stack collision.  If this occurs to you,  simply break  your 
  93. command file into two, or more, separate files, then process them 
  94. both.  Unless your command file is over 2000 lines in length, AND 
  95. uses over 300 memory variables, this should not be a problem.
  96.  
  97.            OPTION 2: Preparation of Structured Source
  98.  
  99.      dTUNE will next ask if you wish a structured version of your 
  100. source file. Acceptable answers are Y or N, either upper or lower 
  101. case.  If you answer Yes to the prompt,  you will receive another 
  102. prompt,  asking if you wish to alter the case of the source code. 
  103. Again, acceptable answers are Y or N, either upper or lower case. 
  104. If you answer No to this prompt, the case of your structured file 
  105. will be the same as the case of your source file.
  106.  
  107.      If you answer Yes to the Case prompt, dTUNE will ask whether 
  108. it  should  make  the structured file UPPER CASE or  lower  case. 
  109. Acceptable answers are U or L,  either upper or lower case. dTUNE 
  110. will uniformly alter the case of the structured  file,  excepting 
  111. quoted  strings.  Strings  may be delimited with either a  single 
  112. quote  mark  ('),  or a double quote mark (").  dTUNE  will  read 
  113. source files in UPPER CASE, lower case, and MiXeD CaSe with equal 
  114. ease. 
  115.                            -- NOTE --
  116.  
  117.      dTUNE  WILL  NOT  ALTER  YOUR  SOURCE  FILE,  IT  CREATES  A 
  118. TEMPORARY FILE FROM WHICH TO WORK, ENSURING THE INTEGRITY OF YOUR 
  119. ORIGINAL SOURCE FILE!!!
  120.  
  121.      If you answered Yes to the Structured Source  prompt,  dTUNE 
  122. will save your structured file with a filetype of .TXT.
  123.  
  124.           OPTION 3: Preparation of a Structured version
  125.                       of the processed file
  126.  
  127.      dTUNE  always prepares a .PRG file that has no  indentation, 
  128. nesting,  or  comments,  and  has all reserved words and  phrases 
  129. shortened  to the minimum four character  length.  The  resultant 
  130. file is nearly impossible to understand. This option will prepare 
  131. a  nested version of the processed file,  allowing you to  follow 
  132. the  logic with more ease.  This file may be substituted for  the 
  133. unstructured  .PRG  file  with negligible difference  in  running 
  134. speed.
  135.  
  136.      You  will be asked if you wish a Structured version  of  the 
  137. Processed  file.  Acceptable answers are Y or N,  either upper or 
  138. lower  case.  If you answer Yes,  dTUNE will save the  structured 
  139. version of the processed file with a filetype of .STR.
  140.  
  141.         OPTION 4: Listing of Structured version of Source
  142.  
  143.      You  will be asked if you wish a Structured Listing  of  the 
  144. Source code. Acceptable answers are Y or N, either upper or lower 
  145. case. If you answer Yes, dTUNE will print a structured version of 
  146. your source code to the LST: device (normally the printer).
  147.  
  148.      Once  you have answered all the option prompts,  dTUNE  will 
  149. begin reading your source file. dTUNE will print a dot (.) to the 
  150. screen  for each FIVE lines of code it reads.  dTUNE will  notify 
  151. you  of  its activities as it creates the desired files.  If  you 
  152. selected the cross-reference option, dTUNE will update you during 
  153. the cross-reference at 100 line intervals.
  154.  
  155.                     ====  GENERAL NOTES  ====
  156.  
  157.      dTUNE  was written in Borland International's Turbo  Pascal, 
  158. Version  3.0 and is compiled for operation in a minimum 44K  TPA. 
  159. This will allow dTUNE to execute succesfully under most  keyboard 
  160. redefinition programs.
  161.  
  162.      During  execution,  dTUNE  creates at least one (two if  you 
  163. decide to alter the case of the .TXT file) working file(s).   You 
  164. MUST  ensure that there is sufficient disk space for all  working 
  165. files,  and  all desired output files on the  default  (selected) 
  166. drive!   Failure  to  heed this will result in the crash  of  the 
  167. program.
  168.  
  169.      dTUNE will read crunched (i.e. Run-Time (tm)) command files, 
  170. but  will not alter them.  Likewise,  it will not cross-reference 
  171. crunched command files.
  172.  
  173.  
  174.                     ==== LICENSING TERMS ====
  175.  
  176.         dTUNE is Copyright (C) 1984,  1985 by UCS,  inc.
  177.                     ALL RIGHTS ARE RESERVED.
  178.  
  179.      dTUNE  is  released  for PRIVATE  NON-COMMERCIAL  use  only. 
  180. Single-User Commercial Use rights are available for a nominal fee 
  181. from the author.  Private End-users may register dTUNE for a  fee 
  182. of $25.00,  which will entitle them to notification of updates to 
  183. dTUNE  and limited support.  Owners of commercial use rights will 
  184. also receive notification of upgrades and limited support.
  185.  
  186.      dTUNE  is  protected  by United  States  Copyright  Law  and 
  187. International Treaty.  Violators of the UCS,  inc. copyright will 
  188. be prosecuted.
  189.  
  190.  
  191.                        ====  CREDITS  ====
  192.  
  193.        dBASEII and dBASEIII are trademarks of Ashton-Tate
  194.  
  195.      dTUNE,  like most programs,  is a result of evolution.  Many 
  196. people  were involved in the testing and modification of dTUNE to 
  197. bring it to its present state.  These brave pioneers provided the 
  198. Beta-Testing and recommendations for improvement that resulted in 
  199. dTUNE Version 3.1.
  200.  
  201.      I  specifically  wish to mention Terry Carroll  of  Bedford, 
  202. Texas,  Dr. Don Saba of San Diego, California, Steve Aidikonis of 
  203. Streamwood,  Illinios,  and Fr. Dick Driscoll of Phoenix, Arizona 
  204. and  express  my gratitude for their patience  and  knowledge  of 
  205. dBASEII.
  206.  
  207. mention Terry Carroll  of  Bedford, 
  208. Texas,  Dr. Don Saba of San Diego, California, Steve Aidikonis of 
  209.