home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / ra / ddoor420.zip / DDOOR.TXT < prev    next >
Text File  |  1993-05-29  |  20KB  |  441 lines
  1.                          ======== ======   =======
  2.                             ==    ==   ==     ===
  3.                             ==    ==   ===   ===
  4.                             ==    ==   ==   ===
  5.                             ==    ======   =======
  6.  
  7.                    =======================================
  8.                    The DeAdZoNe Utilities for RemoteAccess
  9.                    =======================================
  10.                                         
  11.                                      D-DooR
  12.           Top-Door/Top-Door-User Statistics Generator for RemoteAccess
  13.                            Version 4.20   May 24, 1993
  14.                          Copyright Victor Magdic 1991-93
  15.                                All Rights Reserved
  16.                                         
  17.  
  18.  
  19. Description
  20. -----------
  21. D-DooR is a program for RemoteAccess which will automatically track your door
  22. usage, and *who* is using them. It will generate "Top Door" stats, as well as
  23. "Top Door User" stats.  D-DooR 4.20 is designed for use with RemoteAccess 2.00.
  24.  
  25. IMPORTANT:    If you are upgrading from D-DooR version 4.00/4.10 be sure to
  26.               follow these steps before using D-DooR for the first time:
  27.  
  28.               1. Run DDOOR /C
  29.               2. Choose Configuration
  30.               3. Make any necessary changes to the configuration (there are
  31.               several new options) and then save the configuration.
  32.               4. Quit
  33.  
  34.  
  35. Main Features
  36. -------------
  37.    *   Creates two bulletins: A "Top Door" bulletin and a "Top Door User"
  38.        bulletin. The number of doors/users displayed is fully configurable. And
  39.        you can name the bulletins anything you want.
  40.    *   Built in configuration program makes setting up D-DooR a snap.
  41.    *   Supports an exclusion file, which allows you to specify up to 100 names
  42.        or handles which you want excluded from the "Top-Door-User" bulletin.
  43.    *   The Top-Door data file can be easily edited and changed at any time
  44.        using any text editor.
  45.    *   Old users can be purged based on the number of days since they last used
  46.        a door or the total number of doors they have used.
  47.    *   The Top-Door-User and Top-Door counters can be quickly and easily reset.
  48.    *   Shows how many days the statistics cover (e.g. last 50 days).
  49.    *   Supports conditional compiling of the bulletins, so that they are only
  50.        created if the door or user information has been updated. This can be a
  51.        real time-saver for sysops who like to generate the bulletins "on-the-
  52.        fly".
  53.    *   D-DooR will detect if a door is entered more than once in sequence by
  54.        the same user, and will not count it. This is useful for doors that need
  55.        to be entered more than once per call, and it also deters users from
  56.        trying to build up their stats by entering and exiting doors repeatedly.
  57.        This option can be temporarily disabled if necessary.
  58.    *   Supports Handles and Real Names.
  59.    *   Supports up to 250 doors.
  60.    *   Multi-node compatible.
  61.    *   D-DooR is completely free and requires no registration.
  62.  
  63.  
  64. How much does it cost?
  65. ----------------------
  66. This utility is FREE!  If you like it you can continue to use it for as long as
  67. you like free of charge!
  68.  
  69. If you do decide to use it, I would be excited to hear from you !! I encourage
  70. you to send me a postcard at the address listed below (see the end of this text
  71. file), or a message via netmail. It will cost you practically nothing, and will
  72. let me know you're enjoying the program. It will also give me incentive to keep
  73. improving the program and make it even better!
  74.  
  75.  
  76. D-DooR Maintenance Menu
  77. -----------------------
  78. By running DDOOR /C you can invoke the D-DooR maintenance Menu. From this menu
  79. you can configure D-DooR, as well as perform a number of other functions such as
  80. generating reports and resetting door counters.  These specific features will be
  81. explained in more detail below.
  82.  
  83.  
  84. Configuration
  85. -------------
  86. Choose "Configure D-DooR" from the menu and you will be presented with the
  87. configuration menu. Most of the options are self explanatory and only a few will
  88. be described below:
  89.  
  90.  
  91. Include Sysop in         If you want the sysop to be included in the door
  92. bulletin                 statistics turn this option on.
  93.                          
  94. Sysop Name in bulletin   If you want the sysop's name included at the top of the
  95.                          bulletin then turn this option. (Note: the name is use
  96.                          is whatever you have specified under "sysop name".)
  97.                          
  98. Use Handles              Choose YES to use handles when generating the bulletins.
  99.                          Choose NO to use real names.
  100.                          
  101. Use Exclusion File       If you want to use an exclusion file, turn this option
  102.                          on (see discussion on exclusion file later in the docs).
  103.                          
  104. Use Dupe detection       If you want to enable dupe detection turn this option
  105.                          on. (For an explanation of dupe detection see later in
  106.                          the docs).
  107.                          
  108. Date Stamp -Door         D-DooR will keep track of how many days the Door
  109. Bulletin                 statistics cover (e.g. the last 10 days or the last 50
  110.                          days). If you want to change this value you can do so
  111.                          here.
  112.                          
  113.                          Note: when you reset the Door Counters using the
  114.                          maintenance menu, this value is automatically reset to
  115.                          0.
  116.                          
  117. Date Stamp -Door User    D-DooR will keep track of how many days the Door-User
  118. Bulletin                 statistics cover (e.g. the last 10 days or the last 50
  119.                          days). If you want to change this value you can do so
  120.                          here.
  121.                          
  122.                          Note: when you reset the Door-User Counters using the
  123.                          maintenance menu, this value is automatically reset to
  124.                          0.
  125.                          
  126. Colour Scheme            Choose the colour scheme for generating the bulletins.1)
  127.                          Yellow/Red2) Cyan/Magenta3) 3-D shadow effect
  128.                          
  129. Paths and Filenames      Choose this option and you will be presented with
  130.                          another menu where you can define:
  131.                          
  132.                          1. The directory where you want the bulletins created
  133.                          (normally your RA textfiles directory)
  134.                          2. The D-DooR directory (this is useful if you want to
  135.                          keep all the D-DooR data files in a separate directory -
  136.                          otherwise D-DooR will use the main RA directory)
  137.                          3. The filenames of the bulletins which D-DooR will
  138.                          created (i.e. a top-door bulletin, and a top-door-user
  139.                          bulletin). Do not include an extension.
  140.                          
  141. Conditional Compile      Choose whether you want D-DooR to use conditional
  142.                          compiles when generating the bulletins (see discussion
  143.                          of conditional compiling later in the docs).
  144.  
  145.  
  146.  
  147. Door Name Data File
  148. -------------------
  149. You must create a data file called DDOOR ID.DAT which contains formation about
  150. your doors. The file must be a plain ASCII textfile (Note: there is a sample
  151. DDOOR_ID.DAT file included which you can modify to suit your needs).
  152.  
  153. Each door which you want to keep track of has three lines of information
  154. ssociated with it, up to 250 doors can be specified in this way:
  155.  
  156.   Line 1.  Three letter code to identify the door
  157.   Line 2.  The door name (as you want it to appear in the bulletin).
  158.   Line 3.  The number of times the door has been accessed. When you are first
  159.             creating this file, set this value to 0.
  160.   
  161.   Example of DDOOR_ID.DAT:
  162.   
  163.             TW2                 <-- three letter code
  164.             TradeWars 2002      <-- door name
  165.             0                        <-- times used
  166.             AC6
  167.             Alpha Colony 6
  168.             0
  169.             YTR
  170.             Yankee Trader
  171.             0
  172.   
  173.   Comments
  174.   --------
  175.    *   Do not put any blank lines in the data file, and be sure you maintain
  176.        the proper order (id, doorname, times used).
  177.    *   You don't have to start the door counter at 0, you can start it at any
  178.        number you want. For example, if you have been running tradewars for
  179.        some time, you can make an estimate of how many times it has been used
  180.        and put that number in instead.
  181.    *   Since the data file is a plain ASCII text file, you can modify it at any
  182.        time and change the values.
  183.   
  184.   
  185.   Resetting the Door Counters
  186.   ---------------------------
  187.        The Door Counters in DDOOR_ID.DAT can be quickly reset from the
  188.        maintenance menu. This will change ALL the door counters to zero. (Note:
  189.        if for some reason you only want to set *some* of the door counters to
  190.        zero, you can do this manually by editing DDOOR_ID.DAT using a text
  191.        editor.)
  192.   
  193.        To bring up the maintenance menu run DDOOR with the /C switch. You will
  194.        be presented with a menu of choices. Choose "Reset Top Door Data File"
  195.        to reset the door counters.
  196.   
  197.   
  198. USER Data-File
  199. --------------
  200. D-DooR automatically maintains a file called DDOOR_NA.DAT which it uses to keep
  201. track of the Top-Door-Users.  You should not attempt to edit this file yourself
  202. because the results may be unpredictable. If you want to "reset" the top-door-
  203. user statistics you can do so using the D-DooR Maintenance Menu -choose "Reset
  204. Door-User Data File".
  205.   
  206. You can purge users from the User-Data-File based on the number of days since
  207. they last used a door or the total number of doors they have used.  This is done
  208. from the Maintenance utility -choose "Purge User Data File" and then you will be
  209. asked if you want to purge by days or by total.
  210.   
  211.    Note: Door will automatically create a backup file called DDOOR_NA.BAK
  212.          whenever you purge users from the data file. If you change your mind
  213.          after purging users, just copy this file back over the DDOOR_NA.DAT
  214.          file.
  215.  
  216.  
  217. Door User Report
  218. ----------------
  219. You can have D-DooR generate a Top-Door-User report by selecting this option in
  220. the D-DooR maintenance menu.  This report is simply a list of all the users in
  221. the D-DooR data file, as well as a information about how many doors they have
  222. used, and the how many days ago the last use was.  The report is created in a
  223. file called DDRUSER.LST and the directory you have specified as the D-DooR
  224. directory (see configuration above).
  225.  
  226.  
  227. Updating Door Counters
  228. ----------------------
  229. To update the counter for a particular door, run DDOOR in your batch file after
  230. you run the door and specify the three letter ID code that corresponds to that
  231. door on the command line.
  232.  
  233.      Example:  DDOOR AC6      Would update the counter for the door which
  234.                               corresponds to the id code "AC6" (Alpha Colony 6
  235.                               if you were using the example data file shown
  236.                               above)
  237.  
  238.    Comments
  239.    --------
  240.    *   If you enter an ID code that is not defined in the data file
  241.        (DDOOR_ID.DAT) it will simply be ignored.
  242.    *   The ID codes are not case sensitive, so AC6, ac6, and Ac6 would all be
  243.        treated the same.
  244.    *   You can run D-DooR before or after you run the door. If you are running
  245.        under a multi-node set-up and your batch file changes directories to run
  246.        the door, it is recommended that you run D-DooR *before* the door, so
  247.        that it can find the exitinfo.bbs file for that node.
  248.  
  249.  
  250. Dupe Checking
  251. -------------
  252. If you have configured D-DooR to do "Dupe Checking" then it will detect if a
  253. door is entered sequentially by the same user, and will not count it a second
  254. time.
  255.  
  256. You can always temporarily override the global setting by specifying /N after
  257. the three letter door id (this will ignore the dupe checking for the current
  258. door only).
  259.  
  260.     example: DDOOR TW2 /N     Will ignore global dupe checking for the current
  261.                               door update
  262.  
  263.  
  264. Generating Bulletins
  265. --------------------
  266. Bulletins are NOT automatically generated every time you update the door
  267. counter.  This is done in the interest of speed, since generating bulletins
  268. every time a user accesses a door can be time consuming, particularly if you
  269. have a slow hard drive.  (Note: if you want to generate bulletins after every
  270. door a method is explained below.)
  271.  
  272. In order to generate the bulletins you must use the /G parameter on the command
  273. line.
  274.  
  275.                Example:  DDOOR /G
  276.  
  277. This will create four files in the Textfiles directory (as specified in the
  278. configuration menu).  Listed below are the default names, you can change them in
  279. the configuration program.
  280.  
  281.        DDOOR_ID.ANS    Ansi version of Top Doors Bulletin
  282.        DDOOR_ID.ASC    Ascii    "   "   "   "       "
  283.        DDOOR_NA.ANS    Ansi version of Top Door Users Bulletin
  284.        DDOOR_NA.ASC    Ascii  "     "   "   "     "      "
  285.  
  286.  
  287. Generating Stats after each Door
  288. --------------------------------
  289. It is recommended that you generate bulletins at least once per day in your
  290. daily maintenance routine.  If you don't mind the extra delay, and want to
  291. generate new bulletins after every door is used, just generate the bulletins
  292. separately after you update the door counter. For example, your batch file might
  293. look like this:
  294.  
  295.        REM batch file for TW2002 -game one
  296.        @echo off
  297.        cd \ra\doors\tw2002
  298.        tw2002 -qbbs
  299.        cd \ra
  300.        rem update door counter for Tradewars 2002
  301.        DDOOR TW2
  302.        rem generate bulletins
  303.        DDOOR /G
  304.  
  305.  
  306. Conditional Compile
  307. -------------------
  308. If you have configured D-DooR to do conditional compiles (see D-DooR
  309. configuration above) then D-DooR will only generate bulletins if the door or
  310. user stats have changed. This can be a real time-saver if you decide to generate
  311. bulletins "on-the-fly" -i.e. only when a user decides to view them.
  312.    
  313.    
  314. Exclusion List
  315. --------------
  316. D-DooR supports an exclusion list which allows you to specify up to 100 users
  317. which you do not want included in the bulletins. This is useful if have users
  318. (or co-sysops) which you want to "hide" from the bulletins.
  319.  
  320. In order to use this feature you must create a plain ASCII text file called
  321. DDOOR.CTL and simply list the name or handle of the user which you want excluded
  322. (one entry per line). You must also enable "Exclusion File Checking" in the
  323. configuration menu.
  324.    
  325.    Comments
  326.    --------
  327.    *   It is not necessary to specify both a user's real name and their handle
  328.        as separate entries, one or the other will suffice.
  329.    *   The entries in DDOOR.CTL are *not* case sensitive, so if you have "John
  330.        Smith" in your DDOOR.CTL file, and the user's name is actually spelt
  331.        "JoHn SmItH", the name will still be properly excluded.
  332.    *   If you have more than 100 entries in DDOOR.CTL, D-DooR will tell you so
  333.        and abort with an error message.
  334.    
  335.            Example of DDOOR.CTL:
  336.    
  337.                      John Smith
  338.                      Jane Smith
  339.                      The Punisher
  340.    
  341.    
  342. Location of Files
  343. -----------------
  344. In order for D-DooR to function properly, it is essential that you have the RA
  345. environment variable set (for more information on the RA environment variable
  346. see the RA docs).
  347.  
  348. DDOOR.EXE can be placed either in the main RA directory, or anywhere in your
  349. path (if you are running multi-node see below).  The DDOOR data files
  350. (DDOOR_ID.DAT,DDOOR_NA.DAT, and DDOOR.CTL) must go in the directory which you
  351. have specified as the 'D-DooR Directory' in the configuration (by default, this
  352. is the main RA directory -but you can change it to anything you like).
  353.    
  354. D-DooR creates the following temporary files (in the 'D-DooR Directory'):
  355.    
  356.         DDOOR.DUP        Used to detect duplicate door usage by same user.
  357.         DDOOR_ID.TMP     Stores temporary door info. This files is removed when
  358.                          you generate the bulletins.
  359.         DDOOR_NA.TMP     Stores temporary user info. This file is removed when
  360.                          you generate the bulletins.
  361.  
  362.    
  363. Multi-Node Considerations
  364. -------------------------
  365. D-DooR uses information from EXITINFO.BBS to update the door-user counter, and
  366. it will look for EXITINFO in the current directory. This makes multi-node set-
  367. ups easy. All you have to do is run D-DooR from your node directory (where the
  368. exitinfo.bbs will be stored), and D-DooR will handle the rest. It's not
  369. necessary to have a copy of DDOOR.EXE in each node directory, provided that
  370. DDOOR.EXE is somewhere in your path.
  371.    
  372.    NOTE: Because D-DooR must be able to locate the exitinfo.bbs, if your door
  373.          batch file changes directories in order to run the door, it is
  374.          recommended that you run D-DooR before you execute the directory
  375.          change (otherwise D-DooR may not be able to find the files it needs).
  376.        
  377.        example:
  378.        
  379.           rem Game Multi-node  -run ddoor before the door
  380.           DDOOR gam
  381.           cd \ra\doors\game
  382.           game.exe
  383.           exit
  384.        
  385.        
  386. Legal Stuff and Disclaimer
  387. --------------------------
  388. "D-DooR" refers to the executables and documentation in the original
  389. distribution archive. D-DooR is copyrighted material by the author, Victor
  390. Magdic. All rights are reserved.  The author grants you a licence to use this
  391. software free of charge.
  392.  
  393. The program is provided "as is", without warranty or guarantee of any kind,
  394. either expressed or implied, as to its quality or performance. The author will
  395. not be held liable to you or anyone for any direct, indirect, incidental or
  396. consequential damages, including but not limited to any lost profits, or lost
  397. savings which may result from the use or inability to use this program.
  398.  
  399. The author is in no way obligated to provide future versions of this software.
  400.  
  401. Your use of the program constitutes your agreement to these terms and to this
  402. disclaimer.
  403.  
  404. All mentioned products are copyrighted by and/or trademarks of their respective
  405. holders.
  406.  
  407.        
  408. Credits
  409. -------
  410. Thanks to James FitzGibbon for his numerous suggestions, and also for his
  411. invaluable help as a beta tester. Thanks also to Jonathan Rapoport for his
  412. suggestions and bug reports.
  413.  
  414.  
  415. Updates
  416. -------
  417. Please see the enclosed file DEADZONE.TXT for information on how to obtain the
  418. latest version of D-DooR.
  419.  
  420.        
  421. Suggestions always welcome!
  422. ---------------------------
  423. If you have any suggestions for improvement or wish to report any bugs, you can
  424. reach me via netmail:
  425.        
  426.        The DeAdZoNe
  427.        Victor Magdic
  428.        FidoNet: 1:259/427
  429.        TeleNet Canada: 20:22/104
  430.        
  431.        or by writing to:
  432.        
  433.        Victor Magdic
  434.        424 Camden Circle
  435.        Mississauga, Ontario
  436.        L4Z 2P4
  437.        CANADA
  438.        
  439. ------------------------------------------------------------------ end
  440.        
  441.