home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / vrac / t_pack.zip / T-PACK.DOC < prev    next >
Text File  |  1994-09-01  |  15KB  |  324 lines
  1.                            T-Pack v1.0
  2.                   Copyright 1994, Sergey Polak
  3.  
  4.  
  5.                            DISCLAIMER
  6.  
  7.      This program and other files associated with it are NOT
  8. guaranteed to be bug free or virus free.  I am not responsible for
  9. damages of any kind, including profit losses and data losses, that
  10. relate directly or indirectly to these programs and files.
  11.  
  12.                    DISTRIBUTION OF THE PROGRAM
  13.  
  14.      You are free to distribute the program as long as you include
  15. all the files in the archive in their original format.
  16.  
  17.                          WHAT IS T-PACK?
  18.  
  19.      T-Pack is a handy-dandy little program that'll pack your
  20. Telegard 2.7 message bases.  It is intended as a replacement for
  21. both the internal Telegard packer (which is said to be unreliable)
  22. and for the MSGPACK program from the Telegard Sysop Utilities
  23. package.
  24.  
  25.                           REQUIREMENTS
  26.  
  27.      In order for T-Pack to run you must have:
  28.  
  29.      - DOS 3.3 or above or a compatible operating system
  30.      - Telegard 2.7
  31.      - At least 100k of conventional (under 640K) memory free (the 
  32.        more, the better)
  33.  
  34.                             FEATURES
  35.  
  36.      Powerful message base selection commands allow you to select
  37.      all message bases for packing, select bases by giving the
  38.      program a list of message base numbers, a range or a
  39.      combination of the above.
  40.  
  41.      T-Pack can be significantly faster than MSGPACK on certain
  42.      systems.
  43.  
  44.      T-Pack has the ability to fix damaged message bases,
  45.      preventing Telegard from aborting with a run-time error.
  46.  
  47.      If you want to know which bases were packed, which were not,
  48.      and whether there were any problems, T-Pack can keep a log for
  49.      you.
  50.  
  51.      T-Pack has a colorful screen that keeps you informed of the
  52.      current status of the program.  All colors are user-
  53.      configurable.
  54.  
  55.                         HOW TO USE T-PACK
  56.  
  57.      There is one configuration file associated with T-Pack --
  58. T-PACK.CLR  If that file is present in the CURRENT DIRECTORY,
  59. T-Pack will load its color configuration from the file.  Use it
  60. only if you wish to change the default colors.
  61.  
  62.      T-PACK.CLR should be a simple ASCII file containing one number
  63. per line.  The number specifies the new value for the color, and
  64. the line number is the color number (the part of the screen it
  65. applies to).  Any line beginning with a semicolon ; is ignored and
  66. not included in the count.  Valid values for the colors are 0 to
  67. 31.  A value of 99 tells T-Pack to use the default color.  Any
  68. other value will be treated as an error.  See T-PACK.SAM for the
  69. list of color numbers, their default values and the meanings of the
  70. color values.
  71.  
  72.      To run T-Pack, simply call the program in the following
  73. format:
  74.  
  75. T-PACK =|# [/F] [/A] [/T] [/L:filespec] [/S:kb]
  76.  
  77. #    This is the only required parameter, and it specifies the
  78.      message bases to pack.  An equal sign = indicates that you
  79.      want ALL message bases to be packed.  If you only want certain
  80.      message bases to be packed, you must specify them by their
  81.      number.  You can use either a list of numbers (separated by a
  82.      space), a range in the #-# format, or a combination of the
  83.      above.  Please keep in mind that Telegard starts numbering
  84.      message base with 0, not 1!
  85.  
  86. /F   This switch engages the FORCED-FIX mode, which forces T-Pack
  87.      to check each message base for bad messages before it is
  88.      packed.  If a bad message is found, it is marked as DELETED
  89.      and is removed during packing.  If T-Pack is unable to read
  90.      the index file or the message file at all, the message base
  91.      will be skipped (unless /T is specified;  see below for more
  92.      information).  Because every selected message base is checked
  93.      before packing, the program will take significantly longer to
  94.      finish.
  95.  
  96. /A   This switch engages the AUTO-FIX mode, which is an alternative
  97.      to the FORCED-FIX mode.  Instead of checking each message base
  98.      for bad messages before packing, T-Pack will go right on and
  99.      pack them.  If it encounters an error while packing a message
  100.      base, it will attempt to fix it.  If it was able to fix the
  101.      error, the program is going to restart packing the base from
  102.      the beginning.  If a second error is encountered at any time,
  103.      the message base is skipped.  The AUTO-FIX mode will not
  104.      always catch all errors that the FORCED-FIX mode will.  If the
  105.      message base requires packing, then AUTO-FIX will give the
  106.      same result as FORCED-FIX should the message base be damaged. 
  107.      If, on the other hand, the message base is already packed,
  108.      AUTO-FIX will only detect a damaged (physically unreadable)
  109.      index file.  So, if the message base is already packed and the
  110.      index file is corrupt (contains invalid entries), AUTO-FIX
  111.      will not notice the problem.
  112.  
  113. /T   This parameter turns the TRUNCATE feature on.  If T-Pack is
  114.      unable to read the message base files while fixing them and
  115.      TRUNCATE is turned ON, the program will attempt to cut off the
  116.      file just before the damaged entry.  This will save all
  117.      messages up to the damaged entry, but all messages after it
  118.      will be lost.  Use this switch with caution, because you may
  119.      loose many messages to a problem that may have easily been
  120.      fixed by a disk repair program, such as Norton Disk Doctor or
  121.      DOS 6.2 ScanDisk.
  122.  
  123. /L:  This switch enables log file generation.  After the colon you
  124.      must specify the full name and path of the log file (for
  125.      example, /L:C:\TEL\T-PACK.LOG).  If this switch is not
  126.      present, no log file will be made.
  127.  
  128. /S:  This switch tells T-Pack to keep its log size under the
  129.      kilobyte size specified with this switch.  A value of 5, for
  130.      example, will cause T-Pack to shrink the log to under 5120
  131.      bytes.  Valid values for this switch are 1 to 255.  If you do
  132.      not include this switch, T-Pack completely ignores the log
  133.      size.  This switch has no effect unless the /L: switch was
  134.      also specified.
  135.  
  136.      NOTE:     T-PACK shrinks the log file BEFORE it starts the
  137.                packing process.  This means that after it
  138.                finishes, the log may be larger than the size you
  139.                specified here.
  140.  
  141.                When T-PACK shrinks the log, it looks for the first
  142.                log entry separator (a line containing exactly 79
  143.                dashes) that would make the log size smaller than
  144.                the specified kilobyte amount.  That means that a
  145.                log file can potentially shrink to a size
  146.                significantly smaller than the amount you
  147.                specified, or even to a zero size.
  148.  
  149.      Parameters in square brackets are OPTIONAL.  Case and order of
  150. the parameters are irrelevant.  All parameters must be separated by
  151. a space.  No spaces allowed inside of parameters.
  152.  
  153. NOTE:     Since Telegard allows each user to select different
  154.           colors under the same number, T-Pack has no way of
  155.           interpreting MCI color codes.  All Telegard color codes
  156.           will be stripped from message base names both in the log
  157.           and when they are displayed on the screen.
  158.  
  159. NOTE 2:   A "bad" message for T-Pack is one that would cause a run-
  160.           time error if Telegard tried to read it.  A "corrupt"
  161.           message is one that contains garbled text.  T-Pack has no
  162.           way of determining if the message is corrupt or not.  If
  163.           you see any messages which contain obviously garbled
  164.           text, simply mark them as deleted and they'll be removed
  165.           by T-Pack.
  166.  
  167.                         THE T-PACK SCREEN
  168.  
  169.      Upon starting T-Pack you will see a copyright notice, and any
  170. error messages associated with the color configuration file.  If
  171. you specified the /S: switch on the command line, T-Pack will say
  172. that is processing the log file.  It'll then check the log file
  173. size, and, if necessary, shrink it.  Next you'll see any error
  174. messages associated with your STATUS.DAT, BOARDS.DAT, the log file
  175. (if any) and command-line parameters.  Once you get past that
  176. (hopefully without any error messages), you'll see a full screen-
  177. worth of information that will be separated into two windows.
  178.  
  179.      The first line of the screen will show the program name,
  180. version and copyright notice.
  181.  
  182.      The last line of the screen will either say "Press ESC to
  183. abort program" or "Wait. . ."  Depending on the message you can
  184. either press ESC to abort the program or wait until it finishes
  185. whatever it is doing.  You can NOT abort the program if it is
  186. either fixing the message base or processing the index.
  187.  
  188.      The first window is the PROGRAM CONFIGURATION window.  It will
  189. list all message bases that you specified are to be packed.  After
  190. running some tests I found that the list could take up as many as
  191. 11 lines.  Since I couldn't allocate that much space on the screen,
  192. up to 6 lines worth of message base numbers will be displayed.  If
  193. there is more information, the last line will end with three
  194. periods (. . .).  The next line of information will tell you of the
  195. current fix setup.  This will either be NONE, FORCED or AUTO.  The
  196. last line will give you the full name and path of the log file, or
  197. NONE if you didn't enable the log.  The information in this window
  198. does not change when the program is running.
  199.  
  200.      The second window is the PROGRAM STATUS window.  Here you will
  201. see a number of lines of information:
  202.  
  203. Working             This will show a graph, percentage and the
  204.                     number of message bases processed (including
  205.                     the one being worked on now) out of the number
  206.                     specified.
  207.  
  208. Message Base Name   This will list the full description of the
  209.                     message currently being worked on.
  210.  
  211. Currently           Here you will see a brief text description of
  212.                     what the program is currently doing.
  213.  
  214. Fixing              This line will only be "illuminated" if you
  215.                     have selected a FIX mode.  It will show a
  216.                     graph, percentage and the number of messages
  217.                     processed out of the number of total messages
  218.                     in the current message base.  Upon completion
  219.                     it will list the number of bad messages found.
  220.  
  221. Reading             This line will display a graph, percentage and
  222.                     the number of messages read in out of the
  223.                     total number of messages in the current
  224.                     message base.  Upon completion it will list
  225.                     the number of messages read.
  226.  
  227. Packing             This line will display a graph, percentage and
  228.                     the number of messages processed out of the
  229.                     total number of messages in the current
  230.                     message base.  Upon completion it will list
  231.                     the number of messages that were removed.
  232.  
  233. Writing             This line will display a graph, percentage and
  234.                     the number of messages written to the new
  235.                     message base out of the total number of
  236.                     messages in the current message base.  Upon
  237.                     completion it will list the number of messages
  238.                     written.
  239.  
  240. Last Error          This line will list any errors that occurred
  241.                     while the CURRENT message base was being
  242.                     processed.
  243.  
  244.                            ERRORLEVELS
  245.  
  246.      Since you will most likely use T-Pack in batch files, you will
  247. be able to determine the reason for T-Pack's termination by the
  248. errorlevel it returns.  The following is the summary of errorlelevs
  249. returned by the program:
  250.  
  251.  0 - Everything is just fine.
  252.  1 - Help was requested.
  253.  2 - Can't find STATUS.DAT
  254.           STATUS.DAT must be in the same directory as the program!
  255.  3 - Can't read STATUS.DAT
  256.  4 - Can't open log
  257.           Either you specified an invalid name for the log or there
  258.           was a problem opening it.
  259.  5 - Can't read BOARDS.DAT
  260.  6 - User abort
  261.           You pressed ESC while the program was working
  262.  7 - T-Pack couldn't find a file for at least one of the message
  263.      bases it was supposed to pack
  264.  8 - There was not enough room on the disk to pack at least one of
  265.      the message bases T-Pack was supposed to pack
  266.  9 - There was not enough memory to process the index of at least
  267.      one of the message bases T-Pack was supposed to pack
  268. 10 - There was some kind of error in at least one message T-Pack
  269.      was supposed to pack.  This errorlevel will be returned
  270.      whether the error was fixed or not.
  271. 11 - T-Pack couldn't make the necessary temporary files for at
  272.      least one message base it was supposed to pack.
  273. 12 - Invalid log size specified
  274.           The log size you specified with the /S: switch is
  275.           invalid.  Valid entries are 1 to 255, which represent
  276.           KILOBYTES.
  277. 13 - Error shrinking log file
  278.           T-Pack was unable to shrink the log to the specified
  279.           size.  This error should only happen if T-Pack couldn't
  280.           read the log.
  281. 14 - Invalid color codes
  282.           One of the values in the T-PACK.CLR file is invalid. 
  283.           Refer to T-PACK.SAM for information on the format of this
  284.           file.
  285.  
  286. NOTE:     The errorlevel returned will only tell about the first
  287.           problem encountered.  Any subsequent problems are not
  288.           reflected in the errorlevel.
  289.  
  290.      When the program ends, it will display the errorlevel with
  291. which it is exiting.
  292.  
  293.                       CONTACTING THE AUTHOR
  294.  
  295.      If you have any suggestions or bugs to report (hopefully you
  296. will only have suggestions), then do not hesitate to contact me. 
  297. If you have a financial contribution to make, feel free to do so.
  298.  
  299. You can reach me at the following address:
  300.  
  301.                           Sergey Polak
  302.                          212 Spring St.
  303.                         Monroe, NY  10950
  304.  
  305. Of course you can get the same result by sending your message via
  306. electronic mail, and it'll reach me faster!
  307.  
  308. You can reach me electronically on the OFFICIAL T-Pack BBS:
  309.  
  310. Hometown's Glass Manazure 1:272/107 (914) 496-4115  300-14.4K
  311. (v32/v42) baud, send mail to Sergey Polak #2,
  312.  
  313. or via FidoNet at 1:272/94 or 1:272/107 (preferred)
  314.  
  315. or via InterNet at
  316.  
  317. wp931085@pacevm.dac.pace.edu or
  318. sergey_polak@f94.n272.z1.fidonet.org or
  319. sergey_polak@f107.n272.z1.fidonet.org
  320.  
  321. or via BitNet at WP931085@PACEVM
  322.  
  323. I can also be found on the FidoNet Telegard support echo
  324. (TG_SUPPORT).