home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / SFPK317B.ZIP / SFPK317B.DOC < prev    next >
Text File  |  1992-01-18  |  15KB  |  379 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.                                                                SFPACK 3.17B
  29.  
  30.                          The Smart Message Base Packer for Spitfire 3.0/3.1
  31.                                                (For Registered SFUTI Users)
  32.  
  33.                        Copyright 1989, 1990, 1991 by Smart Office Solutions
  34.                                                         All Rights Reserved
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.           Smart Office Solutions, Inc.
  52.           84 South Division Street
  53.           New Rochelle, NY 10805
  54.  
  55.           Voice:         (914) 632-1496
  56.           BBS:           (914) 576-6139 HST
  57.           RIME:          ->SOLUTION
  58.           Intelec:       ->SOLUTION
  59.           Compuserve:    70062,3536
  60.  
  61.  
  62.      SFPACK 3.17B                                                   Page: 1
  63.  
  64.  
  65.                                   Table of Contents
  66.  
  67.  
  68.           Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
  69.  
  70.           Features  . . . . . . . . . . . . . . . . . . . . . . . . . .   2
  71.  
  72.           Reference . . . . . . . . . . . . . . . . . . . . . . . . . .   3
  73.                The SFPACK Command Line  . . . . . . . . . . . . . . . .   3
  74.                Command Line Options . . . . . . . . . . . . . . . . . .   3
  75.                     AREA: . . . . . . . . . . . . . . . . . . . . . . .   3
  76.                     DAYS: . . . . . . . . . . . . . . . . . . . . . . .   3
  77.                     SPRV: . . . . . . . . . . . . . . . . . . . . . . .   3
  78.                     RCVD: . . . . . . . . . . . . . . . . . . . . . . .   3
  79.                     MSGS: . . . . . . . . . . . . . . . . . . . . . . .   3
  80.                     NOBAK . . . . . . . . . . . . . . . . . . . . . . .   3
  81.                     DUPCK . . . . . . . . . . . . . . . . . . . . . . .   3
  82.                     NOLOG . . . . . . . . . . . . . . . . . . . . . . .   3
  83.                     RENUM . . . . . . . . . . . . . . . . . . . . . . .   4
  84.  
  85.           Miscellaneous Operational Notes . . . . . . . . . . . . . . .   5
  86.                Differences From Previous Versions . . . . . . . . . . .   5
  87.                Log File Generation  . . . . . . . . . . . . . . . . . .   5
  88.                Error Reporting  . . . . . . . . . . . . . . . . . . . .   5
  89.                Place Holding  . . . . . . . . . . . . . . . . . . . . .   5
  90.                Message Numbers  . . . . . . . . . . . . . . . . . . . .   6
  91.  
  92.           Recovering From a Critical Error  . . . . . . . . . . . . . .   6
  93.  
  94.           Technical Support . . . . . . . . . . . . . . . . . . . . . .   6
  95.  
  96.  
  97.      SFPACK 3.17B                                                   Page: 2
  98.  
  99.  
  100.      Introduction
  101.  
  102.  
  103.           SFPACK is no longer  an integral part of the SFUTI  package.  One
  104.           of  the  many  changes in  Spitfire  3.0  is the  use  of NetMail
  105.           compatible message  index files which  make a special  packer for
  106.           SFUTI operation unnecessary.  The internal Spitfire packer can be
  107.           used freely.
  108.  
  109.           As a "thank-you"  to the  many Sysops who  have registered  their
  110.           SFUTI packages,  SOS has decided  to continue to  maintain SFPACK
  111.           and to offer it to registered SFUTI users free of charge.  If you
  112.           have registered your SFUTI package, you  are granted a license to
  113.           use the  SFPACK software  on one  computer system  or Local  Area
  114.           Network.  Please  note that SFPACK 3.17B will refuse to  function
  115.           unless your SFUTI system is currently registered.
  116.  
  117.  
  118.      Features
  119.  
  120.           Full   file   sharing  and   MultiNode   /  Local   Area  Network
  121.           compatibility.
  122.  
  123.           All parameters are passed on the SFPACK command line. This allows
  124.           you to pack different message bases with different parameters.
  125.  
  126.           Smart Dual 32 bit CRC duplicate checking removes duplicates.
  127.  
  128.           Messages can be packed by age (number of days old).
  129.  
  130.           Messages can be packed based on Private & Received status.
  131.  
  132.           Messages can be packed based on size (number of messages).
  133.  
  134.           Backup files are created but can be suppressed.
  135.  
  136.           SFPACK  will  NOT attempt  a  pack  unless enough  disk  space is
  137.           available.
  138.  
  139.           SFPACK will pack  messages that  are included in  a "thread"  and
  140.           will  handle  all  necessary "thread"  updating  required  by the
  141.           removal of a threaded message.
  142.  
  143.           Completely SAFE operation.  No changes  are made to your original
  144.           message  bases until the entire pack operation has been completed
  145.           successfully.
  146.  
  147.           Full backup files are created during SFPACK operation.
  148.  
  149.           Full logging of SFPACK's activities is available.
  150.  
  151.  
  152.      SFPACK 3.17B                                                   Page: 3
  153.  
  154.                                       Reference
  155.  
  156.      The SFPACK Command Line
  157.      -----------------------
  158.  
  159.           The parameters passed to SFPACK on its command line may be placed
  160.           in ANY order.   However, if the  same parameter is passed  on the
  161.           command line twice  only the second  occurrence will be  honored.
  162.           For example, if you issued the command:
  163.  
  164.                          SFPACK AREA:4 DAYS:30 DAYS:90
  165.  
  166.           SFPACK will pack the message base to 90 days.
  167.  
  168.      Command Line Options
  169.      --------------------
  170.  
  171.      AREA:xx   This parameter  indicates which message bases  SFPACK should
  172.                process.   If the  AREA: parameter is  not specified, SFPACK
  173.                will pack ALL  message bases with the command line supplied.
  174.                Valid area  values are one  area number or  a range of  area
  175.                numbers (xx-xx).  Multiple area values may  be used provided
  176.                they are separated by commas.   The following are valid AREA
  177.                commands:
  178.  
  179.                               AREA:5
  180.                               AREA:1-20
  181.                               AREA:1,3,9
  182.                               AREA:1,3,17-200,13,5-8
  183.  
  184.      DAYS:dd   This parameter  indicates the  age of  messages that  SFPACK
  185.                should leave in the message bases.   If you specify DAYS:30,
  186.                all messages older than 30 days will be removed.
  187.  
  188.      SPRV:dd   This parameter indicates that Private mail  that has not yet
  189.                been  received by the addressee should  NOT be packed unless
  190.                it is  more than dd days old.   When this parameter is used,
  191.                the DAYS parameter  has no effect  on Private /  Un-Received
  192.                mail.
  193.  
  194.      RCVD:     This parameter indicates that messages  that are marked BOTH
  195.                Private and Received should be removed.
  196.  
  197.      MSGS:xx   This parameter specifies  the MAXIMUM number of  messages to
  198.                leave in the  message base.   SFPACK will  trim the  message
  199.                base  to  the  number  of  messages  specified  here  BEFORE
  200.                applying  any   other  command  line   parameters.     Other
  201.                parameters  may  further  reduce   the  number  of  messages
  202.                remaining upon completion.
  203.  
  204.      NOBAK     This  parameter specifies  that  the  backup  files  (*.BKI,
  205.                *.BKD,  *.BKP) should  be  deleted at  the  completion of  a
  206.                successful pack operation.
  207.  
  208.      DUPCK     This  parameter  actives  SFPACK's Flying  Dual  32  Bit CRC
  209.                duplicate removal algorithm.
  210.  
  211.      NOLOG     This parameter deactivates log file updates.
  212.  
  213.  
  214.      SFPACK 3.17B                                                   Page: 4
  215.  
  216.  
  217.      RENUM     This  parameter   causes  your  messages  to  be  renumbered
  218.                sequentially starting at  1.  This parameter  should only be
  219.                used if your message  numbers are unusually high, or  if you
  220.                suspect  index  file  damage.    RENUM  writes  a  brand new
  221.                SFMSGxx.IDX file  after renumbering, to be sure that the all
  222.                files are in sync.
  223.  
  224.                * NOTE:  If  you are using the PCRelay  Networking Software,
  225.                then  you  MUST   delete  all  the  THREAD.xxx   files  that
  226.                correspond  to  your RENUMbered  message  bases.   Please be
  227.                aware  that  the  THREAD.xxx  files  are  numbered  by  your
  228.                network's   NATIONAL  conference   numbers,   and  NOT   the
  229.                conference numbers that your Spitfire uses locally.
  230.  
  231.  
  232.      /?        This  parameter  will  display  a  summary of  valid  SFPACK
  233.                command line parameters.
  234.  
  235.  
  236.      SFPACK 3.17B                                                   Page: 5
  237.  
  238.  
  239.  
  240.                            Miscellaneous Operational Notes
  241.  
  242.  
  243.      Differences From Previous Versions
  244.      ----------------------------------
  245.  
  246.           The DATE: parameter is no longer supported.
  247.           The NODUP parameter has been changed to DUPCK.
  248.           The SPRV: parameter has been added.
  249.  
  250.  
  251.      Log File Generation
  252.      -------------------
  253.  
  254.           SFPACK  normally  logs  its  activities  to  a  disk  file  named
  255.           SFPACK.LOG  located in  the  UTI home  directory.   Creation  and
  256.           updating  of the log  file may be  suppressed by  using the NOLOG
  257.           parameter on the command line.
  258.  
  259.  
  260.      Error Reporting
  261.      ---------------
  262.  
  263.           SFPACK is designed as an extension  to a registered SFUTI system.
  264.           As such, it contains  the same central disk file  error reporting
  265.           as  the SFUTI package.  All critical  errors will be fully logged
  266.           to the SFUTI.ERR file located in the SFUTI home directory.
  267.  
  268.           In addition, SFPACK will set a DOS ERRORLEVEL when it  aborts due
  269.           to a critical error.  This ERRORLEVEL  may be tested in the batch
  270.           file that runs your packing event.   For more information on  the
  271.           DOS ERRORLEVEL value, please refer to your DOS documentation.
  272.  
  273.  
  274.  
  275.      Place Holding
  276.      -------------
  277.  
  278.           SFPACK will  NEVER remove  the last  message in  a message  base.
  279.           This message is  critical and must  remain on file as  the "place
  280.           holder"  for the  last  message number  issued  by your  Spitfire
  281.           system.    For  proper threading  and  NetMail  operation, it  is
  282.           imperative that  no  two  messages  are ever  assigned  the  same
  283.           number.  If this last "place holder"  message is determined to be
  284.           a duplicate, SFPACK  will mark  the message as  deleted, but  not
  285.           physically remove it from  the file.   Thusly, your users do  not
  286.           see the duplicate  message, but  the "place holder"  is still  in
  287.           place.
  288.  
  289.  
  290.      SFPACK 3.17B                                                   Page: 6
  291.  
  292.  
  293.  
  294.      Message Numbers
  295.      ---------------
  296.  
  297.           The actual unique message numbers used by Spitfire 3.0 and SFPACK
  298.           3.17B for proper thread maintenance are  NOT displayed to you  or
  299.           your users during regular on-line  messaging functions.  Spitfire
  300.           continues to display the relative number of the  message starting
  301.           with 1  and ending with the total number  of messages on file. Do
  302.           not   be  concerned  if  it   appears  that  messages  have  been
  303.           renumbered. 
  304.  
  305.  
  306.      Recovering From a Critical Error
  307.      --------------------------------
  308.  
  309.           SFPACK  uses  the  safest  mechanism  possible for  packing  your
  310.           message bases.   Your original  files (SFMSGxx.DAT,  SFMSGxx.PTR,
  311.           and SFMSGxx.IDX)  are not  written to  during the packing  cycle.
  312.           SFPACK  writes  out  NEW  message  bases  under  the  file  names
  313.           SFMSGxx.NWD, SFMSGxx.NWP, and SFMSGxx.NWI.   When the program has
  314.           reached  completion WITHOUT  encountering a  critical  error, the
  315.           following actions are performed:
  316.  
  317.                SFMSGxx.DAT is renamed to SFMSGxx.BKD
  318.                SFMSGxx.PTR is renamed to SFMSGxx.BKP
  319.                SFMSGxx.IDX is renamed to SFMSGxx.BKI
  320.                SFMSGxx.NWD is renamed to SFMSGxx.DAT
  321.                SFMSGxx.NWP is renamed to SFMSGxx.PTR
  322.                SFMSGxx.NWI is renamed to SFMSGxx.IDX.
  323.  
  324.           If you have used the NOBAK  command line parameter, the following
  325.           additional actions are performed:
  326.  
  327.                SFMSGxx.BKD is deleted
  328.                SFMSGxx.BKP is deleted
  329.                SFMSGxx.BKI is deleted.
  330.  
  331.           If SFPACK encounters  a critical error  at any stage before  this
  332.           final processing  cycle, your  original message  base files  will
  333.           still  be on  disk under their  original names  as if  the packer
  334.           never operated.  Using this method allows you to safely pack your
  335.           message bases in an event.
  336.  
  337.  
  338.  
  339.      Technical Support
  340.      -----------------
  341.  
  342.           Refer  to   your  SFUTI   documentation  for  Technical   Support
  343.           procedures.
  344.  
  345.  
  346.      SFPACK 3.17B                                                   Page: 7
  347.  
  348.  
  349.                                         Index
  350.  
  351.           AREA: . . . . . . . . . . . . . . . . . . . . . . . . . . .  1, 3
  352.           Command line  . . . . . . . . . . . . . . . . . . . . . . . . 1-6
  353.           Conference  . . . . . . . . . . . . . . . . . . . . . . . . . . 4
  354.           DATE: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
  355.           DAYS: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  356.           DUPCK . . . . . . . . . . . . . . . . . . . . . . . . . . 1, 3, 5
  357.           Error . . . . . . . . . . . . . . . . . . . . . . . . . . 1, 5, 6
  358.           ERRORLEVEL  . . . . . . . . . . . . . . . . . . . . . . . . . . 5
  359.           File names  . . . . . . . . . . . . . . . . . . . . . . . . . . 6
  360.           Introduction  . . . . . . . . . . . . . . . . . . . . . . .  1, 2
  361.           License to use  . . . . . . . . . . . . . . . . . . . . . . . . 2
  362.           Local Area Network  . . . . . . . . . . . . . . . . . . . . . . 2
  363.           Log file  . . . . . . . . . . . . . . . . . . . . . . . . 1, 3, 5
  364.           Message number  . . . . . . . . . . . . . . . . . . . . . . . . 5
  365.           MSGS: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  366.           MultiNode . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  367.           NetMail . . . . . . . . . . . . . . . . . . . . . . . . . .  2, 5
  368.           Network . . . . . . . . . . . . . . . . . . . . . . . . . .  2, 4
  369.           NODUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
  370.           NOLOG . . . . . . . . . . . . . . . . . . . . . . . . . . 1, 3, 5
  371.           PCRelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
  372.           RCVD: . . . . . . . . . . . . . . . . . . . . . . . . . . .  1, 3
  373.           RENUM . . . . . . . . . . . . . . . . . . . . . . . . . . .  1, 4
  374.           SFPACK  . . . . . . . . . . . . . . . . . . . . . . . . . . . 0-6
  375.           SFUTI.ERR . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
  376.           Smart Office Solutions  . . . . . . . . . . . . . . . . . . . . 0
  377.           SPRV: . . . . . . . . . . . . . . . . . . . . . . . . . . .  1, 5
  378.           Support . . . . . . . . . . . . . . . . . . . . . . . . . .  1, 6
  379.