home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / DRTRAK10.ZIP / DOORTRAK.DOC < prev    next >
Encoding:
Text File  |  1993-01-01  |  19.7 KB  |  634 lines
  1.  
  2.  
  3.                                 DoorTrack v.1.0
  4.                                 ───────────────
  5.  
  6.                       -Shareware by Platypus Programming-
  7.                           Documentation and Program
  8.                       Copyright 1993 Platypus Programming
  9.  
  10.         ─────────────────
  11.         BRIEF DESCRIPTION
  12.         ─────────────────
  13.  
  14.                 DoorTrack is a sysop utility
  15.                 designed to track the usage of your "doors",
  16.                 or online programs of any sort.  Fully
  17.                 configurable, DoorTrak enables the sysop
  18.                 to track door usage in a variety of ways,
  19.                 including a master listing of all doors used
  20.                 and individual listings for each door.  This
  21.                 program is SHAREWARE and costs $5 if you
  22.                 continue to use it past a reasonable evaluation
  23.                 period
  24.  
  25.         ────────────────────
  26.         How to use DoorTrack
  27.         ────────────────────
  28.  
  29.                 Most BBS systems use a batch file (or script; this
  30.         .DOC will always refer to them as batch files) to run external
  31.         programs.  Usually a unique batch file is required for EACH
  32.         online program.  DoorTrack is designed for any BBS type that
  33.         runs in this fashion, including PCBoard, WWIV, VBBS and many
  34.         others.  In a typical door batch file, you will have something
  35.         like the following:
  36.  
  37.                 @ECHO OFF
  38.                 CD\BBS\DOORS\DENTIST
  39.                 DENTIST DENTIST.CFG
  40.                 CD\BBS
  41.                 BOARD
  42.  
  43.             (note:  this last line will vary greatly from software
  44.              to software.  Some BBS software require you to run a
  45.              batch file to get the board back up.  Others just let the
  46.              batch file end)
  47.  
  48.                 DoorTrack fits in in this way (assuming that the
  49.                         DOORTRAK.COM file is in your PATH):
  50.  
  51.                 @ECHO OFF
  52.                 CD\BBS\DOORS\DENTIST
  53.                 DENTIST DENTIST.CFG
  54.                 DOORTRAK DENTIST.LOG
  55.                 CD\BBS
  56.                 BOARD
  57.  
  58.              You're wondering, "What did that do?"  Well, by calling
  59.              DoorTrack with DENTIST.LOG as the only parameter, you told
  60.              DoorTrack to write the current time to a file called
  61.              DENTIST.LOG!  When you read DENTIST.LOG (an ASCII file),
  62.              you will see all the times that Online Dentist was run!
  63.              This is only ONE of the options, though...
  64.  
  65.                                       1.
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.         ───────
  74.         OPTIONS
  75.         ───────
  76.  
  77.                 DoorTrack is FULLY configurable through command line
  78.         options.  The advantage to having the options enabled through
  79.         the command line is that each door can have a fully separate
  80.         and unique DoorTrack configuration.  Here are the options
  81.         available:
  82.  
  83.         USAGE:  DOORTRAK [I/O] FileName.Ext ["Door Name" {FileTwo.Ext}]
  84.  
  85.                 All items in brackets are optional
  86.  
  87.             I - Will mark as being "entered"
  88.             O - Will mark as being "exited"
  89.             FileName.Ext - REQUIRED - the name of the log file
  90.             "Door Name" - in quotes, the name of the door you are running
  91.               (note:  "Door Name" IS required if you use the FileTwo.Ext)
  92.             FileTwo.Ext - a second log file
  93.  
  94.         ───────────────────────────────
  95.         Detailed Description of Options
  96.         ───────────────────────────────
  97.  
  98.            These will be explained in the order that they appear on the
  99.            command line.
  100.  
  101.            I/O
  102.            ───
  103.  
  104.                 Simply an "I" or an "O" character, indicating whether
  105.            this run of DoorTrack is when going (I)n or (O)ut of a door
  106.  
  107.            FileName.Ext
  108.            ────────────
  109.  
  110.                 This is a filename of your choice.  What is WRITTEN to
  111.            this file will depend on how many parameters are entered
  112.            (which is explained in the next section).  To be general,
  113.            though, the file you name here will contain a list of times
  114.            that a particular door or group of doors was entered and/or
  115.            exited.
  116.            
  117.            "Door Name"
  118.            ───────────
  119.  
  120.                 Entering the name of your door in "quotes" tells
  121.            DoorTrack to use that name when writing to the log file(s).
  122.            If you don't specify a door name, DoorTrack will write
  123.            "Run at 21:12 on 12/21/92" in the logfile.  If you put
  124.            "Online Dentist" in quotes, DoorTrack will write
  125.            "Online Dentist run at 21:12 on 12/21/92".  It all depends
  126.            on what you put in quotes!  You can enter ANY text
  127.            there.
  128.  
  129.  
  130.  
  131.                                       2.
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.            FileTwo.Ext
  140.            ───────────
  141.  
  142.                 Much like FileName.Ext, FileTwo.Ext is any filename you
  143.            choose to contain a list of times a particular door was
  144.            entered and/or exited.  The different usages of FileName.Ext
  145.            and FileTwo.Ext are explained in the next section!
  146.  
  147.         ─────────────────────────────
  148.         Detailed Description of Usage
  149.         ─────────────────────────────
  150.  
  151.            FileName.Ext
  152.            ────────────
  153.  
  154.                 It will probably be easiest to work our way from the
  155.         bare minimum and work our way up!  This is the simplest usage of
  156.         DoorTrak:
  157.  
  158.                 DOORTRAK DOOR.LOG
  159.  
  160.         It would fit in our example batch file this way:
  161.  
  162.                 @ECHO OFF
  163.                 CD\BBS\DOORS\DENTIST
  164.                 DENTIST DENTIST.CFG
  165.                 DOORTRAK DOOR.LOG
  166.                 CD\BBS
  167.                 BOARD
  168.  
  169.         What you get from this is a file called DOOR.LOG that contains
  170.         the time and date that the door was run.  It looks like this:
  171.   
  172.         Run at 21:12:00 on 10/18/1992
  173.  
  174.         As simple as this setup is, there are actually TWO ways to
  175.         implement it.  You COULD put DOORTRAK DOOR.LOG into each batch
  176.         file that calls an online program.  What you would get from this
  177.         is one file called DOOR.LOG with entries generated each time
  178.         each online program was run.
  179.  
  180.         The OTHER alternative is to put a unique FileName.Ext in each
  181.         batch file.  If you have two games, Online Dentist and Online
  182.         Cow-Tipping, you could put DOORTRAK DENTIST.LOG in the batch
  183.         file that calls Online Dentist.  Then put DOORTRAK COW-TIP.LOG
  184.         in the batch file that calls Online Cow-Tipping.  What THIS will
  185.         get you is two separate log files.  The one called DENTIST.LOG
  186.         will contain ONLY the times that Online Dentist was run, and
  187.         COW-TIP log will contain ONLY the times that Online Cow-Tipping
  188.         was run.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.                                       3.
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.            "Door Name"
  206.            ───────────
  207.  
  208.                 This option allows you to have the actual name of the
  209.         door appear in the FileName.Ext file.  It is used in this
  210.         manner:
  211.  
  212.                 DOORTRAK DOOR.LOG "Online Dentist"
  213.  
  214.         Our sample batch file will look this way:
  215.  
  216.                 @ECHO OFF
  217.                 CD\BBS\DOORS\DENTIST
  218.                 DENTIST DENTIST.CFG
  219.                 DOORTRAK DOOR.LOG "Online Dentist"
  220.                 CD\BBS
  221.                 BOARD
  222.  
  223.         The entry in DOOR.LOG will look like this
  224.  
  225.                 Online Dentist run at 21:12:00 on 10/18/1992
  226.  
  227.         If you would like to keep just one file that contains the usage
  228.         of ALL your doors, you will want to utilize DoorTrack in this
  229.         way.
  230.  
  231.            FileTwo.Ext
  232.            ───────────
  233.  
  234.                 Using the FileTwo.Ext flexes the maximum flexibility of
  235.         DoorTrack (hehe).  It allows you to use BOTH of the systems
  236.         described above.  Use the following command lines (in the
  237.         appropriate batch files that call the respective doors):
  238.  
  239.                 DOORTRAK DOOR.LOG "Online Dentist" DENTIST.LOG
  240.                 DOORTRAK DOOR.LOG "Online Cow-Tipping" COW-TIP.LOG
  241.  
  242.         It would appear in our sample batch file this way (this is the
  243.         batch file that calls Online Dentist):
  244.  
  245.                 @ECHO OFF
  246.                 CD\BBS\DOORS\DENTIST
  247.                 DENTIST DENTIST.CFG
  248.                 DOORTRAK DOOR.LOG "Online Dentist" DENTIST.LOG
  249.                 CD\BBS
  250.                 BOARD
  251.  
  252.         The batch file for Online Cow-Tipping would look like this:
  253.  
  254.                 @ECHO OFF
  255.                 CD\BBS\DOORS\COW-TIP
  256.                 COWTIP COWTIP.CFG
  257.                 DOORTRAK DOOR.LOG "Online Cow-Tipping" COW-TIP.LOG
  258.                 CD\BBS
  259.                 BOARD
  260.  
  261.  
  262.  
  263.                                       4.
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.         What you will get from this is THREE files; they will appear like
  272.         this:
  273.  
  274.                  Online Dentist run at 21:12:00 on 10/18/1992
  275.                  Online Cow-Tipping run at 21:45:00 on 10/18/1992
  276.                         (Editor's note-this is in DOOR.LOG)
  277.  
  278.                  Run at 21:12:00 on 10/18/1992
  279.                          (Editor's note-this is in DENTIST.LOG)
  280.  
  281.                  Run at 21:45:00 on 10/18/1992
  282.                          (Editor's note-this is in COW-TIP.LOG)
  283.  
  284.         This allows you to keep a master list of every door run and also
  285.         individual lists for each individual door!!
  286.  
  287.            I/O
  288.            ───
  289.  
  290.                 The I and O options can be used with ANY of the above!
  291.         Using I and O will give you the time that the door was entered
  292.         AND exited so that you can find out exactly how long a user
  293.         spends in a door.  The command line would appear this way:
  294.  
  295.                 DOORTRAK I DOOR.LOG
  296.                         or
  297.                 DOORTRAK O DOOR LOG
  298.  
  299.         It would show up in our example batch file this way:
  300.  
  301.                 @ECHO OFF
  302.                 CD\BBS\DOORS\DENTIST
  303.                 DOORTRAK I DOOR.LOG
  304.                 DENTIST DENTIST.CFG
  305.                 DOORTRAK O DOOR.LOG
  306.                 CD\BBS
  307.                 BOARD
  308.  
  309.         In your FileName.Ext (DOOR.LOG in the above example), you
  310.         will get entries like these:
  311.  
  312.                 Entered at 21:12:00 on 10/18/1992
  313.                 Exited  at 21:32:42 on 10/18/1992
  314.  
  315.         IMPORTANT:  Note that DoorTrack must be run before AND after
  316.         the door so that the correct entries are made.
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.                                       5.
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.            Brain Surgery
  338.            ─────────────
  339.  
  340.                 The most complex usage of DoorTrack would be this:
  341.  
  342.                 DOORTRAK I DOOR.LOG "Online Dentist" DENTIST.LOG
  343.                                 And
  344.                 DOORTRAK O DOOR.LOG "Online Dentist" DENTIST.LOG
  345.                                 WITH
  346.                 DOORTRAK I DOOR.LOG "Online Cow-Tipping" COW-TIP.LOG
  347.                                 And
  348.                 DOORTRAK O DOOR.LOG "Online Cow-Tipping" COW-TIP.LOG
  349.  
  350.         They would appear in the example batch file this way (this is
  351.         the batch file that calls Online Dentist):
  352.  
  353.                 @ECHO OFF
  354.                 CD\BBS\DOORS\DENTIST
  355.                 DOORTRAK I DOOR.LOG "Online Dentist" DENTIST.LOG
  356.                 DENTIST DENTIST.CFG
  357.                 DOORTRAK O DOOR.LOG "Online Dentist" DENTIST.LOG
  358.                 CD\BBS
  359.                 BOARD
  360.  
  361.         The batch file for Online Cow Tipping would look like this:
  362.  
  363.                 @ECHO OFF
  364.                 CD\BBS\DOORS\COW-TIP
  365.                 DOORTRAK I DOOR.LOG "Online Cow-Tipping" COW-TIP.LOG
  366.                 COWTIP COWTIP.CFG
  367.                 DOORTRAK O DOOR.LOG "Online Cow-Tipping" COW-TIP.LOG
  368.                 CD\BBS
  369.                 BOARD
  370.  
  371.         You would get three files (DOOR.LOG, DENTIST.LOG, and
  372.         COW-TIP.LOG) with entries like this:
  373.  
  374.                 Online Dentist entered at 22:55:16 on 12/29/1992
  375.                 Online Dentist exited  at 22:56:18 on 12/29/1992
  376.                 Online Cow-tipping entered at 22:57:19 on 12/29/1992
  377.                 Online Cow-Tipping exited  at 22:59:20 on 12/29/1992
  378.                              (Editor's Note - this is DOOR.LOG)
  379.  
  380.                  Entered at 22:55:16 on 12/29/1992
  381.                  Exited  at 22:56:18 on 12/29/1992
  382.                              (Editor's Note - this is DENTIST.LOG)
  383.  
  384.                  Entered at 22:57:19 on 12/29/1992
  385.                  Exited  at 22:59:20 on 12/29/1992
  386.                              (Editor's Note - this is COW-TIP.LOG)
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.                                       6.
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.         Registration
  404.         ────────────
  405.  
  406.                 DoorTrack is not a free product!  DoorTrack is
  407.         distributed under the Shareware Concept, whereby you are
  408.         permitted a period of evaluation of the program BEFORE you pay
  409.         for it.  If you find that DoorTrack is something you would like
  410.         to keep, you are required to register with the authors directly.
  411.         Keeping in mind that this is a small utility, we have priced it
  412.         at only $5.  This not only registers the program, but we will
  413.         also send you the Registered Version of DoorTrack, which
  414.         includes the additional feature of Total Time:  when you use the
  415.         I and O options, the total time in the door will be included in
  416.         the log automatically!  (You won't BELIEVE how great that is...)
  417.         You will ALSO recieve the COMPANION to DoorTrak, TrackTrim!
  418.         (described below)
  419.  
  420.                 Upon reciept of your registration, we will send you a
  421.         disk with: the latest registered version of DoorTrack, TrackTrim,
  422.         (the DoorTrack companion) and the latest shareware .ZIP of
  423.         DoorTrack for you to make available for download on your BBS.
  424.  
  425.            Fill out the form contained in REGISTER.TXT and mail along
  426.            with your cash, check, or money order to:
  427.  
  428.                         Platypus Programming
  429.                         P.O. Box 6095
  430.                         Terre Haute, IN  47802-6095
  431.  
  432.            Don't forget to make your checks or money orders out to
  433.            Michael Lerch and enclose them with the order form.
  434.  
  435.            TrackTrim
  436.            ─────────
  437.  
  438.                 TrackTrim is the Companion Program to DoorTrack, the
  439.         door usage tracker.  TrackTrim trims the data files used by
  440.         DoorTrack to a fully sysop-configurable size!  Just run
  441.         TrackTrim in your nightly event and tell it the largest size
  442.         you want the data files to reach.  50 lines?  No problem.  100
  443.         lines?  No problem!  TrackTrim can also trim the data files BY
  444.         MONTH!  At the beginning of each month, TrackTrim will start
  445.         your data files over fresh.  Best of all, you can mix and match
  446.         any size with any data file!
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.                                       7.
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.                 TrackTrim is NOT shareware, and is only available to
  470.         registered users of DoorTrack.  It will automatically be sent
  471.         free of charge when DoorTrack registration is recieved.
  472.  
  473.         History
  474.         ───────
  475.  
  476.                 DoorTrack was originally inspired by Mike, who is the
  477.         sysop of Insomnia BBS (812-299-2585).  He wanted a way to keep
  478.         track of which doors were most popular so he could nuke the ones
  479.         that weren't getting played and just for general knowledge, as
  480.         well!  Doug is a Computer Science major at Millikin and took on
  481.         the project.  After a couple of months of ßeta testing,
  482.         DoorTrack was here!
  483.  
  484.         Version -1.0 - Alpha Version: got time and date and listed them to
  485.                a file.  That was about it.
  486.  
  487.         Version -.9ß - Added the second file support and the [I/O]
  488.                support, but did it with extremely large amounts of code.
  489.                Definitely a beta!
  490.  
  491.         Version -.7ß - Totally reconstructed the code to make it much more
  492.                efficient.  Now it starts to become its small, beautiful
  493.                self!
  494.  
  495.         Version  .0ß - The version that got the bugs out of the -.7ß
  496.                version (like when the output files were first created, it
  497.                put the header messages about Platypus Programming into
  498.                them, but then didn't list the time, date, or door name!).
  499.  
  500.         Version  .AßßA - The same as .0ß, only with a couple of
  501.                enhancements and fixes.  This was the wide ßeta-tested
  502.                version.
  503.  
  504.         Version 1.0 - The version you now hold.  If you find any bugs,
  505.                 please write to us at DOORTRACK BUG REPORT, C/O Platypus
  506.                 Programming, P.O. Box 6095, Terre Haute, IN  47802-6095.
  507.  
  508.         ──────
  509.         Thanks
  510.         ──────
  511.  
  512.         To Phantom, sysop of The Wild Side BBS (812-299-9406, WWIVLink
  513.         node @18253), Fireman, sysop of The Star Fire BBS (812-235-9254,
  514.         WWIVLink node @18260 and VirtualNet member) and Parapuke, sysop
  515.         of The Resource Center (812-877-4342, WWIVLink node @18251) for
  516.         Beta testing for us.  Thanks to gUs for proofreading the .DOC!
  517.         (as well as being a great co-sysop).  Thanks to Coffin Man for
  518.         picking up some of the slack on the BBS while we were busy!
  519.  
  520.         We'd also like to give a big thanks for the general BBS
  521.         community of Terre Haute, IN and Decatur, IL for having the
  522.         great BBSs and callers that inspired Platypus Programming and
  523.         Insomnia BBS.  A specific hats off to Nels Anderson, Dennis
  524.         Kreher, and Joe Prosser for their great systems and support.
  525.  
  526.  
  527.                                       8.
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.         A big thanks to Koss Headphones and KLH speakers, too, who have
  536.         kept me company throughout the .DOC writing process. ("Floyd is
  537.         dead, he's nothing but a ripple, 'cause Lilly took that paper
  538.         and sliced him on the nipple").  I'm sure Doug didn't mind that
  539.         Peter Gabriel and Roger Waters both came out with new albums
  540.         while he was coding it, either.
  541.  
  542.         ────────────
  543.         Availability
  544.         ────────────
  545.  
  546.                 The latest version of DoorTrack is always available on
  547.         the following BBS systems:
  548.  
  549.                 Insomnia BBS
  550.                 (812)299-1712
  551.                    Home of Platypus Programming!
  552.                    Node @18262 of the WWIVLink Network
  553.                    Host of Encyclopedia Absurdia
  554.                    Host of the VGA Planets Players' Pub
  555.  
  556.                 )(evious BBS
  557.                 1-508-875-3618 (node 1 ringdown)
  558.                    Four Nodes, 1+ gig PCBoard system
  559.                    *  ATI 2400etc/c MNP/v.42 2400 bps on node 1
  560.                    *  USRobotics Courier HST 9600 bps modem on node 2
  561.                    *  USRobotics Courier HST/Dual Standard HST/v.32
  562.                       modem on node 3
  563.                    *  USRobotics Courier HST/Dual Standard HST/v.32bis
  564.                       modem on node 4
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.                                       9.
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.                              █                   █
  620.                              █                   █
  621.                              █                   █
  622.                              █                   █
  623.                              █                   █
  624.                              █                   █
  625.                              █   ■           ■   █
  626.                              █                   █
  627.                               █                 █
  628.                                █████████████████
  629.  
  630.  
  631.                               Platypus Programming
  632.                          The difference is in the bill
  633.  
  634.