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