home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / nmfw205.zip / NmFwd.Doc < prev    next >
Text File  |  1996-06-18  |  24KB  |  595 lines
  1.         **************************************************************
  2.         *                                                            *
  3.         *                                                            *
  4.         *            **   ** **   ** ******* **   ** *****           *
  5.         *            ***  ** *** ***  **   * **   **  ** **          *
  6.         *            **** ** *******  ** *   **   **  **  **         *
  7.         *            ** **** *******  ****   ** * **  **  **         *
  8.         *            **  *** ** * **  ** *   *******  **  **         *
  9.         *            **   ** **   **  **     *** ***  ** **          *
  10.         *            **   ** **   ** ****     *   *  *****           *
  11.         *                                                            *
  12.         *                                                            *
  13.         *                        Version 2.05                        *
  14.         *                                                            *
  15.         *          A powerful Multi-Robot for Maximus/Squish         *
  16.         *                                                            *
  17.         *                                                            *
  18.         **************************************************************
  19.         *                                                            *
  20.         *       (C) Copyright 1991-1996  Alberto Pasquale            *
  21.         *                                                            *
  22.         *           A L L   R I G H T S   R E S E R V E D            *
  23.         *                                                            *
  24.         **************************************************************
  25.         
  26.         
  27.           "Maximus" and "Squish" are trademarks of Lanius Corporation
  28.         
  29.         
  30.  
  31.                 NmFwd 2.05 User's Manual, by Alberto Pasquale
  32.         
  33.         
  34.                                   INTRODUCTION
  35.         
  36.         
  37.         -> For licensing information, please see License.Doc.
  38.         
  39.         Thanks for evaluating NmFwd: a multi-robot for Maximus/Squish.
  40.         
  41.                                  Main Features
  42.         
  43.         
  44.         - To be used with Squish mail processor and Maximus 3.xx CBCS
  45.           (Trademarks of Lanius Corporation).
  46.           A BinkleyTerm style outbound is required for some features.
  47.         
  48.         - Works on *.MSG or SQUISH netmail area.
  49.         
  50.         - Total or partial forward of NetMail area to (Co)SysOp's point.
  51.         
  52.         - Selective Flag (Crash, Direct) Stripping.
  53.         
  54.         - 3D and 4D point handling (even mixed).
  55.         
  56.         - Boss Routing capability to BossRoute all the crash and direct
  57.           messages addressed to points that are not found in your V7
  58.           nodelist or have a null phone number.
  59.         
  60.         - Point Remapping based on To-Name.
  61.         
  62.         - FileAttach forwarding between points in a dedicated directory,
  63.           with optional automatic file-killing after configured time.
  64.         
  65.         - Automatic Upload for Points via NetMail Robot.
  66.         
  67.         - Complete User Management functions via NetMail Robot (Max 3.xx).
  68.         
  69.         - Complete File Management functions via NetMail Robot (Max 3.xx),
  70.           with flexible privilege and keys handling.
  71.         
  72.         - Automatic (internal) filebase update.
  73.         
  74.         - Areafix functions for Squish.Cfg.
  75.         
  76.         - Return To Sender functions to stop messages addressed to
  77.           unlisted nodes and routed echomail (based on V7 nodelist).
  78.         
  79.         - Support for the V7 .BSY semaphore, as per FastLst specs.
  80.         
  81.         - Return Receipt generation for messages that have the RRQ
  82.           flag set or the "*RR*" string in their subject (standard
  83.           proposed by Alex Palmese of 2:335/317).
  84.         
  85.         
  86.                                     CREDITS
  87.         
  88.         "BinkleyTerm" is a trademark of Bit Bucket Software Co.
  89.         
  90.         This program uses the Squish "MsgAPI" code, Copyright 1991-1994
  91.         by Lanius Corporation. "Squish" and "Maximus" are trademarks of
  92.         Lanius Corporation.
  93.         
  94.  
  95.         
  96.                                OVERALL OPERATION
  97.         
  98.         
  99.         To speed up netmail scanning, NmFwd scans only new messages. To
  100.         accomplish this, it uses an advanced algorithm for *.MSG (the
  101.         necessary information is stored in the NMFWDDIR.DAT located in
  102.         the related directory) and the UID (Unique ID) for the Squish
  103.         base (stored in the <netmail>.NFD file).
  104.         
  105.         In the case you change a message after it has been processed
  106.         (Squish base), it will not be rescanned. So, if you want it
  107.         processed, you must copy then change, not simply change the
  108.         message.
  109.         
  110.         All the messages addressed to your points are directly packed
  111.         to *.?ut in the OUTBOUND.SQ by NmFwd. This is necessary to
  112.         allow correct operations of the Netmail Forwarding functions in
  113.         a mixed 3D-4D environment and for the BossRoute option.
  114.         
  115.         
  116.                                  FLAGS HANDLING
  117.         
  118.         
  119.         If the original message has one of the following flags
  120.         (FileRequest, UpdateRequest), the forwarded one will have a
  121.         two letter upper-case symbol on the first line (FR, UR).
  122.         
  123.         If a Crash message comes from a point authorized to send DM
  124.         only, the Hold attribute is set in order to change the Crash
  125.         flavour to Direct (Squish handles the sum of Crash and Hold
  126.         as Direct). The forwarded copy will have a "cm" lower-case
  127.         symbol on the first line of the message.
  128.         
  129.         If a Crash message comes from a system that is not authorized
  130.         to send neither Crash nor Direct mail, the crash flag will be
  131.         reset and a "cm" symbol will be inserted in forwarded copies.
  132.         
  133.         If a Direct message (Crash and Hold flags set) comes from a
  134.         system that is not authorized, the crash and hold flags will
  135.         be reset and the "dm" symbol will be inserted in forwarded
  136.         copies.
  137.         
  138.         
  139.         
  140.                                   INSTALLATION
  141.         
  142.         
  143.         1) (OS/2): Make sure you have the MSGAPI32.DLL in a directory
  144.              contained in your LIBPATH and the PmHatch.Exe program in
  145.              your PATH. MSGAPI32.DLL can be found in the Squish 1.11
  146.              archive (SQSHP111.LZH).
  147.         
  148.            (NT): Make sure you have the MSGAPINT.DLL in a directory
  149.              contained in your PATH. MSGAPINT.DLL can be found in the
  150.              Max 3.01 for Windows archive (MAX301N.ZIP).
  151.         
  152.            (DOS): Make sure you have the DOS4GW.EXE Dos extender (from
  153.              Rational System Inc.) in your path.
  154.         
  155.              The DOS4GW extender requires an XMS or DPMI memory driver
  156.              installed in your config.sys: e.g. HIMEM.SYS, QEMM (by
  157.              QuarterDeck Office Systems Inc.).
  158.         
  159.         2) Edit nmfwd.cfg following the comments in it.
  160.         
  161.         3) Edit your batch file in order to call nmfwd BEFORE netmail
  162.            packing.
  163.         
  164.            Example 1 (two pass):
  165.         
  166.                     Squish In Out
  167.                     NmFwd
  168.                     Squish Squash -sNrm
  169.         
  170.            Example 2 (one pass):
  171.         
  172.                     Squish In Out Squash -o -sNrm
  173.                     NmFwd
  174.                     Squish Squash -sNrm
  175.         
  176.            Note: - The -o switch prevents squish from packing netmail
  177.                    before Nmfwd has a chance to process it.
  178.                  - You may need additional calls to squish to process
  179.                    echomail generated locally.
  180.         
  181.            Example 3 (separate echo and netmail routing, SqPrv local
  182.                       echomail processor and Nef tic processor used):
  183.         
  184.            sqrem
  185.            squish in out squash -sECHO -o
  186.            nef
  187.            squnrem
  188.            squish in
  189.            sqprv
  190.            squish out squash -sECHO -o
  191.            nmfwd
  192.            squish squash -sNET
  193.         
  194.         
  195.         
  196.                              Command line switches
  197.         
  198.         
  199.         -c<cfgfile>
  200.         -l<logfile>
  201.         
  202.         Example: NMFWD -cc:\max\nmfwd.cfg -lc:\log\nmfwd.log
  203.         
  204.         
  205.         
  206.                                   ERRORLEVELS
  207.         
  208.         
  209.           0 - All OK.
  210.           1 - Help requested
  211.           3 - Abnormal Termination.
  212.           4 - Cfg Error.
  213.           9 - Error accessing Maximus PRM file.
  214.          10 - Error updating/accessing FileBase.
  215.          11 - Nodelist Busy.
  216.         128 - Too many new messages (*.MSG).
  217.               The current limit (providing there is enough free memory)
  218.               is of 32768 messages numbered between 1 and 65535.
  219.         251 - Config file not found.
  220.         252 - Error on command line.
  221.         253 - MsgApi error.
  222.         254 - Can't open Log file.
  223.         255 - Out of memory.
  224.         
  225.         
  226.         
  227.                                CONFIGURATION FILE
  228.         
  229.         
  230.         NmFwd requires a configuration file (defaults to
  231.         NmFwd.Cfg). Before using NmFwd you should edit this file,
  232.         following the comments in the sample one.
  233.         
  234.         The names of the various parameters are NOT case sensitive.
  235.         Items in square brackets ([]) are optional.
  236.         
  237.         
  238.         
  239.                             USER MANAGEMENT COMMANDS
  240.         
  241.         
  242.         You must send a private net-mail message to your robot, using
  243.         the requested password as subject (see the .cfg for details).
  244.         The Syntax of commands (to be put in the text) is:
  245.         
  246.         Username[,Username,Username ...] = Action[,Action, Action ...]
  247.         
  248.         You can list a maximum of 30 Usernames and 30 Actions per
  249.         command. You can use "(<acs>)" as a valid Username
  250.         (where <acs> is a Maximus 3.xx access string).
  251.         
  252.         Examples:
  253.         
  254.         (Extra|Normal/EFP) = list
  255.         
  256.         Requests a list of users that have at least the "Extra"
  257.         privilege or the "Normal" one together with the E,F,P
  258.         keys.
  259.         
  260.         
  261.         (=twit) = Level disgrace
  262.         
  263.         Gives the disgrace privilege to all twit
  264.         users.
  265.         
  266.         
  267.         (0/h) = Level favored
  268.         
  269.         Gives the favored privilege to all users that have the
  270.         h key (except for those that have a privilege above
  271.         MAXLEV).
  272.         
  273.         
  274.         (=disgrace/kj) = Level normal
  275.         
  276.         Gives the normal privilege to all disgrace users that
  277.         have both the k and j keys.
  278.         
  279.         
  280.         All the listed actions will be applied in the listed order
  281.         to all of the listed users.  You can write many commands in
  282.         the same message, provided they are separated by a <CR>.
  283.         Every command may be more than 80 chars but it cannot contain
  284.         carriage returns.
  285.         
  286.         In the case you are unsure whether your message editor really
  287.         inserts carriage returns between long command lines, just
  288.         leave a blank line between any two commands.
  289.         
  290.         
  291.         Examples:
  292.         
  293.         Albert MacGiver = Level Normal
  294.         Franz Cormack, Robert Harris = Level Extra, Keys net
  295.         
  296.         The available actions are:
  297.         
  298.         (The MaxLev option in .cfg allows to inhibit the action on
  299.         higher privileges)
  300.         
  301.         
  302.         Level <level>        - set the <level> privilege.
  303.                                <level> can be any level name
  304.                                defined in Maximus Access.Ctl or
  305.                                a legal level number.
  306.         
  307.                              E.g.
  308.         
  309.                                Level Normal
  310.                                Level 55
  311.         
  312.         Report               - give full report on user record
  313.                                "Permanent" records are marked with a '@'
  314.                                before the user name.
  315.                                "Deleted" records are marked with a '#'
  316.                                before the user name.
  317.         
  318.         List                 - list username with his privilege and
  319.                                keys
  320.         
  321.         Kill                 - Mark the user record as deleted
  322.         
  323.         Avatar               - Set Avatar screen mode
  324.         
  325.         Ansi                 - Set ANSI screen mode
  326.         
  327.         TTY                  - Set TTY screen mode
  328.         
  329.         City <cityname>      - set the user city
  330.         
  331.         Password <password>  - set the user password.
  332.                                If Maximus is configured to use
  333.                                encrypted passwords, the new
  334.                                password will be encrypted the
  335.                                next time maximus accesses the
  336.                                user record.
  337.         
  338.         Phone <userphone>    - set the user telephone
  339.         
  340.         Alias <useralias>    - set the user alias
  341.         
  342.         Help <helplevel>     - set the user help level
  343.                                (Expert|Regular|Novice)
  344.         
  345.         CLS <yes|no>         - set the "Clear Screen allowed" flag
  346.         
  347.         UsedMax <yes|no>     - set the "Not first-time user" flag
  348.         
  349.         IbmChars <yes|no>    - set the IBM graphics flag
  350.         
  351.         RIP <yes|no>         - set the RIP graphics flag
  352.         
  353.         MaxEd <yes|no>       - set the MaxEd full screen editor flag
  354.         
  355.         More <yes|no>        - set the More flag
  356.         
  357.         InUserList <yes|no>  - set the "Show in UserList" flag
  358.         
  359.         Tabs <yes|no>        - set the "Tabs allowed" flag
  360.         
  361.         Nerd <yes|no>        - set the Nerd flag (don't sound when
  362.                                yelling)
  363.         
  364.         ChatAvail <yes|no>   - set the "Available for Chat" flag
  365.         
  366.         HotKeys <yes|no>     - set the "Uses HotKeys" flag
  367.         
  368.         FSReading <yes|no>   - set the "Full Screen Reading" flag
  369.         
  370.         Perm <yes|no>        - set the "User is PERManent" flag
  371.         
  372.         Language <langname>  - select the language
  373.         
  374.         Nulls <nnulls>       - select the number of nulls
  375.         
  376.         Up   <[+|-]upK>
  377.         Down <[+|-]downK>    - set the total up/download in KiloBytes,
  378.                                optional +|- to add|subtract to|from
  379.                                the total.
  380.         
  381.         UpFiles   <[+|-]n>
  382.         DownFiles <[+|-]n>   - set the total number of files
  383.                                up/downloaded, optional +|- to
  384.                                add|subtract to|from the total.
  385.         
  386.         Credit <[+|-]n>
  387.         Debit  <[+|-]n>      - set the user credit/debit (n in 0..65535),
  388.                                optional +|- to add|subtract
  389.                                to|from the total debit.
  390.         
  391.         CreditPoints <[+|-]n>
  392.         DebitPoints  <[+|-]n> - set the user allocated/used points,
  393.                                 optional +|- to add|subtract
  394.                                 to|from the total.
  395.         
  396.         Keys [+]<setkeys>[-<resetkeys>] - set/reset the listed keys;
  397.                                e.g. Keys abc     set keys a, b, c
  398.                                     Keys -abc    reset keys a, b, c
  399.                                     Keys abc-de  set keys a, b, c;
  400.                                                  reset keys d, e.
  401.                                     Keys +abc-de set keys a, b, c;
  402.                                                  reset keys d, e.
  403.         
  404.         ExpDate <expdate>  - set the Expiration date (dd-mm-yy),
  405.                              set the "Expire by date" flag and reset
  406.                              the "Expire by minutes" flag. If no
  407.                              <expdate> is given, reset the "Expire
  408.                              by date" flag. Example:
  409.                              ExpDate 13-May-92
  410.                              ExpDate 13-May-1992
  411.                              ExpDate 13-05-1992
  412.                              ExpDate 13-05-92 (Expire on May 13th 92)
  413.         
  414.         ExpMins <expmins>  - set the Expiration minutes, set the
  415.                              "Expire by minutes" flag and reset the
  416.                              "Expire by date" flag.
  417.                              If no <expmins> is given, reset the
  418.                              "Expire by mins" flag.
  419.         
  420.         ExpNone            - Reset Expire mode flags (ExpAxe and
  421.                              ExpDemote)
  422.         
  423.         ExpDemote <Priv>   - set the Expire->Demote flag and Priv
  424.                              level to demote to.
  425.         
  426.         ExpAxe             - set the Expire->Axe flag
  427.         
  428.         Append             - append a new user record: a default one
  429.                              will be appended. Obviously this must be
  430.                              the first command and can be followed by
  431.                              other commands specifying new parameters
  432.                              for the user. The default is:
  433.         
  434.                              Privilege: 0
  435.                              Help: Novice
  436.                              Screen mode: TTY
  437.                              Language: The first.
  438.                              Columns: 80
  439.                              Rows: 24
  440.                              UsedMax: No
  441.                              MaxEd: Yes
  442.                              More: No
  443.                              HotKeys: No
  444.                              IbmChars: No
  445.                              RIP: No
  446.                              Tabs: No
  447.                              CLS: No
  448.                              FSReading: No
  449.                              All other fields are zeroed.
  450.         
  451.         
  452.         
  453.                                 FILE MANAGEMENT
  454.         
  455.         
  456.         See FMAN.HLP and NMFWD.CFG for details on the FileManagement
  457.         Commands.
  458.         
  459.         OS/2 NOTE:
  460.         
  461.         The Touch command and all the FileManager functions use
  462.         the Maximus 3.xx convention for the file dates on HPFS.
  463.         
  464.         The modification date is shown in reports (just as with
  465.         the OS/2 DIR command), the creation one is used as the
  466.         "upload date" to compute the "age" of files.
  467.         
  468.         Thus the output of a "newfiles 10" command could show
  469.         files with dates much older than 10 days, provided they
  470.         have been uploaded (or touched) during the last 10
  471.         days.
  472.                  
  473.         
  474.         
  475.                                     AREAFIX
  476.         
  477.         
  478.         Integrated AREAFIX: works on SQUISH configuration file (No
  479.         Areas.bbs). Works OK with 3D (fakenet) or 4D points.
  480.         To link/unlink areas: Send a netmail message to AreaFix using
  481.         your password as the subject. You can add "-Q", "-L",
  482.         "-R" and "-H" in the subject field, after the password.
  483.         
  484.         -Q: to request a list of available areas.
  485.         -L: to request a sysop-defined message (usually a description
  486.             of some or all areas).
  487.         -R: to request the rescan of the specified areas (SqPrv
  488.             areas are automatically excluded from rescan).
  489.         -H: to get help.
  490.         
  491.         The same goals can be achieved by using some special
  492.         commands in the message body: %Query, %List, %Rescan,
  493.         %Help respectively.
  494.         
  495.         In the body of the message, you must list the TAGS of the
  496.         areas you want to link or rescan (optionally with a leading
  497.         '+'). If you want to unlink an area, preceed the area name
  498.         with a '-' (e.g. -CHATTER). More than one area tag can be
  499.         specified on the same line.
  500.         
  501.         The password and area tags are not case-sensitive.
  502.         
  503.         See Nmfwd.Cfg for more details.
  504.         
  505.         
  506.                                 RETURN TO SENDER
  507.         
  508.         
  509.         Integrated ReturnToSender based on V7 Nodelist, such as the
  510.         one generated by FastLst. RTS checks the originating and
  511.         destination addresses of all new netmail messages.
  512.         
  513.         If the originating address is not found, then a short warning
  514.         for the addressee is inserted in the message text.
  515.         
  516.         If the destination address is not found, then the message is
  517.         stopped (marked as sent) and a short message is sent to the
  518.         sender.
  519.         
  520.         If both the addresses are not found, then the message is
  521.         stopped and a short message is sent to the SysOp.
  522.         
  523.         Note: for points of other systems, the Boss address
  524.         (.0) is checked; for points of the local Boss, the
  525.         entire 4D address is checked, so you need to have your
  526.         points in the V7 nodelist (usually this is not a
  527.         problem since the points must already be in a local
  528.         nodelist in order to have a session password).
  529.         
  530.         Warning: RTS does not check the existence of a point
  531.         when applying the "name remapping" configured with the
  532.         "Remap" statement in NmFwd.Cfg or Squish.Cfg.
  533.         
  534.         An optional check on Routed Echomail is available: if an
  535.         echomail message not addressed to your node is found in the
  536.         netmail area, than it is stopped (marked as sent) and the
  537.         sysop of the originating node is alerted.
  538.         
  539.         
  540.         
  541.                              RETURN RECEIPT REQUEST
  542.         
  543.         
  544.         You can enable the generation of Return Receipts for netmail
  545.         messages addressed to your system or your points that come in
  546.         with the Return-Receipt-Request flag set or with the "*RR*"
  547.         (case sensitive) string in their subject.
  548.         
  549.         When RRQ is active in the configuration file, if a netmail
  550.         message requests a return receipt, a short receipt is sent to
  551.         the sender, the RRQ flag is stripped from the original
  552.         message, the "*RR*" string is deleted from the subject if
  553.         present, an informative line is added at the head of the
  554.         message body to inform the addressee that a return receipt
  555.         was sent.
  556.         
  557.         If the sender is unlisted and "RTS" is active, than no action
  558.         is taken on messages with RRQ.
  559.         
  560.         The "*RR*" string in the subject is an easy way to ask for
  561.         Return-Receipt when the RRQ flag cannot easily be set by the
  562.         message editor or is stripped by some mail processor.
  563.         
  564.         
  565.         
  566.                                MISCELLANEOUS INFO
  567.         
  568.         
  569.         When UseFB is active, the NewFiles, Dir * and Cont * commands
  570.         of the file-manager use the file-base files instead of looking
  571.         into FILES.BBS and directories.
  572.         
  573.         On fast machines, after generating lots of outbound packets,
  574.         NmFwd will automatically pause for a few seconds reporting
  575.         "Waiting <nn> seconds". This is necessary to avoid routing
  576.         mistaked when Squish is invoked just after NmFwd. The same
  577.         thing happens before Nmfwd invokes Squish for rescanning an
  578.         area in response to a areafix rescan request.
  579.         
  580.         NmFwd recognizes SqPrv areas (SqPrv is another program
  581.         of mine) and does NOT allow rescanning.
  582.         
  583.         
  584.                                S H A R E W A R E
  585.         
  586.         
  587.         If you like this program and continue using it, you should pay
  588.         the author for his work, as per the ShareWare concept of
  589.         distribution.
  590.         
  591.         Please see LICENSE.DOC and REGISTER.DOC for information.
  592.         
  593.         Thank you for your interest in ApWorks programs.
  594.         
  595.