Amiga Elysian Archive

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

/ Amiga Elysian Archive / AmigaElysianArchive.iso / comm / tempest.lha / arexx.doc next >

Wrap

Text File | 1993-05-19 | 43KB | 888 lines

The "Official" AREXX Documentation for Tempest BBS PLEASE NOTE: These commands and Documentation have been done by Rick Rumer (The Technician) and BUG REPORTS should be directed to me, either on NiteFall BBS {FAST!} or on Alpha-Waves {I logon once a month or so...} See the NiteFall BBS ad at the bottom for details... Since I've added so many commands, this will be very confusing at first. I'm not even 100% sure how to write these docs up... If anyone else feels they can do better, have at it!! Please pardon the typos!!! As of 2-16-92, there are 204 commands !!! (+/- 10 : They've changed as I wrote these docs...) Chapter 1 (tm,c)XenoLink Emulation : Since I happened to have this text file, this was largeley the basis for the new commands. Generally, they are all in here, with several differences which will be mentioned in the actual command parameter section... The GETVAR # & SETVAR # routines do NOT MATCH the current ones I've used, so you will have to edit XenoLink scripts manually to reflect the appropriate command #. (tm,c)Paragon Emulation : Only the original ones Tim had in are avaliable for Emulation. If you have a list of commands (NOT an actual AREXX script) that can be added in, please send it to me and I'll do my best to get it all in there... (tm,c)C-Net Emulation : Only the original ones Tim had in are avaliable for Emulation. If you have a list of commands (NOT an actual AREXX script) that can be added in, please send it to me and I'll do my best to get it all in there... (tm,c)BBS-PC! Emulation : To my knowledge, it doesn't support AREXX, so no emulation has been done... (Duh!) (tm,c)Ami-Express Emulation : TBA -- A list is on it's way.... (tm,c)Dialog Emulation : TBA -- A list is on it's way.... Chapter 2 -- Using AREXX with Tempest OK, if you've written in AREXX before, AND know how to use it for Tempest V1.4T and newer, you can skip this section. Otherwise, you may want to examine this section, even if it's only for review purposes. This header will begin ALL AREXX programs you write for Tempest, and will probably need to be changed if you're converting a program from another BBS system. ------- cut here --------- cut here --------- cut here --------- cut here ARG BBS_NODE options results Address value 'TempRexx-'BBS_NODE ------- cut here --------- cut here --------- cut here --------- cut here Here is a line-by-line explanation of this code segment. "ARG BBS_NODE" This automatically picks up the NODE number that the user is on, and stores it into the variable BBS_NODE. This is REQUIRED, or else if two users (or the SYSOP and a user) use the program at the same time, they will collide, crashing one or both nodes, and of course, possibly GURUing! "options results" This tells the AREXX program that the BBS will be sending us data, and that our received data should be avaliable in the FIXED variable "result". (Note, that is NOT a typo! results in the options line IS plural, but the variable we get our answer in is NOT!). By a FIXED variable, I mean that you cannot change it. The BBS will put the answer into RESULT no matter what (If there IS an answer/reply). You can, of course, COPY the contents of result to another variable. for example: UserName = result "Address value 'TempRexx-'BBS_NODE" This line needs to be broken down to be best understood. the word "Address" let's AREXX know that we are going to have a fixed program (Tempest) to do our commuication with. "Value" indicates that it will be a text address, rather than a numerical one (The standard). 'TempRexx-' is PART of the actual address that your program will use. by adding the BBS_NODE after it (NO SPACES!), you turn that address into 'TempRexx-1' (for node 1) etc etc.. This allows us to have ONE program that can be used on multi-node boards, without having to have more than one copy of the program. Needless to say, if this line is omitted, the AREXX program won't know where to send/receive data, nor will the BBS, so both will be locked until either they both crash, or you reboot. Whichever one comes first! After you have the header as listed above, you are ready to continue on into the wonderful world of AREXX. The code varies so much beyond theses lines, that I won't even touch on the subject. To even attempt it would push this document well over the intended file size.... So, with this much under our belt, and a good attitude, we procede on to the Command Set. Chapter 3 -- The Command Set Command parameters Please note that YES, some commands are duplicated, and there are different formats with the same results. This is due to the imitation/emulation of the various BBS programs avaliable, and also makes it possible to use most avaliable script even in an unaltered state. As I get more lists of commands, there may be even more added, depending on the Tempest Owner's demand for it. IMPORTANT NOTE: Even though you see all these commands listed as uppercase letters, you are NOT required to do that. It makes it easier to read, but that's it. The can be all lowercase, or any mixture. When the BBS receives the code, it's done in a non-case-sensitive compare, so however you wanna do it is fine. It MUST be spelled correctly though! I can't compensate for that! There are three basic command types supported : 1) COMMAND 2) COMMAND FUNCTION 3) COMMAND FUNCTION PARAMETER The command type (option one) is a general command, that usually won't have a result returned. For example : EXIT, BufferFlush The command & function is the one that will probably be the most commonly used. It involves the command, and a function to be performed on it. An example would be : 'GetVar' '1' The command, function, and parameter will be mostly used for intercommunication with the BBS itself. An example would be : PUTVAR 1 'This is User's Name' Ok, after understanding that, I'll now attempt to explain each command, it's function, and any parameters that might be required. Command List - Alphabetical ADDPOINTS Currently not defined, and is ignored. No result returned. ADDTIME Currently not defined, and is ignored. No result returned. BBSIDENTIFY BBS|ABBEREXX|USER|TERM|ANSI This command takes one of five possible functions. The result returned will be determined as follows: BBSIDENTIFY BBS = returns the Tempest BBS (c) 1991 message BBSIDENTIFY ABBEREXX = returns the version of the BBS BBSIDENTIFY USER = returns User's Name, Location, and security level, all seperated by a space, and each item enclosed in quotes. BBSIDENTIFY TERM = Returns Baud rate they are currently at, and a simple 8N1 Full-Duplex string. BBSIDENTIFY ANSI = Returns an Integer value of 0 or 1, which indicates if they have ANSI on or off. BUFFERFLUSH Flushes any characters, commands, or garbage (line noise) from the buffer, so that the AREXX program can start clean. This ensures that accidental commands won't be entered accidentally. I recommend EVERY program use this command as their first program instruction (After setting up the address value statement, of course!). This command does not use any parameters, and any given will be ignored. It also does not return anything to the program in Result. CHECKABORT Currently not defined, and is ignored. No result returned. CHECKIO Currently not defined, and is ignored. No result returned. CLS This command stands for CLear Screen. It merely clears the screen (User's and SYSOP's) and places the cursor in the upper left corner of the screen, usually called "HOME". EXIT Tell the BBS that the arexx port does not need to be open any longer. The user will be returned to the BBS at this point. The arexx program CAN still run and do various cleanup utilities, but may NOT call on any more information from the BBS. EXITSCRIPT This command is used by Xenolink BBS, and Tempest support is only partial at this time. Under Xenolink, this command returns control to the BBS, but the arexx script is still active, so when the arexx script executes another BBS command, the user is yanked back into the Arexx script again. In the Tempest emulation of this, it merely exits back to the BBS, leaving the arexx script still running. The arexx program CANNOT get BACK to the BBS however, nor can it call anymore BBS functions, since the connection has been broken at that point. This may change in the future. Currently, 'EXIT' is the command that should be used in place of this one. GETCARRIER This command checks to verify that the user has not hungup on the BBS. If this test returns "TRUE", then the connection is ok. if it returns "FALSE" you will need to exit your program as quickly as possible, so that the BBS may reset for the next caller. results returned are "TRUE" for carrier present, and "FALSE" for no carrier. GETCHAR [string] This command does not require a parameter, but can accept one. This was to maintain compatibility with Xenolink BBS. If a paramter is present, it will be sent to the output. The routine then waits for the user to press one key, and the key pressed will be contained in Result. (This is also known as a HOTKEY function.) If the parameter is NOT present, no change will be made to the output. GETLINE NORMAL|HIDE|YESNO|NOYES [string] This routine accepts input of up to 80 characters. The options that affect the procedure on this are listed below. GETLINE NORMAL = Prints the [string] to the output, both SYSOP and user, and inputs a normal answer, which is returned in the variable result. GETLINE HIDE = Currently this is a clone of NORMAL. I could not discern any difference.... GETLINE YESNO = This prints the string, and accepts a HOTKEY answer of Y or N, defualting to Y if N was not selected. Returns the key that was pressed in Result. GETLINE NOYES = This prints the string, and accepts a HOTKEY answer of Y or N, defualting to N if Y was not selected. Returns the key that was pressed in Result. GETUSER GETUSERVAR GETVAR [Number between 1 and 62 inclusive|KEYWORD] These three commands ALL do the same thing, but are cloned for the convenience of emulating the various BBS programs. Since this command accepts two types of parameters, let me attempt to explain. To succesfully emulate Xenolink, I had to accept words, as well as numbers. This means that BOTH do the same thing, but since Xenolink's vocabulary is somewhat limited, the numbers offer more functions. The word equivelents can be used, but for Tempest programming, I recommend the numbers. The opposites of this command are PUTVAR, SETUSERVAR, and PUTUSER. PLEASE NOTE: Some of these commands are READ-ONLY, which means you can read them, but no function is avaliable to write it back out. This has been done for safety's sake. For example, you can read the name of the BBS, and the SYSOP's name, but it cannot be changed in the BBS. (The AREXX program can alter it in itself all it wants, it just won't be saved to the BBS....) Please be patient here, as there are approximately 80 variations of this command! The WORD commands : Alphabetical Order BYTERATIO User's Byte Ratio (xx/1) Returns ratio. BYTESDOWNLOADED User's Bytes Downloaded from the system. BYTESDOWNLOADEDTODAY User's Bytes Downloaded TODAY. BYTESUPLOADEDTODAY Amount User has uploaded TODAY CALLLIMITPERDAY How many calls the user can make to the BBS in a 24 hour period. CALLS How many times the user has called the BBS since they joined it. CALLSTODAY How many times the user has called today. COMPUTERNAME The name of the Computer System the User entered at the time they filled out the application. COMPUTERNUMBER Only included for Xenolink compatibility. currently returns "0". DATATELEPHONE Returns the phone number the User entered at the time they filled out the application. DOWNLOADBYTES Total Bytes the User has Downloaded. DOWNLOADS Quantity of files the user has downloaded. FIDOCREDIT For Xenolink compatibility. Returns "Not Implemented". FILESDOWNLOADEDTODAY How many files the user has d/l today. FILERATIO The User's File ratio. ILLEGALLOGINS Same as Password Failures. Useful for Hacking detection. Returns the number of logon attempts since the last valid one. LOCATION Where the user is from. (Can include spaces and commas!) MAXBYTESPERDAY Maximum (in bytes) that the user can download in any one 24 hour period. MAXMSGSPERDAY How many messages the user is allowed to post in one 24 hour period. MESSAGES How many messages the user has posted since they joined the BBS. MSGSWRITTENTODAY How many messages the user has written today. NAME (duh!) The User's Handle or Name. PASSWORD User's Password. (We're having fun now!) PRIVILEGE Same as Security Level. Included for Compatibility with Xenolink. TIMELIMIT Maximum time a user is allowed online in any given 24 hour period UPLOADBYTES How much the user has uploaded to the system, in bytes. UPLOADS How many files the user has uploaded. VOICETELEPHONE Returns the phone number the User entered at the time they filled out the application. The Numerical commands : Sequential Order Please note that GETUSER, GETUSERVAR, and GETVAR can be used interchangedly, but since GETVAR is faster to type, I'll be using it for my examples. OK? If not, type it yerself... He he he GETVAR 1 The User's Name or alias or handle. GETVAR 2 The User's REAL Name (If used on your BBS) GETVAR 3 The User's Password. GETVAR 4 The User's Location. Some people use "Group" names here, in which case that would be the result. GETVAR 5 The User's Phone Number. GETVAR 6 The User's Computer Type. GETVAR 7 The User's Message Base Flags. This will be returned in the form of s string EXACTLY 40 characters. In each slot will be a "Y" or a "N". These represent access (or no access) to a particular area. Example: |GETVAR 7 |flags=result |message "flags are: "flags" !" Which would print : flags are : YNYNYNYNYNYNYNYNYNYNYNYNYNYNYNYNYNYNYNYN Each Y represents an area that permits access, and an N signifies no access. GETVAR 8 The User's FileBase flags. Same as GETVAR 7 except it applies to the user's filebase access. GETVAR 9 User's Global Flags. These represent various options that are listed in the setupBBS. When doing the account editing, and selecting "o" for options, these are the same ones, in the same order. They are a series of Y's and N's, just like the msg & filebase flags. GETVAR 10 This is for SYSOP's only! This is a comment string, and can contain what you want it too. I personally use it to keep track of User's Birthdays. This cannot exceed 38 characters! It should NEVER be printed to the user, and is ONLY useful in application programs intended for SYSOP only use. GETVAR 11 The User's "Slot Number", or Account Number. This is the same number that they can use to logon with. GETVAR 12 The User's File Ratio. A "0" represents disabled. GETVAR 13 The User's Byte Ratio. A "0" represents disabled. GETVAR 14 The type of ratio a user has. (Byte, File, or Both, represented as a number. I don't know which is which right now....Sorry!) GETVAR 15 UNUSED - For Future expansion. Results unreliable. GETVAR 16 The User's Security level. 0-255 Usually. Default security level for a new user is 10. GETVAR 17 The quantity of Uploads the user has made to the system. GETVAR 18 The quantity of Downloads the user has made to the system. GETVAR 19 The bytes the user has uploaded today, if any. GETVAR 20 The bytes the user has downloaded today, if any. GETVAR 21 The Message Area that the user will rejoin. (If enabled by the sysop.) GETVAR 22 The File Area that the user will rejoin. (If enabled by the sysop.) GETVAR 23 The amount of messages sent by the user today. GETVAR 24 How many failed password attempts they've had since their last valid call. GETVAR 25 New User Flag. Normally, this will only be a 1 if they have not had their account edited yet. A normal user would have a 0 here, indicating a validated user. GETVAR 26 Preserve account. As of U-11, this is not active, but it should be soon. When set to 0, it has been determined that it is a normal account, and can be deleted if neccessary. If set to a 1, utilities such as The professor's "Lamer Exterminator" will NOT delete the account, regardless of status. GETVAR 27 TimeBank. Contains the minutes a user has stored in the timebank. Note that this is ONLY useful to SYSOP's running my TimeVault Utility. This can be used for other things by SYSOPS who don't wish to run this utility, but be SURE to warn the potential SYSOP that this is being done! Otherwise chaos would prevail!!! GETVAR 28 The number of bytes downloaded since the account became active. GETVAR 29 The number of bytes uploaded since the account became active. GETVAR 30 The User's Daily Download Limit, in bytes. GETVAR 31 The User's Daily Upload Limit, in bytes. GETVAR 32 The amount of uploads today, in bytes. GETVAR 33 The amount of downloads today, in bytes. GETVAR 34 The amount of time the user can be online per 24 hour period. (Time limit) GETVAR 35 The name of the BBS SYSTEM... example: NiteFall BBS GETVAR 36 The Name of the SYSOP. example: The Technician GETVAR 37 The BBS's Telephone Number, if any was entered. GETVAR 38 UNUSED - For Future expansion. Results unreliable. GETVAR 39 UNUSED - For Future expansion. Results unreliable. GETVAR 40 How many calls the BBS has received today. GETVAR 41 How many callers at 300 baud today. GETVAR 42 How many callers at 1200 baud today. GETVAR 43 How many callers at 2400 baud today. GETVAR 44 How many callers at 4800 baud today. GETVAR 45 How many callers at 9600 baud today. GETVAR 46 Aborted downloads to the system today. Not active as of U-11. Should be soon. GETVAR 47 Aborted uploads to the system today. Not active as of U-11. Should be soon. GETVAR 48 Uploads that have been resumed today. Not active as of U-11. Should be soon. GETVAR 49 Downloads that have been resumed today. Not active as of U-11. Should be soon. GETVAR 50 Maximum number of users allowed on the system. GETVAR 51 How many minutes the BBS has been in use today. (NOTE: it does NOT tell you how many minutes the bbs has been online, just the amount USED!) GETVAR 52 How many uploads the system has received today. GETVAR 53 How many downloads the system has received today. GETVAR 54 How many private messages have been sent to the sysop today. (Feedback) GETVAR 55 New Users today. How many users have attempted to fill out applications. (Counts users that drop carrier, and those who choose not to register.) GETVAR 56 How many public messages have been written today. GETVAR 57 How many FILES (F-Mail) have been sent to the sysop. GETVAR 58 Total number of calls the BBS has received since beginning operations. GETVAR 59 Number of bytes downloaded today. GETVAR 60 Number of bytes uploaded today. GETVAR 61 How many minutes the last caller was online. GETVAR 62 Name of the last caller. INPUT [characters<80] Accepts an input string from the user, with a maximum of 80 characters. The user will not be allowed to type past 80 characters, so the routine has some built in error checking. No string will be printed, even if passed to the routine. See also : PROMPT INPUTWAITING Currently not defined, and is ignored. No result returned. KICKOFF Force a user's premature logoff. Sends the BBS the same code as the sysop hitting "F4", for Force Logoff. Accepts no parameters. returns nothing. LOGENTRY [string] This will write the string [string] to the SYSOP's callerslog file. the function returns nothing. MAYGETCHAR Currently not defined, and is ignored. No result returned. MENUSET Currently not defined, and is ignored. No result returned. MESSAGE [string] print a line of formatted or unformatted text, and places a carriage return at the end of the string. Nothing is returned. MSG [string] This function performs the same as 'MESSAGE', but does NOT append a carriage return on the end. the cursor remains at the last character. This function returns nothing. NEWLINE This command ONLY prints a carriage return AND a linefeed. NO parameters are accepted, and returns nothing. OUTTEXT [string] see MSG; Included for emulation with Xenolink. PROMPT [string] This performs much as the INPUT command, but also prints a string to the output first. example: PROMPT "Do you want me to delete your Hard Drive? [YES/NO] " It will then wait until the user enters a response (up to 80 characters) and then return the answer in result. Obviously this is a bad example, but you get the idea... ;-) PUTUSER PUTVAR SETUSERVAR [Number between 1 and 62 inclusive|KEYWORD] [VALUE] These three commands ALL do the same thing, but are cloned for the convenience of emulating the various BBS programs. Since this command accepts two types of parameters, let me attempt to explain. To succesfully emulate Xenolink, I had to accept words, as well as numbers. This means that BOTH do the same thing, but since Xenolink's vocabulary is somewhat limited, the numbers offer more functions. The word equivelents can be used, but for Tempest programming, I recommend the numbers. The opposites of this command are GETVAR, GETUSERVAR, and GETUSER. PLEASE NOTE: Some of these commands are READ-ONLY, which means you can read them, but no function is avaliable to write it back out. This has been done for safety's sake. For example, you can read the name of the BBS, and the SYSOP's name, but it cannot be changed in the BBS. (The AREXX program can alter it in itself all it wants, it just won't be saved to the BBS....) PLEASE NOTE: ALL of these commands return a value to result. The command returned will be noted after the description of the command. Please be patient here, as there are approximately 80 variations of this command! The WORD commands : Alphabetical Order BYTERATIO User's Byte Ratio (xx/1). Accepts NUMERICAL input only. Anything else will be written as a ZERO. returns "OK13", since 13 is the numerical equivelent, if things went ok. BYTESDOWNLOADED User's Bytes Downloaded from the system. Returns "OK28" if things went ok. BYTESDOWNLOADEDTODAY User's Bytes Downloaded TODAY. Returns "OK33" if things went ok. BYTESUPLOADEDTODAY Amount User has uploaded TODAY. Returns "OK32" if things went ok. CALLLIMITPERDAY How many calls the user can make to the BBS in a 24 hour period. Returns "OK" if things went as planned. This feature is NOT found in the numerical listing. CALLS How many times the user has called the BBS since they joined it. Returns "OK" if everything went ok. this feature is NOT found in the numberical listing. CALLSTODAY How many times the user has called today. Returns "OK" if all went well. This feature is NOT found in the numerical listing. COMPUTERNAME The name of the Computer System the User entered at the time they filled out the application. This function returns "OK06" if it went ok. COMPUTERNUMBER Only included for Xenolink compatibility. currently returns "1". No effect is made on anything, and no further information is saved into any accounts. It's here for compatibility ONLY. DATATELEPHONE Returns the phone number the User entered at the time they filled out the application. Even though it's labelled data, generally in Tempest, unless it's a sysop, the number will be voice. This call returns "OK05" if all is well. DOWNLOADBYTES Total Bytes the User has Downloaded. Returns "OK28" if it worked. DOWNLOADS Quantity of files the user has downloaded. Returns "OK18" if the data was ok. FIDOCREDIT For Xenolink compatibility. Returns "Not Implemented". FILESDOWNLOADEDTODAY How many files the user has d/l today. Returns "OK20" when completed. FILERATIO The User's File ratio. Returns "OK12" if all went ok. ILLEGALLOGINS Same as Password Failures. Useful for Hacking detection. Returns the number of logon attempts since the last valid one. Should be no reason to write to this variable, but it's avaliable for Xenolink compatibility. Returns "OK24" if all is ok. LOCATION Where the user is from. (Can include spaces and commas!) Make sure when writing this variable that you DOUBLE QUOTE the entire string, since usually it will contain commas, which AREXX interprets as a delimiter! Returns "OK04" if all is well. MAXBYTESPERDAY Maximum (in bytes) that the user can download in any one 24 hour period. Returns "OK30" if all went well. MAXMSGSPERDAY How many messages the user is allowed to post in one 24 hour period. Returns "OK" if it was completed. This function is NOT avaliable in the numeric listing. MESSAGES How many messages the user has posted since they joined the BBS. Returns "OK" if the option was set well. This function is NOT avaliable in the numerical listing. MSGSWRITTENTODAY How many messages the user has written today. Returns "OK23" after writing. NAME (duh!) The User's Handle or Name. Limited to 30 characters. Returns "OK01" if all is ok. PASSWORD User's Password. (We're having fun now!) Returns "OK03" if it was changed ok. PRIVILEGE Same as Security Level. Included for Compatibility with Xenolink. Return "OK16" if it worked out ok. TIMELIMIT Maximum time a user is allowed online in any given 24 hour period. Returns "OK34" if the function went well. UPLOADBYTES How much the user has uploaded to the system, in bytes. Returns "OK29" if it works well. UPLOADS How many files the user has uploaded. Returns "OK17" when it works. (Sorry, getting tired of typing what it returns. It works fine...) VOICETELEPHONE Returns the phone number the User entered at the time they filled out the application. Returns "OK05". The Numerical commands : Sequential Order Please note that PUTUSER, SETUSERVAR, and PUTVAR can be used interchangedly, but since PUTVAR is faster to type, I'll be using it for my examples. OK? If not, type it yerself... He he he PUTVAR 1 The User's Name or alias or handle. Returns "OK01". PUTVAR 2 The User's REAL Name (If used on your BBS). Returns "OK02". PUTVAR 3 The User's Password. Returns "OK03". PUTVAR 4 The User's Location. Some people use "Group" names here, in which case that would be the result. Returns "OK04". PUTVAR 5 The User's Phone Number. Returns "OK05". PUTVAR 6 The User's Computer Type. Returns "OK06". PUTVAR 7 The User's Message Base Flags. This will be returned in the form of s string EXACTLY 40 characters. In each slot will be a "Y" or a "N". These represent access (or no access) to a particular area. Example: |PUTVAR 7 "YNYNYNYNYNYNYNYNYNYNYNYNYNYNYNYNYNYNYNYN" |status=result |if status = 'OK07' worked = OK Each Y represents an area that permits access, and an N signifies no access. Returns "OK07". PUTVAR 8 The User's FileBase flags. Same as PUTVAR 7 except it applies to the user's filebase access. Returns "OK08". PUTVAR 9 User's Global Flags. These represent various options that are listed in the setupBBS. When doing the account editing, and selecting "o" for options, these are the same ones, in the same order. They are a series of Y's and N's, just like the msg & filebase flags. Returns "OK09". PUTVAR 10 This is for SYSOP's only! This is a comment string, and can contain what you want it too. I personally use it to keep track of User's Birthdays. This cannot exceed 38 characters! It should NEVER be printed to the user, and is ONLY useful in application programs intended for SYSOP only use. Returns "OK10". PUTVAR 11 The User's "Slot Number", or Account Number. This is the same number that they can use to logon with. Returns "OK11". PUTVAR 12 The User's File Ratio. A "0" represents disabled. Returns "OK12". PUTVAR 13 The User's Byte Ratio. A "0" represents disabled. Returns "OK13". PUTVAR 14 The type of ratio a user has. (Byte, File, or Both, represented as a number. I don't know which is which right now....Sorry!) Returns "OK14". PUTVAR 15 UNUSED - For Future expansion. Results unreliable. PUTVAR 16 The User's Security level. 0-255 Usually. Default security level for a new user is 10. Returns "OK16". PUTVAR 17 The quantity of Uploads the user has made to the system. Returns "OK17". PUTVAR 18 The quantity of Downloads the user has made to the system. Returns "OK18". PUTVAR 19 The bytes the user has uploaded today, if any. Returns "OK19". PUTVAR 20 The bytes the user has downloaded today, if any. Returns "OK20". PUTVAR 21 The Message Area that the user will rejoin. (If enabled by the sysop.) Returns "OK21". PUTVAR 22 The File Area that the user will rejoin. (If enabled by the sysop.) Returns "OK22". PUTVAR 23 The amount of messages sent by the user today. Returns "OK23". PUTVAR 24 How many failed password attempts they've had since their last valid call. Returns "OK24". PUTVAR 25 New User Flag. Normally, this will only be a 1 if they have not had their account edited yet. A normal user would have a 0 here, indicating a validated user. Returns "OK25". PUTVAR 26 Preserve account. As of U-11, this is not active, but it should be soon. When set to 0, it has been determined that it is a normal account, and can be deleted if neccessary. If set to a 1, utilities such as The professor's "Lamer Exterminator" will NOT delete the account, regardless of status. Returns "OK26". PUTVAR 27 TimeBank. Contains the minutes a user has stored in the timebank. Note that this is ONLY useful to SYSOP's running my TimeVault Utility. This can be used for other things by SYSOPS who don't wish to run this utility, but be SURE to warn the potential SYSOP that this is being done! Otherwise chaos would prevail!!! Returns "OK27". PUTVAR 28 The number of bytes downloaded since the account became active. Returns "OK28". PUTVAR 29 The number of bytes uploaded since the account became active. Returns "OK29". PUTVAR 30 The User's Daily Download Limit, in bytes. Returns "OK30". PUTVAR 31 The User's Daily Upload Limit, in bytes. Returns "OK31". PUTVAR 32 The amount of uploads today, in bytes. Returns "OK32". PUTVAR 33 The amount of downloads today, in bytes. Returns "OK33". PUTVAR 34 The amount of time the user can be online per 24 hour period. (Time limit) Returns "OK34". PUTVAR 35 The name of the BBS SYSTEM... example: NiteFall BBS Returns "OK35". PUTVAR 36 The Name of the SYSOP. example: The Technician Returns "OK36". PUTVAR 37 The BBS's Telephone Number, if any was entered. Returns "OK37". PUTVAR 38 UNUSED - For Future expansion. Results unreliable. PUTVAR 39 UNUSED - For Future expansion. Results unreliable. PUTVAR 40 How many calls the BBS has received today. Returns "OK40". PUTVAR 41 How many callers at 300 baud today. Returns "OK41". PUTVAR 42 How many callers at 1200 baud today. Returns "OK42". PUTVAR 43 How many callers at 2400 baud today. Returns "OK43". PUTVAR 44 How many callers at 4800 baud today. Returns "OK44". PUTVAR 45 How many callers at 9600 baud today. Returns "OK45". PUTVAR 46 Aborted downloads to the system today. Not active as of U-11. Should be soon. Returns "OK46". PUTVAR 47 Aborted uploads to the system today. Not active as of U-11. Should be soon. Returns "OK47". PUTVAR 48 Uploads that have been resumed today. Not active as of U-11. Should be soon. Returns "OK48". PUTVAR 49 Downloads that have been resumed today. Not active as of U-11. Should be soon. Returns "OK49". PUTVAR 50 Maximum number of users allowed on the system. Returns "OK50". PUTVAR 51 How many minutes the BBS has been in use today. (NOTE: it does NOT tell you how many minutes the bbs has been online, just the amount USED!) Returns "OK51". PUTVAR 52 How many uploads the system has received today. Returns "OK52". PUTVAR 53 How many downloads the system has received today. Returns "OK53". PUTVAR 54 How many private messages have been sent to the sysop today. (Feedback) Returns "OK54". PUTVAR 55 New Users today. How many users have attempted to fill out applications. (Counts users that drop carrier, and those who choose not to register.) Returns "OK55". PUTVAR 56 How many public messages have been written today. Returns "OK56". PUTVAR 57 How many FILES (F-Mail) have been sent to the sysop. Returns "OK57". PUTVAR 58 Total number of calls the BBS has received since beginning operations. Returns "OK58". PUTVAR 59 Number of bytes downloaded today. Returns "OK59". PUTVAR 60 Number of bytes uploaded today. Returns "OK60". PUTVAR 61 How many minutes the last caller was online. Returns "OK61". PUTVAR 62 Name of the last caller. Returns "OK62". QUERY [string] See INPUT; Operation is identical. SENDFILE [path:Filename] Print a file from disk to the screen. Great for viewing ANSI files on the BBS, since it ignores what Tempest's "R"ead command considers "binary" code. Also useful for showing scripts, startup-sequences, etc to other sysops, or perhaps even program code (right Tim? He he) SENDSTRING [string] Prints the formatted or unformatted [string]. NO carriage return OR linefeed is added. Useful for data positioning. Same as MSG and OUTTEXT. SETNODESTATUS Currently not defined, and is ignored. No result returned. SETUSERVAR [parameter to alter] [altering value] This is a clone of PUTUSER and PUTVAR. See those for function and paramter settings. SYSOPLOG See LOGENTRY; Included for Xenolink compatibility. TIMEREMAINING Currently not defined, and is ignored. No result returned. TRANSMIT See MESSAGE; Inlcuded for compatibility with emulation routines. Well, if you read this from the top all the way to the bottom, let's see some GREAT utilities, features, or games! Now there isn't ANY reason not to do it! If this isn't enough data for you to play with, I don't know what is! As long as Tim wishes, and as long as I have an Amiga (or two ;-) ) I'll keep updating these DOCS and the code as neccessary to help keep Tempest on top! Advertisement follows : __ __ _ / \ _ _ /_/__/ )_ __/ /\/ / ) / ) ____ _ /_ _ /____ /_ _/____ / / / / / _ ) / ) / / / _ ) / / / _ ) / / / / / // /_/ /_ / /__/ (__/_/ /_/ // /_/ /_/ /_ /_//___/___//____/______/___/___\__/___/___/ __ __ / / / / / /_ / /_ ______ / _ ) / _ ) / ____/ / // /_/ // /___\ \ /______/___________/ -sk- Featuring the BEST of the Public Domain! This file happily presented to you from those of us on NiteFall BBS! (515) 277-1320 (Des Moines, IA) 602 Megs! 2400 - 19.200 Baud USR HST DUAL STANDARD MODEM (300-1200 Message access only) 24 hrs, 7 days a week Tempest BBS software AND a Tempest support site! SUPPORTING THE NEW MNP-5 MODEMS! CALL NOW!!!! Access first call! The Technician If you got a busy signal before, try again NOW! NiteFall has undergone many changes to allow more users on ! Soon to be expanding to MULTI-NODE !!!! Keeping up with the times.... *********** Comment, disclaimer ******** (tm,c) TradeMarks , Copyrights: All Programs mentioned in this file, are all copyrighted by there respective authors/company. I will give credit to the company name / Author of the above programs, but at this time I do not know there names, [sorry] but if you wish to contribute the information please call the NiteFall BBS. The arexx commands used, are semi-compatable to allow users of different BBS programs to easily exchange programs between BBS platforms, if the SYSOP desires too, Not All commands are interchangable, but ones we feel will allow enough flexibilty to the SYSOP so he/she may run a bbs system the way they want to run it.