------------------------------------------------------------------ | | | | | | | ChatBox Version 3.2 | | | | Split-Screen Sysop Chat - Caller Page Utility | | | | For | | | | PCBoard Versions 15.0, 15.1, 15.2x | | | | Including | | | | PCBoard /M Multi-Port and PCBoard for OS/2 | | | | | | Horizontal or Vertical Split-Screen Chat | | | | | | Sysop Configurable Page Sounds (Beeping, Telephone Ringing) | | | | | | Sysop may choose Flashing "Silent Page" Mode | | | | | | Multi-Language Compatible | | | | | | Seamless appearance when installed as a PCBoard "PPE" or | | when installed as a PCBoard "shelled to" DOOR command. | | | | Highly Sysop-Configurable | | | | | | ChatBox Version 3.2 | | | | (C) Copyright 1991-1995 Yandell Custom Software | | | | 9438 U.S. Hwy. 19 N. Suite 212 | | Port Richey, FL 34668 | | | | DATA -- (813) 842-8099 | | | | | | September 8, 1995 | | | | | | | ------------------------------------------------------------------ -------------------------------------------------------------------- ChatBox -------------------------------------------------------------------- TABLE OF CONTENTS Page ----------------- ---- INTRODUCTION ------------ 1.0 What is ChatBox - Brief Feature List 3 1.1 What is New in Version 3.2 (Upgrading) 4 INSTALLING ChatBox ------------------ 2.0 Preliminaries and Considerations 4 2.1 Setting Up to Use "O" to Page Sysop - PPE MODE 5 2.2 Setting Up Sysop Initiated Chats - PPE MODE 6-7 2.3 Removing Old ChatBox DOOR Installations - PPE MODE 7 2.4 Setting Up ChatBox to Page Sysop - DOOR MODE 8-9 2.5 Setting Up Sysop Initiated Chats - DOOR MODE 9 2.6 Preparing PCBoard for Another Chat Device - DOOR MODE 9 2.7 Running CBSETUP and Creating CHATBOX.CNF 10-20 2.8 Setting Up Multi-Language Use 21 2.9 Setting Up V.I.P. Callers (CHATBOX.VIP) 21 2.10 Setting Up Callers Who Cannot Page (CHATBOX.NOT) 21 2.11 Setting Up Dates for No Paging (DATE.NO) 21 RUN-TIME CONSIDERATIONS ----------------------- 3.0 Notes Regarding CBTEXT Files 22 3.1 Notes Regarding the F4 Function Key 23 3.2 Notes Regarding Window (box) Clearing 23 3.3 Notes Regarding SOUND.BAT 23 3.4 Notes Regarding "Leave a Comment instead?" Feature 24 3.5 Notes Regarding Text File Displays 24 3.6 Notes Regarding ALT-M File Import 25 3.7 Notes Regarding Automatic-Reason-Comment 25 3.8 Notes Regarding Multiple Sysops in SYSOP.DAT 25 3.9 Notes Regarding Multiple Sysops in CALLER.DAT 26 3.10 Configuring ChatBox RIP Colors from Remote 26 MISCELLANEOUS ------------- 4.0 Sysop Function Keys 27 4.1 Technical Notes 28 4.2 Caller Log Entries 28 4.3 ChatBox CHATLOG (ALT-L) Files 29 4.4 Multi-Nodes, Networks, Multi-taskers 29 4.5 Where to Receive Assistance 29 4.6 Disclaimer and Warranty 30 4.7 License to Use ChatBox 30 4.8 Revision History 30 REGISTRATION ------------ 5.0 Registering ChatBox 31 5.1 Register With CONFIDENCE - Author Information 31 -------------------------------------------------------------------- Page 3 ChatBox Page 3 -------------------------------------------------------------------- 1.0 What is ChatBox - Brief Feature List ----------------------------------------- ChatBox is a Split-Screen chat utility designed for PCBoard. The Sysop may select the Split-Screen format for chatting. In horizontal mode, the screen is split into two halves (boxes), upper and lower. In vertical mode, the screen is split into two halves (boxes), left and right. ChatBox is installed as a "PPE" or "DOOR" and is designed to be used between the Sysop and an on-line caller. The Sysop may initiate the chat. ChatBox will bypass its paging process and go directly into chat mode if initiated by the Sysop. Split-Screen chatting allows simultaneous typing between the Sysop and the caller. ChatBox is DESQview aware. ChatBox works with non-standard com ports automatically. ChatBox works with regular PCBoard software or the /M Multi-port version of PCBoard automatically. Brief Features List: - Choice of horizontal or vertical split-screen partitioning. - Functions as BOTH an F10 chat replacement and (O)perator page. - Restores time left after chat like PCBoard's chat. - The Sysop may view the caller's USERS record during chat. - The Sysop may modify the caller's USERS record during chat. - Full RIP chat mode and screens. - Imports text files to display to the caller during chat. - Displays short "message" files (fast or slow mode) during chat. - Optionally logs the chat conversation to disk file. - Detects non-ANSI callers for non-split screen chat mode. - When starting chat, Sysop may select Sysop name to display. - Asks for Sysop permission if caller tries to quit chat. - Customization & language support of almost all internal text. - Separate customization of split screen colors for ANSI & RIP. - Pop-up help boxes for the caller during chat. - Optionally asks the caller their "reason" for paging. - Three different paging time periods for each day of the week. - A configurable paging sound for each paging period. - Choice of many different built-in paging sounds. - Customizable paging sounds in addition to the built-in ones. - Choice of a silent page via a flashing screen. - Optionally logs the "reason" for paging in a Comment to Sysop. - Logs the "reason" for paging to the PCBoard CALLER log file. - Configurability of the number of seconds a page attempt lasts. - The ability to silence a page attempt without answering it. - A list of important caller names who can page at any hour. - A list of caller names who can never page. - A "secret key" (if Sysop desires) to answer pages. - Configurable list of days (holidays etc.) paging is not allowed. -------------------------------------------------------------------- Page 4 ChatBox Page 4 -------------------------------------------------------------------- 1.1 What is New in Version 3.2 (Upgrading) ------------------------------------------- Read the enclosed FEATURES.NEW file for a list of new features in ChatBox version 3.2. REGISTERED USERS of ChatBox 2.7 and earlier: ChatBox 3.2 requires a new registration number. If you registered ChatBox 2.7 more than 6 months prior to the release of ChatBox 3.0 (8/5/94), an upgrade fee is required. See UPGRADE.DOC for instructions and more information. 2.0 Preliminaries and Considerations ------------------------------------- Create a directory or subdirectory where you normally place new PPE or DOOR programs. Extract the entire contents of CBOX32.ZIP into this location. IMPORTANT CONSIDERATION - PLEASE READ ------------------------------------- ChatBox may be installed by "PPE method", allowing callers to page you using the O command. You may initiate ChatBox chats by pressing the F10 key, or SHIFT and F10 simultaneously. If installing ChatBox with PPE functions, follow the directions in sections 2.1, 2.2 & 2.3 (the sections with "PPE MODE" in the title). If using the PPE method, you will most likely need to set PCBoard to "Swap on Shells". Most systems are already swapping for PCBVIEW.BAT, PCBTEST.BAT, etc. Run PCBSetup. Select "G" Configuration Options. Select "D" Configuration Switches. Locate "Swap Out During Shell". Answer with a "Y". Repeat these steps for all nodes. You may also use ChatBox as a DOOR. Installing ChatBox using the PPE method is recommended, however. If installing ChatBox as a DOOR, follow the directions in sections 2.4, 2.5 & 2.6 (the sections with "DOOR MODE" in the title). SPECIAL NOTE REGARDING RIP AND PPE USE: A strange anomaly has been noticed that exists between PCBoard's Sysop function keys and RIP. When a caller is on-line and F10 (or any Sysop function such as F5) is used, before PCBoard does anything else it saves EXACTLY what is on the LOCAL BBS screen. When the Sysop process ends, PCBoard will re-display what it saved when F10 (or other Sysop function) was pressed. If that happens to be the last 21 or so lines of a long RIP file, then that is ALL that is sent to the caller. This means that if anything cleared the caller's screen during the Sysop function (such as ChatBox), only the last part of the caller's RIP screen is re-drawn. If this happens on your system in RIP mode, the only work- around at this time is to use the SYSCHAT.PPE as a SHIFT-F# (F10) command instead of F10 to start a chat (see section 2.2 on page 7). SYSCHAT /SHIFT is designed so that the caller's RIP terminal, not PCBoard, will save and redraw the caller's RIP screen before and after a Sysop initiated chat. This anomaly does not occur with the "O" and other user commands, because PCBoard completely re-sends the menu (from beginning to end) after all "user" commands. -------------------------------------------------------------------- Page 5 ChatBox Page 5 -------------------------------------------------------------------- 2.1 Setting Up to Use "O" to Page Sysop - PPE MODE --------------------------------------------------- The following step-by-step instructions will replace PCBoard's built-in (O)perator page function with ChatBox. This requires PCBoard version 15.1 or later, and the OPAGE.PPE file (enclosed). (1) Run PCBSetup. (2) Select "B File Locations". (3) Select "B Configuration Files". (4) Place the highlight bar on "Name/Loc of Default CMD.LST File". (5) If you have not configured this parameter yet, you will need to refer to the PCBoard documentation and configure this PATH and FILENAME now. (6) Press F2 to edit the CMD.LST file. (7) The following setup screen will appear: Charges Per PPE/MNU File Specification -or- Command Sec Minute Use KeyStroke Substitution --------- --- ------------ ------------------------------- #) O 10 0 0 C:\CHATBOX\OPAGE.PPE * Command : Place the letter O here as shown above. * Security : Enter security needed to use the the O command. * PPE/MNU File: Enter the FULL LOCATION of YOUR ChatBox directory followed by the OPAGE.PPE file as shown above. Note: You may use another command other than "O" here, but this is not recommended. (8) Press ESC and answer Y to save the new CMD.LST file. (9) Exit PCBSetup. (10) Make sure that OPAGE.PPE is located in the same directory with all other ChatBox files. (11) Restore the (O)perator command in your PCBoard main menu if you had previously removed it for earlier DOOR versions of ChatBox. Also see section 2.3 on page 7. The OPAGE.PPE is the PCBoard file which loads ChatBox. The OPAGE.PPE will only load a configuration file names CHATBOX.CNF, so be careful that this is the file you edit with your configuration choices while using CBSETUP.EXE. If you have different CMD.LST files for any conferences, you will need to configure the "O" command in them also. -------------------------------------------------------------------- Page 6 ChatBox Page 6 -------------------------------------------------------------------- 2.2 Setting Up Sysop Initiated Chats - PPE MODE ------------------------------------------------ The following step-by-step instructions will install ChatBox so that the Sysop may initiate a chat with the caller using ChatBox. Decide on whether you want to start ChatBox with a single key press of the F10 key (the PCBoard key for starting a chat), or by pressing the SHIFT and F10 keys. Using the single F10 key allows for easily initiating a ChatBox chat, using the SHIFT and F10 keys leaves the PCBoard F10 chat mechanism enabled, if desired. INSTALLING ChatBox with the PCBoard F10 (unshifted) key ------------------------------------------------------- You may initiate a Sysop chat by pressing the F10 key. These step- by-step instructions must be followed for a successful installation. __ Run MKPCBTXT.EXE. __ Enter PCBTEXT preceded by its location. If you are told the file was not found, you are not entering the correct information. __ Select F3 (jump to record). -- Enter 333. This is the PCBoard chat "greeting" text. __ Edit PCBTEXT record #333 as follows: !C:\CHATBOX\SYSCHAT.PPE /F10 ---------------------------- Start the entry with an exclamation mark, followed by the FULL LOCATION of YOUR ChatBox directory, followed by the SYSCHAT.PPE filename, followed by /F10 as shown. >> You MUST place the /F10 parameter as shown above when installing the SYSCHAT.PPE in MKPCBTXT record #333. __ Press ESC to save the changes and exit the PCBTEXT program. __ Repeat the above steps for all language versions of PCBTEXT that you carry. F10 NOTE: In PCBoard 15.x, the Sysop F10 chat key does not work when the Sysop is logged-on locally. You must log-in to your system from remote (by modem) to test the PCBoard F10 key, regardless of whether or not ChatBox is used. Section 2.2 continues on the next page -------------------------------------------------------------------- Page 7 ChatBox Page 7 -------------------------------------------------------------------- 2.2 Setting Up Sysop Initiated Chats - PPE MODE (continued) ------------------------------------------------------------ INSTALLING ChatBox with the PCBoard SHIFT-F10 command ----------------------------------------------------- You may define up to 10 SHIFT-FUNCTION keys in PCBoard to perform various tasks. The Sysop simply presses the SHIFT and F10 keys at the same time. (1) Run PCBSetup. (2) Select "G Configuration Options". (3) Select "H Function Keys". (4) Move the highlight bar to "F-Key #10". (5) Edit the parameter as follows: F-Key #10 : !C:\CHATBOX\SYSCHAT.PPE /SHIFT ------------------------------ Start the entry with an exclamation mark as shown, followed by the FULL LOCATION of YOUR ChatBox directory, followed by the SYSCHAT.PPE file as shown, followed by the /SHIFT parameter. It is ABSOLUTELY MANDATORY for this entry to begin with an exclamation point (!) as shown. An exclamation point in the first position is how PCBoard knows to run a PPE function when you press the SHIFT and F10 keys at the same time. >> You MUST place the /SHIFT parameter as shown when installing the SYSCHAT.PPE as a PCBSetup F-Key. You may define up to 10 SHIFT-FUNCTION keys in PCBoard to perform various tasks. It is recommended to use SHIFT-F10 to initiate the Sysop chat, as this most closely resembles PCBoard's F10 to start a Sysop chat. (6) Exit AND save PCBOARD.DAT. Perform these steps on all nodes. If installed properly, whenever you press a SHIFT and F10 key at the same time, ChatBox will load and immediately be in chat mode (no paging). This may be done at anytime while the caller is on-line in PCBoard (unless they are out in a door of course). 2.3 Removing Old ChatBox DOOR Installations - PPE MODE ------------------------------------------------------ If *BOTH* the OPAGE.PPE and SYSCHAT.PPE are being used as described in sections 2.1 and 2.2 above, there is no longer a need to have ChatBox configured as a door as in pre-PPE versions. Once you are comfortable with how the new "PPE" functions are running, the door functions previously needed to make ChatBox run should be removed. - Remove PAGE (or whatever you called it) from your DOOR.LST files. - Remove the PAGE command from all main menus, door menus, etc. - Restore the (O)perator command in your PCBoard main menu. - Remove SET_F10.EXE (if used) from your BOARD.BAT files. -------------------------------------------------------------------- Page 8 ChatBox Page 8 -------------------------------------------------------------------- 2.4 Setting Up ChatBox to Page Sysop - DOOR MODE ------------------------------------------------- You may install ChatBox as a door, however the PPE method is a much better choice. Install a door called PAGE into your DOORS.LST file using PCBSETUP. Answer the following questions as follows: USER DOOR Filename Password Sec Login SYS SYS Shell Path to DOOR Files -------- -------- --- ----- --- --- ----- ------------------ #) PAGE 10 N Y N S (if appropriate) Note the use of PAGE as a door name, not CHATBOX, as you will most likely want to place PAGE as a command in your main menu (BRDM). A password would usually not be required for your PAGE door. A low security level is required, as you may also be using this same door when you wish to initiate a chat with the caller. ChatBox follows the security level for the "O" command in PCBoard when ChatBox is installed as a door. Callers who are below this level will not be able to use ChatBox to page the Sysop. A USERS.SYS file MUST be created. ChatBox will not run without it, as ChatBox NEVER accesses the USERS file. A DOOR.SYS file is NOT needed. You should answer "S" to the SHELL question. This will cause PCBoard to SHELL to the ChatBox DOOR (keeping a seamless appearance) and SWAP PCBoard out of memory to insure there is enough memory for ChatBox to run. If you have different DOORS.LST files in your conferences, you will need to configure the PAGE door in them also. It is up to the individual Sysop as to whether or not to place the PAGE command in the doors menu, or as a command on the main menu, or both. The recommended usage is to place PAGE on the main menu and not in the doors menu. Section 2.4 continues on the next page -------------------------------------------------------------------- Page 9 ChatBox Page 9 -------------------------------------------------------------------- 2.4 Setting Up ChatBox to Page Sysop - DOOR MODE (continued) -------------------------------------------------------------- The purpose of this section is to explain the command line calling syntax for ChatBox. Please refer to the PCBoard manual for a more complete discussion on door batch file installation. If you have named the door PAGE (recommended) the following example would be the contents of your door file PAGE (NOTE: do NOT place any extension such as .BAT on the PAGE file). Sample PAGE file ---------------- @echo off C:\CHATBOX\CHATBOX.EXE CHATBOX.CNF %PCBDRIVE%%PCBDIR% ---------------------- ----------- ------------------ | | |->This node's home directory | | using environment variables. | | | ---------> The name of the configuration | file. Enter a file NAME only. | NEVER place a location here. | -------> The executable file LOCATION AND NAME. The two lines above are all that is required to execute ChatBox when running as a swapped-shell-to door. If you are not running ChatBox as a swapped-shelled-to door, add the call to BOARD.BAT as the third command in the door file. Do NOT end your door file with BOARD.BAT if running ChatBox as a swapped-shell-to door. 2.5 Setting Up Sysop Initiated Chats - DOOR MODE ------------------------------------------------- Previous versions of ChatBox supported a crude method of initiating a Sysop chat in DOOR mode. This method will still work with this version of ChatBox (for those who are already using it). In view of the superior PPE method for initiating a Sysop chat, initiating a Sysop chat in DOOR mode is no longer recommended or documented. 2.6 Preparing PCBoard for Another Chat Device - DOOR MODE ---------------------------------------------------------- It is not necessary to disable PCBoard's "O" command in order for ChatBox to function as a DOOR. However, if you wish to use ChatBox exclusively (in DOOR mode) then follow these simple steps. (1) Set record #128 in all PCBTEXT files to: "Please use the PAGE command for paging" (2) Use PCBSETUP to set the page times in PCBOARD.DAT to one minute apart, for example 12:00 - 12:01. Setting this one minute period so that it occurs during the system event is ideal. When a caller presses "O" in PCBoard, they will receive the "Please use the PAGE command" instruction contained in record #128 of the appropriate PCBTEXT file. This applies to DOOR MODE use only! The method prescribed above allows PCBoard and ChatBox to continue using the F4 setting for its intended use. -------------------------------------------------------------------- Page 10 ChatBox Page 10 -------------------------------------------------------------------- 2.7 Running CBSETUP and Creating CHATBOX.CNF --------------------------------------------- Enclosed with ChatBox 3.2 is a file called CBSETUP.EXE. This file allows you to easily and quickly configure ChatBox configuration files. Only one CHATBOX.CNF file is required for all nodes. To start CBSETUP.EXE, enter CBSETUP at your DOS prompt. CBSETUP will ask which configuration file to use. CHATBOX.CNF will be the most appropriate configuration file. Each parameter in CBSETUP is described on the following pages. * Default chat screen type -------------------------- You may select the initial type of Split-Screen chat mode to begin the on-line chat session in. The valid selections are: (1) Horizontal Split-Screen. The Sysop will be in the top half of the screen, the caller will be in the bottom half. (2) Vertical Split-Screen. The Sysop will be in the left hand side of the screen, the caller will be in the right hand side. (3) Regular non-split screen. Self explanatory. If it is determined that the caller's communications program is not ANSI capable, ChatBox will start the chat in the regular, non-split screen mode. If this occurs, the Sysop will receive a message on the local screen stating this. The Sysop should not try to force a Split-Screen chat session when this occurs, as it will probably only result in the caller's screen being filled with unreadable ANSI escape sequences. * Speed to wrap instead of scroll --------------------------------- If the caller is at or below this connect rate, ChatBox will wrap to the top of each window (box) when the box is filled with text. If the caller is above this speed, ChatBox will scroll the contents of the box up one line when the box is filled. Since scrolling separate parts of the screen may yield unfavorable results to callers with connect speeds of 300 and 1200, a setting of at least 1200 is recommended. Valid entries here are 300, 1200, 2400, & 9600. ChatBox will always wrap text to the top of a window when a caller is at 300 baud. A special setting of 0 (zero) is permitted which forces ChatBox to wrap instead of scroll at ALL speeds, even those higher than 9600 (not generally recommended). Section 2.7 continues on the next page -------------------------------------------------------------------- Page 11 ChatBox Page 11 -------------------------------------------------------------------- 2.7 Running CBSETUP and Creating CHATBOX.CNF (continued) --------------------------------------------------------- * Name to Display for Sysop --------------------------- The Sysop's first name is usually used in this parameter. This is used in the status line for the Sysop's half of the screen. This is also used in the @OPTEXT@ variable in CBTEXT record #3 of "Hello, this is _______" when the Sysop answers a page request or initiates a chat. DO NOT enter @OPTEXT@ in this parameter. If the multiple Sysop-name "pick-list" (SYSOP.DAT) is enabled then this setting is not used. Length of Paging Time (seconds) ------------------------------- The length of time that ChatBox will beep, ring, flash, etc., during a caller page may be configured by the Sysop. Valid entries are from 15 to 90 seconds. The default is 30 seconds, which is also the same for PCBoard's built-in page. ChatBox reads record #5 from CBTEXT (or (the appropriate language file) and displays it while paging: Page ends in @OPTEXT@ seconds. (Ctrl-K) Aborts . ChatBox will automatically change @OPTEXT@ to the amount entered in this parameter. * Ask 'Reason' For Paging ------------------------- Answer Y (yes) to make ChatBox ask the reason for paging, but only if a page attempt will actually occur (the paging hours, F4 setting, and other conditions are correct for paging). Answer A (always) to make ChatBox ALWAYS ask the reason for paging, even if ChatBox knows it will not actually be paging the Sysop due to hours, F4, etc. This is helpful by seeing why someone paged you during the off-hours since the reason will be written to the CALLER log even though no page attempt will have occurred. Answer N (no) to make ChatBox never ask the reason for paging. Section 2.7 continues on the next page -------------------------------------------------------------------- Page 12 ChatBox Page 12 -------------------------------------------------------------------- 2.7 Running CBSETUP and Creating CHATBOX.CNF (continued) --------------------------------------------------------- * Post a Comment with Chat Reason --------------------------------- If the caller enters a reason for paging, and the page is then not answered, ChatBox may be set to leave a comment to the Sysop which will contain the reason. The parameter previous to this one, Ask 'Reason' For Paging, must of course be set to Yes. ChatBox must be installed as the operator page command with OPAGE.PPE in order to use this feature. If a page is not answered, ChatBox will leave a comment to SYSOP, from CHATBOX (so the caller cannot change it), in the MAIN board (conference 0). The comment will contain the caller's name and the page reason. If the caller indicates they want to leave a Comment themselves (if enabled), ChatBox will automatically not post the comment with the reason, since presumably the caller is going to. * Always Start with Log (ALT-L) On ---------------------------------- ChatBox contains a toggle that allows the Sysop to log chat sessions to log files in the default ChatBox directory. This toggle is the ALT-L key combination. The (L) which appears on the ChatBox status line indicates logging is active. If the Sysop desires, ChatBox may start with the logging mode on as each chat session begins instead of manually turning it on with the ALT-L keypress. Refer to section 4.3 on page 29 for information. * Sound to Use for VIP Paging ----------------------------- You may select the type of sound ChatBox will make when a caller listed in CHATBOX.VIP pages, regardless of when the page occurs. (1) The familiar "beep beep". (2) The familiar "beep beep, with a lower tone than #1. (3) European telephone ring. Two short rings. (4) Telephone ring. Low pitch. (5) Telephone ring. Medium pitch. (6) Telephone ring. High pitch. (7) Silent - Flashing box on the Sysop's screen. (8) Shell - Use another program or device for sounds or screens. (9) Use LPT1 (parallel printer) bell. (10) Use LPT2 (parallel printer) bell. (11) Use LPT3 (parallel printer) bell. (12) Generic "beep beep" using console for use with older PCs. (13-17) Customized beep sound - configure from CBSetup main menu. Press F2 at this parameter to listen to the sound you have selected. If selecting #8 (shell) see page 23 section 3.3 for instructions. If selecting #13-17 see page 20 section 2.7 for instructions. Section 2.7 continues on the next page -------------------------------------------------------------------- Page 13 ChatBox Page 13 -------------------------------------------------------------------- 2.7 Running CBSETUP and Creating CHATBOX.CNF (continued) --------------------------------------------------------- * Always Use VIP Tone for VIP Caller ------------------------------------ By default, when a VIP caller pages outside of regular paging hours the special VIP sound is used. If they page during regular paging hours, the sound defined for that time period is used as if they are any other caller paging the Sysop. If you want ChatBox to always use the VIP sound when a VIP Caller pages, even if the page is during regular paging hours, answer this parameter with a Y for YES to always use VIP sound. A VIP caller is a caller listed in the CHATBOX.VIP file. * Secret Key Needed to Answer Page ---------------------------------- A secret key may be used to replace to answer a page. When a secret key has been assigned, the top of the Sysop's screen will say "Press *KEY* to answer..." instead of "Press SPACE to answer". For extra enforcement a "high-ASCII" character (127-254) may be used by using "ALT" key combinations. For instance, if you wanted the the secret key to be ASCII character 186, press down the ALT key and keep it pressed while entering 1, 8, then 6 on the number pad (186). In order to then answer a page, the same keystrokes will have to be entered while the caller is paging. This feature is only intended to dissuade someone from touching the computer (because it is making page sounds) who otherwise would not. * Display Full Caller Name In 'Box' ----------------------------------- The caller's first name is displayed in the "box" border in each of ChatBox's two split-screen formats. In certain unusual circumstances it may be desirable for the entire name of the caller to be used. An example would be where boards allow handles as the log-in name (as opposed to the alias feature provide by PCBoard). When these handles are more than two words, like "The Thing" the caller's first name will naturally be considered to be "The" by PCBoard and that is what ChatBox will display in the chat "box" as the name of the caller. If this parameter is answered yes, the FULL name is used in the window border instead of the first name only. Enabling this feature (answering Yes) is rarely needed and should normally be answered No. Section 2.7 continues on the next page -------------------------------------------------------------------- Page 14 ChatBox Page 14 -------------------------------------------------------------------- 2.7 Running CBSETUP and Creating CHATBOX.CNF (continued) --------------------------------------------------------- Disable `Leave a Comment' Prompt -------------------------------- If the Sysop is unavailable (F4 key or Hours) or does not answer a page, the caller will be asked if they would like to leave a comment (just like PCBoard would). If the caller responds Yes, ChatBox will take the proper actions so that a C are entered at the main PCBoard prompt when PCBoard re-loads. Entering a Y for yes in this parameter will disable this function and return the caller to PCBoard whenever a page is unsuccessful. NOTE: After entering "C " at PCBoard's main prompt, PCBoard will confirm the Comment request by displaying the prompt in PCBTEXT record #1. This PCBoard confirmation prompt cannot be disabled. This may give the impression the caller is being asked twice if they want to leave a comment but that is not the case. Some Sysops have added an instruction file or PPE to PCBTEXT record #1 which makes it impractical to try to stuff a "Y" in that prompt after the "C". Disable Use of PCBoard F4 Toggle -------------------------------- ChatBox follows the F4 "paging allowed" toggle in PCBoard. If F4 is OFF, paging will not be permitted, if F4 is ON, paging is permitted if (A) the person has security to page, and (B) if the page attempt is within a time period allowed. This means that ChatBox uses the F4 toggle EXACTLY as PCBoard's "O" command does. By using the F4 toggle, the Sysop can easily turn the page function (ChatBox or PCBoard) off on a temporary basis without having to re-configure any setup parameters. Although not recommended, you may have ChatBox ignore PCBoard's F4 toggle by answering this parameter Yes. * Disable CALLER Log Updating ----------------------------- Chatbox writes entries to the current node's CALLER log file, such as the reason for a page attempt, the results of a page attempt, and others (see section 4.2 on page 28). If you do not want ChatBox to write its entries to PCBoard's CALLER log files, answer Y (yes) to disable this feature. Disabling CALLER log updates by ChatBox is NOT recommended. Section 2.7 continues on the next page -------------------------------------------------------------------- Page 15 ChatBox Page 15 -------------------------------------------------------------------- 2.7 Running CBSETUP and Creating CHATBOX.CNF (continued) --------------------------------------------------------- * Disable (F3 Printer Logging ----------------------------- ChatBox will follow the printer toggle (F3) as set in PCBoard and will print CALLER log entries to the printer just like PCBoard does if PCBoard's printer toggle is turned on. If you do not want ChatBox to follow the PCBoard F3 printer toggle, answer Y (yes) to disable. If printer logging (F3) is not turned on in PCBoard, this setting is not used by ChatBox. * Disable (F7) Local Alarm Bell ------------------------------- ChatBox will follow the local alarm toggle (F7) as set in PCBoard and will beep locally at caller input errors just like PCBoard does if the PCBoard local alarm is turned on. If you do not want ChatBox to follow the PCBoard F7 alarm toggle, answer Y (yes) to disable this feature. If the local alarm (F7) is not turned on in PCBoard, this setting is not used by ChatBox. NOTE: This setting does NOT turn off the sound when a caller pages. * Disable USERNET.XXX Updating ------------------------------ ChatBox updates the PCBoard USERNET.XXX file to indicate to callers on other nodes (when performing a PCBoard 'WHO' or 'CHAT' request) that the caller using ChatBox is either Paging or Chatting with the Sysop. ChatBox does this when: (A) it is used as a DOOR, (B) when it is used with OPAGE.PPE (the "O" replacement) and (C) when installed as SYSCHAT.PPE /SHIFT to initiate Sysop chats. Answer (Y) yes to disable USERNET.XXX updating. NOTE: When ChatBox is installed as SYSCHAT.PPE /F10 to initiate a Sysop chat, this parameter has NO effect since PCBoard is updating USERNET.XXX when F10 is pressed, not ChatBox. Section 2.7 continues on the next page -------------------------------------------------------------------- Page 16 ChatBox Page 16 -------------------------------------------------------------------- 2.7 Running CBSETUP and Creating CHATBOX.CNF (continued) --------------------------------------------------------- * ChatBox ANSI & RIP colors/screen (CBSETUP.EXE Main menu option #2) -------------------------------------------------------------------- * Color to use for ANSI Chat Text --------------------------------- Chat text (text the Sysop and caller type while chatting) colors may be configured. This color is used when the caller is in color mode. Pressing F2 at this parameter in CBSETUP will display a color chart and sample Split-Screen chat display using the colors you've chosen. Chat text colors are always high intensity (bright). ChatBox must be registered for this setting to be recognized. In an unregistered copy, this will default to "2" when ChatBox is run. * Color to use for ANSI Box Lines --------------------------------- Box line (lines creating the chat "box" while chatting) colors may be configured. This color is used when the caller is in color mode. Pressing F2 at this parameter in CBSETUP will display a color chart and sample Split-Screen chat display using the colors you've chosen. Box line colors are always high intensity (bright). ChatBox must be registered for this setting to be recognized. In an unregistered copy, this will default to "6" when ChatBox is run. * Color for ANSI Sysop and Caller Name -------------------------------------- The Sysop and caller names are placed in the "box" lines separating each "box". This color is used when the caller is in color mode. Pressing F2 at this parameter in CBSETUP will display a color chart and sample Split-Screen chat display using the colors you've chosen. Name colors are always high intensity (bright). ChatBox must be registered for this setting to be recognized. In an unregistered copy, this will default to "6" when ChatBox is run. Section 2.7 continues on the next page -------------------------------------------------------------------- Page 17 ChatBox Page 17 -------------------------------------------------------------------- 2.7 Running CBSETUP and Creating CHATBOX.CNF (continued) --------------------------------------------------------- * Color for ANSI Position Arrow --------------------------------- A "position arrow" is located on the left of each chat "box" to show the current line. This color is used when the caller is in color. Pressing F2 at this parameter in CBSETUP will display a color chart and sample Split-Screen chat display using the colors you've chosen. Position arrows are always high intensity (bright). ChatBox must be registered for this setting to be recognized. In an unregistered copy, this will default to "6" when ChatBox is run. * Character for ANSI Position Arrow ----------------------------------- A "position arrow" is located on the left of each chat "box" to show the current line. This character may be set by the Sysop. Any ASCII character between 32 and 255 may be used for the position arrow character. A [space] (ASCII 32) may not be used, nor may ASCII characters below 32 (control characters which some communications programs do not display properly). * Color to use for RIP Chat Text -------------------------------- Chat text (text the Sysop and caller type while chatting) colors may be configured. This color is used when the caller is in RIP mode. RIP chat text colors are always high intensity (bright). It is best to set RIP colors while the Sysop is on-line in RIP mode. See section 3.10 on page 26 for additional information. * Color to use for RIP Sidebar Box ---------------------------------- The color for the graphical RIP bar (around the buttons) on the left of the screen may be configured. This color is also used for the thin "inner" lines inside the boxes surrounding the chat windows. It is best to set RIP colors while the Sysop is on-line in RIP mode. See section 3.10 on page 26 for additional information. Section 2.7 continues on the next page -------------------------------------------------------------------- Page 18 ChatBox Page 18 -------------------------------------------------------------------- 2.7 Running CBSETUP and Creating CHATBOX.CNF (continued) --------------------------------------------------------- * RIP Fill Style for Sidebar Box -------------------------------- The fill pattern for the graphical RIP bar (around the buttons) on the left of the screen may be configured. Valid RIP sidebar fill patterns are: (1) Solid (2) Line (horizontal) (3) Light slash (4) Slash (5) Reverse slash (6) Light reverse slash (7) Crosshatch (8) Heavy crosshatch (9) Interleaving line It is best to set the RIP fill pattern while the Sysop is on-line in RIP mode. See section 3.10 on page 26 for additional information. * Color for RIP Names and Labels -------------------------------- The Sysop and caller names are placed in the "box" lines separating each "box". The "Labels" are the text on RIP buttons which describe their function. This color is used when the caller is in RIP mode. It is best to set RIP colors while the Sysop is on-line in RIP mode. See section 3.10 on page 26 for additional information. * Color for RIP Position Arrow ------------------------------ A "position arrow" is located on the left of each chat "box" to show the current line. This color is used when the caller is in RIP mode. RIP arrow colors are always high intensity (bright). It is best to set RIP colors while the Sysop is on-line in RIP mode. See section 3.10 on page 26 for additional information. * Character for RIP Position Arrow ---------------------------------- A "position arrow" is located on the left of each chat "box" to show the current line. This character may be set by the Sysop. Any ASCII character between 32 and 255 may be used for the position arrow character. A [space] (ASCII 32) may not be used, nor may ASCII characters below 32 (control characters which some communications programs do not display properly). Section 2.7 continues on the next page -------------------------------------------------------------------- Page 19 ChatBox Page 19 -------------------------------------------------------------------- 2.7 Running CBSETUP and Creating CHATBOX.CNF (continued) --------------------------------------------------------- * Page Start and Stop Times (CBSETUP.EXE Main menu option #3) -------------------------------------------------------------- You may enter 3 page starting and stopping times for each day of the week. Times must be entered in HH:MM format, where HH is a value of 0 through 23, and MM is a value of 0 through 59. CBSETUP.EXE performs minimal testing of the hours input into these parameters. Care should be taken to insure the times which are input are valid and in the HH:MM format. To disable paging on a particular day, simply set the page times for PERIOD 1 on that day a minute apart, such as 12:00 - 12:01, and set the start and stop times for PERIOD 2 & 3 to the same time. If there is concern about a caller being able to activate a page during this one minute time period during the day (which is highly unlikely), set this one minute period so it will occur during your daily event. For 24 hour paging, set PERIOD 1 to the same start and stop times. PERIODS 2 & 3 are ignored if their start and stop times are set to the same time. The TAB key rotates through different PERIODS in the same day. * Page Period Tones ------------------- You may select the type of sound ChatBox will make when a caller uses CHATBOX to page during the corresponding time period. (1) The familiar "beep beep". (2) The familiar "beep beep, with a lower pitch tone than #1. (3) European telephone ring. Two short rings. (4) Telephone ring. Low pitch tone. (5) Telephone ring. Medium pitch tone. (6) Telephone ring. High pitch tone. (7) Silent - Flashing box on screen. (8) Shell - Use another program/device for sounds or screens. (9) Use LPT1 Bell * (10) Use LPT2 Bell * (11) Use LPT3 Bell (12) Generic console beep for older, less than 100% compatibles. (13-17) Customized beep sound - configure from CBSetup main menu. Press F2 at this parameter to listen to the sound you have selected. Section 2.7 continues on the next page -------------------------------------------------------------------- Page 20 ChatBox Page 20 -------------------------------------------------------------------- 2.7 Running CBSETUP and Creating CHATBOX.CNF (continued) --------------------------------------------------------- * Custom Tone (Frequency) (CBSETUP.EXE Main menu option #4) ------------------------------------------------------------ These custom tones are used when #13, 14, 15, 16 or 17 are selected as the page sound in any of the ChatBox page sound parameters. This setting indicates the frequency (Hz) that will be sounded. The tone must be in the range of 37 to 18000 (although tones above 12000 are usually beyond the range of human hearing). The tone will sound for the duration (in 1/18th of a second) specified in the DURATION column to the right of this TONE parameter. When ChatBox "plays" sounds 13, 14, 15, 16 or 17, it starts with the tone and duration specified in the top row, then the next row, down to the last row. To simulate a PAUSE, enter 0 for the TONE, then enter the length of the pause (in 1/18th second increments) in DURATION. If the TONE and DURATION in a "row" are both 0, the row is ignored. * Custom Tone Duration (CBSETUP.EXE Main menu option #4) --------------------------------------------------------- This setting indicates the duration that the corresponding tone will will sound for. The DURATION is in increments of 1/18th seconds. If a 1 is entered, the tone will sound for 1/18th of a second, 2 would be a 2/18th second duration, etc. The total of the DURATION column cannot exceed 36 (two seconds). When ChatBox plays sound 13, 14, 15, 16 or 17, it starts with the tone and duration specified in the top row, then the next row, down to the last row. To simulate a PAUSE, enter 0 for the TONE, then enter the length of the pause (in 1/18th second increments) in DURATION. If the TONE and DURATION in a "row" are both 0, the row is ignored. Tone Duration Tone Duration 1000 2 Here are a couple 264 9 0 1 of sample sounds. 0 3 1000 2 296 4 0 1 << On the left is the 0 1 1000 2 << Morse Code for SOS. 316 3 0 1 0 5 1000 5 On the right are the >> 264 6 0 1 first few notes from >> 0 0 1000 5 the "Dragnet" theme. >> 0 0 0 1 0 0 1000 5 0 0 0 1 0 0 1000 2 0 0 0 1 0 0 1000 2 0 0 0 1 0 0 1000 2 0 0 0 0 0 0 -------------------------------------------------------------------- Page 21 ChatBox Page 21 -------------------------------------------------------------------- 2.8 Setting Up Multi-Language Use ---------------------------------- ChatBox uses text from CBTEXT or an appropriate language version of it. To create a language version of CBTEXT, simply use the DOS copy command and copy CBTEXT to CBTEXT.XXX where XXX is the language extension desired. Then use CBSETUP main menu option #5 to select the new CBTEXT.XXX file and edit it. All CBTEXT files must reside in the same location with CHATBOX.EXE. All of the ChatBox text files (WHEN, NO, WHY, VIP) can be used with language extensions. ChatBox uses the same hierarchy as PCBoard with regard to language, security and RIP ("R") versions of text files. 2.9 Setting Up V.I.P. Callers (CHATBOX.VIP) -------------------------------------------- To create a VIP list of callers who may page at any time, create a text file called CHATBOX.VIP. It must reside in the same location as CHATBOX.EXE. To install special names into CHATBOX.VIP, simply enter the names one at a time, with each name beginning on a new line. Callers who appear in CHATBOX.VIP will be able to page the Sysop at any time regardless of page time settings. Callers who are listed in CHATBOX.VIP will NOT be able to PAGE the Sysop if the F4 page bell toggle has been turned off in PCBoard (unless the ability to follow the F4 setting has been disabled with CBSETUP). It is assumed that if the Sysop has turned F4 off then they really don't wish to disturbed. 2.10 Setting Up Callers Who Cannot Page (CHATBOX.NOT) ------------------------------------------------------ To create a list of callers who can NEVER page, regardless of page time settings, F4 page toggle, etc., create a text file called CHATBOX.NOT. It must reside in the same location as CHATBOX.EXE. To install names into CHATBOX.NOT simply enter the names one at a time, with each name beginning on a new line, and with each line ending with a carriage-return line-feed sequence. 2.11 Setting Up Dates for No Paging (DATE.NO) ---------------------------------------------- To create a list of dates when paging is not allowed (holidays, etc.), create or edit a text file called DATE.NO. It must reside in the same location with CHATBOX.EXE. To install dates for no paging, simply enter each date on a new line. These must be the actual dates in MM-DD-YY (month-day-year) format (not the days of the week which can be configured using CBSETUP). Each DATE to be blocked is entered on a new line, and the date must be in the MM-DD-YY (month-day-year) format. If the month (MM) is less than 10, it must begin with 0. For example, New Year's day would be entered as 01-01-94. If a date is not entered exactly in the format shown, it will not be recognized. -------------------------------------------------------------------- Page 22 ChatBox Page 22 -------------------------------------------------------------------- 3.0 Notes Regarding CBTEXT files --------------------------------- ChatBox detects the language in use and uses the language version of CBTEXT. If the default language is used or the appropriate language version of CBTEXT does not exist, the default CBTEXT file without an extension will be used. Most text in CBTEXT is self-explanatory. Exceptions are noted below: Rec# Default Text 1 Paging is not available at this hour Note: Used only if the Sysop has removed the WHEN files. 2 Sorry, the Sysop is not currently available for CHAT! Note: Used only if the Sysop has removed the NO files. 3 Hello, this is @OPTEXT@.~~ Note: ChatBox replaces @OPTEXT@ with the Sysop name. 5 Page ends in @OPTEXT@ seconds. (Ctrl-K) Aborts . Note: ChatBox will replace @OPTEXT@ with the seconds for for paging length time set in CBSETUP. 6 Would you like to leave a comment to the Sysop instead Notes: Used if a page attempt is unsuccessful. 7 Sysop CHAT active at~ Notes: Time is added to end by ChatBox. 8 Sysop CHAT ended at~ Notes: Time is added to end by ChatBox. 9 Operator Paged at~ Notes: Written to caller log only. Time is added to the end. 11 CHAT SUSPENDED, Please wait... Note: Displayed when Sysop is performing a task. Sysop's name in CBSETUP is added to the beginning of the line. 12 Chat resumed, thanks for waiting.~ Notes: Displayed on return from Sysop task. Caller's first name is added to end of the line. 16 Page the Sysop~ Note: Displayed if VIP caller is paging outside normal hours. 19 [END OF FILE] Note: Used after file has been imported by Sysop with ALT-I. 20 Press (Enter) to return to chat mode Note: Used after file has been imported by Sysop with ALT-I. 21 Chat has resumed... Note: Used after file has been imported by Sysop with ALT-I. 27 Ctrl-Z = Help Note: Displayed on caller's screen only, in a box "bar". ADDITIONAL NOTES: ----------------- @FIRST@ (caller's first name) may be used in any line. ChatBox replaces ~ characters with hard spaces in the same fashion PCBoard does with PCBTEXT. The text in CBTEXT files is simple informational text. ChatBox does not support %FILENAME conventions in any of the CBTEXT parameters, nor does ChatBox support !FILENAME.PPE conventions in CBTEXT. -------------------------------------------------------------------- Page 23 ChatBox Page 23 -------------------------------------------------------------------- 3.1 Notes Regarding The F4 Function Key ---------------------------------------- ChatBox follows the F4 toggle from PCBoard. This allows the Sysop to easily toggle paging on or off at any time. ChatBox will not follow the F4 toggle if ability to so has been disabled with CBSETUP. If so, all references to any F4 key action in this manual should be disregarded. The Sysop may also set the F4 toggle while in ChatBox. To determine if you have F4 toggled ON in PCBoard, look at PCBoard's call waiting screen. The very center information block will indicate whether "Page Bell is Off" or "Page Bell is On". If you are in PCBoard locally or a caller is on-line, you can determine if F4 is toggled on by the (B) on the very bottom status line. There may be a "P" or "A" in the parenthesis with the "B", (PAB), (AB), etc. depending on how other toggles are set in PCBoard. If a "B" is there, the page bell is toggled on and a caller may page the Sysop if the current time is within a specified paging period. 3.2 Notes Regarding Window (box) Clearing ------------------------------------------ The caller may press ESC and the Sysop may press ALT-C to clear the incoming window. This places the last line of text in the window at the top of the window (box). Special Note:, or "Whose Box Is It, Anyway?" -------------------------------------------- Each person (the Sysop and the caller) may only clear the incoming text from the other person. It is not practical to allow the person typing to clear the window they are typing (sending) in, as it is IMPOSSIBLE to know if the other person has read, or is keeping up with, the person who is typing! 3.3 Notes Regarding SOUND.BAT ------------------------------ SOUND.BAT is called if #8 has been selected for the type of sound to make when paging. ChatBox will shell out to SOUND.BAT every couple of seconds instead of making a selected noise. This allows the Sysop to make their own noise, screen displays, etc. There are many reports of sound cards successfully used to create page sounds in SOUND.BAT. Most sound cards come with DOS drivers and DOS command line software. It should be noted however this process might have difficulties. Some sound card drivers might have problems when used concurrently with communications programs. Test carefully and thoroughly if you using a sound card to create page sounds. In all cases, keep whatever is placed in SOUND.BAT small and fast. If using a sound card, use SMALL sounds such as TADA.WAV that comes with Windows for best results. -------------------------------------------------------------------- Page 24 ChatBox Page 24 -------------------------------------------------------------------- 3.4 Notes Regarding "Leave a Comment instead?" Feature ------------------------------------------------------- If the Sysop is unavailable (F4 key or Hours) or does not answer a page, the caller will be asked if they would like to leave a comment instead (if enabled). If the caller responds Yes, ChatBox will take the proper actions so that PCBoard will act as though "C [ENTER]" was typed by the Caller. This feature can be disabled with CBSETUP if it is not desired. IMPORTANT CONSIDERATION: If the "Leave a Comment" feature is enabled, OPAGE.PPE will engage PCBoard's internal (real) Comment function by default. This is what is desired in most cases however there is an exception: that is if you have substituted PCBoard's "Comment" routine with a third-party "Comment PPE". If so, and you want that comment PPE to run if the caller says yes (to comment after an unanswered page), then add /CP to the end of the OPAGE.PPE entry in CMD.LST as illustrated below. Charges Per PPE/MNU File Specification -or- Command Sec Minute Use KeyStroke Substitution --------- --- ------------ ------------------------------- #) O 10 0 0 C:\CHATBOX\OPAGE.PPE /CP > Do NOT add /CP if your "C" command is not defined in CMD.LST. > Do NOT add /CP if your "C" command is defined as something other than a "comment PPE". > ONLY add /CP if your "C" command is defined with a third-party "comment PPE" and if you want that PPE to run after ChatBox (after an unanswered page attempt). NOTE: After PCBoard enters the "C" for comment, it displays the confirmation prompt (PCBTEXT record 1) just as if the caller entered "C" themselves. This PCBoard prompt cannot be disabled. This may give the appearance that the caller is being asked twice if they want leave a comment, but that is not the case. 3.5 Notes Regarding Text File Displays --------------------------------------- Text files used by ChatBox support PCBoard color macros. Because ChatBox has been designed to be as small as possible for "shell" purposes, ANSI capability in text files was intentionally omitted. These text files support the @cls@ clear screen macro, and @first@ (caller's first name). Support for a multitude of @info@ macros has been intentionally omitted as they are usually not needed in a chat utility, and to keep memory consumption as low as possible. ChatBox follows the PCBoard convention for selecting the language, security, and RIP ("R") version of a text file if they exist. If the RIP version of a file exists (the file name ends with "R"), ChatBox will send the file to the caller, and display "Displaying RIP version of file: [filename]" on the Sysop's local screen. -------------------------------------------------------------------- Page 25 ChatBox Page 25 -------------------------------------------------------------------- 3.6 Notes Regarding ALT-M File Import -------------------------------------- Sysops may import SHORT "messages" (notes) directly into their chat box. Pressing ALT-M will display (on the Sysop's screen only) a list of files located in the ChatBox directory with an extension of .MSG. Six .MSG files will display in the pick-window, if more are present they are selected by scrolling the contents of the window with the up and down arrow keys. After selecting a file, the Sysop selects whether to display it FAST or SLOW. The .MSG files should be very short in length, such as the examples enclosed with ChatBox. This function is designed to send small pre-prepared text messages to the caller. The maximum size of a .MSG file is 2K (2048 bytes) and color is not supported. Colorized pictures & larger files may be displayed with ALT-I (import). 3.7 Notes Regarding Automatic-Reason-Comment --------------------------------------------- The Sysop may configure ChatBox to automatically leave a Comment to the Sysop with the "reason" the caller wanted to chat, if a page attempt was not successful. Naturally, the "ask reason" toggle in CBSETUP must be set so the caller will be asked why they are paging. If the Sysop then does not answer, ChatBox will leave a comment to SYSOP, from CHATBOX (so the caller cannot change or delete it), in the MAIN board (conference 0). The comment will contain the caller's name and the reason they paged. If the caller indicates they want to leave a Comment themselves (if enabled), ChatBox will not post the automatic comment with the reason, since presumably the caller is going to do so. Use of this feature requires the page be initiated with OPAGE.PPE. 3.8 Notes Regarding Multiple Sysops in SYSOP.DAT ------------------------------------------------- When a file called SYSOP.DAT exists in the ChatBox directory, the Sysop who is answering a page or starting a chat can choose from the list of names SYSOP.DAT contains. NOTE: Do not confuse SYSOP.DAT with CALLER.DAT. If CALLER.DAT exists in the ChatBox directory, the caller can choose the name of the Sysop they wish to page. See the next section for more information. Up to ten Sysop names may be configured to pick from when starting a chat or answering a page. This is extremely useful on systems where there is more than one Sysop, where a Sysop uses an aliases on some nodes, etc. If SYSOP.DAT exists in the ChatBox directory, a pick-list of names will appear on the local screen when answering a page or starting a chat. SYSOP.DAT is a text file created by the Sysop with any text editor. Each Sysop name (up to ten of them) starts on a new line in the file. Each name (line) must end with a carriage-return line-feed sequence (which will be put there by most text editors). -------------------------------------------------------------------- Page 26 ChatBox Page 26 -------------------------------------------------------------------- 3.9 Notes Regarding Multiple Sysops in CALLER.DAT -------------------------------------------------- If a file called CALLER.DAT exists in the ChatBox directory, the caller can choose who they want to page from the list in CALLER.DAT. NOTE: Do not confuse CALLER.DAT with SYSOP.DAT. If SYSOP.DAT exists in the ChatBox directory, the Sysop can choose the name they will use. See the previous section for more information. Up to ten Sysop names may be configured for the CALLER to pick from when starting a page. This is useful on systems where there is more than one person who could answer a page, such as in an office or a BBS in home where family members participate. CALLER.DAT is a text file created by the Sysop with any text editor. Each Sysop name (up to ten) starts on a new line in the file. Each name (line) must end with a carriage-return line-feed sequence (which will be put there by most text editors). The format for CALLER.DAT file is: NAME,DESCRIPTION NAME is a Sysop name, up to 25 characters long. It is recommended that first names only be used n this field. Place is a comma (,) after the name as shown. DESCRIPTION is an OPTIONAL 25 character description of who this person is (such as their job on the BBS). This field is optional. Press [ENTER] when finished with this "line". This should place the carriage-return line-feed sequence at the end of the line. You may configure up to ten Sysop names for the caller to choose from, one on each "line" of CALLER.DAT. Sample CALLER.DAT ----------------- Brent,The Main Sysop Lisa,The Files Sysop The above will look like the following in ChatBox: (1) Brent.............. The Main Sysop (2) Lisa............... The Files Sysop 3.10 Configuring ChatBox RIP Colors from Remote ------------------------------------------------ Sysops may set RIP chat colors differently than regular ANSI chat colors. This may be done with CBSETUP, or while the Sysop is on-line in a RIP mode terminal. When on-line remotely, the Sysop (the person in record #1 of USERS) has a RIP button labeled "Sysop". Selecting this allows the Sysop to see how RIP chat screens look as changes are made. Horizontal chat mode is needed during on-line RIP setup. The RIP "Sysop" button does not appear when callers are on-line. -------------------------------------------------------------------- Page 27 ChatBox Page 27 -------------------------------------------------------------------- 4.0 Sysop Function Keys ------------------------ ALT-H (Help) displays a complete list of Sysop functions (on the Sysop's screen only) during chat. F1 switches to Horizontal Split-Screen mode. F2 switches to Vertical Split-Screen mode. F3 switches to non-split-screen mode. F4 toggles the page availability toggle, just like PCBoard. Sysops may drop to DOS using the F5 key if F5 drop to DOS is enabled in PCBSETUP for the node. During chat, the Sysop may press ALT-P for a profile screen which contains many caller statistics and settings. In horizontal Split- Screen chat, this appears over the "box" the Sysop would normally type in, and the caller is unaware of its presence. In fact, the caller may keep typing while the Sysop is reviewing the profile! After the Sysop has reviewed the profile the contents of the Sysop's "chatbox" will be restored. In vertical or regular non-split screen chat mode, the caller will not be able to continue typing while the profile information is displayed on the Sysop's screen. While the above ALT-P information is on the screen, the Sysop may edit any of the caller's parameters displayed by pressing ALT-E for edit. The Sysop may then cursor through the parameters making changes as needed. Caller input is not accepted while the Sysop is actually Editing the Profile. The Sysop may press ALT-S to save and record any changes or ALT-A to abort any changes. After pressing ALT-S or ALT-A while editing, chatting will resume as normal. ALT-M displays the short message files as described on page 25. The sysop may import text files to display during chat. Press ALT-I, and a box will appear (on the Sysop's screen only) asking for the text file name to import. If the file is found, ChatBox will automatically begin displaying the file. After the file has displayed, a prompt appears advising that the "end of file" has been reached, and allows the caller to press (Enter) to resume chat. ALT-C will clear the incoming window (the box the caller types in). ALT-L toggles the logging of chat to disk file on and off. ALT-B will send a BEEP to the caller during chat. ALT-D toggles (disables) ALL of the caller commands on and off. ChatBox will act on ALT-X and ALT-N requests from the Sysop. ChatBox will set the appropriate flag so that PCBoard will use it after the caller logs off (as if ALT-X or ALT-N had been set in PCBoard). -------------------------------------------------------------------- Page 28 ChatBox Page 28 -------------------------------------------------------------------- 4.1 Technical Notes -------------------- ChatBox has been designed to run specifically with PCBoard versions 15.0 through 15.2. ChatBox will not run with earlier versions of PCBoard or with other brands of software. While ChatBox is running the Sysop may press F10 while the caller is entering a "reason" to page, or while the caller is being told the Sysop is unavailable. This will force ChatBox into a chat. Carrier is monitored by ChatBox. Should a caller drop carrier while in ChatBox they will be returned to PCBoard, which will detect the "no carrier" status and cycle appropriately. ChatBox works with non-standard com ports, addresses, and IRQs. COM1 is address 3F8/IRQ 4. COM2 is address 2F8/IRQ 3. If a COM port other than 1 or 2 is used, ChatBox will use the address and IRQ information as indicated in PCBOARD.DAT for the node. ChatBox works with IRQ values up to 15. ChatBox supports PCBoard's "PCB" environment variable modem setting overrides of the modem settings set in PCBOARD.DAT with PCBSetup. The PCB switches are /PORTx /PORTxF /OS /COMx: /BASE:xxx /IRQ:x. The (PAB) (Printer, Alarm, Bell) indicators on the status line will also include M for multi-port if ChatBox is used in FOSSIL mode. ChatBox gives the caller time credit while chatting with the Sysop, just as PCBoard's chat facility does. If it is detected that the caller's communications program is not ANSI capable, ChatBox will start the chat in the regular, non-split screen chat mode. The OPAGE.PPE files turn on and off the "flashing p" on the PCBoard status line when there has been an unsuccessful page as appropriate. The Sysop may press "S" during a page attempt to Silence the sound without answering the page. 4.2 Caller Log Entries ----------------------- ChatBox makes pertinent entries into the caller log as follows: If a REASON for paging is requested, the caller's answer written to the appropriate node's CALLER file. The reason a page is not allowed (hours, F4 toggle, etc.) is written to the appropriate CALLER log. Text such as "Sysop paged at", "Chat started at", "Chat ended at" is also written to CALLER files by ChatBox where appropriate. -------------------------------------------------------------------- Page 29 ChatBox Page 29 -------------------------------------------------------------------- 4.3 ChatBox CHATLOG (ALT-L) Files ---------------------------------- Sysops may keep a record of the contents of their chat with a caller by entering ALT-L during the chat. ChatBox will add the text of the chat to a file called CHATLOG.xxx, where xxx is the node number the chat is occurring on. CHATLOG files are located with CHATBOX.EXE. CHATLOG files are appended (added) to with each ALT-L, so care should be taken if this feature is used often so that the log files will not become too large to handle. You may turn logging turned ON by default during each chat session by toggling the appropriate setting in CBSETUP.EXE. 4.4 Multi-nodes, Networks, Multi-taskers ----------------------------------------- ChatBox is developed in a networked environment. Multi-node features are thoroughly tested on our own multi-node PCBoard system. ChatBox is OS/2, DESQview and Windows aware. They are automatically detected and time slices are given back to the multi-tasker while ChatBox is idle (waiting at an input prompt). PCBoard for OS/2 and PCBoard /M multi-port software are supported by ChatBox through the FOSSIL interface. ChatBox reads PCBOARD.DAT on the node where it is running and automatically determines if PCBoard has been set for FOSSIL or OS/2 use on that node. If it is, ChatBox will automatically use FOSSIL mode, and a FOSSIL driver must be present and properly installed for ChatBox to function properly. If a single PCBOARD.DAT is used on a multi-node system, ChatBox must be able to read the PCBDAT environment variable so that it knows where the single copy of PCBOARD.DAT can be found. Likewise, ChatBox must also be able to read the PCB environment variable to determine if /PORT: /OS /FOSSIL etc. overrides exist for the node. 4.5 Where to Receive Assistance -------------------------------- Yandell Custom Software (YCS) provides the following technical assistance for ChatBox: 813-842-8099 The YCS Support System. Available to all BBS Sysops. INSTANT on-line credit card registration and support system for YCS Shareware. Support is also available on the Salt Air BBS (home of PCBoard) in the YCS conference (#36). Limited voice support is available to registered users of ChatBox. -------------------------------------------------------------------- Page 30 ChatBox Page 30 -------------------------------------------------------------------- 4.6 Disclaimer and Warranty ---------------------------- ChatBox is a shareware product. ChatBox may be uploaded to BBS systems as long as copyright notices are not removed and no changes are made to the program. There are no warranties, expressed or implied, for unregistered copies of ChatBox. Sysops who install ChatBox on their systems assume any and all liabilities for anything which may result as a consequence of running ChatBox. For registered copies of ChatBox, Yandell Custom Software warrants that ChatBox will perform as described in this documentation. In the event that ChatBox does not perform as specified, Yandell Custom Software may elect to fix ChatBox or refund the amount paid, if YCS is notified within 90 days of the initial registration. This notification must contain a description that enables YCS to reproduce the situation. Under no circumstances shall Yandell Custom Software or the author of ChatBox be liable for any loss of profit or any other damages, including but not limited to special, incidental, consequential, or other damages, arising out of the use or inability to use ChatBox. 4.7 License to Use ChatBox --------------------------- ChatBox is not "public domain" or "free" software. A limited license is granted to use and evaluate ChatBox for thirty days after initial installation. ChatBox must be registered if it is used after the initial thirty day evaluation period. If ChatBox is not registered after 30 days, a Sysop reminder will begin appearing at program termination and will also be written to the node's caller log file. A ChatBox registration may be used only on the original licensee's BBS system and only on nodes the original licensee owns and operates for their own purposes. If the original licensee leases or sells some or all of their nodes to another entity, those nodes will require their own ChatBox registration. ChatBox registrations are not transferable. A ChatBox registration is a license to use the ChatBox software on one (1) BBS System at a single location with as many nodes as the original licensee owns and operates at THAT location. When the licensee owns and operates other BBS' in other locations, each location will require a separate ChatBox registration. 4.8 Revision History --------------------- Date Version Date Version -------- ------- -------- ------- 06-14-91 1.0 08-20-93 2.4 08-10-91 1.1 11-19-93 2.5 11-08-91 1.2 01-01-94 2.6 12-20-91 1.3 03-04-94 2.7 03-27-92 2.0 08-04-94 3.0 05-01-92 2.1 07-28-95 3.1 11-27-92 2.2 09-08-95 3.2 05-04-93 2.3 -------------------------------------------------------------------- Page 31 ChatBox Page 31 -------------------------------------------------------------------- 5.0 Registering ChatBox ------------------------ Registration removes the [UNREGISTERED COPY] message at program termination along with the corresponding brief delay. Registration also enables the Sysop definable colors for ANSI Split-Screen chat. Registration is $15.00 and may be paid by check, money order, VISA, Mastercard, American Express or Diners Club. Receive a registration number INSTANTLY by registering with a credit card! Refer to the ORDER.FRM file for complete registration instructions. 5.1 Register With CONFIDENCE - Author Information -------------------------------------------------- Brent Yandell has been programming for over thirteen years including more than eight years of developing telecommunications software. Most Sysops will be familiar with PCBFV, the popular on-line PCBoard File Viewer. See the enclosed CATALOG.TXT file for a complete list of Sysop utilities from YCS. Yandell Custom Software (YCS) is a licensed business, operating and existing under the laws of the State of Florida since July, 1990. Writing BBS Shareware doors and utilities, in addition to custom programming, is our business.... our ONLY business. First Door Release: 7/6/87 (USBBSDoor). Still updated and supported! YCS Shareware is GUARANTEED (each product's documentation contains each product's specific guarantee). Yandell Custom Software is an *AUTHORIZED* credit card merchant for VISA, Mastercard and American Express charge cards. A dedicated multi-node BBS for support and on-line registrations, a toll-free voice line for registrations, and a voice support line for registered customers are just a few of our offerings in our efforts to provide you with RELIABLE, FAST, FRIENDLY SERVICE.