home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / BBS_UTIL / RTUTI102.ZIP / RTUTI.DOC < prev    next >
Text File  |  1994-02-03  |  16KB  |  342 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.             RBBS 'Turbo' Universal Text Interface Version 1.00 (RTUTI)
  24.               Copyright 1993 by Walter C. Ames.  ALL RIGHTS RESERVED
  25.                         1.00 Released October 28, 1993
  26.                         1.01 Released October 29, 1993
  27.                         1.02 Released February 3, 1994
  28.  
  29.          
  30.          ╓───────────────────────────────────────────────────────────────╖
  31.          ║                       TABLE OF CONTENTS                       ║
  32.          ╙───────────────────────────────────────────────────────────────╜
  33.  
  34.  
  35.  
  36.          1.   License/Warranty/Registration.........................  1
  37.               1.1  License..........................................  1
  38.               1.2  Warranty.........................................  1
  39.               1.3  Registration.....................................  1
  40.  
  41.          2.   Introduction..........................................  2
  42.               2.1  About RTUTI......................................  2
  43.               2.2  RTUTI Features...................................  2
  44.               2.3  Kudos............................................  2
  45.  
  46.          3.   Installation..........................................  3
  47.               3.1  Assumptions......................................  3
  48.               3.2  System Requirements..............................  3
  49.               3.3  Installation Summary.............................  3
  50.  
  51.          4.   Creating Your Configuration File......................  4
  52.  
  53.          5.   Appendix..............................................  6
  54.               5.1  Error Levels.....................................  6
  55.               5.2  Problem Reporting................................  7
  56.          
  57.  
  58.  
  59.          1.   LICENSE * WARRANTY * REGISTRATION
  60.  
  61.          1.1  License
  62.  
  63.  
  64.          Distribution and/or use is permitted under the following terms:
  65.  
  66.          You may copy and distribute verbatim copies of the RTUTI
  67.          documentation and executable code as you receive it, in any medium,
  68.          provided that you conspicuously and appropriately publish on each
  69.          copy a valid copyright notice "Copyright 1993  by Walter C. Ames";
  70.          keep intact the notices on all files that refer to this license
  71.          agreement and to the absence of any warranty.  PROVIDE UNMODIFIED
  72.          COPIES OF THE DOCUMENTATION AS PROVIDED WITH THE PROGRAM; and give
  73.          any of the other recipients of the RTUTI program a copy of this
  74.          license agreement along with the program.  You may charge a
  75.          distribution fee for the physical act of transferring a copy, but
  76.          no more than is necessary to recover your actual costs incurred in
  77.          the transfer. Under no circumstances is RTUTI to be distributed in
  78.          such a way as to be construed as "value  added" in a sales
  79.          transaction, such as, but not limited to,  software bundled with a
  80.          modem or CD-ROM software collections, without the prior written
  81.          consent of the author.
  82.  
  83.  
  84.          1.2  Warranty
  85.  
  86.  
  87.          THIS PRODUCT IS PROVIDED "AS IS"  WITHOUT WARRANTY OF ANY KIND,
  88.          INCLUDING ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A
  89.          PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO THE RESULTS AND
  90.          PERFORMANCE OF THIS PROGRAM IS ASSUMED BY YOU. FURTHERMORE, I THE
  91.          AUTHOR DO NOT WARRANT, GUARANTEE, OR MAKE ANY REPRESENTATIONS
  92.          REGARDING THE USE OF OR THE RESULTS OF THE USE OF THE PROGRAM, OR
  93.          THAT THE PROGRAM WILL RUN WITHOUT ERROR, AND YOU RELY ON THE
  94.          PROGRAM AND RESULTS SOLELY AT YOUR OWN RISK.  I THE AUTHOR CANNOT
  95.          ACCEPT RESPONSIBILITY FOR SYSTEM DAMAGE, LOSS OF PROFIT, OR ANY
  96.          OTHER SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES RESULTING FROM
  97.          THE USE OR INABILITY TO USE THIS PRODUCT.
  98.  
  99.  
  100.          1.3  Registration
  101.  
  102.  
  103.  
  104.          This program is being released under the "SHAREWARE" concept.  This
  105.          means that you can evaluate the program for a period of 30 days to
  106.          see if it meets your needs.  If after a period of 30 days you
  107.          continue to use the program then registration is required.  If you
  108.          do not register the program after 30 days you must discontinue use
  109.          of the program.  See REGISTER.TXT for details on registration.
  110.  
  111.          NOTE:  If you feel that 30 days is insufficient time to evaluate
  112.          this program, please contact me electronically at any of the
  113.          enclosed network addresses or by calling my BBS.  I may, at my
  114.          discretion extend the evaluation period on a case-by-case basis.
  115.           2.   Introduction
  116.  
  117.          2.1  About RTUTI
  118.  
  119.  
  120.          The RBBS 'Turbo' Universal Text Interface (RTUTI) is a series of
  121.          programs that are used to create a Standard Interface Layer for
  122.          Bulletin Board message traffic.  These programs, in conjunction
  123.          with Networking software that supports the UTI format make it
  124.          possible for RBBS-PC Sysops to participate in Message Networks that
  125.          connect a multitude of BBS formats together.
  126.  
  127.  
  128.          2.2  Features:
  129.  
  130.  
  131.               ■  Optimized for use with the Postlink(tm) Network Mail system
  132.               ■  Handles any size message even if it exceeds RBBS's limits
  133.               ■  Progress reporting for ease of operation
  134.               ■  Verbose error trapping and reporting
  135.               ■  Handles RBBS-PC v17.4 message header format
  136.               ■  Will not re-export previously exported or imported mail
  137.               ■  Updates RBBS mail waiting flags
  138.               ■  Tagline checking and concatenation for a cleaner look
  139.               ■  (*)User definable tagline or tagline suppression
  140.               ■  Will re-address mail to SYSOP under several conditions.
  141.                  (These conditions are user definable)
  142.               ■  Author Supported Software!
  143.  
  144.               (*) Denotes a (REGISTERED ONLY) Feature
  145.  
  146.          2.3  Kudos
  147.  
  148.  
  149.          I would like to thank the following individuals for helping me
  150.          develop and test RTUTI.  Without there help RTUTI would not be the
  151.          product it is.
  152.  
  153.               Bruce Jackson
  154.               Dan Shore
  155.               Sam Coleman
  156.  
  157.           3.   INSTALLATION
  158.  
  159.  
  160.          3.1  Assumptions
  161.  
  162.  
  163.          Three basic assumptions are made:
  164.  
  165.               1.   You are an RBBS-PC SysOp with an operational RBBS
  166.                    installation.
  167.               2.   You are familiar with the operation of both DOS and RBBS.
  168.               3.   You have a need for a UTI driver.
  169.  
  170.  
  171.          3.2  System Requirements
  172.  
  173.  
  174.          Although RTUTI was designed to be as generic as possible, the
  175.          following system configuration is required as a minimum:
  176.  
  177.               1.   An IBM PC, XT, AT, PS/2, or a 100% compatible.
  178.               2.   A completely operational copy of RBBS-PC CPC12 - CPC17.4.
  179.               3.   MS/PC-DOS 3.1 or above.
  180.  
  181.  
  182.          3.3  Installation Summary
  183.  
  184.  
  185.               1.   Read the documentation to become familiar with available
  186.                    options.
  187.               2.   Determine the configuration options to be used.
  188.               3.   Edit the parameters in the RBBS-UTI.CFG file.
  189.               4.   Place all of the RTUTI Executable (.EXE) programs in a
  190.                    directory reflected in your PATH statement.
  191.  
  192.               Note:  The file RBBS-UTI.CFG MUST reside in the local or DOS
  193.               Current directory at Runtime.  This would be your Postlink
  194.               Home directory for a Postlink installation.
  195.  
  196.           4.   Creating your Configuration File
  197.  
  198.               The RBBS 'Turbo' Universal Text Interface uses a common
  199.               configuration file to obtain all of it's system specific
  200.               information.  The accuracy of the data contained in this file
  201.               is very important for proper operation of the UTI.
  202.  
  203.               The configuration file is a standard ASCII text file.  You may
  204.               use any ASCII Text editor to edit this file.  All lines that
  205.               begin with the Pound '#' symbol are UTI command lines.  These
  206.               lines will all have keywords following the pound symbol.  All
  207.               lines that begin with a Semi-Colon ';' are considered comments
  208.               and are ignored.  You may enter as many comment lines as you
  209.               feel necessary.
  210.  
  211.               The following is a list of valid Keywords:
  212.  
  213.               #NETWORK_AKA:  This Keyword is used to define possible
  214.                              Network Alias's.  ie. Some networks like to
  215.                              send messages to 'ALL SYSOPS'.  Since your
  216.                              name is not 'ALL SYSOPS' the message may not
  217.                              get to you or it may not set your RBBS Mail
  218.                              Waiting Flag.  With this Keyword you can
  219.                              define up to 10 Network Alias's for yourself.
  220.                              This will cause the UTI to import any message
  221.                              addressed to a Network AKA to be re-addressed
  222.                              to SYSOP and set the Mail Waiting Flag.  Each
  223.                              Network AKA Keyword must be on a line by
  224.                              itself.
  225.  
  226.               #REAL_NAME:    This Keyword is used to define the Real Name
  227.                              of the SYSOP of this system.  This is
  228.                              necessary so that the UTI Export program can
  229.                              re-address outbound messages From SYSOP (the
  230.                              way RBBS enters it) to your Real name.
  231.  
  232.               #REG_CODE:     This Keyword is used to define the
  233.                              Registration code for this copy of RTUTI.  By
  234.                              entering a valid registration code here you
  235.                              will unlock the Registered Only features.
  236.  
  237.               #REMOTE_NAME:  This Keyword is the RBBS Remote Pseudonym.
  238.                              This name will be used by the UTI to set the
  239.                              RBBS Mail Waiting Flag for all inbound
  240.                              messages to SYSOP.  If a message comes in to
  241.                              SYSOP, SYSOP_REALNAME or any of the Useable
  242.                              AKA's the UTI will set this users Mail Waiting
  243.                              Flag.
  244.  
  245.               #SYSOP_AKA:    This Keyword is used to define additional
  246.                              AKA's for the SYSOP of this system.  The best
  247.                              use for this feature is to place the most
  248.                              common misspellings of your name here.  This
  249.                              will ensure that all mail addressed (or mis-
  250.                              addressed) to you will be re-addressed to you.
  251.                              Confused yet?  Lets take the user named
  252.                              'Walter Ames' for example.  A message comes in
  253.                              addressed to 'Walter Aims' same guy?
  254.                              (probably) ok if there was a SYSOP_AKA entry
  255.                              with 'Walter Aims' defined that message would
  256.                              have been re-addressed to SYSOP.  You may have
  257.                              up to 10 SYSOP_AKA's defined, each on a line
  258.                              by itself.
  259.  
  260.               #SYSTEM:       This Keyword is probably one of the most
  261.                              important.  This is the full path and filename
  262.                              to your RBBS CONFMAIL.DEF file.  RTUTI uses
  263.                              this file to resolve pathnames of your RBBS
  264.                              conference USERS files.  This way it can set
  265.                              the RBBS Mail Waiting Flag for any user on
  266.                              your system that receives a Network message.
  267.                              If this keyword is NOT defined your Mail
  268.                              Waiting Flags will NEVER get set.
  269.  
  270.               #USE_TAGLINE:  This Keyword is only available in the
  271.                              Registered version.  It takes 'Y' or 'N' as
  272.                              it's parameter.  If set to 'Y' it will append
  273.                              an RTUTI Tagline to each and every message
  274.                              that is exported from your system.  If set to
  275.                              'N' it will suppress the addition of RTUTI
  276.                              Taglines.
  277.  
  278.               #UTI_TAGLINE:  This Keyword is only available in the
  279.                              registered version.  This is a user definable
  280.                              Tagline.  This string may be 40 characters in
  281.                              length.
  282.  
  283.           5.   APPENDIX
  284.  
  285.          5.1  Error Levels
  286.  
  287.          Universal Text Interface programs (UTI) are virtually never run as
  288.          user applications.  As a rule they are normally called by other
  289.          programs.  Due to this, any error that may occur in processing must
  290.          be passed back to the parent task for processing/logging.  The
  291.          parent process will usually log the error and reference it by it's
  292.          Errorlevel only (since most parent processes don't know how the UTI
  293.          handles errors or what error means what).  The following list
  294.          contains the Errorlevels of all UTI programs by program type.
  295.  
  296.  
  297.               ■ UTIEXPRT.EXE
  298.                    0  Normal Termination
  299.                    1  Error in Command Line Syntax.  See File 'RBBS_UTI.ERR'
  300.                    2  Unable to Open Input Message File
  301.                    3  Unable to Open Output UTI_Txt File
  302.                    4  Error Reading from Input Message File
  303.                    5  Input Message Number Out of Range, Exiting
  304.                    6  Next Message Record Number too Low, Exiting
  305.                    7  Total Number of Node Records out of Range, Exiting
  306.                    8  Unable to Open RBBS_UTI Configuration File
  307.  
  308.               ■ UTIIMPRT.EXE
  309.                    0  Normal Termination
  310.                    1  Unable to Open Confmail.def
  311.                    2  Unable to Open Input UTI_Text File
  312.                    3  Unable to Open Output Message File for write
  313.                    4  Unable to Open Output Message File for read
  314.                    5  Unable to Open Output Message File for update
  315.  
  316.               ■ UTIHIGH.EXE
  317.                    0  Normal Termination
  318.                    1  Unable to Open Input Message File
  319.                    2  Unable to Open Output UTI_Text File for write
  320.  
  321.           5.2  PROBLEM REPORTING
  322.  
  323.  
  324.          If you uncover a problem with the operation of this program please
  325.          contact the author using one of the following methods.
  326.  
  327.               1.  BBS      - The GreyHawk BBS  (410)720-5083 AT&T   V.32Bis
  328.                                                        -5084 USR DS V.32Bis
  329.                                                (410)290-3260 AT&T   V.32Bis
  330.                                                        -3261 USR DS V.32Bis
  331.  
  332.               2.  USPS     - Walter C. Ames
  333.                              9246 Moonfire Place
  334.                              Columbia, MD 21045
  335.  
  336.               3.  NetMail  - RelayNet ->GREYHAWK  R/O Capable
  337.                              FidoNet 1:261/1116 or 1:261/1117
  338.                              RBBSNet 8:936/203  or 8:936/204
  339.  
  340.               4.  InterNet - walter@ghawk.com
  341.  
  342.