ÚÂÄÄ¿ ÂÂÄÄ¿ ÚÂÄÄ¿ ÚÄÂÂÄ¿ ÚÂÄÄ¿ ÚÄÂÂÄ¿ ÚÂÄÄ¿ ³³ ³ ³³ ³³ ³ ³³ ³³ ³³ ³ ³³ ³³ Version 4.01B ³³ ³ ÀÁÄ¿ ³ÃÄÂÙ ÀÁÄ¿ ³³ ³ÃÄÄ´ ³³ ÀÁÄ¿ ³³ ³ ³³ ³³ ³ ³³ ³³ ³³ ³ ³³ ³³ 7/2/95 ÀÁÄÄÙ ÀÄÄÁÙ ÁÁ ÁÄ ÀÄÄÁÙ ÁÁ ÁÁ Á ÁÁ ÀÄÄÁÙ Report Generator Module ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ This document covers the command-line parameters and operation of the USRSTAT2.EXE report generator module. If you are using this module in conjunction with the STPCB, STGEN, or FTT programs, you DO NOT need to concern yourself with this information, as all parameter passing is fully automatic. This information WILL be needed if you wish to use this module with your communication software's scripting language, or as part of a custom software program of your own. ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ The USRSTAT2.EXE program is the heart of all of the USRSTATS utilities. Its only function is to convert a capture file of the modem's ATIx diagnostic screens into a formatted report. It does not do any of the work to get this data from the modem! Retrieving the data from the modem and saving it in a file is a function of the STPCB, STGEN, and FTT programs, or of the comm program script file that you create. The host program will then "shell" to USRSTAT2.EXE with the proper command- line options. USRSTAT2.EXE reads the input file that is passed to it, and creates the formatted report in the specified filename. Control is then returned to the host program, which is responsible for displaying the report on the screen, saving it in a message, etc. ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ The complete USRSTAT2.EXE Command Syntax is: USRSTAT2 [] [/A] [/Mx] [/Px] [/H] ^ ^ ^ ^ ^ No spaces ^ after H For Append mode is a required parameter. This is the input filename containing all the captures of the ATIx commands. If the capture file contains snapshots from several different sessions, ONLY the LAST valid set of captures within the file will be used to generate the report. This means that you are not required to delete the input data, although allowing many capture sessions to accumulate will cause gradually slower performance of the report generator. It is therefore recommended to delete the capture file when finished, or always open the capture file in over-write mode, rather than append mode. is a required parameter. This is the output filename for the report that will be generated. The parameter is used to tell the program to operate in BBS mode or in 'caller' mode. This field is (sort-of) optional. If you do *NOT* pass a value, and if the input file includes the ATI4 data, the "Caller Number" field of the report will be replaced by the LAST DIALED PHONE NUMBER. If you *DO* pass a value, the program operates in BBS mode, meaning that the "LAST DIALED NUMBER" is *not* displayed. (Wouldn't mean anything anyway, would it?) Instead, the current Caller Number (as passed on the command line) is added to the report. This makes it easier to later cross-reference the report with the BBS caller logs, should the need arise. Note that you *can* pass it a Caller Number of "0" to FORCE it into BBS mode. (You would need to do this if your BBS software does not support a "Caller Number", otherwise USRSTAT2.EXE will run in 'caller' mode, not BBS mode!) If the /A option is present on the command line, the will be opened in APPEND mode, rather than OVERWRITE mode. This allows you to keep a continuous record of all your reports in one file. Obviously, you would not want to use this option when installing on a BBS, it's intended for 'caller' mode. The /Mx option controls the video mode of the output file, where x is one of the following values: 1 = Pcboard color 2 = Wildcat! color 3 = ANSI color 4 = AVATAR color 5 = Reserved for future use 6 = 8-bit PC monochrome 7 = 7-bit ASCII monochrome Modes 1-4 will use the appropriate method of changing colors, and will color-code various parts of the report in green, yellow, and red. If no /Mx option is present on the command line, a value of 6 is assumed. The /Px option controls the type of "Pause" prompt placed between sections of the report, where x is one of the following values: 1 = PCBoard (@MORE@) 2 = Wildcat! (@PAUSE@) 3 = STGEN (MORE:) 4 = User-defined, via STPAUSE environment variable. If no /Px option is present on the command line, the output file will have no pause prompting between pages. To use /P4, first set the environment variable with the desired string, as in this example: SET STPAUSE=Press a key... The /H option may be used to include a header at the top of the report. This could be used to indicate the name of the BBS or service you just dialed. In this manner, stand-alone mode reports *can* include both the name and phone number of the host system that is being reported on. This makes for a VERY complete and accurate report. *The /H option, if used, must be the LAST option on the command line.* Assuming a command line like this: USRSTAT2 test.in test.out /HCall the Majestik Moose You'll get an output report that looks like this on the top line: Connection Summary: CALL THE MAJESTIK MOOSE ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ That is the extent of the command-line options. There are only a few, but they are important, so please understand them fully before proceeding. ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ [END]