home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / b / bgtop22.zip / BGTOP.DOC next >
Text File  |  1993-03-23  |  11KB  |  226 lines
  1.  
  2.               VOICE               B.J. GUILLOT               MODEM
  3.          (713) 893-9320       2611 RUSHWOOD CIRCLE      (713) 893-9124
  4.                             HOUSTON TEXAS 77067-1941     v32bis 14.4K
  5.  
  6.             Copyright B.J. Guillot 1989-1993.  All Rights Reserved.
  7.  
  8.          =============================================================
  9.          BGTOP 2.2                                           23 MAR 93
  10.          =============================================================
  11.  
  12.       ╔═════════════════════════════════════════════════════════════════╗
  13.       ║ E02/758 sponsored by 001/070 is the OFFICIAL SUPPORT CONFERENCE ║
  14.       ╚═════════════════════════════════════════════════════════════════╝
  15.  
  16.          -------------------------------------------------------------
  17.          ABSTRACT
  18.          -------------------------------------------------------------
  19.  
  20.          BGTOP creates an informative bulletin  for  your  system that
  21.          includes  the  top  users  in  terms of calls,  uploads,  and
  22.          downloads.  Also,  a  total  box  showing the total number of
  23.          users, calls, uploads, and  downloads  is  shown.  BGTOP  may
  24.          alternatively be run as a logon door.
  25.  
  26.          This  document is written  on  a level so that anyone running
  27.          a  GT Power  bulletin board  can  understand it.  Experienced
  28.          users will no doubt find the instructions quite elementary.
  29.  
  30.          -------------------------------------------------------------
  31.          EXECUTION
  32.          -------------------------------------------------------------
  33.  
  34.          Before begining with this tutorial on the operation of BGTOP,
  35.          please be sure to have your GTPATH environment variable  set.
  36.          If  you  do  not,  please add the following directive to your
  37.          AUTOEXEC.BAT file and  reboot  your system.   Please remember
  38.          that the  GTPATH  is  intended to point towards your main  GT
  39.          directory  and the path does not necessarily have to be named
  40.          the same path as shown in this example.
  41.  
  42.             set gtpath=c:\gt
  43.  
  44.          Using this companion program is  quite  easy.  If you wish to
  45.          ignore the optional parameters,  you may run BGTOP by feeding
  46.          it only one command line parameter--a bulletin number--e.g.
  47.  
  48.             bgtop 4
  49.  
  50.          In the above example,  BGTOP  would create a file named 4 and
  51.          4.CBS in the  default  download  (bulletins)  directory.  The
  52.          colors used in the ANSI (CBS) version of the report are taken
  53.          directly from the sysop selected color codes in GT.CNF.
  54.  
  55.          Be careful as BGTOP will overwrite any existing bulletin.
  56.  
  57.          The actual BGTOP.EXE file may be placed in any directory.
  58.  
  59.          BGTOP offers several options for the  advanced  user.  Please
  60.          note the following available command line parameters.
  61.  
  62.             bgtop bulletin|door [/ln:number] [/ex:access_levels] [/nt] [/nf]
  63.  
  64.          -------------------------------------------------------------
  65.          DOOR MODE
  66.          -------------------------------------------------------------
  67.  
  68.          If you wish to run BGTOP as a dreaded logon door(tm), specify
  69.          the 'door' option rather than a bulletin number, e.g.
  70.  
  71.             bgtop door
  72.  
  73.          A number of things occur during  door mode that you should be
  74.          aware of.   BGTOP writes to the CON device and its output can
  75.          be redirected easily by the  DOS CTTY  command or the greater
  76.          than sign.  Observe these three example GTLOGON.BAT files.
  77.  
  78.             @echo off          @echo off                 @echo off
  79.             ctty com1          bgtop door > com1         %1 com1
  80.             bgtop door                                   bgtop door
  81.             ctty con                                     %1 con
  82.  
  83.          All three of the above files perform the  same  function. The
  84.          third example  shows  the  optimum batch file because it uses
  85.          GT to determine whether to redirect output to the com port.
  86.  
  87.          If you  use  a  com port  other than  COM1,  you will need to
  88.          change the batch file accordingly.
  89.  
  90.          A  great disadvantage exists,  however,  when  one  redirects
  91.          output directly to a com port or auxillary device--the  sysop
  92.          can not see what the user sees.  This problem can be overcome
  93.          by using the GATEWAY device driver available on many bulletin
  94.          board systems.  GATEWAY  can be easily installed by placing a
  95.          one line command in the CONFIG.SYS file.
  96.  
  97.             device=c:\util\gateway2.sys -d -1
  98.  
  99.          If you are using a com port other than COM1, you will need to
  100.          change the  '1'  to  whichever com port number you are using.
  101.          Here,  again,  are the three batch files,  however, they have
  102.          been slightly modified to take advantage of GATEWAY.
  103.  
  104.             @echo off          @echo off                 @echo off
  105.             ctty gate1         bgtop door > gate1        %1 gate1
  106.             bgtop door                                   bgtop door
  107.             ctty con                                     %1 con
  108.  
  109.          If  you  use  a  com port  other than COM1,  you will need to
  110.          change the  GATE1  directive  to one suitable for your needs.
  111.          Again, I would recommend using the third version of this file
  112.          for your GTLOGON.BAT file.
  113.  
  114.          In  'door'  mode,  BGTOP does not create a bulletin.  It will
  115.          display an  ANSI  and  ASCII  version of  the top user report
  116.          depending upon the  ANSI  setting in the GTUSER.BBS file.  It
  117.          also fetches the current caller name from that  file  as well
  118.          and displays a special box letting the current caller see how
  119.          he or she stands up to the rest of the crowd on your board.
  120.  
  121.          -------------------------------------------------------------
  122.          OPTIONS
  123.          -------------------------------------------------------------
  124.   
  125.          Remember the command line options listed a long time ago?
  126.  
  127.             bgtop bulletin|door [/ln:number] [/ex:access_levels] [/nf]
  128.  
  129.          When BGTOP creates its informative bulletin,  it will display
  130.          the 15 top users (13 in 'door' mode).   If you wish to change
  131.          this default so that more (or less) users are shown, the /LN:
  132.          option is for you.  Example:
  133.  
  134.             bgtop 4 /ln:25
  135.  
  136.          The above  commands would cause  BGTOP  to  create bulletin 4
  137.          listing the 25 top users rather than the 15 top users.
  138.  
  139.          BGTOP will scan through all users in the USER.CTL file except
  140.          for any which have been  deleted  or  banned from your board.
  141.          You may also 'exclude' certain access levels from the report.
  142.          This is  useful  if you have special friends that wish not to
  143.          be listed on the report.  Example:
  144.  
  145.             bgtop 4 /ex:zW0
  146.  
  147.          The above syntax would cause  BGTOP  to ignore any user  that
  148.          has an access level of 'z', 'W', or '0'.  Please remember the
  149.          case of the access level is  very  important.   An upper case
  150.          'Z' is completly different from a lower case 'z'.  Ther is no
  151.          limit to the number of access levels that may be excluded.
  152.  
  153.          When  BGTOP  creates its reports, it pads all user names with
  154.          a string of periods.  The  string  of  periods is annoying to
  155.          some sysops and the  /NF  parameter  is provided to ease your
  156.          eyes.   If the  /NF  parameter is used,  BGTOP  will pad user
  157.          names with a string of blank spaces.
  158.  
  159.          All optional parameters can be used at the same time, e.g.
  160.  
  161.             bgtop 7 /ex:0bGF /nf /ln:20
  162.  
  163.          BGTOP would create a bulletin  7  composed of the twenty  top
  164.          users from your  board  excluding  those users  that  have an
  165.          acces level of '0', 'b', 'G', or 'F'.   And,  of course,  the
  166.          user names would be padded with blank spaces.
  167.  
  168.          Using the /NT parameter would force BGTOP to NOT show the
  169.          neat looking total box added in BGTOP 2.2.
  170.  
  171.          -------------------------------------------------------------
  172.          ACKNOWLEDGEMENTS
  173.          -------------------------------------------------------------
  174.  
  175.          I  would  like  to  thank  the  following  people  for  their
  176.          assistance  with   bug  reports  and  implementation  of  new
  177.          command parameters ...  BGTOP 1.0 through BGTOP 1.9.  Thanks!
  178.  
  179.          Dennis Bills        Chuck Blair         Ed Bragg
  180.          Mel Douglass        Jim Kreyling        Chris Leaver
  181.          Bob Luzier          Scott Morris        April Strong
  182.          Dan Turkisher       Raymond Wood        Cory Wright
  183.  
  184.          The following people have given me suggestions for BGTOP 2.0.
  185.  
  186.          John Fisher         Tom Hamlyn          Russell Kroll
  187.  
  188.          Jeremy Mattern  and  Brian Wood  have shown  me  how  SLOW  a
  189.          program runs under a network when its not using buffers.
  190.  
  191.          The direct screen writes method used in  BGTOP 1.7 and beyond
  192.          where developed by Marshall Brain.
  193.  
  194.          I will also give special thanks to  Bob Camp  who helped some
  195.          solve  some of the  compatiblity  problems  and  gave me some
  196.          pointers on how to write code in  Turbo Pascal.   He actually
  197.          wrote  a portion of the new code in BGTOP 1.6.   Thanks, Bob!
  198.  
  199.          Russell suggested the current user block during 'door'  mode.
  200.  
  201.          -------------------------------------------------------------
  202.          OTHER INFORMATION
  203.          -------------------------------------------------------------
  204.  
  205.          The program has been  recompiled under  Turbo Pascal 6.0  and
  206.          was originally written in Quick Basic 4.5.  This is the  most
  207.          widely used BG companion program.
  208.  
  209.          This program is  FREEWARE.  No  registration fee  is required
  210.          for using this program,  BUT,  if  you  would  like to make a
  211.          contribution, I  won't  stop you!  Please  do  not  alter  or
  212.          reverse engineer this program in any way.
  213.  
  214.          If you have any suggestions or comments please  address  them
  215.          to me via  the  E02/758  echomail  conference or via a direct
  216.          voice or data phone call.
  217.  
  218.          <Plug> Check out the newest BG companion program,  BGQWK.  It
  219.          is the first QWK mail door for the GT Power family.  You will
  220.          LOVE this thing.  It's shareware.   If you use BGQWK now, and
  221.          you want  to  register, we  now  take  credit  cards.  Online
  222.          registration is possible if you are listed in the NODELIST.
  223.  
  224.          Regards,                                         GT:  001/040
  225.          B.J. Guillot
  226.