home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR4 / REF19.ZIP / REF.DOC < prev    next >
Text File  |  1994-01-22  |  38KB  |  733 lines

  1.                              ┌───────────────┐
  2.                              │  The REF 1.9  │
  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.  
  96.  
  97.        ──────────────────────────────────────────────────────────────
  98.                                 What is It?
  99.        ──────────────────────────────────────────────────────────────
  100.          What in the heck is The REF?  The REF basically acts as a referee
  101.          of a Echo Message Area.  This utility has two modes of operation
  102.          that you can use.  Both of these modes are described below:
  103.  
  104.          1: Creating a true READ-ONLY echo area.
  105.  
  106.              The REF will allow you to specify who IS authorized to post in
  107.              a particular echo.  Any messages that are found in a
  108.              configured echo that were posted by an UNAUTHORIZED user will
  109.              be "refereed".  The sponsor of the echo has three option to
  110.              penalize the offending user.  The REF can either MOVE the
  111.              message, KILL the message, or MARK the message as bagged so
  112.              that it will not echo throughout the network.  All three of
  113.              these flags are classified under READ-ONLY echo mode, and are
  114.              described under CONFIGURATION AND EXECUTION below.
  115.  
  116.          2: REVIEW messages TO or FROM users, by SUBJECT, or by ORIGIN.
  117.  
  118.              The REF will allow you to specify who's messages you would
  119.              like to REVIEW prior to letting them echo to the network.  If
  120.              you have had problems with a particular or several users
  121.              entering messages that are either off topic, vulgar, or
  122.              generally disruptive The REF can help. The REF can move
  123.              messages that are TO or FROM a configured list of user names,
  124.              SUBJECTS, or ORIGINS to an alternate message area for you, the
  125.              sysop or echos sponsor, to REVIEW prior to allowing the
  126.              message to echo.  The REVIEW flags are classified under REVIEW
  127.              echo mode, and are described under CONFIGURATION AND EXECUTION
  128.              below.
  129.  
  130.  
  131.         Not only can REF read a list of User Names that you supply, it can
  132.         also check the ORIGIN Net/Node of messages.  If you are afraid of
  133.         users using alias's, you can provide REF a list of NET/NODE
  134.         numbers.  The REF will then look at the ORIGIN of each message and
  135.         operate on them if applicable.  The REF also has the capability to
  136.         RETURN the messages to the offending user, see the discussion of
  137.         the /RETURN modifier below for details.
  138.  
  139.  
  140.        ──────────────────────────────────────────────────────────────
  141.                                   Why Is It?
  142.        ──────────────────────────────────────────────────────────────
  143.          You may be asking about now, Why would you want to do this?
  144.          It's simple.  Prior to the birth of The REF there was no real way
  145.          of truly forcing an echo to READ ONLY.  Now The REF can monitor
  146.          the actions of the players in a particular echo and throw flags to
  147.          any unauthorized maneuvers.  In real life The REF scans the
  148.          message area looking for users that are Unauthorized and can take
  149.          appropriate action on these messages prior to nightly bagging
  150.          routines.
  151.  
  152.          Further expanding on The REF, you can also truly REVIEW messages
  153.          by users that have a reputation of causing disruption in your echo
  154.          areas.  You can now automatically move messages to an alternate
  155.          message area by user name, review the messages content, and them
  156.          move them and allow them to continue on the echo path at your
  157.          discretion.
  158.  
  159.        ──────────────────────────────────────────────────────────────
  160.                         Configuration and Execution
  161.        ──────────────────────────────────────────────────────────────
  162.          The REF reads a configuration file named REF.CNF from a directory
  163.          off your GTPATH named HOTWARE.  For example if your GTPATH is set
  164.          to C:\GT, the REF.CNF must reside in C:\GT\HOTWARE.
  165.  
  166.  
  167.          REF has two modes of operation READ-ONLY ECHO mode, and REVIEW
  168.          mode.  These two modes will be explained separately and then
  169.          examples will be shown using the two modes in a single
  170.          configuration file.
  171.  
  172.                 ────────────────────────────────────────────
  173.                             READ-ONLY ECHO Mode
  174.                 ────────────────────────────────────────────
  175.  
  176.          The READ-ONLY ECHO Mode looks at a list of users that are
  177.          classified as AUTHORIZED users.  Any users that The REF see's that
  178.          is NOT in the AUTHORIZED list will be penalized.  Under READ-ONLY
  179.          mode you decide whether the message is to be KILLed, MARKed
  180.          bagged, or MOVEd to an alternate area.
  181.  
  182.          If you are afraid that some folks might try to use Alias's to get
  183.          by The REF, you can alternately supply a list of NET/NODE numbers
  184.          that are AUTHORIZED users.  The REF will then look at the .ORIGIN
  185.          of each message and only allow AUTHORIZED NET/NODES. This is done
  186.          through the use of the following flags: KILL_BY_ORIGIN,
  187.          MARK_BY_ORIGIN, MOVE_BY_ORIGIN.
  188.  
  189.          You may also look at the message RECEIVER or SUBJECT instead of
  190.          the message SENDER or ORIGIN.  These options will allow you to
  191.          create a message area that contains only messages TO a particular
  192.          party, or messages that are a on specific SUBJECT.  This is done
  193.          through the use of the following flags: KILL_BY_SUBJECT,
  194.          MARK_BY_SUBJECT, MOVE_BY_SUBJECT, KILL_BY_RECEIVER,
  195.          MARK_BY_RECEIVER, MOVE_BY_RECEIVER.
  196.  
  197.          These are the twelve available "flags" that are used in READ-ONLY
  198.          mode, KILL, MARK, MOVE, KILL_BY_ORIGIN, MARK_BY_ORIGIN,
  199.          MOVE_BY_ORIGIN, KILL_BY_SUBJECT, MARK_BY_SUBJECT, MOVE_BY_SUBJECT,
  200.          KILL_BY_RECEIVER, MARK_BY_RECEIVER, MOVE_BY_RECEIVER
  201.  
  202.                 ────────────────────────────────────────────
  203.                                 REVIEW Mode
  204.                 ────────────────────────────────────────────
  205.  
  206.          The REVIEW Mode looks at a list of users that are classified as
  207.          UN-AUTHORIZED users.  Any users that The REF see's that IS in the
  208.          UN-AUTHORIZED list will be reviewed.  Under REVIEW mode the
  209.          messages will be moved to an alternate area (destination echo as
  210.          described below) for you to REVIEW.
  211.  
  212.          If you are afraid that some folks might try to use Alias's to get
  213.          by The REF, you can alternately supply a list of NET/NODE numbers
  214.          that are UN-AUTHORIZED users.  The REF will then look at the
  215.          .ORIGIN line of each message and classify any messages that match
  216.          a NET/NODE from your list as UN-AUTHORIZED. This is done through
  217.          the use of REVIEW_BY_ORIGIN.
  218.  
  219.          You may also look at the message RECEIVER or SUBJECT instead of
  220.          the message SENDER or ORIGIN.  These options will allow you to
  221.          specify UN-AUTHORIZED SUBJECTS or RECEIVERS.  In other words if
  222.          the SUBJECT or RECEIVER is recognized, The REF will move the
  223.          message to an alternate message area for you.
  224.          This is done through the use of the following flags:
  225.          REVIEW_BY_SUBJECT, REVIEW_BY_RECEIVER.
  226.  
  227.          These are the four available "flags" that are used in REVIEW mode,
  228.          REVIEW, REVIEW_BY_SUBJECT, REVIEW_BY_ORIGIN, REVIEW_BY_RECEIVER.
  229.  
  230.  
  231.                 ────────────────────────────────────────────
  232.                      A Brief Discussion of Each "FLAG"
  233.                 ────────────────────────────────────────────
  234.  
  235.       MOVE       MOVE messages that *ARE NOT* FROM a User.
  236.  
  237.                  The MOVE Flag will read a list of USERS that you supply in
  238.                  your configuration file.  After this list of USERS has
  239.                  been read, The REF will MOVE any messages that *ARE NOT*
  240.                  FROM a user in the list.
  241.  
  242. MOVE_BY_RECEIVER MOVE messages that *ARE NOT* TO a User.
  243.  
  244.                  The MOVE_BY_RECEIVER Flag will read a list USERS that you
  245.                  supply in your configuration file.  This flag works very
  246.                  similar to the MOVE flag, except The REF will look at the
  247.                  message RECEIVER rather than the message SENDER. After
  248.                  this list of USERS have been read The REF will MOVE any
  249.                  messages that *ARE NOT* TO a user in the list.
  250.  
  251. MOVE_BY_SUBJECT  MOVE messages that *ARE NOT* a particular subject.
  252.  
  253.                  The MOVE_BY_SUBJECT Flag will read a list SUBJECTS that
  254.                  you supply in your configuration file.  This flag works
  255.                  very similar to the MOVE flag, except The REF will look at
  256.                  the message SUBJECT rather than the message SENDER. After
  257.                  this list of SUBJECTS have been read The REF will MOVE any
  258.                  messages that *ARE NOT* a particular subject.  This flag
  259.                  in particular will recognize wildcards.  If the first
  260.                  character of your listed SUBJECT is a *, REF will search
  261.                  for the listed subject as a substring of the actual
  262.                  message subject.  For Example:
  263.  
  264.                  Your Specified Subject = *ECHOMAIL
  265.                  Actual Message Subject = 064/003 ECHOMAIL REPORT
  266.  
  267.                  This Subject will be recognized as a match and WILL NOT be
  268.                  moved by the MOVE_BY_SUBJECT parameter.
  269.  
  270.                  Example Without Wildcard:
  271.  
  272.                  Your Specified Subject = ECHOMAIL
  273.                  Actual Message Subject = 064/003 ECHOMAIL REPORT
  274.  
  275.                  This Subject WILL NOT be recognized as a match and WILL
  276.                  be moved by the MOVE_BY_SUBJECT parameter.
  277.  
  278.  
  279.  MOVE_BY_ORIGIN  MOVE messages that *ARE NOT* FROM a Net/Node.
  280.  
  281.                  The MOVE_BY_ORIGIN Flag will read a list of NET/NODEs that
  282.                  you supply in your configuration file.  After this list of
  283.                  NET/NODEs have been read The REF will MOVE any messages
  284.                  that *ARE NOT* FROM a one of these NET/NODEs.  If you
  285.                  select this FLAG, The REF will read each message and look
  286.                  at the .ORIGIN line, comparing them to the list of
  287.                  Net/Nodes you have supplied.  Any messages that ARE NOT
  288.                  from one of the listed Net/Nodes will be moved to an
  289.                  alternate message area.
  290.  
  291.       MARK       MARK messages that *ARE NOT* FROM a User.
  292.  
  293.                  The MARK Flag will read a list of USERS that you supply in
  294.                  your configuration file.  After this list of USERS has
  295.                  been read, The REF will MARK Bagged any messages that *ARE
  296.                  NOT* FROM a user in the list.  This will prevent any
  297.                  messages that are UnAuthorized from being bagged.
  298.  
  299. MARK_BY_RECEIVER MARK messages that *ARE NOT* TO a User.
  300.  
  301.                  The MARK_BY_RECEIVER Flag will read a list of USERS that
  302.                  you supply in your configuration file. This flag works
  303.                  very similar to the MARK flag, except The REF will look at
  304.                  the message RECEIVER rather than the message SENDER. After
  305.                  this list of USERS have been read The REF will MARK Bagged
  306.                  any messages that *ARE NOT* TO a user in the list. This
  307.                  will prevent any messages that are UnAuthorized from being
  308.                  bagged.
  309.  
  310. MARK_BY_SUBJECT  MARK messages that *ARE NOT* a particular subject.
  311.  
  312.                  The MARK_BY_SUBJECT Flag will read a list of SUBJECTS that
  313.                  you supply in your configuration file. This flag works
  314.                  very similar to the MARK flag, except The REF will look at
  315.                  the message SUBJECT rather than the message SENDER. After
  316.                  this list of SUBJECTS have been read The REF will MARK
  317.                  Bagged any messages that *ARE NOT* on a particular
  318.                  subject. This will prevent any messages that are
  319.                  UnAuthorized from being bagged.  This flag in particular
  320.                  will recognize wildcards. If the first character of your
  321.                  listed SUBJECT is a *, REF will search for the listed
  322.                  subject as a substring of the actual message subject.  For
  323.                  Example:
  324.  
  325.                  Your Specified Subject = *ECHOMAIL
  326.                  Actual Message Subject = 064/003 ECHOMAIL REPORT
  327.  
  328.                  This Subject will be recognized as a match and WILL NOT be
  329.                  marked by the MARK_BY_SUBJECT parameter.
  330.  
  331.                  Example Without Wildcard:
  332.  
  333.                  Your Specified Subject = ECHOMAIL
  334.                  Actual Message Subject = 064/003 ECHOMAIL REPORT
  335.  
  336.                  This Subject WILL NOT be recognized as a match and WILL
  337.                  be marked by the MARK_BY_SUBJECT parameter.
  338.  
  339.  
  340.  MARK_BY_ORIGIN  MARK messages that *ARE NOT* FROM a Net/Node.
  341.  
  342.                  The MARK_BY_ORIGIN Flag will read a list of NET/NODEs that
  343.                  you supply in your configuration file.  After this list of
  344.                  NET/NODEs have been read The REF will MARK Bagged any
  345.                  messages that *ARE NOT* FROM a one of these NET/NODEs.
  346.                  This will prevent any messages that are UnAuthorized from
  347.                  being bagged. If you select this FLAG, The REF will read
  348.                  each message and build a list of names that are allowed to
  349.                  post in the message area.  The REF will scan the the
  350.                  messages in the message area, and dynamically build this
  351.                  list by looking at the ORIGIN line of each message.
  352.  
  353.       KILL       KILL messages that *ARE NOT* FROM a User.
  354.  
  355.                  The KILL Flag will read a list of USERS that you supply in
  356.                  your configuration file.  After this list of USERS has
  357.                  been read, The REF will KILL any messages that *ARE NOT*
  358.                  FROM a user in the list.
  359.  
  360. KILL_BY_RECEIVER KILL messages that *ARE NOT* TO a User.
  361.  
  362.                  The KILL_BY_RECEIVER Flag will read a list of USERS that
  363.                  you supply in your configuration file.  This flag works
  364.                  very similar to the KILL flag, except The REF will look at
  365.                  the message RECEIVER rather than the message SENDER.
  366.                  After this list of USERS has been read The REF will KILL
  367.                  any messages that *ARE NOT* TO a user in the list.
  368.  
  369. KILL_BY_SUBJECT KILL messages that *ARE NOT* a particular subject.
  370.  
  371.                  The KILL_BY_SUBJECT Flag will read a list of USERS that
  372.                  you supply in your configuration file.  This flag works
  373.                  very similar to the KILL flag, except The REF will look at
  374.                  the message SUBJECT rather than the message SENDER. After
  375.                  this list of SUBJECTS have been read The REF will KILL any
  376.                  messages that *ARE NOT* on a particular subject.  This
  377.                  flag in particular will recognize wildcards. If the first
  378.                  character of your listed SUBJECT is a *, REF will search
  379.                  for the listed subject as a substring of the actual
  380.                  message subject.  For Example:
  381.  
  382.                  Your Specified Subject = *ECHOMAIL
  383.                  Actual Message Subject = 064/003 ECHOMAIL REPORT
  384.  
  385.                  This Subject will be recognized as a match and WILL NOT be
  386.                  killed by the KILL_BY_SUBJECT parameter.
  387.  
  388.                  Example Without Wildcard:
  389.  
  390.                  Your Specified Subject = ECHOMAIL
  391.                  Actual Message Subject = 064/003 ECHOMAIL REPORT
  392.  
  393.                  This Subject WILL NOT be recognized as a match and WILL
  394.                  be killed by the KILL_BY_SUBJECT parameter.
  395.  
  396.  
  397.  KILL_BY_ORIGIN  KILL messages that *ARE NOT* FROM a Net/Node.
  398.  
  399.                  The KILL_BY_ORIGIN Flag will read a list of NET/NODEs that
  400.                  you supply in your configuration file.  After this list of
  401.                  NET/NODEs have been read The REF will KILL any messages
  402.                  that *ARE NOT* FROM a one of these NET/NODEs. If you
  403.                  select this FLAG, The REF will read each message and build
  404.                  a list of names that are allowed to post in the message
  405.                  area.  The REF will scan the the messages in the message
  406.                  area, and dynamically build this list by looking at the
  407.                  ORIGIN line of each message.
  408.  
  409.     REVIEW       MOVE messages that *ARE* FROM a User.
  410.  
  411.                  The REVIEW Flag will read a list of USERS that you supply in
  412.                  your configuration file.  After this list of USERS has
  413.                  been read, The REF will MOVE any messages that *ARE*
  414.                  from a user in the list.
  415.  
  416. REVIEW_BY_RECEIVER MOVE messages that *ARE* TO a User.
  417.  
  418.                    The REVIEW_BY_RECEIVER Flag will read a list of USERS
  419.                    that you supply in your configuration file.  This flag
  420.                    works very similar to the REVIEW flag, except The REF
  421.                    will look at the message RECEIVER rather than the
  422.                    message SENDER.  After this list of USERS have been read
  423.                    The REF will MOVE any messages that *ARE* TO a user in
  424.                    the list.
  425.  
  426. REVIEW_BY_SUBJECT MOVE messages that *ARE* a particular subject.
  427.  
  428.                    The REVIEW_BY_SUBJECT Flag will read a list of SUBJECTS
  429.                    that you supply in your configuration file.  This flag
  430.                    works very similar to the REVIEW flag, except The REF
  431.                    will look at the message SUBJECT rather than the message
  432.                    SENDER.  After this list of SUBJECTS have been read The
  433.                    REF will MOVE any messages that *ARE* on a particular
  434.                    subject. This flag in particular will recognize
  435.                    wildcards. If the first character of your listed SUBJECT
  436.                    is a *, REF will search for the listed subject as a
  437.                    substring of the actual message subject.  For Example:
  438.  
  439.                    Your Specified Subject = *ECHOMAIL
  440.                    Actual Message Subject = 064/003 ECHOMAIL REPORT
  441.  
  442.                    This Subject will be recognized as a match and WILL be
  443.                    moved by the REVIEW_BY_SUBJECT parameter.
  444.  
  445.                    Example Without Wildcard:
  446.  
  447.                    Your Specified Subject = ECHOMAIL
  448.                    Actual Message Subject = 064/003 ECHOMAIL REPORT
  449.  
  450.                    This Subject WILL NOT be recognized as a match and WILL
  451.                    NOT be moved by the REVIEW_BY_SUBJECT parameter.
  452.  
  453.  
  454. REVIEW_BY_ORIGIN   MOVE messages that *ARE* FROM a Net/Node.
  455.  
  456.                  The REVIEW_BY_ORIGIN Flag will read a list of NET/NODEs
  457.                  that you supply in your configuration file.  After this
  458.                  list of NET/NODEs have been read The REF will MOVE any
  459.                  messages that *ARE* from a one of these NET/NODEs.  If you
  460.                  select this FLAG, The REF will read each message and build
  461.                  a list of names that are allowed to post in the message
  462.                  area.  The REF will scan the the messages in the message
  463.                  area, and dynamically build this list by looking at the
  464.                  ORIGIN line of each message.
  465.  
  466.                 ────────────────────────────────────────────
  467.                                Flag Modifiers
  468.                 ────────────────────────────────────────────
  469.  
  470.          The REF will recognize three distinct modifiers for each of
  471.          the FLAGS above.  The three modifiers that are recognized are
  472.          /INBOUND /OUTBOUND or /RETURN.  Please note the /INBOUND and
  473.          /OUTBOUND cannot be used simultaneously, but /RETURN may be used
  474.          in combination with either of the other two modifiers.
  475.  
  476.          The purpose of the modifiers are as follows:
  477.  
  478.          /INBOUND  Process ONLY Inbound messages.  If the Incoming flag is
  479.                    not set and you are using this modifier this message will
  480.                    be ignored.
  481.  
  482.         /OUTBOUND  Process ONLY Outbound messages.  If the Incoming flag IS
  483.                    set and you are using this modifier this message will
  484.                    be ignored.
  485.  
  486.         /RETURN    The RETURN modifier will cause any unauthorized messages
  487.                    to be RETURNED to the author of the message.  The
  488.                    default for The REF when this modifier is not in use is
  489.                    to simply move the offending message to an alternate
  490.                    area leaving the message Sender and Receiver intact.
  491.                    When this modifier is used the message will be have The
  492.                    REF x.xx as the Sender and the original author as the
  493.                    Receiver.  The Ref will also extract the .ORIGIN
  494.                    Net/Node address from the message and address it back to
  495.                    the sender.  This allows you to configure your netmail
  496.                    message area in the Destination Message Area Path in
  497.                    your REF.CNF.
  498.  
  499.                 ──────────────────────────────────────────── 
  500.                  Example Single Section Configuration File:
  501.                 ────────────────────────────────────────────
  502.  
  503. E:\READONLY  READ-ONLY Echo     <- Echo Path and Name to Referee
  504. E:\DESTAREA  Destination Echo   <- Destination Path and Name for Moves
  505. MOVE /RETURN This Is A RO Echo  <- Flag, Optional Modifier, and Optional Text
  506.     Rob Roesch                  <-
  507.     Jim Wilson                  <--User List To Search
  508.     Jim Knight                  <-
  509. END                             <- END to specify END OF LIST
  510.  
  511.  
  512.          The Configuration File is laid out in sections as shown above.
  513.          The above seven lines show ONE section of a complete configuration
  514.          files.  You are allowed to have as many sections in your config
  515.          file as you like, as long as each section ends with an END
  516.          statement as shown above.  Each section contains five individual
  517.          components.
  518.  
  519.          Line 1-2:
  520.                     The first two lines of each section will contain a full
  521.                     path and name of two message areas, the search echo,
  522.                     and the destination echo for moves.
  523.  
  524.          Line 3:
  525.                     The third line of each section must start with one
  526.                     "flag", MOVE, KILL, MARK, or REVIEW, MOVE_BY_ORIGIN,
  527.                     KILL_BY_ORIGIN, MARK_BY_ORIGIN, REVIEW_BY_ORIGIN,
  528.                     MOVE_BY_RECEIVER, KILL_BY_RECEIVER, MARK_BY_RECEIVER,
  529.                     REVIEW_BY_RECEIVER,  MOVE_BY_SUBJECT, KILL_BY_SUBJECT,
  530.                     MARK_BY_SUBJECT, REVIEW_BY_SUBJECT.
  531.  
  532.                     In addition to the "flag" you may specify flag
  533.                     Modifiers to alter The REF's scrutiny.  The available
  534.                     modifiers are /INBOUND /OUTBOUND or /RETURN.  All three
  535.                     are detailed above.
  536.  
  537.                     In addition to the "flag" and optional modifiers, you
  538.                     may create your own text for The REF to use in the
  539.                     Header that is applied when the message is moved to an
  540.                     alternate area.  If you do not specify any text here,
  541.                     the default messages will be used.  The default text
  542.                     that is used is as follows:
  543.  
  544.                     DEFAULT REVIEW MODE TEXT:
  545.  
  546.                            ──────── *** ────────
  547.                         This Message Was Moved From
  548.                            Your Message Area Name
  549.                     For The Purpose of Sysop Examination
  550.                                By The REF x.x
  551.                            ──────── *** ────────
  552.  
  553.  
  554.                     DEFAULT READ-ONLY MODE TEXT:
  555.  
  556.                            ──────── *** ────────
  557.                         This Message Was Moved From
  558.                            Your Message Area Name
  559.                                By The REF x.x
  560.                            ──────── *** ────────
  561.  
  562.  
  563.                If you specify text following the "flag" your message
  564.                will be customized with your text.  For example if you
  565.                place MOVE BECAUSE YOU ARE UNAUTHORIZED on line 3, your
  566.                text will look like the following:
  567.  
  568.                            ──────── *** ────────
  569.                         This Message Was Moved From
  570.                            Your Message Area Name
  571.                         BECAUSE YOU ARE UNAUTHORIZED
  572.                                By The REF x.x
  573.                            ──────── *** ────────
  574.  
  575.  
  576.         Line 4-?:
  577.                     Line four is the start of the "Users List" if you are
  578.                     using MOVE, KILL, MARK, REVIEW, MOVE_BY_RECEIVER,
  579.                     KILL_BY_RECEIVER, MARK_BY_RECEIVER, or
  580.                     REVIEW_BY_RECEIVER.
  581.  
  582.                     Line four is the start of the "Net/Node List" if you
  583.                     are using MOVE_BY_ORIGIN, KILL_BY_ORIGIN,
  584.                     MARK_BY_ORIGIN, or REVIEW_BY_ORIGIN. You may have up to
  585.                     1000 entries in this list.
  586.  
  587.                     Line four is the start of the "Subject List" if you are
  588.                     using MOVE_BY_SUBJECT, KILL_BY_SUBJECT,
  589.                     MARK_BY_SUBJECT, or REVIEW_BY_SUBJECT. You may have up
  590.                     to 1000 entries in this list.
  591.  
  592.         Last Line:
  593.                     The last line of each section MUST be END.  The REF
  594.                     will continue to read each line as a user name until it
  595.                     see's END.
  596.  
  597.                 ────────────────────────────────────────────
  598.                 Example Multiple Section Configuration File:
  599.                 ────────────────────────────────────────────
  600.  
  601.            The following example uses five individual sections
  602.            to create a multiple section configuration file.
  603.  
  604. E:\READONLY My READ-ONLY Echo
  605. E:\DESTAREA My Destination Echo
  606. MOVE  Because It Was From An Un-Authorized User
  607.     Rob Roesch
  608.     Jim Wilson
  609.     Jim Knight
  610. END
  611. E:\GTDIGEST  GT-ONE Digest Echo
  612. E:\GTPNSYSOP GT-ONE International Echo
  613. MOVE
  614.     Perry Alexander
  615.     Bob Butcher
  616. END
  617. E:\MYECHO  My Fabulous Echo
  618. E:\NETMAIL My Netmail Message Area
  619. REVIEW_BY_ORIGIN /RETURN You Are Unauthorized To Use This Echo
  620.     064/001
  621.     032/001
  622. END
  623. E:\MYNEWECHO  My New Echo
  624. E:\NEWREVIEW  My New Echo Review Area
  625. REVIEW
  626.     Jim Knight
  627.     Perry Alexander
  628. END
  629. E:\NETMAIL1 My Netmail #1 Area
  630. E:\NETMAIL2 My Netmail #2 Area
  631. REVIEW_BY_SUBJECT /INCOMING Because I Wanted To Get It Out Of The Way
  632.     *ECHOMAIL REPORT
  633.     RETURN RECEIPT
  634. END
  635.  
  636.          In the above example there are five individual echos that fall
  637.          under the scrutiny of The REF.  You will also notice that the
  638.          first two sections are READ-ONLY sections and the third, fourth,
  639.          and fifth are REVIEW sections.  Also note the use of WildCards
  640.          when using the REVIEW_BY_SUBJECT flag, and that INCOMING messages
  641.          only will be moved.
  642.  
  643.  
  644.          You may place as many individual echos into this config file as
  645.          you find necessary.  There is no limit other than available disk
  646.          space.  The REF will continue to process each file until the End
  647.          of File is reached.....  The above example shows two echos, but
  648.          you can run it with 1 or 5000, it's up to you.....
  649.  
  650.  
  651.        ──────────────────────────────────────────────────────────────
  652.                           Command Line Parameters
  653.        ──────────────────────────────────────────────────────────────
  654.  
  655.          Currently there are three, /LOG /NLOG and /REGISTER.
  656.  
  657.       /LOG       If you want REF to keep a log file for you put /LOG on the
  658.                  command line.  REF will keep an ever growing log file in
  659.                  the HOTWARE directory off the GTPATH directory.
  660.  
  661.       /NLOG      If you want REF to keep a log file for you, erasing any
  662.                  old log file that may be setting around, put /NLOG (new
  663.                  log) on the command line.  REF will erase any old log
  664.                  files, and create a new log file in the HOTWARE directory
  665.                  off the GTPATH directory.
  666.  
  667.       /REGISTER  Kill Protect will the proceed to send me a netmail message
  668.                  informing me that you are using the program.  Please use
  669.                  this feature ONCE.
  670.  
  671.        ──────────────────────────────────────────────────────────────
  672.                               ErrorLevel Exits
  673.        ──────────────────────────────────────────────────────────────
  674.  
  675.               Errorlevel 0:  Good run, no Errors.
  676.               Errorlevel 1:  No GTPATH Environment Variable Set
  677.               Errorlevel 2:  Cannot open REF.CNF
  678.               Errorlevel 3:  Insufficient Memory
  679.  
  680.        ──────────────────────────────────────────────────────────────
  681.                                 Registration
  682.        ──────────────────────────────────────────────────────────────
  683.  
  684.         I am not requesting any money for this program, but I would
  685.         not turn any down either <g>.  If you want to slip $5.00 into
  686.         and envelope I'll accept it.  Although I don't require a
  687.         registration fee I would appreciate knowing that you are using
  688.         the program on a normal basis.  Therefore I have provided a
  689.         simple and easy way for you to register this program.  From
  690.         the DOS prompt type:   
  691.  
  692.  
  693.          REF /REGISTER
  694.  
  695.       The REF will the proceed to send me a netmail message informing
  696.       me that you are using the program.  Please use this feature ONCE.
  697.  
  698.        ──────────────────────────────────────────────────────────────
  699.                             Who Is Responsible for This?
  700.        ──────────────────────────────────────────────────────────────
  701.                                  Rob Roesch
  702.                               The HOTware BBS
  703.                          GT Power Net-Node 064/003
  704.                                 Rt 7 Box 566
  705.                                Mocksville, NC
  706.                          704-492-2081 (USR 16.8 DS)
  707.  
  708.           If you start using this utility, and get a chance, let me know 
  709.           (see above procedures.  If you don't have any use for it, delete
  710.           it for your total refund of all the disk space that it was
  711.           occupying, assuming your operating system works right.  This
  712.           program comes with no warranty, no guarantee, and no promises.
  713.           If it works GREAT, if not let me know and I will gladly take a
  714.           look at it in my spare time.  If you really really really like
  715.           the program and want to make any donations, feel free, but it is
  716.           not a requirement.....
  717.  
  718.        ──────────────────────────────────────────────────────────────
  719.                         Alternate Distribution Sites
  720.        ──────────────────────────────────────────────────────────────
  721.  
  722.            The HOTware Utilities now have alternate Distribution
  723.            Centers for your convenience.  The following BBS always
  724.            have the latest and greatest HOTware utilities online and
  725.            available for download.
  726.  
  727.      BBS Name          BBS Phone          Location     GT Net/Node    Hours
  728.  ┌──────────────────┬───────────────┬────────────────────┬───────┬──────────┐
  729.  │ Laboratory 386   │ 618-549-2322  │ Carbondale IL      │064/400│ 10pm-8am │
  730.  └──────────────────┴───────────────┴────────────────────┴───────┴──────────┘
  731.  
  732.  
  733.