home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / comp / zipcmnt.lzh / ZIPCMNT.DOC < prev    next >
Text File  |  1990-11-16  |  5KB  |  114 lines
  1.                  ZIP FILE COMMENT ADDER AND READER 1.0
  2.                  -------------------------------------
  3.                       by William J. McBrine III
  4.  
  5.              Copyright (c) 1990 McBrine Computer Products
  6.                       May be freely distributed
  7.                           Donations welcomed
  8.  
  9. ZIPCMNT.EXE allows adding of long comments (sometimes referred to as
  10. "banners") to .ZIP files. Multiple files can be commented at once,
  11. using wildcards. CMNTREAD.EXE reads comments from zipfiles back into
  12. text files, so they can easily be reused, edited, etc.
  13.  
  14. There are other zip commenters available, but I've found they all have
  15. annoying "features" and flaws. So, I wrote my own. Here's a comparison
  16. of features with one of the most popular commenters (referred to as
  17. "the leading brand" for purposes of this document only):
  18.  
  19. ADVANTAGES OF ZIPCMNT OVER "THE LEADING BRAND"
  20.  
  21. * NO mandatory first line - e.g., "Banner by 'THE LEADING BRAND'"
  22.   - is created
  23.  
  24. * No 10-line limit - limit is 64k
  25.  
  26. * Comments are read as binary files, not text. ANY file can become a
  27.   comment, and ANSI comments work perfectly
  28.  
  29. * Program does not abort when it can't read a file, but continues on
  30.   to the next one specified by the wildcard (if used) after giving an
  31.   error message
  32.  
  33. * ZIP files are truncated when updated with shorter comments than they
  34.   already have (the leading brand leaves the extra part of the dead
  35.   comment dangling)
  36.  
  37. * ZIPCMNT program is much shorter
  38.  
  39. * Comments can be read back into text files with CMNTREAD (including
  40.   leading-brand- and other-inserted comments)
  41.  
  42. DISADVANTAGE OF ZIPCMNT
  43.  
  44. * You have to create the comment file with a seperate program (but any
  45.   will do - you could even use the leading brand for this purpose, by
  46.   stripping off an existing comment with CMNTREAD)
  47.  
  48. ----------------------------------------------------------------------
  49.  
  50. Best of all, ZIPCMNT is FREE, including the source code! There is NO
  51. REGISTRATION, but any and all DONATIONS are VERY WELCOME!
  52.  
  53. The programs are pretty straightforward and self-documenting, but a
  54. few features need additional comment:
  55.  
  56. The comment file is normally a plain text file, often including IBM
  57. graphics characters, generated by any text editor or screen-drawing
  58. program.
  59.  
  60. ANSI comments will work well with ZIPCMNT (unlike some zip commenters),
  61. and so will ANY file - even, say, an EXE - because the comment files
  62. are read as binary files rather than text files. However, ANSI will
  63. not be displayed by PKZIP/PKUNZIP unless the "-q" option is specified
  64. (on the PK command line). Otherwise the ESC codes (charcter 27) will
  65. be stripped on display. (This was apparently done to prevent ANSI
  66. sabotage of the keyboard.) CMNTREAD will not strip ESC codes.
  67.  
  68. "ZIPCMNT * cmntfile.ext" (for example) will comment all files in a
  69. directory. But wildcards cannot be used for the comment filename, nor
  70. for the ZIP filename with CMNTREAD.
  71.  
  72. Using "NUL" for the comment filename with ZIPCMNT will strip the
  73. ZIP file of any comment. "CON" will allow you to type in a comment,
  74. terminated with a ^Z (much as if you had used "PKZIP -z", but allowing
  75. multiple lines).
  76.  
  77. A "/l" can be added as the third parameter on the ZIPCMNT command
  78. line, to insert two <CR><LF> pairs before the main comment. Without
  79. this option, the first line of the comment is printed immediately
  80. following the dash after PKZIP/PKUNZIP's printing of the filename, and
  81. so gets pushed over to the right. Of course, you can edit the comment
  82. file to insert a blank line or two yourself, if needed; this option
  83. just lets you be lazy. I was lazy in implementing it, so it has to be
  84. the third parameter.
  85.  
  86. As kind of an experiment, I'm distributing this program under the "GNU
  87. General Public License". Please see the file LICENSE.DOC for an
  88. explanation of this.
  89.  
  90. The programs were compiled with Turbo Pascal 4.0 and compressed with
  91. Fabrice Bellard's LZEXE 0.91, which I cannot recommend highly enough.
  92.  
  93. There are six files that make up the package:
  94.  
  95. ZIPCMNT.DOC     This document
  96. ZIPCMNT.EXE     Zip file comment adder
  97. CMNTREAD.EXE    Zip file comment reader
  98. ZIPCMNT.PAS     Turbo Pascal 4.0 source code
  99. CMNTREAD.PAS    Turbo Pascal 4.0 source code
  100. LICENSE.DOC     GNU General Public License
  101.  
  102. Please distribute them together.
  103.  
  104. I welcome comments, suggestions and donations:
  105.  
  106. McBrine Computer Products
  107. 514 S. Jackson St.
  108. Salisbury, NC 28144-5428
  109.  
  110. Or leave E-mail to WILLIAM MCBRINE on:
  111.  
  112. HomeBoy's Digital UnderGround - (704) 637-2342  3-24 baud 24 hrs.
  113. The Big Byte                  - (704) 279-2295  3-96 baud 24 hrs.
  114.