home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / lambda / utils / crunch.doc < prev    next >
Text File  |  1993-10-25  |  6KB  |  131 lines
  1.  
  2. ------------------------------------------------------------------------
  3.  
  4. This file contains the basic usage syntax for CRUNCH and UNCRunch pro-
  5. rams, along with a brief description of what the various modes are.
  6. Many additional operational details are contained in the NOTES24.DOC
  7. file, especially details relating to features new to v2.4 vs. v2.3.
  8.  
  9. Information pertaining to exact locations of "patch bytes", which allow
  10. you to tailor the programs to your own preferences, are contained in a
  11. separate file PATCH24.DOC.
  12.  
  13. ------------------------------------------------------------------------
  14.  
  15. CRUNCH    v2.4  Usage:
  16.  
  17.          Filename    Date, etc.    Option letters
  18.         /           /         /
  19. CRUNCH    {du:}<afn>  {du:}  { [id] }  { /<options> }
  20.       \          \           |
  21.        Source      Destination   (space)
  22.  
  23. where <options> = {Q}{C}{O}{A}
  24.  
  25. Items in curly brackets are optional (namely everything except for the
  26. filename).  The two optional 'du:' specs may be of the form DU:, UD:, D:
  27. or U: where 'D' is any legal drive letter and 'U' is a user-code from
  28. 0-15, inclusive.  The colon MUST be typed.  The first 'du:' specifies
  29. where the filename '<afn>' is located, and it should immediately precede
  30. the <afn> with no intervening blanks if it is used . If no drive is
  31. specified, the    default (currently logged) drive is assumed.  The same
  32. is true for the user code.  The filename <afn> may contain the ambiguous
  33. (wildcard) characters '?' or '*' if desired.
  34.  
  35. The second 'du:', which has the same form as the one described above, is
  36. an optional drive specifier where the output will be directed.    No file-
  37. name may follow the the second 'du:' - the filename will be generated
  38. automatically (see below).  As above, if either part of the 'du:' speci-
  39. fication is not included (or if the specification is left out alto-
  40. gether), appropriate defaults will be used.  The resulting file will
  41. have the same name as the crunched file, except that the middle letter
  42. of the extension will be converted to "Z".  If the original file's ex-
  43. tension was blank or already had a "Z" in  the    middle, then a filetype
  44. of "ZZZ" will be used.
  45.  
  46. [id] is an optional "date stamp" (or other information), used to iden-
  47. tify the file.    If used, [id] consists of any text contained between a
  48. pair of square brackets i.e., the brackets must actually be typed.  The
  49. text contained in [id] will be recreated at the console for the opera-
  50. tor's reference when the file is later uncrunched.
  51.  
  52. Four  command line options, "Q", "C", "O" and "A", are available.  They
  53. may be used in any combination and in any order, but must be preceded by
  54. a single slash and there should be no intervening blanks between option
  55. letters.  The "/" itself must be preceded by a blank. For example:
  56.  
  57.     CRUNCH *.DOC B0:  /CQ
  58.  
  59. is a valid command line.
  60. The letters have the following significance:
  61.  
  62.      Q    Quiet mode toggle
  63.      C    Confirm (tag) mode toggle
  64.      O    Overwrite without prompt mode toggle
  65.      A    Archive bit mode toggle
  66.  
  67. The "standard distribution" copy of CRUNCH is shipped with all four of
  68. the above modes "off".    The command line option will activate the assoc-
  69. iated mode.  It should be noted that patch bytes in the .COM file allow
  70. a copy of CRUNCH to be configured to default to an user's own preference
  71. (see PATCH24.DOC).  If a mode is configured to default to the "on" state
  72. then an occurrence of the associated letter in the command line will
  73. flip the  option back off.
  74.  
  75. For example, some users may prefer that CRUNCH generally perform over-
  76. writes without    always prompting.  In a certain situation where the user
  77. wanted to be extra-careful, however, he could temporarily reinstate the
  78. prompt by specifying the /O option.
  79.  
  80.  
  81. Following is a brief statement of what each mode does when active:
  82.  
  83. QUIET MODE:  Simply suppresses the continuous console output normally
  84. supplied by the program while it is processing a file.    May be desirable
  85. if your console is slow, auto-adds LF after CR, is a printing device or
  86. if you just plain don't like watching this kind of activity.
  87.  
  88. OVERWRITE WITHOUT PROMPT MODE:    Suppresses the question "Destination
  89. File exists, overwrite?"  from being issued everytime the program is
  90. about to overwrite an old file with the same name as the new one.
  91. "Safer" to leave this mode in the default "off" state, but really a
  92. matter of personal preference.    Off-state can hinder "unattended" mass
  93. perations, however, since processing may occasionally be suspended pend-
  94. ing an operator response.
  95.  
  96. TAG MODE:  An enhanced method for selectively processing certain files
  97. from a wildcard group.    Though vastly more limited, it is obviously
  98. modeled after the SWEEP/NSWP type "tagging" concept, so many users will
  99. feel comfortable with it immediately.  All specified files are displayed
  100. one at a time in alphabetical order.  Only "tag", "untag", "next file"
  101. and "back one file" functions are supported.  After all proper files
  102. have been tagged, the mass operation commences without further user in-
  103. tervention.  See NOTES24.DOC for some some additional notes on this mode.
  104.  
  105. ARCHIVE BIT MODE:  Allows CRUNCH to be used as an archival type simple
  106. backup program.  Like other "incremental" backup programs, in this mode
  107. CRUNCH will only process files which have been changed since the last
  108. backup, based on the CP/M "archive" directory attribute.  After each
  109. file is processed, the bit will be set indicating the file is now backed
  110. up.  See NOTES24.DZC for some additional notes about this mode as well.
  111. NOTE:  While all other modes and command line options are common to
  112. UNCRunch and CRUNCH, this one is implemented in CRUNCH only.
  113. UNCR  v2.4
  114. Usage:
  115.  
  116.         Filename   (space)
  117.            /        |
  118.  UNCR  {du:}<afn>  {du:}   { /<options> }
  119.      \         \           \
  120.       Source      Destination   Option letters
  121.  
  122. where <options> = {Q}{C}{O}
  123.  
  124. All  usage, options, and patches are identical to CRUNCH, described
  125. above, except  that no [id] can be specified and the /A mode is not im-
  126. plemented.  Also note that the the resulting filename will be recreated
  127. from the name of the file that was originally crunched.
  128.  
  129.  
  130.                 end
  131.