home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / com / utils / catqwk / catqwk.doc < prev    next >
Encoding:
Text File  |  1992-02-09  |  8.0 KB  |  183 lines
  1.                               CatQWK 2.20
  2.                            by Patrick Y. Lee
  3.                             February 9, 1992
  4.                           Copyright 1991-1992
  5.  
  6. New in version 2.20:
  7.  
  8.     2.2     09 Feb 1992     Second public release
  9.  
  10.     -   Added routine to make the PERSONAL.NDX file (be sure to add the
  11.         line PERSONAL=Your Name in your CatQWK.CFG file)
  12.     -   Fixed index file routine to work properly for conferences > 999
  13.         and > 9999
  14.     -   Remove line that extracts *.PTR and *.PNT file because some
  15.         archiver (LHA to be specific) does not generate the correct
  16.         ERRORLEVEL return code upon this kind of error condition
  17.  
  18. CatQWK is distributed as-is.  You are using this program at your own
  19. discretion.  The author assumes no responsibilities for damages either
  20. from the direct use of this product or as a result of the use of this
  21. product.  Warranty of any kind is neither implied nor expressed here.
  22.  
  23. This product is the copyrighted work of the author, with portions copy-
  24. righted by Borland International.  You may use this program under any
  25. kind of environment so you choose.  There is no monetary charge for this
  26. program.
  27.  
  28. CatQWK - Concatenate QWK files - `Cat' is borrowed from the Unix (tm)
  29. command `cat'.  This program will combine two or more QWK files from the
  30. same BBS together into one.  This allows you to follow threads easily.
  31. I wrote this program originally because when I am behind in reading, and
  32. have half a dozen QWKs for each BBS around, reading messages in subject
  33. order is crucial so I won't waste time replying to messages others
  34. have answered already.
  35.  
  36. Syntax:
  37.  
  38.     catqwk [-dpath] newname oldqwk1 [oldqwk2 oldqwk3 ...]
  39.  
  40.     [-dpath]    This parameter is optional.  It allows you to overwrite
  41.                 the work path specified in the configuration file (see
  42.                 below).  This program requires two work directories to
  43.                 be used.  The directories will be created below the work
  44.                 path.
  45.  
  46.     newname     This is the name of the new, concatenated, QWK file.
  47.                 Obviously, you must include this to run the program.  If
  48.                 no file extension is entered, it will be assumed to be
  49.                 QWK.
  50.  
  51.     oldqwk?     This is the separate QWK files you want to combine
  52.                 together to make a bigger one.  You may either list each
  53.                 individual file by its name, or use standard DOS
  54.                 wildcard to specify them.  Anyone wildcards found will
  55.                 be expanded to the full name of the files before
  56.                 running.  CatQWK does not check to see if the QWKs are
  57.                 from the same BBS.  That is your job!
  58.  
  59.     The default compression and decompression program used is PKZIP from
  60.     PKWare.
  61.  
  62.     The default work directories are created in the current directory.
  63.  
  64.     You may change these defaults by creating a file named CATQWK.CFG.
  65.  
  66.     When an error occurs, the contents of the work directories will be
  67.     left as-is.  The files in there are not deleted.  You will have to
  68.     delete the files manually and remove the directories when an error
  69.     occurs.  CatQWK will not run if the work directories (!!!work.new
  70.     and !!!work.old) already exist.  This last item is to ensure CatQWK
  71.     will not be overwriting or deleting existing files.
  72.  
  73.     The CONTROL.DAT file, which contains the names of the conferences,
  74.     is extracted from the last mail packet processed.  Therefore, you
  75.     may want to arrange so that the latest mail packet combined is
  76.     listed last.  That will make sure you have the latest changes to the
  77.     conferences on the BBS.  None of the other files (NEWFILES.DAT
  78.     listing, WELCOME screen, bulletins, etc.) are saved.
  79.  
  80. Configuration file:
  81.  
  82.     This file may appear:
  83.  
  84.         - in the current directory
  85.         - pointed to by the environment variable CATQWK
  86.         - somewhere on your PATH
  87.  
  88.     For example, to set the environment variable CATQWK, type:
  89.  
  90.         SET CATQWK=C:\COMM
  91.  
  92.     either at the DOS prompt or as part of a batch file.  The file
  93.     itself needs only three lines.  You do not need them all, the
  94.     missing ones will retain their default values.  The four commands
  95.     are:
  96.  
  97.         WORKPATH=D:\
  98.         COMPRESS=PKZIP.EXE -m
  99.         DECOMPRESS=PKUNZIP.EXE -o
  100.         PERSONAL=My Name
  101.  
  102.     The WORKPATH may or may not end with a trailing backslash.  It does
  103.     not matter, CatQWK will figure that out and construct the work paths
  104.     properly.  Case is irrelevant.  You may put any amount of spaces or
  105.     tabs in front or after the equal sign.
  106.  
  107.     Note that you must include the extension for the compress and
  108.     decompress programs as well.  You may specify an absolute path to
  109.     these programs, otherwise, the PATH will be searched to locate them.
  110.     Also note that the options must be set for "move" for compress
  111.     program and "overwrite existing file" for the decompression program.
  112.     Examples are included for ARJ and LHA below:
  113.  
  114.         ARJ:    COMPRESS=ARJ.EXE m
  115.                 DECOMPRESS=ARJ.EXE e -y
  116.  
  117.         LHA:    COMPRESS=LHA.EXE m
  118.                 DECOMPRESS=LHA.EXE e -cm
  119.  
  120.     The PERSONAL line is used to create the PERSONAL.NDX file.  By
  121.     including a name here, all messages addressed to this user will be
  122.     included in the PERSONAL.NDX file.  This file is used by readers to
  123.     flag messages addressed to you.  The readers will allow you to read
  124.     messages in here first.  If you don't include a name here, the
  125.     PERSONAL.NDX file will not be created.
  126.  
  127. Last words:
  128.  
  129.     Some readers, such as Session Manager (by Patrick W. Hart), requires
  130.     the mail packet be placed in conference order.  (This is the way
  131.     PCBoard mail doors work.)  However, doing such with this program
  132.     will be painfully slow.  What this program does is simply concate-
  133.     nate the mail files together, stripping the header and any trailing
  134.     garbage, and recreate the index files.  Fortunately, Session Manager
  135.     has a command line switch to change this characteristic of the pro-
  136.     gram.  The user needs to use the "/tc" parameter when starting the
  137.     program.  This will tell SM to not expect the message file in con-
  138.     ference order.
  139.  
  140.     Comments, bug reports, etc. are welcomed.  I follow the Off-line
  141.     Readers conference on RIME, ILink, and Intelec.  I can also be
  142.     reached in the Common conference of RIME.  Happy off-line reading!
  143.  
  144.     I would like to thank the users of AMI BBS (run by Walter Tsin) in
  145.     New York for playing with the program, trying to find bugs, as well
  146.     as offer suggestions.  I would also like to thank Jason Hills of
  147.     Alpine BBS in Oregon for trying to break the program.  [grin]
  148.  
  149. Version history:
  150.  
  151.     1.0                     Can't seem to find this one
  152.     1.1     17 Mar 1991     Never released
  153.     1.2     31 Mar 1991     Never released
  154.     1.3     15 Aug 1991     Never released
  155.     1.4     29 Nov 1991     Never released
  156.  
  157.     2.0     22 Dec 1991     Limited testing
  158.  
  159.     -   Added configuration file
  160.     -   Added support for other archive programs
  161.     -   Much improved speed
  162.  
  163.     2.1ß    01 Jan 1992     Limited testing
  164.  
  165.     -   Added support for wildcards [920101]
  166.     -   Moved documentation from the help screens to this file [920110]
  167.     -   Create the documentation [920110]
  168.     -   Changed some duplicate code into function or procedures.  This
  169.         resulted in a smaller EXE file (shrank the file by about 3K).
  170.         [920111]
  171.  
  172.     2.1     13 Jan 1992     First public release
  173.  
  174.     2.2     09 Feb 1992     Second public release
  175.  
  176.     -   Added routine to make the PERSONAL.NDX file (be sure to add the
  177.         line PERSONAL=Your Name in your CatQWK.CFG file)
  178.     -   Fixed index file routine to work properly for conferences > 999
  179.         and > 9999
  180.     -   Remove line that extracts *.PTR and *.PNT file because some
  181.         archiver (LHA to be specific) does not generate the correct
  182.         ERRORLEVEL return code upon this kind of error condition
  183.