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