home *** CD-ROM | disk | FTP | other *** search
/ synchro.net / synchro.net.tar / synchro.net / modem.madness / SMMNETML / HTRAF140.ZIP / HTRAFFIC.DOC < prev    next >
Encoding:
Text File  |  1992-07-03  |  14.0 KB  |  342 lines
  1.  
  2.     Version 1.40, July 3, 1992
  3.  
  4.  
  5.        H   H  TTTTT  RRRR     A    FFFFF  FFFFF  II   CCC
  6.        H   H    T    R   R   A A   F      F      II  C   C
  7.        HHHHH    T    RRRR   A   A  FFF    FFF    II  C
  8.        H   H    T    R   R  AAAAA  F      F      II  C   C
  9.        H   H    T    R   R  A   A  F      F      II   CCC
  10.  
  11.  
  12.       RICH VERAA'S LITTLE HUDSON MESSAGEBASE TRAFFIC REPORT
  13.  
  14.                          A BIRDSOFT PROGRAM
  15.  
  16.    (C) Copyright 1991, 1992 by Richard P. Veraa. All rights reserved.
  17.        Veraa-Birdsoft Computer Products. North Miami, Florida, USA
  18.  
  19.         HTRAFFIC.EXE is a simple messagebase traffic volume report
  20.    generator for use with bulletin board systems uning the popular
  21.    Hudson messagebase. HTRAFFIC generates an individual report for each
  22.    conference area listed in AREAS.BBS, (or a restricted list that you
  23.    prepare) and tabulates each poster to that echo during the report
  24.    period in order of activity, with the number of messages posted, the
  25.    average size of messages by that author, and his/her net origin
  26.    number of origin, as well as a total number of messages and posters
  27.    for each area. You may compile reports of all traffic in an area, or
  28.    of messages entered from your board only.
  29.  
  30.    HTRAFFIC.EXE also generates a summary report listing number of
  31.    messages in all areas.
  32.  
  33.    FILES IN THIS ARCHIVE
  34.  
  35.    README.RPT - Last minute details.
  36.    HTRAFFIC.DOC - This document.
  37.    AREA.RPT - Sample area report produced by HTRAFFIC.
  38.    SUMMARY.RPT  - Sample summary report produced by HTRAFFIC.
  39.    HTRAFFIC.EXE - HTRAFFIC executable file.
  40.    HTSETUP.EXE  - HTRAFFIC Configuration program.
  41.    SETPLACE.EXE - Utility to reset the HTRAFFIC lastread pointer.
  42.    REGISTER.RPT - Registration information.
  43.    FD2AREA.EXE - Utility that generates AREAS.RPT from MESSAGES.RA
  44.  
  45.    GUARANTEE
  46.  
  47.    There is no guarantee, express or implied. This program works well on
  48.    my system and the systems on which it's been tested... Your mileage,
  49.    as the saying goes, may vary.
  50.  
  51.    USER DEVELOPED SOFTWARE
  52.  
  53.    This program is Shareware. It is NOT free, and it is NOT public
  54.    domain. You may try it out for the period of one month. If you decide
  55.    to continue to use it after that month, you should register your
  56.    copy. I'm not a professional programmer, I just program for fun. All
  57.    of what you see is done in my spare time, and the bills are paid out
  58.    of my own pocket. HTRAFFIC will not stop working after one month, or
  59.    do anything nasty, nor does the registered version have more features
  60.    than the non-registered version. (except for nicely identifying you
  61.    on the reports it generates). However, if you don't register
  62.    HTRAFFIC, I will not be able to continue to work on it and implement
  63.    new user requested features. So support shareware!
  64.  
  65.    REGISTRATION
  66.  
  67.    For information on how to register, see the file REGISTER.RPT that's in
  68.    the HTRAFFIC distribution file. When I've received your registration
  69.    form and registration fee, i will send you a registration key via
  70.    netmail or snailmail (post). HTRAFFIC will list your name and BBS
  71.    name on the reports it generates to indicate that you're using a
  72.    registered version of HTRAFFIC.
  73.  
  74.  
  75.  
  76.    INTRODUCTION
  77.  
  78.    HTRAFFIC.EXE works by reading the area tag names from the AREAS.BBS
  79.    file. (or a limited selection of these in a file called AREAS.RPT
  80.    that you create). It then searches the messagebase for messages in
  81.    that area, and looks up each poster's net address in the origin lines
  82.    of his/her messages.
  83.  
  84.    INSTRUCTIONS
  85.  
  86.       Installation
  87.  
  88.    1. Hudson Messagebase
  89.  
  90.    You must be using a BBS program like QuickBBS or RemoteAccess
  91.    that utilizes a Hudson messsgebase.. that is, you must have a
  92.    directory containing the files MSGINFO.BBS, MSGHDR.BBS and
  93.    MSGTXT.BBS.
  94.  
  95.    2. AREAS.BBS
  96.  
  97.    You also need a file called AREAS.BBS listing the message areas on
  98.    your BBS. If your setup does not use AREAS.BBS, see Appendix A of
  99.    this document for instructions on constructing one.
  100.  
  101.    If you do not want HTRAFFIC to report on ALL the message areas on
  102.    your system, you may prepare a file called AREAS.RPT. HTRAFFIC looks
  103.    for AREAS.RPT first; if it isn't there, it reads AREAS.BBS. The
  104.    easiest way to construct AREAS.RPT is to simply copy AREAS.BBS to
  105.    AREAS.RPT and then use an editor to delete the lines for the areas
  106.    you do NOT want reports on. Note that HTRAFFIC will start reading at
  107.    the THIRD line of this file.
  108.  
  109.    If you use MESSAGES.RA -- A utility program called FD2AREA.EXE is
  110.    included in the archive to create an AREAS.RPT file for HTRAFFIC.
  111.    Note that if you use MESSAGES.RA _and_ have AREAS.BBS (if, for
  112.    example, you have an XRS Door on your system), FD2AREA will not
  113.    disturb that file, and HTRAFFIC will ignore AREAS.BBS if AREAS.RPT is
  114.    present. AREAS.RPT will list message areas as they are listed in the
  115.    RACONFIG Area Manager, except that an underline will be substituted
  116.    for internal spaces. If you don't want HTRAFFIC to scan all your
  117.    areas, simply delete the lines you want to omit in AREAS.RPT. If, on
  118.    the other hand, you change areas frequently, you may wish to place
  119.    FD2AREA in your batch file ahead of HTRAFFIC, so that it always
  120.    reads the current MESSAGES.RA
  121.  
  122.    3. HTRAFFIC.EXE, SETPLACE.EXE and HTSETUP.EXE
  123.  
  124.    Place the above executable files in the same directory as MBUTIL or
  125.    whatever messagebase management utilities you run nightly. This may
  126.    be the same directory as your mailer or your BBS, depending on how
  127.    your system is set up. If (as I sincerely hope) you are registered,
  128.    place your key, TRAFFIC.KEY in this directory as well.
  129.  
  130.    4. Configure HTRAFFIC by running HTSETUP.
  131.  
  132.    Run HTSETUP from the command line and simply fill in the blanks on
  133.    the screen. You may use the up and down arrows to change fields until
  134.    all blanks are correct. Then press <F-10> to accept the displayed
  135.    information.
  136.  
  137.       Enter your name as it appears on your registration form
  138.  
  139.       Enter your BBS or point name -- or your own name. This is the name
  140.       that will appear on the reports HTRAFFIC generates. (if you are a
  141.       registered user).
  142.  
  143.       Enter your net node or point address (enclosed in parentheses).
  144.  
  145.       Enter the date of the beginning of your first report. This
  146.       defaults to today's date, but you may want to reset it from time
  147.       to time.  When you run HTRAFFIC with the "/n" switch (new data
  148.       period), this date will reset to the current date at the end of
  149.       your run, remove current data, and reset the data files. It's
  150.       recommended that you use this option weekly, or at regular
  151.       intervals, creating reports (with the "/r" switch) that cover
  152.       traffic through your system during a uniform period.
  153.  
  154.  
  155.       Enter the full path designations for the files HTRAFFIC needs to
  156.       find:
  157.  
  158.       MSGINFO.BBS MSGHDR.BBS MSGTXT.BBS   The messagebase
  159.  
  160.       AREAS.BBS                           The arealist.
  161.            or
  162.       AREAS.RPT                           abbreviated arealist.
  163.  
  164.       HTRAFFIC will ordinarily prepare reports for all areas listed in
  165.       AREAS.BBS. If you do not want to count all the areas listed, you
  166.       may make an abbreviated file of just the areas you wish to look at
  167.       -- just make a copy of AREAS.BBS named AREAS.RPT.  Delete the
  168.       lines from AREAS.RPT that you do not with reported on.  If
  169.       HTRAFFIC finds AREAS.RPT in the directory listed in the
  170.       configuration file, it will read it, otherwise, it will look at
  171.       AREAS.BBS.  NOTE: If you use FD2AREA.EXE to make an AREAS.RPT
  172.       file from MESSAGES.RA, be sure to list the directory MESSAGES.RA
  173.       is in here, and FD2AREA will place the new AREAS.RPT file there
  174.       (see Section 2).
  175.  
  176.       Enter the path designations for the directories where you wish
  177.       HTRAFFIC to place its reports and data files. The defaults place
  178.       the data files in the same directory as the messagebase and place
  179.       the individual area reports and summary reports in a subdirectory
  180.       of the mailer, but you may have them placed in any valid directory
  181.       on your system.
  182.  
  183.       If HTSETUP can not find a directory you specify (or does not find
  184.       the files it needs), it will warn you via a notice on the screen.
  185.       CAUTION -- it will, however, accept the data you key in. It's your
  186.       responsibility to create the appropriate directories and assure
  187.       the proper files are available in them.
  188.  
  189.  
  190.    5. Operation
  191.  
  192.    Running HTRAFFIC.EXE.
  193.  
  194.    Every time HTRAFFIC is run, it retreives its own data and scans the
  195.    message base for new messages in all areas.
  196.  
  197.    HTRAFFIC will also generate a summary file called SUMMARY.RPT, listing
  198.    all the areas listed in AREAS.BBS, with the total number of messages
  199.    posted in each.
  200.  
  201.    6. Command line switches
  202.  
  203.    HTRAFFIC may be followed by any combination of three command line
  204.    switches (plus "/h" for a help screen):
  205.  
  206.      /r   REPORT on individual areas
  207.  
  208.    HTRAFFIC will generate a separate text file for each area, named
  209.    <tagname>.RPT (tagname truncated at eight characters), listing the
  210.    posters to that area in order of the number of messages posted, along
  211.    with the number of messages posted, and the writer's net address, if
  212.    HTRAFFIC can find it on an origin line in the poster's message.
  213.  
  214.      /n   NEW data.
  215.  
  216.    Ordinarily HTRAFFIC continues to accululate data so that (assuming
  217.    it's run daily) each days' reports show the current day's mail added
  218.    to the previous day's report. When the /n switch is used, HTRAFFIC
  219.    will write it's reports and then discard its old data to start a
  220.    frest reporting period. It will also reset its beginning date for
  221.    future report periods. I run the /n option every two weeks.
  222.  
  223.       /l  LOCAL mode
  224.  
  225.    The /l switch makes HTRAFFIC look at ONLY messages posted from YOUR
  226.    NODE. This is useful for SysOps who was to keep track of how popular
  227.    different echos are with their users.
  228.  
  229.    CAUTION. If you run in local mode, and messages that enter your
  230.    system from other nodes will not be counted by HTRAFFIC, so any
  231.    reports you try to generate will not include them, even if you run
  232.    HTRAFFIC in normal mode. So, if you use one mode or the other, it's a
  233.    good idea to ALWAYS run in the same mode. If you wish to switch from
  234.    one mode to the other, first use the "/n" option to reset the
  235.    database.
  236.  
  237.    6. SETPLACE.EXE
  238.  
  239.    Every time HTRAFFIC runs, it creates a two-byte file called
  240.    HTRAFF.NUM, which keeps track of the last message number accounted
  241.    for. However, if your messagebase cleanup utilities renumber the
  242.    messagebase, this number will change. Accordingly, the little utility
  243.    SETPLACE.EXE is used to reset HTRAFF.NUM to the same number the last
  244.    message is changed to. To make sure no messages go unreported, it's a
  245.    good idea to run HTRAFFIC immediately before cleanup and SETPLACE
  246.    immediately after, as described in the next section.
  247.  
  248.    7. Running HTRAFFIC from a batch file.
  249.  
  250.    The best way to run HTRAFFIC is to call it every night from the batch
  251.    file that runs during your cleanup event. Call HTRAFFIC just before
  252.    cleanup and SETPLACE just after, so that your batch file should look
  253.    something like the following:
  254.  
  255.    CLEAN.BAT
  256.  
  257.               HTRAFFIC /r
  258.               mbutil purge
  259.               mbutil pack
  260.               mbutil link
  261.               SETPLACE
  262.  
  263.    You'll note that I use the /r (report) option every night.. that way
  264.    I've always got a current report of each echo area in a directory I
  265.    call \FD\STAT\. Every two weeks, I run HTRAFFIC /n /r from the
  266.    command line to make final "official" reports for that period, that
  267.    I can archive for my records. If you use MESSAGES.RA, you may want to
  268.    place FD2AREA just _before_ HTRAFFIC to be sure of generating a
  269.    complete AREAS.RPT file (see Section 2, and remember that you can
  270.    only do this if you want to report on all messages areas in
  271.    MESSAGES.RA)
  272.  
  273.    8. That's all there is to it!
  274.  
  275.    You may register this program for US$ 10.00 and I will send you a key
  276.    that will work on subsequent regular versions.
  277.  
  278.  
  279.    Contact me for further information, help, bug reports, comments, or
  280.    Christmas greetings at:
  281.  
  282.            FidoNet 1:135/907
  283.            Internet rveraa@newssun.med.miami.edu
  284.  
  285.            or by SnailMail at:
  286.  
  287.            Richard Veraa
  288.            Room 211
  289.            Villa Maria Nursing Center
  290.            1050 N.E. 125 Street
  291.            North Miami, FL 33161
  292.  
  293.                    Thanks a lot,
  294.  
  295.                    Cheers,
  296.                      Rich Veraa
  297.  
  298.  
  299.  
  300.    APPENDIX A.
  301.  
  302.                        AREAS.BBS
  303.  
  304.    AREAS.BBS is a plain ASCII rext file listing the message areas of
  305.    your BBS in the following format:
  306.  
  307.    Line 1: Your BBS Name
  308.  
  309.    Line 2: A semicolon (;)
  310.  
  311.    Remaining lines: The area number and tag name of each message area
  312.    you carry in the following format. Note that the example below lists
  313.    net addresses for uplinks, which some software requires. HTRAFFIC,
  314.    however, does not use these numbers and they are unnecessary for its
  315.    operation. In any case though, a column at least 25 characterss wide
  316.    must be available for the tag name, which must be typed EXACTLY as it
  317.    appears in the network. If you do not wish to generate traffic
  318.    reports for all the echos carried by your system, make a file in the
  319.    same form as AREAS.BBS, but call it AREAS.RPT, and list only the
  320.    message areas you wish HTRAFFIC to scan, as described in the
  321.    installation instructions.
  322.  
  323.    If your system uses a MESSAGES.RA file, you may wish to use the
  324.    FD2AREA.EXE utility included in the HTRAFFIC archive to generate an
  325.    AREAS.RPT file (See Section 2).
  326.  
  327. Birdsoft Online
  328. ;
  329. 001 LOCAL
  330. 002 PERSONAL
  331. 005 NETMAIL                    1:135/41
  332. 010 MAILBOX                    1:135/142
  333. 016 PASCAL                     1:135/142
  334. 021 QMX_XRS                    1:135/142
  335. 024 FL_LIVING                  1:135/142
  336. 198 Dupes
  337. 199 Bad Netmail
  338. 200 Recovery Board
  339.  
  340.  
  341.  
  342.