home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / PCBOARD / PROPCK31.ZIP / PROPACK.DOC < prev    next >
Text File  |  1991-03-15  |  16KB  |  457 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                  P r o   P a c k
  9.  
  10.                  High Performance Conference Maintenance Utility
  11.                                        by
  12.                                  Samuel H. Smith
  13.  
  14.                              Version 3.0 of 03-15-91
  15.  
  16.                              From The Tool Shop BBS
  17.                                  (818) 891-6780
  18.  
  19.                                  Samuel H. Smith
  20.                                  P. O. Box 4808
  21.                            Panorama City, CA 91412-4808
  22.  
  23.  
  24.     ProPack is designed to make it quick and easy to keep your PCBoard v14
  25.     compatible conference files in top condition.  It is an indispensable
  26.     utility for systems with many large conferences or "net mail" between
  27.     boards.
  28.  
  29.     Some of the high points of ProPack include:
  30.  
  31.           *    Fast!  Runs 5 to 10 times faster than standard util-
  32.                ities.  Uses assembly language and advanced buffering.
  33.  
  34.           *    Detect and automatically delete duplicate messages.
  35.  
  36.           *    Eliminate multiple network "taglines" to reduce message
  37.                base chaos.
  38.  
  39.           *    Option to remove reader "Via" line advertisement lines.
  40.  
  41.           *    Option to remove IBM and "high-ascii" codes.
  42.  
  43.           *    Option to automatically delete .BAK file after process-
  44.                ing is successfully completed.
  45.  
  46.           *    Purge messages after they reach a specified age.
  47.  
  48.           *    Automatically limit conference size to a specified
  49.                number of active messages.
  50.  
  51.  
  52.     Copyright 1988-1991 Samuel H. Smith; All rights reserved.
  53.  
  54.     ProPack is NOT public domain software.  You may use, copy and distribute
  55.     it freely, but you MAY NOT RESELL ProPack.  A modest fee for copying may
  56.     be charged, not to exceed $3.00 exclusive of the cost of disk, mailer
  57.     and postage.
  58.  
  59.     If you like and use ProPack, I request you register the program after a
  60.     reasonable trial period (about 30-45 days).
  61.  
  62.     ----------------
  63.     PCBoard is a registered trademark of Clark Development Company.
  64.  
  65.  
  66.     ProPack is very small and lightning fast.  It is the fastest way I know
  67.     of to pack and re-index PCBoard message files.  It can pack a conference
  68.     with 1000 messages in less than a minute.  The standard PCBPACK program
  69.     takes many minutes and much disk thrashing to do the same thing.
  70.  
  71.  
  72.     High speed operation is achieved through advanced buffering techniques
  73.     and optimized assembly language in critical sections.  
  74.  
  75.     Speed is not gained through "cutting corners" or lax error checking.  
  76.  
  77.     ProPack contains extensive error checking and makes every effort to
  78.     preserve all available data -- even when the message base is already
  79.     partially corrupt.
  80.  
  81.  
  82.     ProPack will remove all "killed" messages, and will skip over older 
  83.     ones to keep the specified number of messages on file.
  84.  
  85.  
  86.     ProPack has the ability to detect and remove "duplicate" messages. This
  87.     option will remove any message that exactly duplicates the text, has the
  88.     same subject, and is from the same person as any other message.  
  89.  
  90.     This is very useful in conjunction with Qnet, Qmail, and other PCBoard
  91.     echo/message extensions.  A very fast 32-bit CRC is used to locate the
  92.     duplicates.
  93.  
  94.  
  95.     You can use batch files with ProPack.  Since you specify the full message
  96.     base filename on the command line, it will easily handle your "external"
  97.     conferences.
  98.  
  99.  
  100.     ProPack can handle message bases with as many as 15000 messages.   
  101.     Please limit your "message blocks" to 15 or less when you define   
  102.     conferences.
  103.  
  104.  
  105.     ProPack is fully integrated with the ProDoor system.  You can use
  106.     ProDoor's PROSM utility to automatically generate a batch file for event
  107.     processing using ProPack.
  108.  
  109.  
  110.     You can redirect the output of ProPack to generate a summary log file
  111.     that records status messages for unattended operation.
  112.  
  113.  
  114.     ProPack has the ability to capture the text of purged messages into
  115.     a text file for archival purposes.
  116.  
  117.  
  118.                                       USAGE
  119.                                       =====
  120.  
  121.       ProPack  MAILFILE MAXMSGS [/DEHKLRTUVX] [/Nxxx] [/Sfile]
  122.  
  123.  
  124.                                    PARAMETERS
  125.                                    ----------
  126.  
  127.      MAILFILE  Mail file d:\path\name to be packed.
  128.  
  129.      MAXMSGS   Maximum number of messages to keep, 0=no limit.
  130.  
  131.  
  132.                                      OPTIONS
  133.                                      -------
  134.  
  135.     Options can be combined without additional "/" or space characters.
  136.  
  137.      /D   Kill any message that has the same exact text, subject and from-
  138.           user as a previous message.
  139.  
  140.      /E   Exclude tag-lines and via-lines when checking for duplicate
  141.           messages.
  142.  
  143.      /H   Reset "high message number" to last message number.
  144.  
  145.           Warning: use of this option can lead to the high message number
  146.           being re-assigned to a different message, causing messages to be
  147.           "lost" under some netmail or reader software.
  148.  
  149.      /I   Remove IBM and "high-ascii" codes.  This option changes all ascii
  150.           codes greater than chr(127) to ".".
  151.  
  152.      /K   Kill .BAK file after a successful pack.
  153.      
  154.      /L   List duplicate message numbers as they are killed.
  155.  
  156.      /Nxx Kill messages over xxx days old.
  157.  
  158.      /R   Purge RECEIVED+PRIVATE messages.
  159.  
  160.      /T   Removes all but the first '* Origin' tagline generated by Qnet,
  161.           PCRelay, or other netmail systems.
  162.  
  163.      /Sfn Capture purged message texts into the text file 'fn'.  If this
  164.           file already exists, the text will be appended.  Otherwise a
  165.           new file will be created.
  166.  
  167.      /U   Always keep UN-RECEIVED+ PRIVATE messages regardless of other
  168.           options.  Keep any message that is PRIVATE but has not been
  169.           received, even if it is old and would normally be purged.
  170.  
  171.      /V   Remove '* Via' lines generated by alternate readers such as
  172.           ProDoor, Qmail, EZ-rdr, RelayMail, etc.
  173.  
  174.      /W   Preserve the two-line format in "PCRelay:" taglines. The default
  175.           (when /T is used) is to keep only the first of  the two lines.
  176.  
  177.      /X   List message texts during packing.  The listing may  include line
  178.           markers for the "Tear", "Via" and "Tag" line components of a
  179.           message.  This display is used in debugging to help locate the
  180.           reason for message duplication.
  181.  
  182.  
  183.  
  184.  
  185.                                     EXAMPLES
  186.                                     ========
  187.  
  188.     ProPack c:\pcb\main\msgs 1000
  189.  
  190.           Pack the main board, leaving no more than 1000 active messages.
  191.  
  192.  
  193.     ProPack \pcb\tools\tools 500 /D /L
  194.  
  195.           Pack the "tools" conference, deleting all duplicates and leaving no
  196.           more than 500 active messages.
  197.  
  198.  
  199.     ProPack \pcb\sysops\sysops 14000 /D /R
  200.  
  201.           Pack the "sysops" conference, deleting all duplicates, all
  202.           RECEIVED+PRIVATE messages, and leaving no more than 14000 active
  203.           messages.
  204.  
  205.  
  206.     ProPack \pcb\ibm\ibm 500 /DLN180T
  207.  
  208.           Pack the "IBM" conference, deleting and listing all duplicates,
  209.           leaving no more than 500 active messages, deleting messages over
  210.           180 days old, and removing multiple "origin" tag lines.  Notice
  211.           that options can be combined without extra "/" characters or
  212.           spaces.
  213.  
  214.  
  215.     ProPack \pcb\ibm\ibm 100 /DLN180T /S\pcb\ibm\ibm.sav
  216.  
  217.           Pack the "IBM" conference, as in the previous example, but
  218.           will also save the text of the purged messages in the file
  219.                 \pcb\ibm\ibm.sav
  220.           for archival purposes.
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.                                 EXAMPLE EVENT.SYS
  229.                                 -----------------
  230.  
  231.     rem PackAll.BAT generated by ProSM
  232.     echo off
  233.     tm "Packall Started" >>PACKALL.LOG
  234.  
  235.     ProPack C:\PCB\MAIN\MSGS 800 /eltn360k >>PACKALL.LOG
  236.     if errorlevel 1 goto exit
  237.  
  238.     ProPack C:\PCB\TOOLS\TOOLS 250 /eltn180k >>PACKALL.LOG
  239.     if errorlevel 1 goto exit
  240.  
  241.     ProPack C:\PCB\SUPPORT\SUPPORT 800 /eltn360k >>PACKALL.LOG
  242.     if errorlevel 1 goto exit
  243.  
  244.     ProPack C:\PCB\AI\AI 100 /eltn180k >>PACKALL.LOG
  245.     if errorlevel 1 goto exit
  246.  
  247.     ProPack C:\PCB\ST\ST 100 /eltn360k >>PACKALL.LOG
  248.     if errorlevel 1 goto exit
  249.  
  250.     ProPack C:\PCB\IBM\IBM 300 /eltn90k >>PACKALL.LOG
  251.     if errorlevel 1 goto exit
  252.  
  253.     ProPack C:\PCB\PHOTO\PHOTO 100 /eltn180k >>PACKALL.LOG
  254.     if errorlevel 1 goto exit
  255.  
  256.     ProPack C:\PCB\SYSOPS\SYSOPS 100 /eltn180k >>PACKALL.LOG
  257.     if errorlevel 1 goto exit
  258.  
  259.     ProPack C:\PCB\SMARTNET\SMARTNET 100 /eltn90k >>PACKALL.LOG
  260.     if errorlevel 1 goto exit
  261.  
  262.     ProPack C:\PCB\INTRLINK\INTRLINK 100 /eltn90k >>PACKALL.LOG
  263.     if errorlevel 1 goto exit
  264.  
  265.     ProPack C:\PCB\TELIX\TELIX 100 /eltn90k >>PACKALL.LOG
  266.     if errorlevel 1 goto exit
  267.  
  268.     ProPack C:\PCB\QMODEM\QMODEM 100 /eltn90k >>PACKALL.LOG
  269.     if errorlevel 1 goto exit
  270.  
  271.     ProPack C:\PCB\ADA\ADA 1000 /eltk >>PACKALL.LOG
  272.     if errorlevel 1 goto exit
  273.  
  274.     :exit
  275.     echo. >>PACKALL.LOG
  276.     tm "Packall Ended" >>PACKALL.LOG
  277.     echo ---------- >>PACKALL.LOG
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.                                  ERROR MESSAGES
  287.                                  ==============
  288.  
  289.     Error: Missing command line parameters
  290.  
  291.           You must always specify the conference file to be packed and the
  292.           maximum number of messages to store in the conference.  If you
  293.           leave off either of these parameters you will get this error
  294.           message along with a summary of the command format and options.
  295.  
  296.  
  297.     Error: Invalid digit in "MAXMSGS" parameter
  298.  
  299.           Following the conference file name you must always specify the
  300.           maximum number of messages to store in the conference.  This error
  301.           usually indicates that you forgot to include the number of messages
  302.           and instead entered one of the command options.
  303.  
  304.  
  305.     Error: Unknown option: ____
  306.  
  307.           This error means that you are using a command line option that is
  308.           not recognized by the program.
  309.  
  310.  
  311.     Error: Cant open index file
  312.  
  313.           ProPack requires that an index file be present for each message
  314.           file being packed.  If you are creating a new conference, or if you
  315.           have lost your index file, please use ProDoor's PROSM program to
  316.           create a new one.
  317.  
  318.  
  319.     Error: Cant open message file
  320.      
  321.           Please check that you are specifying the proper full path and file
  322.           name for the conference you with to pack.  This error might also
  323.           indicate that the message file is in use by another program that
  324.           requires exclusive access to the same file.  Network systems should
  325.           insure that all nodes are offline before attempting to pack a
  326.           conference file.
  327.  
  328.  
  329.     ProPack Aborted.  Reason: Could not rename _________ to ________
  330.  
  331.           After packing is completed, ProPack attempts to rename the original
  332.           message file to 'name.BAK', and then to rename the newly packed
  333.           file to 'name'.  Rename failure usually indicates that the original
  334.           file is in use by another program.  Network systems should insure
  335.           that all nodes are offline before attempting to pack a conference
  336.           file.
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.     ProPack Aborted.  Reason: Write failure - disk full or bad sector
  346.  
  347.           This error is reported when DOS reports an error while writing to
  348.           the new conference file.  It usually indicates that the disk is
  349.           too full to hold the original message file plus the new file, or
  350.           that there is a bad sector that prevented the file from being
  351.           written.  
  352.  
  353.  
  354.     ProPack Aborted.  Reason: Index too large - decrease index blocks
  355.  
  356.           Index files should be 64k or smaller.  ProPack loads the entire
  357.           index into memory for the fastest operation possible.  If you are
  358.           using very large index files you need to reduce them to 15 or
  359.           fewer blocks using ProDoor's PROSM utility.
  360.  
  361.  
  362.     ProPack Aborted.  Reason: Index file overflow - increase index blocks
  363.  
  364.           Each index file must be allocated large enough to have one entry
  365.           for each message number between the lowest message and the highest
  366.           message in a conference.  Index file sizes are *NOT* based on the
  367.           number of active messages - rather the size is based on the size of
  368.           the range of valid message numbers.  
  369.  
  370.  
  371.     ProPack Aborted.  Reason: CRC table overflow - delete .CRC file and rerun
  372.  
  373.           This error indicates that the .CRC file used for duplicate message
  374.           detection has grown beyond the limits of the program.  ProPack
  375.           allocates room for 15000 total messages in the CRC file.  After
  376.           processing this many messages you may have to manually delete the
  377.           'name.CRC' file and let ProPack rebuild it from scratch.
  378.  
  379.      Please note that it is normal for ProPack to leave a .CRC file in the
  380.      same directory as the message file.  This small file contains informa-
  381.      tion on present and past messages that makes it possibly to quickly
  382.      determine if a new message is unique or a duplicate.  
  383.  
  384.      If you delete the .CRC file it will slow down program operation because
  385.      it must then look at each and every message to check for duplication.
  386.  
  387.  
  388.  
  389.                                   ERROR LEVELS
  390.                                   ============
  391.  
  392.     ProPack returns with ERRORLEVEL set to 0 after a successful pack.  If any
  393.     error occurred during the pack ERRORLEVEL will be set to 1.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.                                      SUPPORT
  402.                                      =======
  403.  
  404.     I work very hard to produce a software package of the highest quality and
  405.     functionality.  I try to look into all reported bugs, and will generally
  406.     fix reported problems within a few days.
  407.  
  408.     Since this is user supported software under the ShareWare concept, I
  409.     don't expect you to contribute if you don't like it or if it doesn't meet
  410.     your needs.
  411.  
  412.     If you have any questions, bugs, or suggestions, please contact me at the
  413.     Tool Shop BBS, (818) 891-6780.
  414.  
  415.     The latest version is always available for downloading.
  416.  
  417.  
  418.                                      LICENSE
  419.                                      =======
  420.  
  421.     This package is NOT public domain software.  You may use, copy and
  422.     distribute it freely, but you MAY NOT RESELL the program.  A modest fee
  423.     for copying may be charged, not to exceed $3.00 exclusive of the cost of
  424.     disk, mailer and postage.
  425.  
  426.     If you like and use this program, I request you register it for $15
  427.     after a reasonable trial period (about 30-45 days).
  428.  
  429.     Please see REGISTER.FRM for additional registration information.
  430.  
  431.  
  432.     Send your registration check or money order to:
  433.  
  434.          Samuel H. Smith
  435.          The Tool Shop
  436.          P. O. Box 4808
  437.          Panorama City, CA 91412-4808
  438.  
  439.  
  440.  
  441.  
  442.                                    DISCLAIMER
  443.                                    ==========
  444.  
  445.      IN NO EVENT WILL I BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST
  446.      PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES
  447.      ARISING OUT OF YOUR USE OR INABILITY TO USE THE PROGRAM, OR FOR ANY
  448.      CLAIM BY ANY OTHER PARTY.
  449.  
  450.  
  451.                                 REVISION HISTORY
  452.                                 ================
  453.  
  454.                       See PROPACK.NEW for complete revision history.
  455.  
  456.  
  457.