home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / pcboard / swop145i.zip / SWOP.DOC < prev    next >
Text File  |  1992-06-23  |  17KB  |  356 lines
  1.  
  2.                 ╔════╗
  3.                 ║    ╩
  4.                 ║
  5.                 ╚════╗  ╦     ╦ ╔════╗ ╔════╗
  6.                      ║  ║  ╦  ║ ║    ║ ║    ║
  7.                 ╦    ║  ║  ║  ║ ║    ║ ║    ║
  8.                 ╚════╝  ╚══╩══╝ ╚════╝ ╠════╝       Version 1.07
  9.                                        ║
  10.                                        ║
  11.                                        ╩
  12.  
  13.  
  14.                               CopyRighted 1992 by
  15.  
  16.                            PC-2-PC COMMUNICATIONS CC
  17.  
  18.  
  19.  
  20. ══════════════════════════════════════════════════════════════════════════════
  21.  
  22.                  A door for a PCBoard Version 14.5a BBS software.
  23.  
  24.           This door allows a SYSOP to provide his users with a facility
  25.                 to SWOP their time available for more bytes,  or,
  26.                    to swop their bytes available for more time.
  27.  
  28. ══════════════════════════════════════════════════════════════════════════════
  29.  
  30.               PC-2-PC COMMUNICATIONS is situated in South Africa.
  31.  
  32.               BBS tel. no's :  Node 1 - (011) 391-3627  (2400 bps)
  33.                                Node 2 - (011) 391-3628  (2400 bps)
  34.  
  35.                            (FAX) : (011) 391-2349
  36.  
  37.  
  38. ╔═══════╗
  39. ║ INDEX ║
  40. ╚═══════╝
  41.  
  42.  
  43.              Opening words............................... 1
  44.              System requirements......................... 1
  45.              Installation................................ 2
  46.              Syntax and parameters for SWOP.EXE.......... 4
  47.              Features.................................... 5
  48.              A special word about Base Baud Rate......... 6
  49.              What if you do not registered as a user..... 6
  50.              List of files with descriptions............. 6
  51.              History of the program releases............. 7
  52.  
  53.  
  54. ╔═══════════════╗                                                PAGE 1
  55. ║ OPENING WORDS ║
  56. ╚═══════════════╝
  57.  
  58.     This software,  along with its documentation is CopyRight by
  59.     PC-2-PC COMMUNICATION CC.  You may not alter anything inside the
  60.     program,  and/or the documentation.
  61.  
  62.     This software is being distributed under the Public Domain concept.
  63.     This means that you as the user are allowed to use the program for
  64.     as long as you like.   We do not require any registration's at
  65.     all.  The software is not crippled in any way.  Should you wish to
  66.     have the latest copy of this door,  you may call our BBS in RSA at
  67.     (011) 391-3627.  It is in the SYSOP's conference on the BBS.
  68.  
  69.  
  70. ╔═════════════════════╗
  71. ║ SYSTEM REQUIREMENTS ║
  72. ╚═════════════════════╝
  73.     Hardware  :  IBM Compatible,  modem,  hard-drive,  ect.
  74.     Software  :  PCBoard Version 14.5a  BBS software
  75.     Memory    :  The available RAM required to run this door is 110 kB.
  76.  
  77.     Networks  :  On a network,  ensure that file-server has some
  78.                  sub-directory,  accessible to all nodes.  This is
  79.                  where the security-access "SWOPPWRD" file would
  80.                  be referenced to as a parameter.
  81.  
  82.     Other     :  A VERY HARD WORKING SYSOP!!!!!
  83.  
  84. ╔══════════════╗                                                 PAGE 2
  85. ║ INSTALLATION ║
  86. ╚══════════════╝
  87.  
  88.     This section is placed so early in the documentation so that you
  89.     do not have to read about an half an hour,  before you find the
  90.     installation part.
  91.  
  92.     First we have to mention the following:
  93.       If you really hate reading documents,  you could always just
  94.       run the program direct from the DOS prompt,  and it would lead
  95.       you to install it correctly.
  96.  
  97.     Now,  here is a proper description of how to install this door.
  98.     No fancy stuff required with the SWOP door.
  99.  
  100.       Just follow the following steps one by one:
  101.  
  102.     1.   Ensure that you have somewhere in your Path statement located
  103.          usually in the AUTOEXEC.BAT file, a path stating the location
  104.          of your PCBOARD sub-directory,   or just simply make sure you
  105.          do change the directory in the file SWOP(created by yourself)
  106.          to the PCBOARD sub-directory,  before calling SWOP.EXE.
  107.  
  108.     2.   Now go to your PCBoard sub-directory,  and run PCBSETUP.
  109.  
  110.     3.   Select either      J  Main Board Configuration
  111.                                         or
  112.                             K  Conferences.
  113.  
  114.          Conferences in the case if you plan to install SWOP door
  115.          inside a specific conference only.
  116.  
  117.     4.   Select now under Doors: "Path/Name List File" and select
  118.          your DOORS.LST file with 'F2'.
  119.  
  120.     5.   Go to the last entry and enter 'Alt-I' to add this door,
  121.          and enter stuff as follow:
  122.  
  123.   Filename  Password Sec Login USER.SYS DOOR.SYS Shell Path to Batch Files
  124.  ══════════ ════════ ═══ ═════ ════════ ════════ ═════ ════════════════════
  125. 1) SWOP               0    N       Y        N      Y     <path for SWOP>
  126.  
  127.          Save it now.  (Take note of Y under USERS.SYS)
  128.          The Y under Shell may be N or S,  only affect the PCB opperation.
  129.  
  130.     6.   Select now under Doors: "Menu Listing" your DOORS menu file
  131.          and add the SWOP door listing in your menu.
  132.                                                                 PAGE 3
  133.     7.   Now create the SWOP file at the location you specified in
  134.          step (5) five.    Not SWOP.BAT,  as PCBoard expects you to
  135.          have the batch file commands in a file for himself,  without
  136.          the "BAT" extension.
  137.          PCBoard will create its own DOOR.BAT file,  to eliminate
  138.          a possibility of share violations if you had a Network
  139.          installed.
  140.  
  141.          Inside the SWOP file enter the following commands
  142.  
  143.             ECHO OFF
  144.             CD <location of SWOP.EXE ex: C:\PCB\DOORS>
  145.             SWOP <location of "SWOPPWRD"  ex: Z:\DOORS\SWOPPWRD>
  146.             CD <back to PCBoard sub-directory ex: C:\PCB>
  147.             EXIT <if you shelled else BOARD if you did not shell>
  148.  
  149.  
  150.     That's it folks,  the minimum requirements is above to get your door
  151.     up and running.
  152.  
  153.     Here is what our SWOP file looks like on our BBS:
  154.              @ECHO OFF
  155.              Z:\PCB\DOORS\SWOP\SWOP Z:\PCB\DOORS\SWOP\SWOPPWRD
  156.              EXIT         <== Make "BOARD" if Shell is set to "N".
  157.  
  158. ╔════════════════════════════════════╗                           PAGE 4
  159. ║ SYNTAX AND PARAMETERS FOR SWOP.EXE ║
  160. ╚════════════════════════════════════╝
  161.  
  162. Syntax:  SWOP <full path for SWOPPWRD> <\S>
  163.  
  164.  <Full path for SWOPPWRD> : This means that we want you to specify the
  165.                             exact path and name of the SWOPPWRD file.
  166.                                (SWOPPWRD gets created by the door)
  167.                             This is very important if operating in
  168.                             a networking environment.
  169.  
  170.  <\S> : If \S is specified,  the door returns with an message
  171.         "Returning back to BBS.....".
  172.          If \S is NOT specified,  no message is given on return.
  173.  
  174.  Any or all parameters may be left out,  no "must" for any parameter.
  175.  
  176.                      Parameters is not case sensitive.
  177.  
  178.       REMEMBER: Set the USER.SYS flag inside DOOR.LST to yes!!!!!
  179.  
  180.  
  181. ╔══════════╗                                                     PAGE 5
  182. ║ FEATURES ║
  183. ╚══════════╝
  184.  
  185.     1.   Support from Com1 up to Com4.
  186.     2.   Support from 300 baud up to 115,000 Baud.
  187.     3.   ANSI Emulation,  without the need of ANSI.SYS in CONFIG.SYS
  188.     4.   Auto detection of the com port in use,  and baud rate.
  189.     5.   Detection of Data Carrier Detect.  The door will recycle back
  190.          to PCBoard,  in the case of a Carrier Lost,  while in the door.
  191.     6.   Auto adapt to the bell flag the SYSOP has setted, to
  192.          ensure that if the flag was set to off,  the door do not
  193.          send bell sounds to the local speaker.
  194.     7.   Auto detection of keyboard time-out period as setted inside
  195.          PCBoard.  Your user will be exited back to PCBoard if he
  196.          does not press a key within your specified time limit.
  197.     8.   Filtering of characters.  This ensures that most line noise
  198.          usually over the line is filtered out.
  199.     9.   Multiple commands accepted if entered at command line,  just
  200.          the same as with PCBoard.
  201.    10.   Allow the user to change between Graphics and normal mode.
  202.    11.   Give help information to users that need it.
  203.    12.   Correct updating of callers log,  to see what the user did
  204.          while he was inside the SWOP door.
  205.    13.   Allow the user to re-display the screen,  if the screen was
  206.          garbled.
  207.    14.   Will not allow a user with unlimited bytes facility to trade
  208.          bytes or time.  A user with unlimited bytes would otherwise
  209.          have been able to have unlimited time as well.
  210.    15.   Will not give access to a user,  if the SYSOP has setted the
  211.          bytes/minute to 0 bytes.  An way to stop certain users to use
  212.          the facility if the SYSOP wishes to do so.
  213.    16.   Allow the user to trade time in for more bytes to download.
  214.    17.   Allow the user to trade bytes in for more time on the system.
  215.    18.   Allow the SYSOP to set a bytes/minute,  min time left,  and
  216.          a base baud rate for every security level individually.
  217.          All this from the local console only,  without the need to drop
  218.          to DOS,  to run a special editor
  219.    19.   Ability to let the bytes/minute change according to the users
  220.          connect speed.
  221.          (Bytes/Minute = Bytes/minute * Base Baud rate / Connect speed.)
  222.  
  223. ╔═════════════════════════════════════╗                           PAGE 6
  224. ║ A SPECIAL WORD ABOUT BASE BAUD RATE ║
  225. ╚═════════════════════════════════════╝
  226.   The base baud rate give you the facility to let the bytes per minute
  227.   change according to the connect speed of your user.  (This is one of
  228.   the configuration facilities as in item 18 on previous page)
  229.  
  230. { Bytes per minute = Bytes per minute * (Base Baud Rate / connect speed) }
  231.  
  232.    Assume the following setting were inside the SWOPPWRD file.
  233.        Bytes per minute = 10000,       Base Baud Rate = 2400
  234.  
  235.  
  236.  Connect speed |           Calculation of new Bytes per minute
  237.  ==============|===========================================================
  238.     300 baud   | Bytes per min = 10000 * (2400 / 300)    =    80000
  239.    1200 baud   | Bytes per min = 10000 * (2400 / 1200)   =    20000
  240.    2400 baud   | Bytes per min = 10000 * (2400 / 2400)   =    10000
  241.    9600 baud   | Bytes per min = 10000 * (2400 / 9600)   =     2500
  242.   19200 baud   | Bytes per min = 10000 * (2400 / 19200)  =     1250
  243.  
  244.   The higher the connect speed,  the lower the bytes per minute.
  245.   Only here encase some of wanted it.   However,  if you think
  246.   carefully about it.  A user could fool you easily in such a case
  247.   by connecting at 300 baud.  Swop 10 minutes to receive 800,000 bytes.
  248.   Log-off,  call in at 19200 baud,  and download the 800,000 bytes
  249.   within a few minutes.
  250.  
  251.  
  252. ╔════════════════════════════════╗
  253. ║ LIST OF FILES AND DESCRIPTIONS ║
  254. ╚════════════════════════════════╝
  255.  
  256.     Only two files were issued along with SWOP145I.ZIP
  257.  
  258.     SWOP.DOC - You are reading it right now.
  259.     SWOP.EXE - The actual door program.
  260.  
  261.  
  262. ╔═════════╗                                                      PAGE 7
  263. ║ HISTORY ║
  264. ╚═════════╝
  265.     01 December 1991  :  "SWOP145A.ZIP"
  266.                          Initial release of the SWOP door.
  267.  
  268.     06 December 1991  :  "SWOP145B.ZIP"  -  Version 1.0
  269.                          Same as for 01 December 1991,  but is called
  270.                          Version 1.0.   With this version we removed
  271.                          all crippling that was in previous release.
  272.  
  273.     10 December 1991  :  "SWOP145C.ZIP"  -  Version 1.01
  274.                          Program was unable to detect that it is the
  275.                          SYSOP on-line,  if the SYSOP has entered his
  276.                          name in PCBSETUP with non-capital letters.
  277.                          This meant that in this case,  the sysop
  278.                          would not be able to change the security
  279.                          configuration from the local console as he
  280.                          is suppose to do.
  281.                          Fixed this by making the program not to be
  282.                          case sensitive when checking for the SYSOP's
  283.                          name.    ooops...
  284.  
  285.     12 December 1991  :  "SWOP145D.ZIP"  -  Version 1.02
  286.                          Somewhere we did something wrong in vers. 1.01
  287.                          The program was suddenly unable to transmit
  288.                          characters over the comms port.
  289.                                    Sorry....    fixed now.
  290.  
  291.     16 December 1991  :  "SWOP145E.ZIP"  -  Version 1.03
  292.                          Still the same old problem that the program is
  293.                          unable to transmit characters over the comms
  294.                          port.  This was because we tried to get clever
  295.                          with software flow-control (XON/XOFF),  and
  296.                          hardware flow-control (CTS/RTS).  We now removed
  297.                          the ability to adapt to the hardware/software
  298.                          flow control.  We now take the comm port as left
  299.                          by PCBoard,  and return it back the way we
  300.                          received it.  Seems like this solved our
  301.                          problem.  Let us know if anyone with an
  302.                          error-correcting modem experience some
  303.                          problems,  although we expect to hear every
  304.                          one is happy with it,  the way it is now.
  305.  
  306.     19 December 1991  :  "SWOP145F.ZIP"  -  Version 1.04
  307.                          The door had a problem that it gets an runtime
  308.                          error,  as soon as it was installed for the first
  309.                          time.  It was because we attempted to delete a
  310.                          file,  that was still open.   This is now fixed,
  311.                          thanks to the thorough investigation of Joaqium
  312.                          Inacio from VC BBS at (011) 435-3922.  Thank
  313.                          you for your patience George.
  314.  
  315.     20 December 1991  :  "SWOP145G.ZIP"  -  Version 1.05
  316.                       1. Removed the [NOT REGISTERED] handicap if not
  317.                          registered.  We now no longer force you to
  318.                          register.  We now ask you politely to register
  319.                          "yourself" as a user,  and not to register
  320.                          the "program".   So,  as from this release the
  321.                          program will allways be as if it is registered
  322.                          allready.
  323.                       2. All previous programs,  registered or not, would
  324.                          only be able to opperate under PCBoard 14.5.
  325.                          As from this release,  it is programmed to
  326.                          allready accept the new formats of PCBoard
  327.                          vers 15.0 and higher.
  328.                       3. Also we done some "fine-tuning",   that resulted
  329.                          into the fact that the program code was decreased
  330.                          with at least 3400 bytes.
  331.  
  332.     19 January 1992  :  "SWOP145H.ZIP"  -  Version 1.06
  333.                       1. We added the Bytes/Minute information on the
  334.                          Main Menu screen.   Seems like the users don't
  335.                          like to read our "fancy" help screen  ..grin..
  336.                       2. Removed the "Returning to BBS ..." notice,
  337.                          after the user is done with the door.  (Default)
  338.                       3. Added a parameter "/S" for incase you want the
  339.                          message "Returning to BBS..." to be displayed
  340.                          to your users when they are done with the door.
  341.                       4. Added a feature to provide information inside
  342.                          the callers log,  of what the user done while
  343.                          he/she used the swop door.
  344.  
  345.        30 June 1992  :  "SWOP145I.ZIP"  -  Version 1.07
  346.                       1. The door forgot to look at a users expiry date.
  347.                          This meant that if a subscribers,  subs period
  348.                          has expired,  the door kept on working on it
  349.                          subscription security level,  instead of the
  350.                          expired security level.   --fixed--
  351.                       2. The door allways gave a user one extra minute
  352.                          if a user entered,  and exited from the door.
  353.                          Problem now solved.
  354.  
  355. - THE END -
  356.