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