home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / WCHAT001.ZIP / WCHAT.DOC < prev    next >
Text File  |  1990-10-30  |  9KB  |  242 lines
  1.  
  2.                              -------------------                            
  3.  
  4.                               WChat v0.01a.OS/2                             
  5.  
  6.                              -------------------                            
  7.  
  8.  
  9.                      Split-window Chat for Maximus CBCS.                    
  10.  
  11.  
  12.                            (C) David Luong, 1990.                           
  13.  
  14.                             All rights reserved.                            
  15.  
  16.  
  17.  
  18.                         FIDOnet address: 3:712/631.0                        
  19.  
  20.  
  21.  
  22.  
  23. Distribution Rights 
  24. ^^^^^^^^^^^^^^^^^^^ 
  25. You  are  hereby  granted a limited licence to use WChat in any way you see
  26. fit,  and to distribute it in any way you wish, so long as you don't charge
  27. any  money  for it. If I catch you selling my software for profit, I'll sue
  28. you for every penny of it. So there! 
  29.  
  30.  
  31. License fee & Support 
  32. ^^^^^^^^^^^^^^^^^^^^^ 
  33. Please  send me a post card if you decide to use WChat on your BBS. I enjoy
  34. collecting  postcards from _anywhere_ around the world and I mean ANYWHERE,
  35. doesn't matter even if it's from Sydney Australia! 
  36.  
  37. My postal address is included at the end of this document. 
  38.  
  39. If  you  have any problems with the installation of WChat, or if you'd like
  40. to see more features then don't hesitate to contact me via netmail. 
  41.  
  42.  
  43. Warranty 
  44. ^^^^^^^^ 
  45. I  grant  no  warranty  of  any  kind,  either  expressed  or implied. This
  46. includes, but is not limited to, implied warranties of merchantability, and 
  47. fitness  for  any  particular purpose with respect to both the software and
  48. the documentation included in this package. 
  49.  
  50. In  NO  event  shall  I  or  any of EDEN BBS's principals be liable for any
  51. direct,  indirect,  consequential, or incidental damages arising out of the
  52. use  or  inability  to  use  WChat  even  if  I  have  been  advised of the
  53. possibility of such damages or claim. 
  54.  
  55. The warranties set forth above are in lieu of all other express and implied 
  56. warranties,  whether  oral, written, or implied, and the remedies set forth
  57. above are your sole and exclusive remedies. 
  58.  
  59. This  document  constitutes  the entire agreement and understanding between
  60. the  parties  and  supersedes  any prior agreement or understanding whether
  61. oral or written, relating to the use of this package. 
  62.  
  63.  
  64. Absolute Requirements! 
  65. ^^^^^^^^^^^^^^^^^^^^^^ 
  66. * OS/2 v1.1 or higher is essential. 
  67.  
  68. * A  communications  library(COMM.DLL)  must be present to handle the  high
  69. level  comm  port communications. This 'COMM.DLL' library is distributed as
  70. part of the OS/2 Maximus CBCS package. 
  71.  
  72.  
  73. Introduction 
  74. ^^^^^^^^^^^^ 
  75. *  WChat  is  a  simple split windowed chat program for use by OS/2 Maximus
  76. sysops. 
  77.  
  78.  
  79. Contents of this archive 
  80. ^^^^^^^^^^^^^^^^^^^^^^^^ 
  81.     WChat.EXE       The  main WChat executable file.
  82.     WChat.DOC       This document.
  83.     WChat.HST       An WChat history file outlining the changes made between
  84.                     versions of WChat.OS/2
  85.     WChat.CTL       Sample WChat control file.
  86.  
  87. Command line syntax of WChat 
  88. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
  89.  
  90.        WChat -Pn -B -Tn
  91.  
  92.  
  93.        Command line options of WChat
  94.        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  95.  
  96.            -p ,specifies which comm port handle.
  97.                No default.
  98.  
  99.                IMPORTANT NOTE:
  100.                ---------------
  101.                * On a zero based comm port assignment, '-p0' does NOT
  102.                  necessarily mean COM1.
  103.  
  104.                * This comm port handle should be the one passed on by
  105.                Maximus's  '%L' or '%p' translation sequence for external
  106.                door programs.
  107.  
  108.            -b ,caller's baud rate.
  109.                This option is ignored by this OS/2 version of WChat. WChat
  110.                does NOT need to change the current comm port's operating
  111.                parameters.
  112.  
  113.            -t ,where n is the task number for this node.
  114.  
  115.                LEAVE THIS OPTION OUT COMPLETELY if the 'TASK' token is NOT
  116.                in effect in your MAX.CTL.
  117.  
  118.        NOTE:
  119.        * Command line options may be presented in any order.
  120.  
  121.  
  122.  
  123.  
  124. Installation 
  125. ^^^^^^^^^^^^ 
  126. 1.  Create  a  separate  directory  for  WChat(will  use  d:\WChat for this
  127. example). 
  128.  
  129. 2.  Copy all the files in this archive to d:\WChat
  130.  
  131. 3.  Modify  the control file 'WChat.CTL'. Please consult the sample control
  132. file for more information on the syntax of WChat.CTL. 
  133.  
  134. 4.  Maximus  CBCS  has  10  macro  keys which you can program. These are F1
  135. through to F10. To program the Maximus macro keys, you simply create a file 
  136. by  the  name  of  the  key(e.g.  F8.BBS) and place it in your Maximus Misc
  137. directory(usually \max\misc). 
  138.  
  139. These macro keys would only work when a remote caller is on-line. 
  140.  
  141.  
  142. For Example: 
  143. ------------ 
  144.  
  145. * If you wish to use the F10 key to call up WChat whenever you want to have
  146. a chat with your callers, then create a MECCA file 'F10.mec' in the Maximus
  147. Miscellaneous directory(usually \max\misc) like this one: 
  148.  
  149.       [Xtern_run]d:\WChat\WChat.exe %L -t%k
  150.  
  151.       Maximus will translate:
  152.  
  153.            %L into either '-K' or '-Pn -bxxxx'
  154.               depending on whether the caller is remote or not.
  155.  
  156.            %k into the task number of this node.
  157.  
  158. * Now compile this file via MECCAP.EXE.
  159.  
  160.   ┌─────────────────────────────────────────────────────────────────────┐
  161.   │ TASK NUMBER?!?                                                      │
  162.   │ --------------                                                      │
  163.   │                                                                     │
  164.   │ * If you run a single line Maximus BBS and haven't specified a      │
  165.   │   'Task' number in your MAX.CTL, then LEAVE OUT the '-t%k' in       │
  166.   │   all the above example.                                            │
  167.   │                                                                     │
  168.   │   WChat  uses the '-T' command line switch to find out which        │
  169.   │   'lastus??.BBS' to use.                                            │
  170.   │                                                                     │
  171.   │   For example:                                                      │
  172.   │                                                                     │
  173.   │         * If '-T' is ABSENT from the command line AND WChat is NOT  │
  174.   │           operating in the local mode, then WChat would look for    │
  175.   │           'Lastuser.bbs' for more info on the current caller.       │
  176.   │                                                                     │
  177.   │         * If '-T1' is present on the command line AND WChat is NOT  │
  178.   │           operating in the local mode, then WChat would look for    │
  179.   │           'Lastus01.bbs' for more info on the current caller.       │
  180.   │                                                                     │
  181.   └─────────────────────────────────────────────────────────────────────┘
  182.  
  183.  
  184.  
  185.  
  186. WChat Control File Syntax: 
  187. ^^^^^^^^^^^^^^^^^^^^^^^^^^ 
  188.  
  189.       Key Words:
  190.       ----------
  191.  
  192.  
  193.        Lastuser_Path   This tells WChat where to find your 'lastus??.bbs'
  194.                        files. The 'lastus??.bbs' files are written out
  195.                        by Maximus each time an external program is
  196.                        called from within Maximus.
  197.  
  198.                        WChat make use of these files to find out the
  199.                        caller's name, time remaining etc.
  200.  
  201.                        For Example:
  202.  
  203.                               Lastuser_Path  D:\max\
  204.  
  205.  
  206.        SYSOP           Defines the Sysop's name.
  207.  
  208.  
  209.                        For Example:
  210.  
  211.                                SYSOP   David Luong
  212.  
  213.  
  214.  
  215. Hardcoded Error levels of WChat 
  216. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
  217.  
  218.       255: Fatal error. You should  take note of the error message on
  219.            the screen.
  220.  
  221.  
  222.  
  223.  
  224. -=[WELL, THAT'LL BE ALL FOLKS]=- 
  225.  
  226.  
  227. Future enhancement, bug report etc. 
  228. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
  229. WChat  is  not  guaranteed to be free of bugs. In any case, netmail me your
  230. wish list and bug reports, and I'll see what I can do in the next version. 
  231.  
  232. Please  send  in  those  post-cards, they serve as an incentive for further
  233. developments in this BBS utility program. 
  234.  
  235. Post cards should be directed to: 
  236.  
  237.                  Mr. David Luong
  238.                  308/232 Pitt Street,
  239.                          Waterloo, N.S.W. 2017
  240.                          Australia.
  241.  
  242.