home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / database / dbsquash.zip / DBSQUASH.DOC < prev   
Text File  |  1987-02-14  |  5KB  |  139 lines
  1. DBSQUASH.DOC
  2.  
  3.                Documentation for
  4.  
  5.                   DBSQUASH.COM
  6.                       and
  7.                   DBSQUASH.BAS
  8.  
  9.                        by
  10.                 Gregory C. Dahl
  11.  
  12.                October 14,  1983
  13.  
  14.       COPYRIGHT (C) 1983 by GREGORY C. DAHL
  15.  
  16. This program is a small utility for dBASE II (tm) 
  17. programmers which compacts .CMD files an average of 
  18. 35-40 per cent, thereby saving memory and speeding 
  19. program execution.
  20.  
  21. USER SUPPORTED
  22.  
  23.      This program is user supported software.  It 
  24. is copyrighted and cannot be sold for profit, but 
  25. unlimited copies may be made and distributed for 
  26. free.  Users who find the program useful are 
  27. encouraged to send a contribution to the author:
  28.                 Gregory C. Dahl
  29.                 4050 Arroyo Trail
  30.                 Carmel, CA  93923
  31. If this "peoples' marketing" venture is successful, 
  32. the author will be encouraged to write and distri
  33. bute more programs in this unrestricted manner, 
  34. which benefits everyone.  So do your part!
  35.  
  36.      Any contributors who send $10 or more will 
  37. receive a diskette containing the latest version of 
  38. this program and its documentation, along with 
  39. other programs by the same author.  Please be sure 
  40. to indicate single or double density, and the name 
  41. of the program that interests you.  Comments on 
  42. programs are also most welcome!
  43.  
  44.      Due to possible unforeseen circumstances, the 
  45. above offer is subject to change without notice. 
  46.  
  47. WHAT IT DOES
  48.  
  49.      DBSQUASH reads an ASCII file containing your
  50. dBASE II command file, which can be prepared within
  51. dBASE II using the MODIFY COMMAND command or using
  52. a word processor.  A new file is created in which
  53. comments, unnecessary blanks, and other redundant
  54. material has been eliminated.
  55.  
  56.      When writing dBASE II command files, it is 
  57. very useful to indent lines according to the 
  58. program logic.  It is also good programming 
  59. practice to use comments liberally, greatly 
  60. improving the readability of the program (especially 
  61. after a period of time!).  However, both use up 
  62. memory space and dBASE has to write all this 
  63. useless material into memory each time the program 
  64. executes.  Disk swaps are thus greatly increased.
  65. Therefore, after a program is fully debugged it
  66. is desirable to create a streamlined copy with 
  67. redundant material eliminated, using DBSQUASH.
  68.  
  69.      All leading blanks and comments beginning
  70. with * are deleted by DBSQUASH.  Comments after 
  71. ENDIF, ENDDO, and ENDCASE are also eliminated.  
  72. Material in single or double quotes is not affected.  
  73. NOTE comments are not changed.  All spaces before 
  74. and after operators and punctuation marks (which 
  75. are redundant) are removed.  The most common
  76. commands, IF THEY ARE TYPED IN FULL AND IN UPPER
  77. CASE, are shortened to four letters.   Thus STORE
  78. becomes STOR, SELECT SECONDARY becomes SELE SECO,
  79. etc.
  80.  
  81.      The program asks for the name of your command
  82. file to be read from.  It assumes this file is on
  83. drive B: unless you specify another drive.  It then
  84. asks for the name of the file to write to.  This
  85. file will be created if it does not exist, and 
  86. will reside on the B: drive unless you specify
  87. otherwise.  It will have an extension of .CMD 
  88. unless you give a different extension.  Please note
  89. that you must have two different files with 
  90. different names.  Thus you cannot start with a 
  91. .CMD file and end up with a .CMD file of the same
  92. name.  It is recommended that you use the 
  93. extension .FUL for your un-squashed command files
  94. to distinguish them from the squashed versions.
  95.  
  96.      As the program executes, it displays the
  97. current line being squashed and running totals for
  98. the size of the file before and after squashing.
  99. At the end, the percentage savings is displayed.
  100.  
  101. MBASIC AND COMPILED VERSIONS
  102.  
  103.      DBSQUASH is available in two forms: an MBASIC
  104. program and a compiled .COM program.  The .COM
  105. version runs almost twice as fast, and is recom-
  106. mended.  To execute the .COM version, simply type
  107. DBSQUASH at the >A prompt (CP/M).  This is a 
  108. complete machine-language program, and does not
  109. need any file with library routines.
  110.  
  111.      To execute DBSQUASH.BAS you need to first
  112. load MBASIC, and then type RUN "DBSQUASH.
  113.  
  114. PORTABILITY
  115.  
  116.      DBSQUASH was written for the Osborne I (tm)
  117. and uses certain screen addressing commands which
  118. will not work on other machines.  With modification
  119. to these commands (which are not essential to 
  120. operation), the program should run on any CP/M
  121. machine.
  122.  
  123. PROGRAMMING SUGGESTION
  124.  
  125.      It is useful to make the first line of
  126. your program a NOTE containing the name of the
  127. file and the date of the last update.  NOTES are
  128. not removed by DBSQUASH.  This line will help you
  129. to keep track of your files and their revisions.
  130.  
  131.      Your disk drives will be much happier if you
  132. arrange to put your two files (reading from and 
  133. writing to) on separate drives, and the program
  134. will execute a little faster.
  135.  
  136.  
  137.      Happy programming!  
  138.  
  139.                                       Greg Dahl