home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-385-Vol-1of3.iso / z / zl2b0103.zip / RECOM105.ZIP / RECOM105.DOC < prev   
Text File  |  1990-04-27  |  10KB  |  230 lines
  1.  
  2.  
  3.  
  4.         ReComment - a .ZIPfile Comment Processor               4/27/90
  5.         Version 1.05 - Copyright 1990, Michael C. Loewen
  6.         -----------------------------------------------------------------
  7.            ReComment is a utility which allows you process .ZIP file
  8.         comments, in a manner which is particularly useful to BBS
  9.         operators.  I wrote this program to replace a somewhat cumbersome
  10.         procedure on my BBS, involving removing/replacing .ZIP comments
  11.         and timestamping, which was being performed by several different
  12.         utilities.  ReComment allows me to perform all these operations
  13.         in 1 step, while also allowing me to log .ZIP comments to a file
  14.         for later viewing.  With more and more sysops adding comments to
  15.         the .ZIP files on their systems, it's interesting to note from
  16.         where the files uploaded to your system are coming.
  17.  
  18.         ReComment allows you to perform the following operations on
  19.         a .ZIP file:
  20.  
  21.         1. Remove a comment from a .ZIP.
  22.         2. Add a comment to a .ZIP with no existing comment.
  23.         3. Substitute a new comment for an existing comment.
  24.         4. Copy comments to a logfile, for later inspection.
  25.         5. Change the .ZIP timestamp to that of the most recent file
  26.         within the .ZIP.
  27.  
  28.                               Command Line Options
  29.                              ----------------------
  30.  
  31.         -n
  32.              do NOT remove existing comment.  This option overrides -s.
  33.  
  34.         -o
  35.              Change .ZIP file timestamp to that of the most recent file
  36.              within the .ZIP
  37.  
  38.         -l LOGFILE
  39.              Log existing comments to a text file, LOGFILE.  Comments are
  40.              appended to an existing file, or a new file is created if
  41.              the specified file does not exist.
  42.  
  43.         -s COMMENTFILE
  44.              Substitute (add) a comment contained in COMMENTFILE to
  45.              the .ZIP.  If there is no existing comment in the .ZIP, the
  46.              new comment is added.  If there IS an existing comment, it
  47.              is replaced.  COMMENTFILE may be created with any ASCII or
  48.              ANSI editor.  Note: if the replacement comment is the SAME
  49.              as the old comment, it will not be replaced or logged.
  50.  
  51.            You can use wildcards on the command line for the .ZIP files.
  52.         Command line options may be used in any order, with the following
  53.         restrictions:
  54.  
  55.         1. If -l is used, the log file name must follow it.
  56.         2. If -s is used, the comment file name must follow it.
  57.         3. The first argument which does not begin with a '-' is assumed
  58.         to be a .ZIP filename, along with everything following it.
  59.  
  60.  
  61.  
  62.                                 Program Defaults
  63.                                __________________
  64.  
  65.            Program operation defaults to that of a simple comment
  66.         stripping utility:
  67.  
  68.         1. Remove existing comment.
  69.         2. Do not log comments.
  70.         3. Maintain the .ZIP file timestamp.
  71.  
  72.                            Environment Variable RECOM
  73.                           ----------------------------
  74.  
  75.            If you prefer, you can specify a default set of options in an
  76.         environment variable, RECOM.  Set RECOM equal to the options you
  77.         wish to use, exactly as you would use them on the command line,
  78.         with one restriction: you may not specify .ZIP files in the RECOM
  79.         variable.  Note: if you elect to use the RECOM variable, and also
  80.         specify the same options on the command line, the command line
  81.         options will override the variable settings.
  82.  
  83.            Please note that ReComment does NOT process comments attached
  84.         to individual files within the .ZIP: it only works with comments
  85.         attached to the end of the .ZIP.  Also, ReComment does not, at
  86.         this time, support self-extracting .ZIP files.  This will be
  87.         implemented in a later version.
  88.  
  89.                                     Examples
  90.                                    __________
  91.  
  92.            ReComment allows a certain flexibility in its operation, by
  93.         using the options in various combinations.  Some examples are:
  94.  
  95.         Command Line                            Operation
  96.  
  97.         recom *.zip                   Removes comment, maintains .ZIP
  98.                                       timestamp.
  99.  
  100.         recom -o *.zip                Removes comment, sets .ZIP
  101.                                       timestamp to most recent file
  102.                                       in .ZIP.
  103.  
  104.         recom -n -o *.zip             Changes .ZIP timestamp, only.
  105.  
  106.         recom -l logfile *.zip        Remove comment, log it to logfile.
  107.  
  108.         recom -s cfile *.zip          Replace comment.
  109.  
  110.         recom -l logfile -s cfile *.zip
  111.                                       Replace comment, log old comment.
  112.  
  113.         recom -n -l logfile *.zip     Log existing comment, do not
  114.                                       remove.
  115.  
  116.  
  117.  
  118.                                     BBS Hints
  119.                                    -----------
  120.  
  121.            ReComment can be used on a BBS in several ways.  On my system
  122.         (PCBoard 14.2), with ProDoor 3.1, I made an entry in the
  123.         PROUTEST.BAT file, to automatically process .ZIP files when they
  124.         are uploaded.  Such an entry might look like this:
  125.  
  126.         rem -- replace comments in uploads; RECOM is from RECOM105.ZIP
  127.         chkpath recom %0 >>%1
  128.         recom -o -s c:\pcb\icslabel -l c:\pcb\cmntfile %2\*.zip >>%1
  129.  
  130.            An alternative, and possibly more useful method, would be to
  131.         make an entry in your EVENT.SYS file, to process your upload
  132.         directory on a daily basis.  This entry might look like this:
  133.  
  134.         recom -o -s c:\pcb\icslabel -l c:\pcb\cmntfile c:\upload\*.zip
  135.  
  136.  
  137.                               Software Availability
  138.                              -----------------------
  139.  
  140.            The latest version of this software is available on several
  141.         systems, among them:
  142.  
  143.         The ICS Round Table - State College, PA  (814) 231-2568
  144.         The Magnetic Bottle - State College, PA  (814) 231-1345
  145.  
  146.            I can be reached (Mike Loewen) on either of these systems for
  147.         questions, comments, suggestions, etc..  I can also be reached
  148.         through the RIME (RelayNet International Message Exchange)
  149.         Shareware conference.
  150.  
  151.            Many thanks to Bill Mertens, sysop of the Magnetic Bottle, for
  152.         testing the software and his many helpful suggestions, and to
  153.         Frank Maczaczyj, sysop of the Random Access BBS (814-371-5881)
  154.         for his help in testing.
  155.  
  156.            If you find this program to be useful, any contributions will
  157.         certainly be welcome, in order to support the continued
  158.         development of this, and other software.  Contributions may be
  159.         sent to:
  160.  
  161.                                 Michael C. Loewen
  162.                                 RD4, 461 Plum St.
  163.                               Bellefonte, PA  16823
  164.  
  165.  
  166.            I strive to develop a quality product, and I believe that this
  167.         software is fully functional as stated in the documentation.
  168.         However, it is not possible to test the software in all
  169.         situations, and there may be something lurking deep down which
  170.         might surface unexpectedly.  Should you discover a defect in the
  171.         program, please contact me on the ICS Round Table, so that I
  172.         might correct the problem.
  173.  
  174.  
  175.  
  176.  
  177.                                  Version History
  178.                                 -----------------
  179.  
  180.         1.04 (03/25/90) - initial public release.
  181.  
  182.         1.05 (04/27/90) - bug fix.  Changed the manner in which comments
  183.         and log files are searched for CTRL-Z characters: comments with
  184.         multiple CTRL-Zs were sneaking through.  Also found a logic flaw
  185.         which would cause ReComment to ignore a request for timestamp
  186.         change in .ZIP files with no comment attached.
  187.  
  188.            Now, for the legal stuff:
  189.  
  190.                                    Disclaimer:
  191.                                 -----------------
  192.            The author makes no warranties, expressed or implied, as to
  193.         the quality or performance of this program.  Your use of this
  194.         program constitutes your release of the author from liability or
  195.         litigation for any indirect or consequential damages arising from
  196.         the use of this program or its associated files.
  197.  
  198.            In no event will I be liable to you for any damages, including
  199.         any lost profits, lost savings or other incidental or
  200.         consequential damages arising out of your use of inability to use
  201.         the program, or for any claim by any other party.
  202.  
  203.                                 Copyright/License
  204.                                -------------------
  205.         This document and the program file RECOM.EXE ("the software") are
  206.         copyrighted by the author.  The copyright owner hereby licenses
  207.         you to:
  208.  
  209.         1. use the software;
  210.         2. make as many copies of the program and documentation as you
  211.         wish;
  212.         3. give such copies to anyone;
  213.         4. distribute the software and documentation via electronic
  214.         means.
  215.  
  216.            No fee may be charged for this software, beyond the cost of
  217.         the media.  Also, the software may NOT be distributed as part of
  218.         any software package for sale, unless specific permission is
  219.         first obtained in writing from the author.
  220.  
  221.            Your use of the program constitutes your acceptance of the
  222.         terms and conditions stated above.  No copy of the software may
  223.         be distributed or given away without this document, and this
  224.         notice must not be removed.
  225.  
  226.         -----------------------------------------------------------------
  227.  
  228.         ReComment - a .ZIPfile Comment Processor               4/27/90
  229.         Version 1.05 - Copyright 1990, Michael C. Loewen
  230.