home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / pcboard / pcbwrap.zip / PCBWRAP.DOC < prev    next >
Text File  |  1993-07-14  |  7KB  |  163 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                     PCBWrap
  7.                  Free DOS utility: PCBoard filelist reformatter
  8.                           Version 1.00 - July 14, 1993
  9.                                     (c) 1993
  10.                                        by
  11.                              David Daniel Anderson
  12.                                    Reign Ware
  13.  
  14.  
  15.  
  16.  
  17.  
  18. PCBWrap reformats downloaded PCBoard directory list "short" (45 character)
  19. description lines into "long" (79 character) lines.
  20.  
  21. WARNING!!! PCBWrap OVERWRITES THE INPUT FILE, SO MAKE SURE THAT YOU EITHER WORK
  22. ON A COPY OF YOUR FILES OR YOU KNOW WHAT YOU ARE DOING BEFORE YOU START.
  23. (If you want them to be reformatted as they originally were, use the following
  24. command [without the quotes]: "PCBWrap filename 31:1", which is very close.)
  25.  
  26. In scanned or downloaded PCBoard directory lists, after the first line of each
  27. file's name/ size/ date/ description, all subsequent descriptor lines for that
  28. filename have a left margin of 33.  PCBWrap will decrease that to as little as
  29. three (" | ").  After the reformatting process, the lists will typically be
  30. *at least* 20% smaller.  PCBWrap processes about 1 meg/ minute on my 386sx-20
  31. with a 120mb/15ms hard drive and 386MAX/Super PC-Kwik managing 8 megs RAM.
  32.  
  33. Usage:  PCBWrap file(s)_to_wrap [left_margin[:padding] (1..31, default = 1:1)]
  34.  
  35. PCBWrap takes up to two parameters on the command line. The first is mandatory.
  36. This is the filename (or names), which can include the DOS wildcards of "*"
  37. and "?" (e.g. dos*.*).  The second, which is optional, is the left margin
  38. specification.  Note: the left margin itself is composed of at least one space,
  39. the "|" character, and at least one more (padding) space.  Therefore, the
  40. numbers in the second parameter signify how many spaces precede and follow
  41. the "|" character (the sum must not exceed 32).  However, you must use a
  42. *colon* in the command line, since the "|" character is the DOS piping symbol.
  43.  
  44. Thus, the description for SHEZ90A.ZIP was changed from the first to the
  45. second by specifying:  "PCBWrap uploads", and to the third by specifying:
  46. "PCBWrap uploads 12:10".
  47.  
  48.  
  49. SHEZ90A.ZIP    233995  05-13-93  SHEZ v9.0A - ASP - The Premier Compression
  50.                                  Shell. Supports ZIP,LHA,ZOO,ARC,ARJ,SQZ,PAK
  51.                                  Completely redesigned mouse support. Other
  52. new
  53.                                  options. Debugged new release Uploaded by Jim
  54.                                  Derr
  55.  
  56. SHEZ90A.ZIP    233995  05-13-93  SHEZ v9.0A - ASP - The Premier Compression
  57.  | Shell. Supports ZIP,LHA,ZOO,ARC,ARJ,SQZ,PAK Completely redesigned mouse
  58.  | support. Other new options. Debugged new release Uploaded by Jim Derr
  59.  
  60. SHEZ90A.ZIP    233995  05-13-93  SHEZ v9.0A - ASP - The Premier Compression
  61.             |          Shell. Supports ZIP,LHA,ZOO,ARC,ARJ,SQZ,PAK Completely
  62.             |          redesigned mouse support. Other new options. Debugged
  63.             |          new release Uploaded by Jim Derr
  64.  
  65.  
  66. NOTE!: PCBWrap will also AUTOMATICALLY remove the "Uploaded by:..." and
  67. "Files:..." lines which PCBoard adds.  However, you can override this
  68. by SETting [DOS env. var.] "nostrip=true".
  69. (At the "C:\" prompt type "set nostrip=true" - without the quotes.)
  70.  
  71. ===============================================================================
  72.  
  73. PCBWrap is similar in function to Jim Robeson's COPYDESC v1.02, but more
  74. powerful *and* smarter.  I have collected his statements about COPYDESC below,
  75. and follow each with comments about how PCBWrap compares.
  76.  
  77. Features of COPYDESC:
  78. [by Jim Robeson; The Cricket BBS, Pacific Grove CA,  408-373-3773]
  79.  
  80.  1) converts short lines to long lines
  81. >>> PCBWrap ditto.
  82.  
  83.  2) adjustable positioning of
  84.    2a) new text by the user
  85. >>> PCBWrap ditto.  [I handled this somewhat differently.]
  86.  
  87.    2b) '|' character by the user
  88. >>> PCBWrap ditto.  [I handled this somewhat differently.]
  89.  
  90.  3) The program is free.
  91. >>> PCBWrap ditto.  [I can't imagine charging for it either.]
  92.  
  93.  4) includes Turbo C source.
  94. >>> PCBWrap includes PASCAL (BP7) source.  [It's all I know, but it works.]
  95.  
  96.  5) parses the text so everything fits properly
  97. >>> PCBWrap ditto.  [Removes existing preceding "|" characters and spaces.]
  98.  
  99.  6) packs the text so everything fits properly
  100. >>> PCBWrap ditto.  [Multiple spaces are changed to single spaces.]
  101.  
  102.  7) It might work in the PCBTEST environment, but I haven't tested it that way.
  103. >>> PCBWrap ditto.  [I don't have a clue as to what this is.]
  104.  
  105.  8) "I do know that it stuffs blanks between split-line hyphenated words.
  106.       Since that doesn't bother me, consider that "by design". <g>"
  107. >>> PCBWrap is smarter, and does *not* stuff the blanks.  [It did bother me.]
  108.  
  109.  9) Also, it might try to compress unique separator lines.
  110. >>> PCBWrap shouldn't, due to the extensive validating it does.
  111.  
  112. 10) The test for the "first-line" of a description includes:
  113.    10a) a numeric in column 21,
  114. >>> PCBWrap is more thorough, by testing for a 7-digit numeric value (the
  115.     filesize) ending in column 21.  If it is less than 7-digits, it can only
  116.     be preceded by spaces.
  117.  
  118.    10b) a '-' in each of 26 & 29,
  119. >>> PCBWrap ditto.  PCBWrap also checks for spaces in columns 22 and 23
  120.     (between the filesize and filedate).
  121.  
  122.    10c) and an "acceptable" DOS filename character in column 1.
  123.         the '&' is not acceptable
  124.         no lower case alpha allowed ....
  125. >>> PCBWrap accepts *any* non-space character in column 1.  More flexible,
  126.     but not necessarily good.  For my purposes, it is preferable.
  127.  
  128. 11) description data in line one is NOT re-packed, it is taken as-is.
  129. >>> PCBWrap is smarter, and does repack all information in line one - after
  130.     column 33.
  131.  
  132. 12) Words might get added to line 1
  133. >>> PCBWrap ditto.  This is what both of these programs are supposed to do,
  134.     squeeze more text on each line.
  135.  
  136. 13) If run without arguments, a bit of help appears.
  137. >>> PCBWrap ditto, PCBWrap also will show help related to specific errors.
  138.  
  139. 14) "This version will blow up if more than 39-40 lines are found in
  140.      any single file description.  If a "hang" is experienced, check
  141.      the input file for really long descriptions.  You could lower the
  142.      number of lines!  If I continue to modify this, I will add a test
  143.      for this condition.  Meanwhile, now you know too!"
  144. >>> PCBWrap is smarter, and can handle descriptions containing *any* number
  145.     of lines.
  146.  
  147. 15) As lines are being read into the buffer, test for buffer overrun.
  148.      If yes, spit out a message, pack what we have, and treat the remainder
  149.      of that set as comment lines.
  150. >>> PCBWrap is smarter, and can handle descriptions containing *any* number
  151.     of lines.  It does not need a buffer, but processes the lines dynamically.
  152.  
  153. 16) Is a column 79 blank [added] in some cases, and if so, is that bad?
  154. >>> PCBWrap *never* adds blanks, and never writes lines with leading or
  155.     trailing whitespace.
  156.  
  157. Finally, as stated before, PCBWrap will also optionally remove the "Files:..."
  158. and "Uploaded by:..." lines while reformatting the file, which is a feature
  159. not included in COPYDESC.
  160.  
  161. All this in just over half the bytes!
  162.  
  163.