home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / splitz22 / splitz22.doc < prev    next >
Text File  |  1993-05-01  |  23KB  |  445 lines
  1.  
  2.                            --- QBBS SplitZ v2.2---
  3.  
  4.                        >>> The ULTIMATE Chat program <<<
  5.  
  6.                      --- Copyright (c) 1992 M.J.Matts ---
  7.                   Source released into the Public Domain 1993
  8.                       Portions of Code (c) 1993 P.Baker
  9.                         --- SplitZ is now FREEWARE ---
  10.  
  11. These DOC files were originally released my Mark Matts into the Public
  12. Domain after he ceased to Support SplitZ , they have been altered in some
  13. respects to mirror the changes I have made to the program since receiving
  14. it.
  15.  
  16. If you use a Pre 2.0 version of SplitZ please forget about it. This 
  17. NEW version has undergone MANY changes, rewrites and has had many additions. 
  18. Due to this I recommend that you read ALL of this DOC file before using or 
  19. trying it as there are many differences between this and previous versions. If 
  20. you tried previous versions and decided not to use it due to the bugs, 
  21. especially in split screen mode, I recommend you try this.. Many online hours 
  22. have been spent testing for any possible bugs and it now seems to be ok, my 
  23. fingers are crossed as I type this. Most of the 'live' testing was done 
  24. between myself on the ST and my wife on her PC running ANSI.SYS.. because of 
  25. this SplitZ will work exactly the same as VT52 graphics mode when running in 
  26. ANSI giving you the FULL split screen capability between different machines..
  27.  
  28. SplitZ is, as the name suggests, a split screen chat program for using with
  29. any BBS capable of running external programs . It comes with the usual
  30. features of many good chat programs but with a few other features never found in any other chat program before.
  31. Many of the features available are SysOp configurable so it can be set up to
  32. suit your own tastes, and possibly that of your users!
  33. such as Allowing the SysOp to jump to a CLI program from within SplitZ,
  34. logging the chat to a text file, switching off uppercase characters,
  35. dropping the line on the user plus many others. The 'EXTRA' features found
  36. in SplitZ include the ability to show a text file to a users from within
  37. the chat, a 'fun' mode that can be easily switched on and off and the best
  38. feature is the ability for an 'INSTANT DOWNLOAD', read on for a further
  39. explanation of this..
  40.  
  41.   ****************************** DISCLAIMER *****************************
  42.   *                                                                     *
  43.   *   SplitZ has been tested as much as possible and as yet has never   *
  44.   *   trashed a harddisk, however, I cannot gaurantee that it is 100%   *
  45.   *   safe so you use it at your own risk.                              *
  46.   *                                                                     *
  47.   ***********************************************************************
  48.  
  49. >>>> How to install SplitZ..
  50.  
  51. Place SPLITZ.PRG , SPLITZ.RSC & SPGRAPH.PRG in the folder you are going
  52. to run them from.
  53.  
  54. Run The SPGRAPH.PRG program in a batch file when a user logs on to your
  55. BBS and pass the users FULL name to it as a parameter.
  56. SPGRAPH will search the file SPLITZ.DAT , if the user isn't found it will
  57. then ask the user for his choice of emulation , save it in SPLITZ.DAT and 
  58. create a file called SPLITZ.USR, this will be read by SPLITZ when it is run.
  59.  
  60. To stop the SPLITZ.DAT file getting too large , if you run SPGRAPH once a
  61. day with the paramaters SCAN <no of days> then SPGRAPH will scan SPLITZ.DAT
  62. and remove any users from it who haven't logged on within the set number of
  63. days.
  64.  
  65. E.G. SPGRAPH.PRG SCAN 90
  66.  
  67. Once installed you must make your BBS run the SplitZ program passing the
  68. parameter YELL to it to make the program page you , if your BBS can run
  69. a default pager at your request then SPLITZ will go straight into chat mode
  70. if no parameter is used when you go into chat with a user on-line.
  71. That is it, you now have a  standard SplitZ setup. 
  72.  
  73. TURBO Board sysops , rename SPLITZ.PRG to CHAT.PRG and the BBS will run it
  74. automatically when you press escape with a user on-line.
  75.  
  76. If you want to take advantage of SplitZ's extra features you must create two
  77. external text files telling SplitZ how you want it to operate.
  78.  
  79. The first is called FUNMODE.BBS and controls the 'fun' mode where words type
  80. are replaced with others, sometimes this can be quite amusing and on other
  81. occasions quite embarrassing depending on how you have it set up. 
  82. FUNMODE.BBS is simply a listing of any words that you want changing when the 
  83. 'fun' mode is operational. For the 'fun' mode to work the FUNMODE.BBS file 
  84. _MUST_ be in the folder that you run SplitZ from. It must also use the
  85. following format:-
  86.  
  87. hello<>Wotcha
  88. bye<>Goodbye
  89. qbbs<>QuickBBS
  90. sysop<>Spotty Twerp (!)
  91.  
  92. The first word can only be a single word but be in any case, ie, upper or
  93. lower. This is the word that is changed if it is written. The second string
  94. of text can be anything you like and not just a single word. How you write
  95. it here is EXACTLY as it is re-written when replacing the first word. 
  96. Between the word to change and the word(s) to change it to you must place the 
  97. two characters <> in this exact format, basically what it means is change 
  98. this < to that >.. The 'fun' mode can be very useful aswell as amusing.. If 
  99. you find that you are regularly typing the same phrase each time you chat why 
  100. not include shortcut words that will be extended into your most used phrases, 
  101. for example., I am always typing 'BTW' instead of 'by the way' which confuses 
  102. a few users as they do not know what 'BTW' means, therefore one line in my 
  103. FUNMODE.BBS reads..  btw<>by the way .. Makes life much quicker!
  104.  
  105. The second external file that you can use to enhance SplitZ is called
  106. SPLITZ.CTL, which again _MUST_ be placed in the same folder as you run 
  107. SplitZ from , and is used to switch on certain functions or to replace
  108. certain standard text lines. The format of each command must be exactly as
  109. shown below but they can be in any order within the CTL file. If you do not
  110. want to have, or change a feature you simply leave the command out of the
  111. CTL file.
  112.  
  113. The available commands are as follows:-
  114.  
  115. Command : SYSTEMPATH <Full path to your main BBS folder>
  116. Example : systempath e:\turbo\
  117. Purpose : This _MUST_ be in the CTL file.. I do not trust environment 
  118.           variables 100% so this is to make sure the system files can be 
  119.           found.. Without this command SplitZ WILL NOT work..
  120.  
  121. Command : DOS <Full path and filename>
  122. Example : dos e:\pcommand.prg -i -c
  123. Purpose : When you press ALT/J this program will be called. Any parameters 
  124.           needed can be added to the end of the program name. (See example)
  125.  
  126. Command : TODOSTEXT <Text string>
  127. Example : todostext Hang on a sec.. Just gone to DOS!!
  128. Purpose : This text is displayed to the user when you press ALT/J to run the 
  129.           program defined by DOS=
  130.  
  131. Command : FROMDOSTEXT <Text string>
  132. Example : fromdostext Hi, I'm back with a vengance...
  133. Purpose : This text is displayed to the user when you return to Splitz after 
  134.           running the program defined by DOS=
  135.  
  136. Command : PAGELEN <number>
  137. Example : pagelen 15
  138. Purpose : This number defines the amount of seconds Splitz will try to page 
  139.           you. If not used SplitZ will page you for 20 seconds.
  140.  
  141. Command : SCROLL
  142. Purpose : This Changes the method SPLITZ uses to handle screen text when you
  143.           reach the bottom of your text box , normally the cursor moves to
  144.           the top line and blanks it , this command forces the top line to
  145.           be deleted and a blank line to be inserted at the bottom instead.
  146.  
  147. Command : GETTEXT <Text string>
  148. Example : gettext Just gone for that DOC file you want to read..
  149. Purpose : Displayed to the user when you are searching for a text file to 
  150.           send to them for viewing.
  151.  
  152. Command : INSTANTDL
  153. Example : instantdl
  154. Purpose : If used this will enable the 'INSTANT DOWNLOAD' feature which can 
  155.           then be accessed by pressing ALT/I from within any chat mode. No 
  156.           parameters are needed for this command. If it is not used all other 
  157.           CTL commands needed for the 'INSTANT DOWNLOAD' feature will be 
  158.           ignored and pressing ALT/I will have no effect.
  159.  
  160. Command : INSTDLTEXT <Text string>
  161. Example : instdltext Just gone to get the file you want, back in a mo..
  162. Purpose : This will be the text displayed to the user when you press ALT/I to 
  163.           use the 'INSTANT DOWNLOAD' feature. This will let them know that 
  164.           the BBS hasn't crashed while you go looking for the file that they 
  165.           want to download, or the one that you want to send to them.
  166.  
  167.  
  168. Command : DLX <Full path, file name and parameters>
  169. Example : dlx d:\transfer\xyz.ttp -u -c -x *file
  170. Purpose : Specifies the external transfer program to use for X-Modem transfer 
  171.           and the parameters to be passed to it. *file will be replaced with 
  172.           the name of the file you are going to send to the user, it can be 
  173.           anywhere in the parameters line so that different transfer programs 
  174.           can be used.
  175.  
  176. Command : DLY <Full path, file name and parameters>
  177. Example : dly d:\transfer\xyz.ttp -u -c -y *file
  178. Purpose : Specifies the external transfer program to use for Y-Modem transfer 
  179.           and the parameters to be passed to it. *file will be replaced with 
  180.           the name of the file you are going to send to the user, it can be 
  181.           anywhere in the parameters line so that different transfer programs
  182.           can be used.
  183.  
  184. Command : DLZ <Full path, file name and parameters>
  185. Example : dlz d:\transfer\xyz.ttp -u -c -z *file
  186. Purpose : Specifies the external transfer program to use for Z-Modem transfer 
  187.           and the parameters to be passed to it. *file will be replaced with 
  188.           the name of the file you are going to send to the user, it can be 
  189.           anywhere in the parameters line so that different transfer programs
  190.           can be used.
  191.  
  192. Command : DLJ <Full path, file name and parameters>
  193. Example : dlj jekyll.ttp -t1m0k1or1oh3op1oq1z2048 -ph:\qbbs\upload\ *file
  194. Purpose : Specifies the external transfer program to use for Jekyll transfer 
  195.           and the parameters to be passed to it. *file will be replaced with 
  196.           the name of the file you are going to send to the user.
  197.  
  198. Command : LOCKOUT <Text string>
  199. Example : lockout Sorry, its my turn to say something..
  200. Purpose : Sends the text string to the user when you press ALT/M to lock 
  201.           their keyboard.
  202.  
  203. Command : F1,F2, upto F10 <Text String>
  204. Example : F2 Welcome to my humble BBS
  205. Purpose : Allows you to assign a text string to the 10 function keys which 
  206.           will be sent to the users screen as if you had typed it..
  207.  
  208. Command : F11,F12, upto F20 <Full path and filename + any parameters>
  209. Example : F12 h:\turbo\batch\fcshell.prg /icp pcommand.prg
  210. Purpose : Allows you to run any external progam at the touch of a function 
  211.           key. F11 to F20 must be a function key pressed with shift, for 
  212.           example to run program F15 you must press SHIFT + F5.. You can pass 
  213.           parameters by adding them to the end of the filename. (See example, 
  214.           the / is part of the fcshell parameter language, not a part of 
  215.           SplitZ.). Usually the users screen is not cleared when you run an 
  216.           external program, instead they get the relevant message displayed to 
  217.           them. In the case of 'I/O re-direction' programs such as FCSHELL it 
  218.           may be useful to clear the screen so that the user, or yourself if 
  219.           operating remotely, will not have a messed up display. To make the 
  220.           users screen clear you simply place an asterisk (*) after the equals 
  221.           character, for example 'f11 h:\dos.prg' will NOT clear the users 
  222.           screen but using 'f11 *h:\dos.prg' will. There must be no spaces 
  223.           between the asterisk and other characters.
  224.  
  225. Command : EXTPRGTEXT <Text string>
  226. Example : extprgtext Hang on a second, just running external program..
  227. Purpose : Lets the user know what you are doing rather than letting them 
  228.           think the BBS has crashed!!
  229.  
  230. Command : ASKCHAT
  231. Example : askchat
  232. Purpose : If used SplitZ will ask the user to type a reason for requesting 
  233.           the chat.
  234.  
  235. Command : AUTOCLEAR
  236. Example : autoclear
  237. Purpose : Puts the 'autoclear' option in split screen mode ON as default.
  238.  
  239. Command : USELOG
  240. Example : uselog
  241. Purpose : SplitZ will log certain activities such as the reason for chat, 
  242.           file viewed or downloaded plus other small bits of information in a 
  243.           file called SPLITZ.LOG which will be kept in the same folder as the 
  244.           main SplitZ program.
  245.  
  246. Command : USERESCAPE
  247. Example : userescape
  248. Purpose : If used the user online will also be able to quit the chat by 
  249.           pressing their escape key.
  250.  
  251. Command : WELCOME <Text string>
  252. Example : welcome Hi there me old mate..
  253. Purpose : The text string is displayed the user as soon as the chat starts. 
  254.  
  255. Command : COMPRESSED
  256. Example : compressed
  257. Purpose : Forces SPLIT screen chatting to operate in 9 line mode instead of 
  258.           the usual 10 lines. Pressing ALT/C will still allow you to switch 
  259.           between compressed and decompressed modes.
  260.  
  261. Command : DEFAULTTUNE <path and filename to *.MUS file>
  262. Example : defaulttune h:\qbbs\tunes\beguine.mus
  263. Purpose : Defines the tune to be played if no TUNE command matches the 
  264.           online user. This will override the internal default tune.
  265.  
  266. Command : TUNE <name> <path and filename to *.MUS file>
  267. Example : tune Mark Matts h:\qbbs\tunes\monty_p.mus
  268. Purpose : Allows you to define a tune for a named person.
  269.  
  270.                          >>> Available KEY presses <<<
  271.  
  272.                           ***** QUICK REFERANCE *****
  273.  
  274.     [S] - Available to the SysOp only     [B] - Available to SysOp AND user
  275.  
  276.  
  277.         [S]  <HELP>- Display a help screen to the SysOp only.
  278.         [S]  ALT/A - Toggles the AUTOCLEAR function in SPLIT mode.
  279.         [S]  ALT/B - Clears BOTH windows in SPLIT chat mode.
  280.         [S]  ALT/C - Decompress/Compress SPLIT screen chat.
  281.         [S]  ALT/D - Displays a text file to the user.
  282.         [S]  ALT/F - Toggles the 'fun' mode (ASCII chat only).
  283.         [S]  ALT/G - Stops CTL/G ringing your bell!
  284.         [S]  ALT/H - Hangs up the phone and disconnects the user.
  285.         [S]  ALT/I - Allows an INSTANT DOWNLOAD to the user.
  286.         [S]  ALT/J - Executes program specified by CTL command DOS=.
  287.         [S]  ALT/L - Toggles the chat LOG file (BOTH chat modes).
  288.         [S]  ALT/M - Disables the users keyboard.
  289.         [S]  ALT/R - Redraws the screen in both SPLIT & ASCII modes.
  290.         [S]  ALT/S - Switches between SPLIT and ASCII chat mode.
  291.         [S]  ALT/U - Toggles the use of Uppercase characters.
  292.         [S]  ALT/Z - Toggles Scroll or Clear chat window wrapping
  293.         [B]  <TAB> - Clears your own SPLIT chat window.
  294.         [B]  CTL/E - Highlights the typed text (Not in ASCII graphics).
  295.         [B]  CTL/G - Rings each others bell!!!
  296.        *[S]  <ESC> - Quit from SplitZ and return to the BBS.
  297.  
  298.  * A configurable option.
  299.  
  300.                   ***** DETAILED KEYPRESS DESCRIPTIONS *****
  301.  
  302. <HELP>- Displays a help screen to the SysOp only which has ALL the available 
  303.         key presses for both users.
  304.  
  305. ALT/A - Toggles the AUTOCLEAR function either on or off. What AUTOCLEAR does 
  306.         is makes the split windows clear themselves each time the cursor 
  307.         returns to the top line. The user and SysOps windows operate 
  308.         independantly of each other. The bell will ring once for disabled and 
  309.         twice for enabled. The bottom line of text in each window will not be 
  310.         cleared just in case you didn't read it..
  311.  
  312. ALT/B - Allows the SysOp to clear both split chat windows at one time.
  313.  
  314. ALT/C - Switches between 9 and 10 line SPLIT screen chat modes.
  315.  
  316. ALT/D - Allows you to send a text file via the modem so that the user can 
  317.         view it.  The user can control the viewing of the text simply by 
  318.         pressing Y or N to continue viewing or to finish. Viewing of the file 
  319.         is done page by page. When the SysOp presses ALT/D the text string 
  320.         defined by the CTL command GETTEXT= or the default text is sent to 
  321.         the user, the Sysop simply clicks on the file to view using the 
  322.         standard fileselector.
  323.  
  324. ALT/F - Toggles the 'fun' mode which is only available in the ASCII chat 
  325.         mode. This feature is only used if the FUNMODE.BBS file exists and has 
  326.         valid entries. The bell will ring once for disabled or twice for 
  327.         enabled.
  328.  
  329. ALT/G - Stops the user ringing your bell when they press CTL/G. Their bell 
  330.         will still ring but yours will be nice and quiet!
  331.  
  332. ALT/H - If the online user is annoying you or it is time to go to bed you can 
  333.         cut them off and drop the carrier by pressing ALT/H. The user will be 
  334.         sent a random string of garbage which should make them think the phone 
  335.         line had a bad connection and the carrier was lost naturally.
  336.  
  337. ALT/I - By using a mixture of CTL commands you can send a file to the user 
  338.         directly from within SplitZ using either X,Y or Z-Modem protocols. 
  339.         This is especially useful if whilst having a chat the user mentions 
  340.         that he was looking for a specific file which he couldn't find, with 
  341.         this 'INSTANT DOWNLOAD' feature you can sort it out for him and send 
  342.         it to him within seconds. When you press ALT/I you will be shown the 
  343.         fileselector which you use to click on the file to send to the user. 
  344.         Once the file has been choosen the user will be offered a protocol 
  345.         menu, depending on what you have enabled in the CTL file, offering 
  346.         them the choice of downloading it. Once the download has finished you 
  347.         will both go straight back to the chat screens.
  348.  
  349. ALT/J - Executes the program specified by the CTL command DOS=. This is best 
  350.         used with a CLI type program. If you only use this feature to move 
  351.         files whilst a user is online I would recommend installing a good 
  352.         replacement fileselector such as UIS3 and then use a small program 
  353.         that calls the Fileselector when run.
  354.  
  355. ALT/L - Switches the chat LOG feature either on or off. When you switch 
  356.         logging on a folder called CHATLOGS will be created in the folder 
  357.         where SplitZ is (assuming that it doesn't exist).. When a chat log is 
  358.         started a file called CHAT.xxx will be created in the CHATLOGS folder. 
  359.         This file will be unreadable unless you use the file viewer included 
  360.         with this release.. It actually replays the chat session as if you 
  361.         were still on line.. This applies to both chat modes.. When you next 
  362.         open a chat log the next available number CHAT file will be created.. 
  363.         ie, CHAT.000 then CHAT.001 etc etc.. if you delete any then the lowest 
  364.         available number will be replaced with the new file..
  365.  
  366. ALT/M - My turn!! Locks the users keyboard so that they can type nothing. 
  367.         Gives you a chance to say what you want without any interuptions.
  368.  
  369. ALT/R - Clears the screen and then redraws it depending on which chat mode 
  370.         you were in. The users screen will also be cleared and then redrawn.
  371.  
  372. ALT/S - If the online user is operating in either VT52 or ANSI graphics mode 
  373.         you will be able to use either the SPLIT or ASCII chat modes. By 
  374.         pressing ALT/S in either mode you will instantly switch between them.
  375.  
  376. ALT/U - Prevents the use of UPPERCASE characters all the time. If you or the 
  377.         user are in CAPS LOCK and this function is enabled all words will be 
  378.         written in lowercase apart from the first letter, this allows you to 
  379.         keep names and places capitalised. The bell will ring one for disabled 
  380.         and twice for enabled.
  381.  
  382. ALT/Z - Depending on wether you have the Keyword SCROLL in SPLITZ.CTL the
  383.         text will either be cleared from the next line as you type and the
  384.         cursor will jump back to the top line OR the top line will be
  385.         erased and a new blank bottom line inserted , this will toggle
  386.         between the two modes.
  387.  
  388. <TAB> - Both users can press this key to clear their own split windows. Both 
  389.         windows will NOT be cleared, only the window of the person who pressed 
  390.         their <TAB> key.
  391.  
  392. CTL/E - Any text typed after pressing CTL/E will be highlighted. This does 
  393.         not work when the user has selected ASCII graphics mode.
  394.  
  395. CTL/G - Simply rings the bell on both computers.
  396.  
  397. <ESC> - Both SysOp and user can quit the chat program by pressing their escape 
  398.         key.
  399.  
  400. The bottom of the screen in both chat modes displays the SplitZ title text ,
  401.  along with the status of various toggles, ie, telling you whether they are
  402. on or off. In both modes you will also have a constant time display which 
  403. is updated every minute, there is also a counter for how long you have been 
  404. chatting, this should give you an idea of how long the user still has left 
  405. online..
  406.  
  407.                              *** KNOWN BUGS ***
  408.  
  409. After about 2 months of testing on 5 different BBS's we have hopefully 
  410. eradicated most bugs, however, 2 of the testers experianced a problem with 
  411. the middle bar dissappearing when in Split chat mode.. I have been unable to 
  412. recreate or fix this so would deeply appreciate any users telling me if they 
  413. also suffered the same problem. Apart from this all the obvious bugs have been 
  414. fixed although there are likely to be some that will appear once this program 
  415. hits all the different setups available.
  416.  
  417.                                    --*--
  418.  
  419.                             -*-   UPDATES   -*-
  420.  
  421. I found that if a user was in MONO mode then I tended to get MONO split
  422. screen mode at my end as well , I've fixed this bug and the sysops split
  423. screen mode is now totally independant of the Users graphics choice
  424.  
  425.                                     --*--
  426.  
  427. If you experience any problems or have ANY ideas for new features then please
  428. put them forward, after all, I can only make the program better with your
  429. help. It was only due to Mark Butler <and Kevin Osborne> approaching me with
  430. ideas that you now have this version.
  431.  
  432. I can be contacted at the following addresses:-
  433.  
  434. Please feel free to mail me at anytime with any problems you may be having
  435. and also any ideas for new features.
  436.  
  437.         Paul Baker                 Fidonet    2:440/108.0
  438.         The Tavern BBS             Atarinet  51:502/100.0
  439.         300-14400 MNP4-5 V42bis    Nest      90:102/140.0
  440.         24 Hours                   TurboNET 100:1011/0.0
  441.         +44 (0)81 445-6514
  442.  
  443. Happy chatting...
  444.  
  445.