home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 15 / CD_ASCQ_15_070894.iso / vrac / st234b.zip / USRSTATS.DOC < prev    next >
Text File  |  1994-05-22  |  18KB  |  404 lines
  1.  
  2.                                     5-22-94
  3.  
  4.                            USRSTATS Version 2.34 BETA
  5.                            ==========================
  6.  
  7.                              PLEASE READ CAREFULLY
  8.                     THIS IS A BETA VERSION OF THIS SOFTWARE.
  9.  
  10.            ---------------------------------------------------------
  11.     To install this update, simply copy the .EXE and .PPE files over the
  12.     old versions, and read the following "New features" section.
  13.            ---------------------------------------------------------
  14.  
  15.                          *****NEW IN VERSION 2.34*****
  16.  
  17.                  This really is the LAST Beta of V2.x!  <grin>
  18.  
  19.     This version adds several new features to command-line mode.  BBS
  20.     operation is not changed.
  21.  
  22.     Command Syntax of the new version is:
  23.  
  24.     USRSTAT2 <infile> <outfile> [<callernum>] [/A] [/H<your header info>]
  25.  
  26.                                                ^      ^
  27.                                                ^      ^
  28.                                                ^      No spaces after H!
  29.                                                ^
  30.                                                For Append mode
  31.  
  32.     Here's the details on the new options.
  33.  
  34.     New feature #1:
  35.  
  36.     IF the I4 data is present in the input file
  37.  
  38.     AND you do not pass a caller number (meaning its not in "BBS mode")
  39.  
  40.     THEN the "Caller:" field in the report will be replaced with the Last
  41.     Dialed Number as extracted from the I4 screen.
  42.  
  43.     OTHERWISE  it's the same as before.  ("BBS mode" is not changed at all.)
  44.  
  45.     This way, the report will contain the number you dialed to make the
  46.     connection in the first place.  Simplifies record-keeping.
  47.  
  48.     New feature #2:
  49.  
  50.     IF a /H parameter is specified
  51.  
  52.     AND you do not pass a caller number (meaning its not in "BBS mode")
  53.  
  54.     THEN  Whatever text you supply after the /H (and NO SPACES AFTER THE
  55.     "H" PLEASE) will be written to the top of the report.
  56.  
  57.     Assuming a command line like this:
  58.     USRSTAT2 test.in test.out /HCall the Majestik Moose
  59.  
  60.     You'll get an output report that looks like this on the top line:
  61.  
  62.     Connection Summary: CALL THE MAJESTIK MOOSE
  63.     ┌─────────────────────────────────────────────────────
  64.  
  65.     OTHERWISE  it's the same as before.  ("BBS mode" is not changed at all.)
  66.  
  67.  
  68.     The idea is that you use a macro in your comm program to do all of this,
  69.     and you pass the BBS name you are currently calling via the /H option.
  70.     Then, the report will have the BBS name stuck right there on the top
  71.     line, simplifying your record-keeping even further.  This complements
  72.     New Feature #1, explained above.
  73.  
  74.     New Feature #3:
  75.  
  76.     IF the /A option is present on the command line, the <outputfile> will
  77.     be opened in APPEND mode, rather than OVERWRITE mode.  This allows you
  78.     to keep a huge "rolling" record of all your reports in one file.
  79.  
  80.     New feature #4:
  81.  
  82.     If it is NOT a V.FC connection, the Transmit Level will be replaced
  83.     with ?? and the Line Probe info will be blanked out.  The modem
  84.     doesn't report valid data for those items except under V.FC.  It does
  85.     appear that the Receive Level is correct, so that is left alone.
  86.  
  87.                          *****NEW IN VERSION 2.33*****
  88.  
  89.     USRSTATS is not just for Sysops any more!   This version now supports
  90.     operation from the DOS command line, to allow all users the ability to
  91.     generate stand-alone report files similar to the one seen in on-line
  92.     mode.
  93.  
  94.     Use the capture buffer function in your comm software to create a file
  95.     containing the output of the I6, I7, I11, Y11, and (optionally) I4
  96.     commands while in online command mode.  You get into online command
  97.     mode by issuing the +++ escape sequence, and you must have DIP switch 9
  98.     DOWN.  After issuing the commands, close the capture buffer and return
  99.     to data mode with an ATO command.
  100.  
  101.     After you've captured the data, feed it into the USRSTAT2.EXE program
  102.     in the following manner:
  103.  
  104.     USRSTAT2 <inputfile> <outputfile>
  105.  
  106.     Where inputfile is the name of the buffer capture you created in the
  107.     above step, and outputfile is any filename you choose.  If the output
  108.     file already exists, it will be overwritten, unless the /A option is
  109.     used.
  110.  
  111.     The output file will then contain your report, ready for viewing,
  112.     editing, or whatever it is you want to do with it.  <G>
  113.  
  114.     Note to DOOR software authors:
  115.  
  116.     With this release, and the new command-line operation, I suspect that
  117.     some USRSTATS "clones" will begin appearing, making use of the command
  118.     line mode.   Here's a little tip for you:  Call the USRSTAT2.EXE
  119.     program with the added parameter shown below:
  120.  
  121.     USRSTAT2 <inputfile> <outputfile> <callernumber>
  122.  
  123.     The inclusion of the callernumber parameter will then be noted in the
  124.     report.
  125.  
  126.     One other thing, if you're going to write a clone of USRSTATS for your
  127.     favorite BBS package, please be kind enough to give me credit where
  128.     due, and also upload a copy of your completed product to The Majestik
  129.     Moose BBS at 708-843-2871.  If you plan on charging a registration fee
  130.     for your version of the software, you must have my written
  131.     authorization first.  This is copyrighted software.
  132.  
  133.  
  134.                           ****NEW IN VERSION 2.31****
  135.  
  136.     In the lower left corner of the report, you will now see the Line Probe
  137.     information for V.FC connections.   This is a table of frequency
  138.     points, and the signal level at those points.  This response curve
  139.     influences the modem's selection of carrier frequency and symbol rates,
  140.     which in turn affect the overall connect rate.  The levels are
  141.     referenced from zero, so larger numbers mean a LOWER signal level.
  142.  
  143.     The config file now has a new field labeled NODE_LOCKOUT.  This field
  144.     allows control over which nodes of the system the PPE will function on.
  145.     As an example, if you had a USR modem on node 1, and a Hayes on node 2,
  146.     you would want to disable the program from running on node 2 by using a
  147.     NODE_LOCKOUT=2 in the config file.  (You could get the same effect by
  148.     using *node*-specific CMD.LST files in the PCBoard setup, but I suppose
  149.     it *is* easier to just set it up here in our config file.)  Setting
  150.     NODE_LOCKOUT=256 will allow the program to be used on all nodes, and is
  151.     the default.  The USRSTATS.CFG file *MUST* be edited to include this
  152.     new field, or the program will complain!
  153.  
  154.     The PREEMPHASIS field has been changed from a level to an index, after
  155.     discussion with engineers that know about these things.  The value
  156.     reported is an index with a value of 0 to 15.  Each value represents a
  157.     specific preemphasis value, but it's not a linear relationship.
  158.     Suffice it to say that larger values indicate greater preemphasis
  159.     levels.
  160.  
  161.      * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  162.  
  163.  
  164.     What is it?
  165.  
  166.     It's an add-on for PCBoard 15.1 or later.  It consists of a PPL program
  167.     and a small program written in QuickBasic 4.5.   The PPE is installed
  168.     in PCBoard's CMD.LST file, and effectively becomes a new command
  169.     available from the PCBoard menu prompt.   Operation is fully seamless.
  170.     It also functions in standalone mode, from the DOS command prompt. This
  171.     allows non-sysops the same powerful reporting capabilities.
  172.  
  173.  
  174.     What does it do?
  175.  
  176.     It allows your callers to dynamically view the *BBS MODEM'S* Link
  177.     Diagnostics information at any time while on-line, or their own
  178.     information while off-line.
  179.  
  180.  
  181.     Why would I want to do that?
  182.  
  183.     It is mainly intended as a troubleshooting tool.   The information
  184.     contained in the Link Diagnostics of the USR modems can reveal
  185.     important information to trained service technicians.   Until now,
  186.     your callers have never been able to view this information from *YOUR
  187.     END* of the connection, only from their own end.  Also, there are MANY
  188.     modems out there that do not report this information in any way,
  189.     leaving the caller completely in the dark when it came to poor
  190.     connections.  Now, both of those problems are solved.  At this point, I
  191.     am not going to discuss the technical details of this information, and
  192.     will instead refer you to your copy of the Owner's Manual, or to the
  193.     bookstore to buy some books on basic Data Communications testing and
  194.     troubleshooting.
  195.  
  196.  
  197.  
  198.  
  199.  
  200.     How does it work?
  201.  
  202.     The PPE program forces the modem (which must be specially configured,
  203.     see below for details) into on-line command mode, retrieves the Link
  204.     Diagnostics info, and passes it to the QB program.  The QB program
  205.     translates the info into a useable format, and generates a display
  206.     file.  Control passes back to the PPE program, which displays the file,
  207.     and performs any other needed actions (like message capture) before
  208.     returning control back to PCBoard.
  209.  
  210.  
  211.     What does it work with?
  212.  
  213.     The PPE works ONLY with PCBoard version 15.1 or later.   The PPE was
  214.     compiled with version 2.00 of the compiler, so it won't work under PCB
  215.     15.0, sorry.  The EXE program should work with anything.
  216.  
  217.     At this time there are no plans for versions for other BBS packages.
  218.     It works ONLY with the small-footprint models of the US Robotics
  219.     Courier modems.  (These are the ones that support 57.6K or higher on
  220.     the serial port.)   It won't work with the older, larger models because
  221.     they do not support the &D1 command.
  222.  
  223.     Note: Further testing has shown that the program works well with the
  224.     USR ComServer 386 and ComServer 486.
  225.  
  226.     It *IS* multi-node aware, and has been tested running under DesqView
  227.     and Netware on a multi-node commercial BBS,  and running single node
  228.     under DesqView and Lantastic.
  229.  
  230.  
  231.     How do I install it?
  232.  
  233.     FOR COMMAND-LINE USE, SKIP TO THE NEXT SECTION!
  234.  
  235.     PCBoard installation:
  236.  
  237.     Installation is very simple.  No special steps are needed for multi-
  238.     node operation.
  239.  
  240.     First, create a directory or subdirectory of your choice.  The program
  241.     requires read/write access to the directory it is installed in, to
  242.     allow creation of temporary files during execution.  Copy USRSTATS.PPE
  243.     and USRSTAT2.EXE into that directory.
  244.  
  245.  
  246.     Now, go into PCBSETUP and modify the CMD.LST files for the Main Board
  247.     and/or any conferences that you wish to be able to call the program
  248.     from.  Edit the CMD.LST file, entering the command name you wish to use
  249.     to call the program, and full path and filename of USRSTATS.PPE.
  250.  
  251.     After saving the new CMD.LST files, we need to edit the modem init
  252.     string.  The normal init string for PCBoard is "ATZ" which simply
  253.     resets the modem.  The standard modem setting of &D2 allows PCBoard to
  254.     hang up by simply dropping the DTR lead on the serial port.   For this
  255.     program to work, we need to have the modem running with &D1 instead of
  256.     &D2.   &D1 forces the modem to go into on-line command mode WITHOUT
  257.     dropping the connection whenever the DTR lead is dropped.   Now, here
  258.     are the 2 problems: The USR Courier modems do NOT store the &D setting
  259.     in NVRAM, they rely on the dip switches to set the value of &D.   The
  260.     switch allows setting &D to a value of 0 or 2, but *NOT* 1, which is
  261.     what we need.  So, we need to be creative with the modem init string to
  262.     get it into the state we want.  The second problem is more troublesome,
  263.     as there's no good work-around for it.  When the modem is running with
  264.  
  265.  
  266.     &D1, it can't be forced to drop the connection simply by dropping DTR,
  267.     it must also be sent an ATH or ATZ command.
  268.  
  269.                                 ***************
  270.  
  271.     THIS MAY OR MAY NOT BE AN ISSUE FOR YOU, DEPENDING ON ANY DOORS OR
  272.     OTHER SOFTWARE YOU MAY BE RUNNING.  YOU ARE ON YOUR OWN IN DETERMINING
  273.     WHETHER THIS WILL CAUSE ANY PROBLEMS FOR YOUR SETUP.
  274.  
  275.                                 ***************
  276.  
  277.     Remember, PCBoard only drops DTR, it doesn't send any commands to hang
  278.     up and can't be configured to do so.   But, we can be clever and let
  279.     the modem INIT string force the hang-up, so that the modem DOES go back
  280.     on-hook during the reset cycle.  (It just takes a little longer to drop
  281.     the caller.)  The trick that makes this work is that the Courier modem
  282.     drops any active connection when given an ATZ command.
  283.  
  284.     If you've followed this up till now, and haven't been scared off, edit
  285.     your init string to read:  ATZ^M~~~AT&D1
  286.  
  287.     (Of course, this assumes the modem has all the correct settings already
  288.     in NVRAM.)
  289.  
  290.     This simply sends the standard ATZ followed by a carriage return (the
  291.     ^M), then pauses 1.5 seconds (the ~~~), and then sends the &D1 command.
  292.     PCboard adds the final carriage return for you automatically, so no ^M
  293.     is needed at the end of the line.
  294.  
  295.     Please note that this causes/requires *NO* permanent re-configuring of
  296.     your modem.   The only thing changing is the PCB setup.
  297.  
  298.     The last step is setting up the configuration file.   This file MUST be
  299.     located in the same directory as the PPE file, and it MUST be named
  300.     USRSTATS.CFG.   A sample file named USRSTATS.DEF is supplied in the
  301.     distribution archive, or the program will create another one for you if
  302.     no config file is found.   All documentation for the fields in the
  303.     config file, and the program options, are contained as comments with
  304.     the sample config file itself, so I will refer you to that for more
  305.     info.  Edit and save a USRSTATS.CFG file, setting the options as
  306.     desired for your system.
  307.  
  308.     That's it, installation is complete.   Now, when your callers enter the
  309.     new command you have defined, the BBS will chug and puff for a few
  310.     seconds, then display a nicely formatted screen of modem status info.
  311.  
  312.     Please note that it doesn't work in local mode, there has to be a real
  313.     live modem connection.  (I hope that would be obvious.) <G>
  314.  
  315.  
  316.  
  317.     FOR COMMAND-LINE MODE USE:
  318.  
  319.     Simply copy the USRSTAT2.EXE program into the directory of your choice,
  320.     preferably your "Utilities" directory or other directory in the system
  321.     Path, and read the instructions in the "What's New" section of this
  322.     document.  That's it!    (Oh, and make sure your modem has DIP switch
  323.     #9 DOWN.
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.     What about support?
  333.  
  334.     Call The Majestik Moose BBS at 708-843-2871 and leave a message for the
  335.     SYSOP.   I'll help you if I can, but I make no promises.  My time is
  336.     very limited.  DO NOT call and ask for explanations of the technical
  337.     information.  Go buy a book and learn it, you'll be glad you did.  Do
  338.     NOT call and ask questions that are already answered in the docs.  You
  339.     will find me somewhat unpleasant under those circumstances.  Please DO
  340.     report any bugs or suggestions.
  341.  
  342.     The latest version of this program is always available as a free
  343.     download in the Main Board area.
  344.  
  345.     It is also available (and running) on the USRobotics BBS
  346.     at 708-982-5092.
  347.  
  348.     At the present time, there is no registration required for this
  349.     software.  If you really want to pay me a few bucks for the many hours
  350.     of effort that went into this, I'll be glad to take it from you.  Call
  351.     The Majestik Moose and leave a (C)omment.
  352.  
  353.     Standard Disclaimer:
  354.  
  355.     This is a BETA version of this software.  It has undergone only limited
  356.     testing.   Use at your own risk.    It works fine for me.  All product
  357.     names are trademarks of their respective companies.
  358.  
  359.     This software is NOT a product of USRobotics, Inc.
  360.  
  361.     ================================================================
  362.  
  363.     Joseph C. Frankiewicz
  364.     The Majestik Moose BBS
  365.     708-843-2871
  366.  
  367.     =================================================================
  368.  
  369.     History:
  370.  
  371.     Versions 1.00 - 2.10:  Internal use only, not released
  372.  
  373.     V 2.11, 4/16/94:  First public Beta release.
  374.  
  375.     V 2.12, 4/22/94:  Fixed missing SV/DSP dates in USRSTAT2, experiment
  376.                       with modem delays in USRSTATS to try to prevent it
  377.                       from happening in the first place.
  378.  
  379.     V 2.20, 4/28/94:  Added external configuration file.   Improved error
  380.                       detection and handling within USRSTATS.  Activated
  381.                       option to allow user to make messages R/O.  Activated
  382.                       option to allow user to force retrain.  Activated
  383.                       option to view modem settings.  Default modem delay
  384.                       is now 4 instead of 2.
  385.  
  386.     V 2.31, 5/8/94:   Added NODE_LOCKOUT option to the config file.  Added
  387.                       V.FC line probe data to report.  Changed Preemphasis
  388.                       from "level" to "index".
  389.  
  390.     V 2.33, 5/16/94:  Documented command-line mode.  Fixed problem with Y11
  391.                       missing fields.  This should be the final beta of the
  392.                       2.x release.
  393.  
  394.  
  395.  
  396.  
  397.  
  398.     V 2.34, 5/22/94   Added /A (append) and /H (header) options in command-
  399.                       line mode.  When in command-line mode, will extract
  400.                       the last dialed number from the I4 screen and replace
  401.                       "Caller:" field.  (Command-line mode only.) Y11 and
  402.                       xmit level are blanked for non-V.FC connections.
  403.     [end]
  404.