BinkleyTerm ST 3.00 - Reference Guide **** * * * ******* TM * * * * * * * * * ** * * * *** * * * *** * ** *** ** **** * ** * * * * * * * * * * * ** * * * * * * * * *** * **** * * * **** * * * * * * * * * * * * * * * * * * * * * **** * * * * * * **** **** * **** * * * * * Version 3.00 - Reference Guide * November 30th 1991 *** A Freely Available FidoNet Compatible Electronic Mail Interface and Dumb Terminal Package Software Written by Vince Perriello and Bob Hartman Atari-ST version by STeven Green. Documentation Written by Alan D. Applegate Documentation Updated by Robert Elsinga and STeVeN Green Copyright (C) 1988, 1989 Bit Bucket Software, Co. A Delaware Corporation All Rights Reserved Terms and Conditions Contained Separately Bit Bucket Software, Co. 427-3 Amherst St., Suite 232 Nashua, NH 03063 "BinkleyTerm" and "Freely Available" are trademarks of Bit Bucket Software, Co. BinkleyTerm ST 3.00 - Reference Guide TABLE OF CONTENTS Section 1 - General Information 4 How to Use This Manual 4 Section 2 - Configuring BinkleyTerm 5 Configuration File 5 Scheduling Events 34 Janus Protocol 40 Domain addressing 44 Section 3 - General Reference Information 46 Command Line Parameters 46 Dial Translation 47 Response File Template 48 Scripts 51 Terminal Mode Keystrokes 56 Unattended Mode Keystrokes 60 VT-100 Keystrokes 64 Environment Variables 65 Index 66 Reference Guide - Page 2 BinkleyTerm ST 3.00 - Reference Guide +-------------+ | +---------+ | | | Section | | BinkleyTerm Reference Guide | | 1 | | GENERAL INFORMATION | +---------+ | +-------------+ HOW TO USE THIS MANUAL The documentation for BinkleyTerm is supplied in two parts. The User's Guide (named BT_USER.DOC) explains how to install BinkleyTerm. It also describes basic operational procedures. New users may find some concepts or terminology unfamiliar; a glossary is provided toward the end of the User's Guide. Concepts and terminology that may be of interest to experienced users and new users alike are covered in the Reference Guide (named BT_REF.DOC) an alphabetically arranged manual separate from the User's Guide. For inquiries, questions or comments regarding BinkleyTerm, please refer to the User's Guide section "BinkleyTerm Support." Reference Guide - Page 3 BinkleyTerm ST 3.00 - Reference Guide +-------------+ | +---------+ | | | Section | | BinkleyTerm Reference Guide | | 2 | | CONFIGURING BINKLEYTERM | +---------+ | +-------------+ CONFIGURATION FILE The BinkleyTerm configuration file, by default named BINKLEY.CFG, is the place where you communicate information about your system to BinkleyTerm. Modem control strings, FidoNet node addresses, and much more are all contained in the configuration file. A sample configuration file comes with the BinkleyTerm distribution package. The sample file is arranged in such a way as to illustrate which parameters need to be changed for which operational modes. For ease of use as a reference, the parameters are listed alphabetically here. About This tells BinkleyTerm the name of the ABOUT file, a special file used with incoming file requests. is a complete drive, path and filename designation. Refer to the User's Guide sections "File Requests" and "Security - Controlling File Requests" for more information. Address [:]/[.][@domain] [fakenet] [bossphone] This statement (or multiple statements) designates the network address(es) of your system. Although the and parameters are optional, it is recommended that the parameter ALWAYS be used. When this statement is used, the older style (BinkleyTerm 2.00 and previous versions) addressing should NOT be used, such as 'Aka', 'Point', and 'Zone'. Multiple 'Address' statements, each with a different parameter, may be used. This allows BinkleyTerm to identify itself differently to different zones, thereby making multi- net operation somewhat more simple. Note that in this scenario, if you are connected to a zone for which an 'Address' statement does not exist, that the 'Address' statement that appears first in the configuration file will be used as a default. In addition, the zone given in the 'Address' statement that appears first determines your "default" outbound area, as given by the 'Hold' statement. Mail for all other zones is stored in distinct outbound areas for each zone. See "Zone Support" in the User's Guide for details. Point systems should add the optional fakenet address to this line rather than use the older Boss, PrivateNet and BossPhone statements. This enables you to be a point from more than one system using a different fakenet address for each. Reference Guide - Page 4 BinkleyTerm ST 3.00 - Reference Guide AfterMail If used, BinkleyTerm will invoke a DOS shell and execute the after receiving mail. It is suggested that designate a batch file, rather than a specific program. The batch file would contain command line(s) for the program(s) that will actually unpack and/or toss incoming mail. NOTE! If this statement is used, no E2= or E3= exits during event schedules should be used, since they take priority over this statement. Refer to the section "Scheduling Events" for details. See also 'Packer' and 'Cleanup' for related information. Aka / NOTE: This statement is supported for backward compatibility only. If you wish to specify a/k/a addresses, please use the newer 'Address' statement described previously. Allows nodes with more than one FidoNet address to specify their alternate addresses. This would normally be used by network, region or zone coordinators, and other 'special' nodes. Multiple 'Aka' statements can be used. Answer When this statement is used, BinkleyTerm assumes that the modem has been set NOT to answer the phone automatically (by the modem initialization string, or the modem's DIP switches). When BinkleyTerm receives a response string of "RING" from the modem, it sends the command to the modem to answer the phone. The advantage is that BinkleyTerm must be "alive and well" before the modem will answer a call. If for some reason BinkleyTerm is not available, yet the modem still has power, no calls will be answered. NOTE! Some modems DO NOT like commands to be sent while they're sending response strings...in testing, this feature DOES NOT work on all modems. Only by trying it will you be able to determine if it works with your modem. AnswerBack In Terminal Mode, when an ENQ (ASCII decimal 5, hex 5) is received, will be sent in response. Normal BinkleyTerm character translations are available. Many BBS packages send this character immediately prior to requesting a user name. Reference Guide - Page 5 BinkleyTerm ST 3.00 - Reference Guide Application [ ... ] Allows addition of application dependent data to the configuration file. Any 'Application' statement is ignored by BinkleyTerm entirely. is the name of or reference to a specific application, such as a message editor or outbound maintenance utility that uses the BinkleyTerm configuration file. Zero or more application specific parameters, shown as in the example, may follow . Autobaud In Unattended Mode, this forces BinkleyTerm to call out at the baud rate specified by the 'Baud' statement, regardless of the baud rate associated with a given nodelist entry. This assures connects at the highest possible baud rate. Avail This designates the name of the file to be sent to a remote system that file requests "FILES" from your system. The identifies the file, and may contain an optional drive and path designation. Refer to the User's Guide sections "File Requests" and "Security - Controlling File Requests" for more information. Banner The line designated by is sent to callers immediately following the BinkleyTerm identification line, and before the line, "Press to enter BBS." Generally, this is the name of your BBS or something else of interest to callers. Baud This parameter tells BinkleyTerm your maximum baud rate. Valid settings are 300, 1200, 2400, 4800, 9600, 19,200 and 38,400. In Terminal Mode, you may change this setting. Note that on the Atari ST machines 38400 baud is not supported by the OS, but BinkleyTerm will attempt to do it by changing hardware registers, this is not very reliable however and if you really need 38400 baud then you should consider performing a hardware patch to increase the baud rate. See Hard38400 for more information. BBS This designates the method to be used to access your BBS software when a human caller dials your system. Valid options for are 'Batch,' 'Exit' and 'Spawn.' Refer to the User's Guide section "BBS Interface" for more information on the options, and how to use them. Reference Guide - Page 6 BinkleyTerm ST 3.00 - Reference Guide BBSNote After a human caller presses Escape to access the BBS program, or after the number of seconds designated by the 'Timeout' statement, BinkleyTerm will display the to the caller. Generally, this is a notification that the BBS software is loading. Boss / NOTE: This statement is supported for backward compatibility only. It is not needed when the 'Address' statement is used, as described previously. This specifies a FidoNet node address. For regular FidoNet nodes, place your assigned address here. For Point systems, place the address of your Boss node here. BossPhone NOTE: This statement is supported for backward compatibility only. It is not needed when the 'Address' statement is used, as described previously. This parameter, used in Point installations, contains the telephone number of your Boss node for use with the Alt-Y command in Terminal Mode. This statement is optional in all cases except Point installations that do not wish to use a nodelist. BossPwd NOTE: This statement is supported for backward compatibility only. It is not needed when the 'Address' and 'key' statements are used as described elsewhere. Used for Point installations, this parameter designates the password to be used for session-level passwording with your Boss node. Refer to the User's Guide section "Security - Session Passwording" for additional information. The Boss node must also have session passwording implemented, using this password. When this parameter AND 'BossPhone' are BOTH implemented, a nodelist is NOT required for a Point system. Reference Guide - Page 7 BinkleyTerm ST 3.00 - Reference Guide BoxType When full-screen mode is used (default), this tells BinkleyTerm what type of boxes to use for the various on- screen windows. Legal values are from 0 to 4. They produce the following results (apologies given to people with printers that do not support the extended IBM character set): 0 1 2 3 4 0 = Hatches (Non-IBM) +-+ ÚÄ¿ ÉÍ» ÖÄ· Õ͸ 1 = Single Rule | | ³ ³ º º º º ³ ³ 2 = Double Rule +-+ ÀÄÙ Èͼ ÓĽ Ô; 3 = Single Top, Double Sides 4 = Double Top, Single Sides To make use of any of the types other than 0 on an Atari ST, it is recommended to use the program BTFONT by Jon Webb. Busy While BinkleyTerm performs certain functions, and when you exit the program from Unattended Mode, BinkleyTerm sends the to the modem. Normally, this is a short set of modem commands, as shown in the sample configuration file, to take the phone off-hook to prevent incoming calls. Callers will hear a busy signal. You may desire to lower DTR instead using a lower-case letter "v." This would cause callers to hear ringing, but with no answer. CaptureFile If used, this statement tells BinkleyTerm the name of a file to use for session capturing in terminal mode. The Alt-L command toggles session capture on and off. If this statement is not used, then BinkleyTerm will prompt for a name each time Alt-L is pressed. When activated, all communications session I/O will be echoed to this file. The may optionally include a drive and path designation as well. Carrier For backwards compatibility ONLY! This has no effect on the Atari ST. This tells BinkleyTerm which status bit it should use to determine whether or not carrier is present. A value of 80 (hexadecimal) is nearly always correct. Some modems do not support CD (carrier detect) and other signal lines may be used. NOTE: This value is in HEXADECIMAL (base 16). Other systems, such as Opus-CBCS, ask for this value in DECIMAL (base 10). Normal setting is 80 hex, which equals 128 decimal. Reference Guide - Page 8 BinkleyTerm ST 3.00 - Reference Guide City The location of your system as specified in the NodeList. Intended to be used to create a nodelist entry for you and is sent to the remote system during an EMSI session. See also: NLSystem, NLFlags, NLBaud, Phone. Cleanup If used, BinkleyTerm will execute at the beginning of each event, but prior to the 'Packer' statement's command line (if used). This might be used to unpack any previously packed outbound mail for later repacking, or to perform minor outbound area maintenance, etc. It is suggested that designate a batch file that would contain the command line(s) for the program(s) actually used to unpack mail and/or perform maintenance. See also 'AfterMail' and 'Packer' for related information. CLIcommand Defines a string passed to a command line interpreter. If this command is used then the default "-c" and "/c" parameters are overidden. Using this command without any parameters disables the "-c" and "/c" completely. e.g. CLIcommand batch would execute shell's using: $SHELL batch commandline or $COMSPEC batch commandline Colors This statement allows setting of colour attributes for the full-screen windowed display. The arguments are for the informational border area around the windows, and the following colour attributes: for the "Current Settings" window, for the "Today at a Glance" window, for the "Pending Outbound Mail" window, for the "Recent Activity" window, and for the "Transfer Status" window. The parameter designates the reverse video colour used in the Pending Outbound window to mark the node you are calling. The parameter designates the colour of pop-up windows (such as those produced with the Alt-G and Alt-S commands in Unattended Mode). The parameter designates the colour used in named windows, the colour of the frames. The default colors are all 7, black background with white foreground. Reference Guide - Page 9 BinkleyTerm ST 3.00 - Reference Guide Each parameter is a colour calculated as: background*16+foreground where the colours are the logical colours used by Tos. e.g. on a hi- rez screen they are 0 or 1, on a medium rez 0,1,2,3, etc. Be very careful not to make the background the same as the foreground. Refer to the reference guide for what each parameter does. The actual colours will depend on what you set them to with the desktop control accessory. You'll probably be best off simply using Black and White!!! Tos only uses the low bits needed by that resolution so you can specify a colour as colour 15, but on a mono screen this will be the same as 1. I hope all that makes sense to you. Some recommended colours are: Colors 1 3 2 3 3 2 48 32 ; (Medium rez) or Colors 7 7 7 7 7 7 240 240 ; (Mono/Hirez) The default is something like I just recommended for monochrome. The screen will adjust itself to the physical screen size when initialised. Thus if you are using that program that lets you have 50 rows on a mono-screen (instead of the usual 25), BinkleyTerm will use the entire screen. Line A variables are used to move the cursor about and change colours, which makes it quite a bit faster than sending all this through the VT52 emulator. CurMudgeon Undocumented feature of the PC version, treats other systems points as nuisance callers and drops carrier. CursorCol For use with multitasking systems, this tells BinkleyTerm the column number to place the cursor after screen writes. For DESQview, should be set to 1. The default value is 80. CursorRow For use with multitasking systems, this tells BinkleyTerm the row number to place the cursor after screen writes. For DESQview, should be set to 1. The default value is 23. Debug For debugging purposes only! Let's Binkley write very detailed information to the logfile when using Beta Test versions. Reference Guide - Page 10 BinkleyTerm ST 3.00 - Reference Guide Dial /[] This option allows for real-time telephone number translation. BinkleyTerm will look at the telephone number it is to send to the modem. If the prefix of the telephone number matches that shown in , then the prefix will be changed to , and (optional) will be added to the end. In most cases, this will be used to strip-off "1-" and/or area codes for systems in a local exchange, such as: DIAL 1-603-888 888/ A number in the nodelist as 1-603-888-8179 would be changed to simply 888-8179 and dialled. DIAL 1-303-555 555/&M0 A number in the nodelist as 1-303-555-1234 would be changed to 555-1234&M0 and dialled. There is a maximum of 20 characters each for , and . Another use for this feature would be for dialling scripts: DIAL 1-404 "GA_PCP.SCR"404/ This line could be used to invoke a PC Pursuit script, for example, for the state of Georgia. The script would be used for all outgoing calls to area code 404. For permanent translations it is probably more efficient to perform these translations with your nodelist processing program (i.e., XlatList, ParseLst, XlaxNode). Refer to your nodelist processing software documentation for more information. DoingMail If used, this statement will cause BinkleyTerm to send to a caller when an event without a 'B' flag is active, indicating that BBS access is NOT allowed. This replaces the default string "Processing Mail. Please hang up." See the section "Scheduling Events" for more information on event flags. Reference Guide - Page 11 BinkleyTerm ST 3.00 - Reference Guide Domain [] Domain addressing adds an additional "layer" to address designation that represents a particular network. Within that network, zones and nets can all be specified without conflict to identical zones and nets in other networks. The is the actual domain name. For example, FidoNet would be "fidonet.org" and Alternet would use "alternet.ftn" for the designator. The is the abbreviated form of the domain name, and is LIMITED TO EIGHT (8) CHARACTERS. This name is passed in the packet header during a session. In most cases, this will be the common name of the network, such as "fidonet" or "alternet" in our examples. Finally, the optional parameter provides the base nodelist name to associate with this domain. If not given, it defaults to the name given for the parameter. In our examples, "nodelist" would be used for FidoNet, while "anetlist" would be used for Alternet. Here are two complete examples of the use of the 'Domain' statement, one for FidoNet, one for Alternet: Domain fidonet.org fidonet nodelist Domain alternet.ftn alternet anetlist NOTE: If you designate a domain in your 'Address' statement, or in your 'Key' statement, then you must also create a corresponding 'Domain' statement. NOTE: The best way to order thing in BINKLEY.CFG is: Domain statements Address statements Key statements Having them in a different order may cause strange things to happen. Please refer to the complete Domain explanation later in this reference. Downloads This tells BinkleyTerm where to place files downloaded while in Terminal Mode. The is a complete drive and path designation. This path has no effect on mail transfers made in Unattended Mode. Reference Guide - Page 12 BinkleyTerm ST 3.00 - Reference Guide DTRHigh If used, BinkleyTerm will leave the DTR (data terminal ready) line to the modem "high" whenever it is exiting. By default, BinkleyTerm takes the DTR line "low" when exiting. The use of 'DTRHigh' has no effect when doing an Alt-J shell escape which will leave DTR low. 'DTRHigh' should be used with modems that go back on-hook when DTR is lowered. EnterBBS If used, this statement will cause BinkleyTerm to send to a caller when the BBS is available, during events with a 'B' flag, indicating that BBS access is allowed. This replaces the default string "Press to enter BBS." Note that must not exceed one line. See the section "Scheduling Events" for more information on event flags. Event NOTE! Normally the 'Event' statement is used only in the event file, BINKLEY.EVT. Events should NOT be scheduled in the configuration file. This statement begins an event line. Due to the depth of this topic, it is covered in the section "Scheduling Events." ExtrnMail [] This is used in conjunction with BinkleyTerm's external mail program feature. If while waiting for a YooHoo or TSYNC (the beginning of a FidoNet mail session) BinkleyTerm receives , it will write to the disk a file named MAILBAT.BAT, and will then exit with an errorlevel of 99. Refer to the User's Guide section "External Mail Programs" for information. Note that if the [] parameter is used, BinkleyTerm will exit with an errorlevel of the value given, rather than the default value of 99. When used for an external mail program, should be relatively long, without too many repeating characters, to assure accuracy. When used with multiple BBS functionality, may be only one letter. Up to 16 "ExtrnMail" statements that each use [] may be used. Flags The directory name specified is used by BinkleyTerm to create task identification files. The filename is TASK.# where # is the task number. These files can be used to determine if any given Binkley task is currently running. The file is created whenever Binkley has carrier present and a mail session is in progress. Reference Guide - Page 13 BinkleyTerm ST 3.00 - Reference Guide FTS_0001 When used, this statement will force BinkleyTerm to use only base FidoNet protocol (FTS-0001), effectively enabling the equivalent of the following statements: NoWaZOO, NoResync, NoSLO, NoEMSI and NoSEAlink. Used mostly for debugging and testing of FidoNet policy compliance; not for regular use. Gong Using this statement causes BinkleyTerm to sound an alarm when it successfully connects with a system it's attempting dial, or after a download has been completed. 'Gong' is only applicable in Terminal Mode. Note that 'Gong' also works when doing a manual mail poll operation in Terminal Mode (Alt-M). Hard38400 Assumes you have patched the 68901 serial chip to do 38400 bps. HardCTS Enables Iain Paton's code to always make sure CTS is low before sending anything to the RS232. Hold This specifies the complete drive and path designation for the directory that will be used as your outbound mail holding area. oMMM and/or other mail processing software places outbound mail in this area for BinkleyTerm to send to or hold for other FidoNet systems. It should be mentioned that this area should NOT contain any other files of any kind, and that the contents of the directory should NOT be manipulated by you unless you know EXACTLY what you're doing. For all practical purposes, BinkleyTerm maintains this directory for you. HoldOnUs If this is put into BINKLEY.CFG then Hold files will be sent when calling out. Can be followed by a list of nodes for which it takes effect. The nodes may use wildcards. Also a node may be preceded by a '-' (hyphen or minus sign) which indicates that this node should NOT have the effect. IKBDclock Updates the GEMDOS clock from the IKBD clock at a regular bases. This used to fix timing problems, occurring because, when using TOS 1.4 or TurboCTS, the 200Hz timer doesn't seem to get through. Reference Guide - Page 14 BinkleyTerm ST 3.00 - Reference Guide Include If used, this tells BinkleyTerm the name of a file to include while reading the configuration file. The include file must contain additional configuration file statements in the same format as expected for the primary configuration file. When end-of-file is reached, BinkleyTerm will continue reading the main configuration file at the line immediately following the "Include" statement that initially caused BinkleyTerm to branch. The may optionally include a drive and path designation. Example: C:\BT\INCL_2.CFG Init BinkleyTerm sends the to the modem to initialize it, and make it ready for communication. The string is sent to the modem verbatim, with the exception of special dial translation characters. These characters are shown in the section "Dial Translations." Refer to your modem instruction manual for help in finding a correct init string for your particular modem and configuration. JanusBaud JanusOK Controls whether Janus bidirectional protocol will be used during WaZOO sessions. Please refer to the complete Janus explanation later in this document. Key [#alias] [%prefix/phone] [!password] address Parameters in [] are optional, but there should be at least one of them! The phone number will override any other number (e.g. from Address statement or the nodelist). The format of the %prefix/phone is either: prefix/ e.g. %ATB1&G2DT/ prefix/phone e.g. %ATB1&G2DT/012-345-6789 phone e.g. %012-345-6789 This means that you can't use the '/' character in the prefix string. The purpose of this statement is: - make it possible to temporarily add new nodes who you want to call that aren't in the nodelist yet without the hassle of editing nodelists. e.g. I wanted to call 2:244/470, but the number was not in the nodelist, so I added: Key %010-49-7151-61494 2:244/470 Reference Guide - Page 15 BinkleyTerm ST 3.00 - Reference Guide Binkley will display the caller's name as "binkley's Boss", but I don't think this matters. - To add special modem command prefixes to certain nodes. For example you might want to force a particular type of connection or change the guard tone settings for some nodes. - For points to call other systems without having to set up a separate Address or have a nodelist. If an #alias is used that hasn't been defined, then a warning will be displayed and the KEY ignored! Most people should have no use for the <#alias> part of a KEY statement as Binkley will automatically assume the correct alias depending on zone and domain information. KnownAbout This tells BinkleyTerm the name of the ABOUT file, a special file used with incoming file requests. is a complete drive, path and filename designation. This ABOUT file applies only to file requests that are received from "known" systems. Refer to the User's Guide sections "File Requests" and "Security - Controlling File Requests" for more information. KnownAvail This designates the name of the file to be sent to a "known" remote system which file requests "FILES" from you. The identifies the file, and may contain an optional drive and path designation. Refer to the User's Guide sections "File Requests" and "Security -Controlling File Requests" for more information. KnownInbound Used with secured inbound areas, this statement designates the path to the inbound file area used for mail received from "known" systems. Refer to the User's Guide section "Security - Secured Inbound File Areas" for more information. KnownMaxBytes See 'MaxBytes' for information. KnownMaxTime