ProfitPress Mega CDROM2 Shareware Freeware (MSDOS)(1992)(Eng)

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

/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / BBS / TELEGARD / TGDOCS25.ZIP / MAIN.DOC < prev next >

Wrap

Text File | 1990-03-11 | 272.0 KB | 6,777 lines

------------------------------------------------------------------ ---/ Telegard Bulletin Board System -- Version 2.5 Standard \--- ---( Copyright 1988,89,90 by Eric Oman, Martin Pollard, )--- ---\ and Todd Bolitho - All Rights Reserved /--- ------------------------------------------------------------------ Main Documentation March 11, 1990 Telegard Bulletin Board System Main Documentation Copyright 1988,89,90 by Eric Oman, Martin Pollard, and Todd Bolitho. All rights reserved. No part of this publication may be reproduced without the prior written consent of the copyright holders. All brand and product names mentioned in this publication are trademarks or registered trademarks of their respective copyright holders. Original documentation written by Bill Schram. Additional documentation provided by Eric Oman, Bill Schram, John Dixon, and Martin Pollard. The Telegard development team wishes to extend special thanks to the following individuals: Bill Schram, whose extensive work on the original documentation provided the major portion of this work; John Dixon, who provided much information on the use of Telegard and US Robotics high-speed modems; and all the other individuals who assisted in making Telegard the product it is today. ___________________________________ T A B L E O F C O N T E N T S ___________________________________ Introduction ..................................................... 1 Installing a New System ....................................... 1 Updated Releases .............................................. 1 Source Code Availability ...................................... 2 Warranty and Copyright Information ............................ 2 Additional Information and Help ............................... 2 System Startup and the WFC Screen ................................ 3 SysOp Function Keys .............................................. 7 The ACS System ................................................... 10 The MCI Code System .............................................. 13 MCI Codes for Prompts ......................................... 13 MCI Codes for Door Commands ................................... 14 MCI Codes for Messages and Text Files ......................... 15 MCI Color Codes ............................................... 16 System Configuration ............................................. 17 Modem Configuration ........................................... 18 File Paths & BBS Configuration ................................ 21 System ACS Settings ........................................... 24 General Variables ............................................. 26 General Flagged Functions ..................................... 29 File Section Configuration .................................... 33 Archive Configuration ...................................... 35 New User & Auto-Validation Settings ........................... 38 Miscellaneous Configuration ................................... 41 FidoNet Configuration ......................................... 42 String Configuration .......................................... 45 Default Colors ................................................ 50 Time Limitations .............................................. 51 Call Allowances Per Day ....................................... 52 UL/DL Number of Files Ratio ................................... 52 UL/DL Kilobytes Ratio ......................................... 52 Modem Information ................................................ 53 Sample Initialization Strings ................................. 53 High-Speed Modems ............................................. 53 The US Robotics Dual Standard Modem ........................ 54 Using a FOSSIL Communications Driver .......................... 54 The History of FOSSIL ...................................... 55 How a FOSSIL Driver Benefits Telegard ...................... 56 Installing a FOSSIL Driver With Telegard ................... 56 The User Editor .................................................. 57 The File Base Editor ............................................. 62 The Message Base Editor .......................................... 67 The Protocol Editor .............................................. 73 The Menu Editor .................................................. 79 The Main Editor Menu .......................................... 79 Menu Command Modification ..................................... 81 Menu Information Modification ................................. 83 Special Global Menu Commands .................................. 85 The Help-File Menu System ..................................... 86 The Generic Menu System ....................................... 88 Linking Menu Commands ......................................... 89 Menu Commands Available in Telegard ........................... 90 The Scheduled Event Editor ....................................... 91 Mini-DOS ......................................................... 95 Mini-DOS Commands ............................................. 95 The Mini-DOS Text Editor ...................................... 97 The InfoForm Questionnaire System ................................ 99 How InfoForm Questionnaires Are Constructed ................... 99 The New User Questionnaire .................................... 99 Asking and Reading InfoForm Questionnaires .................... 99 InfoForm Questionnaire Commands ............................... 100 A Sample InfoForm Questionnaire ............................... 101 Run-Time Errors .................................................. 103 DOS Errors .................................................... 104 I/O Errors .................................................... 104 Critical Errors ............................................... 104 Fatal Errors .................................................. 105 Telegard Main Documentation - Version 2.5 ______________ INTRODUCTION ______________ Thank you for choosing Telegard as your bulletin board system (BBS) software of choice. We feel that Telegard represents the BBS community as a nice, user friendly software package that is easy to set up, yet powerful enough to set it apart from other software in its class. Telegard was written and compiled using the Turbo Pascal compiler, version 5.5, from Borland International. Main testing was provided by Eric Oman, Martin Pollard, and Todd Bolitho. ----------------------- INSTALLING A NEW SYSTEM ----------------------- Telegard was designed to be used with the following minimum system configuration: - IBM PC/XT/AT (or true compatible) or PS/2 - Hard disk drive (10 megabytes minimum) - 384K RAM (more is preferable) - 80 column monochrome or color monitor - Modem (300 baud or greater; Hayes compatible is preferred) - PC-DOS or MS-DOS version 3.2 or later A start-up package is distributed under the name INITxxxx.ZIP, where "xxxx" indicates the version number in question. This archive contains complete documentation concerning the setup of a new system. ---------------- UPDATED RELEASES ---------------- Alpha and Beta sites (as well as most Standard sites) will have the latest Standard release, and will distribute them at no cost (other than the phone call to download the program!). Hopefully, updates will be released on a regular basis, but we are unable to give any kind of schedule. Since Alpha and Beta sites perform testing of newer versions of Telegard before it is released Standard, you might want to call those boards to keep up with the latest features. We are adding them all the time! - Page 1 - Telegard Main Documentation - Version 2.5 ------------------------ SOURCE CODE AVAILABILITY ------------------------ The source code for Telegard is not available for the general public under any circumstances. This may go "against the grain" of seasoned programmers, but the Telegard development team has had much trouble in the past with the source code "floating around," and doesn't want to repeat the same mistakes in the future. A software developer's toolkit is available for Turbo Pascal and C programmers who wish to write support utilities for Telegard. This toolkit contains the record structures for Telegard's data files. Contact the Telegard development team for further details. ---------------------------------- WARRANTY AND COPYRIGHT INFORMATION ---------------------------------- Telegard is not public domain software; it is copyrighted by the Telegard development team. However, we grant you the right to distribute as many copies of the Standard release version as you wish, provided the following restrictions are kept in mind: - Only distribute the Standard release version in its original form, with all of its related files intact. We will allow the archives to be converted to a different format, but that is the extent of it. - Do not accept ANY kind of payment for the program. The exception would be computer clubs and other organizations that charge a nominal price for disk copying, mailing, etc. - Do not alter the program in any manner. - Do not use the program in a commercial environment. If you wish to do so, contact the development team for details. Telegard is guaranteed only to take up disk space. No other warranty or responsibility is implied; the development team is not responsible for damages resulting from the use (or misuse) of the Telegard software. In plain English: It works for us, but if it doesn't work for you... c'est la vie. (Or, in the immortal words of Wynn Wagner III: "Run at your own risk, but if it breaks, YOU have the pieces...") ------------------------------- ADDITIONAL INFORMATION AND HELP ------------------------------- Experiment; it's a big system, and you're not going to learn it all in one sitting. If you need help and/or information concerning the setup and operation of a Telegard system, you may contact one of the Telegard Alpha or Beta sites. Since the installed base of Telegard systems is growing by leaps and bounds, you should check the list of Telegard systems (included with every Standard release) for a site near you. - Page 2 - Telegard Main Documentation - Version 2.5 ___________________________________ SYSTEM STARTUP AND THE WFC SCREEN ___________________________________ To start the BBS, change to the main BBS directory and execute the "BBS" program. Assuming that the main BBS directory is named "C:\BBS", you would type the following commands: CD C:\BBS BBS Alternatively, you may place these commands into a batch file, and use the batch file to start the BBS. This has several advantages, not the least of which is the ability to interpret the ERRORLEVEL code returned from the program. Normal termination, critical errors or external system events can be identified and appropriate action taken, depending on the ERRORLEVEL value. There are also several command line options you can use to alter the functioning of the system. These options can be entered in either upper or lower case: -Bxxxxx Answer the phone and force the baud rate to "xxxxx". Note that the "answer phone" string is NOT sent to the modem. This option will find the most use when executing the system from a front-end mailer (refer to "Using Telegard With FidoNet" for more information). -EExxx If a critical error occurs during the operation of the BBS, it aborts to DOS with an ERRORLEVEL value of 254. This option can be used to change that value. -ENxxx Normally, when you perform a normal exit back to DOS, the program returns an ERRORLEVEL value of 255. This option can be used to change that value. -K Operate the BBS in local mode only (don't send anything out to the modem, and don't respond to incoming calls). -P Pack the message bases and return to DOS. This option can be useful when using Telegard with a front-end mailer (refer to "Using Telegard With FidoNet"); message base packing can be performed from the command line during a front-end event. Thus, you don't have to mess around with two event systems (you can perform all external events through the front-end if you like). -Q Quit to DOS after the next user logs off. Telegard will then perform various initialization functions (such as loading data files and initializing the modem) before arriving at the Wait For Caller (WFC) screen. The WFC screen is where the BBS sits while waiting for the next caller. The commands available from this screen are displayed, as well as the following constantly-updated information: Time - The current time and date. Mail - The number of Email messages the SysOp has waiting. DLs - The number of files and kilobytes downloaded for the day. - Page 3 - Telegard Main Documentation - Version 2.5 ULs - The number of files and kilobytes uploaded for the day. % Activity - The percentage of activity for the day. Disk Space - The total amount of remaining disk space. Last Active - How long ago the BBS was last active. Last Caller - The name of the last remote caller. The commands available from the WFC screen are explained in detail below. In most cases, there is a chapter in this manual devoted to the command in question (such as the message and file base editors, and the system configuration command). A Sends the "answer phone" command to the modem. It is used mainly for situations where you have your system "hard-wired" to another system for testing purposes. In most cases, the BBS will automatically answer the phone by itself. B Enters the message base editor, where you can enter and modify the bases used to store public messages. C Displays a list of callers for the day. D Shells to DOS, allowing you to perform maintenance and other functions that aren't available through Mini-DOS. To return to the WFC menu, use the DOS "EXIT" command. E Enters the scheduled event editor, where you can enter and modify the various scheduled events used to perform system maintenance (and other functions). F Enters the file base editor, where you can enter and modify the bases used to store files for uploading and downloading by users. G Enters the text file base editor, where you can enter and modify the bases used to store user-viewable text (and ANSI) files, as well as add and delete entries in each base. H Sends the "initialization" command to the modem, which serves to hang up the phone if it is offhook (usually via the "O" command). I Enters the voting editor, where you can enter and modify the voting booth questions. L Displays the SysOp logs. You can display today's log, or the logs of previous days (up to the number of days specified in the system configuration). M Allows viewing of ALL Email messages that have been posted. It does not allow for the viewing of a specific individual's Email (use the "R" command for that). - Page 4 - Telegard Main Documentation - Version 2.5 N Enters the Mini-DOS text editor, allowing you to create and edit any text file in the AFILES directory. (This editor is very similar to the DOS "EDLIN" editor.) O Sends the "offhook" command to the modem, which makes the line busy to all remote callers. Use the "H" or "+" commands to hang up the phone. P Enters the system configuration, where you can perform most of the major changes and modifications to the BBS. Q Exits the BBS and returns to DOS with the "normal exit" ERRORLEVEL value (discussed earlier). R Allows you to read a specific individual's Email messages. S Displays the current status of the BBS (chat status, number of users, etc.). T If a batch file named "TERM.BAT" exists, Telegard will execute it. This is mainly used to call an external terminal program (such as MiniTerm, which is available separately). U Enters the user editor, where you can modify the modify the information for each user of the BBS. V Creates a text file containing the current questions in the voting booth, along with the current statistics of each answer (percentages, who voted for which answer, etc.), which can optionally be displayed on the screen. W Allows you to send Email messages to other users, either individually or via various mass mail criteria. X Enters the protocol editor, where you can enter and modify the definitions of the file transfer protocols used to upload and download files. Z Displays the usage log information contained in the ZLOG.DAT file, which contains a record of all general system activity (number of posts, number of uploads and downloads, etc.). # Enters the menu editor, where you can create and modify the BBS online menus. ! Enters Mini-DOS, which is a DOS-like environment that can be used for system maintenance functions. Unlike the full DOS shell, Mini-DOS has security restrictions on many of its commands. + Sends the "initialization" command to the modem, used to initialize the modem. (This also serves to hang up the phone if the line was taken offhook via the "O" - Page 5 - Telegard Main Documentation - Version 2.5 command.) [SPACE] Allows you to log on to the BBS locally. You can choose to log on normally (by pressing "Y") or log on quickly (by pressing "F"). Logging on quickly will bypass the shuttle logon menu, all the text and ANSI files, the auto-message, and the bulletin menu (some or all of which may already be disabled by you via the system configuration). 1 to 9 Executes batch files called "WFCBATx.BAT", where "x" is the digit that you pressed (1 to 9). There is a secondary WFC screen that is displayed if the local security function is enabled in the system configuration; it is called, appropriately enough, the WFC security screen. When this screen is displayed, only two commands are allowed: [SPACE] and "Q". "Q" will, obviously, exit to DOS with the "normal exit" ERRORLEVEL value. Pressing [SPACE] will bring up a prompt for the system password; entering the correct password will display the normal WFC screen, allowing the use of all WFC menu commands. Note that both the normal and security WFC screens can be modified to suit your taste. The image of both of these screens is contained in two ANSI files, WFCMENU.ANS (the normal screen) and WFCMENU0.ANS (the security screen). Modifying one of these files will automatically regenerate the WFCMENU.DAT and WFCMENU0.DAT files (which contain the raw screen images), and will give your system a more customized look. Lines 1-23 of the security WFC screen, and lines 6-23 of the main WFC screen, are available for your images. (Lines 24 and 25 are reserved for information that the BBS displays.) Some further notes about the normal WFC screen: - If you turn the WFC logo off in the system configuration, lines 1-5 also become available for your images. - Be careful of the portion of the screen that displays the constantly updated information. Make sure that whatever image you create isn't affected by the information that will be displayed. For simplicity, it is suggested that you leave that portion of the image alone (this is, of course, entirely up to you). ANSI files can be created using a Shareware program called TheDraw, which is an ANSI picture editor and animator. Look for TheDraw on one of the BBSes in your area; it is a very popular program, widely regarded as the best in its class. (It is usually under the filename "TDRAWxxx.ZIP"; the "xxx" depends on the current version number.) - Page 6 - Telegard Main Documentation - Version 2.5 _____________________ SYSOP FUNCTION KEYS _____________________ There are many functions available to you via function keys, both while a user is online (or while you are online locally) and while you're performing local maintenance. These function keys are used to perform maintenance, change a user's security information, and other operations. The following function keys are available only when a user is online: [F1] Allows modification of the user's security information (SL, DSL, AR & AC flags, file points). Prints the "SysOp working" message while this window is displayed. [Shift-F1] Same as [F1] except that the "SysOp working" message is not displayed. [F2] Switches the SysOp information windows between the normal 5-line window and the extended 11-line window. If the window is not on, [F2] will turn it on. [Shift-F2] Toggles the SysOp window on and off. [F3] Toggles the user's keyboard on and off. This doesn't actually disable the user's keyboard, it only tells the system to ignore any keystrokes coming from the user (which has the EFFECT of disabling the user's keyboard). Ever been in chat mode and couldn't get a word in edgewise? This is the function key for you! [Shift-F3] Toggles the user's screen on and off. Again, this doesn't actually disable the user's screen, it only tells the system not to send any output to the user (which has the EFFECT of disabling the user's screen). [Alt-F3] Toggles the local screen on and off. Like [Shift-F3], it doesn't disable the screen, it only suspends output to the screen (which has the EFFECT of disabling the local screen). [F4] Turns off the "user attempted to chat" flag (shown on the SysOp window as a blinking "-CHAT-" message). [Alt-F4] Performs a local shell to DOS. Prints the "SysOp has shelled to DOS" message before entering DOS, and the "thank you for waiting" message after returning from DOS. - Page 7 - Telegard Main Documentation - Version 2.5 [Ctrl-F4] Performs a "warm" reboot of the computer. (A "warm" reboot skips the memory test and other self-checks normally associated with a first-time, or "cold" boot.) [F5] Hangs up on a user immediately and returns to the WFC menu. [Shift-F5] Allows you to select a hangup message to display (HANGUP0.MSG through HANGUP9.MSG) before hanging up on the user and returning to the WFC menu. [Alt-F5] Prints fake "line noise" (random ASCII characters) before hanging up on the user and returning to the WFC menu. [Ctrl-F5] Prints fake "line noise" but does NOT hang up on the user. Used mainly to drive users crazy! (Who says being a SysOp isn't fun?!) [F6] Redraws the SysOp window, if active. [F7] Subtracts five minutes from a user's total time left. [Shift-F7] Subtracts a specified amount of time from a user's total time left. [F8] Adds five minutes to a user's total time left. [Shift-F8] Adds a specified amount of time to a user's total time left. [F9] Toggles temporary SysOp access for a user. If temporary SysOp access is still active when the user logs off, the user's statistics are returned to normal. USE ONLY WITH TRUSTED USERS!!! [Alt-F9] Sends a continuous stream of ASCII bell characters (7 decimal) to a user, which will produce a continuous stream of beeps until the user presses a key on his keyboard (or hangs up). Used to get a daydreaming user's attention! [F10] Toggles chat mode on and off, allowing you to "talk" to a user via the keyboard. [Shift-F10] Toggles "beep-after-end" on and off. This feature will, when activated, take the phone offhook and sound an alarm when the user logs off, thus letting you know that the system is available. [Alt][F10] Displays the chat reason on the top line of the local screen. - Page 8 - Telegard Main Documentation - Version 2.5 [Home] Toggles the chat capture buffer on and off (used while in chat mode). [Alt-G] Allows enabling and disabling of activity trapping and chat capturing for a user. [Alt-J] An alternative to [Alt-F4] to shell to DOS. The [Alt-J] sequence is the same one used by Telix and other communications programs to shell to DOS, thus it provides ease of use for SysOps that use those particular programs. [Alt-L] Clears the local screen. If the SysOp window is active, only the user area is cleared. [Alt-T] Toggles the SysOp window display between the top and bottom of the local screen. [Alt-V] Validates a user while he/she is online, using the validation settings specified in the system configuration. The following function keys are available anywhere in the system, whether or not a user is online: [Alt-=] Toggles "DOS exit after user logoff" on and off. This means that the system will return to DOS after the current caller has logged off or, if toggled on while at the WFC menu (or elsewhere), when the NEXT caller has logged off. [Alt-x] Executes a batch file called "GLOBATx.BAT", where "x" is a number from 1 to 9. [Scroll Lock] Toggles the "SysOp available for chat" flag on and off. When the [Scroll Lock] light on the keyboard is off, the SysOp is available; when the light is on, the SysOp is unavailable. [Ctrl] Provides for an immediate exit from the BBS, [Print Scrn] returning the "critical error" ERRORLEVEL value. - Page 9 - Telegard Main Documentation - Version 2.5 ________________ THE ACS SYSTEM ________________ ACS stands for Access Condition String, and is a powerful new method of stating the requirements and conditions under which a user has access to something -- whether it be a file area, a menu command, or a text file in the text file section. The ACS system combines security levels (SL and DSL), AR and AC flags and several other unique features into a string of twenty characters. It is ALMOST like a miniature programming language. (I know some of you probably flinched at the word "programming"!) There are 12 different functions in the ACS system, and all of them have the same basic syntax: A letter followed by the parameter of the function, all of which can be specified in upper or lower case. The following is a list of all possible functions. Function : "Annn" Description: Age of user Access req.: Must be as old as "nnn". Function : "Bnnn" Description: Baud rate, without last two zeros ("00") Access req.: Must be connected at "nnn" baud. Function : "Dnnn" Description: DSL Access req.: Must have DSL of "nnn" or higher. Function : "Fx" Description: AR flag Access req.: Must have AR flag "x" (A to Z). Function : "Gx" Description: Gender Access req.: Must have gender "x" (M or F). Function : "Pnnnnn" Description: File points Access req.: Must have AT LEAST "nnnnn" file points. Function : "Rx" Description: AC flag Access req.: Must have AC flag "x" (LCVBA*PEKM1234). Function : "Snnn" Description: SL level Access req.: Must have SL of "nnn" or higher. Function : "Tnnnnn" Description: Time left Access req.: Must have AT LEAST "nnnnn" minutes of time left. - Page 10 - Telegard Main Documentation - Version 2.5 Function : "Unnnn" Description: User number Access req.: Must be user number "nnnn". Function : "VV" Description: Validation Access req.: Must be a validated user. Function : "Ynnnn" Description: Time of day Access req.: Must be AT LEAST "nnnn" minutes after midnight. The following are a few examples: "A21" - Must be 21 years old to have access. "B96" - Must be connected at 9600 or higher baud rate. "FS" - Must have AR flag "S". "T20" - Must have at least 20 minutes time left. "Y360" - Must be later than 6:00 am. There are five logical operators that can be used in ACS, only three of which (the first three) are used frequently: "&" - Logical AND "|" - Logical OR "!" - Logical NOT "^" - Logical TRUE "%" - Logical FALSE The default operator between any two functions is AND. Thus, functions can be strung together without any operators in between. For example, "S20D50" (aka "S20&D50") requires SL 20 and DSL 50. "A21FSD255" (aka "A21&FS&D255") requires that the user be 21 or older, AR flag "S", and DSL 255. The OR operator is simple to use. For example, "S20|FA" requires that the user have either SL 20 *OR* AR flag "A". In either case, the user meets the access requirement. The NOT operator is also easy to use. Just place a "!" character before any function to reverse it's meaning. For example: "!FA" means the user must NOT have AR flag "A" to have access. IMPORTANT: Be sure to remember that, in numeric functions, the NOT operator COMPLETELY REVERSES THE MEANING of the function. Thus, "!S30" does NOT mean "SL less than or equal to 30"; it means "SL less than 30", *without* the "equal to". The TRUE and FALSE operators are used to give everyone access, or to not give anyone access. "^" means all users have access, and "%" means no users at all have access. They are NOT meant to be used in combination with other ACS operators! To provide for even more complex ACS's, parentheses are allowed. "(S20FA)|(D255)" means, for example, that the user must have SL 20 and AR flag "A", *OR* DSL 255, to have access. - Page 11 - Telegard Main Documentation - Version 2.5 Here are some more examples: S50 User must have SL 50 to 255. !S50 User must have SL 0 to 49. VV|U1 User must be validated, or be user #1, to have access. A21FAS50 User must be 21 years old, have AR flag "A", and and have 50 SL. !(A21FAS50) User has access so long as they do NOT have all of the following: 21 years old, AR flag "A", and SL 50. !A21!FA!S50 User has access SO LONG AS they have NONE of the three. - Page 12 - Telegard Main Documentation - Version 2.5 _____________________ THE MCI CODE SYSTEM _____________________ Telegard provides a powerful system for displaying and handling system and user information, in prompts, command lines and text messages. This is done using a set of codes called MCI (Message Command Interpreter). These codes are entered with the character "@" followed by a specific ASCII character. Changing colors in text messages is accomplished through a special system that is described later. --------------------- MCI CODES FOR PROMPTS --------------------- The following MCI codes may be used in the various prompt strings that can be configured through the system configuration. These codes may also be used in the "To:" and "Subject:" fields in public messages, but a user may only see the results of these codes if the MCI ACS field for the particular message base allows it. Unless stated otherwise, information displayed by these MCI codes are displayed using the current MCI color. @A Displays the current message board number in the format "#xxx". @B Displays the current message board name. If the name contains MCI color codes, it will be displayed using those colors; otherwise, it is displayed in MCI color #5 (default: yellow) if Local, or MCI color #0 (default: bold white) if EchoMail or GroupMail. @C Displays the current file board number in the format "#xxx". @D Displays the current file board name. If the name contains MCI color codes, it will be displayed using those colors; otherwise, it is displayed in MCI color #5 (default: yellow). @F Displays the current user's real first name. @G Sounds a beep (on the user's side only). @H Displays the current user's user name minus the user number. @K Displays the number of kilobytes (K) available on the drive of the current file board's upload path. @L Displays the current user's real last name. - Page 13 - Telegard Main Documentation - Version 2.5 @M Displays a carriage return/linefeed. @N Displays the current user's user name and number. @P Displays the number of file points remaining to the current user. @R Displays the current user's entire real name. @T Displays the amount of time online remaining to the current user in the format "HH:MM:SS". @U Displays the message number that the current user is reading. @V Displays the commands that are accessible to the current user at the current menu. @W Displays the number of messages in the current message board. @X Displays the maximum number of lines allowed for a message in the current message board. @Y Displays the current message board name and number. If the name contains MCI color codes, it will be displayed using those colors; otherwise, it is displayed in MCI color #5 (default: yellow) if Local, or MCI color #0 (default: bold white) if EchoMail or GroupMail. The number is ALWAYS displayed with MCI color #5 or #0. @Z Displays the string entered when the current user requested a chat with the SysOp (the "chat reason"). --------------------------- MCI CODES FOR DOOR COMMANDS --------------------------- The following MCI codes may be used for the command lines passed to DOS when executing an external program (a "door"). Note that though many of these codes duplicate information returned from the MCI prompt codes, these codes can ONLY be used with door command lines. Any MCI color codes that may be present are removed before the information is passed. @N Returns the current user's user name. @F Returns the current user's first name. @L Returns the current user's last name. @T Returns the amount of time online remaining to the current user (in minutes). - Page 14 - Telegard Main Documentation - Version 2.5 @G Returns a "1" if the current user has ANSI graphics enabled, "0" if disabled. @R Returns the current user's user number. @B Returns the baud rate that the current user logged on with. Local keyboard logons are indicated with a "0" (meaning no baud rate). @D Returns the current file base's download directory pathname. @I Returns the current file base's *.DIR filename and pathname. ------------------------------------- MCI CODES FOR MESSAGES AND TEXT FILES ------------------------------------- The following MCI codes may be used in .MSG text files and public messages. Note that if the current user's setup does not match the requirements for the MCI ACS field for a particular message base, that user cannot use these codes; they will instead be shown as "@1", "@2", etc. (This does not apply to text files.) The rules regarding MCI colors for MCI prompt codes also apply here. @1 Displays the current user's user name. @2 Displays the current user's real name. @3 Displays the current user's phone number. @4 Displays the current user's city & state. @5 Displays the current user's street address. @6 Displays the current user's postal zip code. @7 Clears the screen. @8 Provides a few seconds' delay. @9 Displays the "pause" string (defined in System Configuration) and waits for the current user to press a key. @! Toggles the current user's ability to abort the message or text file to OFF until it is finished being displayed. @# Toggles the "pause when screen is full" feature to OFF (if enabled for the current user) until the message or text file is finished being displayed. - Page 15 - Telegard Main Documentation - Version 2.5 --------------- MCI COLOR CODES --------------- The ability to display any of the ten MCI colors in messages, text files, prompt strings, etc., is provided via two methods. The first method is usable almost everywhere in Telegard: At the point where you wish to change to another MCI color, press [Ctrl-P] (hold down the [Ctrl] key and press the "P" key, then release both) and then press a number key ("0" through "9"). From then on, the current MCI color will be the one corresponding to the number you pressed, until the color is changed again either by the system or by another MCI color code sequence. (Technical note: The color code is stored as a two-byte sequence, "03" hexadecimal followed by "00" through "09" hexadecimal, depending on the number you selected. This is why you sometimes see funny characters when you TYPE a Telegard .MSG file from DOS; more than likely, that file contains MCI color codes.) The second method is to enter, at the point where you wish to change colors, a "^" character followed by a number character ("0" through "9"). For example, if you wished to change to MCI color #3, you would enter "^3". This method is usable only in a few areas, which include the system configuration string configuration section and the prompts and strings in the menu editor's menu configuration section. - Page 16 - Telegard Main Documentation - Version 2.5 ______________________ SYSTEM CONFIGURATION ______________________ At the heart of Telegard is the system configuration feature. It is here that the entire operation of the system is set up, from modem configuration to file archiving options to time allowances and upload and download restrictions. This section is selected by the "P" command at both the Wait For Caller (WFC) screen and the SysOp Menu (while executing the BBS). Once selected, the following menu is displayed: ______________________________________________________________________ System configuration: A. Modem Configuration B. File paths & BBS configuration C. System ACS settings D. General variables E. General flagged functions F. File section configuration G. New user and Auto-Validation settings H. Miscellaneous configuration I. FidoNet configuration S. String configuration Z. Default Colors 1. Time limitations 2. Call allowance/day 3. UL/DL # files ratio 4. UL/DL K-bytes ratio 5. Post/Call ratio Enter selection (A-I,SZ,1-5) [Q]uit : ______________________________________________________________________ Selecting one of the keys will take you to the appropriate section of the system configuration. Pressing "Q" will take you back to the WFC screen (or the SysOp Menu). - Page 17 - Telegard Main Documentation - Version 2.5 ------------------- MODEM CONFIGURATION ------------------- Modem Configuration allows you to set up how the modem and Telegard communicate. It is here that the COM port, modem commands and result codes are configured. Note that the default settings that are installed with the initialization package are suitable for most standard modems (300 to 2400 baud). However, as is the case with most things concerning computers, one configuration will simply not do for every situation. This is especially true concerning modems. That is why there is a special section for modem information (called, appropriately enough, "Modem Information"). This section includes alternate configuration strings, information for setting up Telegard with various 9600 baud modems, and how to use Telegard with a FOSSIL communications driver. By default, Telegard is set up for use with a Hayes compatible modem (whatever that means nowadays). If you modem does not fall into this category -- older modems from Radio Shack, for instance, use their own command sets -- you will have to make modifications to the settings. Consult the manual for your modem for the correct information. Upon selecting this option, the following menu is displayed: ______________________________________________________________________ Modem configuration 1. Maximum baud rate : 1200 2. COM port number : 1 3. Modem initialization string: "ATH0Q0V0E0M0X1S0=0S2=1S10=40&C1" 4. Modem answer string : "ATA" 5. Modem hangup string : "~~~^A^A^A~~~ATH0" 6. Modem offhook string : "ATH1M0" 7. No call init. time : 30 A. 9600 ARQ rate baud : 9600 baud F. Forced baud rates? : Yes R. Modem result codes: Case 1 Case 2 (ARQ) R1. NO CARRIER : 3 R2. NO DIALTONE: 6 R3. BUSY : 7 R4. 300 BAUD : 1 0 R5. 1200 BAUD : 5 15 R6. 2400 BAUD : 10 16 R7. 4800 BAUD : 0 0 R8. 9600 BAUD : 13 17 Enter selection or (Q)uit : ______________________________________________________________________ - Page 18 - Telegard Main Documentation - Version 2.5 Note that the command strings can contain the following special characters: "|" Sends a carriage return to the modem. Note that all strings are automatically terminated with a carriage return, so this character is not needed at the end of the strings. "^x" Sends a control character to the modem. The "x" is an uppercase letter (A-Z), and will correspond to control codes 1 through 26. "~" Performs a half-second delay before sending the next character to the modem. Each menu option is described in detail below. 1 This is the baud rate that Telegard will use when waiting for calls at the WFC menu. This should be set to the modem's maximum baud rate, at either 300, 1200, 2400, 4800, 9600, 19200 or 38400 baud. 2 This is the COM port that your modem is connected to, which can be COM1 through COM4. 3 This is the command that initializes the modem. This is VERY important, as it tells the modem how to operate under the BBS environment. If your modem does not respond using the default command, consult the "Modem Information" section for more information (or "play" with the command until you get it just right). 4 This is the command that enables the modem to answer an incoming call. 5 This is the command that hangs up the modem. 6 This is the command that places the modem offhook (when you wish to have SOME access to your computer!). This has the same effect as taking the receiver off the hook on your telephone. 7 This sets the time (in minutes) in which the modem will be reinitialized if no one has called. Do NOT set this option to zero (0); if you do, the modem will be constantly reinitialized, and will not let anyone call in (nor will it let you regain control of the system until you press the Reset button!). A This sets the ARQ baud rate used with 9600 baud (or higher) modems. Consult your modem's manual for more details on the ARQ feature. F This option sets the forced baud rate used with 9600 baud (or higher) modems. - Page 19 - Telegard Main Documentation - Version 2.5 R These are the result codes returned by the modem when the NO CARRIER, NO DIALTONE, BUSY and various baud rate conditions are encountered. Case 1 result codes are the main codes returned by the modem. Case 2 result codes are provided for persons using MNP class modems (such as the USR Courier HST), which are designed to filter more noise and give a better grade connection, in the ARQ mode. - Page 20 - Telegard Main Documentation - Version 2.5 ------------------------------ FILE PATHS & BBS CONFIGURATION ------------------------------ This area is where many of the various BBS options are configured, as well as the required file paths that the program needs to find its files. Upon selecting this option, the following menu is displayed (the menu has been slightly compressed to fit onto the page): ______________________________________________________________________ BBS configuration and file paths A. BBS name & number :Telegard BBS (000-000-0000) B. SysOp's name/alias :<System Operator> C. SysOp chat hours :*None* G. 300 baud hours :Always... D. Regular DL hours :Always allowed H. 300 baud DL hours :Always... E. Shuttle Logon is :In-active I. New users are :Accepted !. LOCKOUT 300 BAUD :No J. Snow checking is :In-active F. BBS Passwords K. Pre-event warning :60 1. Main data files dir. :"C:\BBS\GFILES\" 2. Alternate text file dir.:"C:\BBS\AFILES\" 3. Priv/pub msgs directory :"C:\BBS\MSGS\" 4. Menu file directory :"C:\BBS\MENUS\" 5. Text-file section dir. :"C:\BBS\TFILES\" 6. Trap/log/chat directory :"C:\BBS\TRAP\" 7. Temporary directory :"C:\BBS\TEMP\" 8. Last text-file edit date:04/21/89 Enter selection (A-K,!,1-8) [Q]uit : ______________________________________________________________________ Each option is described in detail below. A This option allows you to enter the name and the phone number of your BBS, which is used as a general string during the logon procedure. MCI color codes are allowed. B This option allows you to enter the name or the handle of the SysOp (you!), which is used in various places throughout the program. C This option allows you to declare your chat hours. When someone pages you during these hours, a bell will sound to inform you that a user wishes to chat. Also, during the logon procedure, a message is displayed that indicates the status of the SysOp. If a user logs on within the chat hours, the SysOp is declared "available to chat", otherwise the SysOp is declared "unavailable to chat". Alternately, you may leave the chat hours as "undefined." This allows the use of a special feature associated with the [Scroll Lock] key. When [Scroll Lock] is active, the BBS declares that the SysOp is unavailable; when inactive, the - Page 21 - Telegard Main Documentation - Version 2.5 BBS declares that the SysOp is available. This allows you to control the chat status via the keyboard. D This option defines the hours that file downloading is allowed. Some SysOps prefer to have certain hours set aside for non-file related activities (posting messages, etc.); this option allows that. The default is to always allow file downloading. E This option toggles the status of the shuttle logon. The shuttle logon provides an extra layer of security for the BBS, which is desired by some SysOps. ! This option allows you to lock out 300 baud users. Some SysOps do not wish to tie up their systems with users that use slow (and outdated) 300 baud modems. The default is NO. If this feature is activated, and a 300 baud user tries to log on, the message NO300.* is displayed during the logon procedure and the BBS will hang up. F This option defines the SysOp, new user and shuttle logon passwords. G This option defines the hours that 300 baud callers may log on. Some SysOps prefer to restrict the hours available to users of 300 baud modems. The default is to always allow 300 baud callers. If these hours are defined, and a 300 baud caller tries to log on, the file 300HOURS.* is displayed during the logon procedure and the BBS will hang up. Note that this option is pretty much useless if 300 baud users are locked out (the "!" option). H This option defines the hours that 300 baud callers may download files. Again, some SysOps prefer to restrict the activities of user with 300 baud modems (due to their slowness). The default is to always allow 300 baud callers to download files. Once again, note that this option is useless if 300 baud users have been locked out (with the "!" option). I This option allows you to accept or lock out new users. The default is to always accept new users. If you decide you have enough users, or you wish to run a private board where only certain people are permitted access, you should set this option to lock out new users. J This option toggles video snow checking. This option is mainly for systems using a Color Graphics Adapter (CGA), which is susceptible to video "snow" during direct writes to the screen. (Systems with monochrome adapters, Enhanced Graphics Adapters [EGA] or Video Graphics Array [VGA] adapters usually do not have this problem.) The default is no snow checking. - Page 22 - Telegard Main Documentation - Version 2.5 K This options sets the number of seconds before a scheduled event is run in which the user is warned. This gives the user time to finish up and log off. The default is 60 seconds (one minute). 1 This option defines the directory in which your main data files are stored. These include the file directory (*.DIR) and miscellaneous system (*.DAT, *.LST) files. 2 This option defines the directory in which your text files are stored. These files include ANSI (*.ANS), text (*.MSG), and InfoForm question (*.INF) and answer (*.ASW) files. 3 This option defines the directory in which your public and private message files (*.BRD, *.MIX, *.TRE) are stored. 4 This option defines the directory in which the menu files (*.MNU) are stored. 5 This option defines the directory in which the text file system (Tfiles) files are stored. These files may be viewed by various users, and their contents can cover a wide range of interests and topics. (See the section on Tfiles for more information on this feature.) 6 This option defines the directory in which the trap files (TRAP*.MSG), system log files (SYSOP*.LOG) and capture chat files (CHAT*.MSG) are stored. 7 This option defines the directory in which temporary files are stored. During the course of BBS operation, this directory is used for: Holding incoming batch uploads until the queue is empty; converting archive files between different formats (ARC, LZH, PAK, ZIP, ZOO, or other user- defined formats); holding files processed using the "(E)xtract to Temp" and "(W)ork on Temp" commands from the File Transfer menu (more on this later); and so on. It is recommended that this path point to a drive that has plenty of space available (at least 1MB is recommended). 8 This option defines the date in which your text files (Tfiles) were last edited and/or updated. - Page 23 - Telegard Main Documentation - Version 2.5 ------------------- SYSTEM ACS SETTINGS ------------------- These settings define how many of the features of the BBS will oper- ate, from posting features to file transfer ratio/file point checking to Co-SysOp and SysOp access levels. Each setting is set up using the Access Condition String (ACS) system (refer to the "The ACS System" section for more information). Upon selecting this option, the following menu is displayed (the menu has been slightly compressed to fit on the page): ______________________________________________________________________ System ACS settings: A. Full SysOp :"s255" B. Full Co-SysOp :"s250" C. Message base SySop :"s199" D. File base SysOp :"s230" E. SysOp Password at logon :"s250" F. See passwords remotely :"s255" G. Post normal public mail :"s11" H. Send normal private mail:"s11" I. See who posted anon :"s100" J. See who Emailed anon :"s100" K. Post on ANY base anon :"s100" L. Email anon :"s100" M. See unvalidated files :"s50" N. DL unvalidated files :"s230" O. No UL/DL ratio checking :"s255" P. No post/call ratio check:"s200" R. No file point checking :"s255" S. ULs auto-credited :"s21" Enter selection (A-S) [Q]uit : ______________________________________________________________________ Each option is described in detail below. A This setting defines the security level for a full SysOp. B This setting defines the security level for a full Co-SysOp. C This setting defines the security level for a message base SysOp. D This setting defines the security level for a file base SysOp. E This setting defines the security level in which the SysOp password must be specified during the logon process. F This setting defines the security level in which a user can view passwords remotely. G This setting defines the security level required to post normal public mail. H This setting is similar to option G, except that it pertains to normal Email. I This setting defines the security level that allows a user to see who posted public messages anonymously. - Page 24 - Telegard Main Documentation - Version 2.5 J This setting defines the security level that allows a user to see who posted Email anonymously. K This setting defines the security level that allows a user to post anonymously on ANY message base, regardless of the settings of the anonymous flags for the message bases. L This setting is similar to option K, except that it pertains to Email. M This setting defines the security level that allows a user to see unvalidated files when listing the files in the file bases. N This setting defines the security level that allows a user to download unvalidated files. O This setting defines the security level at which upload/ download ratio checking is suppressed. P This setting defines the security level at which the post/ call ratio check is suppressed. R This setting defines the security level at which file point checking is suppressed. S This setting defines the security level at which uploaded files are automatically credited to the uploader. (Setting the security level to a value higher than that for normal users will prevent uploading of "garbage" in order to balance an UL/DL ratio for further downloading, thereby preventing "leeching" of the file sections.) - Page 25 - Telegard Main Documentation - Version 2.5 ----------------- GENERAL VARIABLES ----------------- This section controls various numeric values and limits for the BBS, such as the maximum number of lines per message, number of logon attempts, and the number of minutes of inactivity before the WFC screen is blanked. Upon selecting this option, the following menu is displayed: ______________________________________________________________________ General variables: A. Max private sent per call:20 B. Max feedback sent per call:5 C. Max public posts per call:20 D. Max chat attempts per call:3 E. Normal max mail waiting :15 F. CoSysOp max mail waiting :50 G. Normal max lines/message :120 H. CoSysOp max lines/message :160 I. Number of logon attempts :4 J. Backspace delay :20 K. SysOp chat color :4 L. User chat color :3 M. Min space for posts :10 N. Min space for uploads :100 O. Back SysOp Log keep days :7 P. Blank WFC menu minutes :0 R. Default video page width :80 S. Default video page length :25 Enter selection (A-S) [Q]uit : ______________________________________________________________________ Each option is described in detail below. A This option sets the limit for the amount of Email that any single caller can leave during a visit (as it can be distracting AND FRUSTRATING when some guy finds the need to mass mail every caller three times a week!). B This option sets the limit for the number of feedback messages that any single caller can send during a visit. This option should usually be kept low, the reason being that feedback comes to YOU, the SysOp, and if you have 40 callers a day, and every one leaves 20 messages to you, soon you no longer have any room on your hard drive! C This option sets the limit for the number of public messages that any single caller can send during a visit. This option is RARELY exceeded (unfortunately!). D This option sets the limit for the number of chat attempts that any single caller can make during a visit. Again, this number is usually kept rather low, as a SysOp has a life besides the BBS (usually!), and some callers constantly page for chat when he has other things that need to be done. E This option sets the limit for the amount of Email that can be kept waiting for a given caller. It keeps a limit so that people are ENCOURAGED to discard old Email to save disk space. - Page 26 - Telegard Main Documentation - Version 2.5 F This option sets the limit for the amount of Email that can be kept waiting for a Co-SysOp. This number should be relatively high compared to that of an average user, as a remote has duties that may include file requests, system questions and new user validations. G This option sets the limit for the number of lines allowed in any given message for a normal user. H This option sets the limit for the number of lines allowed in any given message for the Co-SysOp. Again, a Co-SysOp deserves more as, though most questions are short, some may go into VERY lengthy explanations and replies. I This option sets the limit for the number of attempts a user can make to log on to the BBS, before the system automatic- ally hangs up on the caller. J This option sets the delay value between the time the system erases the "Saving message..." string and prints the "Message posted on..." string when posting a message. Setting this option to zero (0) eliminates the delay completely. K This option sets the SysOp chat color, which can be 0 to 9 (corresponding to the Telegard MCI colors, explained later). For those users that can view ANSI colors, this color is used while the SysOp is typing. Note that if a SysOp chat color filter is defined (more on this later), this setting is ignored. L This is analogous to option K, except that it pertains to the user chat color. (The reason for different chat colors for the SysOp and the user is primarily for visual ease and differentiation of the conversation.) Same rules and restrictions apply. M This option sets the minimum amount of hard drive space (in kilobytes, or K) that MUST be available in order to post a public message or Email. It is designed as a safeguard, as problems can result if there is not enough space available (result can be a runtime error and/or a locked-up system). N This is analogous to option M, except that it specifies the minimum amount of hard drive space (again, in kilobytes) that MUST be available to upload a file. This is another safeguard so people can't fill up the drive. O This option sets the number of days that the SysOp back logs are kept. The maximum is 15, so that the SysOp has a running record of up to approximately two weeks to review BBS activity. P This option sets the number of minutes of inactivity before the WFC screen is blanked. This is provided as a safeguard against "burning in" the image of the WFC screen onto the - Page 27 - Telegard Main Documentation - Version 2.5 phosphor of the CRT. (Pressing the [Enter] key will redisplay the WFC screen.) Setting this option to zero (0) will disable the blanking feature. R This option defines the default number of video columns set for the user during the new user logon process. S This option defines the default number of video rows set for the user during the new user logon process. - Page 28 - Telegard Main Documentation - Version 2.5 ------------------------- GENERAL FLAGGED FUNCTIONS ------------------------- These options control various functions of the BBS, from clearing the screen before displaying messages to allowing handles to controlling various actions during the logon procedure. Upon selection this option, the following menu is displayed: ______________________________________________________________________ General flagged functions: A. Special effects :On B. Use FOSSIL comm driver :Off C. Handles allowed on system:On D. Phone number in logon :On E. Local security protection:Off F. Local screen security :Off G. Global activity trapping :Off H. Auto chat buffer open :On I. AutoMessage in logon :On J. Bulletins in logon :On K. Last few callers in logon:On L. "Your Info" in logon :On M. BBS is multi-tasking :Off N. Offhook in local logon :On O. Mandatory voting :Off P. Compress file/msg numbers :Off R. UL duplicate file search :Off S. SysOp Log type :File Only T. Strip color off SysOp log:Off U. Use WFC menu logo :On V. Use BIOS for video output:On W. Suppress snow on CGA :Off X. Use EMS for overlay file :Off 1. New user message sent to :1 2. Guest user number :Off 3. Mins before timeout bell :2 4. Mins before timeout :5 Enter selection (A-X,1-4) [Q]uit : ______________________________________________________________________ Each option is described in detail below. A This option controls the "special effects" feature of the WFC screen (the rotating colors in the "TELEGARD" logo). B This option specifies whether or not to use a FOSSIL communications driver instead of the built-in communications routines. (Refer to the "Modem Information" section for more details about FOSSIL drivers.) If this option is enabled, and Telegard does not detect a FOSSIL driver, the built-in communications routines will be used. C This option specifies whether or not handles are allowed on the system. Having this option active enables users to be expressed by a pseudonym or alias (their real name is asked for during the new user logon process). Disabling this option allows only the user's real name to be used (primarily for businesses and SysOps who wish callers to use their real names). D This option specifies whether or not the user's phone number is asked for during the logon process. This acts as an extra security feature just in case someone has illegally acquired someone else's password. - Page 29 - Telegard Main Documentation - Version 2.5 E This option controls local security protection. When set to ON, it prevents the SysOp (and anyone else that may be present) from seeing the caller type his password and phone number (if active). Good for "friends" that visit you and may try something stupid. F This option controls local screen security. When set to ON, the SysOp will see a "Baud = nnnnn" message in the upper left hand corner of the screen as usual. However, that is ALL that will remain, in addition to the status line... in effect, you CANNOT see what is going on at ALL. G This option controls global activity trapping. If set to ON, the BBS will make a trap file for EVERY caller (in the form of TRAP*.MSG). This is useful in the event of numerous system errors, runtime errors or BBS crashes, in order to find a solution to the problem. H This option specifies whether or not to automatically open the chat buffer. If set to ON, the chat is automatically recorded in the CHAT*.MSG file when the SysOp initiates chat, without having to press the [Home] key first. I This option specifies whether or not the auto-message is displayed during the logon process. Enables you to make the auto-message totally optional or mandatorily viewed by all callers. J This option specifies whether or not the bulletin menu is presented during the logon process, enabling the SysOp to display dated bulletins that are of special interest to callers, such as BBS lists, online game scores, file request lists, and so on. K This option specifies whether or not the last few callers are displayed during the logon process. If set to ON, the last few callers will be displayed right after the automessage (if present). L This option specifies whether or not the user's individual statistics are shown during the logon process. This feature was left over from early versions of Telegard, and has been made optional by request of various SysOps and users that did not appreciate it being automatically displayed. M This option specifies whether or not the BBS is running under a multi-tasking environment. (This feature has not yet been implemented.) N This option specifies whether or not the phone should be taken off-hook during local logon, so that the SysOp can use the BBS without worrying about a user trying to log on. O This option specifies whether or not to force all users to vote on all unanswered voting questions before they may enter the BBS. - Page 30 - Telegard Main Documentation - Version 2.5 P This option controls the "compression" of file and message base numbers. This feature takes a little explaining, so an example is in order: Say that you have defined ten message bases (1-10), and that bases 5, 7 and 8 are restricted from certain users. Now, normally, when the list of message areas is displayed, those areas will not be shown, leaving a gap in the message base numbers (1, 2, 3, 4, 6, 9, 10). If this option is set to ON, all the message base numbers are made contiguous (1, 2, 3, 4, 5, 6, 7) to the user. THIS, HOWEVER, DOES NOT CHANGE THE PHYSICAL BASE NUMBERS! This feature takes some getting used to, so you should experiment with it to make yourself more familiar with it. R This option controls the search for duplicate files during the uploading process. If set to ON, the BBS will search the file directories for the same file that the user is attempting to upload. The BBS will also perform "partial" searches (if the same file is uploaded with a different extension, i.e. "FILE.ZIP" already exists and the user tries to upload "FILE.ARC"). In this case, if the preexisting file is in a base accessible to the user, the user will be asked if the upload is still wanted. If the preexisting file is in a base that the user does NOT have access to, the upload will be rejected outright. S This option controls the operation of the SysOp log. When this option is selected, you can choose one of three types: File only -- Saves the day's events in the SYSOPxx.LOG file in the TRAP directory. Printer & file -- Saves the data in the SYSOPxx.LOG file and spools the output to the printer throughout the day as activity continues. Printer only -- Spools the information only to the printer, providing a hardcopy record, but no file record, of daily activity. T This option specifies whether or not Telegard's MCI color codes will be stripped from the SysOp log. If set to ON, the color codes are stripped (leaving pure ASCII text). U This option specifies whether or not the "TELEGARD" logo is displayed at the WFC menu. If set to OFF, a full-screen WFC screen can be created (it releases an extra five lines at the top of the screen for use). V This option specifies whether or not ROM BIOS routines are to be used for all local screen output. If disabled, screen output is written directly to video memory. Enabling this option is useful on systems that aren't 100% compatible with the IBM PC standard (for instance, the Tandy 2000). - Page 31 - Telegard Main Documentation - Version 2.5 W This option specifies whether or not "snow checking" is required for Color Graphics Adapters (CGAs). On most CGAs, interference will result if characters are stored in video memory outside the horizontal retrace intervals, resulting in "snow" (this does not occur with Monochrome Display Adapters [MDAs], Enhanced Graphics Adapters [EGAs], or Video Graphics Array adapters [VGAs]). Enabling this option will make all screen writes occur only during the horizontal retrace intervals. (This option has no effect if option V is enabled to select BIOS output.) X This option specifies whether or not the BBS.OVR file is to be stored in, and accessed from, EMS (expanded) memory. If the overlay can't be stored in EMS (no EMS present, not enough EMS RAM available, etc.), Telegard will access the overlay from disk as usual. NOTE: Any changes to this option require that Telegard be exited and restarted for the change to take effect. Also, you will need enough EMS memory to hold the entire overlay file in order for this feature to work. 1 This option defines the number of the user that will receive "new user" messages. The default is user 1 (the SysOp), but can be changed if you have another user who handles the validation of new users. 2 This option specifies whether or not a "guest user" account is to be used. If toggled on, a generic account with low access is created called "GUEST", so that new callers have the option of investigating the BBS before deciding to join as an active user. The default password is "GUEST" (which can be changed in the "BBS Configuration and File Paths" section) and the default phone number is "0000". 3 This option specifies the number of minutes before a bell is sounded to alert the user that the system is about to "time out" and hang up. Handy for users who fall asleep at the keyboard! 4 This option specifies the number of minutes that are allowed to pass with no activity before the system "times out" and hangs up. This value should, obviously, be set higher than the "time out bell" value in option 3! - Page 32 - Telegard Main Documentation - Version 2.5 -------------------------- FILE SECTION CONFIGURATION -------------------------- File Section Configuration allows you to control various options associated with the file transfer section. In addition, it allows the definition and maintenance of Telegard's built-in archive manipulation settings, one of the system's most powerful features! Upon selecting this option, the following menu is displayed: ______________________________________________________________________ File section configuration A. Archive configuration B. Upload/download ratio :Active C. Auto file point compensation :In-active D. File point compensation ratio :3 to 1 E. Base file size per 1 file point :10k F. Upload time refund percent :100% G. "To-SysOp" file base :0 H. Auto-validate ALL files ULed? :No I. Remote DOS re-direction device :COM1 J. Max k-bytes allowed in TEMP\3\ :500 K. Min k-bytes to save for resume :100 Enter selection (A-K) [Q]uit : ______________________________________________________________________ Each option is described in detail below. A This option takes you into the archive configuration section, which will be discussed in the latter part of this section. B This option specifies whether or not upload/download ratio checking is active. If active, a user must have uploaded X amount (in kilobytes) of files in order to download a file. C This option specifies whether or not automatic file point compensation is active. If active, files are automatically given X amounts of points per X amount of kilobytes uploaded, as determined by the setting of option D. D This option works in conjunction with option C, and defines how many points a user is entitled to download in files, divided by the number of points uploaded (works similar to the upload/download ratio system). E This option also works in conjunction with option C, and defines how many file points should be rewarded for a given upload, based on the number of kilobytes in the given upload. F This option defines the percentage of time that a user is refunded after uploading a file. It calculates an amount of - Page 33 - Telegard Main Documentation - Version 2.5 time in hours, minutes and sections, that a user is to have restored to their remaining time online after the upload, as a token from the SysOp. The default is 100%, or the same amount of time lost uploading the file. Raising the value will award more time, lowering the value will restore less time. Note that if an event is scheduled during the user's time online, the amount of time is NOT refunded to the user until after the event has taken place (when they next log on). G This option defines the file base that is designated as "SysOp only". This is for SysOp-only uploads, performed in the file transfer area by preceding the uploaded file's description with a backslash ("\"). The default is area 0. It is recommended that you set aside area 0 for SysOp-only uploads, because if you define another file area as such, and change this option to point to it, then add or delete other file areas before it, you will have to constantly change this option. H This option specifies whether or not all uploaded files are to be auto-validated. This option defaults to NO, which is preferred by many SysOps (that way, they can view the file and determine its worth, and also check it for possible viruses that may cause unwanted anguish to a user or a fellow SysOp). I This option defines the remote DOS re-direction device. Normally, activity in DOS is tailored for the local user, and a remote who may need to edit a batch file, etc., would have a hardship in doing so. Thus, a re-direction device will show DOS activity through the CTTY device using the re- direction device. Got all that? No? Here's the short version: It allows both the local and remote users to see what's going on when the remote user has shelled to DOS, as long as a device driver that redirects video output has been installed using CONFIG.SYS. (An excellent driver for this purpose is GATEWAY2.SYS, which is installed using CONFIG.SYS, and can be configured for use with COM1 [GATE1] or COM2 [GATE2]. GATEWAY2.SYS should be available from any local system as GATEWAY2.ZIP; if not, it is available from the Telegard Alpha sites.) J This option defines the maximum number of kilobytes allowed in the temporary archive working directory. K This option defines the minimum number of kilobytes that must have been sent during an upload before it can be saved for a resume-later upload operation, in the event that the upload is aborted. - Page 34 - Telegard Main Documentation - Version 2.5 ARCHIVE CONFIGURATION As described above, option A will take you into the archive configuration section. This section defines the various archive formats supported by Telegard's internal archive manipulation functions. These functions will, among other things, automatically convert uploaded files from one archive format to another (for example, convert to ZIP format all archives uploaded in ARC format). It is a feature that, until now, has not existed on any BBS software package! (See the "File Base Editor" section for more information on this feature.) Upon selection, the following menu is displayed: ______________________________________________________________________ Archive configuration edit 1. Archive comment: Telegard BBS 000-000-0000 2. Archive comment: *None* 3. Archive comment: *None* NN:Ext:Compression cmdline :Decompression cmdline :Success Code ==:===:========================:======================:============ +1 ZIP PKZIP -aex @F @I PKUNZIP @F @I 0 -2 ARC PKPAK a @F @I PKUNPAK @F @I 0 -3 ZOO ZOO aP: @F @I ZOO x @F @I 0 -4 PAK PAK a @F @I PAK e @F @I -1 (ignores) -5 LZH LHARC A @F @I LHARC X @F @I 0 Archive edit (Q,?=help) : ______________________________________________________________________ Pressing "?" will display the functions allowed at this menu: <CR>Redisplay screen 1-3:Archive comments (I)nsert archive (D)elete archive (M)odify archives (Q)uit and save Each option is described below: 1-3:Archive comments -- Allows the definition of up to three different archive comments, which can be added to archive files automatically after they have been uploaded. Note that not all archive formats support archive comments. (I)nsert archive -- Creates a new entry in the archive format table. (D)elete archive -- Remove an entry from the archive format table. (M)odify archives -- Allows modification of the archive format table entries (more on that later). (Q)uit and save -- Saves the table and returns to the File - Page 35 - Telegard Main Documentation - Version 2.5 Section Configuration menu. When you select the (M)odify command, you will be asked which format you wish to modify. After you select one, the following screen is displayed (the ZIP format is used as an example): ______________________________________________________________________ Archive #1 of 5 1. Active : Yes 2. Extension name : ZIP 3. Interior list method : "/1" - *Internal* ZIP viewer 4. Compression cmdline : PKZIP -aex @F @I 5. Decompression cmdline : PKUNZIP @F @I 6. Integrity check cmdline: PKUNZIP -t @F 7. Add comment cmdline : PKZIP -z @F 8. Errorlevel for success : 0 Q. Quit Edit menu: (1-8,[,],Q) : ______________________________________________________________________ The "[" and "]" keys will allow you to move back and forth between each entry in the archive format table. Options 1-8 are described in detail below. Pressing "Q" will return you to the Archive Configuration Edit screen. 1 This option specifies whether or not the archive format is active. If inactive, then Telegard will not allow any operation on archive files in this format, such as integrity checking or viewing its contents (the uploading of such files, however, will not be impaired). 2 This option specifies the extension used for files saved in the particular archive format. For example, "ZIP" is used as an extension for archive files created by the PKZIP archiving program. In common usage, the file extension usually describes the archive format itself (ZIP format, ARC format, ZOO format, etc.). 3 This option defines the method used to view the contents of archive files in the particular format. The following entries are allowed: /1 - Uses the internal ZIP file viewer /2 - Uses the internal ARC/PAK file viewer /3 - Uses the internal ZOO file viewer /4 - Uses the internal LZH file viewer If you have defined an archive format that is not supported internally, you may use this option to define the command line required to view the archive's contents, using the actual archiving program itself (which usually provides a method of viewing the contents of archives it creates). The archiving program must reside somewhere in your DOS PATH in order for this feature to work. - Page 36 - Telegard Main Documentation - Version 2.5 When defining the command line, substitute the "@F" MCI where the actual archive filename would normally be placed. Telegard will automatically replace the MCI with the intended filename. 4 This option defines the command line used to create or update an archive file using this format, using the actual archiving program itself. The archiving program must reside somewhere in your DOS PATH in order for this feature to work. When defining the command line, substitute the "@F" and "@I" MCIs where the actual archive filename and file to be archived, respectively, would normally be placed. Telegard will automatically replace the MCIs with the proper information. Consult the documentation for the particular archiving program for the command line options required to create or update an archive file. 5 This option is similar to option 4, except that it defines the command line used to extract files from an archive file. All rules and restrictions mentioned above also apply. 6 This option is also similar to option 4, except that it defines the command line used to check the integrity of an archive file. All rules and restrictions mentioned above also apply (except that the "@I" MCI will more than likely not be needed). If the archiving program does not support integrity testing, this option can be set to NULL (in which case the BBS will not check the integrity of the archive file after it has been uploaded). 7 This option is also similar to option 4, except that it defines the command line used to add a comment to an archive file. All rules and restrictions mentioned above also apply (except that, as in option 6, the "@I" MCI will more than likely not be needed). If the archiving program and/or archive format does not support archive comments, this option should be set to NULL. 8 This option defines the ERRORLEVEL value that the archiving program returns when an operation has been successfully completed. Most archiving programs return an ERRORLEVEL of 0 in this case. However, some do not return an ERRORLEVEL value at all. In situations like these, setting this option to "-1" will ignore any value returned from the program, and assume that all operations were successful. - Page 37 - Telegard Main Documentation - Version 2.5 ----------------------------------- NEW USER & AUTO-VALIDATION SETTINGS ----------------------------------- This section defines the security levels and flags given to users before and after they have been validated. Upon selecting this option, the following screen is displayed: ______________________________________________________________________ New user configuration Auto-validation command A. SL :20 F. SL :50 B. DSL:20 G. DSL:50 C. AR :-------------------------- H. AR :-------------------------- D. AC :-----*--K-/---- I. AC :----------/---- E. #FP:0 Enter selection (A-I) [Q]uit : ______________________________________________________________________ Each option is described in detail below. A This option defines the security level (SL) of a new user, which is the status they are trusted with as user and is usually periodically upgraded as the individual proves himself worthy of higher access. This is the beginning access level on your BBS, before a user is validated. B This option defines the download security level (DSL) of a new user. The DSL is analogous to the SL, except that it is used primarily in the file transfer section. C This option defines the area flags (AR flags) for a new user. Telegard currently has 26 AR flags, which correspond to the letters of the alphabet (A-Z). They are used for special accesses, like special interest groups (SIGs), high security file bases, text file areas, etc. For the most part, a new users should not have ANY access to these features until you have reviewed their information and validation letter to determine what their interests are. When used in conjunction with the ACS system, AR flags can create a powerful security and special-interest system. D This option defines the access flags (AC flags) for a new user. AC flags are rather generic in nature, and not configurable like the AR flags. They are designed for both "problem users" and "special users". As a SysOp, from time to time you will run into persons who abuse features of the system, and without lowering their access level, AC flags are the GREAT denominator. The possible flags available at any given time are as follows: LCVBA*PEKM/1234 However, no user will have all of these, as the first subset - Page 38 - Telegard Main Documentation - Version 2.5 consists of "penalty" flags, whereas the second subset consists of "reward" flags. Each flag is defined as follows: L Can logon ONLY once/day -- Does not allow a given caller to have more than one BBS logon in a given day. Used for callers who tie up your BBS all day and don't allow other callers a fair opportunity for system time. C Can't page SysOp -- Does not allow the caller to use the CHAT commands throughout the BBS. Some callers choose to constantly page the SysOp for rather unimportant reasons; they become extremely annoying, as well as extremely time consuming! V Posts marked unvalidated -- Marks all public messages as "unvalidated" until the SysOp decides to either validate or delete them. Used for callers who leave abusive or off-topic messages, despite repeated warnings to the contrary. B Back/downspacing restricted -- Back/downspacing is a Telegard MCI subset that allows the user to do various "tricks", such as spinning the cursor and moving the cursor all over the screen. This flag is used to prevent callers from tying up the message base with fancy, yet childish (and useless) posts. A Can't add to BBS list -- This flag prevents the caller from using the (A)dd command in the BBS list menu. Primarily used for callers who keep adding the same BBS, false boards, voice phone numbers, etc. to the BBS list. * Can't post/send anon. -- This flag prevents the caller from being able to post public or Email messages anonymously. Used for callers who like to verbally assault other users; with this restriction, all parties are aware of EXACTLY who posts the message(s) in question. P Can't post at all -- This flag prevents a user from posting any messages in the message base. Used for callers who abuse the message bases wither with blank posts on a post/call ratio oriented system, excessive profanity, inane comments, verbal assaults, etc. E Can't send Email -- This flag prevents the caller from sending ANY Email to another user. Used for callers who harass other users and don't stop, despite SysOp intervention. - Page 39 - Telegard Main Documentation - Version 2.5 K Can't vote -- Does not allow the caller to have access to the voting booth. Basically, this is the most harmless restriction, as only the SysOp and trusted users have designed the voting questions (however, some users don't deserve ANY breaks! <hehehe>). M Automatic mail deletion -- This flag will force the BBS to automatically delete a caller's Email. Primarily used as a harassment tool for persons who have previously abused the Email system and have lost the privilege. 1 No UL/DL ratio check -- This flag will suppress the mandatory upload/download ratio check. Used for favored callers as a reward, and for remote SysOps. 2 No post/call ratio check -- This flag will suppress the post/call ratio check on systems which implement this feature. Used for remotes who may have other important tasks, such as user and file validations, and it proves to be a hindrance. 3 No file points check -- This flag will suppress the checking of a user's file points when requesting a download of a file. Used as a reward to a good uploader on a file points oriented system, or to a remote. 4 Protection from deletion -- This flag will prevent a user's account from being deleted, until it is toggled off. Good for the SysOp, remote SysOps, message base SysOps and all other high security users. E This option sets the initial number of file points awarded to new users. The value here is determined, basically, by the generosity of the SysOp! F This option sets the SL value for a validated user. This value should be greater than that of a new users, because they passed your ideals of what a valid user should be. Permits higher access in the message base and other areas of the system. G This option is similar to option F, except that it pertains to the DSL value. Permits higher access in the file transfer section. H This option defines the AR flags for a validated user. See option C above for a complete description of AR flags. I This option defines the AC flags for a validated user. See option D above for a complete description of AC flags. - Page 40 - Telegard Main Documentation - Version 2.5 --------------------------- MISCELLANEOUS CONFIGURATION --------------------------- This section is for miscellaneous configuration options that don't fit anywhere else in the System Configuration. Upon selecting this option, the following menu is displayed: ______________________________________________________________________ Miscellaneous configuration A. System start-out menu :MAIN B. SysOp chat color-filter : C. User chat color-filter : D. Default bulletin prefix file:BULLET Enter selection (A-D) [Q]uit : ______________________________________________________________________ Each option is described in detail below. A This option defines the menu that is loaded first when a user logs on, which must be defined and must reside in the MENUS directory. The default is MAIN, or the main menu. This option is useful for forcing users to start out at a different menu (the file transfer menu, the on-line programs menu, a user-defined menu, etc.). B This option defines the color filter configuration file used during chat for the SysOp's input. The file must reside in the AFILES directory. If undefined, the SysOp chat color defined in the General Variables section is used. C This option is similar to option B, except that it defines the color filter configuration file used during chat for the user's input. Same rules and restrictions apply. D This option defines the prefix name used for bulletin files. One to seven characters may be input, which would allow for seven- to one-character selections at the bulletin menu. - Page 41 - Telegard Main Documentation - Version 2.5 --------------------- FIDONET CONFIGURATION --------------------- This section defines the information required for use by external FidoNet message processing utilities. This includes your FidoNet address, a default origin line, and options used when tossing and scanning messages. (If you are not a FidoNet node, then you can skip this information.) Except for the FidoNet address, all information specified here is used as defaults when creating a new message base (and, in the case of the origin line, if an individual origin line is not specified). Upon selecting this option, the following menu is displayed: ______________________________________________________________________ FidoNet configuration A. FidoNet address : 0:0/0.0 B. Origin line : Telegard BBS C. Strip IFNA kludge lines : Yes 1. Color of standard text : 1 D. Strip SEEN-BY lines : Yes 2. Color of quoted text : 3 E. Strip origin lines : No 3. Color of tear line : 9 F. Strip centering codes : Yes 4. Color of origin line : 5 G. Strip box codes : Yes H. Center box/center lines : Yes I. Add tear/origin lines : Yes Enter selection (A-I,1-4) [Q]uit : ______________________________________________________________________ Each option is described in detail below. A Defines your given FidoNet address. You will be prompted for each individual component of the address (zone, net, node and point numbers); pressing [ENTER] at any prompt will leave that component unchanged. The FidoNet address is displayed in various places in the system (including the "Welcome to..." line during logon). However, if the net number is equal to "0", then the address is NOT displayed (since there is no such thing as Net 0 in FidoNet). B Defines the origin line placed at the bottom of outgoing messages. Do not put your FidoNet address in the origin line; Telegard (as well as external message processing utilities) will add it automatically. This origin line is used if an individual origin line is not specified for a message base (and if THIS origin line isn't defined, then the first 50 characters of the BBS name are used). C Toggles stripping of IFNA kludge lines from incoming messages. Kludge lines begin with the ^A code (1 decimal), and are not normally needed. Applicable to both EchoMail - Page 42 - Telegard Main Documentation - Version 2.5 and GroupMail bases. D Toggles stripping of SEEN-BY lines from incoming messages. SEEN-BY lines define which nodes have received the message, and are not normally needed once the message has been received. Useful only for EchoMail bases, as GroupMail messages don't have SEEN-BY lines. E Toggles stripping of origin lines from incoming messages. The origin line identifies the system that originated the message, and is usually desirable. Applicable to both EchoMail and GroupMail bases (though GroupMail messages aren't required to have origin lines). F Toggles stripping of "center line" codes from lines in outgoing messages. The centering code (^B, or 2 decimal) tells Telegard to display the line in the center of the screen according to the current screen width. Unless you are communicating strictly with another Telegard system, this code has no meaning in FidoNet messages. Applicable to both EchoMail and GroupMail bases. G Toggles stripping of "box line" codes from lines in outgoing messages. The box code ("`#[") tells Telegard to enclose the text in a box, centered on the screen according to the current screen width. Unless you are communicating strictly with another Telegard system, this code has no meaning in FidoNet messages. Applicable to both EchoMail and GroupMail bases. H Toggles centering of boxed/centered lines in outgoing messages. If enabled, lines that start with a box or center code will be centered on an 80-column line by padding the line to the left with spaces. (This is only done if box and/or centering codes are being stripped.) Applicable to both EchoMail and GroupMail bases. I Toggles the automatic addition of tear and origin lines to messages posted in FidoNet bases. The tear line will use the BBS version number ("--- Telegard v2.5", for example). Applicable mainly to GroupMail bases, as GroupMail messages aren't required to have tear and origin lines (they are mandatory, however, for EchoMail messages). 1 Defines the color used to display normal text. The default is MCI color #1 (cyan in the default setup). Applicable to both EchoMail and GroupMail bases. 2 Defines the color used to display quoted text. Quoted text lines usually start with a ">" character, and serve to quote portions of a previous message. If the line contains a ">" character anywhere in positions 1 through 5, it is displayed using this color, which defaults to MCI color #3 (bright cyan in the default setup). Applicable to both EchoMail and GroupMail bases. - Page 43 - Telegard Main Documentation - Version 2.5 3 Defines the color used to display the tear line. The tear line defines the program used to process the message on the originating system; it begins with "--- ", followed by the name of the program. The default is MCI color #9 (bright green in the default setup). Applicable to both EchoMail and GroupMail bases (though GroupMail messages aren't required to have a tear line). 4 Defines the color used to display the origin line. As explained above, the origin line identifies the system that the message originated on; it begins with " * Origin: ", followed by a message defined by the SysOp of the originating system. The default is color #5 (yellow in the default setup). Applicable to both EchoMail and GroupMail bases (though GroupMail messages aren't required to have an origin line). - Page 44 - Telegard Main Documentation - Version 2.5 -------------------- STRING CONFIGURATION -------------------- This section will allow you to add different colors and special codes to, and generally change the appearance of, many of the strings displayed throughout the system. The String Configuration section is currently comprised of five (5) pages of information; upon selecting this option, the first page will be displayed. Following is a display of all five pages, with descriptions of each field. Three command keys are available at all screens: "[" to move to the previous screen, "]" to move to the next screen, and "Q" to return to the System Configuration section. With only a few exceptions, all strings defined below have a maximum limit of 80 characters, and may contain ASCII text, MCI commands or MCI color codes. ______________________________________________________________________ String configuration - page 1 of 5 A. Ansi logon Q.:Display ANSI logon? B. Logon note #1:Enter your Telegard NAME or USER NUMBER Logon note #2:* NEW USERS, enter "NEW" * C. Logon prompt :Logon : D. Echo chr :X E. SysOp IN :The SysOp is probably around! F. SysOp OUT :The SysOp is NOT here, or doesn't want to chat G. Engage chat :@MThe SysOp brings you into chat! H. Exit chat :The SysOp returns you to the BBS....@M I. SysOp working:{-Please Wait-} J. Pause screen :(* pause *) Enter selection (A-J,[,]),(Q)uit : ______________________________________________________________________ A This question is asked of ALL callers, both off-site and local (except when the SysOp is in fast logon mode). If the user enters "Yes", an ANSI picture (WELCOME.ANS) is displayed. If the user enters "No", a text file (WELCOME.MSG) is displayed. B These lines are provided as an aid to callers, especially to new users to a Telegard system who may not know how to log on as a new user. C This is displayed just before the input area, and is usually a prompt such as "Logon:" that lets the caller know that the system is ready to log them on. D This is the character that is echoed to the screen when the caller types his password and phone number. Designed as a security feature so nobody standing behind the caller's back can steal their account. - Page 45 - Telegard Main Documentation - Version 2.5 E This string tells the user that the SysOp is available and ready to chat. This is displayed ONLY during the defined chat hours (defined in the "BBS Configuration and File Paths" section). F This string is displayed when the SysOp is not available to chat (or doesn't wish to!). It works according to the defined chat hours and is displayed at all times EXCEPT during chat hours. G This string is displayed when the SysOp has engaged the Chat mode. H This string is displayed as the SysOp disengages the Chat mode. I This string is displayed when the SysOp is performing a function while a user is online (such as editing a user's security information). J This works off the default screen size, established during the new user logon (and configurable at the Personal Information menu). For instance, the default number of lines on an IBM-compatible system is 25. So, after every 25 lines of text is printed, the user is temporarily paused to allow viewing of the text. This message is displayed when the pause is active; pressing [ENTER] releases the pause and continues normal operations. ______________________________________________________________________ String configuration - page 2 of 5 A. Message entry L#1:Enter message now. You have @X lines maximum. B. Message entry L#2:Enter /S to save. /? for a list of commands. C. NewScan start :[@Y - @W msgs] NewScan began.@M D. NewScan done :[@Y - @W msgs] NewScan complete.@M E. Read msgs prompt :[@Y]@M[@U] Read (1-@W,<CR>,T,Q,P,A,R,B,W,D) : F. Automessage by :AutoMessage by: G. Auto border char.:- Enter selection (A-G,[,]),(Q)uit : ______________________________________________________________________ A This is the first line of the description for entering public messages and Email, displayed just after the header information is entered. B This is the second line of the description for entering public messages and Email. Both lines may contain color and MCI commands. C This message is displayed at the start of each message base during a global NewScan for new messages. D This message is displayed at the end of each message base during a global NewScan for new messages. - Page 46 - Telegard Main Documentation - Version 2.5 E This prompt is displayed after each scanned or NewScanned message, and provides a list of available commands that may be used in the reading of messages. F This message is displayed as the header of the automessage. It can be either straight ASCII text, or colorized text using the MCI colors. G This character is a straight uncolored ASCII character. It surrounds the text in the automessage at both the top and the bottom of the message. ______________________________________________________________________ String configuration - page 3 of 5 A. Shell to DOS L#1 :>> System Operator has Shelled to DOS, please wai t ... B. Shell to DOS L#2 :>> Thank you for waiting C. Chat call L#1 :Paging System Operator for chat, please wait..... D. Chat call L#2 : >><*><< E. Guest user info :Enter "GUEST" as your user name to be a guest use r on the system. F. Name not found :That name is NOT found in the user list. G. Bulletin line :Enter Bulletin Selection (XX,?,Q=Quit) : H. Thanks for voting:Thanks for taking the time to vote! Enter selection (A-H,[,]),(Q)uit : ______________________________________________________________________ A This message is displayed when the SysOp has performed a local shell to DOS. While the SysOp is in DOS, the caller is prevented from doing anything. B This message is displayed when the SysOp has returned from dropping to DOS. C This message is displayed when a user pages the SysOp for chat during declared chat hours. D This message is displayed while the BBS is paging the SysOp during chat hours. It is displayed nine times, with a beep occurring once prior to each display and once after. A high pitched beeping sound on the local end is used to alert the SysOp that a user wishes to chat. E This line is displayed with the logon lines at the time of logon, if a guest user account has been defined (see the "General Flagged Functions" section for more information about this feature). F This message is displayed if the user name entered during the logon process is not present in the NAMES.LST file. It serves to warn the user that either they entered their name wrong, or they have not signed onto the BBS before. - Page 47 - Telegard Main Documentation - Version 2.5 G This message is displayed below the list of the BBS bulletins. It contains commands that are present in the bulletin menu. H This string is displayed after a user has accessed the voting booth and changed one ore more questions, or answered new questions. ______________________________________________________________________ String configuration - page 4 of 5 A. List line :List files - P to pause B. File NewScan line:Search for new files - C. Search line :Search all directories for a file mask - D. Find Descrip. L#1:Search descriptions and filenames for a keyword - E. Find Descrip. L#2:Enter the string to search for: F. Download line :Download - You have @P file points. G. Upload line :Upload - @Kk free on this drive H. View content line:View archive interior files -@MP to Pause, N for Next file I. Insuff. file pts :Access denied: Insufficient points to download. J. Bad UL/DL ratio :Access denied: Your UL/DL ratio is out of balance : Enter selection (A-J,[,]),(Q)uit : ______________________________________________________________________ A This message is displayed when the user selects the command to list files at the file transfer menu. B This message is displayed when the user selects the command to scan for new files at the file transfer menu. C This message is displayed when a user searches for a particular file or files. D This is the first line of the message that is displayed when a user selects the command to search for a text string to match a description or filename at the file transfer menu. E This is the second line of the message described in option D. F This message is displayed when a user attempts to download a file in either regular or batch mode. G This message is displayed when a user attempts to upload a file in either regular or batch mode. H This message is displayed when a user attempts to view the contents of an archive file available for downloading. I This message is displayed when a user attempts to download a file that is worth more file points than they have credit for. Used only on BBSes that use the file point system. - Page 48 - Telegard Main Documentation - Version 2.5 J This message is displayed when a user attempts to download a file when their upload/download ratio is out of balance. Used only on BBSes that use the UL/DL ratio system. ______________________________________________________________________ String configuration - page 5 of 5 A. P/N file info :P to Pause, N for next directory. B. Get filespec L#1 :[Enter]=All files C. Get filespec L#2 :File mask: D. Add to batch :File added to batch queue. Enter selection (A-D,[,]),(Q)uit : ______________________________________________________________________ A This message is displayed when a NewScan of the file bases has begun. Pressing "P" will pause during a file listing. Pressing "N" will stop the current base being scanned and start scanning the next available file base, if present. B This is the first line of the message displayed when a file search is being attempted. C This is the second line of the message displayed when a file search is being attempted. D This message is displayed when a user has added a file to the upload or download queue for batch uploading or downloading. - Page 49 - Telegard Main Documentation - Version 2.5 -------------- DEFAULT COLORS -------------- This option is used to edit the colors for prompts, messages, etc., to add color and attractiveness to your BBS. You can edit either black- and-white or ANSI colors. The default colors are the ones used for new users; once set, the user can change his defined colors while online. Below is a list of the standard color table: 0. Other Used for miscellaneous messages 1. Default Used for public message and Email text 2. Unused Unused 3. Yes/No Used for responses to Yes/No questions 4. Prompts Used for prompts 5. Note Used for file descriptions 6. Input line Used for keyboard input responses 7. Y/N question Used for Yes/No prompts 8. Blinking Used for unvalidated files and warnings 9. Other Used for miscellaneous messages The color editor itself is pretty self-explanatory, so the details will not be presented here. (In a nutshell, both foreground and background colors, and blinking, can be selected from the full ANSI color set for each of the ten items in the color table.) Suffice it to say that experimentation is in order if you wish to redo the standard color scheme, until you attain a combination to your liking. - Page 50 - Telegard Main Documentation - Version 2.5 ---------------- TIME LIMITATIONS ---------------- This section defines the maximum amount of time (in minutes) that a user can remain online for each security level (SL) setting. Upon selecting this option, the following screen is displayed (screen has been shortened for simplicity): ______________________________________________________________________ Editing: Time limitations 0:1 20:20 40:50 60:90 80:110 100:130 120:130 140:130 1:1 21:20 41:50 61:90 81:110 101:130 121:130 141:130 . . . . . . . . . . . . . . . . . . . . . . . . 19:10 39:40 59:80 79:100 99:120 119:130 139:130 159:130 Range settings (S)et (T)oggle (Q)uit : ______________________________________________________________________ The three commands available here are: (S)et - Sets the SL values for a range of SL settings. You are asked to enter the starting and ending SL settings, and the new value to be placed in those settings. Available SL settings are 0-255. (T)oggle - Switches the display between showing SL settings 0-159 and 160-255. Note that this does not affect the setting of SL values; the (S)et command can change values anywhere in the 0-255 SL range without necessarily having them currently displayed on the screen. (Q)uit - Returns you to the System Configuration menu. - Page 51 - Telegard Main Documentation - Version 2.5 ----------------------- CALL ALLOWANCES PER DAY ----------------------- This section works off the exact same principle as the Time Limitations section, therefore the above example should prove sufficient. This section sets the number of calls allowed in any given day for a particular security level (SL). --------------------------- UL/DL NUMBER OF FILES RATIO --------------------------- This section works off the exact same principle as the Time Limitations section, therefore the above example should prove sufficient. This section sets the number of files that a user can download for every ONE file that the user uploads, for a particular security level (SL). --------------------- UL/DL KILOBYTES RATIO --------------------- This section works off the exact same principle as the Time Limitations section, therefore the above example should prove sufficient. This section sets the number of kilobytes that a user can download for every ONE KILOBYTE that the user uploads, for a particular security level (SL). - Page 52 - Telegard Main Documentation - Version 2.5 ___________________ MODEM INFORMATION ___________________ Telegard can operate with a wide variety of modems... which is good, considering the wide variety of modems out there! Therein, however, lies the problem... since modems vary so widely, one configuration cannot hope to work with all modems. Hopefully, the information presented here will help you get your modem up and running with Telegard. Also presented is information on using Telegard with a FOSSIL communications driver. ----------------------------- SAMPLE INITIALIZATION STRINGS ----------------------------- Shown below are some sample initialization strings. If your modem does not respond to the default string, try using one of these. Tested and verified using the Everex Evercom EX-920 and the Avatex 1200 1200 baud modems: "ATH0Q0V0E0M1X1S0=0S2=1S10=45" Tested and verified using the Avatex 2400 and the Tektoniks 2400 2400 baud modems: "ATH0Q0V0E0M1S0=0S2=1S7=45S9=3" Tested and verified using the Cardinal Technologies MB2450 2400 baud modem: "ATH0Q0V0E0M0X1S0=0S2=1S7=45S10=40&C1&D2" Tested (but not fully) with Tandy Hayes-compatible modems: "ATH0Q0V0E0M0X1S2=1S10=40" Note that just because the description states that it works with a certain brand at a certain speed, it doesn't mean that it will not work with YOUR modem. The only way to be sure is to try. ----------------- HIGH-SPEED MODEMS ----------------- In the world of the IBM PC, modems that run at 300, 1200 and 2400 baud are pretty standard; they use the same data transmission formats, and they are -- for the most part -- compatible with the Hayes SmartModem. The world of 9600 baud (and higher) modems is a different matter. Several different data transmission standards exist -- the HST and - Page 53 - Telegard Main Documentation - Version 2.5 V.32 standards are the most common -- as well as different variations on the Hayes command set. Other features, such as baud locking, make using a high-speed modem on BBS systems a formidable task. This chapter is devoted to "clearing the air" about such matters. Current information is sparse, as high-speed modems are relatively new to the market (and just coming into the price range of most computer users). When we receive more information about high-speed modems, we will be updating our information and informing you, the user, as soon as we have all the facts. Note that we DO NOT GUARANTEE that this information will work with your modem! We are providing it to serve as a starting point; if it works perfect with your high-speed modem, all the better. If you absolutely cannot get your high-speed modem to work with Telegard, contact one of the Alpha or Beta sites near you for assistance. THE US ROBOTICS DUAL STANDARD MODEM Below is the configuration information for the US Robotics Dual Standard modem (set up in the Modem Configuration section of the system configuration), allowing baud locking at 19,200 baud. This setup should also work -- with a little modification -- with the US Robotics HST 9600 modem (though it hasn't been tested). 1. Maximum baud rate : 38400 2. COM port number : 1 3. Modem initialization string: "ATB0E0H0M0V0X6&A1&B2&D0&H3&I5&K1&M4&N0&R2|" 4. Modem answer string : "ATA" 5. Modem hangup string : "~~~+++~~~ATH0" 6. Modem offhook string : "ATH1M0" 7. No-call init time : 15 A. 9600 ARQ rate baud : 38400 baud F. Comm flags: CTS check ON, DSR check ON, XON/XOFF OFF, Normal carrier $. Force baud rates? : Yes R. Modem result codes: Case 1 Case 2 (ARQ) R1. NO CARRIER : 3 R2. NO DIALTONE: 6 R3. BUSY : 7 R4. 300 BAUD : 4 14 R5. 1200 BAUD : 5 15 R6. 2400 BAUD : 10 16 R7. 4800 BAUD : 18 19 R8. 9600 BAUD : 13 17 ------------------------------------ USING A FOSSIL COMMUNICATIONS DRIVER ------------------------------------ FOSSIL stands for Fido/Opus/SEAdog Standard Interface Layer, which specifies a generic telecommunication interface for IBM PC and - Page 54 - Telegard Main Documentation - Version 2.5 compatible -- and less-than-compatible -- systems. Due to the fact that it is a standard specification, the FOSSIL driver has gained wide acceptance in the FidoNet community, and is used in various FidoNet- related products. It allows systems that are similar to the IBM PC -- but with wide-ranging architecture -- to use the same software without modification. THE HISTORY OF FOSSIL To better explain the history of FOSSIL, here is an excerpt from "Fundamentals of FOSSIL Implementation and Use, Version 5", by Rick Moore: "For those people who were not lucky enough to have an IBM PC or a system nearly completely compatible, the world has not been very friendly. With his implementation of the Generic Fido(tm) driver, Tom Jennings made it possible for systems that had nothing in common with an IBM PC except an 808x-class processor, and the ability to run MS- DOS Version 2 and above, to run his Fido(tm) software. That was a lot to ask, and a lot of people though it was enough. "But not everyone. While Thom Henderson was debugging version 4.0 of his SEAdog(tm) mail package, an 'extended' Generic driver was designed (in cooperation with Bob Hartman) as a quick kludge to help him get past a problem with certain UART chips. The new hook was quickly pounced upon by Vince Perriello, who, with almost DAILY prodding (ouch! it still hurts) by Ken Kaplan, had been working with Henderson to get DEC Rainbow support into SEAdog. Vince then coded a driver to use this hook and - Voila! - SEAdog 4.0 started working like a champ on the Rainbow. "At the same time something was rotten in the state of Texas. Wynn Wagner started encountering some serious difficulties in his Opus development effort. Specifically, he couldn't force the Greenleaf(tm) Communications Libraries to behave in exactly the way he felt Opus required. Enter Bob Hartman. Having already enjoyed success in the effort with Thom Henderson, he suggested to Wynn that with very few extensions, any driver that was already SEAdog(tm) 4.0 compatible could drive Opus as well. About that time, Vince called Wynn to discuss porting Opus to the DEC Rainbow. Wynn called Bob, Bob called Vince, and the FOSSIL driver came into existence. "To say that the concept has gained wide acceptance in the FidoNet community would be an understatement. Henk Weavers' DUTCHIE package uses the FOSSIL communications services. Ron Bemis' OUTER package uses FOSSIL services for everything it does and as a result it is completely generic. There are already FOSSIL implementations for the Tandy 2000, Heath/Zenith 100, Sanyo 555 and other 'non-IBM' architectures. With each new 'port' of the spec, the potential of a properly coded FOSSIL application grows!" - Page 55 - Telegard Main Documentation - Version 2.5 HOW A FOSSIL DRIVER BENEFITS TELEGARD Using a FOSSIL driver with Telegard has several advantages. First and foremost, Telegard can now be used with IBM PC-type systems that don't use the exact same communications standard. Also, since FOSSIL drivers are time-proven, reliable, and -- best of all -- FAST, system performance is increased. Most FOSSIL drivers will also work reliably with COM ports 3, 4, and higher. Finally, FOSSIL drivers work splendidly with high-speed modems. Thus, if you can't get your high- speed modem to work reliably with Telegard's built-in communication routines and/or with COM port 3 or higher, try using a FOSSIL driver. Telegard will take care of enabling and disabling the FOSSIL driver when needed; it will not be left "hanging" when you shell to DOS (to execute a door, etc.) or exit the BBS. It is completely reliable. INSTALLING A FOSSIL DRIVER WITH TELEGARD Below are the steps necessary to use Telegard with a FOSSIL driver. If one FOSSIL driver doesn't work to your satisfaction, try using another; there are plenty of them out there. If you have any trouble getting a FOSSIL driver to work with Telegard, contact one of the Alpha or Beta sites near you. 1. Get a FOSSIL driver. If you own a true IBM compatible, there are several drivers to choose from: X00.SYS, Opus!Comm, and BNUcom are just three of them. (For the following examples, X00.SYS is assumed.) 2. Install the FOSSIL driver into your AUTOEXEC.BAT (if it is a COM or EXE program) or CONFIG.SYS (if it is a SYS driver) file. Make sure it is set up to work with ONE communications port. (For example, installing X00.SYS would use "DEVICE=X00.SYS E 1" in your CONFIG.SYS file.) It is a good idea to use a small transmit buffer (if your FOSSIL driver supports it), say around 1024 bytes or less. If a larger buffer is used, it will fill up too fast, and users will not be able to abort displays very easily. (If you are using a high-speed modem, you may actually WANT to use a larger buffer for better performance. You'll have to experiment with it.) 3. Reboot your system so the FOSSIL driver will be installed. 4. Start up the BBS, go into the system configuration, and enter the General Flagged Functions section. Toggle option "B" ("Use FOSSIL comm. driver") to YES. This will tell Telegard to use the FOSSIL driver instead of the built-in communications routines. Don't worry about messing things up if you enable this option without a FOSSIL driver installed; Telegard is smart enough to recognize whether or not a FOSSIL driver actually exists, and to use the built-in routines if it doesn't. - Page 56 - Telegard Main Documentation - Version 2.5 _________________ THE USER EDITOR _________________ Telegard's user editor is a feature you will use in conjunction with others to determine who has access to various parts of your system. In addition, all sorts of information about each user is kept here for you. Upon entry to the user editor, you will see the following screen (which has been compressed slightly to fit on the page): ______________________________________________________________________ User #1 of 1 Status:None SL:255 DSL:255 User name:SysOp AR:ABCDEFGHIJKLMNOPQRSTUVWXYZ Real name:System Operator AC:----------/1234 Address :Unknown Sex/Age :M00 (00/00/00) City / State :Unknown, MI Zip-code:00000 Computer Type:IBM PC Phone # :000-000-0000 SysOp note : Last/1st:01/01/80 (01/01/80) Occupation :SysOp Lockfile:inactive BBS reference: Password:SYSOP Call records- TC:1 TT:1 CT:0 TL:32761 Tbank:0 Mail records- Pub:0 Priv:0 Fback:0 Wait:0 File records- DL:0 UL:0-0k Pts:0 Option : ______________________________________________________________________ Each command available in the user editor is detailed below. ; Toggles between "long" and "short" display modes. The long mode is shown above. The short mode displays only the user record number, user status, SL and DSL, user name, real name, AR flags, and AC flags. : Used to "turn off" the display of the user account records. This speeds things up considerably when you already know what you intend to do next. However, [ENTER] will still redisplay the account if needed. [ Allows editing of the record previous to the current one. If you are at the first record, this command will move to the last record. ] Allows editing of the record after the current one. If you are at the last record, this command will move to the first record. = This command restores the original information for the current record, IF you have not moved to another record or exited the user editor. In effect, the information in the current record is not recorded UNTIL you move to another record or exit the user editor. (Think of "=" as an "undo" - Page 57 - Telegard Main Documentation - Version 2.5 or "oops!" feature.) { Searches backwards in the user file for all users matching the criteria declared in "O" (search options). If at the lowest matching user, the highest matching user will be displayed. If no criteria has been declared, this command acts the same as "[". } Searches forward in the user file for all users matching the criteria declared in "O" (search options). If at the highest matching user, the lowest matching user will be displayed. If no criteria has been declared, this command acts the same as "]". * Automatically validates a new user with the SL, DSL, AR flags, and restrictions as defined in the system configuration. ~ This command will trap (record) EVERY single action of a user from logon to logoff, including file scans, message scans, posts, etc. It is far more comprehensive than the SYSOP.LOG file (explained later) and is used to record the actions of "problem users" or to reconstruct events if there has been some type of a common crash occurring with numerous callers. When this is toggled to ON, it will prompt for whether or not to trap, and whether or not to send it to a separate file. If it is sent to a separate file, the status bar in the user record will say "Trapping (Separate)", and the trapping will be sent to a file called TRAPxxxx.MSG with the "xxxx" corresponding to the user's record number. If the trapping is NOT separate, then it will go to a common file called TRAP.MSG. @ This option allows a user to be "locked out" from the BBS; the user will not be allowed to log back on under that name or handle. You will be prompted for a lockout filename, which can contain your own personal message to that special someone you would like to repay for all his/her kindness. If a filename is entered, that text is displayed each time the user tries to call. If no special file is chosen, it displays a common one called LOCKOUT.MSG and then hangs up. ! Toggles the "alert" status of the user. If on, an "ALERT!" message is displayed in the SysOp window and a siren will sound (until you press [F9] to shut it off). A Alters the user's address. C Alters the user's city and state/province. D Alters the user's download security level (DSL). E Allows toggling of the user's AC flags. The various flags are explained in detail in the system configuration section - Page 58 - Telegard Main Documentation - Version 2.5 (under "New User and Auto-Validation Settings"). F Allows toggling of the user's AR flags, which can allow (or restrict) access to various sections of the BBS. These flags are not defined with a specific purpose; their use is entirely controlled by you. G Alters the user's date of birth. I Alters the user's "occupation" comment. K Alters the comment field. This field can be used as a "scratch pad" for keeping notes on the user. L Alters the date that the user last called the BBS. M Alters the status of the user's mailbox. If the mailbox is closed, no Email can be sent to that particular user. (The only exception is the user that is designated to receive validation letters from new users. New user validation letters will be "forced" into the mailbox, even if it is closed). If the mailbox is open, the option exists to route the mail to another user. N Alters the user's name. If the BBS allows handles, this name can be different from the user's real name. O Specifies certain criteria for searching for users. The following criteria are defined: General text ACS SL DSL AR flags AC flags Status (alert, chat buffering, deleted, locked out, separate SysOp log, trapping) Days since last on Days since first on Number of calls User age User gender # 1/10's call/post #k DL/1k UL # DLs/1 UL In addition, there are several commands that can be used while in this sub-menu: (L)ist options - List the current definitions for each option. (T)oggle options on/off - Toggle an option on/off. (C)lear options - Make all options inactive. - Page 59 - Telegard Main Documentation - Version 2.5 (U)sers who match - List all users who match the defined criteria. (Q)uit - Return to the user editor. P Alters the user's telephone number. R Alters the user's real name. S Alters the user's security level (SL). T Alters the user's computer type. U Moves directly to another user's record. You may enter the user number, the user name, or a partial search string (the user file will be searched for every user name that contains the search string, and you will be prompted one by one). W Alters the "heard about this BBS from?" comment field. Y Assigns the user as a message base SysOp for up to five message bases. Remember to alter this if you delete and/or move message bases via the message base editor! Z Alters the user's postal zip code. $ Alters the user's password. \ Allows viewing of the separate SysOp log for this user (if one has been set up). 1 Allows alteration of the user's calling records, both daily and cumulative values. The total calls, total time on, calls today, time left today, and illegal logon attempts fields can be changed. 2 Allows alteration of the user's cumulative mail records. The total public posts, total private posts (Email), total feedback sent, and mail waiting fields can be changed. 3 Allows alteration of the user's cumulative UL/DL records. The number of uploaded files, number of downloaded files, total upload kilobyte value, and total download kilobyte value fields can be changed. ' Alters the user's personal color setup. Both color and black-and-white setups can be changed. # Alters the user's file points. & Alters the amount of time in minutes that the user has in the Time Bank. The maximum amount of time allowed is 600 minutes total. ^ Toggles deletion of a user's record. In the event a user is deleted, all voting records and Email (both to and from the - Page 60 - Telegard Main Documentation - Version 2.5 user) are deleted. - Allows viewing of the user's answers to the NEWUSER.INF InfoForm questionnaire (stored in NEWUSER.ASW), if one was used. _ Allows viewing of the user's answers to any InfoForm questionnaire. You will be prompted to enter the filename of the InfoForm questionnaire; the answers will be extracted from the corresponding *.ASW file. Q Exits the user editor and returns to the WFC menu (or the BBS if online). - Page 61 - Telegard Main Documentation - Version 2.5 ______________________ THE FILE BASE EDITOR ______________________ The file base editor serves a valuable purpose in that it sets up your file bases, which are ESSENTIAL for the uploading and downloading of files on the BBS. Upon entering the file base editor, a screen similar to the example shown below will be displayed (it has been compressed slightly to fit on the page): ______________________________________________________________________ NNN:File base name :Flags:ACS :UL ACS:Name ACS:Maxf:Dep ===:=========================:=====:========:======:========:====:=== 0 SysOp ----- s200d200 U1 100 0 1 General ---N- d50 s50 50 0 2 IBM Games ----- d50fG 200 0 3 Communications Programs ----- d60 50 0 4 GIF Pictures [VGA ONLY] -G--- d60 500 0 ______________________________________________________________________ The following commands are available from this screen: <CR>Redisplay screen (D)elete base (I)nsert base (M)odify base (P)osition base (Q)uit (T)oggle display format and are explained in detail below. <CR>Redisplay screen -- It will redisplay the listing of file bases when pressed. (D)elete -- Used to remove a file base. You will be prompted WHICH base you want to delete. File bases number from 0 to the highest; Telegard currently has provisions for 97 file bases. When you delete a file board, it will move all following file bases up one in position. Also, the filename that described the files present in the directory is erased (you are prompted with "Delete it (Y/N)?", just in case you wish to abort the deletion. (I)nsert -- Used to insert another file board in your file system. It will prompt you with "File base to insert before (0-xx)?", with "xx" being the highest base currently. Also, Telegard has a maximum of 97 file bases ranging from (0-96). Inserting a file board will move all subsequent boards up one in position. NOTE: Telegard uses "<<Not Used>>" as the default description, NEWDIR as the default filename, and "C:DLOADS\" as the default file path when you insert a board. - Page 62 - Telegard Main Documentation - Version 2.5 (M)odify -- Allows changes to be made to the security setting of the file base, the file path, the board name, maximum number of files, and the filename, which stores the data of the file descriptions of that particular file board. Details of this command are presented later. (P)osition -- Moves the file boards around in position. For example, if you recently created a file base 0, and wished for it to be after file board 2, then you would change the position from 0 to 3. (T)oggle -- Toggles the file board editor between three display modes. The common and default one is illustrated at the beginning of the file editor discussion. (Q)uit -- Exits the file base editor. Now, for an explanation of how to modify individual file bases. When you select the (M)odify command, you will be asked which base you wish to modify. After you make your selection, you will be shown a screen similar to the following example: ______________________________________________________________________ 1. Name : General Files 2. Filename : GENERAL 3. DL/UL path : C:\BBS\DLOADS\GENERAL\ /Same 4. ACS required: "s50d50fG" 5. UL/Name ACS : "" / "" 6. Max files : 50 7. Password : "" 8. Arc/cmt type: ZIP/1 9. Dir depth : 0 Flags : ----- P-Index : 27 Q. Quit Enter selection (1-9) [Q]uit : ______________________________________________________________________ The commands available from this screen are: <CR>Redisplay screen 1-8:Modify item ([)Back entry (])Forward entry (J)ump to entry (F)irst entry in list (Q)uit and save (L)ast entry in list Toggles: (N)oRatio (U)nhidden (D)ir-header (I)*.DIR file in DLPATH (G)ifSpecs and are explained in detail below. 1 Allows you to rename the current file base. It stores the name as ASCII text, with a maximum of 40 characters (less if - Page 63 - Telegard Main Documentation - Version 2.5 MCI colors are used, which take up 2 characters each). 2 Allows you to alter the directory filename, which stores the information on each file in the file base (description, file points, date uploaded, length, etc.). The respective files are stored in the GFILES path as ".DIR" files (or in the upload path if the "(I)*.DIR file in DLPATH" flag is set). 3 Allows you to reconfigure the path to which your files are stored in. The default is "C:DLOADS\", but Telegard will accept any logical drive that DOS supports, if present. If the DL and UL paths are the same, "Same" is displayed for the UL path. The option of separate paths is provided to aid the SysOp if, for example, the SysOp has one directory for all new files; until validation, they can be sent there. 4 This is a security feature of the file system, designed for different security levels, with primary emphasis on HIGHER security levels. The user must be able to satisfy the specified Access Condition String in order to have access to that file base. 5 A user must be able to satisfy the specified ACS in order to be allowed to upload files to that particular directory. The name ACS is used as a secondary security option so that only persons satisfying the name ACS will be able to see the uploader's name in the secondary list option. Also, it will not list the uploader's name when the user attempts to download a file from that particular file base, if the user does not satisfy the ACS requirements. 6 This is the maximum number of files allowable in a file board. If a user tries to upload a file when the maximum number of files is achieved, it will NOT allow the transfer. This value usually starts at 50 and may increase to 32,767 files, depending on the need, and it relates to the number of individual files in the base and the number of individual descriptions in the filename. 7 Another security feature, in that the user must enter a password each time they attempt to access the file board. Passwords may be 10 characters in length, and are alphanumeric in nature. (The default password is "" [null], or no password.) 8 This enables file bases to be set up with different compression types, as defined in the system configuration (the "Archive Configuration" sub-menu of the "File "Configuration" section). You may have a few different file comments floating around, such as "Call [BBS]" or "From Another Fine Telegard Near You!". (The default is the ZIP compression method and the first comment.) 9 The directory depth feature has not been implemented (it is for future expansion). - Page 64 - Telegard Main Documentation - Version 2.5 [ Displays the previous file base. If at the first file base, this command has no effect. ] Displays the next file base. If at the last file base, this command has no effect. F Displays the first file base. J Displays the specified file base. L Displays the last file base. Q Exits the file base editor and returns to the WFC menu (or the BBS if online). The bottom two fields are defined as follows: Flags -- Five flags are present for toggling that regulate file viewing and ratios. These flags are: N - No ratio checking U - File base is unhidden D - [not implemented] I - *.DIR file in DLPATH G - Automatically insert GIFspecs on *.GIF files These flags are explained in more detail below. P-Index -- A "permanent index number" for the file base number that can NOT be changed. It stays with the base from creation, regardless of insertions, deletions, and movements of file bases. The available flags are toggled with the following commands: N Sets the file base in question so that there are no UL/DL ratio or file points checks. U If toggled on, it will display a file base in an area listing regardless of whether or not the user has access to that base. If the user lacks access, it will show in the list with a name but no base number and it will be inaccessible. D This feature is not implemented (it is for future expansion). I If toggled on, the *.DIR file for the particular file base will be stored in the download path instead of the GFILES directory. An example of using this feature would be to store groups of files on floppy diskettes (with *.DIR files on each diskette). That way, the disks can be "rotated" every once in a while (useful for GIF picture files, which can take up a LOT of space before you know it!). - Page 65 - Telegard Main Documentation - Version 2.5 G Speaking of GIF files... this flag is used for directories containing GIF pictures, and if toggled on, the BBS will, upon uploading, insert in the description the size and color information taken directly from the GIF file. It is saved in the following format: (xpixels,ypixels,colors) where "xpixels" is the width of the picture (the X axis), "ypixels" is the height of the picture (the Y axis), and "colors" is the number of colors used in display. - Page 66 - Telegard Main Documentation - Version 2.5 _________________________ THE MESSAGE BASE EDITOR _________________________ The message base editor is used to structure the message system in all features such as data file name, maximum number of messages, message base security levels for viewing and posting, and other security features. Upon entry to the message base editor, a screen similar to the examplebelow will appear (it has been compressed slightly to fit onto the page): ______________________________________________________________________ NNN Base name :Flag:ACS :Post ACS :MCI ACS :MaxM:An === ====================:====:==========:==========:==========:====:== 1 General L--- s10 s10 % 100 Y 2 Telegard News! L--- s10 s10 % 100 N 3 Dear Abby L--- s20 s20 % 50 A 4 Star Trek Echo ER-A s20 s20 % 500 N 5 GroupMail Support GR-A s20 s20 % 100 N ______________________________________________________________________ The available commands from this screen are: <CR>Redisplay screen (D)elete base (I)nsert base (M)odify base (P)osition base (Q)uit (T)oggle display format and are described as follows: <CR>Redisplay screen -- This will redisplay the list of message bases available for editing. (D)elete -- This command will delete a message base and move all the subsequent message bases up one entry. If you try to delete a message base, as a warning it will display a string of ASCII text: "[Base Name] Delete it?". (I)nsert -- Serves to insert a new message base and move all the subsequent bases down one in the listing. (M)odify -- Allows you to make modifications to the individual message bases that include things such as file names, security features, and the name of that message base. This process is described in detail later. (P)osition -- Moves the message bases around in position. For example, if you recently created a message base 0, and wished for it to be after message base 2, then you would use this command to change the position from 0 to 3. - Page 67 - Telegard Main Documentation - Version 2.5 (T)oggle display format -- This will cause the message base editor to toggle between four different screens covering everything associated with the structure of a message base: Security, names, file paths, permanent index numbers, etc. The first and most common toggle mode is shown above. (Q)uit -- Exits the message base editor. When you select the (M)odify command, you are asked which base you wish to modify. After entering your selection, a screen similar to the following example is displayed: ______________________________________________________________________ 1. Name : General 2. Filename : GENERAL 3. Base type : Local Message path: Unused -OR- <message directory path> 4. ACS req. : "s30" 5. Post/MCI ACS: "s30" / "%" 6. Max Mess : 50 7. Anonymous : Yes 8. Password : "" C. Colors : Unused -OR- Text=1, Quote=3, Tear=9, Origin=5 M. Flags : Unused -OR- KS-CB/MT O. Origin line : Unused -OR- "<origin line text>" Flags : --- P-Index : 0 Q. Quit ______________________________________________________________________ Each field and command is described in detail below. 1 The name of the message base. It is in straight ASCII text and has a maximum of 40 characters. MCI colors and other commands may be used in the base name. 2 The name of the message files. Three files are created using this name: "name.BRD" (the actual messages), "NAME. MIX" (index into the BRD file), and "name.TRE" (similar to MIX except for ReplyTree mode); the files are stored in the message directory defined in the system configuration. 3 Designates the message base type. Three types are currently available: Local -- Allows the exchange of messages only between the users of the BBS. EchoMail -- Allows the exchange of messages, via the FidoNet system, between users of BBSes linked across the country and around the world. GroupMail -- Similar in concept to EchoMail, but with a different distribution method that, in many cases, is faster and more reliable than EchoMail. - Page 68 - Telegard Main Documentation - Version 2.5 When a base is defined as EchoMail or GroupMail, you will be prompted for the FidoNet message path. This is required for Telegard-specific FidoNet mail processing utilities; it is used to store temporary files. For EchoMail messages, you can define the path off the message directory, using the same name as the message base filename. (For example, if the base filename was "TREK", and the BBS message path was "C:\BBS\MSGS", you could define the directory path as "C:\BBS\MSGS\TREK".) For GroupMail messages, you'll have to use the paths created off the GROUP directory (as created by SEA's GROUP utility). For example, if the base filename was "BLATZ", and the GroupMail message path was "C:\BBS\GROUP", you must define the directory path as "C:\BBS\GROUP\BLATZ". Consult the manual for the GROUP utility for more information, as well as the section "Using Telegard With FidoNet" in this manual. If a base is defined as Local, then "Unused" is shown as the message path in the "Message path:" field. Otherwise, the actual directory pathname is shown. 4 The ACS requirements that the user must meet in order to access the message base. A caller that does not satisfy the requirements will notice a board is missing -- unless it is designated as "unhidden" -- but will have no clues as to what it is. (If the "compress message/file bases" feature is enabled in the system configuration, then the user won't even know the base is missing!) 5 For the post ACS, the user must satisfy the requirements in order to post messages on that base. In some cases, users will be able to read messages, but be lacking in security to post. For the MCI ACS, the user must satisfy the requirements in order to use MCI codes within messages. For non-local bases, it is recommended that you disable the MCI feature by specifying "%" for the ACS, as non-Telegard systems will see the MCI codes (@1, @2, etc.) with no idea what they mean. 6 This is the maximum number of messages that can be posted on the base. The default is 50, with a maximum of 32767. When the number of messages exceeds this limit, and the message bases are packed, old posts start getting removed (with the exception of messages that have been flagged "permanent"). 7 This determines the anonymity level of the message base. Available anonymity levels are: (Y)es, anonymous allowed, selectively (N)o, anonymous not allowed (F)orced anonymous (D)ear Abby (A)ny Name - Page 69 - Telegard Main Documentation - Version 2.5 and are defined as follows: (Y)es, anonymous allowed, selectively -- Anonymous posts are allowed on the board on an optional basis. After a user has posted a message, it will prompt for "save", then it will feed another prompt "Post anonymous?". If the caller enters "Y", the message will be anonymous and will be unviewable EXCEPT to users that satisfy the ACS for the "see anonymous public posts" setting in in the system configuration. (N)o, anonymous not allowed -- Anonymous posts are NO allowed on that base by ANY user, no matter what SL level they have. (F)orced Anonymous -- This automatically makes every post on the base anonymous, but can be viewed by users under the conditions stated above for the (Y)es setting. (D)ear Abby -- This is for a "Dear Abby" problem solving message base. A user may post a message under ANY one of these three possibilities: "Problemed User" -- Posted by a user with personal problems, who wants help, but wishes to remain anonymous. "Abby" -- Allows another user to respond to a problem post, with anonymity. User name and number -- Allows a caller to post a problem/suggestion under THEIR handle and user number. (A)ny Name -- Allows users to post messages using either their own user name and number OR anything they like. For non-local bases, it is recommended that the anonymous level be set to "NO", as anonymous messages are frowned upon on most EchoMail and GroupMail conferences (also, standard FidoNet message files can't support anonymous messages). 8 A security feature that, if activated, will prompt the user for a password which must be entered correctly in order to access that message base. C Defines the colors used for standard text, quoted text, tear, and origin lines when EchoMail and GroupMail messages are tossed into the message base. Refer to the "FidoNet Configuration" section in "System Configuration" for more information. NOTE: This option cannot be selected if the base is defined as Local. - Page 70 - Telegard Main Documentation - Version 2.5 M Defines the various flag settings used when tossing, scanning, and posting EchoMail and GroupMail messages. The currently available flags are: K - Strip IFNA kludge lines. S - Strip SEEN-BY lines (EchoMail only). O - Strip origin lines. C - Strip Telegard "center line" codes. B - Strip Telegard "box line" codes. M - Center boxed/centered lines with spaces. T - Add tear and origin lines to posted messages. Refer to the "FidoNet Configuration" section in "System Configuration" for more information. NOTE: This option cannot be selected if the base is defined as Local. O Defines the origin line placed at the bottom of EchoMail and GroupMail messages. If an origin line is not defined here, the default origin line is used. Refer to the "FidoNet Configuration" section in "System Configuration" for more information. NOTE: This option cannot be selected if the base is defined as Local. Q Exits the message base editor. The last two fields are defined as follows: Flags -- Defined as follows: R - Real names only. U - Unhidden. A - Remove ANSI and 8-bit ASCII. P-Index -- The "permanent index" acts the same as the permanent index in the file system. When a message base is created it is assigned the next highest index number and regardless of insertions, deletions, or movements of message boards, this number will stay the same. The flags are toggled with the following commands: R If enabled, real names are stored in the "From:" and "To:" fields of each message, regardless of whether or not the BBS allows handles. This is the preferred setting for Echo- Mail and GroupMail bases, as most conferences frown upon the use of handles (and some prohibit them outright). U If enabled, it will display a message base in an area listing regardless of whether or not the user has access to that base. If the user lacks access, it will show in the list with a name but no base number and it will be inaccessible. A If enabled, ANSI codes and 8-bit ASCII characters (127-255) are removed from messages before they are posted. (The enter ANSI sequence itself isn't removed; only the leading - Page 71 - Telegard Main Documentation - Version 2.5 ESC character is stripped. This renders the rest of the sequence useless. Also, ASCII character 127 is defined as DEL in the ASCII standard, which can cause problems for some systems.) Enabling this option is recommended for EchoMail and GroupMail bases, as ANSI and 8-bit ASCII characters are usually prohibited to provide compatibility with non-IBM systems. - Page 72 - Telegard Main Documentation - Version 2.5 _____________________ THE PROTOCOL EDITOR _____________________ The protocol editor allows you to set up different protocols for transferring files. The most common protocols are ASCII, Xmodem, Ymodem and Zmodem; they have already been set up for you in the protocol editor. All you need to do is place the appropriate program into any directory that is part of your DOS PATH statement. In order to enable the default protocols, you will need a copy of the DSZ program. It is available from most BBSes as "DSZnnnn.ZIP", where "nnnn" is the release date. Extract the DSZ.COM program, place it in a directory contained in your PATH, and you'll be all set. The main screen of the protocol editor looks similar to the one shown below: ______________________________________________________________________ NNN:ACS :Description ===:==========:====================================================== +0 (Q) Quit - abort transfer +1 (Q) Quit - abort batch transfer +2 (Q) Quit - abort resume transfer +3 (B) Batch transfer +4 (N) Skip to next file +5 (A) ASCII +6 (X) Xmodem +7 (C) Xmodem-CRC +8 (Y) Ymodem +9 (Y) Ymodem batch +10 (Y) Ymodem resume +11 (Z) Zmodem +12 (Z) Zmodem batch +13 (Z) Zmodem resume Protocol editor (?=help) : ______________________________________________________________________ The commands available from this menu (displayed by pressing the "?" key) are: <CR>Redisplay screen (D)elete protocol (I)nsert protocol (M)odify protocol (P)osition protocol (Q)uit and are detailed below: <CR>Redisplay screen -- Displays the menu again, in case something you wished to see scrolled off the screen. (D)elete protocol -- Removes an entry from the protocol list. You will be prompted for the entry number to delete. - Page 73 - Telegard Main Documentation - Version 2.5 (I)nsert protocol -- Inserts a new entry in the protocol list. You will be prompted for the entry number that the new entry should be inserted before, and the number of new entries to insert. (M)odify protocol -- Allows you to change an entry in the protocol list. Details on modifying entries are given later. (P)osition protocol -- Moves an entry from one position to another. You will be prompted for the entry number to move and the entry number that it will precede. (Q)uit -- Exits the protocol editor. When you select the (M)odify command, you will be prompted for the entry number to modify. After you make your selection, a menu similar to the following example will be displayed: ______________________________________________________________________ Protocol #11 of 24 !. Type/protocl:Active - Batch protocol 1. Keys/descrip:"Z" / "(Z) Zmodem" 2. ACS required: "" 3. Temp. log : "%C\dsztemp.log" 4. <U>L log : "%C\xfer.log" <D>L log : "%C\xfer.log" 5. <U>L command: "dsz port %P speed %B rz" <D>L command: "dsz port %P speed %B sz @%L" 6. Codes mean :Transfer bad 7. <U>L codes :(1)"" (2)"" (3)"" (4)"" (5)"" (6)"" <D>L codes :(1)"E" (2)"e" (3)"L" (4)"l" (5)"" (6)"" E. Environ. cmd: "set DSZLOG=%T" I. DL File list: "%C\fi.lst" C. Max DOS chrs:128 P. Log position: Filename: 51 - Status: 1 Edit menu (?=help) : ______________________________________________________________________ Notice that some of the strings in the above example have a "%x" sequence of characters. These are special protocol codes, and they are defined as follows: %B Specifies the current baud rate, as a string of ASCII digits ("300", "1200", "2400", etc.). %C Specifies the pathname of the main BBS directory. Note that a backslash ("\") is NOT automatically appended, so it will have to be specified if necessary. %F Specifies the filename(s) to be transferred. In the case of a batch transfer, this MCI indicates where multiple filenames may be inserted, up to the allowable length of the command line (defined in option C, below). - Page 74 - Telegard Main Documentation - Version 2.5 %L Specifies the name of the file that contains a list of filenames to be batch downloaded (defined in option I, below). %T Specifies the name of the transfer result temporary log file (defined in option 3, below). Note that all protocol code MUST BE SPECIFIED IN UPPER CASE, or they will NOT work! These codes are shown on the video display using MCI color #3 (bright cyan in the default setup). The commands available from this menu (displayed by pressing the "?" key) are: #:Modify item <CR>Redisplay screen ([)Back entry (])Forward entry (J)ump to entry (F)irst entry in list (Q)uit and save (L)ast entry in list and are described below: <CR>Redisplay screen -- Redisplays the menu. ([)Back entry -- Moves the pointer to the previous entry in the protocol list. If the pointer is at the first entry, this command is ignored. (])Forward entry -- Moves the pointer to the next entry in the protocol list. If the pointer is at the last entry, this command is ignored. (J)ump to entry -- This command moves the pointer to the user specified entry in the protocol list. You will be prompted for the entry number to move to. (F)irst entry in list -- Moves the pointer to the first entry in the protocol list. (L)ast entry in list -- Moves the pointer to the last entry in the protocol list. (Q)uit and save -- Saves the current protocol list and returns to the main protocol editor menu. In addition, you can modify any of the entries shown on the screen. They are defined as follows: ! This option allows you to define the type and availability of the current protocol. The protocol can be enabled, disabled or set to one of the following types: Single - The protocol will only transfer a single file. Batch - The protocol will transfer multiple files with one command. - Page 75 - Telegard Main Documentation - Version 2.5 Resume - The protocol will transfer one file, and resume the transfer where it left off (if the previous transfer was aborted). For example, DSZ.COM support Ymodem and Zmodem resume transfers. 1 This option defines the command keys required to select the protocol and a description that will be displayed when a list of protocols is requested. The description may contain MCI color codes. 2 This option defines the ACS requirements that the user must satisfy in order to use the protocol. 3 This option defines the name of the file that holds the result log of a file transfer operation. This temporary log is then used to build the permanent result logs (defined in option 4) and to determine the transfer status after a batch transfer. Note that not all protocol drivers support a result log. 4 This option defines the names of the permanent result log files for both upload and download operations. Data from the temporary result log file (defined in option 3) are used to build these permanent logs. Separate log files can be specified for upload and download operations, or a common log file can be used. 5 This option defines the commands required to perform file uploading and downloading. When selected, you will be asked which command (upload or download) to define. Then, you are asked what type of command it will be. The four different types are defined as follows: (A)SCII -- The protocol is used for pure ASCII file transfers. In this event, almost all other options for this protocol (transfer logs, result codes, etc.) are ignored, as they aren't needed. (C)ommand -- The entry is assigned to a special function. The two functions available are: Batch -- The entry will not actually transfer a file, but instead will add the file to the batch transfer queue. Next -- The selected file is skipped and the next file (if a wildcard operation is being performed) is selected. (E)xternal -- Allows you to define the actual DOS command line used in conjunction with the protocol driver. Refer to the above list of protocol MCIs and the documentation for the protocol driver to create the command necessary to perform the file transfer. (Note that the upload command should be - Page 76 - Telegard Main Documentation - Version 2.5 defined with the protocol driver's "receive file" option, and the download command should be defined with the driver's "send file" option.) (O)ff -- Disables that particular function for the protocol. This may be necessary on some protocol drivers that, for example, allow batch transfers in one direction but not the other (Ymodem batch, for example; batch downloading is permitted, but not batch uploading). 6 This option toggles the meaning of the error result codes defined in option 7 (below). The meaning can be set to "transfer okay" or "transfer bad", depending on the requirements of the protocol driver. 7 This option defines the error result codes (for both uploading and downloading) returned by the protocol driver after completing transmission of a file. Since some drivers can return more than one result code upon completion of a successful (or unsuccessful) operation, up to six codes can be defined. If there are less than six, fill the remaining entries with a duplicate code (for example, most drivers return only a single value, zero, when an operation is successful; thus, all six entries would contain "0"). Telegard will use these codes to determine the success or failure of a transfer operation. If you have defined a result log file, this option defines the strings that Telegard should compare when determining if a batch transfer is successful. (This is used in conjunction with option P, below.) E This option defines the command that sets up an environment string, for protocol drivers that require environment variables to be set up in certain ways. For example, "SET DSZLOG=%T" would set the DSZ.COM temporary result log filename to the name defined in option 3. If no environment setup is necessary, this string should be set to NULL (""). *IMPORTANT*: IF YOU DEFINE AN ENVIRONMENT SETUP COMMAND WITH THIS OPTION, MAKE SURE THAT IT IS ALSO DEFINED IN YOUR AUTOEXEC.BAT FILE, OR FILE TRANSFERS WILL NOT WORK PROPERLY! (For example, if you have the result log filename set to "%C\dsztemp.log", and this option set to "SET DSZLOG=%T", place "SET DSZLOG= C:\BBS\DSZTEMP.LOG" in your AUTOEXEC.BAT file. Naturally, you should use the name of your main BBS directory if it's not C:\BBS.) I This option defines the name of a file in which Telegard will store the filenames to be transferred in a batch upload operation (for those programs that require it, as opposed to specifying the names of the files directly on the command line). If a file list file is not required, this - Page 77 - Telegard Main Documentation - Version 2.5 string should be set to NULL (""). C This option defines the maximum number of characters allowed on the DOS command line. The default is 128, which is the normal amount allowed by DOS. Some DOS enhancement programs, however, allow for more characters on a command line. If you are using one of these enhancement programs, you may wish to modify this field to contain the number of characters allowed by the enhancement program. P This option defines the positions, on a single line of the temporary result log, of the filename and return status (starting from position #1). If no temporary result log is defined, then these values are ignored. This is used (in conjunction with option 7, above) to determine the status of batch transfer operations. - Page 78 - Telegard Main Documentation - Version 2.5 _________________ THE MENU EDITOR _________________ Telegard's menu system is the base of the entire system's structure; almost every command that a user will ever enter can be modified, added to, and deleted from your BBS with the use of the menu editor. The menu system is broken up into individual menu FILES, each of which define the different menus of your system. The menu files all exist in your MENUS directory, and all have the file extension of "MNU". One advantage of having a multiple menu-file system, over a single menu-file system, is that other people who write Telegard add-on utilities, such as online doors, can include the menu file with their programs, minimizing the total amount of work necessary on the SysOp's part. -------------------- THE MAIN EDITOR MENU -------------------- Upon entry to the Menu Editor, you will be presented with a screen similar to the following (compressed slightly to fit onto the page): ______________________________________________________________________ Telegard Menu Editor Directory of C:\BBS\MENUS\*.mnu ARCHIVE MNU AUTO MNU BATCH MNU BBSLIST MNU FILE MNU GOODBYE MNU MAIN MNU MSG MNU ONLINE MNU PERSONAL MNU SHUTTLE MNU SYSOP MNU 12 File(s) nnnnnn bytes free Menu editor (?=help) : ______________________________________________________________________ The commands available at this screen are: (D)elete menu file - This command allows you to erase any of the *.MNU files in the MENUS directory. (I)nsert menu file - This command will generate a new *.MNU file in the MENUS directory with just one menu command on it, all ready to be used. (M)odify menu file - This is where you get to load in one of the *.MNU files and modify the menu commands and structure of the menu. (Q)uit - Exits the menu editor. - Page 79 - Telegard Main Documentation - Version 2.5 When you execute the (M)odify command, you will be asked for the menu to modify. In this case, we are using the main menu ("MAIN") as an example. When you enter the name of the menu, the following menu is displayed (again, compressed to fit onto the page): ______________________________________________________________________ Modifying menu: MAIN NN KK-Typ-MString NN KK-Typ-MString NN KK-Typ-MString -- ---------------------- -- ---------------------- -- --------------- 1 * -/ sysop 10 N ME 1 19 Y OY 2 A -/ auto 11 O -/ goodbye 20 . -/ online 3 B -/ bbslist 12 /O HM 21 $ O$ 60;600 4 C OC 1 13 P -/ personal 22 ! MA 17 5 I OI 14 S OS 23 ! -/ md 6 F -^ file 15 T -S *> Entered TFil 24 CLE-^ main;C 7 H OM 16 T OT 25 XXXDD activity 8 L -F user.log 17 V OV 9 M -^ msg 18 X OP 22 Menu editor (?=help) : ? ______________________________________________________________________ In this display, the command number ("NN"), the keys used to execute the command by users ("KK"), the type of command ("Typ"), and the command data ("MString") are all displayed at once. Other display formats are available, and are explained later on in this section. The following are descriptions of the commands available here: (D)elete command - Removes one of the menu commands from the current menu loaded. There is a 50 command limitation for each menu, so get into the habit of deleting commands that are no longer useful. (I)nsert command - Inserts new menu commands somewhere in the menu. It is possible to insert more than one menu command at once using this option, rather than repeating the same (I)nsert sequence several times. (L)ong generic menu - Displays how the current menu's generic tutorial looks currently. An alternative to repeatedly modifying the menu, exiting the menu-editor, looking at the menu, re-entering the menu, etc, etc. (M)odify commands - This command allows you to modify the menu command information of a menu command in the current menu, whether newly created or old. Menu modification is discussed in detail later. (P)osition menu commands - This command allows you to rearrange the order of the menu commands on the menu. Although useful for linking commands (see the special section on linking commands), it is *especially* useful for making a good, finished product out of your generic menus (if you use them). - Page 80 - Telegard Main Documentation - Version 2.5 (S)hort generic menu - Shows how the current menu's normal generic menu looks currently. Again, as with the (L)ong command, it is a speed alternative to repeatedly exiting the menu editor to check how the menu looks after each modification. (T)oggle display type - There are two formats which Telegard will use to output the listing of menu commands on the current menu; this command is used to toggle between the two. One of them is shown up above; it is more concise, and takes up less space than the alternate one (which is more descriptive). (X)Menu data/command data display mode toggle - Toggles between either of the two menu command list modes in (T), and another, separate list of information about the current menu (which is described in detail later). ------------------------- MENU COMMAND MODIFICATION ------------------------- When you execute the (M)odify command, you will be asked which command to modify. After you enter the command number, the following menu is displayed: ______________________________________________________________________ Menu filename: MAIN Command #1 of 25 1. Long descript :(*)SysOp Menu - Perform system maintenance 2. Short descript:(*)SysOp Menu 3. Cmd letters :* 4. ACS required :"s200" 5. Cmdkeys :-/ 6. MString :sysop 7. Flags :None Q. Quit Edit menu: (1-8,[,],F,J,L,Q,?) : ______________________________________________________________________ This is probably starting to get confusing right about now! If you ARE getting confused, don't worry; you'll understand it soon enough, after a little usage. From here, the following modification and movement commands are available: 1 This field stores a long description of the menu command, used when listing a generic tutorial of the current menu. 2 This field stores a shorter description of the menu command, and is used when the BBS generates a generic menu. If the short description is longer than the column size of the generic menu, the description is shortened to fit neatly into the space allocated to it. A large sized description field is provided to allow the SysOp to put whatever kind of - Page 81 - Telegard Main Documentation - Version 2.5 colors he wants into it (color changes take up two characters each in this and ALL strings). 3 This is the actual string that the user enters when he wants to execute the command. If the command letters field has only one character in it, the command will be executed immediately after the user presses the one character; he need not even press [ENTER] afterwards. If the first character of the command letters is a slash character ("/"), the command letters must be two characters in length. The user must enter the slash character ("/"), and the second character of the command letters to execute the command. After that, [ENTER] does not need to be pressed; the command automatically continues. For example: if the command letters are "/O", the user must enter "/O", but does NOT need to press [ENTER]. If the command letters have more than one character in them, and the first character of the command letters is NOT a slash character ("/"), the user must enter two slashes in a row ("//"), and then the rest of the command, and press [ENTER]. For example, if the command letters are "YELL", the user must enter "//YELL", and then press [ENTER]. 4 This is the ACS requirement that the user must satisfy in order to have access to the command. You may set up two or more menu entries to execute different menu commands for opposite or varying access conditions (see the section on linking commands). 5 This is the type of command to be executed. A full explanation of EVERY possible type of menu command is in the "Menu System Commands" section. This field must be two characters long, or nothing will be executed. 6 This string contains miscellaneous command-particular information; each command uses this information differently. The MString used by each command is defined alongside the command keys in the "Menu System Commands" section, along with a short 5-10 line description of the command, what it does, and what all is possible with it. 7 There are several functions for each command which may be flagged on or off according to how they should be set up. When you press the "7" key from this section, the following flags can be changed: (H)idden command - This makes the command "hidden". This means that whether the user has access to the command or not, the command will NEVER be displayed on ANY generic menu. (U)nhidden command - This makes the command "unhidden". This means that the command will always be displayed to all users on any generic menus, - Page 82 - Telegard Main Documentation - Version 2.5 whether they have access to the command or not. If they do not have access to it, the command letters are displayed in generic color #1 (the same color as the surrounding brackets). Note that if neither flag is set, the default method (display the command if the user has access to it, and hide the command if the user doesn't) is used. If *BOTH* flags are set, the results are unpredictable! [ Displays the previous menu command. If at the first command, this command does nothing. ] Displays the next menu command. If at the last command, this command does nothing. F Displays the first menu command. J Displays the specified menu command. L Displays the last menu command. ----------------------------- MENU INFORMATION MODIFICATION ----------------------------- When you execute the "X" command at the main editor menu, you switch the display to show the other menu information: ______________________________________________________________________ Menu filename: MAIN 1. Menu name :**> Telegard Bulletin Board System <** :Main Menu 2. Help files :MAIN@S / *Generic* 3. Prompt :^4Time Left: [^3@T^4] (^3?^4=^3help^4)@M^4Main Menu ^2:^6 (Time Left: [01:00:00] (?=help) Main Menu :) 4. ACS required :"" 5. Password :*None* 6. Fallback menu :MAIN 7. Forced ?-level:None 8. Generic info :4 cols - 3/5/4 9. Flags :----- Q. Quit Menu editor (?=help) : ______________________________________________________________________ The following commands are available from this menu: 1 This field contains a description of the current menu (example: "Telegard BBS Main Menu"). One to three description lines can be defined. - Page 83 - Telegard Main Documentation - Version 2.5 2 This command inputs the TWO filenames which make up the menus of your menu system. The generic menus are specified in EITHER case by setting the strings to NULL (""). NEITHER filename should have a file extension. Telegard automatically searches for and displays MSG, 40C, ANS, or ANx, depending on the situation at hand (the user's account). The first filename is the NORMAL help display, and the second filename is the tutorial help display. If a "@S" occurs in either of these two filenames, it is replaced with the current user's SL, and THAT file is displayed. If that file is not found, the "@S" is taken out and THAT is displayed. If that file is still not present, a generic menu is displayed. Example: The filename is "MAIN@S", and the user's SL is 60. If MAIN60.* does not exist, and MAIN.* does not exist, a generic menu will be displayed. Note that tutorial menus can be turned off entirely on any menu by entering the string "*OFF*" (without quotes) as the tutorial filename. 3 This field contains the actual menu prompt that is displayed before it will accept commands from the user online. It can be up to 120 characters long, allowing many SysOp's to design VERY creative prompt strings. Prompt MCI is available in this field. 4 This is the ACS requirement that the user must satisfy in order to access the menu. If the user does not have access, and he/she enters the menu, they will be sent back to the fallback menu (specified by option 6). 5 If a menu has a password attached to it and a user attempts to enter the menu in any way, the password will be prompted for. If correctly entered, the user enters the menu; otherwise, the fallback menu is loaded. 6 This is a legal menu file which is loaded whenever the user does not have access to the current menu (see options 4 and 5) or some type of critical menu error occurs. 7 The help level setting that is forced when the user enters the menu. The help levels are: 0 -- No help level forcing. 1 -- Expert level (only the prompt is shown). 2 -- Normal level (the normal menu, or the short generic menu, is displayed). 3 -- Novice level (the tutorial menu, or the long generic menu, is displayed). 8 This entry includes all the information that is used to generate the generic menus. The number of columns to use, and the three colors used to colorize the menu command descriptions, are included here. - Page 84 - Telegard Main Documentation - Version 2.5 9 There are several functions for each menu that may be flagged on or off. The available flags are: (C)lear screen before menu - This tells Telegard to clear the screen every time the normal generic menu or generic tutorial menu is displayed. It should be used in conjunction with the "(P)Force pause before menu display" toggle, so that user gets a chance to see important information before the screen clears if he/she is not in expert mode. (D)on't center the menu titles - This tells Telegard to leave the menu titles uncentered (i.e. left justified). This ONLY affects the three menu titles at the top, not any of the Generic sub titles. (N)o menu prompt toggle - This can be used if you want to put the menu prompt for the menu RIGHT IN THE .MSG OR .ANS file. Telegard will not display any menu prompt whatsoever, and will totally ignore the current menu prompt, whatever it is. (P)Force pause before menu display - The screen will be paused before the menu is displayed, if this option is toggled on. This allows the user to see information from the previous command entered, if the menu clears the screen. (T)Auto-time display toggle - If this is set to ON, a "time-left" string will be inserted DIRECTLY before the prompt of the current menu. The format is as follows: "[<Time Left - HH:MM:SS>]" Many people find it more desirable to use the @T MCI command to insert a HH:MM:SS type format time left string into their menu-prompt, being able to customize the system even further. ---------------------------- SPECIAL GLOBAL MENU COMMANDS ---------------------------- There are several internal commands that may be used from ANY menu on the BBS (excepting the shuttle logon menu, SHUTTLE.MNU); their command letters therefore cannot be used in any menu command. These commands are: ? Pressing "?" will ALWAYS get help on ANY menu. Pressing it will raise the help level of the user by one. Since there are only three help levels, pressing it at the third one has no effect. Help level 1 is where no help whatsoever is displayed (expert mode). - Page 85 - Telegard Main Documentation - Version 2.5 Help level 2 is where the main help is displayed (normal mode). Help level 3 is when the tutorial help is displayed (novice mode). Hitting [ENTER] will drop the help level down to the user's normal level again. Available to all users. = This command will display a list of ALL the menu commands on the current menu loaded, and the contents of the current menu "stack" (used by the "-/", "-\", and "-^" menu commands). Available only to users with Co-SysOp access or higher. | This command will display the current version info, the date the BBS.EXE and BBS.OVR files were last compiled on by the authors, and the registration information, if available. Available to all users. //\\ When these characters precede a command, the rest of the command is executed just like a normal menu command; the command keys are the first two characters immediately afterwards, and the rest of the command is the MString of the command. For example, "//\\OC1;WHY DO YOU WANT TO CHAT?!" would execute the Chat menu command, with chat-reason question "WHY DO YOU WANT TO CHAT?!", sending mail to user #1 if the SysOp does not respond to the call. Available only to users with SL 255. ; When the ";" character is pressed, the rest of the command is treated as a command macro. Every other occurrence of ";" in the command is replaced with a <CR>. For example, entering ";MPThis is a test;SysOp;" from the main or file menus would ("M") enter the message menu, ("P") post a message, ("This is a test") enter the subject of the message, (";") include a <CR> at the end, and "address" the message to "All" (the last ";"). ------------------------- THE HELP-FILE MENU SYSTEM ------------------------- Telegard has a VERY complicated way of displaying text files - particularly the menus. Here is a list of possible file extensions and their meanings: MSG Contains Telegard color codes. Displayed with colors to those who have ANSI, but with NO color to those without ANSI. 40C Displayed to users with less than 80 column screen displays. ANS Displayed to those users who have ANSI. - Page 86 - Telegard Main Documentation - Version 2.5 AN1-AN9 If a file with an extension of AN1 exists, Telegard will RANDOMLY pick and display a file somewhere in the range of <ANS, AN1-AN9>. For example, if WELCOME.ANS, WELCOME.AN1, and WELCOME.AN2 all exist, Telegard will randomly choose one of them to display when WELCOME.* needs to be displayed by the system. A0S-A6S These ANSIs are displayed on different days of the week, ranging from 0:Sunday to 6:Saturday. They can be used in conjunction with the random ANSIs, too. (For example, WELCOME.A01 means the first (1) random ANSI displayed on Sundays). Don't worry if this system seems to be too complicated. A better system is on the way. The above is what is meant whenever you see something like WELCOME.* or SL50.*, etc. Telegard will search for any of these highly specialized files, depending on the user's account. Therefore, the menu system can be VERY complicated if you want to provide for all of the possibilities. It doesn't end THERE, however! Security-sensitive menus are possible through Telegard. In the help filename configuration of the menus, you can specify a "@S" to be replaced with the user's SL, and displayed. If their particular SL file does not exist, it will display a common one, which replaces "@S" with a null string (i.e. "MAIN@S" would become "MAIN"). You can have a MSG, 40C, and 10 ANSI text files for EACH of the security levels! While it's doubtful all these options will ever be used all at once, they provide some real interesting configuration abilities for the system. The following is an explanation of what goes on under several different conditions, for a sample configuration of the main menu. Here's the logic of this, if a user with ANSI and 255 SL is on and the main menu file is set to "MAIN@S": If (MAIN255.ANS exists) then { If (MAIN255.AN1 exists) then { The system chooses a random MAIN255.AN?, where "?" is either an "S" or "1"-"9". } Otherwise MAIN255.ANS is displayed. } Otherwise If (MAIN255.MSG exists) then MAIN255.MSG is displayed Otherwise { It repeats the ENTIRE process again, searching this time for MAIN.*. If no files were found THEN, it will display a generic menu. } - Page 87 - Telegard Main Documentation - Version 2.5 ----------------------- THE GENERIC MENU SYSTEM ----------------------- The generic menu system in Telegard is just another name for a self- generated menu system. Telegard will automatically generate its own help menus in two cases: if the menu help files specified the menu editor do not already exist, or if the SysOp explicitly uses the menu editor to configure Telegard to generate them. Many other BBS programs use generic menus, and unfortunately, it shows: They are usually very rigid, allowing very little room for creativity (making it a carbon-copy of other systems, and giving it a "bland" look). Telegard solves this problem by making the generic menus extremely configurable. First of all, the number of columns the BBS uses to generate the menus is configurable. The REALLY nice feature, however, is Telegard's ability to colorize menu command descriptions automatically, with no effort on the SysOp's part. If you want to change the ENTIRE color scheme of a certain menu, all you have to do is change a few parameters in the menu editor. Each menu can have a different color scheme, as well. When normal generic menus are displayed, they are displayed in the following format (this is an example using the 4 column size): <<< Menu Title >>> [ Column #1 ][ Column #2 ][ Column #3 ][ Column #4 ] [ Column #1 ][ Column #2 ][ Column #3 ][ Column #4 ] [ Column #1 ][ Column #2 ] All columns are left-justified, meaning they begin at column 1 of the screen. Descriptions which are too long to fit neatly within the columns are shortened. The furthest position any of the menu description lines go out to on the right of the screen is used to calculate the position of the menu titles; they are centered on the screen according to this (unless centering has been disabled with the "(D)on't center the menu titles" flag). When generic menu tutorials are displayed, they are displayed like this: <<< Menu Title >>> [ Command #1 ........ Max length = 70 chrs ] [ Command #2 ........ ] [ Command #3 ........ ] . . . - Page 88 - Telegard Main Documentation - Version 2.5 The menu titles are ALWAYS centered, using the same formula as in the normal generic menu displays (unless centering has been disabled with the "(D)on't center the menu titles" flag). When colorizing the menu descriptions (short or long, in the normal or tutorial menus, respectively), Telegard uses the three "generic colors" specified in the menu by the menu editor. The command keys (key sequences used to execute the command) are searched out, and if found in the description string, they are colorized using color #2. The "bracket" characters around the command keys are colorized using color #1, and all other characters in the description are colorized using color #3. Note that if an online user does NOT have access to a command, and it is an unhidden command, the command WILL be displayed, but with the command-keys colorized using color #1. This differentiates on the screen between commands the user HAS access to, and those they DO NOT. Note that the "bracket" characters need not be brackets. They can be any types of characters: Parentheses ("(" and ")"), dashes ("-"), or any of the characters from the IBM extended character set. Whatever they are, Telegard will simply colorize whatever is on either side of the command key sequence. Telegard has no problems handling descriptions such as "F)ile section", either, which have brackets only on ONE side of the command key sequence ("F"). The following diagram should help clear all this up: ________________ Color #1 (the "(" and ")" characters) | | (F)ile section | ^^^^^^^^^^^\__ Color #3 (all other characters - "ile section") |_______________ Color #2 (the "F" character) When a command with command letters of "GTITLE" is encountered by Telegard, it is treated as a generic sub-title. This means that the description is centered and placed on a separate line. For example, you could put the words "SysOp Commands" as a sub-title before your listing of SysOp commands in the file section. Telegard looks for a NEW set of Generic color codes in the MString, in the format of "<Color1>;<Color2>;<Color3>". If they DO exist, all commands for the remainder of the menu will be displayed in the new set of colors (unless, of course, another "GTITLE" is encountered). That's just about all there is to the colorizing methods! A rather simple system, but it tends to encourage creativity on the part of the SysOp -- more, probably, than any other comparable self-generating menu system. --------------------- LINKING MENU COMMANDS --------------------- One of the most powerful features of the Telegard menu system is its ability to chain, or "link", different menu commands together. Many things are possible using this feature. - Page 89 - Telegard Main Documentation - Version 2.5 Telegard's method of linked commands is the simplest possible method, as any programmer would attest to. When Telegard executes a menu command, it will execute all commands which have the command letters which were entered by the user. Therefore, if two different commands both have the same command letters in them, both commands are simply executed in the order in which they are placed in the menu editor (this is one of the purposes of the P:osition command). One possibility of linking commands is to display a text file (Cmdkeys -F) and then prompt the user whether he wants to send mail to a user on your BBS (Cmdkeys ME). This can be used for "SIGs" on your board that require users to "sign up" to receive access to them. Another possibility is to link the file section's area-change command with the current file section statistic's lister command (Cmdkeys F$). This will show the stats on the file base you have changed to, every time you change areas using the "A" command. Think of the menu editor as a kind of limited programming language. MANY, MANY things are possible, if you only use your imagination! You should remember one important thing when linking commands together. ONLY put a short and long description on the FIRST command in the chain of commands, and leave the rest set to NULL. This will prevent a command from being displayed several times when generic menus are displayed. One final feature: If a command (or several commands) with command letters "FIRSTCMD" are encountered in any menu, after it has just been loaded (either "loaded", "called", or "returned to"), they will be executed *first*, before the user is allowed to enter commands themselves. This can be useful in the file section to remind users that they still have files left in their upload/download batch queues (with the "B?" command keys), and for many other such things. With the powerful ACS system, you could even have Telegard remind (for example) user #50 that they should read their mail, on the message menu. ----------------------------------- MENU COMMANDS AVAILABLE IN TELEGARD ----------------------------------- Due to the fact that there are so many available commands, and that thorough descriptions of each command take up so much space, the available commands are described in a separate documentation file, MENU.DOC. Consult MENU.DOC for descriptions of all menu commands available in Telegard. - Page 90 - Telegard Main Documentation - Version 2.5 ____________________________ THE SCHEDULED EVENT EDITOR ____________________________ The Scheduled Event Editor allows you to define "events" that are run at defined times throughout the day/week/month. Various events can be run, such as BBS enhancements (updating bulletins, performing file section maintenance, packing the message bases, etc.) or DOS utilities (Norton Speed Disk, etc.). How do scheduled events affect users, specifically their time on-line? If a user logs on, and the amount of time allowed will overlap a scheduled event, the user's allowed time online is decreased accordingly. If a user is online and a scheduled event is approaching, he will be alerted prior to the event. The Event Editor can be accessed through the WFC menu and the SysOp menu. Upon executing, the following screen is displayed: ______________________________________________________________________ NN:Description :Typ:Bsy:Time :Len:Days :ExecData ==:===========================:===:===:=====:===:=======:============ -1 A NEW Telegard Event DOS 5 00:00 1 ------- event.bat Event editor (?=help) : ______________________________________________________________________ The following commands are available from this screen: <CR>Redisplay menu (D)elete (I)nsert (M)odify (P)osition (Q)uit <CR>Redisplay menu -- This will redisplay the listing of events that are present. (D)elete -- This will allow you to delete an undesirable system event from the listing. (I)nsert -- This will insert another event in the list of defined system events. (M)odify -- This will allow you to modify an existing event. More on this command later. (P)osition -- This will move an event from one position to another in the list of events. (Q)uit -- Exits the Event Editor and returns to the point you entered (the WFC menu or the SysOp menu). - Page 91 - Telegard Main Documentation - Version 2.5 When you select the (M)odify command, you are asked to select the event that you would like to modify. Upon selecting, the event data is displayed: ______________________________________________________________________ Event #1 of 1 !. Active : No 1. Description: A NEW Telegard Event 2. Sched. type: DOS shell 3. Event data : event.bat 4. Busy time : 5 minutes 5. Exec time : 00:00 6. Busy during: Yes 7. Duration : 1 8. Days active: ------- Edit menu (?=help) : ______________________________________________________________________ The item numbers and available commands at this screen are explained in detail below. ! This determines whether or not the event will be executed at the scheduled time. The default is "no". If it is toggled to "yes", it acts according to the specifications defined for the event. 1 This field describes the event. Up to 80 characters are allowed, as well as MCI color codes. 2 This is the type of event that will be executed. There are four possibilities, outlined below: ACS -- These events are regulated by the ACS system. It is designed to enable only certain callers to access the BBS at a specified time of the day. The BBS will prompt for a user name or number, and if that user number is not defined in the current ACS event, that user will not be able to log on. The connection is terminated after a 20 second "grace period". Chat -- Not implemented yet. DOS -- By far, the most common event, this is activated by performing a shell to the DOS level and executing files defined in the Event Data (usually batch files). Note that this event type should NOT be used for programs that require a lot of memory (for example, disk de-fragmenting programs such as Norton Utilities Speed Disk or PC Tools Compress). External -- This requires a batch file for execution, which is used to detect an ERRORLEVEL value - Page 92 - Telegard Main Documentation - Version 2.5 (returned upon exiting the BBS) to determine the operation to be performed. This will TOTALLY exit the BBS, using the ERRORLEVEL value defined in the Event Data field. Pack -- This event packs the message bases by removing all deleted messages and adjusting the number of messages in each base to conform to the maximum limit set in the message base editor (by removing old, non-permanent messages). You should define AT LEAST ONE packing event; if you don't, your message bases will "grow out of control"! 3 The contents of this field will vary with the type of event being executed: DOS -- The name of a batch file to be executed when dropping to DOS, or the name of a program to be executed. External -- The ERRORLEVEL value to be used to detect the type of event to execute. The value is restricted to the range 0-255. (It is recommended that you do NOT use either 0 or 255.) ACS -- The ACS requirement that users must satisfy in order to log on to the BBS. All others -- Not used; the event data field will be ignored. 4 This is the time prior to an event that the BBS will appear busy. Telegard will take the Exec Time and subtract the Busy Time to determine this value. When the time is encountered, the modem is taken off-hook using the "modem off-hook" command (defined in the Modem Configuration section in System Configuration), and will remain off-hook until the event time is reached. Then, depending on the setting of the Busy During field, the modem will either remain off-hook or it will be initialized. Setting this field to zero (0) allows users to remain online until the exact time of the scheduled event (at which time they are unceremoniously logged off!). 5 This is the time of day that the particular scheduled event will occur. It is defined in both hours and minutes, on a 24-hour clock. 6 This field determines whether or not the modem will be taken off-hook during the scheduled event (the default is "yes"). If the value is "no", the modem will stay on-hook during the event (useful for ACS and Chat events). 7 This is a specified time in minutes that will be necessary for the event to occur. This field will usually be set to one (1) minute. Unless you know PRECISELY how many minutes - Page 93 - Telegard Main Documentation - Version 2.5 an event will take, you should ALWAYS set this field to 1. 8 These are the days of either the regular week, or the whole month, that the scheduled event will occur: Weekly -- This will occur at least once every single week. A bar with the current days active will be displayed as follows: Current: SMTWTFS Modify by entering "X"'s under the days. If it is not currently active, typing "X" under the day will make it active, and vice versa. Monthly -- This will occur only one day in the month. The default is the first day of the month. This is common for such routines as a hard drive backup program. [ This will jump back one entry in the list of events. If it is positioned at the first entry, this command is ignored. ] This will move forward one entry in the list of events. If it is positioned at the last entry, this command is ignored. F This will move to the first entry in the list of events. L This will move to the last entry in the list of events. J This will jump to a specified entry in the list of events. Q Saves all entries in the list of events and returns to the main editor screen. - Page 94 - Telegard Main Documentation - Version 2.5 __________ MINI-DOS __________ Mini-DOS is a security sensitive DOS shell that is common to many BBS programs. It runs as an "internal door" and works according to that user's ACS. Mini-DOS in Telegard is usually accessed either via the WFC menu in local access mode, or remotely through the SysOp menu. When Mini-DOS is executed, it automatically shells to the AFILES directory defined in the system configuration. Upon execution, the following appears: Type "EXIT" to return to Telegard. Telegard(R) Mini-DOS(R) Version 2.5 (C)Copyright 1988,89,90 The Telegard Team <C:\BBS\AFILES> and you are ready to go to work. ----------------- MINI-DOS COMMANDS ----------------- The command set that is resident in MiniDOS is as follows: x: This command is synonymous to DOS' ability to change between drives being accessed at the DOS level. For example, if you are currently in drive C and type "E:", control will switch to drive E. This works much the same as DOS, in that it accepts only logical drives A-E (or the highest drive specified in the "LASTDRIVE" parameter of CONFIG.SYS). CD This works almost the same as the CD (or CHDIR) command in DOS, in that it enables the user to go to different paths within the file directory tree. The only noticeable difference is that the Mini-DOS CD command requires a space between the command and the directory name (i.e., although ".." can be used just like in DOS to go to the parent directory, you must use "CD .." instead of "CD.."). CLS Works the same as DOS' CLS command, in that it erases the current screen and places the prompt at the upper left corner. COPY This works almost the same as DOS' COPY command with the exception that you can't have wildcards appear in the destination filename. The copy format is as follows: - Page 95 - Telegard Main Documentation - Version 2.5 COPY [destination] 'to' [target] Thus the following formats are valid: COPY A:EXAMPLE.TXT D:EXAMPLE.TXT COPY A:*.* D: COPY A:*.GIF D: DEL This will physically erase files from the storage media, and it acts the same as DOS' internal delete command and will delete one or more files. It can support wildcards, and if the file in question is not present or has a read only attribute, the following text will be displayed: <Filename> Could not delete DIR This is the same as DOS' DIR command that displays a listing of files, and it can use wildcard formats, including "*" and "?". EDIT This command invokes the internal text editor, which can be used to edit standard ASCII text or Telegard *.MSG files. EXIT Exits out of Mini-DOS and returns to the WFC menu (or the BBS if online). EXT Allows a user with SysOp access to execute an external DOS command or program. The syntax is: EXT <Command> where <Command> is a DOS command or program executed exactly the same was as if it were being executed from DOS itself. Note that while Telegard is loaded, there is not much memory available to do anything extensive. IFL Displays a list of files inside an archive file. The syntax is: IFL <Filename> where <Filename> is the name of an archive file in ARC, LZH, PAK, ZIP or ZOO format. If you do not specify a filename, a help screen will be displayed. MD This command is the same as the external DOS command, in that it will make a new directory. MOVE This command functions the same as COPY, except that the source files are deleted once they have been copied to their destination. RD This command is the same as the external DOS command, in that it will remove a directory (as long as it is - Page 96 - Telegard Main Documentation - Version 2.5 empty, and no files or directories are contained within it). REN This is the same as the external DOS command that will rename a file or a wildcard of files to a different filename(s). SEND Enables a high security level user to download files (usually BBS or DOS related) not present on the system, that may be essential. The caller will enter "SEND filename" and choose a file transfer protocol to use to download the file. The file is then transferred and the Mini-DOS prompt will return. TYPE This command operates almost exactly the same as DOS' TYPE command, except that (1) the display will pause when it has filled according to the user's setup, and (2) if a *.MSG file is displayed that contains MCI color codes, the file will be displayed in color (or not, again according to the user's setup). VER Displays information about the current version of Mini DOS and Telegard being used. For example, Mini-DOS for version 2.5 displays the following text: Telegard(R) MiniDos(R) Version 2.5 (C)Copyright 1988,89,90 The Telegard Team ? Displays a list of all available Mini-DOS commands. ------------------------ THE MINI-DOS TEXT EDITOR ------------------------ Telegard has a special built in text editor that can be used to edit standard ASCII text files or Telegard *.MSG files. This editor works similarly to DOS' EDLIN text editor, in that it works on one line at a time. Upon entering the text editor (either from the WFC menu or through Mini-DOS), you are given a command line and must enter the name of the file you wish to edit. The default path is your AFILES directory, and when you request help in the text editor, by pressing "?" for a list of commands, you are presented with the following menu: (+)Forward line (-)Back line (T)op (B)ottom (P)rint line (L)ist (I)nsert lines (D)elete lines (R)eplace line (C)lear all (Q)uit (abort) (S)ave (*)Center line - Page 97 - Telegard Main Documentation - Version 2.5 These commands are explained below: (+)Forward line -- Will move the current line of editing up one in position, unless it is at the end, then it will say [end line]. For example, if you are currently editing line number 5 and at the ":" prompt, you hit a "+", you are moved to line 6 of the text. (-)Back line -- Moves the current text being edited back one in position, unless at the beginning in which case it will automatically stay at line 1. (T)op -- Automatically moves the line being edited from the current one to line 1. (B)ottom -- Automatically moves the line being edited from the current one to the last line of the text. (P)rint line -- Display the current line. (L)ist -- Will list the line being edited and all subsequent lines in the file. Therefore, if you have a 26 line text file, and are currently editing line 6, the list will be from 6 to 26. (I)nsert lines -- Enables you to insert lines either blank or containing text, until you type "." at the beginning of a line to save the file. (D)elete lines -- Enables you to delete the current line being edited in the file. (R)eplace lines -- In the event you wish to replace lines, this command will show the original line and then provides a blank line for changes and alterations. (C)lear all -- Clears the screen and makes the file in memory appear blank. Basically, used ONLY when a file has been damaged so bad, there is no salvaging it. (Q)uit (abort) -- Used to abort the edit. Does NOT save the file in memory to disk. Used when you made a mistake and decide that the previous version of the file was better. Returns you to the point of entry (the WFC menu, the BBS, or Mini- DOS). (S)ave -- Used to save the file in memory to disk, then it will exit and return to the point of entry (the WFC menu, the BBS, or Mini-DOS). (*)Center line -- This command will center the line being edited. Be careful with this command; since it does not remove any previous centering code, you could end up "stacking" multiple centering codes on the line (making it look not at all like you want!). - Page 98 - Telegard Main Documentation - Version 2.5 ___________________________________ THE INFOFORM QUESTIONNAIRE SYSTEM ___________________________________ The InfoForm questionnaire system is one of Telegard's most powerful information-gathering features. Using just a few commands -- scattered in an ordinary text file -- the SysOp can gather volumes of information about users: Who they are, what they want, what they DON'T want. The uses for the InfoForm questionnaire system are virtually endless. ------------------------------------------- HOW INFOFORM QUESTIONNAIRES ARE CONSTRUCTED ------------------------------------------- InfoForm questionnaires are really nothing more than plain text files with certain commands, meaningful only to the InfoForm system, placed throughout. Think of the InfoForm system as a miniature batch file language, but whose emphasis is placed on user input. The InfoForm questionnaire is stored in the AFILES directory, in a file with the extension ".INF". When users answer the questions, their answers are also stored in the AFILES directory, in a file with the same name as the InfoForm questionnaire but with the extension ".ASW" (for "AnSWers"). Answers from different users are appended to the end of the *.ASW file; thus, you have a complete record of each user's responses (until you delete the *.ASW file). -------------------------- THE NEW USER QUESTIONNAIRE -------------------------- A special InfoForm questionnaire, if present, is always given to a new user during the new user logon process. The file is NEWUSER.INF, with the answers stored in NEWUSER.ASW. Like all InfoForm questionnaires, NEWUSER.INF can contain any questions you like; however, the new user questionnaire is usually used to ask for additional information (information that isn't requested during the normal new user logon process). Answers to the new user questionnaire can be read from the user editor, or through a menu command (discussed below). ------------------------------------------ ASKING AND READING INFOFORM QUESTIONNAIRES ------------------------------------------ Constructing a command to ask an InfoForm questionnaire is simply a matter of adding a new command to a menu. The command should use Cmdkeys "-Q", with the InfoForm questionnaire filename in the MString field. For example: - Page 99 - Telegard Main Documentation - Version 2.5 Long descript :(Q)uestionnaire - Ask user some questions Short descript:(Q)uestionnaire Cmd letters :Q ACS required :"s20" Cmdkeys :-Q MString :question.inf Flags :None Reading an InfoForm answer file is just as easy. Construct a command using Cmdkeys "-R", with the InfoForm questionnaire filename in the MString field: Long descript :(R)ead Answers - Read answers to questionnaire Short descript:(R)ead Answers Cmd letters :R ACS required :"s20" Cmdkeys :-R MString :question.inf Flags :None Alternately, you could leave the MString field blank, in which case Telegard will prompt you for the InfoForm questionnaire filename in which to read the answers. ------------------------------- INFOFORM QUESTIONNAIRE COMMANDS ------------------------------- Below are listed all the InfoForm questionnaire commands currently supported by Telegard. All commands must start on a separate line, beginning with a ";" (semicolon) character. Labels (used by the "G" and "I" commands) start on a separate line, beginning with a ":" (colon) character and followed by a string of characters. Anything else is treated as displayable text. Command: A<string>* Function: Upper and lower case string input. Displays <string>, then inputs the string at the "*" character. NOTE: All characters after the "*" character are completely ignored! Command: B<string>* Function: Similar to the "A" command, except all input is upper case only. Command: C"chars"<string>* Function: Multiple-choice input. Displays string, then inputs a single character at the "*" character. Accepted answers are any character between the quote marks (""). Command: Dx<string> Function: Open door. Outputs a door file (depending on "x"), then executes <string>. All rules for standard door commands apply (refer to the menu documentation). Allowable values for "x": - Page 100 - Telegard Main Documentation - Version 2.5 - None (no door file written) C CHAIN.TXT (WWIV) D DORINFO1.DEF (RBBS-PC) G DOOR.SYS (GAP) S SFDOORS.DAT (Spitfire) W CALLINFO.BBS (Wildcat!) Command: G<label> Function: Goto statement. Returns to beginning of file and searches for the first label of <label>. If none exists, the end of the questionnaire file is reached and the questionnaire completes. Command: H Function: Hang up. Terminate questionnaire and hang up on user. Command: I<string>,<label> Function: Conditional goto statement. Branches to <label> if <string> was the last value input from a "A", "B", "C", or "Y" command. No distinction is made between upper and lower case. Command: K Function: Abort. Terminate questionnaire without saving answers in answer file. Command: L<string> Function: Outputs <string> to the questionnaire answer file, but not to the user's display. Command: Q Function: Quit. Terminate questionnaire and save answers in answer file. Command: T<filename> Function: Displays the file <filename>. Command: Y<string>* Function: Yes or No question. Displays <string>, then accepts either a "Y" for Yes, or an "N" for No, at the "*" character. Command: ;<string> Function: Comment. It is neither displayed, nor output to the questionnaire answer file. ------------------------------- A SAMPLE INFOFORM QUESTIONNAIRE ------------------------------- Below is listed a small InfoForm questionnaire as an example of what the InfoForm system can do. This questionnaire is suitable for use as a new user questionnaire (NEWUSER.INF); with a little modification, it can be enhanced to ask whatever questions you wish. - Page 101 - Telegard Main Documentation - Version 2.5 Okay... just one more series of questions to answer, and then you'll be on your way! It is essential for validation purposes and security measures that you answer the following questions as completely and accurately as possible. There are no trick questions, so don't worry... it's not a test! ;AAbout how long have you been BBSing? * ;YAre you a SysOp of any BBS? (Y/N) : * ;INO,NOSYSOP Enter the BBS number in the following format: ###-###-#### ;A: * Now enter the BBS name: -BBS-Name--------------------------------------------------- ;A: * ;AWhat type of BBS software do you run? * ;AHow long has your BBS been running for? * ;GNOSYSOP1 :NOSYSOP Oh well, someone's gotta do it, eh! :NOSYSOP1 Do you know any of the current users on this BBS, or any other good users that could recommend you? (2 lines) 1: * 2: * Well, that completes our little survey. Hope it wasn't too painful! - Page 102 - Telegard Main Documentation - Version 2.5 _________________ RUN-TIME ERRORS _________________ Certain errors at run time cause Telegard to exit back to DOS. Whenever this occurs, the ENTIRE screen image is output to a file called "ERR.LOG" in your main BBS directory, along with certain pieces of vital information such as time, date, error number, BBS version number, the user who was on and what baud rate they were on at. Here is what each screen image entry LOOKS like in ERR.LOG: RT #XXX at MM/DD/YY HH:MM:SS BBS-Ver: 1.7b Standard User "BLACK ADEPT #1" was on at 2400 baud after which follows the "picture" of the screen at the time of the error. Also, a message is output to the SysOp log, and the user's screen, when a run-time error occurs. This is output to the SysOp log: *>> Runtime error XXX at MM/DD/YY HH:MM:SS <<* (Check ERR.LOG in main BBS dir) and this is output to the user's screen: *>> System error occurred at MM/DD/YY HH:MM:SS <<* Note that WHENEVER a run-time error occurs, it is a bug in Telegard. Telegard is NOT supposed to have run-time errors in it. Please note the information at the top of the ERR.LOG file: Critical Error Log file - Contains screen images at instant of Error. The "X" character shows the cursor position at time of error. Note: You may periodically delete this file with no harm to the system, but note the following information: Please notify Eric Oman that you have encountered a Critical Error. You will need to send this file to him, along with a short message stating - briefly - what events led up to the Critical Error, and whether or not the error was repeatable, and under what circumstances. The run-time errors are divided into four categories: DOS errors 1- 99; I/O errors, 100-149; critical errors, 150-199; and fatal errors, 200-255. Please remember that run-time errors should NEVER HAPPEN! When they do, it is an indication that something in the BBS isn't working correctly. The following is a listing of all run-time errors. You might be able to figure out the problem, and correct it, by referring to this list. If you can't, don't get discouraged. Just call one of the Alpha or Beta sites near you, and they'll be happy to help you through any problem you might encounter. - Page 103 - Telegard Main Documentation - Version 2.5 ---------- DOS ERRORS ---------- 2 File not found. 3 Path not found. 4 Too many open files. This error may indicate that you do NOT have a FILES=xx entry in your CONFIG.SYS file. You should have the following lines in your CONFIG.SYS file: BUFFERS=40 FILES=30 5 File access denied. 6 Invalid file handle. This error is reported if an invalid file handle is passed to a DOS system call. It should never occur; if it does, it is an indication that the file variable is somehow trashed. This may come about if you edit a file that has been opened by Telegard. 12 Invalid file access code. 15 Invalid drive number. 16 Cannot remove current directory. 17 Cannot rename across drives. ---------- I/O ERRORS ---------- 100 Disk read error. Reported if Telegard attempts to read past the end of a file. 101 Disk write error. Reported if the disk becomes full. 102 File not assigned. 103 File not open. 104 File not open for input. 105 File not open for output. 106 Invalid numeric format. --------------- CRITICAL ERRORS --------------- These errors usually indicate a hardware problem. Double-check your system for faults (especially your hard and/or floppy disks). 150 Disk is write-protected. - Page 104 - Telegard Main Documentation - Version 2.5 151 Unknown unit. 152 Drive not ready. 153 Unknown command. 154 CRC error in data. 155 Bad drive request structure length. 156 Disk seek error. 157 Unknown media type. 158 Sector not found. 159 Printer out of paper. 160 Device write fault. 161 Device read fault. 162 Hardware failure. ------------ FATAL ERRORS ------------ These errors always immediately terminate the program. 200 Division by zero. 201 Range check error. 202 Stack overflow error. 203 Heap overflow error. 204 Invalid pointer operation. 205 Floating point overflow. 206 Floating point underflow. 207 Invalid floating point operation. 208 Overlay manager not installed. 209 Overlay file read error. If you run Norton Utilities Speed Disk or PC Tools Compress (or some other hard disk organizer/defragmenter) as an event, and run it as a DOS Shell event, this error can occur sometimes, because Speed Disk/Compress will probably move the BBS.OVR file somewhere else. The solution is to run Speed Disk/Compress as an "External" event. (Any program of that nature should be run as an "External" event anyway, to give them all the memory they want to operate!) - Page 105 -