home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / sqpv104.zip / sqprv.doc < prev    next >
Text File  |  1995-11-10  |  11KB  |  420 lines
  1. ******************************************************************************
  2. *                                                                            *
  3. *                                                                            *
  4. *                   ****    *****   ******   ******   **   **                *
  5. *                  **  **  **   **   **  **   **  **  **   **                *
  6. *                   **     **   **   **  **   **  **  **   **                *
  7. *                    **    **   **   *****    *****   **   **                *
  8. *                     **   **   **   **       ** **   **   **                *
  9. *                  **  **  **  ***   **       **  **   ** **                 *
  10. *                   ****    *****   ****     **** **    ***                  *
  11. *                               **                                           *
  12. *                                                                            *
  13. *                    A local echomail scanner for Squish<tm>                 *
  14. *                                                                            *
  15. *                                                                            *
  16. ******************************************************************************
  17. *                                                                            *
  18. *                 (C) Copyright 1992-1995  Alberto Pasquale                  *
  19. *                                                                            *
  20. *                   A L L   R I G H T S   R E S E R V E D                    *
  21. *                                                                            *
  22. ******************************************************************************
  23. *                                                                            *
  24. *   SqPrv is NOT free-software, it is distributed under the ShareWare        *
  25. *   concept !  If you regularly use it, you should register.                 *
  26. *   See REGISTER.DOC for more details on how to register your copy.          *
  27. *                                                                            *
  28. ******************************************************************************
  29. *                                                                            *
  30. *   How to contact the author:  Alberto Pasquale                             *
  31. *                               Viale Verdi 106                              *
  32. *                               41100 Modena                                 *
  33. *                               Italy                                        *
  34. *                                                                            *
  35. *   2:332/504@fidonet +39-59-246112 ISDNC V34+ VFC V32T H16     24h          *
  36. *   2:332/524@fidonet +39-59-246113 ISDNC V34  VFC V32T H16 FAX 24h          *
  37. *                                                                            *
  38. ******************************************************************************
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.                    SQuish PRiVate echomail scanner ver. 1.04
  63.  
  64.  
  65.  
  66.                                    LICENSE
  67.  
  68.          See License.Doc.
  69.  
  70.  
  71.          Main characteristics:
  72.  
  73.          - To be used with Squish<tm> mail processor by Scott J. Dudley.
  74.  
  75.          - Especially easy to configure in combination with NmFwd by
  76.            the same author (Alberto Pasquale).
  77.  
  78.          - Allows correct distribution of local private or public&private
  79.            areas to points.
  80.  
  81.          - Allows Squish's one-pass processing.
  82.  
  83.          - Minimum configuration effort required.
  84.  
  85.          - Full 3D and 4D support.
  86.  
  87.          - Full *.MSG and Squish type areas support through MSGAPI
  88.            by Scott J. Dudley.
  89.  
  90.          * This program uses the MsgAPI code by Scott J. Dudley.
  91.          * Squish is a trademark of Lanius Corporation.
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.                                      Page  1
  121.  
  122.                               OVERALL OPERATION
  123.  
  124.  
  125.            SqPrv is a special kind of echomail scanner that exports
  126.          messages to your OUTBOUND.SQ.
  127.  
  128.            Public messages are forwarded to all the linked systems,
  129.          while Private ones are only forwarded to the addressee's
  130.          point (if any match occurs with the "Remap" statements of
  131.          NmFwd.cfg or SqPrv.cfg).
  132.  
  133.            You can specify a list of systems that must receive all
  134.          the messages, even if they are private (typically useful
  135.          for the SysOp's and/or CoSysOp's point or for sharing the
  136.          area with another similarly equipped BBS).
  137.  
  138.            If you are currently using Squish in a multi-pass environment,
  139.          then you can invoke SqPrv after Toss and before Scan/Pack.
  140.  
  141.            If you are using Squish in a one-pass environment, then you
  142.          must use the SqRem/SqUnRem programs too.
  143.            Since you want Squish NOT to scan private areas while
  144.          tossing them, you need to call SqRem _before_ Squish, in
  145.          order to comment private areas so that they are not
  146.          recognized and the tossed messages go to your BAD_MSGS (which
  147.          must be in Squish format).
  148.            Then you can use SqUnRem to restore the commented areas and
  149.          invoke "squish in" to do a Toss from the BAD_MSGS. Now you can
  150.          call SqPrv and "Squish squash" to pack the private-area
  151.          messages that SqPrv has just exported to your outbound.SQ. See
  152.          "Installation" and the sample SqPriv.Btm file for examples.
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.                                      Page  2
  180.  
  181.  
  182.                                 INSTALLATION
  183.  
  184.  
  185.          1) Make sure your "BadArea" in Squish.Cfg is in Squish format,
  186.             otherwise the public messages coming from a 4D point will be
  187.             exported to him too.
  188.  
  189.          2) Enable the "TossBadMsgs" option in squish.cfg.
  190.  
  191.          3) Make sure you are not using the "Include" feature of Squish,
  192.             to divide its config file into multiple ones.
  193.             You need a unique Squish configuration file before
  194.             installing SqPrv (at least, all the info needed by SqPrv
  195.             must be in one file only).
  196.  
  197.          4) Edit SqPrv.cfg and choose your exes.
  198.  
  199.             OS/2   : Make sure you have MSGAPI32.DLL in your libpath.
  200.  
  201.             DOS  32: Make sure you have the DOS4GW.EXE dos extender in
  202.                      your path.
  203.  
  204.          5) Always remember that SqPrv is an echomail Scanner that
  205.             selectively exports messages to the temporary Outbound.Sq.
  206.  
  207.          5a) Multi-Pass environment:
  208.  
  209.             Edit your mail processing batch file in order to call SqPrv
  210.             after "Squish in" and before "Squish out".
  211.  
  212.             Example:
  213.  
  214.             ...
  215.             Squish in
  216.             NmFwd
  217.             SqPrv
  218.             Squish out squash
  219.             ...
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.                                      Page  3
  238.  
  239.          5b) One-Pass environment:
  240.  
  241.             You must separate Toss and Scan for the private-echomail
  242.             areas.
  243.  
  244.             Edit your mail processing batch file in order to follow
  245.             the guideline given by the sample SqPriv.Btm (which you can
  246.             rename to .CMD (OS/2) or .BAT (DOS).
  247.  
  248.             Example:
  249.  
  250.             ...
  251.             SqRem
  252.             Squish in out squash -o
  253.             SqUnRem
  254.             Squish in
  255.             NmFwd
  256.             SqPrv
  257.             Squish out squash
  258.             ...
  259.  
  260.             The last "Squish out squash" could be "Squish squash", but
  261.             locally entered messages in areas with no new tossed
  262.             messages would not be scanned (since "Squish in out
  263.             squash" only scans the areas it has just tossed to).
  264.  
  265.  
  266.  
  267.             If you use different schedules for netmail and echomail,
  268.             you have to add some more lines to your batch:
  269.  
  270.             Example:
  271.  
  272.             ...
  273.             SqRem
  274.             Squish in out squash -sEpack -o
  275.             SqUnRem
  276.             Squish in
  277.             Sqprv
  278.             Squish out squash -sEpack -o
  279.             NmFwd
  280.             squish squash -spack
  281.             ...
  282.  
  283.             Where pack is the netmail schedule and Epack the echomail
  284.             one.
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.                                      Page  4
  298.  
  299.          6) Private area selection.
  300.  
  301.             SqPrv scans all the areas in the Squish configuration file
  302.             that have their "Echoarea" definition preceded by a
  303.             ";SqPrv [<node> ...]" line. The optional list of nodes
  304.             specifies which systems, if linked, must receive all the
  305.             messages whether they are public or private.
  306.  
  307.             Example from Squish config file:
  308.             ...
  309.             ;SqPrv 2:332/504.1 .2
  310.             EchoArea GAMELOC d:\msg\gameloc -$d30 2:332/504.1 .3 .4
  311.             EchoArea CLOCAL  d:\msg\clocal  -$d15 2:332/504.1 .2 .3
  312.             ;SqPrv 2:332/504.1 .2
  313.             EchoArea LOCAL   d:\msg\local         2:332/504.1 .2 .3 .4
  314.             ...
  315.  
  316.             Area GAMELOC is scanned by SqPrv and .1 receives all the
  317.             messages whether they are public or not.
  318.  
  319.             Area CLOCAL is not scanned by SqPrv.
  320.  
  321.             Area LOCAL is scanned by SqPrv and points 1 and 2 receive
  322.             all public and private messages.
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.                                      Page  5
  358.  
  359.                            Command line switches
  360.  
  361.             -c<cfgfile>    Cfg file override
  362.  
  363.             Example: SqPrv   -cc:\max\SqPrv.cfg
  364.                      SqRem   -cc:\max\SqPrv.cfg
  365.                      SqUnRem -cc:\max\SqPrv.cfg
  366.  
  367.  
  368.  
  369.                                 Errorlevels
  370.             
  371.             SqPrv:
  372.  
  373.               1 - Invalid parameter on command line or no config file
  374.               2 - Cannot open squish config file
  375.             253 - Cannot initialize MSGAPI
  376.             254 - Cannot open logfile
  377.             255 - Out of memory
  378.  
  379.  
  380.             SqRem/SqUnRem:
  381.  
  382.               1 - Invalid parameter on command line or no config file
  383.               2 - Cannot open or write to squishcfg
  384.               3 - Cannot rename tmp file to squish.cfg: you can find
  385.                   the temporary squish config file with the ".$$$"
  386.                   extension.
  387.             254 - Cannot open logfile
  388.             255 - Out of memory
  389.  
  390.  
  391.  
  392.                              CONFIGURATION FILE
  393.  
  394.  
  395.          SqPrv requires a configuration file (defaults to SqPrv.Cfg).
  396.  
  397.          See the sample file included in the archive for more details.
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.                                      Page  6
  418.  
  419.  
  420.