home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / utils / squsq / crunch24.lbr / PATCH24.DZC / PATCH24.DOC
Text File  |  1987-09-16  |  8KB  |  146 lines
  1. ---------------------------------------------------------------------------
  2. This  document describes all of the one byte patches which can be  made  to
  3. v2.4 of CRUNCH.COM and UNCR.COM. It should be noted however, that the great
  4. majority of users can COMPLETELY IGNORE this document if they so choose, as
  5. the  "distribution" copies of CRUNCH and UNCR can be used immediately  just
  6. the way they are. The only notable exception to this is for people  running
  7. certain versions of TURBODOS, who MUST make the TURBODOS patch, or the pro-
  8. grams  may not operate properly. Regular CP/M 2.2, CP/M +, and  ZCPR  users
  9. need not worry about this.
  10. ---------------------------------------------------------------------------
  11.  
  12. All  patches are itemized below. In each case, the patches can be  made  to
  13. either  program  for corresponding identical effects  (except  the  "Bigger
  14. File" patch and the "Archive mode" patch which have no significance on  the
  15. UNCRunch  program. Also note that UNCR does not use the filetype  exclusion
  16. list described at the end of this document).
  17.  
  18. CRUNCH/UNCR v2.3 was released with another program which provided  prompted
  19. automatic patching of four of the options.  This so called v2.3  "CRINSTAL"
  20. program IS compatible with v2.4 and will perform the same functions on  the
  21. newer programs.
  22.  
  23. This version, however, is being released with a short "overlay" file  which
  24. can  be edited with any word processor.  This can then be merged  with  the
  25. "distribution" CRUNCH/UNCR, resulting in a "personalized" copy. This allows
  26. easy  setting of ALL possible "patch bytes", and provides a  mechanism  for
  27. defining  a user-configurable "filetype exclusion list". If you  choose  to
  28. use this method, you can pretty much ignore this document as well, as  most
  29. of  the  text below is repeated next to each appropriate  question  in  the
  30. overlay file, CRUN-OVL.ASM. Simple two step instructions for performing the
  31. assembly/merge are can be found at the beginning of that file.
  32.  
  33. Bytes  can of course be individually patched in a traditional manner  using
  34. SID or equivalent. Below is a description of the bytes and their function:
  35. ---------------------------------------------------------------------------
  36.  
  37. Byte      Significance
  38. ====      ============
  39.  
  40. 10BH     "Z3 Flag". Non-zero configures program for use on the ZCPR3  oper-
  41.          ating  system.  Non-zero values in either 109H or 10AH (  Z3  "en-
  42.          vironment  descriptor"  ) will have the same  effect,  so  running
  43.          Z3INS  on  the  programs precludes the necessity  of  making  this
  44.          patch.
  45.  
  46. 10CH     "Archive Mode Flag". If non-zero, the program will normally run in
  47.          the "archive" backup mode, unless toggled back off by the /A  com-
  48.          mand  line  option. Since this is sort of a specialty  mode,  this
  49.          byte should probably be left in its default zero state.
  50.  
  51. 10EH     "Quiet Mode Flag". Patch to any non-zero value to have the program
  52.          default  to "quiet" mode, ie the program will not display lots  of
  53.          churning  numbers on the screen during operation.  Corresponds  to
  54.          the  /Q  command line option which will toggle  the  default  mode
  55.          defined by the patch.
  56. 10FH     "Overwrite Without Prompt Flag". If patched to non-zero,  existing
  57.          files  will  be overwritten without a prompt. Toggled  by  the  /O
  58.          command line option.
  59.  
  60. 110H     "Turbo-DOS Flag". If patched to non-zero, program will not attempt
  61.          multi-sector  I/O. Otherwise the program will use it if  the  BDOS
  62.          "Get System Version" call returns a value of 3.0 or higher.
  63.  
  64. 111H     "Confirm (tag) Mode Flag". If set to non-zero, the program default
  65.          to  the "tag" mode of operation everytime its is invoked.  Toggled
  66.          by the /C  (alternate: /T) command line option.
  67.  
  68. 112H     "Warm  Boot  Flag". If set non-zero, the program  will  perform  a
  69.          "warm  boot", as opposed to a return to the CCP, each time its  is
  70.          run.  This is normally not necessary, but is included  for  people
  71.          running  systems who have reason to believe that the CCP will  not
  72.          remain resident.
  73.  
  74. 113H     "Bigger File Flag". If set non-zero, the program will NOT ask  the
  75.          question "Result file larger than original. Keep it anyway?".  The
  76.          assumed answer to the question will be "Yes". In v2.4, this  ques-
  77.          tion  is only asked when the destination drive and user areas  are
  78.          identical. See NOTES24.DOC for more information.
  79.  
  80. 114H     "Maximum Drive allowed, plus one". The default value here is "FF",
  81.          effectively disabling the feature. If you so desire, you may enter
  82.          a  value here ("A" = 2, "B" = 3, etc), in which case  the  program
  83.          will intercept any references to higher drives (giving an "Invalid
  84.          Drive"  error). This feature has very little usefulness  in  prac-
  85.          tice. If you leave this feature deactivated, your operating system
  86.          will gladly tell you about the invalid drive spec when it gets it.
  87.  
  88. 115H    "Maximum  User  Code Allowed, plus one". Similar  to  above.  Note
  89.          however that the command line parser will reject all references to
  90.          values  above 15 no matter what. In this case, you don't even  get
  91.          an  "Invalid User Area" message, you will get "Invalid  Argument".
  92.          31 user areas are NOT currently supported. About as useless as the
  93.          above patch.
  94.  
  95.  
  96. 116H     "Spare Flag". For future use.
  97.  
  98. ---------------------------------------------------------------------------
  99.  
  100.                    Filetype Exclusion List (CRUNCH only)
  101.  
  102. The  next  30 (decimal) bytes may contain up to  10  three-letter  filename
  103. suffixes. When encountered, no attempt will be made to compress these files
  104. unless  explicitly  specified; they will be either copied or  ignored  (see
  105. NOTES24.DOC). The defaults are ARC, ARK, and LBR. The first two are  always
  106. compressed  already, so any attempt at recompression will almost  certainly
  107. be  a waste of time. While an .LBR file may or may not contain  files  that
  108. have already been compressed, most commonly they already are.
  109. Notes: Some users may prefer to add COM, as object code files often do  not
  110. compress well, sometimes not at all. On the other hand, usually some  comp-
  111. ression  will  be realized, and in cases where there is  embedded  text  or
  112. other  patterns they may compress quite nicely. Microsoft REL files,  which
  113. are  bitwise encoded, are even less likely to compress, but may also  comp-
  114. ress  when embedded text is present. SLR REL files are not bit encoded  and
  115. are more likely to show modest compression. Since the v2.4 program will now
  116. replace  compression failures with straight copies automatically,  the  de-
  117. fault  configuration here leaves it to the program to try these files  out.
  118.  
  119. It  is  not necessary to add ?Z? and ?Q? to the list, as CRUNCH  v2.4  will
  120. recognize  squeezed and crunched files directly by reading  their  headers.
  121. Including  these filetypes may save some time however, as it precludes  the
  122. necessity   of  opening the files for analysis.  On the other hand  it  may
  123. prevent  the  compression, based on suffix alone, of  certain  files  which
  124. would normally be compressible (eg assembly source with an ".AZM"  suffix).
  125. In any event, you can make your own decisions right here:
  126.  
  127. Byte      Default
  128. ====      =======
  129.  
  130. 117H      'ARC'     }
  131. 11AH      'ARK'     } Default exclusion filetypes
  132. 11DH      'LBR'     }
  133.  
  134. 120H      0,0,0     }
  135. 123H      0,0,0     }
  136. 126H      0,0,0     } Room for up to seven additional user defined filetype
  137. 129H      0,0,0     } exclusions. "?" char may be used. Must fill list con-
  138. 12CH      0,0,0     } secutively, and zero must follow last entry.
  139. 12FH      0,0,0     }
  140. 132H      0,0,0     }
  141.  
  142. 135H      00H !!    If all ten are used, this byte MUST be zero!
  143.  
  144. *** End of User Patchable Area ***
  145.  
  146.