Monster Media 1994 #1

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

/ Monster Media 1994 #1 / monster.zip / monster / OS2 / PCONF180.ZIP / PHTCONF.DOC < prev next >

Wrap

Text File | 1994-02-01 | 30KB | 801 lines

╔══════════════════════════════════════════════════════════════╗ ║ ║ ║ Phantom Tele-Conference System ║ ║ Version 1.72 Documentation ║ ║ ║ ╟──────────────────────────────────────────────────────────────╢ ║ ║ ║ ┌───────┐ ┌───────┐ ┌───────┐ ┌───────┐ ║ ║ │ │ │ │ │ │ │ │ ║ ║ │ Node1 │/\/\/\│ Node2 │/\/\/\│ Node3 │/\/\/\│ Node4 │ ║ ║ │ │ │ │ │ │ │ │ ║ ║ └─╥╥╥╥╥─┘ └─╥╥╥╥╥─┘ └─╥╥╥╥╥─┘ └─╥╥╥╥╥─┘ ║ ║ ┌──╨╨╨╨╨──┐ ┌──╨╨╨╨╨──┐ ┌──╨╨╨╨╨──┐ ┌──╨╨╨╨╨──┐ ║ ║ └─────────┘ └─────────┘ └─────────┘ └─────────┘ ║ ║ ║ ║ PHTConf, a multi-user tele-conference door that supports ║ ║ up to 256 users online at once. COM ports 0-255 are all ║ ║ supported. A fossil driver is not needed but you may use ║ ║ one if you wish. 32000 local users supported for use on ║ ║ a network. Personal BIOs, and action commands supported ║ ║ as well as sysop commands. ║ ║ ║ ╟──────────────────────────────────────────────────────────────╢ ║ ║ ║ PHTConf is a registered trademark of Phantom Software ║ ║ Copyright 1994, All Rights Reserved ║ ║ This documentation Copyright 1994, Brian A. Altenpohl ║ ║ ║ ╟──────────────────────────────────────────────────────────────╢ ║ ║ ║ Phantom Software ║ ║ 17 Van Order Drive #6-301 ║ ║ Kingston, Ontario K7M-1B5 ║ ║ FidoNet: 1:249/1 ║ ║ ║ ╚══════════════════════════════════════════════════════════════╝ This manual may be freely copied and distributed in its original form. Distribution of modified copies shall be considered copyright infringement. This document is the user manual for Phantom Conference. This material is distributed on "as-is," without warranty of any kind, either expressed or implied. Neither Phantom Software nor the author shall be held liable to the user or any other person or entity with respect to any liability, loss, or damage caused or alleged to be caused directly or indirectly by this manual. This manual is 14 pages in length. TABLE OF CONTENTS Introduction ............................................ Page 3 Installing PHTConf ...................................... Page 3 Installing RAM Disks .................................... Page 4 Example Batch Files ..................................... Page 4 Command Line Parameters ................................. Page 4 Alias Definition ................................... Page 5 Baud Rate .......................................... Page 5 COM Port ........................................... Page 5 Time Slicing ....................................... Page 5 DOOR.SYS Support ................................... Page 5 ANSI Graphics Default .............................. Page 5 Skip Port Initialization ........................... Page 5 Local Login ........................................ Page 5 Node Definition .................................... Page 6 Opus/Avatar Graphics Default ....................... Page 6 Non-Paying User Definition ......................... Page 6 Real Name Definition ............................... Page 6 Time Limit Definition .............................. Page 6 Access Level Definition ............................ Page 6 Network Option ..................................... Page 6 Command Mode ............................................ Page 7 Sysop Commands .......................................... Page 9 User To User Chat ....................................... Page 11 Conference Information .................................. Page 11 Local Networks .......................................... Page 12 Action Commands ......................................... Page 13 Software Licence Agreement .............................. Page 14 1.0 - Conditions ................................... Page 14 1.1 - Hobby Systems ................................ Page 14 1.2 - Commercial Systems ........................... Page 14 1.3 - Government Systems ........................... Page 14 1.4 - Educational Systems .......................... Page 14 2.0 - Liability .................................... Page 15 2.1 - Improvements ................................. Page 15 2.2 - Warranty On Media ............................ Page 15 2.3 - Software Support ............................. Page 15 2.4 - Registration ................................. Page 15 2.5 - Distribution ................................. Page 15 Acknowledgements ........................................ Page 16 INTRODUCTION Phantom Conference, otherwise known as PHTConf is a multi-user BBS door. This door will allow the users to talk (type) to each other, among other things. PHTConf offers a system operator the ability to allow users to conference, conduct private chats one-on- one, and much more. PHTConf is designed to run under DESQview, but can be run directly from a DOS prompt. Detailed descriptions on how to run PHTConf is explained later in this manual. INSTALLING PHTCONF PHTConf is a disk access demanding software product. It is advised that you install PHTConf to your hard drive, and have PHTConf copied to a RAM disk when your system boots up. You should then have your system backup the PHTConf data files (*.PHT) from the RAM drive to your hard disk, during the system maintenance. Information on installing RAM disks is explained later in this manual. Example batch files are also explained. To install PHTConf onto your hard-disk, enter the distribution diskette into your floppy drive, and run the program called INSTALL.EXE. If you inserted the distribution diskette into your A: drive, type: A:\INSTALL from your DOS prompt. If you inserted the distribution diskette into your B: drive, type: B:\INSTALL from your DOS prompt. Once you are in the installation utility, follow the prompts, and the installation utility will do the rest. After you have completed the installation, you can proceed to setup PHTConf as a door for your BBS, or put it in a local commands directory on your network. If you are installing PHTConf to be run over a local network, and you are not using any Remote terminals, please see the section on LOCAL NETWORKS. INSTALLING RAM DISKS MS-DOS comes with a RAM-DISK driver. To install a RAM-DISK using MS-DOS's driver, insert the following line into your CONFIG.SYS file that is located in your root directory. DEVICE=C:\DOS\RAMDRIVE.SYS 1000 512 1024 /E The above line will create a RAM-DISK with 1000k, sector size of 512, and maximum directory entries of 1024. You may modify the parameters for the RAM-DISK to suit your needs. A 500k RAM-DISK, is plenty for most systems. EXAMPLE BATCH FILES To move the files from your hard drive to the RAM-DISK upon your system boot up, you may want to insert the following lines into your AUTOEXEC.BAT file that is located in your root directory. COPY C:\PHTCONF\PHTCONF.EXE D:\PHTCONF.EXE COPY C:\PHTCONF\*.PHT D:\*.PHT This is to assume that your RAM-DISK is drive D:, and that you installed PHTConf on your C: drive, using the default path in the installation utility. To backup all of PHTConf's data file when doing system maintenance, you may want to make a batch file like the following. @ECHO OFF ECHO Backing up PHTConf data files, please wait... COPY D:\PHTCONF.PHT C:\PHTCONF\*.PHT ECHO Conference data-files backed up... This is to assume that your RAM-DISK is drive D:, and that you installed PHTConf on your C: drive, using the default path in the installation utility. COMMAND LINE PARAMETERS PHTConf has several command line parameters that you can call using a BBS, or directly from the command line. PHTConf was designed mainly for BBS usage, but can be run over a local network. The command line parameters pass important information to PHTConf, to assure that everything runs correctly. The command line parameters that PHTConf uses are as follows: /a=user's alias This is used to specify the user's alias that is used in the tele-conference. /b=baud rate This is used to specify the user's baud rate. This is more important when running PHTConf from a BBS, or remote node. /c=COM port This is used to tell PHTConf what COM port the user is on. This is only necessary when running PHTConf from a BBS, or remote node. Valid COM ports are in the range from 0-255. COM0 is considered a local login. The COM port is specified as a numeric, where (1=COM1, 2=COM2, etc). /d This option will turn OFF DESQview & multi-tasking time sharing routines. /f=PATH\FILENAME This option is used to tell PHTConf where to find DOOR.SYS. This file is dropped by many popular BBS programs. When you specify a DOOR.SYS file you will not need to specify any of the other parameters, other than a possible /l to define that it is a local node, but this many not be needed, depending on the DOOR.SYS file. PATH\FILENAME refers to the full path and filename for the DOOR.SYS file. /g This is used to specify that ANSI is to be used. When in local mode, colour is always on. /i This is used to prevent PHTConf from initializing the specified port, incase the port has already been initialized, and you want to avoid conflicts. /l This is used to specify that the user is running on a local terminal. This is to be used for local sysops, and for users who are on a local network. /n=Node# This parameter is a must unless a DOOR.SYS file is specified. Node numbers range from 0-32000. /o This is used to specify that OPUS/AVATAR is to be used. When in local mode, colour is always on. /p=Chats This parameter is used to tell PHTConf that the user is a non-paying user, and it also defines the number of times that the user may talk in the conference before re-entering. /r=RealName This is used to define the users real name. The real name is used for data- files. /t=minutes This is used to define how many minutes the user is allowed in the conference. /u=access level This is used to define the user's access level in the conference. A level of 100 or greater is considered sysop/conference moderator. /z This is used to denote that the system is running on a network. Without this option defined, the user to user chat will not operate. PHTConf will not allow extended ASCII characters in the user's alias. This is to make it fair to those users who do not know how to access the extended characters. It makes it rather frustrating for novice computer users to use some of the conference functions, such as whispering, when the novice has no idea how to type the other user's alias. Here are a few examples on how to load PHTConf from the command line: PHTCONF /f=C:\BBS\DOORS\DOOR.SYS This will load the tele-conference using the information in door.sys file located in C:\BBS\DOORS. PHTCONF /c=0 /n=1 /a=JoDoe /r=John /t=60 /u=50 /l This will load the tele-conference in local mode, on node 1, with a time limit of 60 minutes, with a user level of 50. An alias, and real name are also defined. PHTCONF /c=16 /n=16 /a=JoDoe /r=John /t=50 /u=50 /g /p=5 /b=14400 This will load the tele-conference in remote mode, COM 16, Node 16, with a time limit of 50 minutes, a user level of 50, ANSI graphics on, and a maximum chats of 5. The baud rate will be set to 14,400 baud, and an alias, and real name are defined. PHTCONF /c=4 /n=10 /a=JoDoe /t=30 /u=100 /b=9600 This will load the tele-conference in remote mode, COM 4, Node 10, with a time limit of 30 minutes. The user will have full moderator/sysop access in the conference, and both the real name, and UserID of the user will be set to JoDoe. The baud rate for the port will be set at 9600 baud. COMMAND MODE When a user first enters the conference and a bunch of information is displayed, the user will be sent to command mode. In command mode, the user may either type a line to send to everyone else in the conference, or perform an action, or a command. Valid commands are as follows, and are all initiated with a forward slash. Away Bio Bios Cls Current Exit Echo Forget Help Join List Main Pref Remember Time Topic Version The breakdown and explanation of the commands follow. Command: Away Usage: /Away This command is used to avoid being terminated by the in-activity checking routine. Users may use this when they have to step away from their terminal for longer than 3 minutes. Command: Bio Usage: /Bio This command is used to create/edit your personal bio. The bio's are accessible by all other users in the conference. The bio's will contain specific information on the user. Command: /Bios Usage: /Bios This is used to list all the users and their bio summarys. Command: Cls Usage: /Cls This command is used to clear the current screen, and then list the users in the current conference room. Command: Current Usage: /Current This command is used to display the technical statistics for the current user. COM port, and node numbers are displayed. Command: Exit Usage: /Exit This command is used to exit the tele-conference. Command: /Echo Usage: /Echo [on] [off] [text] This command is used to turn echo on, off, to display the current echo state, or to echo text, or system variables to the user. Command: /Forget Usage: /Forget <UserID> This command is used to forget a user in the teleconference. A maximum of 10 users may be forgotten during a session. Command: /Join Usage: /Join <channel> This command is used to enter a different conference/channel. Channels range from 1 to 32000. Command: /List Usage: /List This command is used to list all the users in the tele-conference. The current user's name will be high-lighted in yellow. Command: /Main Usage: /Main This command is used to return to the main tele-conference channel from any channel in the tele-conference. Command: /Pref Usage: /Pref [option] [command] This command is used to display, edit, load, and/or save user preferences. Options are numbered 4 to 6, and commands are Save, and Load. Command: /Remember Usage: /Remember <UserID> This command is used to remember a user in the teleconference that has been forgotten. Command: /Time Usage: /Time This command is used to display the user's current time statistics. Command: /Topic Usage: /Topic [topic name] [-] This command is used to display, set, or remove the current user's comment/topic that is displayed in the /s or /list options. Command: /Version Usage: /Version This command is used to display the current tele-conference version. Command: /Help Usage: /Help [command] This command is used to obtain help on a specific command. The Help command will display files with the .HLP extension. The full file name is the COMMAND.HLP, where "COMMAND" is the command the user is requesting help with, for example: /help topic will display the file called TOPIC.HLP these files are to be located in the PHTConf directory. SYSOP COMMANDS Sysop Conference commands may only be accessed by users who have level 100 or above. All sysop conference commands have a prefix of /$ and the command following. Command: /$ Activity Usage: /$ Activity This command is used to display all the users currently in the conference, and the COM port that they are on. The status of the port is also displayed, where ACTIVE denotes that a carrier is present, and InActive denotes that one is not. Over a network, or LAN, users will be inactive, as the modem port is not accessible, or being used. Command: /$ Add Action Usage: /$ Add Action This command is used to add action commands/words to the action vocabulary. All action words are stored in the ACTNVOCA.PHT file. Command: /$ Adjust_Lvl Usage: /$ Adjust_Lvl [userid] [new level] This command is used to adjust the access of a user in the teleconference. The access adjust is only valid in the teleconference. Command: /$ Adjust_Time Usage: /$ Adjust_Time [userid] [+/- minutes] This command is used to adjust the time limit (in minutes) that a user is allowed in the teleconference. The time adjust is only valid in the teleconference. Note that a plus or minus sing must be specified, as a time adjust is only added or subtracted from a user's current time limit, a new limit can not be specified. Command: /$ Aid Usage: /$ Aid [userid] [command] <parameters> This command is used to aid another user online. The command, or information and parameters are feed into the users keyboard buffer, and sent as if entered by the user. Command: /$ Dos Usage: /$ Dos This command will allow a local user to shell to DOS. Other users in the teleconference are not advised that this user has shelled to DOS. All messages sent while the user is in DOS will be saved and displayed upon return. Command: /$ Fix Usage: /$ Fix This command is used to reset the conference manager. It should only be used if the conference manager has crashed. Command: /$ Invisible Usage: /$ Invisible This command is used to toggle the current user's visibility. The default visibility is on. When other users in the teleconference use the /s or the /list command to list users in the teleconference, invisible users will not be displayed. In addition, invisible users will not be displayed in the conference header. Command: /$ Remove Usage: /$ Remove This command is used to remove a UserID from the conference manager. This function is to be used when a user has crashed a line, or node without exiting the conference. Command: /$ Report Usage: /$ Report This command is used to list all the users and their access levels, that have used the teleconference. Command: /$ Show Usage: /$ Show This command is identical to the /s and the /list commands, with the exception that all invisible users are listed and high-lighted in red. Command: /$ Whois Usage: /$ Whois <UserID> This command is used to list a users, or all users in the teleconference, and their real-names (if available). A partial UserID may also be specified, and it will be matched as if a pattern search was initiated. CONFERENCE INFORMATION When a user is in the teleconference, he/she may request information on _ANSI and _CTRL functions. The ANSI information is a built in help screen that describes to the user how to add ANSI colours to their prompt. The CTRL information is a built in help screen that describes to the user what CTRL keys are valid in the teleconference, those keys are as follows: CTRL L - List previous command history (last 10 lines) CTRL P - Previous command/line in the history CTRL N - Next command/line in the history These functions are useful to retype lines quickly to make changes, etc. USER TO USER PRIVATE CHAT Where user to user private chat is initiated, user may type directly to one another. During a chat session, the users may press CTRL S to see who is in the teleconference (identical to the /s and the /list commands while in the teleconference). To exit the private chat, only one user must press ESC. If one of the users (if a remote user) drops carrier (hangs-up), the private chat will automatically terminate. LOCAL NETWORKS If you are running PHTConf on a local network, you should install it on a RAM drive on a server. Allow read and write access to this drive. When the system boots, have it copy the conference data files, and the conference program to the RAM drive (please see the section on installing RAM disks). Allow the users on the network to be able to enter that directory and run the conference. The conference program MUST be run from this directory. When loading PHTConf on a workstation you should specify the following parameters: PHTCONF /a=alias /r=Realname /t=time /n=node /b=19200 /c=0 /l /u=50 Where: alias = The user's alias to be used Realname = The user's real name time = The maximum time allowed in conference in terms of minutes. node = The workstation node number, as a numeric from 1 to 32000 The other parameters will specify a null baud rate, a local com port, and a local user. The user will be a regular user and will not have conference sysop access. If the user's level is greater or equal to 100 the user will then have conference sysop access. ACTION COMMANDS When creating action commands, the system will prompt you for six pieces of information. In order, they are as follows: 1) The action word. This is the word that the user must type to active the action. 2) Message to actor. This is the message sent to the actor. 3) Message to recipient. This is the message sent to the recipient, if one is specified. 4) Message to all #1. This is the message sent if a user does not specify a recipient, or any data. 5) Message to all #2. This is the message sent if a user does specify a recipient. 6) Message to all #3. This is the message sent if a user does specify a recipient and data, or data. Action commands are then added to the system, and are accessible by any user who has the ability to chat, and has selected that actions are on. Although PHTConf will generate a list of action commands on the system for a user, you may create an ASCII, and an ANSI file containing a list of action words. PHTConf will scan the directory for these files and display them instead of the generated list, if the files exist. The file names are ACTNVOCA.ASC for the ASCII file, and ACTNVOCA.ANS for the ANSI file. If a user has selected Opus/Avatar codes, the ANSI file will be translated to Opus/Avatar codes and be displayed. When in the teleconference users who have the action ability on may use the ga command, to make a generic action. The form of the generic command is: ga <message> wheren message is the data that is displayed after the user's alias. SOFTWARE LICENCE AGREEMENT The following is the licence agreement setup by Phantom Software to govern Phantom Teleconference System. 1.0 Conditions Phantom Teleconference (PHTConf) has been release with the following conditions. If you plan on using PHTConf, you agree to follow these conditions exactly, and failure to read, understand, or follow these conditions renders you legally in the wrong, and you are subject to the penalty for not following these set out conditions. 1.1 Hobby Systems Phantom Teleconference System may be run by a hobbyist as long as the system is either run as a free board, or both free, and donation board. A hobbyist may only run PHTConf for a maximum of 20 days before it will expire and require registration. 1.2 Commercial Systems Phantom Teleconference System may be run by commercial systems for a maximum of 20 days, after which time PHTConf will expire and require registration. Once registration has been paid by a commercial system, the licence granted to the commercial system is not transferable. PHTConf, once registered, may only be run on a single network. Additional registration fees are required for usage over more than one network, or bulletin board system at the same time. 1.3 Government Systems Phantom Teleconference System may be run by government system operators following the same conditions set out in section 1.2. In addition to the conditions set out in section 1.2, government system operators must pay an additional registration fee of $50 for use of the software package. 1.4 Educational Systems Phantom Teleconference System may be run by educational institutions following the same conditions set out in section 1.2. In addition extra software support will be provided for system operators of an educational institution BBS. 2.0 Liability Except as expressly provided below in section 2.2 for media, Phantom Software nor its employees make no warranties, either express or implied, with respect to the software, its fitness for any particular purpose. The software is distributed solely on an "as is" basis. The entire risk as to its quality and performance is with you. 2.1 Improvements Phantom Software reserves the right to make improvements in the product described in this manual at any time and without notice. 2.2 Warranty On Media Phantom Software or its distributor, depending on which party produced the program diskette, warrants the diskettes on which the software is recorded to be free from defects in materials and faulty workmanship under normal use for a period of 90 days after the date of original registration. If during this 90 day period a defect in the diskette should occur, the diskette may be returned for replacement without charge, provided that you have completed the registration form and returned it to Phantom Software. Your sole remedy in the event of a defect in a diskette is limited to replacement of the diskette as provided above. 2.3 Software Support Phantom Software reserves the right to terminate any, and all software support for Phantom Teleconference System or any of its utilities at any time without notice or explanation. 2.4 Registration Phantom Software has the right to give and/or revoke registration and/or written permission from any person, company, or entity, at any time without notice. If registration and/or written permission is revoked, the user has twenty-four (24) hours from the moment of decision, to remove the said software package from any and all of their systems. 2.5 Distribution Phantom Teleconference System may be distributed in its unmodified, original form without written permission from Phantom Software. Users may upload the software package to other bulletin board systems, or distribute copies to friends. ACKNOWLEDGEMENTS Desqview is a trademark of Quarterdeck Systems MS-DOS is a trademark of Microsoft Corporation Special thanks to Timothy Pulver for helping test the conference online. Much thought, and time was spent in the early hours of development by Timothy!