home *** CD-ROM | disk | FTP | other *** search
/ Carsten's PPE Collection / Carstens_PPE_Collection_2007.zip / S / STATSQ1D.ZIP / STATUSQ.DOC < prev    next >
Text File  |  1995-03-01  |  20KB  |  446 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                          Network Mail Status - QFront Version
  8.  
  9.           ═════════════════════════════════════════════════════════════════
  10.  
  11.                First off I would like to thank Don Sharp who suggested this
  12.           version. Also to  all those who offered suggestions  and comments
  13.           on my original  Status program. Some  functions and displays  are
  14.           the direct result  of this input. Don Sharp was  a beta tester on
  15.           Status, StatusC and now StatusQ.
  16.  
  17.                (1) Generates a network  Import mail status bulletin showing
  18.           each conference  (full 24 characters for  conference names), 1500
  19.           maximum, and the  total number of  messages imported for  current
  20.           date and  total to date  for each conferences,  total conferences
  21.           and the total messages to date for the specified network.
  22.  
  23.                (2) Generates a network  Export mail status bulletin showing
  24.           each conference  (full 24 characters for  conference names), 1500
  25.           maximum, and the  total number of  messages exported for  current
  26.           date and  total to date  for each conferences,  total conferences
  27.           and the total messages to date for the specified network.
  28.  
  29.                (3)  Generates  Last  Import  bulletin  showing  last import
  30.           information: date,  time, total messages imported  in last import
  31.           and total messages imported to date.
  32.  
  33.                (4)  Generates, or appends to  the end of,  a monthly totals
  34.           bulletin called  network.TOT  with each  rollover. This  bulletin
  35.           contains  the total  lines from  previous Import  bulletins along
  36.           with header.
  37.  
  38.                Supports  multiple  networks.  This  program  uses  QFront's
  39.           QSCAN.LOG(s).  It does  a monthly  rollover  of the  LOG(s) using
  40.           PKWare's PKZIP.EXE (copyright PKWare).
  41.  
  42.                This archive should contain the following files:
  43.  
  44.                CLEANUPQ.EXE.......... QFront log reduction program
  45.                CLEANUPQ.DOC.......... Instructions for running CleanUpQ
  46.                DOORS.TXT............. Current list of James Huckabey doors
  47.                FILE_ID.DIZ........... BBS description file
  48.                SOFTWARE.TXT.......... Information on sharewared
  49.                HUCKABEY.TXT.......... Current list of all James Huckabey
  50.                                       software
  51.                ARCHIVE.TXT........... This list of files
  52.                READ.ME............... Update/changes information
  53.                STATUSQ.EXE........... Actual Status program
  54.                STATUSQ.DOC........... Instructions for running StatusQ
  55.                STATUSQ.CFG........... Sample configuration file     
  56.                STATUSQ2.CFG.......... Sample configuration file
  57.                STATUSQ3.CFG.......... Sample configuration file
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                Syntax is pretty straight forward:
  64.  
  65.  
  66.                                  STATUSQ STATUSQ.CFG
  67.  
  68.  
  69.                Full path  to STATUSQ.EXE may be  used if not in  path or in
  70.           current  directory.  If  you do  use  a  path  statement in  your
  71.           execution of Status (not in  current dir or in path) you  need to
  72.           set the  environment variable  "SET STATUSQ=path  to STATUSQ.EXE"
  73.           (SET STATUSQ=C:\UTILITY\OTHER, etc. no ending slash is needed).
  74.  
  75.                It  is  not  necessary  to  add  a  path  statement  to  the
  76.           configuration file since the program finds itself. Of  course the
  77.           file must  be in  location of STATUSQ.EXE.  If the  configuration
  78.           file  is not in the same location  then use the path statement to
  79.           it's location. 
  80.  
  81.                "STATUSQ.CFG" and can have any file name with the  following
  82.           format. You can  use up to 8 characters of  your network name for
  83.           the  name  of your  .CFG file  if  that helps  keep multi-network
  84.           configurations clearer. This would  be the easiest way to  do it.
  85.           Each  line must  be  populated  with  a  valid  entry.  Paths  to
  86.           bulletins or logs are not needed if they are in or written to the
  87.           current directory:
  88.  
  89.                          (1) Unregistered BBS
  90.                          (2) 0000
  91.                          (3) Network
  92.                          (4) QSCAN.LOG
  93.                          (5) C:\BBS\BLT1
  94.                          (6) C:\BBS\BLT2
  95.                          (7) C:\BBS\BLT3
  96.                          (8) PCB
  97.                          (9) Bright
  98.  
  99.  
  100.                                      CFG line #1
  101.  
  102.                "Unregistered BBS", BBS name if registered.
  103.  
  104.  
  105.                                      CFG line #2
  106.  
  107.                "0000", valid serial number if registered.
  108.  
  109.  
  110.                                      CFG line #3
  111.  
  112.                "Network" should be the  name of the actual network  you are
  113.           using,  one word and  case sensitive (Fido,  AccessNet, etc.). 18
  114.           characters max, longer  names are truncated.  Say you are  making
  115.           two different network mail runs with the same software, you would
  116.           use those names here, each in it's own configuration file.
  117.  
  118.  
  119.  
  120.  
  121.  
  122.                                      CFG line #4
  123.  
  124.                "QSCAN.LOG" is the path and name of your QFront scan log .
  125.  
  126.  
  127.                                      CFG line #5
  128.  
  129.                "C:\BBS\BLT1" is the path and name for your Import bulletin.
  130.  
  131.  
  132.                                      CFG line #6
  133.  
  134.                "C:\BBS\BLT2" is the path and name for your Export bulletin.
  135.  
  136.  
  137.                                      CFG line #7
  138.  
  139.                "C:\BBS\BLT3" is  the  path and  name for  your Last  Import
  140.           bulletin.  If you are not using this  option the file can just be
  141.           written out to the current directory, but it must be generated.
  142.  
  143.  
  144.                                      CFG line #8
  145.  
  146.                Color  and characters  used are  setup to  give you  as much
  147.           control over the  output as possible. Not all users  can read and
  148.           handle IBM extended graphic characters (like sight impaired users
  149.           and  voice hardware).  Program  can  use  either "=/-"  or  IBM's
  150.           extended graphic  characters "═/─". Line  #8 must contain  one of
  151.           the following options:
  152.  
  153.                "PCB" use IBM extended  graphic characters and PCBoard's @X0
  154.           colorizing codes.
  155.  
  156.                "PCB2" use no IBM  extended graphic characters and PCBoard's
  157.           @X0 colorizing codes.
  158.  
  159.                "ANSI"   use  colorizing   and  no   IBM  extended   graphic
  160.           characters.
  161.  
  162.                "ANSI2" use colorizing and IBM extended graphic characters.
  163.  
  164.                "ASCII"  use  no  colorizing  and no  IBM  extended  graphic
  165.           characters.
  166.  
  167.                "ASCII2"  use no  colorizing, but  use IBM  extended graphic
  168.           characters.
  169.  
  170.  
  171.                                      CFG line #9
  172.  
  173.                Text Tone: This option  can be either Bright or  Normal. The
  174.           default is BRIGHT. Even if you are using an ASCII option you must
  175.           still populate this option.
  176.  
  177.  
  178.  
  179.  
  180.  
  181.                                 STATUSQ TOTAL FILE(s)
  182.  
  183.                This  file,  StatusQ  Totals,  is  written  to  the  current
  184.           directory only. Current directory is the directory where you call
  185.           STATUSQ.EXE  from. The file name is  the first eight alphabetical
  186.           characters  of  your network  name. This  way  if you  are making
  187.           multiple network mail runs each network will have it's own totals
  188.           file. The extension is always "TOT".
  189.  
  190.                Please  make  note  that if  your  copy  of  StatusQ is  not
  191.           registered that  the total file  will have "Unregistered  BBS" in
  192.           the BBS line of the  bulletin. If you keep the file  and register
  193.           StatusQ you will  have to edit  the top line  of the bulletin  or
  194.           erase the file(s) and start over.
  195.  
  196.                This file/bulletin  has unlimited possibilities.  If you are
  197.           making  more  than  one  StatusQ  execution,  say  for  different
  198.           formats, only the first  one will be executed with  the rollover.
  199.           So this file  will only contain that color format. It is complete
  200.           with whatever color codes  existed in the original bulletin.  The
  201.           colors can be removed  or replaced with whatever colors  you want
  202.           manually using a text editor.
  203.  
  204.                The file has  a three  line header when  first created,  (1)
  205.           line with BBS name in it, (2) an explanation of what it is, (3) a
  206.           header  termination line.  It then  has one  line for  Import and
  207.           Export  totals   followed  by  a  blank   separation  line.  Each
  208.           successive  appendage is  two  lines  total.  A year's  worth  of
  209.           information would have a total of thirty-nine lines.
  210.  
  211.                What you do with this information is up to you. Just another
  212.           friendly option added to the program.  If you are going to use it
  213.           as an  active bulletin it  can be copied anywhere  you want. Just
  214.           make sure that if you want the next rollover appended  to the end
  215.           that you keep the file in the current directory for the execution
  216.           of  StatusQ. If you change this directory  make sure you move the
  217.           total bulletin(s) to your new directory.
  218.  
  219.  
  220.                    Special Bulletins Showing Totals Each Conference
  221.  
  222.                It  is  possible  to  make  a  "Previous  Month's"  activity
  223.           bulletin out of the  rolled over log(s). At least the  data would
  224.           be all  there and compacted  if you have  used CleanUpQ.  All you
  225.           have to  do is make a  special STATUSQ.CFG file with  the name of
  226.           the  bulletins for these special bulletins. You could do one each
  227.           month  for the previous month.  The bulletin for  the Last Import
  228.           could just be written to the  current directory and not used. For
  229.           a  full month the Bulletins would have something like 01-01-95 to
  230.           01-31-95 for  the time period as this would be the dates in a log
  231.           for January 1995.
  232.  
  233.                Of  course the  above would  work even  if you  did not  run
  234.           CleanUpP.
  235.  
  236.  
  237.  
  238.  
  239.  
  240.                It should be noted that when you start using StatusQ for the
  241.           first time  that if your QFront  log(s) are not  just the current
  242.           month's log(s) that the log does not roll over until the month in
  243.           the log equals  your system's  current month.  The first  archive
  244.           will  contain everything to last  day of previous  month. The new
  245.           log will start at the first current month's date StatusQ finds in
  246.           the  current   month's   log.  Bulletins   generated  will   show
  247.           information only for  the current  month and from  this point  on
  248.           each  roll over archive  will contain  only the  previous month's
  249.           log.
  250.  
  251.  
  252.  
  253.  
  254.  
  255.                                         Errors
  256.  
  257.                Errors are written to the same directory as STATUSQ.EXE in a
  258.           file called  STATUSQ.ERR. If  the file already  exists additional
  259.           errors are  appended to the  end of the  file. It may  be deleted
  260.           after you have  made note of  any errors. It's  existence it  not
  261.           required by the program.
  262.  
  263.                During  the  start  up  procedures  that  program   displays
  264.           "Searching!" while it is looking for the directory STATUSQ.EXE is
  265.           located  in.  Also  "Configuring!" while  it  is  reading  in and
  266.           verifying all information in the configuration file. These are to
  267.           show you what the program is doing should lockups occur. Normally
  268.           these two displays should be very quick and  unreadable depending
  269.           on system speed and StatusQ's configuration.
  270.  
  271.                The  program confirms  each item  in the  configuration file
  272.           before it  does  anything else.  Program  aborts if  each  option
  273.           cannot be confirmed.
  274.  
  275.                If StatusQ has trouble finding the log(s) it first tries to 
  276.           create a  "no data bulletin" and  do an normal error  exit. If it
  277.           cannot  create  these  bulletins  it  makes  an  error exit  that
  278.           displays  the help screen. These  two exits would  normally be an
  279.           error in  the configuration  file: wrong  path, wrong file  name,
  280.           configuration file name not used, etc.
  281.  
  282.                If the program has any problems with your log(s) such  as no
  283.           conferences  found,   a  bulletin   is  generated   showing  that
  284.           information,  but   no  error  information  is   written  to  the
  285.           STATUSQ.ERR. If no imported messages are found the program aborts
  286.           writing out a no  message bulletin for Import along  with writing
  287.           out to STATUSQ.ERR.
  288.  
  289.  
  290.  
  291.  
  292.  
  293.                               Making Different Bulletins
  294.  
  295.                Perhaps you want to  make a bulletin with the  PCBoard color
  296.           codes  and one using straight  ASCII codes and  yet another using
  297.           ANSI codes, Bright  or Normal  Text Tones. The  .CFG files  would
  298.           contain the bulletin names and the form setting (#9):
  299.  
  300.                STATUSQ STATUSQ.CFG
  301.                (.CFG with PCB, uses PCBoard color codes and IBM extended
  302.                 graphic characters and normal text tone)
  303.  
  304.                STATUSQ STATUSQ2.CFG
  305.                (.CFG with ASCII, ASCII and no IBM extended graphic
  306.                 characters and normal text tone [must be populated])
  307.  
  308.                STATUSQ STATUSQ3.CFG
  309.                (.CFG with ANSI, ANSI colors and no IBM extended graphic
  310.                 characters and bright text tone)
  311.  
  312.                You just call STATUSQ as many  times as needed, with as many
  313.           configuration files  as needed  to generate whatever  formats you
  314.           want.  On my 486-40 it takes less  than twenty seconds to run the
  315.           program on a 16,500 line test log.
  316.  
  317.  
  318.  
  319.  
  320.  
  321.                         PKZIP.EXE used by the StatusQ Program
  322.  
  323.                "PKZIP.EXE" must be somewhere in your path or in the current
  324.           directory. When  the month  changes in the  export/import.log the
  325.           program  archives the  current log  into a  file using  'SQ'+ the
  326.           current date  (SQ010195.ZIP, etc.). It also  includes the current
  327.           logs and all  bulletins. It  creates this in  the directory  that
  328.           contains the log file(s). The program then rewrites the log using
  329.           only the  current new month's  data. This  way there is  only one
  330.           month's log data in your QFront log(s).
  331.  
  332.                The  bulletins  are  added  to   the  archive  so  the  last
  333.           information posted on the BBS before rollover is available should
  334.           this information be required by you.
  335.  
  336.                If you do not want the previous month's log(s) simply delete
  337.           the archive from your hard drive. In your calling batch  file you
  338.           can  add "IF EXIST SQ*.ZIP DEL SQ*.ZIP" and this will auto-delete
  339.           the archive.
  340.  
  341.                There must  be at least one  meg of free disk  space for the
  342.           archive to be executed. I have no idea the possible  sizes and if
  343.           anyone has problems with the archive with one meg as the  minimum
  344.           please let me know and I will increase the size of the free space
  345.           required. 
  346.  
  347.  
  348.  
  349.  
  350.  
  351.                                  The StatusQ Program
  352.  
  353.                If you don't like the program please write to me and explain
  354.           why. Send me any suggestions you  might have. If they enhance the
  355.           overall program I will try to incorporate part, some, all, in the
  356.           next release.
  357.  
  358.                 This program package represents  many hours of programming,
  359.           testing, updating and LD telephone calls  to get it tested and to
  360.           distribute the beta and release copies. Please support my efforts
  361.           and register your copy. Registration enables CleanUpQ.
  362.  
  363.  
  364.                                  StatusQ Registration
  365.  
  366.                Please  supply name of  BBS to  be added  to program,  up to
  367.           sixty  characters. Anything  longer  than this  is truncated,  no
  368.           exceptions. This is to be on one line of code and must be legible
  369.           since the  serial number  is based on  exact syntax. I  cannot be
  370.           responsible for unreadable data. Please print. Case sensitive! 
  371.  
  372.                For  those  who do  not understand  "case sensitive"  I will
  373.           explain since  some people do not  seem to know the  term. If you
  374.           send me  your BBS name in  all capital letters that  is what your
  375.           serial number matches. If you send me your BBS name  in all lower
  376.           case letters your this is what your serial number matches. If you
  377.           send me your BBS name  in capital and lower case letters  that is
  378.           what your serial number matches. Writing small capital letters is
  379.           not the same as lower case. I have gotten registrations where the
  380.           first letter of  words were in large capital letters and the rest
  381.           of  the letters  in  that  word  in  small  capital  letters.  My
  382.           interpretation is  that this is all  uppercase (capital) letters.
  383.           By match means that your configuration file must contain the same
  384.           format your serial number is based on: (1) all uppercase, (2) all
  385.           lower case, (3) mixed case.
  386.  
  387.           Example:  "Jim's Graphic  BBS". In  StatusQ it  comes out  as the
  388.           following in all bulletins generated:
  389.  
  390.                ==================(Jim's Graphic BBS)==================
  391.  
  392.  
  393.  
  394.  
  395.  
  396.                               StatusQ Registration Form
  397.  
  398.  
  399.            [-------------------------------------------------------------]
  400.  
  401.                                  (put BBS name above)
  402.  
  403.                Send  BBS information  and one  of the  following in  $ U.S.
  404.           Registration enables CleanUpQ.
  405.  
  406.                (1) Registration via mail............................$12
  407.                    (outside U.S./Canada please add $2)
  408.  
  409.                (2) Registration and latest version via mail......... $14
  410.                    (outside U.S./Canada please add $4) Include diskette
  411.                    size.
  412.  
  413.                (3) Registration and latest version via mail and copy
  414.                    of all James Huckabey Doors and PC software...... $17
  415.                    (outside U.S./Canada please add $5) Include diskette
  416.                    size.
  417.  
  418.                         Option: 1: [ ]     2: [ ]     3: [ ] 
  419.  
  420.                Diskette Size: 360: [ ]   1.2: [ ]   720: [ ]  1.44: [ ]
  421.  
  422.                Your current version number: [     ]
  423.  
  424.           FROM: 
  425.                   Name: 
  426.                        ---------------------------------------------------
  427.                Address:  
  428.                        ---------------------------------------------------
  429.                   City: 
  430.                        ---------------------------------------------------
  431.            State & Zip: 
  432.                        ---------------------------------------------------
  433.               BBS Name:
  434.                        ---------------------------------------------------
  435.           Phone(voice):                       (data)
  436.                        ----------------------        ---------------------
  437.  
  438.  
  439.                Your registration  number and any  diskettes, if  requesting
  440.           current version or other software, are sent by return mail.
  441.  
  442.                James Huckabey
  443.                3621-A Fraser Street
  444.                Bellingham, Washington 98226-2473 U.S.A.
  445.                (360) 671-2868 (voice, Pacific)
  446.                I do have a US Robotics HST 14.4 DS v32 v42/v42bis modem!