home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / top2src.zip / TOPLINK.ZIP / TOPLINK.DOC < prev    next >
Text File  |  1996-09-29  |  15KB  |  328 lines
  1.                              TOPLink Version 2.00g1
  2.                                User Documentation
  3.                      Copyright 1996 Paul Sidorsky, ISMWare
  4.            Original Documentation Copyright 1994 David Ong, OmniWare
  5.  
  6.  
  7.                                 [ Description ]
  8.  
  9. TOPLink is a teleconference linking program.  Specifically, it links TOP (The
  10. Online Pub) teleconferences to almost any other teleconference program such as
  11. another copy of TOP, a Major BBS teleconference, or even IRC on the Internet!
  12.  
  13.                                 [ Gamma Notice ]
  14.  
  15. This is a gamma version of TOPLink, release in conjunction with the gamma
  16. version of TOP.  It is fully functional but not complete.  Please report all
  17. bugs to the author immediately!  See the end of this file for information on
  18. how to contact the author.
  19.  
  20. The final release of TOPLink will contain the following enhancements:
  21.  
  22.     - File locking for more stable and secure interaction with TOP.
  23.  
  24.     - Support for TOP's Crash Protection.
  25.  
  26.     - Support for TOP v2.00 (final) when it is released.
  27.  
  28.                                 [ Requirements ]
  29.  
  30. TOPLink requires:  128K of memory.
  31.                    The Online Pub Teleconference (TOP) v2.00g1 or higher.
  32.                    FOSSIL Communications Driver loaded.
  33.                    SHARE.EXE loaded (or an operating system with built-in SHARE
  34.                      support, such as OS/2).
  35.  
  36. NOTE:  At this time, there is no OS/2 or Win95 version of TOPLink.  This DOS
  37.        version of TOPLink should work seamlessly with TOP for OS/2 or TOP for
  38.        Win95.
  39.  
  40.                                   [ Licence ]
  41.  
  42. You may upload TOPLink to any bulletin board, distribute copies to other users,
  43. and use TOPLink provided these conditions are met:
  44.  
  45. 1) You may use TOPLink for a 60 DAY TRIAL PERIOD after which you MUST register
  46.    TOPLink or discontinue using it.
  47. 2) None of the files contained in the archive have been added, deleted, or
  48.    modified in any way prior to being distributed.
  49. 3) There is no charge other than a nominal fee for the diskette and cost of
  50.    sending the program.
  51. 4) Shareware distributors MUST make it clear that they are receiving an
  52.    unregistered EVALUATION copy that requires a registration fee be sent to the
  53.    author after a trial period.
  54. 5) Registered versions of this program ARE NOT TO BE DISTRIBUTED.
  55. 6) This licence may be revoked by the author without prior notice.
  56.  
  57.                                    [ Files ]
  58.  
  59. TOPLINK.EXE      TOPLink program for BBSs running TOP 2.00g1 or higher.
  60. TOPLINK.DOC      This file.  Documentation for TOPLink.
  61. UPGRADE.DOC      What to do if you're upgrading from RAPLink.
  62. HISTORY.DOC      Program history.
  63. REGISTER.FRM     Registration form.
  64. README.1ST       Important program information.
  65. DONTSHOW.TXT     Sample file used with TOPLink.
  66. FILE_ID.DIZ      Archive description, for BBSs.
  67.  
  68. *** WARNING: Do not PKLITE, LZEXE or do any similar thing to TOPLink.  Doing so
  69.              will corrupt the program!  TOPLink writes its configuration
  70.              directly to the TOPLINK.EXE file.
  71.  
  72. It is recommended you put these files in a seperate directory from TOP.
  73.  
  74.                             [ Configuring TOPLink ]
  75.  
  76. Run TOPLink with a /CONFIG parameter to access the configuration manual.
  77.  
  78. Command line> TOPLINK /CONFIG
  79.  
  80. You will be able to configure these options by using the up/down cursor keys to
  81. move to the option you wish to change.  Then hit ENTER to change that option.
  82. -------------------------------------------------------------------------
  83. Your BBS Name
  84.   - This is the name of your BBS system.
  85.  
  86. ANSI Stripping
  87.   - If this is set to ON, TOPLink will remove all ANSI coming from the BBS you
  88.     have linked to.
  89.  
  90. PubColour Code Sending
  91.   - If this is set to ON, TOPLink will send PubColour codes to the BBS you have
  92.     linked to.  This can be set ON if you are connect to another TOP
  93.     teleconference, otherwise it should be OFF.
  94.  
  95. Show BBS Name
  96.   - When turned ON, the name of the BBS is displayed in front of the text
  97.     received from that BBS.  TOPLink usually looks better with this setting
  98.     turn OFF, but can be confusing to the users especially if TOPLink is
  99.     connected to another TOP teleconference.
  100.  
  101. Sending Delay
  102.   - Some teleconference programs cannot received data at the rate TOPLink sends
  103.     it.  If this is true of the teleconference TOPLink is linked to make sure
  104.     this setting is set to a suitablely long delay.  For TOP systems a delay of
  105.     7ms works well.
  106.  
  107. Checking Delay
  108.   - In order to reduce the stress on a multi-tasking or network system TOPLink
  109.     can be set to delay for a certain number of seconds between checking
  110.     incoming text from the linked BBS, and incoming text from local useres.  If
  111.     this setting is set to 0, TOPLink will continuously be checking for
  112.     incoming messages.
  113.  
  114. Direct Text
  115.   - This can be used to turn off access to direct text.  Direct text is text
  116.     from the user that is sent exactly as the user writes it.  No braces "[]"
  117.     or any other text is added to it.
  118.  
  119. BBS Commands
  120.   - TOPLink has commands which the linked BBS can send.  If you do not want
  121.     them to be able to, turn this option to OFF.
  122.  
  123. Give Time Slices
  124.   - When there is no incoming text from the linked BBS and no incoming text
  125.     from the local users, TOPLink will give up time slices to the operating
  126.     system.  This can help overall system performance on a multitasked PC.
  127.  
  128. Channel Number
  129.   - This is the channel number that you want TOPLink to "inhabit".  It can
  130.     range from 0 to 2147483647.  TOPLink is currently _NOT_ able to use
  131.     channels right up to 3999999999 (as TOP supports), nor is it able to use
  132.     Personal Channels or Conferences.  Setting this to 0 means that TOP will
  133.     reside in EVERY channel simultaneously.
  134.  
  135. Minimum Security
  136.   - TOPLink can appear invisible to users who don't have a certain security
  137.     level.  This allows you to prevent "twit" users or unverified users from
  138.     using or seeing the link.  All text sent by TOPLink will be ignored by
  139.     users who don't have this security level, and all text sent by these users
  140.     will be ignored by TOPLink.  This can be set from 0 to 65535.
  141.  
  142. MaxNodes Setting
  143.   - This should be set exactly the same as the MaxNodes setting in your TOP.CFG
  144.     file.
  145.  
  146. Crash Prot. Delay
  147.   - This setting is not used in this version of TOPLink, but it will be used in
  148.     the next (release) version.  For now, you MUST set the CrashProtDelay
  149.     setting in TOP.CFG to 0!  TOPLink does not currently support TOP's crash
  150.     protection.
  151.  
  152. -------------------------------------------------------------------------
  153.  
  154. After you have set the options to your preference press the <ESC> key. You will
  155. be prompted as to if you want to save the settings.  Type "Y" if you want them
  156. saved, "N" if you don't.
  157.  
  158.                              [ DONTSHOW.TXT File ]
  159.  
  160. Any message you don't want displayed from the other BBS should be added to this
  161. file.  Usually message sent text is ignored since it adds a lot of extra
  162. clutter.  Up to 50 lines can be placed in the DONTSHOW.TXT file with an ASCII
  163. text editor.
  164.  
  165. Sample DONTSHOW.TXT file:
  166. -Sent-
  167. -- Message Sent --
  168. -- Sent --
  169.  
  170. The file must be placed in the SAME directory TOPLink is in.
  171.  
  172.                               [ Linking to a BBS ]
  173.  
  174. First of all, make sure TOP HAS BEEN RUN PREVIOUSLY OR IS RUNNING.  TOPLink
  175. will not initialize/create the *.TCH files.
  176.  
  177. Then call the BBS you want to link to using any terminal program that allows
  178. you to shell to DOS.  Enter the BBS's teleconference and shell to DOS.  Then
  179. run TOPLink with these parameters:
  180. =========================================================================
  181. TOPLink <com port> <BBS Name> <TOP work path> <node>
  182.  
  183. <comport>    Is the com port you are going to use.
  184.              COM1 = 1, COM2 = 2, etc.
  185. <BBS Name>   Is the name of the BBS (Only one word!) you are linking to.
  186. <work path>  Is the path to TOP's work directory.
  187. <node>       Is the node TOPLink should use.
  188.  
  189. Example:
  190. Command Line> TOPLINK 2 Nucleus d:\top\workdir
  191. =========================================================================
  192.  
  193.                           [ While TOPLink is Running ]
  194.  
  195. TOPLink will load and a Pub entry message should appear to all the TOP users.
  196. The screen should look something like this once TOPLink has started:
  197. *****************************************************************************
  198.      TOPLink v2.00g1 Copyright 1996 Paul Sidorsky, All Rights Reserved.
  199. ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  200. ░┌── Com Port: 2 ─────────────────────────────────────── Node: 3 ───┬────┐░░░
  201. ░│[ TOPLink v1.00 Activated ]                                       │Sent│░░░
  202. ░│[ TOPLink v1.00 Activated ]                                       │Rcvd│░░░
  203. ░│                                                                  │    │░░░
  204. ░│                                                                  │    │░░░
  205. ░│                                                                  │    │░░░
  206. ░│                                                                  │    │░░░
  207. ░│                                                                  │    │░░░
  208. ░│                                                                  │    │░░░
  209. ░│                                                                  │    │░░░
  210. ░│                                                                  │    │░░░
  211. ░│                                                                  │    │░░░
  212. ░│                                                                  │    │░░░
  213. ░│                                                                  │    │░░░
  214. ░│                                                                  │    │░░░
  215. ░│                                                                  │    │░░░
  216. ░├──────────────────────────────────────────────────────────────────┴────┤░░░
  217. ░│L)inked to: Nucleus                                                    │░░░
  218. ░│A)nsi Stripping is: Off           B)BS Name Displaying is: On          │░░░
  219. ░│S)end TOP codes: Off              D)irect Text is: On                  │░░░
  220. ░└───────────────────────────────────────────────────────────────────────┘░░░
  221. ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  222.  <ESC> Exits TOPLink and disengages the link                   Unregistered
  223. *****************************************************************************
  224.  
  225. The window displays what TOPLink sends or receives from the com port and what
  226. it does to it shown by the right hand section of the window.
  227.  
  228. These are the codes and what they mean:
  229. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  230. Sent - Text that is sent to the other BBS.
  231. Rcvd - Text received from the other BBS but not broadcasted to the local TOP
  232.        users.
  233. Brod - Text received from the other BBS and is broadcasted to the local TOP
  234.        users.
  235. DTxt - Direct text sent from a local user.  No braces "[]" or any other text
  236.        is added to it.
  237. -Who - Sending response from a (TOP:WHO) command issued by the linked BBS.
  238. -Ver - Sending response from a (TOP:VER) command issued by the linked BBS.
  239.  
  240. Availible commands in the TOPLink session:
  241. -------------------------------------------------------------------------
  242. Key to press                       What it Does
  243.      L                 Change the name of the link.
  244.      A                 Toggles ANSI stripping of incoming text.
  245.      B                 Toggles display of linked BBS Name to local users.
  246.      S                 Toggles sending of TOP colour codes to linked BBS.
  247.      D                 Toggles ability of local users to send text
  248.                        directly to the linked BBS.
  249.     ESC                Exits TOPLink
  250.    Alt-J               Shells to DOS.
  251. -------------------------------------------------------------------------
  252.  
  253.                              [ Commands for Users ]
  254.  
  255. By typing text as usual, TOPLink will send it over the modem to the linked BBS.
  256. Actions, talktypes, profile editor enter/exiting, and many other things are
  257. sent to the linked BBS.
  258.  
  259. Direct text can be sent to the linked BBS by a user by whipsering to the link
  260. and putting a "*" before the text.
  261. eg:
  262. Rebel: /q *poker scan
  263.  
  264. Commands from the other BBS can be sent to TOPLink.  There are currently two
  265. commands availible.  They must be enclosed with parentheses "()".
  266.  
  267. (TOP:WHO) - Shows who is in TOP at the moment.
  268. (TOP:VER) - Shows version and copyright of TOPLink.
  269.  
  270.                               [ Acknowledgements ]
  271.  
  272.     The author of TOPLink wishes to thank David Ong for providing me with the
  273. original source code and documentation for RAPLink so it could be adapted for
  274. TOP.  David was too busy with university and related happenings to do this job.
  275. I am immensely grateful to him that I didn't have to rewrite TOPLink and its
  276. documentation, because it saved me months worth of work.
  277.  
  278.                                  [ Disclaimer ]
  279.  
  280.   This software and accompanying materials are distributed "as is" without
  281. warranty, expressed or implied; including but not limited to any implied
  282. warranties of merchantability or fitness for a particular purpose. In no event
  283. shall Paul Sidorsky or anyone else involved with the creation and production of
  284. this product be held liable for any damages, including, but not limited to, any
  285. lost profits, savings, data or other incidental, indirect, special, or
  286. consequential damages arising out of the use or inability to use this software,
  287. or for any claim by any other party, even if Paul Sidorsky have advised of the
  288. possibility of such damages. The person using the software bears all risk as to
  289. the quality and performance of the software.
  290.  
  291.                          [ Copyright Acknowledgements ]
  292.  
  293. This document may have mentioned other products.  All copyrights, trademarks
  294. and reserved rights held by these products are acknowledged. All trademarks and
  295. registered trademarks belong to their respective owners.
  296.  
  297.                             [ Registering TOPLink ]
  298.  
  299. TOPLink is shareware.  If you use TOPLink for more than a 60 DAY TRIAL
  300. PERIOD you MUST register it or discontinue using TOPLink.
  301.  
  302. Registering TOPLink costs $15.  Please see REGISTER.FRM for payment details.
  303.  
  304. TOPLink is NOT CRIPPLED, but does have "reminders" that it is unregistered.
  305. Registering TOPLink will remove all these reminders that TOPLink.
  306.  
  307. **************************************************************************
  308. *Print out REGISTER.FRM, complete the form and mail to the address shown!*
  309. **************************************************************************
  310.  
  311.                             [ Reaching the author ]
  312.  
  313. Please report any bugs and feel free to send comments/suggestions!
  314.  
  315.   FidoNet - 1:134/31
  316.   Internet - None right now.
  317.   Or call the ISMWare Support directly (403)686-0449 and leave a message
  318.   by pressing L at the main menu.
  319.  
  320. Or send mail to:   Paul Sidorsky
  321.                    1414 45th Street SW
  322.                    Calgary, Alberta
  323.                    CANADA T3C 2C2
  324.  
  325. The latest version of TOPLink can be downloaded from the ISMWare Support BBS by
  326. calling (403)686-0449.  The current version of TOPLink can also be freqed using
  327. the magic name of "TOPLINK".
  328.