home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR4 / REF21.ZIP / REF.DOC < prev    next >
Text File  |  1994-01-31  |  45KB  |  857 lines

  1.                              ┌───────────────┐
  2.                              │  The REF 2.1  │
  3.                              └───────────────┘
  4.  
  5.                          "The Message Area Referee"
  6.  
  7.                       Compliments of:  The HOTware BBS
  8.                               Net/Node 064/003
  9.  
  10.     *    PLEASE DELETE ALL Version 1.5 ARCHIVES, Ver. 1.5 CONTAINS  *
  11.     *             NUMEROUS PROBLEMS AND SHOULD NOT BE USED          *
  12.  
  13.        ──────────────────────────────────────────────────────────────
  14.                                   History
  15.        ──────────────────────────────────────────────────────────────
  16.  
  17.          11-02-92   Ver 1.0 Initial Release
  18.          11-12-92   Ver 1.1 Added /LOG command line parameter.  /LOG
  19.                             will cause a REF.LOG to be kept in
  20.                             <GTPATH>\HOTWARE.
  21.          10-31-93   Ver 1.2 Added the REVIEW flag.  This gives REF the
  22.                             ability to REVIEW messages from select users
  23.                             prior to bagging the message area. Added
  24.                             the /REGISTER feature to REF. Added /NLOG (new
  25.                             log) to REF.
  26.          11-04-93   Ver 1.3 Major Bug Fix!  When using The REF on multiple
  27.                             message areas, the Name's list was not being
  28.                             purged correctly.  The result, any names that
  29.                             were in previously processed message areas were
  30.                             again being processed, even if the names were
  31.                             not listed for that message area.  Please
  32.                             delete version 1.2 of The Ref IMMEDIATELY if
  33.                             you are processing multiple message areas from
  34.                             one configuration file.
  35.          11-07-93   Ver 1.4 Added four new "FLAGS": REVIEW_BY_ORIGIN,
  36.                             MOVE_BY_ORIGIN, KILL_BY_ORIGIN, MARK_BY_ORIGIN.
  37.                             These new "FLAGS" allow you to specify a list
  38.                             of NET/NODE numbers for REF to look for rather
  39.                             than sender names on messages.  When using
  40.                             these new "FLAGS" REF will dynamically build
  41.                             the name list and add any names that it finds
  42.                             in your message area that has any of NET/NODE
  43.                             numbers that you listed. See Discussion below
  44.                             for further information.
  45.           1-01-94   Ver 1.5 Added four new "FLAGS": REVIEW_BY_RECEIVER,
  46.                             MOVE_BY_RECEIVER, KILL_BY_RECEIVER,
  47.                             MARK_BY_RECEIVER. These new "FLAGS" allow you
  48.                             to specify a list of RECEIVE names for REF
  49.                             to look for rather than SENDER names on
  50.                             messages.  When using these new "FLAGS" REF
  51.                             will now look at the message Receivers rather
  52.                             than the message Senders.  Please read the
  53.                             documentation below for further information.
  54.           1-02-94   Ver 1.6 MAJOR BUG FIX RELEASE!  DELETE VERSION 1.5
  55.                             IMMEDIATELY!  Version 1.5 was very overzealous
  56.                             with Deleting Moving and Marking messages and
  57.                             SHOULD NOT BE USED.  Version 1.6 fixes the
  58.                             problems with Deleting Moving and Marking of
  59.                             messages that should not be operated on.  This
  60.                             version also adds a much improved logging
  61.                             logging facility and improved screens.  This
  62.                             version also repairs a problem with comparing
  63.                             one word names.  Previous version were not
  64.                             working with single word names.
  65.           1-18-94   Ver 1.7 Added four new "FLAGS": REVIEW_BY_SUBJECT,
  66.                             MOVE_BY_SUBJECT, KILL_BY_SUBJECT,
  67.                             MARK_BY_SUBJECT. These new "FLAGS" allow you to
  68.                             specify a list of SUBJECTs for REF to look for
  69.                             rather than SENDER or RECEIVER names on
  70.                             messages.  When using any of the SUBJECT flags,
  71.                             the Search text can also match substrings if the
  72.                             first character of the configured subject is a
  73.                             *.  REF is now much more intelligent when using
  74.                             the ORIGIN parameter. Rather than building a
  75.                             name list as before, version 1.7 will look at
  76.                             the ORIGIN of each message prior to operating
  77.                             on it.  The third improvement for this release
  78.                             is a configurable message header. You may now
  79.                             specify what you want REF to report as the
  80.                             reason for the moved message.  Please see the
  81.                             documentation below for details on the above
  82.                             new features.
  83.           1-21-94   Ver 1.8 Added three modifiers to the "FLAGS" argument
  84.                             in REF.CNF.  These modifiers add two major
  85.                             improvements. The REF can now RETURN messages
  86.                             to the sender, and The REF can now be told to
  87.                             only operate on INCOMING or OUTGOING messages
  88.                             specifically.  These modifiers are invoked
  89.                             immediately following your FLAGS argument in
  90.                             REF.CNF in for form of /INBOUND /OUTBOUND
  91.                             /RETURN.  See the documentation below for
  92.                             details on implementation.
  93.           1-22-94   Ver 1.9 REF will now indicate in the LOG File when a
  94.                             message has been RETURNED to the sender.
  95.           1-23-94   Ver 2.0 REF now has the ability to process a GTMDIR.BBS
  96.                             GLOBALLY, and process a list of message areas
  97.                             rather than a single message area.  Along with
  98.                             the GLOBAL processing comes the ability to
  99.                             EXCLUDE specific message areas even though they
  100.                             are listed in the GTMDIR.BBS file. The REF also
  101.                             recognizes a new command line parameter, /C:.
  102.                             This new parameter will allow you to specify a
  103.                             configuration file other than
  104.                             <GTPATH>\HOTWARE\REF.CNF.
  105.           1-31-94   Ver 2.1 REF now has a new "Flag": ROUTE_VIA_NETMAIL.
  106.                             This flag will allow you specify a list of
  107.                             Receivers that you would like to have messages
  108.                             routed to netmail.  When using this "Flag"
  109.                             each receivers name must be followed by the
  110.                             Net/Node to route the message to. This release
  111.                             also has a minor Bug fix.  This version will
  112.                             recognize if the Source and Destination message
  113.                             areas are in the same directory, ie. the same
  114.                             message base.  This was a problem when the
  115.                             Destination area in the REF.CNF was also an
  116.                             area in the GTMDIR.BBS when using the GLOBAL
  117.                             feature.
  118.  
  119.  
  120.        ──────────────────────────────────────────────────────────────
  121.                                 What is It?
  122.        ──────────────────────────────────────────────────────────────
  123.          What in the heck is The REF?  The REF basically acts as a referee
  124.          of a Echo Message Area.  This utility has two modes of operation
  125.          that you can use.  Both of these modes are described below:
  126.  
  127.          1: Creating a true READ-ONLY echo area.
  128.  
  129.              The REF will allow you to specify who IS authorized to post in
  130.              a particular echo.  Any messages that are found in a
  131.              configured echo that were posted by an UNAUTHORIZED user will
  132.              be "refereed".  The sponsor of the echo has three option to
  133.              penalize the offending user.  The REF can either MOVE the
  134.              message, KILL the message, or MARK the message as bagged so
  135.              that it will not echo throughout the network.  All three of
  136.              these flags are classified under READ-ONLY echo mode, and are
  137.              described under CONFIGURATION AND EXECUTION below.
  138.  
  139.          2: REVIEW messages TO or FROM users, by SUBJECT, or by ORIGIN.
  140.  
  141.              The REF will allow you to specify who's messages you would
  142.              like to REVIEW prior to letting them echo to the network.  If
  143.              you have had problems with a particular or several users
  144.              entering messages that are either off topic, vulgar, or
  145.              generally disruptive The REF can help. The REF can move
  146.              messages that are TO or FROM a configured list of user names,
  147.              SUBJECTS, or ORIGINS to an alternate message area for you, the
  148.              sysop or echos sponsor, to REVIEW prior to allowing the
  149.              message to echo.  The REVIEW flags are classified under REVIEW
  150.              echo mode, and are described under CONFIGURATION AND EXECUTION
  151.              below.
  152.  
  153.  
  154.         Not only can REF read a list of User Names that you supply, it can
  155.         also check the ORIGIN Net/Node of messages.  If you are afraid of
  156.         users using alias's, you can provide REF a list of NET/NODE
  157.         numbers.  The REF will then look at the ORIGIN of each message and
  158.         operate on them if applicable.  The REF also has the capability to
  159.         RETURN the messages to the offending user, see the discussion of
  160.         the /RETURN modifier below for details.
  161.  
  162.  
  163.        ──────────────────────────────────────────────────────────────
  164.                                   Why Is It?
  165.        ──────────────────────────────────────────────────────────────
  166.          You may be asking about now, Why would you want to do this?
  167.          It's simple.  Prior to the birth of The REF there was no real way
  168.          of truly forcing an echo to READ ONLY.  Now The REF can monitor
  169.          the actions of the players in a particular echo and throw flags to
  170.          any unauthorized maneuvers.  In real life The REF scans the
  171.          message area looking for users that are Unauthorized and can take
  172.          appropriate action on these messages prior to nightly bagging
  173.          routines.
  174.  
  175.          Further expanding on The REF, you can also truly REVIEW messages
  176.          by users that have a reputation of causing disruption in your echo
  177.          areas.  You can now automatically move messages to an alternate
  178.          message area by user name, review the messages content, and them
  179.          move them and allow them to continue on the echo path at your
  180.          discretion.
  181.  
  182.        ──────────────────────────────────────────────────────────────
  183.                         Configuration and Execution
  184.        ──────────────────────────────────────────────────────────────
  185.          The REF reads a configuration file named REF.CNF from a directory
  186.          off your GTPATH named HOTWARE.  For example if your GTPATH is set
  187.          to C:\GT, the REF.CNF must reside in C:\GT\HOTWARE.  You may also
  188.          tell REF via a command line parameter /C, what configuration file
  189.          to use.  For a complete discussion of the /C parameter, see
  190.          COMMAND LINE PARAMETERS below.
  191.  
  192.  
  193.          REF has two modes of operation READ-ONLY ECHO mode, and REVIEW
  194.          mode.  These two modes will be explained separately and then
  195.          examples will be shown using the two modes in a single
  196.          configuration file.
  197.  
  198.                 ────────────────────────────────────────────
  199.                             READ-ONLY ECHO Mode
  200.                 ────────────────────────────────────────────
  201.  
  202.          The READ-ONLY ECHO Mode looks at a list of users that are
  203.          classified as AUTHORIZED users.  Any users that The REF see's that
  204.          is NOT in the AUTHORIZED list will be penalized.  Under READ-ONLY
  205.          mode you decide whether the message is to be KILLed, MARKed
  206.          bagged, or MOVEd to an alternate area.
  207.  
  208.          If you are afraid that some folks might try to use Alias's to get
  209.          by The REF, you can alternately supply a list of NET/NODE numbers
  210.          that are AUTHORIZED users.  The REF will then look at the .ORIGIN
  211.          of each message and only allow AUTHORIZED NET/NODES. This is done
  212.          through the use of the following flags: KILL_BY_ORIGIN,
  213.          MARK_BY_ORIGIN, MOVE_BY_ORIGIN.
  214.  
  215.          You may also look at the message RECEIVER or SUBJECT instead of
  216.          the message SENDER or ORIGIN.  These options will allow you to
  217.          create a message area that contains only messages TO a particular
  218.          party, or messages that are a on specific SUBJECT.  This is done
  219.          through the use of the following flags: KILL_BY_SUBJECT,
  220.          MARK_BY_SUBJECT, MOVE_BY_SUBJECT, KILL_BY_RECEIVER,
  221.          MARK_BY_RECEIVER, MOVE_BY_RECEIVER.
  222.  
  223.          These are the twelve available "flags" that are used in READ-ONLY
  224.          mode, KILL, MARK, MOVE, KILL_BY_ORIGIN, MARK_BY_ORIGIN,
  225.          MOVE_BY_ORIGIN, KILL_BY_SUBJECT, MARK_BY_SUBJECT, MOVE_BY_SUBJECT,
  226.          KILL_BY_RECEIVER, MARK_BY_RECEIVER, MOVE_BY_RECEIVER
  227.  
  228.                 ────────────────────────────────────────────
  229.                                 REVIEW Mode
  230.                 ────────────────────────────────────────────
  231.  
  232.          The REVIEW Mode looks at a list of users that are classified as
  233.          UN-AUTHORIZED users.  Any users that The REF see's that IS in the
  234.          UN-AUTHORIZED list will be reviewed.  Under REVIEW mode the
  235.          messages will be moved to an alternate area (destination echo as
  236.          described below) for you to REVIEW.
  237.  
  238.          If you are afraid that some folks might try to use Alias's to get
  239.          by The REF, you can alternately supply a list of NET/NODE numbers
  240.          that are UN-AUTHORIZED users.  The REF will then look at the
  241.          .ORIGIN line of each message and classify any messages that match
  242.          a NET/NODE from your list as UN-AUTHORIZED. This is done through
  243.          the use of REVIEW_BY_ORIGIN.
  244.  
  245.          You may also look at the message RECEIVER or SUBJECT instead of
  246.          the message SENDER or ORIGIN.  These options will allow you to
  247.          specify UN-AUTHORIZED SUBJECTS or RECEIVERS.  In other words if
  248.          the SUBJECT or RECEIVER is recognized, The REF will move the
  249.          message to an alternate message area for you.
  250.          This is done through the use of the following flags:
  251.          REVIEW_BY_SUBJECT, REVIEW_BY_RECEIVER.
  252.  
  253.          These are the four available "flags" that are used in REVIEW mode,
  254.          REVIEW, REVIEW_BY_SUBJECT, REVIEW_BY_ORIGIN, REVIEW_BY_RECEIVER.
  255.  
  256.  
  257.                 ────────────────────────────────────────────
  258.                      A Brief Discussion of Each "FLAG"
  259.                 ────────────────────────────────────────────
  260.  
  261.       MOVE       MOVE messages that *ARE NOT* FROM a User.
  262.  
  263.                  The MOVE Flag will read a list of USERS that you supply in
  264.                  your configuration file.  After this list of USERS has
  265.                  been read, The REF will MOVE any messages that *ARE NOT*
  266.                  FROM a user in the list.
  267.  
  268. MOVE_BY_RECEIVER MOVE messages that *ARE NOT* TO a User.
  269.  
  270.                  The MOVE_BY_RECEIVER Flag will read a list USERS that you
  271.                  supply in your configuration file.  This flag works very
  272.                  similar to the MOVE flag, except The REF will look at the
  273.                  message RECEIVER rather than the message SENDER. After
  274.                  this list of USERS have been read The REF will MOVE any
  275.                  messages that *ARE NOT* TO a user in the list.
  276.  
  277. MOVE_BY_SUBJECT  MOVE messages that *ARE NOT* a particular subject.
  278.  
  279.                  The MOVE_BY_SUBJECT Flag will read a list SUBJECTS that
  280.                  you supply in your configuration file.  This flag works
  281.                  very similar to the MOVE flag, except The REF will look at
  282.                  the message SUBJECT rather than the message SENDER. After
  283.                  this list of SUBJECTS have been read The REF will MOVE any
  284.                  messages that *ARE NOT* a particular subject.  This flag
  285.                  in particular will recognize wildcards.  If the first
  286.                  character of your listed SUBJECT is a *, REF will search
  287.                  for the listed subject as a substring of the actual
  288.                  message subject.  For Example:
  289.  
  290.                  Your Specified Subject = *ECHOMAIL
  291.                  Actual Message Subject = 064/003 ECHOMAIL REPORT
  292.  
  293.                  This Subject will be recognized as a match and WILL NOT be
  294.                  moved by the MOVE_BY_SUBJECT parameter.
  295.  
  296.                  Example Without Wildcard:
  297.  
  298.                  Your Specified Subject = ECHOMAIL
  299.                  Actual Message Subject = 064/003 ECHOMAIL REPORT
  300.  
  301.                  This Subject WILL NOT be recognized as a match and WILL
  302.                  be moved by the MOVE_BY_SUBJECT parameter.
  303.  
  304.  
  305.  MOVE_BY_ORIGIN  MOVE messages that *ARE NOT* FROM a Net/Node.
  306.  
  307.                  The MOVE_BY_ORIGIN Flag will read a list of NET/NODEs that
  308.                  you supply in your configuration file.  After this list of
  309.                  NET/NODEs have been read The REF will MOVE any messages
  310.                  that *ARE NOT* FROM a one of these NET/NODEs.  If you
  311.                  select this FLAG, The REF will read each message and look
  312.                  at the .ORIGIN line, comparing them to the list of
  313.                  Net/Nodes you have supplied.  Any messages that ARE NOT
  314.                  from one of the listed Net/Nodes will be moved to an
  315.                  alternate message area.
  316.  
  317.       MARK       MARK messages that *ARE NOT* FROM a User.
  318.  
  319.                  The MARK Flag will read a list of USERS that you supply in
  320.                  your configuration file.  After this list of USERS has
  321.                  been read, The REF will MARK Bagged any messages that *ARE
  322.                  NOT* FROM a user in the list.  This will prevent any
  323.                  messages that are UnAuthorized from being bagged.
  324.  
  325. MARK_BY_RECEIVER MARK messages that *ARE NOT* TO a User.
  326.  
  327.                  The MARK_BY_RECEIVER Flag will read a list of USERS that
  328.                  you supply in your configuration file. This flag works
  329.                  very similar to the MARK flag, except The REF will look at
  330.                  the message RECEIVER rather than the message SENDER. After
  331.                  this list of USERS have been read The REF will MARK Bagged
  332.                  any messages that *ARE NOT* TO a user in the list. This
  333.                  will prevent any messages that are UnAuthorized from being
  334.                  bagged.
  335.  
  336. MARK_BY_SUBJECT  MARK messages that *ARE NOT* a particular subject.
  337.  
  338.                  The MARK_BY_SUBJECT Flag will read a list of SUBJECTS that
  339.                  you supply in your configuration file. This flag works
  340.                  very similar to the MARK flag, except The REF will look at
  341.                  the message SUBJECT rather than the message SENDER. After
  342.                  this list of SUBJECTS have been read The REF will MARK
  343.                  Bagged any messages that *ARE NOT* on a particular
  344.                  subject. This will prevent any messages that are
  345.                  UnAuthorized from being bagged.  This flag in particular
  346.                  will recognize wildcards. If the first character of your
  347.                  listed SUBJECT is a *, REF will search for the listed
  348.                  subject as a substring of the actual message subject.  For
  349.                  Example:
  350.  
  351.                  Your Specified Subject = *ECHOMAIL
  352.                  Actual Message Subject = 064/003 ECHOMAIL REPORT
  353.  
  354.                  This Subject will be recognized as a match and WILL NOT be
  355.                  marked by the MARK_BY_SUBJECT parameter.
  356.  
  357.                  Example Without Wildcard:
  358.  
  359.                  Your Specified Subject = ECHOMAIL
  360.                  Actual Message Subject = 064/003 ECHOMAIL REPORT
  361.  
  362.                  This Subject WILL NOT be recognized as a match and WILL
  363.                  be marked by the MARK_BY_SUBJECT parameter.
  364.  
  365.  
  366.  MARK_BY_ORIGIN  MARK messages that *ARE NOT* FROM a Net/Node.
  367.  
  368.                  The MARK_BY_ORIGIN Flag will read a list of NET/NODEs that
  369.                  you supply in your configuration file.  After this list of
  370.                  NET/NODEs have been read The REF will MARK Bagged any
  371.                  messages that *ARE NOT* FROM a one of these NET/NODEs.
  372.                  This will prevent any messages that are UnAuthorized from
  373.                  being bagged. If you select this FLAG, The REF will read
  374.                  each message and build a list of names that are allowed to
  375.                  post in the message area.  The REF will scan the the
  376.                  messages in the message area, and dynamically build this
  377.                  list by looking at the ORIGIN line of each message.
  378.  
  379.       KILL       KILL messages that *ARE NOT* FROM a User.
  380.  
  381.                  The KILL Flag will read a list of USERS that you supply in
  382.                  your configuration file.  After this list of USERS has
  383.                  been read, The REF will KILL any messages that *ARE NOT*
  384.                  FROM a user in the list.
  385.  
  386. KILL_BY_RECEIVER KILL messages that *ARE NOT* TO a User.
  387.  
  388.                  The KILL_BY_RECEIVER Flag will read a list of USERS that
  389.                  you supply in your configuration file.  This flag works
  390.                  very similar to the KILL flag, except The REF will look at
  391.                  the message RECEIVER rather than the message SENDER.
  392.                  After this list of USERS has been read The REF will KILL
  393.                  any messages that *ARE NOT* TO a user in the list.
  394.  
  395. KILL_BY_SUBJECT KILL messages that *ARE NOT* a particular subject.
  396.  
  397.                  The KILL_BY_SUBJECT Flag will read a list of USERS that
  398.                  you supply in your configuration file.  This flag works
  399.                  very similar to the KILL flag, except The REF will look at
  400.                  the message SUBJECT rather than the message SENDER. After
  401.                  this list of SUBJECTS have been read The REF will KILL any
  402.                  messages that *ARE NOT* on a particular subject.  This
  403.                  flag in particular will recognize wildcards. If the first
  404.                  character of your listed SUBJECT is a *, REF will search
  405.                  for the listed subject as a substring of the actual
  406.                  message subject.  For Example:
  407.  
  408.                  Your Specified Subject = *ECHOMAIL
  409.                  Actual Message Subject = 064/003 ECHOMAIL REPORT
  410.  
  411.                  This Subject will be recognized as a match and WILL NOT be
  412.                  killed by the KILL_BY_SUBJECT parameter.
  413.  
  414.                  Example Without Wildcard:
  415.  
  416.                  Your Specified Subject = ECHOMAIL
  417.                  Actual Message Subject = 064/003 ECHOMAIL REPORT
  418.  
  419.                  This Subject WILL NOT be recognized as a match and WILL
  420.                  be killed by the KILL_BY_SUBJECT parameter.
  421.  
  422.  
  423.  KILL_BY_ORIGIN  KILL messages that *ARE NOT* FROM a Net/Node.
  424.  
  425.                  The KILL_BY_ORIGIN Flag will read a list of NET/NODEs that
  426.                  you supply in your configuration file.  After this list of
  427.                  NET/NODEs have been read The REF will KILL any messages
  428.                  that *ARE NOT* FROM a one of these NET/NODEs. If you
  429.                  select this FLAG, The REF will read each message and build
  430.                  a list of names that are allowed to post in the message
  431.                  area.  The REF will scan the the messages in the message
  432.                  area, and dynamically build this list by looking at the
  433.                  ORIGIN line of each message.
  434.  
  435.     REVIEW       MOVE messages that *ARE* FROM a User.
  436.  
  437.                  The REVIEW Flag will read a list of USERS that you supply in
  438.                  your configuration file.  After this list of USERS has
  439.                  been read, The REF will MOVE any messages that *ARE*
  440.                  from a user in the list.
  441.  
  442. REVIEW_BY_RECEIVER MOVE messages that *ARE* TO a User.
  443.  
  444.                    The REVIEW_BY_RECEIVER Flag will read a list of USERS
  445.                    that you supply in your configuration file.  This flag
  446.                    works very similar to the REVIEW flag, except The REF
  447.                    will look at the message RECEIVER rather than the
  448.                    message SENDER.  After this list of USERS have been read
  449.                    The REF will MOVE any messages that *ARE* TO a user in
  450.                    the list.
  451.  
  452. ROUTE_VIA_NETMAIL  MOVE messages that *ARE* TO a User And Apply the
  453.                    NET/NODE Address as supplied.
  454.  
  455.                    The ROUTE_VIA_NETMAIL Flag works identical as the
  456.                    REVIEW_BY_RECEIVER except you may also supply a Net/Node
  457.                    address to place in the message header.  This flag will
  458.                    read a list of USERS that you supply in your
  459.                    configuration file.  After this list of USERS have been
  460.                    read The REF will MOVE any messages that *ARE* TO a user
  461.                    in the list.  The list is specified somewhat differently
  462.                    than the other flags.  The user list must be configured
  463.                    as:
  464.  
  465.                    Rob Roesch,064/003
  466.                    Jim Knight,064/001
  467.  
  468.                    You must also make sure that the destination message
  469.                    area as listed in you REF.CNF file is listed as a
  470.                    Netmail Message area in your GTMDIR.BBS.  Unless this
  471.                    message are is a valid netmail message area this feature
  472.                    will not work correctly. Please see the example
  473.                    configurations below for more explanation.
  474.  
  475.  
  476. REVIEW_BY_SUBJECT MOVE messages that *ARE* a particular subject.
  477.  
  478.                    The REVIEW_BY_SUBJECT Flag will read a list of SUBJECTS
  479.                    that you supply in your configuration file.  This flag
  480.                    works very similar to the REVIEW flag, except The REF
  481.                    will look at the message SUBJECT rather than the message
  482.                    SENDER.  After this list of SUBJECTS have been read The
  483.                    REF will MOVE any messages that *ARE* on a particular
  484.                    subject. This flag in particular will recognize
  485.                    wildcards. If the first character of your listed SUBJECT
  486.                    is a *, REF will search for the listed subject as a
  487.                    substring of the actual message subject.  For Example:
  488.  
  489.                    Your Specified Subject = *ECHOMAIL
  490.                    Actual Message Subject = 064/003 ECHOMAIL REPORT
  491.  
  492.                    This Subject will be recognized as a match and WILL be
  493.                    moved by the REVIEW_BY_SUBJECT parameter.
  494.  
  495.                    Example Without Wildcard:
  496.  
  497.                    Your Specified Subject = ECHOMAIL
  498.                    Actual Message Subject = 064/003 ECHOMAIL REPORT
  499.  
  500.                    This Subject WILL NOT be recognized as a match and WILL
  501.                    NOT be moved by the REVIEW_BY_SUBJECT parameter.
  502.  
  503.  
  504. REVIEW_BY_ORIGIN   MOVE messages that *ARE* FROM a Net/Node.
  505.  
  506.                  The REVIEW_BY_ORIGIN Flag will read a list of NET/NODEs
  507.                  that you supply in your configuration file.  After this
  508.                  list of NET/NODEs have been read The REF will MOVE any
  509.                  messages that *ARE* from a one of these NET/NODEs.  If you
  510.                  select this FLAG, The REF will read each message and build
  511.                  a list of names that are allowed to post in the message
  512.                  area.  The REF will scan the the messages in the message
  513.                  area, and dynamically build this list by looking at the
  514.                  ORIGIN line of each message.
  515.  
  516.                 ────────────────────────────────────────────
  517.                                Flag Modifiers
  518.                 ────────────────────────────────────────────
  519.  
  520.          The REF will recognize three distinct modifiers for each of
  521.          the FLAGS above.  The three modifiers that are recognized are
  522.          /INBOUND /OUTBOUND or /RETURN.  Please note the /INBOUND and
  523.          /OUTBOUND cannot be used simultaneously, but /RETURN may be used
  524.          in combination with either of the other two modifiers.
  525.  
  526.          The purpose of the modifiers are as follows:
  527.  
  528.          /INBOUND  Process ONLY Inbound messages.  If the Incoming flag is
  529.                    not set and you are using this modifier this message will
  530.                    be ignored.
  531.  
  532.         /OUTBOUND  Process ONLY Outbound messages.  If the Incoming flag IS
  533.                    set and you are using this modifier this message will
  534.                    be ignored.
  535.  
  536.         /RETURN    The RETURN modifier will cause any unauthorized messages
  537.                    to be RETURNED to the author of the message.  The
  538.                    default for The REF when this modifier is not in use is
  539.                    to simply move the offending message to an alternate
  540.                    area leaving the message Sender and Receiver intact.
  541.                    When this modifier is used the message will be have The
  542.                    REF x.xx as the Sender and the original author as the
  543.                    Receiver.  The Ref will also extract the .ORIGIN
  544.                    Net/Node address from the message and address it back to
  545.                    the sender.  This allows you to configure your netmail
  546.                    message area in the Destination Message Area Path in
  547.                    your REF.CNF.  Please note that this flag is not valid
  548.                    when using the ROUTE_VIA_NETMAIL flag.
  549.  
  550.                 ──────────────────────────────────────────── 
  551.                  Example Single Section Configuration File:
  552.                 ────────────────────────────────────────────
  553.  
  554. E:\READONLY  READ-ONLY Echo     <- Echo Path and Name to Referee
  555. E:\DESTAREA  Destination Echo   <- Destination Path and Name for Moves
  556. MOVE /RETURN This Is A RO Echo  <- Flag, Optional Modifier, and Optional Text
  557.     Rob Roesch                  <-
  558.     Jim Wilson                  <--User List To Search
  559.     Jim Knight                  <-
  560. END                             <- END to specify END OF LIST
  561.  
  562.  
  563.          The Configuration File is laid out in sections as shown above.
  564.          The above seven lines show ONE section of a complete configuration
  565.          files.  You are allowed to have as many sections in your config
  566.          file as you like, as long as each section ends with an END
  567.          statement as shown above.  Each section contains five individual
  568.          components.
  569.  
  570.          Line 1:
  571.                     This is the full path and name of the message area to
  572.                     search for matches.  If you do not supply a name here
  573.                     The REF will title the message area UN-NAMED MESSAGE
  574.                     AREA.
  575.  
  576.                     You may alternately indicate here that you would like
  577.                     to process GLOBALLY all message areas listed in the
  578.                     GTMDIR.BBS, or an alternate GTMDIR.BBS.  If you would
  579.                     like to do GLOBAL processing the Pathname is replaced
  580.                     with the work GLOBAL.  If you would like to use a
  581.                     GTMDIR.BBS other than the one found in the GTPATH
  582.                     directory you may specify the full path and name of the
  583.                     file.  For example, if you placed the following on the
  584.                     first line:
  585.  
  586.                     GLOBAL
  587.  
  588.                     The REF would GLOBALLY process all message areas found
  589.                     in C:\GT\GTMDIR.BBS
  590.  
  591.                     If you placed the following on the first line:
  592.  
  593.                     GLOBAL C:\GT\ALTGTMDR.BBS
  594.  
  595.                     The REF would GLOBALLY process all message areas found
  596.                     in C:\GT\ALTGTMDR.BBS.
  597.  
  598.          Line 2:
  599.                     This is the full path and name of the destination
  600.                     message area you would like messages to be moved to. If
  601.                     you do not supply a name here The REF will title the
  602.                     message area UN-NAMED MESSAGE AREA.
  603.  
  604.          Line 3:
  605.                     The third line of each section must start with one
  606.                     "flag", MOVE, KILL, MARK, or REVIEW, MOVE_BY_ORIGIN,
  607.                     KILL_BY_ORIGIN, MARK_BY_ORIGIN, REVIEW_BY_ORIGIN,
  608.                     MOVE_BY_RECEIVER, KILL_BY_RECEIVER, MARK_BY_RECEIVER,
  609.                     REVIEW_BY_RECEIVER, ROUTE_VIA_NETMAIL, MOVE_BY_SUBJECT,
  610.                     KILL_BY_SUBJECT, MARK_BY_SUBJECT, REVIEW_BY_SUBJECT.
  611.  
  612.                     In addition to the "flag" you may specify flag
  613.                     Modifiers to alter The REF's scrutiny.  The available
  614.                     modifiers are /INBOUND /OUTBOUND or /RETURN.  All three
  615.                     are detailed above.
  616.  
  617.                     In addition to the "flag" and optional modifiers, you
  618.                     may create your own text for The REF to use in the
  619.                     Header that is applied when the message is moved to an
  620.                     alternate area.  If you do not specify any text here,
  621.                     the default messages will be used.  The default text
  622.                     that is used is as follows:
  623.  
  624.                     DEFAULT REVIEW MODE TEXT:
  625.  
  626.                            ──────── *** ────────
  627.                         This Message Was Moved From
  628.                            Your Message Area Name
  629.                     For The Purpose of Sysop Examination
  630.                                By The REF x.x
  631.                            ──────── *** ────────
  632.  
  633.  
  634.                     DEFAULT READ-ONLY MODE TEXT:
  635.  
  636.                            ──────── *** ────────
  637.                         This Message Was Moved From
  638.                            Your Message Area Name
  639.                                By The REF x.x
  640.                            ──────── *** ────────
  641.  
  642.  
  643.                If you specify text following the "flag" your message
  644.                will be customized with your text.  For example if you
  645.                place MOVE BECAUSE YOU ARE UNAUTHORIZED on line 3, your
  646.                text will look like the following:
  647.  
  648.                            ──────── *** ────────
  649.                         This Message Was Moved From
  650.                            Your Message Area Name
  651.                         BECAUSE YOU ARE UNAUTHORIZED
  652.                                By The REF x.x
  653.                            ──────── *** ────────
  654.  
  655.  
  656.         Line 4-?:
  657.                     Line four is the start of the "Users List" if you are
  658.                     using MOVE, KILL, MARK, REVIEW, MOVE_BY_RECEIVER,
  659.                     KILL_BY_RECEIVER, MARK_BY_RECEIVER, or
  660.                     REVIEW_BY_RECEIVER, or ROUTE_VIA_NETMAIL.
  661.                     When using the ROUTE_VIA_NETMAIL you must specify a
  662.                     net/node destination in the form:  Rob Roesch,064/003
  663.  
  664.  
  665.                     Line four is the start of the "Net/Node List" if you
  666.                     are using MOVE_BY_ORIGIN, KILL_BY_ORIGIN,
  667.                     MARK_BY_ORIGIN, or REVIEW_BY_ORIGIN. You may have up to
  668.                     1000 entries in this list.
  669.  
  670.                     Line four is the start of the "Subject List" if you are
  671.                     using MOVE_BY_SUBJECT, KILL_BY_SUBJECT,
  672.                     MARK_BY_SUBJECT, or REVIEW_BY_SUBJECT. You may have up
  673.                     to 1000 entries in this list.
  674.  
  675.                     If you are using the GLOBAL parameter on line 1 of the
  676.                     configuration file, you may include EXCLUDE lines for
  677.                     any message areas that you would like to EXCLUDE: from
  678.                     processing.  For example if you used the following
  679.                     configuration:
  680.  
  681. GLOBAL C:\GT\ALTGTMDR.BBS
  682. E:\DESTAREA My Destination Echo
  683. MOVE  Because It Was From An Un-Authorized User
  684.     EXCLUDE:C:\GTMAIL\GENERAL
  685.     Rob Roesch
  686.     Jim Knight
  687. END
  688.  
  689.                     All message areas found in C:\GT\ALTGTMDR.BBS will be
  690.                     processed EXCEPT C:\GTMAIL\GENERAL.  To EXCLUDE message
  691.                     areas from the global process simply put
  692.                     EXCLUDE:<PATHNAME> in the name/netnode listing.
  693.  
  694.         Last Line:
  695.                     The last line of each section MUST be END.  The REF
  696.                     will continue to read each line as a user name until it
  697.                     see's END.
  698.  
  699.                 ────────────────────────────────────────────
  700.                 Example Multiple Section Configuration File:
  701.                 ────────────────────────────────────────────
  702.  
  703.            The following example uses six individual sections
  704.            to create a multiple section configuration file.
  705.  
  706. E:\READONLY My READ-ONLY Echo
  707. E:\DESTAREA My Destination Echo
  708. MOVE  Because It Was From An Un-Authorized User
  709.     Rob Roesch
  710.     Jim Wilson
  711.     Jim Knight
  712. END
  713. E:\GTDIGEST  GT-ONE Digest Echo
  714. E:\GTPNSYSOP GT-ONE International Echo
  715. MOVE
  716.     Perry Alexander
  717.     Bob Butcher
  718. END
  719. GLOBAL C:\GT\ALTGTMDR.BBS
  720. E:\GTMAIL\SEEDS Destination for SEED Messages
  721. MOVE Because I Wanted To Get It Out Of The Way
  722.     EXCLUDE:C:\GTMAIL\E02\507
  723.     SEED
  724. END
  725. E:\MYECHO  My Fabulous Echo
  726. E:\NETMAIL My Netmail Message Area
  727. REVIEW_BY_ORIGIN /RETURN You Are Unauthorized To Use This Echo
  728.     064/001
  729.     032/001
  730. END
  731. E:\MYNEWECHO  My New Echo
  732. E:\NEWREVIEW  My New Echo Review Area
  733. REVIEW
  734.     Jim Knight
  735.     Perry Alexander
  736. END
  737. E:\NETMAIL1 My Netmail #1 Area
  738. E:\NETMAIL2 My Netmail #2 Area
  739. REVIEW_BY_SUBJECT /INCOMING Because I Wanted To Get It Out Of The Way
  740.     *ECHOMAIL REPORT
  741.     RETURN RECEIPT
  742. END
  743. E:\MYECHO My Echomail Area
  744. E:\NETMAIL My Netmail Area
  745. ROUTE_VIA_NETMAIL
  746.     Mike Powell,010/022
  747. END
  748.  
  749.          In the above example there are seven individual message areas that
  750.          fall under the scrutiny of The REF.  You will also notice that the
  751.          first three sections are READ-ONLY sections and the fourth, fifth,
  752.          and sixth are REVIEW sections.  The last section allows to route
  753.          Mike Powell's messages via netmail.  Note that the third section
  754.          does global processing with an excluded message area.  Also note
  755.          the use of WildCards when using the REVIEW_BY_SUBJECT flag, and
  756.          that INCOMING messages only will be moved.
  757.  
  758.  
  759.          You may place as many individual echos into this config file as
  760.          you find necessary.  There is no limit other than available disk
  761.          space.  The REF will continue to process each file until the End
  762.          of File is reached.....  The above example shows two echos, but
  763.          you can run it with 1 or 5000, it's up to you.....
  764.  
  765.  
  766.        ──────────────────────────────────────────────────────────────
  767.                           Command Line Parameters
  768.        ──────────────────────────────────────────────────────────────
  769.  
  770.          Currently there are three, /LOG /NLOG and /REGISTER.
  771.  
  772.       /LOG       If you want REF to keep a log file for you put /LOG on the
  773.                  command line.  REF will keep an ever growing log file in
  774.                  the HOTWARE directory off the GTPATH directory.
  775.  
  776.       /NLOG      If you want REF to keep a log file for you, erasing any
  777.                  old log file that may be setting around, put /NLOG (new
  778.                  log) on the command line.  REF will erase any old log
  779.                  files, and create a new log file in the HOTWARE directory
  780.                  off the GTPATH directory.
  781.  
  782.       /C:<ALT_CONFIG>
  783.  
  784.                  If you wish to use a Config FIle other than
  785.                  <GTPATH>\HOTWARE\REF.CNF then you can specify a
  786.                  /C:<ALT_CONFIG> where <ALT_CONFIG> is the full path and
  787.                  filename of the file you wish to use for the configuration
  788.                  file.
  789.  
  790.  
  791.       /REGISTER  Kill Protect will the proceed to send me a netmail message
  792.                  informing me that you are using the program.  Please use
  793.                  this feature ONCE.
  794.  
  795.        ──────────────────────────────────────────────────────────────
  796.                               ErrorLevel Exits
  797.        ──────────────────────────────────────────────────────────────
  798.  
  799.               Errorlevel 0:  Good run, no Errors.
  800.               Errorlevel 1:  No GTPATH Environment Variable Set
  801.               Errorlevel 2:  Cannot open REF.CNF
  802.               Errorlevel 3:  Insufficient Memory
  803.  
  804.        ──────────────────────────────────────────────────────────────
  805.                                 Registration
  806.        ──────────────────────────────────────────────────────────────
  807.  
  808.         I am not requesting any money for this program, but I would
  809.         not turn any down either <g>.  If you want to slip $5.00 into
  810.         and envelope I'll accept it.  Although I don't require a
  811.         registration fee I would appreciate knowing that you are using
  812.         the program on a normal basis.  Therefore I have provided a
  813.         simple and easy way for you to register this program.  From
  814.         the DOS prompt type:   
  815.  
  816.  
  817.          REF /REGISTER
  818.  
  819.       The REF will the proceed to send me a netmail message informing
  820.       me that you are using the program.  Please use this feature ONCE.
  821.  
  822.        ──────────────────────────────────────────────────────────────
  823.                             Who Is Responsible for This?
  824.        ──────────────────────────────────────────────────────────────
  825.                                  Rob Roesch
  826.                               The HOTware BBS
  827.                          GT Power Net-Node 064/003
  828.                                 Rt 7 Box 566
  829.                                Mocksville, NC
  830.                          704-492-2081 (USR 16.8 DS)
  831.  
  832.           If you start using this utility, and get a chance, let me know 
  833.           (see above procedures.  If you don't have any use for it, delete
  834.           it for your total refund of all the disk space that it was
  835.           occupying, assuming your operating system works right.  This
  836.           program comes with no warranty, no guarantee, and no promises.
  837.           If it works GREAT, if not let me know and I will gladly take a
  838.           look at it in my spare time.  If you really really really like
  839.           the program and want to make any donations, feel free, but it is
  840.           not a requirement.....
  841.  
  842.        ──────────────────────────────────────────────────────────────
  843.                         Alternate Distribution Sites
  844.        ──────────────────────────────────────────────────────────────
  845.  
  846.            The HOTware Utilities now have alternate Distribution
  847.            Centers for your convenience.  The following BBS always
  848.            have the latest and greatest HOTware utilities online and
  849.            available for download.
  850.  
  851.      BBS Name          BBS Phone          Location     GT Net/Node    Hours
  852.  ┌──────────────────┬───────────────┬────────────────────┬───────┬──────────┐
  853.  │ Laboratory 386   │ 618-549-2322  │ Carbondale IL      │064/400│ 10pm-8am │
  854.  └──────────────────┴───────────────┴────────────────────┴───────┴──────────┘
  855.  
  856.  
  857.