home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / NMFWD190.ZIP / NMFWD.DOC < prev    next >
Text File  |  1995-06-24  |  20KB  |  468 lines
  1. ******************************************************************************
  2. *                                                                            *
  3. *                                                                            *
  4. *                   **   ** **   ** ******* **   ** *****                    *
  5. *                   ***  ** *** ***  **   * **   **  ** **                   *
  6. *                   **** ** *******  ** *   **   **  **  **                  *
  7. *                   ** **** *******  ****   ** * **  **  **                  *
  8. *                   **  *** ** * **  ** *   *******  **  **                  *
  9. *                   **   ** **   **  **     *** ***  ** **                   *
  10. *                   **   ** **   ** ****     *   *  *****                    *
  11. *                                                                            *
  12. *                                                                            *
  13. *            A powerful Multi-Robot for Maximus/Squish/BinkleyTerm           *
  14. *                                                                            *
  15. *                                                                            *
  16. ******************************************************************************
  17. *                                                                            *
  18. *                 (C) Copyright 1991-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. *   NmFwd 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 details on how to register your copy.               *
  27. *                                                                            *
  28. ******************************************************************************
  29. *                                                                            *
  30. *   How to contact the author:  Alberto Pasquale of 2:332/504@fidonet        *
  31. *                               Viale Verdi 106                              *
  32. *                               41100 Modena                                 *
  33. *                               Italy                                        *
  34. *                                                                            *
  35. ******************************************************************************
  36.  
  37.  
  38.  
  39.                            NetMail Forward ver. 1.90
  40.  
  41.  
  42.  
  43.                                    LICENSE
  44.  
  45.          See License.doc.
  46.  
  47.  
  48.  
  49.          Main characteristics:
  50.  
  51.          - To be used with Squish mail processor and Maximus CBCS
  52.            (Trademarks of Lanius Corporation) and BinkleyTerm front-end
  53.            (TradeMark of Bit Bucket Software).
  54.  
  55.          - Works on *.MSG or SQUISH netmail area.
  56.  
  57.          - Total or partial forward of NetMail area to (Co)SysOp's point.
  58.  
  59.          - Selective Flag (Crash, Direct) Stripping.
  60.  
  61.          - 3D and 4D point handling.
  62.  
  63.          - Boss Routing capability to BossRoute all the crash and direct
  64.            messages addressed to points that are not found in your V7
  65.            nodelist or have a null phone number.
  66.  
  67.          - Point Remapping based on To-Name.
  68.  
  69.          - FileAttach forwarding between points in a dedicated directory,
  70.            with optional automatic file-killing after configured time.
  71.  
  72.          - Automatic Upload for Points via NetMail Robot.
  73.  
  74.          - Complete User Management functions via NetMail Robot (Max 2.0).
  75.  
  76.          - Complete File Management functions via NetMail Robot (Max 2.0),
  77.            with flexible privilege and keys handling.
  78.  
  79.          - Automatic (internal) filebase update.
  80.  
  81.          - Areafix functions for Squish.Cfg.
  82.  
  83.          - Return To Sender functions to stop messages addressed to
  84.            unlisted nodes and routed echomail (based on V7 nodelist).
  85.  
  86.          - Return Receipt generation for messages that have the RRQ
  87.            flag set or the "*RR*" string in their subject (standard
  88.            proposed by Alex Palmese of 2:335/317).
  89.  
  90.  
  91.          * This program uses the MsgAPI code by Scott J. Dudley.
  92.          * Squish is a trademark of Lanius Corporation.
  93.  
  94.  
  95.  
  96.  
  97.                                 INSTALLATION
  98.  
  99.  
  100.          1) OS/2: make sure you have the MSGAPI32.DLL in your libpath.
  101.             It can be found in the Squish distribution archive.
  102.  
  103.             DOS: make sure you have the DOS4GW.EXE dos extender in your
  104.             path. It is included in the archives of major releases of
  105.             NmFwd.
  106.  
  107.          2) Edit nmfwd.cfg following the comments in it.
  108.  
  109.          3) Edit your batch file in order to call nmfwd BEFORE netmail
  110.             packing.
  111.  
  112.             Example 1 (two pass):
  113.  
  114.                      Squish In Out
  115.                      NmFwd
  116.                      Squish Squash -sNrm
  117.  
  118.             Example 2 (one pass):
  119.  
  120.                      Squish In Out Squash -o -sNrm
  121.                      NmFwd
  122.                      Squish Squash -sNrm
  123.  
  124.             Note: - The -o switch prevents squish from packing netmail
  125.                     before Nmfwd has a chance to process it.
  126.                   - You may need additional calls to squish to process
  127.                     echomail generated locally.
  128.  
  129.             Example 3 (separate echo and netmail routing, SqPrv local
  130.                        echomail processor and Nef tic processor used):
  131.  
  132.             sqrem
  133.             squish in out squash -sECHO -o
  134.             nef
  135.             squnrem
  136.             squish in
  137.             sqprv
  138.             squish out squash -sECHO -o
  139.             nmfwd
  140.             squish squash -sNET
  141.  
  142.  
  143.  
  144.                            Command line switches
  145.  
  146.             -c<cfgfile>
  147.             -l<logfile>
  148.  
  149.             Example: NMFWD -cc:\max\nmfwd.cfg -lc:\log\nmfwd.log
  150.  
  151.  
  152.  
  153.                                 Errorlevels
  154.  
  155.               0 - All OK.
  156.               1 - Help requested
  157.               3 - Abnormal Termination.
  158.               4 - Cfg Error.
  159.              10 - Error updating FileBase.
  160.             128 - Too many new messages (*.MSG).
  161.                   The current limit (providing there is enough free memory)
  162.                   is of 32768 messages numbered between 1 and 65535.
  163.             251 - Config file not found.
  164.             252 - Error on command line.
  165.             253 - MsgApi error.
  166.             254 - Can't open Log file.
  167.             255 - Out of memory.
  168.  
  169.  
  170.                              CONFIGURATION FILE
  171.  
  172.  
  173.          NmFwd requires a configuration file (defaults to
  174.          NmFwd.Cfg). Before using NmFwd you should edit this file,
  175.          following the comments in the sample one.
  176.  
  177.          The names of the various parameters are NOT case sensitive.
  178.          Items in square brackets ([]) are optional.
  179.  
  180.  
  181.  
  182.                               OVERALL OPERATION
  183.  
  184.  
  185.          To speed up netmail scanning, NmFwd scans only new messages. To
  186.          accomplish this, it uses an advanced algorithm for *.MSG (the
  187.          necessary information is stored in the NMFWDDIR.DAT located in
  188.          the related directory) and the UID (Unique ID) for the Squish
  189.          base (stored in the <netmail>.NFD file).
  190.  
  191.          In the case you change a message after it has been processed
  192.          (Squish base), it will not be rescanned. So, if you want it
  193.          processed, you must copy then change, not simply change the
  194.          message.
  195.  
  196.          All the messages addressed to your points are directly packed
  197.          to *.?ut in the OUTBOUND.SQ by NmFwd. This is necessary to
  198.          allow correct operations of the Netmail Forwarding functions in
  199.          a mixed 3D-4D environment and for the BossRoute option.
  200.  
  201.  
  202.  
  203.                                 FLAGS HANDLING
  204.  
  205.          If the original message has one of the following flags
  206.          (FileRequest, UpdateRequest), the forwarded one will have a
  207.          two letter upper-case symbol on the first line (FR, UR).
  208.  
  209.          If a Crash message comes from a point authorized to send DM
  210.          only, the Hold attribute is set in order to change the Crash
  211.          flavour to Direct (Squish handles the sum of Crash and Hold
  212.          as Direct). The forwarded copy will have a "cm" lower-case
  213.          symbol on the first line of the message.
  214.  
  215.          If a Crash message comes from a system that is not authorized
  216.          to send neither Crash nor Direct mail, the crash flag will be
  217.          reset and a "cm" symbol will be inserted in forwarded copies.
  218.  
  219.          If a Direct message (Crash and Hold flags set) comes from a
  220.          system that is not authorized, the crash and hold flags will
  221.          be reset and the "dm" symbol will be inserted in forwarded
  222.          copies.
  223.  
  224.  
  225.  
  226.                       USER MANAGEMENT COMMANDS
  227.  
  228.  
  229.          You must send a private net-mail message to your robot, using
  230.          the requested password as subject (see the .cfg for details).
  231.          The Syntax of commands (to be put in the text) is:
  232.  
  233.          Username[,Username,Username ...] = Action[,Action, Action ...]
  234.  
  235.          You can list a maximum of 30 Usernames and 30 Actions per
  236.          command. You can use "(<privilege>)" or "(Keys <userkeys>)"
  237.          or "(<privilege>)&(Keys <userkeys>)" as a valid Username.
  238.  
  239.          Example:
  240.  
  241.          (twit)=disgrace
  242.          (keys h)=favored
  243.          (disgrace)&(keys kj)=normal
  244.  
  245.          The first command gives the disgrace privilege to all twit
  246.          users. The second command gives the favored privilege to all
  247.          users that have the h key (except for those that have a
  248.          privilege above MAXLEV). The third command gives the normal
  249.          privilege to all disgrace users that have both the k and j
  250.          keys.
  251.  
  252.          All the listed actions will be applied in the listed order
  253.          to all of the listed users.  You can write many commands in
  254.          the same message, provided they are separated by a <CR>.
  255.          Every command may be more than 80 chars but it cannot contain
  256.          carriage returns.
  257.  
  258.          Example:
  259.  
  260.          Albert MacGiver=Normal
  261.          Franz Cormack, Robert Harris = Extra, Keys net
  262.  
  263.          The available commands are:
  264.  
  265.          (The MaxLev option in .cfg allows to inhibit the action on
  266.          higher privileges)
  267.  
  268.  
  269.  
  270.          Twit                 - set the Twit privilege
  271.          Disgrace             - set the Disgrace privilege
  272.          Limited              - set the Limited privilege
  273.          Normal               - set the Normal privilege
  274.          Worthy               - set the worthy privilege
  275.          Privil               - set the Privil privilege
  276.          Favored              - set the Favored privilege
  277.          Extra                - set the Extra privilege
  278.          Clerk                - set the Clerk privilege
  279.          AsstSysOp            - set the AsstSysOp privilege
  280.          SysOp                - set the SysOp privilege
  281.          Report               - give full report on user record
  282.                                 "Permanent" records are marked with a '@'
  283.                                 before the user name.
  284.                                 "Deleted" records are marked with a '#'
  285.                                 before the user name.
  286.          List                 - list username with his privilege and
  287.                                 keys
  288.          Kill                 - Mark the user record as deleted
  289.          Avatar               - Set Avatar screen mode
  290.          Ansi                 - Set ANSI screen mode
  291.          TTY                  - Set TTY screen mode
  292.          City <cityname>      - set the user city
  293.          Password <password>  - set the user password
  294.          Phone <userphone>    - set the user telephone
  295.          Alias <useralias>    - set the user alias
  296.          Help <helplevel>     - set the user help level (HotFlash|
  297.                                 Expert|Regular|Novice)
  298.          CLS <yes|no>         - set the "Clear Screen allowed" flag
  299.          UsedMax <yes|no>     - set the "Not first-time user" flag
  300.          IbmChars <yes|no>    - set the IBM graphics flag
  301.          MaxEd <yes|no>       - set the MaxEd full screen editor flag
  302.          More <yes|no>        - set the More flag
  303.          InUserList <yes|no>  - set the "Show in UserList" flag
  304.          Tabs <yes|no>        - set the "Tabs allowed" flag
  305.          Nerd <yes|no>        - set the Nerd flag (don't sound when
  306.                                 yelling)
  307.          ChatAvail <yes|no>   - set the "Available for Chat" flag
  308.          HotKeys <yes|no>     - set the "Uses HotKeys" flag
  309.          FSReading <yes|no>   - set the "Full Screen Reading" flag
  310.          Perm <yes|no>        - set the "User is PERManent" flag
  311.          Language <langname>  - select the language
  312.          Nulls <nnulls>       - select the number of nulls
  313.          Up <[+|-]upK>        - set the total upload in KiloBytes,
  314.                                 optional +|- to add|subtract to|from
  315.                                 the total upload.
  316.          Down <downK>         - set the total download in KiloBytes,
  317.                                 optional +|- to add| subtract to|from
  318.                                 the total download.
  319.          Credit <[+|-]<nnnnn> - set the user credit (<nnnnn> in
  320.                                 0..65535), optional +|- to add|subtract
  321.                                 to|from the total credit.
  322.          Debit <[+|-]<nnnnn>  - set the user debit (<nnnnn> in
  323.                                 0..65535), optional +|- to add|subtract
  324.                                 to|from the total debit.
  325.  
  326.          Keys [+]<setkeys>[-<resetkeys>] - set/reset the listed keys;
  327.                                 e.g. Keys abc     set keys a, b, c
  328.                                      Keys -abc    reset keys a, b, c
  329.                                      Keys abc-de  set keys a, b, c;
  330.                                                   reset keys d, e.
  331.                                      Keys +abc-de set keys a, b, c;
  332.                                                   reset keys d, e.
  333.          ExpDate <expdate>  - set the Expiration date (dd-mm-yy),
  334.                               set the "Expire by date" flag and reset
  335.                               the "Expire by minutes" flag. If no
  336.                               <expdate> is given, reset the "Expire
  337.                               by date" flag. Example:
  338.                               ExpDate 13-May-92
  339.                               ExpDate 13-May-1992
  340.                               ExpDate 13-05-1992
  341.                               ExpDate 13-05-92 (Expire on May 13th 92)
  342.          ExpMins <expmins>  - set the Expiration minutes, set the
  343.                               "Expire by minutes" flag and reset the
  344.                               "Expire by date" flag.
  345.                               If no <expmins> is given, reset the
  346.                               "Expire by mins" flag.
  347.          ExpNone            - Reset Expire mode flags (ExpAxe and
  348.                               ExpDemote)
  349.          ExpDemote <Priv>   - set the Expire->Demote flag and Priv
  350.                               level to demote to.
  351.          ExpAxe             - set the Expire->Axe flag
  352.          Append             - append a new user record: a default one
  353.                               will be appended. Obviously this must be
  354.                               the first command and can be followed by
  355.                               other commands specifying new parameters
  356.                               for the user. The default is:
  357.  
  358.                               Privilege: Disgrace
  359.                               Help: Novice
  360.                               Screen mode: TTY
  361.                               Language: The first.
  362.                               Columns: 80
  363.                               Rows: 24
  364.                               UsedMax: No
  365.                               MaxEd: Yes
  366.                               More: No
  367.                               HotKeys: No
  368.                               IbmChars: No
  369.                               Tabs: No
  370.                               CLS: No
  371.                               FSReading: No
  372.                               All other fields are zeroed.
  373.  
  374.  
  375.  
  376.  
  377.                                  FILE MANAGEMENT
  378.  
  379.          See FMAN.HLP and NMFWD.CFG for details on the FileManagement
  380.          Commands.
  381.  
  382.  
  383.  
  384.                                      AREAFIX
  385.  
  386.  
  387.          Integrated AREAFIX: works on SQUISH configuration file (No
  388.          Areas.bbs). Works OK with 3D (fakenet) or 4D points.
  389.          To link/unlink areas: Send a netmail message to AreaFix using
  390.          your password as the subject. You can add "-Q", "-L" and "-R"
  391.          in the subject field, after the password.
  392.  
  393.          -Q: to request a list of available areas.
  394.          -L: to request a sysop-defined message (usually a description
  395.              of some or all areas.
  396.          -R: to request the rescan of the specified areas.
  397.  
  398.          In the body of the message, you must list the TAGS of the
  399.          areas you want to link or rescan. If you want to unlink an
  400.          area, preceed the area name with a '-' (e.g. -CHATTER). More
  401.          than one area tag can be put on the same line.
  402.  
  403.          The password and area tags are not case-sensitive.
  404.  
  405.          See Nmfwd.Cfg for more details.
  406.  
  407.  
  408.  
  409.                               RETURN TO SENDER
  410.  
  411.  
  412.          Integrated ReturnToSender based on V7 Nodelist, such as the
  413.          one generated by FastLst. RTS checks the originating and
  414.          destination addresses of all new netmail messages.
  415.  
  416.          If the originating address is not found, then a short warning
  417.          for the addressee is inserted in the message text.
  418.  
  419.          If the destination address is not found, then the message is
  420.          stopped (marked as sent) and a short message is sent to the
  421.          sender.
  422.  
  423.          If both the addresses are not found, then the message is
  424.          stopped and a short message is sent to the SysOp.
  425.  
  426.          An optional check on Routed Echomail is available: if an
  427.          echomail message not addressed to your node is found in the
  428.          netmail area, than it is stopped (marked as sent) and the
  429.          sysop of the originating node is alerted.
  430.  
  431.  
  432.  
  433.  
  434.                              RETURN RECEIPT REQUEST
  435.  
  436.  
  437.          You can enable the generation of Return Receipts for netmail
  438.          messages addressed to your system or your points that come in
  439.          with the Return-Receipt-Request flag set or with the "*RR*"
  440.          (case sensitive) string in their subject.
  441.  
  442.          When RRQ is active in the configuration file, if a netmail
  443.          message requests a return receipt, a short receipt is sent to
  444.          the sender, the RRQ flag is stripped from the original
  445.          message, the "*RR*" string is deleted from the subject if
  446.          present, an informative line is added at the head of the
  447.          message body to inform the addressee that a return receipt
  448.          was sent.
  449.  
  450.          If the sender is unlisted and "RTS" is active, than no action
  451.          is taken on messages with RRQ.
  452.  
  453.          The "*RR*" string in the subject is an easy way to ask for
  454.          Return-Receipt when the RRQ flag cannot easily be set by the
  455.          message editor or is stripped by some mail processor.
  456.  
  457.  
  458.  
  459.                                MISCELLANEOUS INFO
  460.  
  461.  
  462.          When UseFB is active, the NewFiles, Dir * and Cont * commands
  463.          of the file-manager use the file-base files instead of looking
  464.          into FILES.BBS and directories.
  465.  
  466.  
  467.  
  468.