home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR4 / THDUTL36.ZIP / THDUTL.DOC < prev    next >
Text File  |  1993-12-04  |  21KB  |  438 lines
  1.  
  2.                        ============================
  3.                             Tri-HD's-Utility
  4.                        ============================
  5.                Copyright 1993 Heavy Duty Software/HD's BBS
  6.  
  7.       Proceeds from the sale of this utility are applied to the maintenance
  8.             and upkeep of Radio Freaks/HD's Support BBS. The BBS is
  9.                  free to all callers and programs such as this
  10.                        are it's sole source of revenue.
  11.  
  12.                        Version 3.xx     12/04/93
  13.  
  14.                                    By
  15.  
  16.                               H. D. Holland
  17.                            2911 Chestnut Grove Dr.
  18.                              Austell, Ga. 30001
  19.  
  20. LATEST VERSION/SUPPORT:
  21. ^^^^^^^^^^^^^^^^^^^^^^
  22. The latest version of this Product and online Support are available
  23. at the Radio Freaks/HD's Support BBS, (404) 941-1308, or via WME net.
  24. I am sorry but I can not promise to provide support for unregistered
  25. users of the program. If you have a question, please leave me a note on
  26. my BBS or WME, I will get back to you as time permits. Registered users
  27. will receive immediate replies and a satisfactory resolution of their
  28. problems.
  29.  
  30. I do solemnly swear that I will do my best to keep the program current
  31. and compatible with the latest releases of TriBBS. I do not intend to
  32. leave good customers with a useless program. :)
  33.  
  34. LEGALITIES:
  35. ^^^^^^^^^^
  36. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  37. WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY
  38. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  39. IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS
  40. PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING
  41. OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  42.  
  43. DISTRIBUTION:
  44. ^^^^^^^^^^^^
  45. You may make this file available for downloading from your BBS or you may
  46. upload it to any BBS of your choice, provided that you do not make any
  47. changes to the contents of the archive (ZIP file). The term "BBS" includes 
  48. online services. However, commercial disk vendors must contact the 
  49. author for permission prior to distribution.
  50.  
  51. PROGRAM DESCRIPTION:
  52. ^^^^^^^^^^^^^^^^^^^
  53. THDUTL is a multi function utility for TriBBS* V5.xx bulletin boards. It
  54. is intended to provide the most used/requested 'nice little features'.
  55. The program is TriBBS specific.
  56.  
  57. NOTE:
  58. ^^^^
  59. The utility is NOT (CURRENTLY) crippled in any way. You may place it on
  60. your system for a period of Thirty days for test and evaluation. After
  61. that period, you are expected to register the software with the author,
  62. or remove it from your system. Remember it is a screen generator, anyone
  63. calling your board can ascertain your use of the program. ShareWare
  64. works only if we make it work.
  65.  
  66. FEATURES:
  67. ^^^^^^^^
  68. 1. Last 15 Callers screen with programmable 'watch' items. Provides
  69.    the usual screen with a few added goodies that allows you and
  70.    your callers to get a feel for the boards activity.
  71.  
  72. 2. BBS Door/activity tally screen with programmable 'tally' items.
  73.    Activity in your doors as listed in the DOORS.MNU is tallied
  74.    automatically, alternately; you may add additional items to be
  75.    tallied.
  76.  
  77. 3. Welcome New Users screen. List the names, City/State, date and
  78.    baudrate of new callers.
  79.  
  80. 4. Download tracking. The utility places the usual "# Downloads:"
  81.    comment in your FILES.LST. Special interest downloads may be
  82.    tracked with the name, city & state, and date/time of download
  83.    being placed in a separate file.
  84.  
  85. 5. Upload tracking. THDUTL builds a file named UPLOAD.DAT in the TriBBS
  86.    directory. You may use it as you wish. The file simply contains the
  87.    names of the files that were uploaded. Unless deleted in the
  88.    BETWEEN.BAT, it will continue to grow with each user that uploads.
  89.  
  90. 6. Upload archive Integrity checking, conversion and Virus checking in
  91.    the BETWEEN.BAT (after the user logs off), optional. Stripping and
  92.    Addition of new archive comments also supported, and addition of
  93.    DESC.SDI (description) files to archives having none.
  94.  
  95. 7. Top 15 tracking of Uploaders, Downloaders and popular Files. Screen
  96.    displays your top 15 activity if desired. Exclusion files are
  97.    available to exclude particular file names or file areas or users.
  98.  
  99. 8. BBS hourly usage graph. A screen to appraise your users when the BBS
  100.    is busy and when it is most open for calls. Mail run hour may be
  101.    flagged also.
  102.  
  103. 9. Trim your CALLERS.LOG to a specified length automatically. You set
  104.    the maximum length in kilo-bytes. Trimmed portion may be saved.
  105.  
  106. 10.Dropped carrier notification. An exit code of 1 from THDUTL indicates
  107.    that the user dropped carrier before the 'logged off' flag appeared
  108.    in the CALLERS.LOG. You may use it as you deem fit with a third-party
  109.    program or DOS batch ERRORLEVEL checking.
  110.  
  111. INSTALLATION:
  112. ^^^^^^^^^^^^
  113. Create a directory off of your TriBBS directory such as \UTL. Copy
  114. THDUTL.EXE and THDUTL.CFG from the archive to the new directory.
  115. Edit the THDUTL.CFG file to the specifications of your BBS. Run
  116. the program with the /F command line switch from the \UTL directory
  117. to initialize the screen files. Depending on the size of your
  118. CALLERS.LOG file, the program may take some time to run. Subsequent
  119. runs will only look at that portion of the CALLERS.LOG added since
  120. it was ran last. If you edit your CALLERS.LOG file, THDUTL will note
  121. the change and run from the beginning again, rebuilding the screens
  122. and files.
  123.  
  124. If you are NOT now using a download tracker, you may use the command
  125. line switch /D on the FIRST run. This will provide for tracking of
  126. past downloads into your .LST files. Do NOT use the /D switch on any
  127. subsequent runs or the download numbers will be falsely inflated.
  128.  
  129. Place a call to THDUTL in your BETWEEN.BAT file. Each time a caller
  130. logs off, THDUTL will examine that portion of the CALLERS.LOG which
  131. has been appended by TriBBS since it last was called. Include the
  132. command line switches of your selection (see below).
  133.  
  134. You may also have THDUTL keep your CALLERS.LOG trimmed to a specified
  135. length by adding the command line switch /T# (See switches below).
  136. Alternately, the trimmed portion may also be saved with /ST.
  137.  
  138. Upload Virus and integrity checking may be performed if desired. Place
  139. the /U switch in the call to THDUTL in BETWEEN.BAT. If you desire an
  140. archive comment file be added to your files, build THDUTL.MSG with your
  141. information and place it in the \UTL directory. Ensure your default
  142. archive is set correctly in TriBBS's WFC Configure System menu and turn
  143. upload checking OFF and set EXACT MATCH to YES. Note that THDUTL will
  144. convert ALL uploads to the default archive system unless excluded. To
  145. exclude specified file extensions, build the file THDUTL.ACX in the \UTL
  146. directory and enter the three letter extensions you do NOT want
  147. converted to archive. If the upload does not include a FILE_ID.DIZ or
  148. DESC.SDI file, THDUTL will extract the file description from the
  149. FILES.LST and build a DESC.SDI file for inclusion in the archive. All
  150. uploads are tracked in file UPLOAD.DAT in the TriBBS directory also.
  151.  
  152. THDUTL prints various items to the screen while running. You may
  153. want to redirect the printouts to a log file to provide a condensed
  154. CALLERS.LOG for your own use. Try THDUTL >> C:\UTL\UTILITY.LOG in your
  155. BETWEEN.BAT if you wish.
  156.  
  157. The program assumes there will never be anyone around to answer a
  158. prompt. All errors recover automatically and proceed. A THDUTL.LOG
  159. is produced which indicates when errors occur. Please upload this
  160. file to the BBS with any request for support so that I may review
  161. it.
  162.  
  163. IMPORTANT: If you do not now use the Index files associated with the
  164. file areas, I suggest you do. They speed up the download tracking
  165. process immensely. Simply go into your Waiting For Caller screen and
  166. edit the file areas adding an index file name for each file area, then
  167. run MAKEIDX /ALL. Additionally, add a check for the UPLOAD.DAT file to
  168. your BETWEEN.BAT and if it exist, call MAKEIDX /F:#-# (Where #-# include
  169. your upload file areas) See example below.
  170.  
  171. If you wish to track the download of particular files on your system,
  172. build an ASCII file named THDUTL.CHK, and place the names of the files
  173. you wish to track in this list. You may enter partial filenames (e.g.
  174. .ZIP) to track all files which contain that partial. The results are
  175. printed to FILECHK.DAT in the \UTL directory, giving filename, user
  176. name, city & state and date/time of download.
  177.  
  178. CONFIGURATION:
  179. ^^^^^^^^^^^^^
  180. Example configuration file for THDUTL.CFG
  181. ----------------------------------------
  182.  
  183. Radio Freaks/HD's Support BBS   <=-  Name of your BBS (<30 characters)
  184. C:\TRIBBS                       <=-  Your BBS home directory
  185. CD=OK                           <=-  OK to track CD-ROM downloads
  186. LOGON2                          <=-  Name of Last 15 caller screen
  187. LOGON3                          <=-  Name of BBS activity tally screen
  188. LOGON4                          <=-  Name of New User Welcome screen
  189. LOGON5                          <=-  Top 15 activity screen
  190. LOGON6                          <=-  BBS Hourly usage screen
  191. QWK=TriMail                     <=-  Variable #1 for Last 15 Caller screen
  192. CBV=MAIN#                       <=-  Variable #2
  193. CHT=Chat Started                <=-  Variable #3
  194. ANSI graphics                   <=-  Variable #1 for the BBS activity tally
  195. RIPScrip graphics               <=-  Note new variables added in B09 +
  196. TriMail QWK                     <=-  Variable #3 for BBS activity tally
  197. Executed door                   <=-  Variable #4 - N
  198. Downloaded file                 <=-
  199. Uploaded file                   <=-
  200. Entered message                 <=-
  201.  
  202. BBS Name   -   Up to 30 characters which will be displayed in the screens.
  203.  
  204. BBS directory  The node 1 directory of your TriBBS. THDUTL V1.x has NOT
  205.                been tested with multiple nodes. It does support SHARE.
  206.  
  207. CD-ROM     -   If you have a CD-ROM drive on-line, and have moved the
  208.                FILES.LST to a disk, indicate OK, otherwise indicate NO.
  209.                THDUTL will track downloads from the CD-ROM if it is able
  210.                to write to the FILES.LST associated with it. A NO answer
  211.                here will exclude CD-ROM files from the Top 15 list also.
  212.  
  213. LOGON2-6       Self explanatory. The names of the screen files to be
  214.                generated and may be BULLET#, DBULL# or LOGON#. If you
  215.                do not wish to use a particular screen, enter a dummy
  216.                filename, e.g. JUNK. THDUTL always generates the screens
  217.                but you do not have to use them. Edit your BULLETIN.MNU
  218.                or DRBULL.MNU accordingly.
  219.  
  220. QWK=TriMail    Up to three Variable elements to display and track in the
  221.                Last 15 Caller screen. Enter a Three (3) letter heading
  222.                such as QWK, CBV, CHT, DOR etc followed by an equal (=)
  223.                and the key-word occurring in the CALLERS.LOG that
  224.                indicates this action has occurred. The three letter
  225.                heading will be displayed verbatim in the screen. The
  226.                screen will indicate the occurrence of the item with a
  227.                check mark. If you do not desire to have these items
  228.                tracked, edit the .CFG file and enter "NONE" in the three
  229.                slots.
  230.  
  231. TriMail QWK    Variables to be tallied and displayed in the BBS activity
  232.                screen. You may edit these out or leave them as they are,
  233.                or modify them to your liking. They must be typed into the
  234.                .CFG file EXACTLY as they appear in the CALLERS.LOG in
  235.                order to match (and tally). Note that THDUTL will read your
  236.                DOORS.MNU from the NWORK directory and compute activity
  237.                tallies based on those entries automatically. This area of
  238.                the .CFG file offers you an opportunity to add additional
  239.                activity items to the screen. If you do not wish these
  240.                items tallied, edit them out of the .CFG file.
  241.  
  242. THDUTL.XCL file          <Callers name exclusion>
  243. ^^^^^^^^^^^^^^^
  244. You may create this file to tell THDUTL which users NOT to include in
  245. the Last 15 Callers screen. Enter the full user's name EXACTLY as it
  246. would appear in the CALLERS.LOG. One name per line, up to 20 names.
  247. Partials may be used also. e.g. entering MAILRUN would prevent all of
  248. your mailrun users from showing up in the display.
  249.  
  250. THDUTL.CLR file           <Screen Color keys>
  251. ^^^^^^^^^^^^^^^
  252. You may optionally select the colors used by THDUTL for the various
  253. screens. Edit the provided file as desired, entering the ANSI color
  254. control sequences desired for each of the 5 screens. Each screen's
  255. controls consist of 7 ANSI color sequences, the BBS @command that is
  256. sent prior to displaying the screen and the terminating BBS @command
  257. separated by comma's. The file is not required for THDUTL to generate
  258. the screens, default colors will be used. The @X## codes have been
  259. tested but do not seem to work well due to TriBBS's handling of them
  260. with respect to spacing. See COLOR.DAT file included in archive.
  261.  
  262. THDUTL.ACX file           <Archive Conversion exclusion>
  263. ^^^^^^^^^^^^^^^
  264. Archive exclude file. Enter the three letter file extensions you do
  265. NOT wish repacked into your default archive format, e.g. GIF.
  266.  
  267. THDUTL.TTX file           <Top Ten file name exclusion>
  268. ^^^^^^^^^^^^^^^
  269. Top 15 files exclude. If you have files you do NOT wish displayed in
  270. the Top 15 download area, list them (up to 50) in this ASCII file.
  271. You may use partials also.
  272.  
  273. THDUTL.AFX file           <Top Ten File Area exclusion>
  274. ^^^^^^^^^^^^^^^
  275. Top 15 screen area exclude. An ASCII file listing the file area numbers
  276. that are to be excluded from Top 15 screen listing.
  277.  
  278. THDUTL.MSG file           <Archive comment message>
  279. ^^^^^^^^^^^^^^^
  280. Archive comment text. Place the message you wish added to your archives
  281. in this file. ASCII or ANSI may be used but ASCII is suggested.
  282.  
  283. THDUTL.CHK file           <Special download tracking>
  284. ^^^^^^^^^^^^^^^
  285. If this file exist, the filenames or partials listed in it will receive
  286. special download tracking. A FILESCHK.DAT file is build in the /UTL
  287. directory listing downloads.
  288.  
  289. Build an ASCII file named THDUTL.CHK in the \UTL directory and enter the
  290. names of files you wish to track the downloads for. You may enter full
  291. file names (THDUTL.ZIP), or partials (.ZIP). Each time a user downloads
  292. one of these files, an entry is made in the FILECHK.DAT file:
  293.  
  294.   filename          user            from            date/time logged on
  295. THDULT32.ZIP     by Hal Holland   From Austell, Ga.   10/24/93 12:51:43
  296.  
  297. Example BETWEEN Batch File (Use what you need, discard what you don't)
  298. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  299.    @ECHO OFF
  300.    ECHO ATH1 >> COM1        <=  Take the phone off the hook to prevent
  301.                                 calls while we are working
  302.    CD\UTL                   <=- Switch to the utility's Directory.
  303.  
  304.    THDUTL /U /R /M /T50 /ST /H04  <=- Execute THDUTL with options
  305.    IF NOT ERRORLEVEL 1 GOTO NEXT1
  306.    ECHO This dummy dropped carrier! >>  C:\TRIBBS\DROPPER.LOG
  307.    :NEXT1
  308.  
  309.    IF NOT EXIST FILECHK.DAT GOTO NEXT2
  310.    :: Do whatever you do when you had someone download your special files
  311.    :: then move the data to another file and delete the FILECHK.DAT.
  312.    :NEXT2
  313.  
  314.    CD\TRIBBS                <=- Go back to TriBBS DIR
  315.  
  316.    IF NOT EXIST UPLOAD.DAT GOTO NEXT3
  317.    TYPE UPLOAD.DAT >> UPLOADS.DAT      <=- Save the data in UPLOADS.DAT
  318.    MAKEIDX /F:#-#                      <=- Re index upload areas
  319.    DEL UPLOAD.DAT
  320.    :NEXT3
  321.  
  322.    ECHO ATH0 >> COM1        <=- Put the phone back on the hook
  323.    BOARD                    <=- Restart BBS.
  324.  
  325. Support Files
  326. ^^^^^^^^^^^^^
  327. Program and support files:
  328.  
  329.    THDUTL.EXE    The executable.
  330.    THDUTL.CFG    The configuration file
  331.    THDUTL.XCL    List of users to exclude from Last 15 screen.
  332.    THDUTL.MSG    Ascii text file to be added to archives as comment.
  333.    THDUTL.CLR    Color control for the 5 screens generated
  334.    THDUTL.TTX    Top 15 file name excludes
  335.    THDUTL.AFX    Top 15 file Area excludes
  336.    THDUTL.ACX    Files excluded from archive conversion
  337.    THDUTL.CHK    Files to receive special download tracking
  338.  
  339. THDUTL will build various support files when it is invoked.
  340.  
  341.    THDUTL.WRK    data to build the Last 15 Caller screen.
  342.    THDULT.DOR    data to build the BBS Activity screen.
  343.    THDUTL.GUY    data to build the New Users screen
  344.    THDUTL.TIM    data to build the Hourly call graph
  345.    THDUTL.FIL    Download file tracking for Top 15
  346.    THDUTL.DLD    Download user name tracking for Top 15
  347.    THDUTL.UPL    Upload user name tracking for Top 15
  348.    UPLOAD.DAT    Contains a list of uploads w/name of user
  349.    THDUTL.LOG    An error log.
  350.    FILECHK.DAT   Contains the information about special downloads
  351.    CALLERS.TRM   In the MWORK directory. The trimmings from CALLERS.LOG
  352.    $TMP, TMP     Temporary files built by THDUTL. They 'should' be
  353.                  deleted by the program :)
  354.  
  355. RUNNING THDUTL
  356. ^^^^^^^^^^^^^^^
  357. To run the program, simply type (or add to your .BAT file) THDUTL
  358. (With appropriate switches).
  359.  
  360. e.g.     THDUTL /U /T100 /ST /R /M /H05
  361.  
  362. Multiple switches may be used, in any order:
  363.  
  364.       /F  =     Force output and use the entire CALLERS.LOG. New
  365.                 UPLOAD.DAT, THDUTL.WRK, .DOR, .GUY files are built
  366.                 and new screens are constructed. Unless the /F is
  367.                 used, the data used in screen construction is added
  368.                 to each call. Use the /F switch to re initialize your
  369.                 screens.
  370.  
  371.       /D  =     Force tracking of downloads and update of the .LST
  372.                 files on a full run. Use only once! On the first run
  373.                 if you were not using a download tracker prior to
  374.                 THDUTL.
  375.  
  376.       /A  =     Include all users (ignore the THDUTL.XCL file)
  377.  
  378.       /L  =     Include local logons in the Last 15 Caller screen.
  379.  
  380.       /T# =     Trim log length in Kilo bytes. /T50 will maintain
  381.                 your CALLERS.LOG length at 50,000 bytes, trimming it
  382.                 back each time it exceeds the desired setting by %20.
  383.                 The log is trimmed back to the first logon occurring
  384.                 after the specified length.
  385.  
  386.       /ST =     Save Trimmed log. Entries from CALLERS.LOG trimmed
  387.                 with the use of the /T# switch are appended to file
  388.                 CALLERS.TRM. This file will continue to grow until
  389.                 trimmed/removed by you. CALLERS.TRM + CALLERS.LOG =
  390.                 full log of events.
  391.  
  392.       /U  =     Perform upload archive integrity checking and Virus
  393.                 checking on any uploads found. Convert the archive to
  394.                 the default (.ZIP), and (optionally) add archive comment
  395.                 from the THDUTL.MSG file. Files failing the check are
  396.                 deleted and the entry is removed from the FILES.LST.
  397.  
  398.       /M  =     If no 'Uploaded By:" line is found in the FILES.LST,
  399.                 place one in the file with the name of the SysOp as
  400.                 the uploader.
  401.  
  402.       /R  =     If the logon name is an alias, change it to the Real name
  403.                 of the user.
  404.  
  405.       /H## =    Mail run hour. The hour indicated (00 - 23) will appear
  406.                 in the BBS Hourly usage screen flagged as the mail hour.
  407.  
  408.       /Z   =    A debug switch. DO NOT USE IT. Forces THDUTL to look in
  409.                 C:\D directory for all FILES.LST and Up/Download FILES.
  410.  
  411.  
  412. FUTURE VERSIONS:
  413. ^^^^^^^^^^^^^^^
  414. Let us know what you would like to see added, subtracted or modified!!
  415. If it can be done, odds are 50%/50% that I can do it.
  416.  
  417. REGISTRATION:
  418. ^^^^^^^^^^^^
  419. Registration is $25.00. Considering the price of the 3 to 5 utilities
  420. necessary to do the job of THDUTL, this price is reasonable. If you feel
  421. it is not, and you are interested in the program, drop me a note and
  422. state your case. Please complete the enclosed text file, REGISTER.TXT.
  423. This one-time fee will "register you for life" and will allow you to get
  424. Updates as occurring. Mail the completed registration from along with
  425. check, money order or plane hard cash to:
  426.  
  427.       H. D. Holland
  428.       2911 Chestnut Grove Dr.
  429.       Austell, Ga. 30001-000
  430.  
  431. You will receive a letter of registration (and the sincere appreciation
  432. of myself and the users of Radio Freaks/HD's Support BBS) via return
  433. mail.
  434.  
  435. *TriBBS is a registered trademark of Mark D. Goodwin and is in no way
  436. associated with Heavy Duty Software, HD's Support BBS or H. D. Holland.
  437.  
  438.