Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / LCHAT110.ZIP / LIGHTCHT.ZIP / LIGHTCHT.DOC < prev next >

Wrap

Text File | 1995-06-23 | 118.3 KB | 3,435 lines

█ █ █ ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█▀▀▀▀▀▀ █ █ █ ▄ ▄ ▄ ▄ █ █ ▀ ▄▀▀▀▄ █ █ ▄▀▀▀▄ █ █ ▄▀▄ █ █ ▀█ █ █ █ █ █ █ █ █ █ █ █ █ ▀▀█ █▀▀▀█ ▀▀█▀▀ █ █▀▀▀█ █▀▀▀█ █ █ ▄█▄ ▀▄▄▄▀ █ █ █ ▀▄▄▄▀ █ █ █ █ █ █ █ █ █ █ █ █ █ █ ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ LightChat v1.10 "The brightest chat program ever!" Copyright (C) 1994-1995 Lightning Software All Rights Reserved │ ─────────┬─ │iG├┤┬ C├┤A│ └──────────── USER GUIDE Table of Contents 1 INTRODUCTION .................................................. 4 1.1 What is LightChat? ....................................... 4 1.2 Features ................................................. 4 1.3 License Agreement and Disclaimer ......................... 7 1.4 Users' Comments .......................................... 7 1.5 Registration ............................................. 8 2 INSTALLATION .................................................. 9 2.1 Unpacking the Files ...................................... 9 2.2 Using AutoInstall ........................................ 9 2.3 Configuring Your BBS Software for LightChat ............. 12 2.3.1 Configuring RemoteAccess ......................... 12 2.3.1.1 Creating a 'Page SysOp' Option .......... 12 2.3.1.2 Configuring RA to Break into Chat ....... 13 2.3.2 Configuring Other BBS Software ................... 14 2.4 Configuring Your BBS Software for LightEdit ............. 16 2.4.1 Configuring RemoteAccess ......................... 16 2.4.2 Configuring Other BBS Software ................... 17 3 LCSETUP ...................................................... 18 3.1 System .................................................. 18 3.1.1 Names ............................................ 18 3.1.2 Paths ............................................ 19 3.1.3 Filenames ........................................ 20 3.1.4 Paging ........................................... 22 3.1.4.1 General ................................. 22 3.1.4.2 Display ................................. 24 3.1.4.3 Hours ................................... 25 3.1.4.4 Reason for chat ......................... 26 3.1.5 General .......................................... 27 3.1.5.1 Random ANSI effects ..................... 27 3.1.6 Strings .......................................... 29 3.1.6.1 General ................................. 29 3.1.6.2 Auto greetings .......................... 30 3.1.6.3 Auto goodbyes ........................... 31 3.2 Command Macros .......................................... 33 3.3 Word Macros ............................................. 33 3.4 Chat Modes .............................................. 34 3.4.1 Mode 1 ........................................... 34 3.4.2 Mode 2 ........................................... 35 3.4.3 Mode 3 ........................................... 37 3.4.4 Mode 4 ........................................... 37 3.5 Message Editor .......................................... 37 3.5.1 General .......................................... 37 3.5.2 Conditions ....................................... 38 3.5.3 Screen ........................................... 40 3.5.4 Command-macros ................................... 41 3.6 Registration ............................................ 42 3.7 Information ............................................. 42 3.8 Exit to DOS ............................................. 43 4 LIGHTCHT ..................................................... 44 4.1 Command line parameters ................................. 44 4.2 Operation ............................................... 45 4.2.1 Paging ........................................... 45 4.2.2 Intelligent "logon" mode ......................... 45 4.2.3 Using AutoExclude ................................ 46 4.2.4 Customising screens .............................. 47 4.2.5 Default Operation and Keys ....................... 48 5 APPENDICES ................................................... 52 5.1 Data codes .............................................. 52 5.2 Macro commands .......................................... 53 5.3 Errorlevels ............................................. 56 6 CREDITS ...................................................... 58 7 SUPPORT AND INFORMATION ...................................... 59 1 Introduction Welcome to LightChat, probably the most sophisticated and configurable chat program ever written! This introduction describes exactly what LightChat is, provides a list of its extensive features, and gives details of how you can register. If you have not used LightChat before, we recommend you read the rest of this introduction to find out more about what LightChat can do, and then refer to Section 2 for full details on how to set up LightChat for your system. 1.1 What is LightChat? LightChat is a sophisticated and stylish split-screen multi-node aware chat program for RemoteAccess Bulletin Board Systems, and any BBS that can support the DOOR.SYS format drop-file. Every effort has gone into LightChat, in an ultimate aim to make it the best chat program on the market. LightChat's sheer configurability and rich feature set make it stand out from the crowd. You will also find LightChat is one the easiest programs to install ever, thanks to its intelligent AutoInstall technology. Coupled with Lightning Software's continued commitment to providing a quality service, you really can not go wrong. We truly believe that this is the best BBS chat program money can buy. If, after trying it, you disagree, we would sincerely appreciate your comments and/or suggestions as they are very useful for future releases. LightChat now consists of TWO programs in one! From this release, LightChat has a special feature whereby you can tell it to act as an external message editor - a single switch and LightChat is now "LightEdit"! 1.2 Features As you can see from the list below, LightChat is already packed with features, but we are regularly receiving requests from users for additional features that we hadn't thought of. If you have a suggestion, get in touch - it may well be included in the next version! Details of how to contact us can be found in Section 7. In the following list of features, those that are shown in italics are only available in the registered version. * Intelligent interactive AutoInstall feature, with complete self-installation in seconds! * Fully backward-compatible with previous versions of LightChat. LCSETUP can import and set defaults for ANY previous release. 4 * Demo mode with demonstration of features and a guided tour when run in local mode. * Customisable ASCII chat mode: - Customisable text file to display upon entry. - Configurable colours for SysOp and User text. * Three fully configurable ANSI chat modes. - Configurable colours. - Configurable window sizes/positions. - Configurable date/clock type, colours and positions. - Configurable screen layout. - Configurable 'scrollback' buffer. - Configurable 'number of lines to scroll'. * Command line controlled chat mode selection (forced, or random choice). * Configurable random ANSI effects when loading LightChat. * New, intelligent "Logon" mode, invoked by LightChat when it autodetects that a user is still in the new user or logon procedure. * Parameters can be obtained from DOOR.SYS file or overridden by optional command line parameters. * Configurable 'reason for chat' screen, with reason for chat returned to RemoteAccess' status bar. * Customisable automatic greetings and goodbyes, with random/time control and configurable SimuType technology (simulated typing). * Configurable intelligent auto-greeting, to prevent greeting a user more than once during the same call. * Configurable pager: - Beep, tune or silent operation. - Configurable 'bar graph' page progress indicator. - Configurable page duration. - Random tune selector feature. - Configurable paging hours (internal or RemoteAccess based). - Paging hours override. - Silence button (SCROLL LOCK). - Configurable maximum number of pages per call. - AutoExclude facility, for automatically barring pest-users. - Flashing keyboard lights (configurable) in time to the page tunes! * Fully configurable message-to-SysOp feature, with support for Hudson and JAM message base types. * Built-in ANSI message editor with full text-editing facilities. * Direct-save feature in message editor. 5 * Page up/down, delete line, insert/overtype, backspace/delete, full cursor movement facilities within all chat modes and message editor. * Message editor can be used as a stand-alone external QuickBBS-compatible message editor. * Built-in RemoteAccess-style ASCII message editor. * Shell to DOS facility, with customisable user-messages, and swapping to EMS or XMS. * All user selections/choices are made with colour-configurable hotkey/cursor driven LightBars, with animated ANSI prompts. * Up to 3 additional names to use instead of SysOp's name, each with an associated (configurable) chat key to answer page. * Definable macro keys and associated functions (50 for the SysOp, 50 for the user). ALL keys for any function in LightChat are completely configurable! Separate macro sets for LightChat and LightEdit. Defined macros are available at all times during program operation. * Definable word-macros, with user/SysOp/both, SimuType and case sensitivity control mechanism. * Configurable trigger characters to activate word-macros. * Editor-like chat windows, with full cursor movement and text insertion/deletion, both locally and remotely. * Text in chat windows is deletable in both directions (i.e. you can delete characters to the right of the cursor as well as to the left). * Delete-line feature, in both chat and message editor. * Complete internal user editor, with customisable user-messages and on-line help. * Ability to swap to the other chat window. * Ability to freeze the user's input. * Hang-up facility, to disconnect user directly. * Lock-out facility, to lock out user directly. * Chat capture-to-file facility with configurable multi-node aware capture filename. * Chat capture stores both SysOp and user input separately. 6 * Auto chat capture feature, with automatic re-opening after mode-switch. * Allows "high-ASCII" in chat and all configurable strings; useful for international characters. * Redraw screen facility. * Clear window/other window feature. * Multi-node aware. * Supports DOS, OS/2, Windows, and DESQview, and releases timeslices where appropriate, for smooth operation. * Configurable action if the SysOp is already chatting to another user. * Customisable .ASC/.ANS files to display when: - Asking for a reason for chat. - The reason given is too short. - Paging the SysOp. - The SysOp aborts the page. - The SysOp does not answer the page. - The SysOp is already chatting to another user. - The user not allowed to page the SysOp. - The user is paging outside of paging hours. * Excluded user list to prevent particular users from paging the SysOp. * Configurable action when dealing with excluded users - either display a file or 'pretend' to page the SysOp. * USERDOES support for compatible programs to show that the user is in LightChat. * Configurable USERDOES and semaphore paths. * USERDOES file shows when the user is paging, when they are chatting, and when leaving a message. * LightChat activates/deactivates RemoteAccess' 'wants chat' indicator. * Sets RemoteAccess to show 'SysOp Chat' from a 'Who's on-line?' menu option. * 'Rotatable' SysOp status bar, with configurable colours. * RemoteAccess style compact or expanded logging. * Returns specific errorlevels indicating user's behaviour, system errors, etc. 7 * Interactive and easy to use configuration program, complete with context-sensitive on-line manual. 1.3 License Agreement and Disclaimer "Lightning Software" consists of David McGarry and Marcel Cook. "LightChat" refers to the executables and documentation contained in the LightChat distribution archive, officially released by Lightning Software. * LightChat is Copyright (C) 1994-1995 Lightning Software; All rights reserved. * Lightning Software and the author(s) of LightChat are under no obligation to provide future versions of, or support for LightChat. * Lightning Software and the author(s) of LightChat will under no circumstances be held responsible for any damage or loss resulting from the use of LightChat. * By using LightChat you are agreeing to the conditions set out in this License Agreement and are therefore releasing Lightning Software and the author(s) of LightChat from any liability or litigation. 1.4 Users' Comments You don't have to take our word for it - here is what some SysOps who already use LightChat have had to say about it: "It is the most impressive chat software I have ever come across." Les Pitcher, Phantasmagoria BBS (2:2503/413) "It's a truly excellent program." Glen Chambers, The Glass Asylum (2:257/84) "Oi! Oi! Oi! Gimme Gimme Gimme! :-)" Michael Rallings, Gunsmoke BBS (2:252/174) These are comments we have received from genuine SysOps (printed with their consent) who use LightChat on a daily basis. 1.5 Registration This software is not free. The unregistered version is distributed for evaluation purposes and as such, you are expected to register it after an initial evaluation period of 30 days. If, after this period, you decide not to use the software, you must not use it again without registering first. 8 What you get by registering: * No more annoying flashing UNREGISTERED signs (and also silent operation). * Ability to define your own 'reason for chat' prompt screen. * Forced/random chat mode selection. * Two more fully configurable chat modes. * Ability to let the user switch chat modes and quit chat. * Ability to suppress tearlines in messages to SysOp. * No 'UNREGISTERED' taglines in LightEdit. * Intelligent auto greetings. * AutoExclude facility. * Full technical support. * Free updates when available (no upgrade fee). * More chance of LightChat being developed further. The basic registration fee is currently UKP 15.00, US $25.00 or 37.00 DM. Remember, you get two programs for the price of one! To register, please read the REGISTER.TXT file enclosed in the official LightChat distribution archive. ┌─────────────────────────────────────────────────────────────────┐ │ You can register LightChat RIGHT NOW on CompuServe! Simply 'GO │ │ SWREG', and use the LightChat Product ID, 4832. │ └─────────────────────────────────────────────────────────────────┘ We are also looking for more beta-testers for LightChat; please refer to the BETA.APP file for more information. 9 2 Installation Installing LightChat is an extremely easy task, thanks to its intelligent AutoInstall facility, which will configure LightChat for you as much as possible, install itself into your RemoteAccess system, and all in a matter of seconds! LightChat requires a fossil driver to be present in your system to run (this is not required in local mode). If you do not already have one, you must obtain and install a fossil driver before using LightChat. We recommend X00 or BNU, although LightChat should work with others. Fossil drivers are available from most BBS's, but can also be obtained from Lightning Software or Lightning BBS. 2.1 Unpacking the Files Make a directory to extract the LIGHTCHT.ZIP file into. For consistency with the paths used in this documentation, we recommend the following: C:\RA\LIGHTCHT With the LIGHTCHT.ZIP file inside this directory, extract it using: PKUNZIP -D LIGHTCHT This will ensure the creation of the SCREENS and TUNES sub- directories with their relevant files. After unpacking the files, you should receive the following message: Authentic files Verified! # XNT146 Marcel Cook David McGarry, Lightning Software If you do not, then LIGHTCHT.ZIP is not the officially released archive, and you should delete it and obtain a new copy. 2.2 Using AutoInstall AutoInstall is a sophisticated self-installation routine that makes installing LightChat as quick and easy as possible. If you are using LightChat with BBS software other than RemoteAccess, regrettably, you will not be able to use this facility, and should refer to Section 2.3 for details of how to install LightChat manually, and then Section 3 for configuration instructions. Note that even if you are not using RemoteAccess, AutoInstall will still attempt the first and last steps shown below. 10 ┌────────────────────────────────────────────────────────────────────┐ │ Note: Although LightChat is fully backward-compatible (AutoInstall │ │ automatically imports old configurations), it is recommended │ │ that you completely re-install LightChat if you currently │ │ use Versions 0.28 or 0.29, in order to take full advantage │ │ of the major enhancements. │ └────────────────────────────────────────────────────────────────────┘ If you are using RemoteAccess, we strongly recommend you use LightChat's AutoInstall facility for first-time installations. This ensures LightChat's configuration is fully in-tune with your system. AutoInstall's only requirement for successful operation is that you set the RemoteAccess environment variable to point to your RemoteAccess system directory (see your RemoteAccess documentation for more details). AutoInstall will adjust many paths and filenames according to where LCSETUP is located when it is run. Therefore, before using AutoInstall, you should ensure that LCSETUP is in the directory where LightChat will finally reside. Next, run LCSETUP. You will be prompted to create a LIGHTCHT.DAT file, which is achieved by pressing the SPACE bar. LCSETUP will now ask whether you would like to use AutoInstall. If, for some reason, you do not want LCSETUP to alter your RA configuration and menu files (despite the fact that it will make backup copies of everything it changes), you should press 'N'. You will then have to configure LightChat manually, although it will still configure the paths to the LightChat files for you. If you choose 'Y', LightChat's AutoInstall facility will now attempt to achieve the following tasks: * Locate an existing LightChat installation. If found, this configuration will automatically be imported and converted, and any new features will be given default values. Otherwise, AutoInstall will continue as follows: * Locate your RemoteAccess configuration files. If found, AutoInstall will make a backup copy (CONFIG.OLD), paging settings will be transferred to your LightChat configuration, and the command line required to invoke LightChat will be automatically generated and placed in your RemoteAccess configuration. You will also be asked if you wish to configure LightChat's "LightEdit" feature. If you choose to do so, AutoInstall will generate a command line to invoke LightEdit, and place it in the "External message editor" slot in your RemoteAccess configuration. If you have not yet registered RemoteAccess, AutoInstall will 'intelligently' select a suitable Alt-function key slot in which to place the LightChat command line. 11 * Locate your GLOBALRA.MNU file. If you use a GLOBALRA.MNU, AutoInstall will make a backup copy of this (GLOBALRA.OLD) and install LightChat into a menu slot for you. AutoInstall uses heuristics to either 'intelligently' select an existing menu slot or create a new one. If GLOBALRA.MNU is not found, AutoInstall will create one. * Locate your To/From SysOp message-base. AutoInstall uses heuristics to attempt to locate your private message-base, and if successful, configures LightChat accordingly. If it does not successfully choose the correct message-base, it will use its 'best guess'. * Adjust pathnames and filenames. AutoInstall will detect where you have extracted the LightChat files, and adjust relevant path and file names accordingly. Therefore, it is important that the files are located where they will be used later, when running LCSETUP for the first time. As you can see, AutoInstall's self-configuration is very comprehensive, and as a result, it is unlikely that you will need to configure anything manually before you are able to use LightChat for the first time. There are, however, many options in LCSETUP which you should familiarise yourself with over time. To do this now, we suggest you read Section 3 of this documentation. If you are keen to get LightChat up and running, here are a few things you might wish to check before attempting to execute LightChat: * System->Names->SysOp's name Your name should be entered here. * System->Paths Check that the paths are correct for your particular setup. * System->Filenames Check that the paths are correct for your particular setup. It does not matter if some of the definable .ASC/.ANS screens are not present at this stage of the installation procedure. * Chat modes->Mode 1->Screen file * Chat modes->Mode 2->Screen file * Chat modes->Mode 3->Screen file * Chat modes->Mode 4->Screen file * Message editor->Screen->Screen file Check that the paths are correct for your particular setup. After checking these options, press the ESCAPE key to exit LCSETUP. You will be prompted to save your changes, for which you should answer yes by pressing the Y key. You are now ready to add LightChat to your BBS and try it out! 12 If AutoInstall was successful, you should not need to configure LightChat any further, or install it in your BBS - you can now try loading LightChat from DOS, or start up your BBS and try paging. Otherwise, you will have to install and configure LightChat manually. Please refer to the next section for details of how to install LightChat, and then read Section 3 for configuration details. 2.3 Configuring Your BBS Software For LightChat For LightChat to be able to run, a minimum requirement is that it has access to a DOOR.SYS BBS drop file. This file contains essential information about the user and your system. RemoteAccess and most other BBS software is capable of producing this file - please refer to your BBS software documentation if you are not sure. LightChat expects to be able to find this file in the current directory when LightChat is loaded - if it is not, then LightChat cannot run. 2.3.1 Configuring RemoteAccess The easiest way of loading LightChat from RemoteAccess is to set it up in a 'Type 7' menu option. If you use this method, the DOOR.SYS file will already be in the current directory when LightChat loads, so you do not need to worry about this. If you use any other method (such as a batch file), you will need to ensure that you change into the directory containing the DOOR.SYS file before making the batch file load LightChat. LightChat can also use another file, specific to RemoteAccess, which contains additional information about the user and your system. This file is called EXITINFO.BBS, and will be created in the same directory as DOOR.SYS. It is not required for LightChat to run, but will let you use additional features such as the rotatable status bar, the internal user-editor and the 'Wants Chat' indicator. 2.3.1.1 Creating a 'Page SysOp' Option in a Menu If AutoInstall was successful, it will have already installed LightChat in a Type 7 menu option in your GLOBALRA menu file, in the form shown below. Here is how LightChat should be called from a Type 7 menu option: C:\RA\LIGHTCHT\LIGHTCHT.EXE /MR /N*N /B*B /P*P *! *M 13 The /MR parameter makes LightChat randomly select a chat mode to start in. It has no effect unless you have registered LightChat. The /N, /P, and /B parameters specify the node number, port number, and baud rate of the caller. They are totally optional, but are REQUIRED for the intelligent "logon" mode (see Section 4.2.2) to function correctly. The *! parameter freezes RemoteAccess' timer whilst you are in chat mode, so that the user still has the same number of minutes available on-line after finishing a chat session as they did before they paged you. The *M parameter forces RemoteAccess to swap out of memory before executing LightChat, allowing LightChat to use more memory for itself. This will load LightChat and start the paging action. 2.3.1.2 Configuring RemoteAccess to Break into Chat LightChat accepts a parameter /F, which forces it to bypass the page screen and enter chat mode immediately. This is useful for the SysOp to initiate a conversation with a user. If AutoInstall was successful, this step should have already been performed for you. There are two ways you can do this: 1. LightChat can be added to RACONFIG's external chat slot. In RACONFIG, under Options->Paging->External, the following line can be added: C:\RA\LIGHTCHT\LIGHTCHT.EXE /F /MR /N*N /B*B /P*P *! *M This will allow you to break into chat mode by pressing ALT-C. ┌─────────────────────────────────────────────────────┐ │ Tip: If a user has logged on with EMSI, │ │ RemoteAccess will default to its own │ │ split-screen EMSI chat mode. To override │ │ this, press SHIFT-ALT-C instead of just ALT-C. │ └─────────────────────────────────────────────────────┘ ┌─────────────────────────────────────────────────────┐ │ Note: The ALT-C function in RemoteAccess does not │ │ work when running in local mode. │ └─────────────────────────────────────────────────────┘ 14 2. LightChat can be assigned to an ALT-FUNCTION key combination in RACONFIG. In RACONFIG, under Manager->AltFn keys, the following line can be added: C:\RA\LIGHTCHT\LIGHTCHT.EXE /F /MR /N*N /B*B /P*P *! *M Assuming you defined this for ALT-F1, you can now force a user into chat mode by pressing ALT-F1. If you have not yet registered RemoteAccess, you should use the second of these methods, as the first is a registered-only feature. 2.3.2 Configuring Other BBS Software Since the procedures involved for configuring LightChat with other BBS software vary greatly depending on which you are using, it is not possible to list them all here. We recommend that you refer to your BBS software documentation, and look for a section on 'external chat', or 'running external programs', for specific details. It is essential that your BBS software can create DOOR.SYS type files for LightChat to run. If these are created in the current directory when you load LightChat, then all you need do is configure your BBS to have a menu option that loads LightChat, using the following command line: C:\RA\LIGHTCHT\LIGHTCHT.EXE /MR The /MR parameter makes LightChat randomly select a chat mode to start in. It has no effect unless you have registered LightChat. This will load LightChat and start the paging action. If the DOOR.SYS files are not created in the current directory, then you will have to make your BBS software run a batch file to load LightChat, and just before the above command line, you should make the batch file change into the directory containing the DOOR.SYS file. You may also wish to configure your BBS software so that you can break into chat with a user, without the paging process, if such a facility exists within your BBS software. The way to do this is to enter another command line in the 'External chat command line', if your BBS software has this feature. Alternatively, you may be able to configure a function key, for example, that invokes a configurable command-line. Please refer to your BBS software documentation for details of how to achieve this. The command line you should use to bypass the paging process is: 15 C:\RA\LIGHTCHT\LIGHTCHT.EXE /F /MR You will now be able to jump straight into chat with the user, using the appropriate key or key combination. 2.4 Configuring Your BBS Software For LightEdit LightEdit is effectively a stand-alone external message editor, that is activated simply by passing a single parameter (/E) to LightChat. From the user's point of view, the program is completely separate, but it has the advantage that you do not need to set up another program to use it! All LightEdit's settings are the same as those for LightChat's internal message editor (see Section 3.5). LightEdit is a QuickBBS-compatible message editor, which means it makes use of the MSGTMP and MSGINF interface. These two files are created by the BBS software to pass information such as the user's name, recipient, subject, and existing message content (if the message is a reply) to the editor. As such, LightEdit REQUIRES the presence of AT LEAST the MSGINF file to operate. If this file does not exist, LightEdit will run in local test mode. LightEdit will also make use of the DOOR.SYS and EXITINFO.BBS files if they exist, but their presence is entirely optional. 2.4.1 Configuring RemoteAccess LightEdit is extremely easy to set up with RemoteAccess. If you have used AutoInstall, LCSETUP will have created a suitable command line for you and placed it in the External Message Editor slot in RACONFIG. Otherwise, you will have to do this yourself. In RACONFIG, under the Options menu, select 'Messages'. From this menu, select the 'External Editor' option. You should now enter the following command line: C:\RA\LIGHTCHT\LIGHTCHT.EXE /E *M The /E parameter tells LightChat to switch to "LightEdit" mode, and act as an external message editor. The *M parameter forces RemoteAccess to swap out of memory before executing LightChat, allowing LightChat to use more memory for itself. 16 From now on, any users that have the 'ANSI full screen editor' enabled as one of their options, will be presented with LightEdit when they enter or reply to a message on your system! 2.4.2 Configuring Other BBS Software Since the procedures involved for configuring LightEdit with other BBS software vary greatly depending on which you are using, it is not possible to list them all here. We recommend that you refer to your BBS software documentation, and look for a section on 'external editor', or 'running external programs', for specific details. As a bare essential, your BBS software must be able to create QuickBBS-compatible MSGINF and MSGTMP files that can be used by LightEdit. If your software can do this, then you will need to have your BBS software load LightEdit as follows: C:\RA\LIGHTCHT\LIGHTCHT.EXE /E The /E parameter tells LightChat to switch to "LightEdit" mode, and act as an external message editor. 17 3 LCSETUP LCSETUP is LightChat's interactive configuration/setup utility. It uses a standard user interface, which should make using it as simple as possible. Each menu option displays a line of context sensitive help at the bottom of the screen which should be enough for most users to understand what the various options mean. If you need more detailed help, you can press F1 at any time from within the program, to display the relevant section of this manual. Using LCSETUP is fairly intuitive even for novices, but a full list of keys is provided below: Cursor Up/Cursor Left/Shift-Tab Move selection bar up in menu. Cursor Down/Cursor Right/Tab Move selection bar down in menu. Home Highlight first menu item. End Highlight last menu item. Return Select menu option/Edit item. Escape Previous menu/Quit/Cancel edit. ALT-Z Shell to DOS. F1 Display context-sensitive help. From within the help-browser (invoked by pressing F1 at any time), you may use the following keys: Cursor Up Move up one line. Cursor Down Move down one line. CTRL-PgUp/Home Move to start of manual. CTRL-PgDn/End Move to end of manual. PgUp Move one page up. PgDn Move one page down. Tab Jump to a specific page number. F4 Search for some specified text. Shift-F4 Jump to a specific section. ALT-Z Shell to DOS. Escape Exit help-browser. 3.1 System This menu lets you configure all LightChat's system options, such as names, paths, filenames, paging behaviour, auto-greetings, auto- goodbyes, etc. 3.1.1 Names This menu lets you configure the SysOp's and Co-SysOps' names, and their associated 'chat keys'. Get SysOp name from Defines where LightChat should look for the SysOp's name. Use "LightChat" for LightChat's configuration file, or "RA" for the DOOR.SYS file. 18 SysOp's name The SysOp's name. Only used when [Get SysOp name from] is set to "LightChat". Alternative name #1 Alternative SysOp name #1. Useful for a Co-SysOp. Chat key Key used to answer a page request using the name defined in [Alternative name #1] above. Alternative name #2 Alternative SysOp name #2. Useful for a Co-SysOp. Chat key Key used to answer a page request using the name defined in [Alternative name #2] above. Alternative name #3 Alternative SysOp name #3. Useful for a Co-SysOp. Chat key Key used to answer a page request using the name defined in [Alternative name #3] above. 3.1.2 Paths This menu lets you define the paths LightChat requires to locate certain system files. AutoInstall automatically configures these. System Path to your RemoteAccess system directory. Example: C:\RA Semaphore Path to your semaphore directory, where LightChat should create it's semaphore files, mainly for multi-node use. Example: C:\SEMAPHOR 19 Page tunes Path to your LightChat page tunes. All files in this directory are assumed to be LightChat paging tunes, so nothing else should reside here. Example: C:\RA\LIGHTCHT\TUNES USERDOES Path to your USERDOES directory, where LightChat will create USERDOES.nnn files to describe LightChat actions. This is sometimes the same as your semaphore directory, or it can be somewhere else, such as your RemoteAccess system directory. Example: C:\RA 3.1.3 Filenames This menu lets you define various system filenames (such as log file and exclude-list) as well as some configurable ANSI/ASCII screens. AutoInstall will automatically adjust the paths to these files. System log Full path and filename of the log file you wish LightChat to log details to. This can be your normal RemoteAccess log file, or a log file specifically for LightChat. You may include the *N macro in this filename - *N will be replaced by the node number LightChat is running on, which is useful for multi-node systems that wish to keep node's log files separate. Example: C:\RA\NODE*N\RA.LOG Chat log Full path and filename of the file you wish LightChat to capture chat to (when activated). You may include the *N macro in this filename - *N will be replaced by the node number LightChat is running on. Example: C:\RA\LIGHTCHT\CHAT*N.LOG Reason Full path and filename (excluding extension) of a .ASC/.ANS file which is displayed when LightChat prompts the user for a reason to chat. Example: C:\RA\LIGHTCHT\SCREENS\REASON 20 Too short Full path and filename (excluding extension) of a .ASC/.ANS file which is displayed when the reason for chat string is less than the minimum length required. Example: C:\RA\LIGHTCHT\SCREENS\TOOSHORT Excludelist Full path and filename of a file in which you can list users that you do not wish to be paged by. The file is just a plain text file with one name on each line, such as this: Fred Bloggs Joe Smith Andy Cap Example: C:\RA\LIGHTCHT\TWITS.LST Excl. user Full path and filename (excluding extension) of a .ASC/.ANS file which is displayed when someone listed in the [Excludelist] file (see above) tries to page you. Example: C:\RA\LIGHTCHT\SCREENS\EXCLUDE Paging Full path and filename (excluding extension) of a .ASC/.ANS file which is displayed when paging the SysOp. Example: C:\RA\LIGHTCHT\SCREENS\PAGING SysOp busy Full path and filename (excluding extension) of a .ASC/.ANS file which is displayed when the SysOp aborts a page. Example: C:\RA\LIGHTCHT\SCREENS\BUSY Chatting Full path and filename (excluding extension) of a .ASC/.ANS file which is displayed when the SysOp is already chatting to another user. Example: C:\RA\LIGHTCHT\SCREENS\INCHAT 21 No answer Full path and filename (excluding extension) of a .ASC/.ANS file which is displayed when the SysOp does not answer a page. Example: C:\RA\LIGHTCHT\SCREENS\NOANSWER Wrong time Full path and filename (excluding extension) of a .ASC/.ANS file which is displayed when a user attempts to page outside of the defined hours. Example: C:\RA\LIGHTCHT\SCREENS\PAGETIME Max. pages Full path and filename (excluding extension) of a .ASC/.ANS file which is displayed when a user exceeds the maximum number of pages per call (defined by [Maximum pages]). Example: C:\RA\LIGHTCHT\SCREENS\MAXPAGE Excl. warn Full path and filename (excluding extension) of a .ASC/.ANS file which is displayed when a user exceeds the maximum number of pages per call (defined by [Maximum pages]), and AutoExclude has not been disabled. Example: C:\RA\LIGHTCHT\SCREENS\WARNING 3.1.4 Paging This menu lets you configure all LightChat's paging options, including page tunes, pager behaviour and display, reason for chat, and paging hours. 3.1.4.1 General This menu lets you define how LightChat should behave under certain circumstances, and what type of pager to use. 22 Type This defines what sort of sound LightChat should make when a user pages the SysOp. "Tune" refers to the LightChat paging tunes found in your "Page tunes" directory. "None" means LightChat will page you silently. "Beep" indicates that LightChat will produce simple beeps whilst paging. Duration Length of page (in seconds). Maximum pages This field defines how many times the user is allowed to page during each call. It has two functions: 1. If [Auto-excl. pages] (see below) is set to zero, and the user pages more times than this value, the file defined in [Max. pages] will be displayed, and the user will not be allowed to page again. If you do not wish to set a maximum number of pages, this field should be set to zero. 2. If [Auto-excl. pages] (see below) is not set to zero, and the user pages more times than this value, the file defined in [Excl. warn] will be displayed, and the user will be allowed to page again. This is, in effect, the number of pages before the user should be warned about being AutoExcluded. If you so not wish the user to be warned before being AutoExcluded, this field should be set to zero. Auto-excl. pages This field determines how many pages LightChat will allow before a user is automatically added to the excluded user list (defined in [Excludelist]). If you do not wish users to be automatically excluded, this field should be set to zero. This field is ignored if you have not yet registered LightChat. Busy action This defines what action to take if the SysOp is already chatting on another line and a user attempts to page. "Show 'SysOp chatting' file" indicates that the file defined in [Chatting] will be displayed. "Page SysOp anyway" tells LightChat to ignore the fact that the SysOp may already be busy, and pages anyway (good for multi-tasking SysOp's!). 23 Excluded action This defines what action to take if a user listed in the [Excludelist] attempts to page the SysOp. "Show 'User excluded' file" indicates that the file defined in [Excl. user] will be displayed. "Pretend to page (silent)" pages the SysOp as usual, with the exception of no sound being made (so the SysOp is unlikely to respond to the page). Create USERDOES? This defines whether LightChat should create USERDOES.nnn files in the [USERDOES] directory to enable "Who is on-line?" type programs to display what the user is doing. Valid options are "Yes" or "No". Remote beep? This defines whether LightChat should send a beep to the remote (user) terminal whilst paging. Valid options are "Yes" or "No". 3.1.4.2 Display This menu lets you configure how you would like the pager to appear to the user. Display type Defines what type of character LightChat should use for the page progress indicator. Valid options are "Bar" or "Dots". "Dots" prints one '.' character per second during paging, whereas "Bar" displays a 'bar-graph' indicating page progress, using the settings below. Bar length If [Display type] is set to "Bar", this field determines the length of the bar (in characters). Bar position If [Display type] is set to "Bar", this field determines the position of the bar on the screen. Empty colours If [Display type] is set to "Bar", this colour selector will determine what colour the empty page bar will be displayed in. 24 Empty char. This is the character to be used to display an 'empty' page bar. It's colour is defined by the option above. Full colours If [Display type] is set to "Bar", this colour selector will determine what colour the full page bar will be displayed in. Full char. This is the character to be used to display a 'full' page bar. It's colour is defined by the option above. 3.1.4.3 Hours This menu allows you to define what times you are available for paging during the week. Get hours from Defines whether LightChat uses it's own paging hours (see below) or the hours defined in RemoteAccess (obtained from DOOR.SYS). If you use the hours defined in RemoteAccess, you will be able to use the 'Override paging hours' feature from within RemoteAccess. Valid options are "LightChat" or "RA". Monday If [Get hours from] is set to "LightChat", this options lets you define the hours you are available for paging on a Monday. Tuesday If [Get hours from] is set to "LightChat", this options lets you define the hours you are available for paging on a Tuesday. Wednesday If [Get hours from] is set to "LightChat", this options lets you define the hours you are available for paging on a Wednesday. Thursday If [Get hours from] is set to "LightChat", this options lets you define the hours you are available for paging on a Thursday. 25 Friday If [Get hours from] is set to "LightChat", this options lets you define the hours you are available for paging on a Friday. Saturday If [Get hours from] is set to "LightChat", this options lets you define the hours you are available for paging on a Saturday. Sunday If [Get hours from] is set to "LightChat", this options lets you define the hours you are available for paging on a Sunday. 3.1.4.4 Reason for chat This menu lets you configure LightChat's 'reason for chat' feature; whether it's active or inactive, and its appearance on screen. Ask for reason? Defines whether LightChat should prompt the user for a reason before attempting to page the SysOp. Valid options are "Yes" or "No". Minimum length If [Ask for reason?] is set to "Yes", this field defines the minimum number of characters allowed for the user's reason for paging. Maximum length If [Ask for reason?] is set to "Yes", this field defines the maximum number of characters allowed for the user's reason for paging. Position If [Ask for reason?] is set to "Yes", this field determines where the user enters their reason for paging on the screen. Colours If [Ask for reason?] is set to "Yes", this colour selector will determine what colour the reason for paging text will be displayed in. 26 Empty character This is the character to be used to display an 'empty' reason for chat field. It will be used to show an 'empty' field at first, and also if Backspace is pressed whilst editing the reason. It's colour is defined by the option above. 3.1.5 General This menu lets you configure general LightChat system options, such as status bar colours, word-macro triggers, log style, SimuType speed, and which user appears in which window. 3.1.5.1 Random ANSI effects This menu lets you enable and disable a selection of LightChat's animated ANSI effects that are used when loading. LightChat (and LightEdit) will select one of the enabled effects at random, or use a non-animated version if all the effects are disabled. Use Swipe? Defines whether LightChat should use the 'Swipe' effect when loading. This effect 'highlights' the LightChat banner from left to right. Valid options are "Yes" or "No". Use Searchlight? Defines whether LightChat should use the 'Searchlight' effect when loading. This effect 'lights up' the LightChat banner from left to right, and back again. Valid options are "Yes" or "No". Use Jump? Defines whether LightChat should use the 'Jump' effect when loading. This effect highlights each letter in turn and makes them 'jump' up and down again. Valid options are "Yes" or "No". Use Collect? Defines whether LightChat should use the 'Collect' effect when loading. This effect makes each letter in the LightChat banner drop in to place from the top and right of the screen. Valid options are "Yes" or "No". 27 Use Wacky? Defines whether LightChat should use the 'Wacky' effect when loading. This effect randomly changes the colours and case of the letters in the LightChat banner. Valid options are "Yes" or "No". Word-macro triggers Defines which characters typed will trigger word-macros whilst in chat mode (e.g. "() +-=,.?!/*"). Note that the RETURN key is always an active word-macro trigger. Log style Defines the LightChat log file format. Valid options are "Expanded" or "Compact". The logging behaves in a similar way to RemoteAccess logging. Min. SimuType delay Defines the minimum delay between SimuType'd characters (for auto-greetings etc.) appearing on the screen (in milliseconds). Altering this value helps customise your simulated typing speed to fool users. Max. SimuType delay Defines the maximum delay between SimuType'd characters (for auto-greetings etc.) appearing on the screen (in milliseconds). Altering this value helps customise your simulated typing speed to fool users. SysOp window number Defines which window the SysOp should appear in on the local screen. Valid options are "1" or "2". User window number Defines which window the user should appear in on the remote screen. Valid options are "1" or "2". Auto chat capture? Defines whether LightChat should automatically open the chat capture file [Chat log] (defined in System->Filenames), and log the SysOp's and user's type as soon as chat mode is entered. Valid options are "Yes" or "No". 28 Flash key-lights? Defines whether LightChat should flash the keyboard lights in time to the page tune (only applicable if Page type is set to 'Tune'). We highly recommend that you set this option to "No" if you are using a multitasker, otherwise your typing in another window will be affected by Caps Lock being toggled! Valid options are "Yes" or "No". Status bar colours This colour selector will determine what colour the SysOp status bar appears as on the local screen. Separator colours This colour selector will determine what colour the separators on the SysOp status bar appear as on the local screen. 3.1.6 Strings This menu will let you define strings to be shown to the user on certain actions (such as entering the user editor or shelling to DOS), and also let you configure the auto greetings and auto goodbyes. 3.1.6.1 General This menu allows you to define strings to be shown to the user before and after using the built-in user editor or shelling to DOS. User editor entry Defines the message that is shown to the user just before the SysOp enters the user editor. This field can contain data codes (see Section 5.1). Return Defines the message that is shown to the user after the SysOp returns from the user editor. This field can contain data codes (see Section 5.1). DOS shell entry Defines the message that is shown to the user just before the SysOp enters the DOS shell. This field can contain data codes (see Section 5.1). 29 Return Defines the message that is shown to the user after the SysOp returns from the DOS shell. This field can contain data codes (see Section 5.1). 3.1.6.2 Auto greetings This menu lets you configure LightChat's auto greeting feature, and allows you to define up to 5 greetings. Once only? Defines whether or not LightChat should use 'intelligent' auto greetings. If set to "Yes", LightChat will only greet a particular user once during the same call. If set to "No", LightChat will greet the user every time they enter chat. SimuType? Defines whether the automatic greetings should be displayed using SimuType (simulated typing). Valid options are "Yes" or "No". Selection Defines how LightChat should select an automatic greeting. "Timed (use defined hours)" means LightChat will show the relevant greeting during the defined hours (see below). "No auto greetings" means that no automatic greetings will ever be displayed. "Always use Greeting #1" means that LightChat will always display the greeting defined in [Greeting #1] (see below). "Random" means that LightChat will randomly choose a greeting from the available list (see below). Greeting #1 Defines greeting string #1. This field can contain data codes (see Section 5.1). Hours If [Selection] is set to "Timed (use defined hours)", this option allows you to define the hours in which [Greeting #1] will be displayed. Greeting #2 Defines greeting string #2. This field can contain data codes (see Section 5.1). 30 Hours If [Selection] is set to "Timed (use defined hours)", this option allows you to define the hours in which [Greeting #2] will be displayed. Greeting #3 Defines greeting string #3. This field can contain data codes (see Section 5.1). Hours If [Selection] is set to "Timed (use defined hours)", this option allows you to define the hours in which [Greeting #3] will be displayed. Greeting #4 Defines greeting string #4. This field can contain data codes (see Section 5.1). Hours If [Selection] is set to "Timed (use defined hours)", this option allows you to define the hours in which [Greeting #4] will be displayed. Greeting #5 Defines greeting string #5. This field can contain data codes (see Section 5.1). Hours If [Selection] is set to "Timed (use defined hours)", this option allows you to define the hours in which [Greeting #5] will be displayed. 3.1.6.3 Auto goodbyes This menu lets you configure LightChat's auto goodbye feature, and allows you to define up to 5 goodbyes. SimuType? Defines whether the automatic goodbyes should be displayed using SimuType (simulated typing). Valid options are "Yes" or "No". 31 Selection Defines how LightChat should select an automatic goodbye. "Timed (use defined hours)" means LightChat will show the relevant goodbye during the defined hours (see below). "No auto goodbyes" means that no automatic goodbyes will ever be displayed. "Always use Goodbye #1" means that LightChat will always display the goodbye defined in [Goodbye #1] (see below). "Random" means that LightChat will randomly choose a goodbye from the available list (see below). Goodbye #1 Defines goodbye string #1. This field can contain data codes (see Section 5.1). Hours If [Selection] is set to "Timed (use defined hours)", this option allows you to define the hours in which [Goodbye #1] will be displayed. Goodbye #2 Defines goodbye string #2. This field can contain data codes (see Section 5.1). Hours If [Selection] is set to "Timed (use defined hours)", this option allows you to define the hours in which [Goodbye #2] will be displayed. Goodbye #3 Defines goodbye string #3. This field can contain data codes (see Section 5.1). Hours If [Selection] is set to "Timed (use defined hours)", this option allows you to define the hours in which [Goodbye #3] will be displayed. Goodbye #4 Defines goodbye string #4. This field can contain data codes (see Section 5.1). Hours If [Selection] is set to "Timed (use defined hours)", this option allows you to define the hours in which [Goodbye #4] will be displayed. 32 Goodbye #5 Defines goodbye string #5. This field can contain data codes (see Section 5.1). Hours If [Selection] is set to "Timed (use defined hours)", this option allows you to define the hours in which [Goodbye #5] will be displayed. 3.2 Command Macros This menu allows you define various command macros for LightChat. These macros give you total control on how various keys activate the different features of LightChat. Up to 100 command macros can be defined. No. This allows you to select the command macro number you wish to edit from a list. Macros 1-50 are for the SysOp's use, and 51- 100 are for the user. Key Defines the key you wish to activate the command macro. Macro Defines the actual macro string associated with a key defined in [Key] (see above). A summary of available macro strings is displayed on the right hand side of the screen for your convenience. These are explained in full detail in Section 5.2. This field may also contain data codes, which are listed in Section 5.1. Notes This allows you to define a short note or comment associated with the currently selected command macro. 3.3 Word Macros This menu allows you define various word macros. These macros instruct LightChat to automatically replace various words or letter combinations, making them ideal for abbreviations, emotions and complicated phrases. Up to 50 word macros can be defined. No. This allows you to select the word macro number you wish to edit from a list. 33 Find This defines the string which LightChat should check for. This field may contain spaces. Replace This defines the string which LightChat should use to replace the [Find] string (see above) with. This field may contain spaces. Check case? Defines whether the [Find] string (see above) should only be replaced if the case of the letters matches exactly. Valid options are "Yes" or "No". SimuType? Defines whether the [Replace] string (see above) should be SimuTyped (use simulated typing). Valid options are "Yes" or "No". Available to Defines who may use the word macro. "SysOp and user" means that both the SysOp and the user can use the macro. "SysOp only" means that only the SysOp can use the macro. "User only" means that only the user can use the macro. 3.4 Chat Modes 3.4.1 Mode 1 This menu lets you configure LightChat's ASCII chat mode (Mode 1). Screen file Full path and filename (excluding extension) to a .ASC/.ANS file which is displayed when entering flat-chat mode. Example: C:\RA\LIGHTCHT\SCREENS\ASCII SysOp colours This colour selector will determine what colour the text typed by the SysOp in flat-chat mode will be displayed in. User colours This colour selector will determine what colour the text typed by the user in flat-chat mode will be displayed in. 34 3.4.2 Mode 2 This menu allows you to configure the appearance and behaviour of LightChat's ANSI Mode 2. Screen file Full path and filename (including extension) to the .ANS file which is used for this chat mode. Example: C:\RA\LIGHTCHT\SCREENS\HORIZONT.ANS Clock type This defines what type of clock should be used on the main chat screen. Valid options are "12:00 (24hr)", "12:00a (12hr)", "12:00am (12hr)" or "12:00AM (12hr)". Flash? Defines whether the ":" in the clock should flash every second. Valid options are "Yes" or "No". Position This field determines the position of the clock on the screen. Colours This colour selector will determine what colour the clock will be displayed in. Date type This defines what type of date should be used on the main chat screen. Valid options are "30-01-95", "01-30-95", "30 Jan 1995", "Jan 30 1995", "30 January 1995", "January 30 1995", "Monday 30 January 1995" or "Monday January 30 1995". Position This field determines the position of the date on the screen. Colours This colour selector will determine what colour the date will be displayed in. Window 1 colours This colour selector will determine what colour the text that appears in window 1 will be displayed in. 35 Boundaries This field determines the on-screen borders of the chat window 1. The first co-ordinates are for the top left corner, and the second ones are for the bottom right corner. Scroll lines Defines the number of lines the text within a window should scroll up when the cursor reaches the bottom. Name position This field determines the position of the window owner's name on the screen. Max. name len. Defines the maximum length of the window owner's name which will be displayed. If the actual name is longer than this figure, the name will be truncated. Line buffer Defines the number of lines that LightChat should buffer for this window. This is used for scrolling back to previously typed text. Windows 2 colours This colour selector will determine what colour the text that appears in window 2 will be displayed in. Boundaries This field determines the on-screen borders of the chat window 2. The first co-ordinates are for the top left corner, and the second ones are for the bottom right corner. Scroll lines Defines the number of lines the text within a window should scroll up when the cursor reaches the bottom. Name position This field determines the position of the window owner's name on the screen. 36 Max. name len. Defines the maximum length of the window owner's name which will be displayed. If the actual name is longer than this figure, the name will be truncated. Line buffer Defines the number of lines that LightChat should buffer for this window. This is used for scrolling back to previously typed text. 3.4.3 Mode 3 This menu allows you to configure the appearance and behaviour of LightChat's ANSI Mode 3. Please refer to Section 3.4.2. 3.4.4 Mode 4 This menu allows you to configure the appearance and behaviour of LightChat's ANSI Mode 4. Please refer to Section 3.4.2. 3.5 Message Editor This menu lets you configure options for LightChat's message-to-SysOp feature, such as its appearance, behaviour, and the conditions under which it can be used. 3.5.1 General This menu allows you to configure general message-to-SysOp options, such as the message base type, path, and the message recipient. Message type Defines what type of message base LightChat should post a message in. Valid options are "HMB" (Hudson message base) or "JAM". 37 HMB board no./JAMbase path This option changes depending on the setting of [Message type] (see above). It defines the HMB board number (1- 200) or the path of a JAMbase in which the message to SysOp should be posted. If defining a JAMbase path, you should enter the full path and basename of the JAMbase, without any extension. Word-macros? Defines whether LightChat's word-macros can be used in the message editor. Valid options are "Yes" or "No". Add tearline? Defines whether LightChat should append a tearline to the message to SysOp. Valid options are "Yes" or "No". If you have not yet registered LightChat, a tearline will be added to the message, regardless of the setting of this option. Msg. buffer Defines the capacity of the message to SysOp (in number of lines). The user will not be able to write any more when this maximum has been reached. Addressee Defines whether the message should be addressed to the current SysOp name (which may be the SysOp's, or a co- SysOp's if they have answered the page), or to an alternative name that you can define in [Other] (see below). Valid options are "SysOp" or "Other". Other name If [Addressee] (see above) has been set to "Other", this field determines the alternative name that the message should be addressed to. 3.5.2 Conditions This menu lets you configure the conditions under which LightChat will ask the user if they wish to leave a message. 38 Excluded user Defines whether LightChat should ask the user if they wish to leave a message when they have been barred from paging (i.e. their name appears in the file defined by [Excludelist]). Valid options are "Yes" or "No". Note: If you change this setting, you should also add or remove the 'Leave message to SysOp?' question, as applicable, from the screens defined in [Excl. user]. Out of hours Defines whether LightChat should ask the user if they wish to leave a message when they have paged out of the defined hours. Valid options are "Yes" or "No". Note: If you change this setting, you should also add or remove the 'Leave message to SysOp?' question, as applicable, from the screens defined in [Wrong time]. Unanswered page Defines whether LightChat should ask the user if they wish to leave a message when their page has not been answered. Valid options are "Yes" or "No". Note: If you change this setting, you should also add or remove the 'Leave message to SysOp?' question, as applicable, from the screens defined in [No answer]. SysOp abort Defines whether LightChat should ask the user if they wish to leave a message when the SysOp has aborted the page by pressing Escape. Valid options are "Yes" or "No". Note: If you change this setting, you should also add or remove the 'Leave message to SysOp?' question, as applicable, from the screens defined in [SysOp busy]. User abort Defines whether LightChat should ask the user if they wish to leave a message when the user has aborted the page by pressing CTRL-K. Valid options are "Yes" or "No". 39 SysOp chatting Defines whether LightChat should ask the user if they wish to leave a message when the SysOp is chatting to a user on another node. Valid options are "Yes" or "No". Note: If you change this setting, you should also add or remove the 'Leave message to SysOp?' question, as applicable, from the screens defined in [SysOp chatting]. 3.5.3 Screen This menu allows you to configure the appearance of the message editing screen. Screen file Full path and filename (including extension) to the .ANS file which is used for the message editor screen. Note: No screen is provided for ASCII users. Example: C:\RA\LIGHTCHT\SCREENS\HORIZONT.ANS Window bounds This field determines the on-screen borders of the message editing window. The first co-ordinates are for the top left corner, and the second ones are for the bottom right corner. Scroll lines Defines the number of lines the text within a window should scroll up when the cursor reaches the bottom. To: position This field determines the position of the user's name on the screen. Subject: position This field determines the position of the message subject on the screen. Subject length Defines the maximum allowed length of the message subject. This should be set to the maximum amount of space you have allowed in your configurable ANSI screen for the message subject. LightChat will not allow the user to enter a subject longer than this value. 40 Header colours This colour selector will determine what colour the text in the message header (user's name, and message subject) will be displayed in. Message colours This colour selector will determine what colour the message text will be displayed in. LightBar colours This colour selector will determine the colour of deselected options in a LightBar menu. LightBars are used when asking the user if they wish to leave a message, and when displaying the menu from the message editor. Highlighted This colour selector will determine the colour of selected (highlighted) options in a LightBar menu. Clock type This defines what type of clock should be used on message editing screen. Valid options are "12:00 (24hr)", "12:00a (12hr)", "12:00am (12hr)" or "12:00AM (12hr)". Flash? Defines whether the ":" in the clock should flash every second. Valid options are "Yes" or "No". Position This field determines the position of the clock on the screen. Colours This colour selector will determine what colour the clock will be displayed in. 3.5.4 Command Macros This menu allows you define various command macros for use with the message editor, LightEdit. These macros give you total control on how various keys activate the different features of LightEdit. Up to 50 command macros can be defined. 41 No. This allows you to select the command macro number you wish to edit from a list. All macros apply to both the SysOp and user, but certain functions (such as Shell-to-DOS) can only be used by the SysOp. Key Defines the key you wish to activate the command macro. Macro Defines the actual macro string associated with a key defined in [Key] (see above). A summary of available macro strings is displayed on the right hand side of the screen for your convenience. These are explained in full detail in Section 5.2. This field may also contain data codes, which are listed in Section 5.1. Notes This allows you to define a short note or comment associated with the currently selected command macro. 3.6 Registration This menu allows you to enter your registration name and key if you have registered, which will enable you to gain access to the registered-only features of LightChat. Registered to This field should contain your personal LightChat registration string, exactly as it was given to you by Lightning Software. Leave blank if you have not yet registered LightChat. Key This field should contain your personal LightChat registration key number. Leave blank if you have not yet registered LightChat. 3.7 Information This option will display some general information about LightChat, including version number, copyright, and the compiler used. 42 3.8 Exit to DOS This option will exit LCSETUP and return to DOS. Before exiting, LCSETUP will check if you have made any changes, and if so, ask you whether you wish to save them. If you wish to temporarily shell to DOS at any time whilst using LCSETUP, you may do so by pressing ALT-Z. 43 4 LIGHTCHT LIGHTCHT.EXE is the main chat program itself, that will be loaded when you invoke LightChat or a user pages you. 4.1 Command line parameters LIGHTCHT.EXE accepts several parameters: /L Run LightChat in local test mode. /E Switch LightChat into "LightEdit" mode. /F Jumps straight into chat without paging. /A1 Use name defined in [Alternative name #1]. /A2 Use name defined in [Alternative name #2]. /A3 Use name defined in [Alternative name #3]. /M1 Forces LightChat into ASCII Chat Mode 1. /M2 Forces LightChat into ANSI Chat Mode 2. /M3 Forces LightChat into ANSI Chat Mode 3 (registered version only). /M4 Forces LightChat into ANSI Chat Mode 4 (registered version only). /MR Selects an ANSI Chat Mode at random (registered version only). This parameter is ignored if the user's terminal does not support ANSI. /Nn Specifies that LightChat is running on Node 'n'. /Pp Specifies that LightChat should use port 'p'. /Bb Specifies that the caller is logged on at 'b' baud rate. The /N, /P, and /B parameters are entirely optional, but are REQUIRED if you wish LightChat's intelligent "logon" mode (see Section 4.2.2) to function correctly. The /A parameter is used to set LightChat to use a name other than the SysOp's. This parameter is overridden if one of the alternative SysOp name keys is used to answer a page. For example, if you wished to go straight into a random chat mode, using the name defined in [Alternative name #1], you might use the following command line from RemoteAccess: C:\RA\LIGHTCHT\LIGHTCHT.EXE /F /A1 /MR *! *M The *! and *M parameters are interpreted by RemoteAccess, and are not passed to LightChat - see your RemoteAccess documentation for more details. 44 4.2 Operation 4.2.1 Paging During the paging process, you will hear a beep or a tune (depending on your configuration), and will see some form of progress, either as dots or in the form of a bar-graph. During this period, you may decide to abort the page, answer it, or ignore it. If the user has been prompted for a reason for chat, that reason will be shown along with their name, on the status bar. You may use the 'rotate status bar' macro keys to find out further details about the user before deciding how to deal with the page request. Aborting: To abort the page, simply press Escape. The user will then be shown the screen defined in [SysOp busy]. Answering: If you wish to use a name other than the SysOp's, you should press the associated 'chat key' you have defined for that name in System->Names. Otherwise, you should press any key (other than Escape), and you will enter chat mode, with the SysOp's name (or an alternative name, if one was passed on the command line). Ignoring: You may wish to simply ignore the user's page, in which case, they are shown the screen defined in [No answer], and may be offered the opportunity of leaving a message instead, if you have configured LightChat to do so. LightChat has a 'silence' key that you can use when you do not want to be disturbed; if Scroll-Lock is on during the paging process, no sound will be made. 4.2.2 Intelligent "logon" mode This is a special feature unique amongst RemoteAccess chat programs. With other programs, if you break into chat with a user who hasn't yet entered their name, or is in the middle of the new user procedure, one of two things will usually happen: 1) The program will report that EXITINFO.BBS is missing, and not run. 2) The program will run, but have the previous caller's name and details! 45 There is a reasonable explanation for this behaviour; RemoteAccess does not create a DOOR.SYS and EXITINFO.BBS file for the user until they have fully logged on. The problem is that there can be an OLD DOOR.SYS file present, and the chat program can use the details from there instead. This is simply frustrating, rather than disastrous, but of course, it can mean that the chat program thinks the user has ANSI capabilities when in fact they do not. LightChat, however, has the capability of recognising when a user is still logging on, and will behave accordingly. If it detects that a user has not yet logged on properly, it will try and find as much information about the user from alternative sources. For instance, if the user has entered their name, and is in the middle of the new user procedure, LightChat will be able to use their name, perform an AutoGreeting if configured, and will assume ASCII mode. If they have not even entered their name when you break into chat, LightChat will suppress AutoGreetings and enter ASCII mode. You will see "Someone from Somewhere" on the status bar, as the user has not yet entered a name or location. IMPORTANT NOTE: To make use of this feature, you MUST use the /P, /N, and /B parameters (see Section 4.1), which "logon" mode uses to ascertain whether or not DOOR.SYS is a reliable source of information. 4.2.3 Using AutoExclude AutoExclude is a facility (available only if you have registered LightChat) which enables you to automatically bar users from paging you by adding their names to the 'exclude' list; careless configuration can lead to unexpected results and baffled users. The [Maximum pages] and [Auto-excl. pages] fields in System->Paging->General are closely linked. The following table illustrates the relationship between them. 46 ┌───────────────┬──────────────────┬───────────────────────────┐ │ Maximum pages │ Auto-excl. pages │ Action │ ├───────────────┼──────────────────┼───────────────────────────┤ │ 0 │ 0 │ User can page the SysOp │ │ │ │ indefinitely. │ ├───────────────┼──────────────────┼───────────────────────────┤ │ 3 │ 0 │ User can page the SysOp 3 │ │ │ │ times. If they page again,│ │ │ │ the file [Max. pages] │ │ │ │ (defined in │ │ │ │ System->Filenames) is │ │ │ │ shown. │ ├───────────────┼──────────────────┼───────────────────────────┤ │ 0 │ 5 │ On the 5th page, the user │ │ │ │ will be automatically │ │ │ │ added to the exclude list │ │ │ │ (defined in │ │ │ │ System->Filenames) without│ │ │ │ any warning. │ ├───────────────┼──────────────────┼───────────────────────────┤ │ 2 │ 5 │ After 2 pages, the user │ │ │ │ will be shown the file │ │ │ │ [Excl. warn] (defined in │ │ │ │ System->Filenames), but │ │ │ │ will still be allowed to │ │ │ │ page the SysOp. On the │ │ │ │ 5th page, the user will be│ │ │ │ automatically added to the│ │ │ │ exclude list (defined in │ │ │ │ System->Filenames). │ └───────────────┴──────────────────┴───────────────────────────┘ 4.2.4 Customising screens One of the major advantages LightChat has over its competitors is that, once registered, all its screens are completely configurable (when unregistered, you cannot customise the reason for chat screen), so you are not forced to have the program and author's name all over each screen, as is often the case with other programs. LightChat will always attempt to display a custom screen if one is defined, but for every customisable screen there is some plain text that will be shown instead, if no screen is defined or for some reason the screen cannot be displayed. When designing your own screens, remember that you might want to create two versions, one in ANSI (ending in .ANS), and the other in ASCII (ending in .ASC). You should also remember to avoid using the 80th column and the 2 bottom rows (rows 24-25) of the screen, as these are liable to make the screen scroll on remote terminals due to status bars etc. 47 If you are using TheDraw to design your screens, it is best, though not essential, to save the screens in 'animation mode'. You should pay particular attention to the Message Editor configuration when designing certain screens, as the conditions you have set in Message Editor->Conditions will affect what you need to put in some of the screens: When LightChat asks the user if they wish to leave a message, it only displays the question itself if no screen was defined or the screen could not be found. For instance, if you have configured LightChat to allow the user to leave a message when no-one answers the page, you should have an appropriate question in [No answer] (defined in System->Filenames). LightChat will wait for 'y', 'n', or Return to be pressed after showing this screen, so if you haven't asked the question in the appropriate screen, it will be confusing for the user. Remember that if you change the conditions under which LightChat will allow the user to leave a message, you should also change the appropriate screen. 4.2.5 Default Operation and Keys Unlike many programs, LightChat's operation is almost totally configurable, right down to the behaviour of individual keypresses! Of course, you may not want to have to configure so many things, so LightChat is distributed with a default configuration file and command-macro file. During the beta-testing process, these defaults have been changed regularly to make them as intuitive and 'ready-to-run' as possible. Everything is already configured for you, so if you don't have the time, or are happy with the way LightChat works, then you need never worry about changing anything. On the other hand, the option is always there to customise as little or as much of LightChat as you like. For your convenience, the default macro-commands and their keys for LightChat are listed below: Key: SysOp: User: Action: ─────────────────────────────────────────────────────────────── Backspace Yes Yes Delete character to the left. Enter Yes Yes New line. Delete Yes Yes Delete character to the right. Home Yes Yes Go to start of line. 48 End Yes Yes Go to end of line. Left Yes Yes Left one character. Right Yes Yes Right one character. Up Yes Yes Up one line. Down Yes Yes Down one line. PgUp Yes Yes Up one page. PgDn Yes Yes Down one page. Insert Yes Yes Toggle insert/overtype mode. Control-W Yes Yes Clear window. Control-O Yes No Clear other window. Control-Y Yes Yes Delete line. Control-G Yes Yes Beep. Control-R Yes Yes Redraw screen. Alt-Z/Alt-J Yes No Shell to DOS. F1 Yes Yes Chat mode 1. F2 Yes Yes Chat mode 2. F3 Yes Yes Chat mode 3. F4 Yes Yes Chat mode 4. Escape Yes Yes Exit LightChat. Control-S Yes Yes Swap to other window. Control-F Yes No Freeze user input. Alt-H Yes No Hang-up user. Alt-L Yes No Lockout user. Alt-E Yes No Edit user's details. Control-Left Yes No Rotate status bar left. Control-Right Yes No Rotate status bar right. Control-L Yes No Log chat buffer to file. 49 F5 Yes No (Sample macro #1) - Types message to user and freezes them. F6 Yes No (Sample macro #2) - Types message to user. ─────────────────────────────────────────────────────────────── Additionally, there is a separate set of macro-commands for LightEdit, the built-in message editor. These macro-commands are the same when LightEdit is working in stand-alone mode as they are when working after a failed page request. For your convenience, the default macro-commands and their keys for LightEdit are listed below: Key: Action: ─────────────────────────────────────────────────────────────── Backspace Delete character to the left. Enter New line. Delete Delete character to the right. Home Go to start of line. End Go to end of line. Left Left one character. Right Right one character. Up Up one line. Down Down one line. PgUp Up one page. PgDn Down one page. Insert Toggle insert/overtype mode. Control-Y Delete line. Control-R Redraw screen. Alt-Z/Alt-J Shell to DOS. Escape Display message menu. Alt-S/Control-S/Control-Z Save message immediately. Control-F Freeze user input. 50 Alt-H Hang-up user. Alt-L Lockout user. Control-Left Rotate status bar left. Control-Right Rotate status bar right. ─────────────────────────────────────────────────────────────── 51 5 Appendices 5.1 Data Codes Data codes are provided in LightChat to allow you to include variable information in screens, system messages etc., such as the user's name and the system node number. A data code consists of Ctrl-K (ASCII 11) followed by one of the following letters: a User's first name. b User's surname. c Node number user is on. d User's location. e Full name of other user SysOp is chatting to. f Node number other user is on. g Other user's location. Note: e, f and g are only set if the SysOp is already chatting to another user. n New line (CR, LF). Two other data codes are available that do not need to be preceded by Ctrl-K. These are: Ctrl-A (ASCII 1) Waits for the ENTER key to be pressed. Ctrl-W (ASCII 23) Pauses for 1 second. These two codes are the same as those used by RemoteAccess. Note: To enter data codes into LCSETUP, it is necessary to enter a literal character. This is achieved by pressing CTRL-P before the character you wish to enter. Example #1: (entering code to show user's first name) Type CTRL-P followed by CTRL-K followed by 'a'. The characters 'a' should have appeared. Example #2: (entering the 'wait for ENTER to be pressed' code) Type CTRL-P followed by CTRL-A. The character '' should have appeared. 52 5.2 Macro Commands All of LightChat's in-chat features are accessed through macro commands, which are completely configurable, enabling you to group text and/or data codes with one or more actions, assign them to a key of your choice, and specify whether or not they may be used by the user. LCSETUP provides an on-screen list of mnemonics to help you remember which macro commands provide which action, but all of them are detailed here in full. A macro command consists of the Escape character (ASCII 27) followed by another character (which determines the macro function). For example, the macro command for 'Backspace' is 'a'. Note: To enter macro commands into LCSETUP, it is necessary to enter a literal character. This is achieved by pressing CTRL-P before the character you wish to enter. Example: (entering code to activate Backspace) Type CTRL-P followed by Escape followed by 'a'. The characters 'a' should have appeared. Mnemonic: Description: Purpose: ──────────────────────────────────────────────────────────────────── BACK Backspace Deletes one character to the left of the cursor, or moves to the line above if used at the start of a line. CRLF New line Inserts a new line at the current cursor position. DEL Delete Deletes one character to the right of the cursor. HOME Start of line Moves the cursor to the start of the current line. EOL End of line Moves the cursor to the end of the current line. LEFT Left one character Moves the cursor one character to the left. RIGHT Right one character Moves the cursor one character to the right. UP Up one line Moves the cursor up one line, scrolling if necessary. DOWN Down one line Moves the cursor down one line, scrolling if necessary. 53 PGUP Up one page Scrolls the screen up one whole page length. PGDN Down one page Scrolls the screen down one whole page length. INS Insert/overtype Switches between insert and overtype editing mode. SAVE Save message Saves the message immediately and exits LightEdit. Not available in chat modes. CLRW Clear window Clears the window you are currently in. This command adds a new line to the end of the chat buffer if necessary. Not available in message editor. CLROW Clear other window Clears the window the other user is currently in. This command adds a new line to the end of the chat buffer if necessary. Not available in message editor. DELLN Delete line Deletes an entire line in the current window, pulling text from below up if necessary. BEEP Beep Sends a beep to the remote terminal and makes a sound on the local machine. Not available in message editor. REDRW Redraw screen Clears and redraws the screen. DOS Shell to DOS Sends configurable message to user (defined in System->Strings->General), attempts to swap LightChat out to EMS or XMS, and invokes a temporary DOS session. On return, another configurable message is sent to the user (to say you have returned, for example). This command can only be invoked by the SysOp. MODE1 Chat mode 1 Switches to ASCII chat mode 1. If unregistered, this command can only be invoked by the SysOp. Not available in message editor. 54 MODE2 Chat mode 2 Switches to ANSI chat mode 2. If unregistered, this command can only be invoked by the SysOp. Not available in message editor. MODE3 Chat mode 3 Switches to ANSI chat mode 3. Not available in message editor. MODE4 Chat mode 4 Switches to ANSI chat mode 4. Not available in message editor. QUIT Quit Exits LightChat, after issuing auto goodbye, if active. If unregistered, this command can only be invoked by the SysOp. MENU Message menu Displays the LightEdit message editor menu. SWAP Swap window Switches to other chat window. If this command is used a second time, it switches back to the original chat window. Not available in message editor. FREEZ Freeze user Temporarily 'freezes' user by ignoring anything typed by them. If this command is used a second time, the user is then 'unfrozen'. This command can only be invoked by the SysOp. HANG Hang-up user Disconnects the user directly by hanging up the modem. LOCK Lockout user Sets the user's security level to zero, then behaves the same as the 'HANG' macro (see above). USRED User editor Sends configurable message to user (defined in Systems->Strings->General), enters LightChat's internal user editor, then sends another configurable message upon return. The user editor is only available if EXITINFO.BBS was found when LightChat loaded. This command can only be invoked by the SysOp. Not available in message editor. 55 LOG Log chat Opens the chat capture file (defined in System->Filenames), and logs user's typing from start of chat buffer until capture file is closed (achieved by using this macro a second time). Not available in message editor. STATL Status bar left 'Rotates' the status bar left, to show extended information about the user. Extended information is only available if EXITINFO.BBS was found when LightChat loaded. This command can only be invoked by the SysOp. STATR Status bar right 'Rotates' the status bar right, to show extended information about the user. Extended information is only available if EXITINFO.BBS was found when LightChat loaded. This command can only be invoked by the SysOp. ──────────────────────────────────────────────────────────────────── 5.3 Errorlevels LightChat and LightEdit return certain errorlevels indicating the user's behaviour, system errors, etc. A list of the errorlevels and their meaning is provided below: Errorlevel Meaning 0 Normal exit, no error. 1 Aborted message (LightEdit). 2 User out of time (LightEdit). 3 Insufficient memory to run LightChat. 4 No fossil driver was loaded. 5 Configuration file not found; run LCSETUP. 6 Corrupt configuration file. 7 Command macro file not found. 8 Corrupt command macro file. 9 New (unrecognised) configuration file. 10 Old configuration file; run LCSETUP to import. 11 Corrupt database file; LIGHTCHT.UDB needs deleting. 12 Carrier lost. 13 Error writing message to messagebase. 14 Error opening MSGINF file (LightEdit). 15-28 Reserved for future use. 29 Invalid LightChat beta authorisation. 30 Excluded user was refused paging access. 31 User had exceeded the maximum number of pages per call. 32 User tried to page out of defined hours. 56 33 Reason for chat was too short. 34 The page was not answered. 35 User aborted the page. 36 SysOp aborted the page. 37 User told that the SysOp is chatting to another user. 38 SysOp disconnected the user. 39 SysOp locked out the user. 40 User left a message. 57 6 Credits * LightChat and the LCSETUP configuration utility were written by David McGarry. * LightChat uses the EXEC v3.3b swapping routines, written by Thomas Wagner. * All the executables were compiled using Borland C++ v3.1. * The LightChat User Guide was written by Marcel Cook and David McGarry. * The cover and LightChat logo (printed version only) were created by Gordon Finlay. * LightChat distribution, registration and support services are provided by Marcel Cook. * Testing, evaluation and suggestions are provided by the Lightning Software beta team. Thanks to: Marcel Cook, Michael Rallings, Adrian Thomas, Mike Ehlert, Frank Schittek. * All executables and documentation contained in the LightChat distribution archive are Copyright (C) 1994-1995 Lightning Software; All rights reserved. * All other products mentioned are copyrighted material and/or trademarks of their respective owners. 58 7 Support and Information If you need help, information or technical support, please contact us by using one of the methods listed below: Post: Lightning Systems BBS: Lightning BBS (Cambridge) PO Box 123 [+44] 01954-212231 (H16/V.FC/V.34) CAMBRIDGE [+44] 01954-212232 (H16/V.FC/V.34) CB3 8AR UNITED KINGDOM Lightning BBS (London) [+44] 0181-863-7623 (H16/V.FC/V.34) CompuServe: 100545,3045 Internet: lsoft@lbbs.demon.co.uk FidoNet: Marcel Cook @ 2:2504/100 David McGarry @ 2:254/262 59