home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / ltalk30 / ltalk.doc < prev    next >
Text File  |  1993-01-20  |  20KB  |  534 lines
  1.       ~~ LazerTalk ~~ Full Duplex External Chat System for the Atari ST
  2.                       The Midas Development Team (c)1992
  3.  
  4. John Carolin                             Keyop Troy
  5. QueST BBS, QuickBBS-ST Support UK        Magnum BBS
  6. Fidonet 2:255/303  NeST 90:1008/102      Fidonet 2:255/313  NeST 90:1008/101
  7. +44-422-381164                           +44-274-547006
  8.  
  9.  
  10. Purpose
  11. =-=-=-=
  12.  
  13. LazerTalk is an external replacement  chat  program  for most Atari ST
  14. BBS systems that offers a split screen chat facility. It is the  first
  15. of its kind to operate in BOTH VT52 AND ANSI!
  16. The screen is split in two  giving  the  SysOp  and the user their own
  17. window allowing text to be entered simultaneously by each participant.
  18. If the user has ASCII or something  else selected then a standard chat
  19. routine is provided, but  with  many  enhanced  features. Depending on
  20. the users  graphics mode the SysOp may  freely  toggle  between  split
  21. screen and standard modes during the chat.
  22.  
  23. If a user is operating at LESS than 1200 baud with  VT52/ANSI selected
  24. LazerTalk will NOT use  split screen. This  is  because  split  screen
  25. operation is very IO intensive and will become too slow. If it becomes
  26. too slow even at 1200 baud, then the SysOp can switch to the  standard
  27. chat routine at the press of a key.
  28.  
  29.  
  30. How it works
  31. =-=-=-=-=-=-
  32.  
  33. Firstly a word  about  the  command  line  LazerTalk  requires to run.
  34. Failure to pass it the correct parameters  will  result  in  an  error
  35. message or LazerTalk functioning incorrectly. The command line follows
  36. QuickBBS conventions.
  37. SysOp's using other  BBS  software  should  execute  LazerTalk  from a
  38. batch/script file and use macro's or system variables to give  it  the
  39. information it needs.
  40. Please do not panic! Even if you  know the BBS software you use cannot
  41. run LazerTalk with the right parameters... read on.
  42.  
  43. LTALK.PRG <1> <2> <3> <4> <5> <6>
  44.  
  45. 1. This is the 'yell' parameter. It indicates that the user paged with
  46.    a value of 1, or the SysOp broke in to chat with a value of 0.
  47.  
  48. 2. Simply the baudrate of the  current user online in standard format,
  49.    i.e. 1200,2400... 19200 etc.
  50.  
  51. 3. Current users first name.
  52.  
  53. 4. Current users last name.
  54.  
  55. 5. This indicates what graphics  mode  the  current user has selected.
  56.    The values are:
  57.    0 - Ascii
  58.    1 - VT52 Mono
  59.    2 - VT52 Colour
  60.    3 - VT52 Standard (-Unused-)
  61.    4 - ANSI
  62.  
  63. 6. Users record number in USERS.BBS. This is strictly a QBBS only
  64.    parameter and is no longer used by LazerTalk. For completeness this
  65.    must still be present. Simply give it  any value you wish such as 0
  66.    or 1.
  67.  
  68. If LazerTalk if being used  with  QBBS,  QBBS  will spoon feed it with
  69. exactly the above command line. Therefore  the  above  information  is
  70. only given for SysOps who run other BBS software to help get LazerTalk
  71. installed and working. If absolutely necessary you can cheat a little,
  72. for instance you could make parameter no. 2, the baudrate, permanently
  73. 2400.
  74.  
  75. 'Feeders'
  76. ---------
  77.  
  78. On its  own  LazerTalk  cannot  be  installed  to  correctly  run with
  79. ///Turbo BBS because it is unable to  supply  LazerTalk  with all  the
  80. parameters it needs.
  81. To overcome this a series of 'Feeders' will become available. The idea
  82. behind these is that instead of running LTALK.PRG a feeder is run that
  83. finds the information LazerTalk requires from  system files of the BBS
  84. software it was written  for  and  then  executes  LTALK.PRG  with the
  85. correct command line.
  86.  
  87. A feeder for  ///Turbo  BBS  is  already  available. The  filename is
  88. LT_TBBS2.LZH and should be available from  the same place you got this.
  89. It includes three  programs and  documentation  that explains the very
  90. simple installation process to get LazerTalk and ///Turbo BBS  working
  91. in perfect harmony!
  92.  
  93. If you can't get LazerTalk  running  with  your particular BBS package
  94. then PLEASE feel free to contact  us  and  ask  about  the possibility
  95. of a feeder being written for it and we'll see what can  be  done!. We
  96. want LazerTalk to be compatible with all ST BBS systems available!
  97.  
  98. Configuration File
  99. ------------------
  100.  
  101. A configuration file called LTALK.CFG must live in the same  directory
  102. as LTALK.PRG. This file contains many config commands, some  optional,
  103. some essential that configure LazerTalk to your system.
  104. The format of the file  is  one  command  per line, followed  by a ':'
  105. colon, a space and the options/text for the command.
  106.  
  107. i.e.          SYSOP: John Carolin
  108.               REASON-TO-CHAT: ON
  109.  
  110. Please view the example LTALK.CFG  included  in  this archive to get a
  111. better idea.
  112. The commands currently implemented are -
  113.  
  114. SYSOP
  115. -----
  116.  
  117. Usage: Name of SysOp.
  118. Desc : Specify name of SysOp,  this  is  displayed in the split screen
  119.        mode to indicate who's window belongs to who.
  120.  
  121. REASON-TO-CHAT
  122. --------------
  123.  
  124. Usage: ON or OFF.
  125. Desc : If this is set to ON,  when  a  user pages you he will be asked
  126.        for a reason to chat. He  may  give  a  1  line reply which  is
  127.        then displayed on screen while LazerTalk pages you to help  you
  128.        decided whether to bother answering the page or not!
  129.  
  130. SHELL
  131. -----
  132.  
  133. Usage: Path and filename.
  134. Desc : Specify program to execute when ALT-J is pressed.
  135.  
  136. YELL
  137. ----
  138.  
  139. Usage: Path and filename OR 'BELL'.
  140. Desc : You may either  specify a  filename of  an xbios 32  compatible
  141.        yelltune to play upon a  page, or  enter 'BELL'  and  LazerTalk
  142.        will use the ST's bell to get your attention. You may  use  any
  143.        of the QBBS paging tunes here.
  144.  
  145. PAGE-LENGTH
  146. -----------
  147.  
  148. Usage: Time in seconds.
  149. Desc : Specify how long LazerTalk should attempt to page you.
  150.  
  151. NOT-AROUND
  152. ----------
  153.  
  154. Usage: Path and filename.
  155. Desc : Specify a text file to display to the user if you do not answer
  156.        a page request before the 'PAGE-LENGTH' time expires.
  157.        
  158. SCROLL
  159. ------
  160.  
  161. Usage: ON or OFF.
  162. Desc : When a window is full of text it will scroll with  this set  to 
  163.        ON. Setting to OFF will result in the window  being  wiped  and
  164.        having the cursor returning to the top.
  165.  
  166.  
  167. *** ALL ABOVE COMMANDS MUST BE PRESENT ! ***
  168.  
  169. LOG-RTC
  170. -------
  171.  
  172. Usage: ON or OFF.
  173. Desc : If this is set to  ON  LazerTalk  will write the reply the user
  174.        enters to the reason to chat prompt  in  your  system log. This
  175.        command is only required if 'REASON-TO-CHAT' is set to ON.
  176.  
  177. SYSLOG
  178. ------
  179.  
  180. Usage: Path and filename.
  181. Desc : Specify the path and filename  of your system log. This command
  182.        is only required if the 'LOG-RTC' command is ON.
  183.  
  184. PAGE-STARTMSG
  185. -------------
  186.  
  187. Usage: One line message.
  188. Desc : This message will be displayed  to the user when LazerTalk goes
  189.        into chat from a user page.
  190.        i.e. "Hi, How can I help?". This command is optional.
  191.        The '|' (pipe) character can be used to give a carriage return.
  192.  
  193. PAGE-ENDMSG
  194. -----------
  195.  
  196. Usage: One line message.
  197. Desc : This message  will  be  displayed  to  the  user when LazerTalk
  198.        exits after a user page. This command is optional.
  199.        The '|' (pipe) character can be used to give a carriage return.
  200.  
  201. BREAK-STARTMSG
  202. --------------
  203.  
  204. Usage: One line message.
  205. Desc : This message will be displayed  to the user when LazerTalk goes
  206.        into chat from a SysOp break in.
  207.        i.e. "The SysOp bursts in". This command is optional.
  208.        The '|' (pipe) character can be used to give a carriage return.
  209.  
  210. BREAK-ENDMSG
  211. ------------
  212.  
  213. Usage: One line message.
  214. Desc : This message  will  be  displayed  to  the  user when LazerTalk
  215.        exits after a SysOp break in. This command is optional.
  216.        The '|' (pipe) character can be used to give a carriage return.
  217.  
  218. FUNWORD
  219. -------
  220.  
  221. Usage: findstring<>replacestring
  222. Desc : This  is  where  the  good  stuff  starts!  Both findstring and
  223.        replacestring  may  each  be  any  number of  words.  When  the
  224.        findstring is  typed  by the  SysOp or  the user, the  text  is
  225.        backspaced over and overwritten with the replacestring.
  226.        i.e. LazerTalk<>LazerTalk, simply the BEST chat system!
  227.        FUNWORD definitions are optional.
  228.        The '|' (pipe) character can be used to give a carriage return.
  229.  
  230. FUNMODE-DEFAULT
  231. ---------------
  232.  
  233. Usage: ON or OFF.
  234. Desc : If this is set to  ON  when  LazerTalk first goes into chat the
  235.        funmode will be  active. This may  be later  toggled  by  ALT-F
  236.        within chat. This command is only required if you have  defined
  237.        any FUNWORD's.
  238.  
  239. FUNMODE-CASE-CHECK
  240. ------------------
  241.  
  242. Usage: ON or OFF.
  243. Desc : Decides whether the funmode should be case sensitive.
  244.        i.e SysOp<>System Commander
  245.        If this is set to ON, ONLY  'SysOp will trigger the funmode, if
  246.        it is set  to OFF 'SYSOP', 'sysop' etc  will  trigger it.  This
  247.        command is only required if you have defined any FUNWORD's.
  248.  
  249. F1 - F20
  250. --------
  251.  
  252. Usage: Function key string.
  253. Desc : These commands are used to assign text/messages to the function
  254.        keys. F11 - F20 are accessed with SHIFT F1 - SHIFT F10.
  255.        The '|' (pipe) character can be used to give a carriage return.
  256.  
  257. PRG1 - PRG10
  258. ------------
  259.  
  260. Usage: Path of program to execute, followed by parameters in quotes.
  261. Desc : These commands can be used to define some external programs  to
  262.        run from within LazerTalk. They are accessed from  the keyboard
  263.        by ALT-1 (PRG1) ALT-2 (PRG2)...... etc ALT-0 (PRG10).
  264.        If any parameters need passing to the program  they  should  be
  265.        placed in quotes.
  266.        i.e. Program on its own:
  267.        PRG1: C:\XYZ.TTP
  268.        i.e. Program with parameters:
  269.        PRG2: C:\XYZ.TTP "-c"
  270.  
  271.        The special string '*INPUT*' may be placed anywhere within  the
  272.        quotes.If this is done, when the program entry is run LazerTalk
  273.        will ask you to enter a line of text to PLACE  IN THAT POSITION
  274.        on the command line for that program.For example to send a file
  275.        using XYZ.TTP you could use -
  276.  
  277.        PRG3: C:\XYZ.TTP "-c -u *INPUT*"
  278.  
  279.        and the filename you give would be placed neatly in the desired
  280.        position on the command line.OR if you wish to enter the entire
  281.        command line of a program yourself at runtime, you can use -
  282.  
  283.        PRG3: C:\XYZ.TTP "*INPUT*"
  284.        
  285. WAITMSG
  286. -------
  287.  
  288. Usage: One line message.
  289. Desc : Used to specify a line of text to display to user when the chat
  290.        pauses for  a moment  while  a help  screen, config  editor  or
  291.        external program is used.
  292.  
  293. ----------------------------------------------------------------------
  294. SOME CONFIGURATION COMMANDS ARE ONLY OPTIONAL DEPENDING ON THE SETTING
  295. OF ANOTHER COMMAND. (I.E. LOG-RTC IS ONLY NEEDED IF REASON-TO-CHAT: IS
  296. SET TO ON) MISSING COMMANDS WILL GIVE AN ERROR MESSAGE FROM  LAZERTALK
  297. OR LAZERTALK MAY FUNCTION INCORRECTLY. IT IS A GOOD IDEA TO MODIFY THE
  298. INCLUDED EXAMPLE LTALK.CFG FOR YOUR NEEDS.
  299.  
  300. LTALK.CFG may contain blank lines, tabs and comments. Each line may be
  301. up to 255 characters long, alowing some pretty impressive funmode  and
  302. function key definitions!
  303. ----------------------------------------------------------------------
  304.  
  305.  
  306. Usage
  307. =-=-=
  308.  
  309. Installation
  310. ------------
  311.  
  312. 1. Copy all LazerTalk files into  the  same directory, plus any feeder
  313.    programs if they are needed.
  314.  
  315. 2. Modify the supplied LTALK.CFG  to  suit  your system or create your
  316.    own.
  317.  
  318. 3. QBBS-ST: Edit the "External Chat"  field in QCONFIG  and enter  the
  319.             path and filename to LTALK.PRG.
  320.    OTHER  : Create a batch/door file  to execute LTALK.PRG and give it
  321.             the command line it requires or setup  a Feeder  for it if
  322.             there is one available.
  323.  
  324.  
  325. Functions Available - Being Paging
  326. ----------------------------------
  327.  
  328. When you are being paged, '*' can be pressed to halt the  paging tune, but
  329. continue with the paging itself. This is best reserved with annoying users
  330. and helps avoid the risk of turning the monitor volume down and forgetting
  331. to turn it back up. Any other key starts the chat. These options are shown
  332. on your screen upon a page.
  333.   While the paging is still happening, the user may abort it by pressing
  334. his space bar. This option is displayed to the user. 
  335.  
  336.  
  337. Functions Available - In Chat
  338. -----------------------------
  339.  
  340.  
  341. Functions available to the SYSOP:
  342.  
  343. > UNDO    : Exit LazerTalk
  344.  
  345.   This key exits LazerTalk funnily enough!
  346.  
  347. > INSERT  : Switch Mode
  348.  
  349.   Toggles  between  split screen/standard  chat.  This  will only work
  350.   from  the  standard chat mode if the user is using VT52 or ANSI.
  351.  
  352. > HELP    : Help summary/display status
  353.  
  354.   Pressing HELP displays a comprehensive help screen showing  all  the
  355.   available functions of LazerTalk. Note  than  when  this  screen  is
  356.   displayed all chatting will halt but continue from exactly where you
  357.   left off when you return. Pressing any key returns to the chat.
  358.  
  359. > ALT-H   : Disconnect User
  360.  
  361.   Instantly disconnect a user and exit to QBBS.
  362.  
  363. > ALT-J   : Execute Shell
  364.         
  365.   This  executes  the  program    specified  in  the config file under
  366.   SHELL. This  can  be  used  to create  a jump  to  dos  facility  in
  367.   LazerTalk.
  368.  
  369. > ALT-U   : Uppercase Killer
  370.         
  371.   Don't you just HATE PEOPLE  SHOUTING,  turning the uppercase  killer
  372.   on stops the effect of the users shift or caps lock.
  373.  
  374. > ALT-I   : Toggle Remote I/O Lock
  375.  
  376.   A very nasty function! If a user is really getting on your nerves or
  377.   simply won't shut up, activate this. It  prevents  the  user  typing
  378.   ANYTHING, and sends a bell back to him for each keypress he hits.
  379.  
  380. > ALT-F   : Toggle Funmode
  381.  
  382.   This will enable/disable the  Funmode  facility,  depending what the
  383.   default in LTALK.CFG is set to.
  384.  
  385. > ALT-L   : Chat Logging On/Off
  386.  
  387.   Activates/Deactivates chat logging. In normal mode, the conversation
  388.   will be saved in LT_CHAT.LOG. In split screen, the conversation will
  389.   be saved as 2 seperate files, one for each window. They are saved as
  390.   LT_SYSOP.LOG and LT_USER.LOG respectively.
  391.   
  392. > ALT-R   : Redraw Screen
  393.          
  394.   This will redraw the split  screen  and   clear each of the windows.
  395.   It affects both the  SysOps AND  the  users  screen.  This  is  best
  396.   used if the screen becomes corrupted in some way by line noise.
  397.  
  398. > ALT-W   : Wipe Your Window
  399.  
  400.   This simply wipes your window of text.
  401.   
  402. > ALT-K   : Show Function Keys
  403.  
  404.   Displays a screen showing  the current  contents of F1-F20. Any  key
  405.   returns to chat.
  406.  
  407. > ALT-S   : Scroll Toggle
  408.  
  409.   The initial setting of this depends upon  the  SCROLL line  in  your
  410.   configuration. Pressing ALT-S will toggle the scrolling/wiping  mode
  411.   accordingly.
  412.   
  413. > ALT-C   : Configuration Editor
  414.   
  415.   LazerTalk allows you to edit its configuration while  on-line.  This
  416.   can be used for the adding/removal of Funwords, Function Keys or any 
  417.   other aspect of LazerTalks configuration. When ALT-C is  pressed the
  418.   menu below is shown.
  419.   
  420.   LazerTalk Configuration Editor, Available Functions -
  421.   
  422.   1]  [V]IEW    - Displays current LTALK.CFG.
  423.   2]  [A]DD     - Add line to LTALK.CFG.
  424.   3]  [D]EL     - Deletes given line from LTALK.CFG.
  425.   4]  [R]EPLACE - Replace a line in LTALK.CFG.
  426.   0]  [E]ND     - Re-load configuration and return to chat.
  427.  
  428.  
  429.   View    : Shows the current contents of LTALK.CFG.
  430.   Add     : Prompts for a line to append to LTALK.CFG.
  431.   Del     : Prompts for a line that matches the line in LTALK.CFG  you
  432.             wish to delete. Wildcards may be used with this function.
  433.             i.e. a '?' (question mark) can  be used  to  represent any
  434.             single  character, and  a '*'  asterisk  can  be 1 used to
  435.             represent any number of characters. For example, to delete
  436.             Function Key 15, you could enter "F15: *".
  437.   Replace : Prompts for a line to find which may contain wildcards. It
  438.             then asks for a line to replace this with, if found.
  439.   End     : Configuration will be reloaded and the conversion can
  440.             continue with any changes taking immiedate effect.
  441.  
  442. Functions available to the USER:
  443.  
  444. > CTRL-R  : Redraw Screen
  445.  
  446.   Redraws  the   split   screen   and   clears   both   windows,  this
  447.   function  affects  both the SysOps and the users screen.
  448.  
  449. > CTRL-W  : Wipe Users Window
  450.  
  451.   Wipes the users windows of text.
  452.  
  453.  
  454. Points to note
  455. =-=-=-=-=-=-=-
  456.  
  457. You will find operating in ANSI is  slightly slower than VT52. This is
  458. because the necessary ANSI codes  are  on  average 2 bytes larger than
  459. their VT52 equivalents. At the  users  end  the screen may suffer from
  460. cursor jumping. This is  unavoidable  as  after great investigation  I
  461. have been unable to find an ANSI  code  to turn off the cursor. If you
  462. know such a code let me know!
  463.  
  464.  
  465. LazerTalk is NOT free!
  466. =-=-=-=-=-=-=-=-=-=-=-
  467.  
  468. LazerTalk  is SHAREWARE. You are  free to use  it for  the  evaluation
  469. period of 31 days. If you continue to use  it after this  time you are
  470. obliged to  become  a  registered  user.   There  are  many  plans for
  471. enhancements to LazerTalk in the  coming  months  but  this  won't  be
  472. possible unless we receive your full support.
  473. As a registered user you will receive a key that will personalise your
  474. copy of LazerTalk, and remove  all "Unregistered Copy" messages, along
  475. with the screen that is  displayed  for 5 seconds  whenever  LazerTalk
  476. exits. Once you have registered you have 3 options how to receive your
  477. key:
  478.  
  479. 1. Delivery by mailer if you have a network ID on Fidonet or NeST.
  480. 2. Downloaded from my BBS.
  481. 3. Sent on disk, but you must supply the disk.
  482.  
  483. The registration fee is 10 English  Pounds or the  equivalent  in your
  484. currency. This can  be paid by Cheque if  you are within the  UK or by
  485. International Bank Draft the rest of the world  made payable  to J. M.
  486. Carolin. Send  this,  along  with your Name, Address  and  BBS details
  487. (Name, network addresses etc) to :
  488.  
  489. John Carolin
  490. 331 Moor End Road
  491. Mount Tabor
  492. Halifax
  493. West Yorkshire
  494. HX2 ORD
  495. England
  496.  
  497. Remember to specify how you wish to receive your key.
  498. If you have ANY queries or problems regarding registration then please
  499. contact John Carolin  by netmail at (2:255/303)  or (90:100/113)  and
  500. we'll try and work something out, we want as many registered LazerTalk
  501. users as possible!
  502.  
  503. Under NO circumstances should a key be passed onto anyone else but the
  504. registered user the key was created for.
  505.  
  506.  
  507. Copyright
  508. =-=-=-=-=
  509.  
  510. The program(s), documentation  and  any  other  related  files to this
  511. project are copyright of The Midas  Development Team 1992. Each  piece
  512. of software maybe the sole work of John Carolin, Keyop Troy or a joint
  513. production. Copyright is held by the respective author(s). ALL  RIGHTS
  514. RESERVED.
  515.  
  516. This software may be freely distributed if:
  517.  
  518. 1. No charge is made for this software by a third party.
  519. 2. No modifications to the documentation or executables are made.
  520. 3. The contents of this archive are not changed in any way.
  521.  
  522.  
  523. Feedback
  524. =-=-=-=-
  525.  
  526. If you have any problems or suggestions for new features in  LazerTalk
  527. PLEASE get in touch with us at the systems on the top of this document
  528. and we'll see what can be done. If you are unable to install LazerTalk
  529. for your BBS software, again contact us  at  the systems listed at the
  530. top of this document.
  531. Remember, we are busy people and only registered  users get  priority!
  532. Messages can  be  left for us in the QUICKBBS.ST echo and most Fidonet
  533. and NeST SysOp echo's.
  534.