home *** CD-ROM | disk | FTP | other *** search
/ CD Shareware Magazine 1997 January / CD_shareware_1-97.iso / DOS / COMUNICA / RNRUS105.ZIP / RNRUS.DOC < prev    next >
Encoding:
Text File  |  1996-10-09  |  16.5 KB  |  397 lines
  1.                     TriBBS USERS UTILITY Version 10.0x
  2.                           By: Bertrand Le Guen
  3.                           1995,96 RnR Software
  4.  
  5.                     TriBBS is a copyright of TriSoft
  6.  
  7.                                 WARNING
  8.                                ==========
  9.  RNRUS.EXE   V10.xx will only run with TRIBBS 10.xx
  10.  any other uses of RnRUS normally won't cause you any damage  except
  11.  by wasting your time and may be locking your PC ...
  12.  
  13.  I recommand you to backup your USERS.* file in the MWORK directory
  14.  before using it. RnRUS is working every where by we never knows !
  15.  frightened no ??? :-)
  16.  
  17.                                Disclaimer
  18.                                ==========
  19.  Bertrand Le Guen shall not be held responsible for anything this program 
  20. does or doesn't do to you or your property.
  21.  The only thing i can guaranty you is that it will take space on your hard
  22. drive and won't wake up while you are sleeping to eat everything in your
  23. fridge !
  24.  
  25.                            What is Shareware ?
  26.                            ===================
  27.  The shareware concept is great for both programmer and the end-user. 
  28.  
  29.  The programmers can distribute their products without getting involved 
  30. in expensive marketing or advertising. The end-user benefits by receiving 
  31. a full-featured program, usually better than the commercial competition,
  32. and support available directly from the author. But it only works if the 
  33. end-user participates in the shareware concept.
  34.  
  35.  Shareware is not free. After using RnRUS for the suggested 30 day trial 
  36. period, you must pay for continued use of the program.
  37.  
  38.  I have worked hard to produce a good program and the price is very fair.
  39.  
  40.                                What is it
  41.                               ============
  42. The TriBBS RnR USers Utility makes for you :
  43.  
  44.    * Generates some Bulletins in your nightly event
  45.      - BESTOF : makes your user compete to be the best or not to be the
  46.                 worst depending on how many points you gave him for
  47.                 each action he mades
  48.                 (Post of a message, Upload, Download, Call)
  49.      - BULLET : Makes some statisticals bulletins
  50.           CALBYAGE = Callers By Age
  51.           CALBYCAL = Callers By Number of Calls
  52.           CALBYSEC = Callers By Security Levels
  53.  
  54.    * Makes Your Last Users Bulletin
  55.    * Makes Your New Users Welcome Bulletin
  56.    * Check your last user to see if he drops carrier
  57.  
  58.    * Del users who hasn't logged on since a specified number of days
  59.  
  60. RnRUS won't take care of users who are flagged as : LOCKED OUT or DELETED
  61.  
  62. Read the HISTORY.DOC file or look at the RNRUS.CFG file to see what has
  63. been added/changed whith this version. (thanks ;-) )
  64.  
  65.                              How To Run It
  66.                              =============
  67.  
  68. RNRUS Option Config_file     
  69.  
  70. Option can be one of the followings :
  71.  
  72.    BESTOF  will only process the BESTOF  section of the config file
  73.    BULLET  will only process the BULLET  section of the config file
  74.    BDAY    will only process the BDAY    section of the config file
  75.    USERDEL will only process the USERDEL section of the config file
  76.  
  77.    LASTUS  will only process the LASTUS  section of the config file
  78.    NEWUS   will only process the NEWUS   section of the config file
  79.    DROPCAR will only process the DROPCAR section of the config file
  80.  
  81.    ALL     will process all the sections founded in the config file
  82.            except the GOODBYE one (NEWUS,DROPCAR, LASTUS)
  83.            Usefull if you use it in a nightly batch event !
  84.  
  85.    GOODBYE will process section that will be executed in the
  86.            GOODBYE.BAT : NEWUS,DROPCAR and LASTUS
  87.  
  88.    ERRORS  will list the exit error codes
  89.  
  90. example : RNRUS DROPCAR C:\TRIBBS\UT\RNRUS\RNRUS.CFG
  91. (if you've named your config file RNRUS.CFG, you can omit to specify it !
  92. in this case, just type : RNRUS option)
  93.  
  94. If you forgot everything, just type RNRUS to have some helps :-)
  95.  
  96.                            How To Configure It
  97.                            ===================
  98.  
  99. ==================-------------------------------------------------------
  100. The Configuration File
  101. ==================-------------------------------------------------------
  102. the config file is separated in multiple section which are :
  103. [INIT]    which contains information needed by the program
  104. [BULLET]  which contains information for making the bulletins
  105. [BESTOF]  which contains information for making the Best Of Bulletin
  106. [USERDEL] which contains information for deleting users
  107. [DROPCAR] which contains information for cheching drop carrier
  108. [LASTUS]  which contains information for making last users bulletin
  109. [NEWUS]   which contains information for making new  users bulletin
  110. [END]     mark the end of the config file
  111.  
  112. for an example of config file look at the file RNRUS.CFG.
  113. You'll see the one that is working on my BBS.
  114.  
  115. ==================-------------------------------------------------------
  116. The INIT section
  117. ==================-------------------------------------------------------
  118. [INIT]    Specifies the beginning of the init section
  119. bbs     = Specifies BBS Name or Heading
  120. sysop   = Specifies Sysop Name
  121. regcode = the famous registration code !B-]
  122. path    = Path to Node 1 WITH Trailing backslash
  123. path2nod= Path to current Node (used by the LOGON section to locate
  124.           the TRIBBS.SYS file created for the on-line user)
  125. display = Path to Display Directory WITH Trailing BackSlash
  126.           this statement is only used by the screen section, so you can
  127.           specify an other directory than your main TriBBS directory if
  128.           you want to test it !!
  129. nocprght= Specifies if you want or not all the copyright notice to be
  130.           include in the list or screen created by RnRUS !
  131.           Choice are : Y or N
  132.  
  133.  
  134. ==================-------------------------------------------------------
  135. The BESTOF section
  136. ==================-------------------------------------------------------
  137. [BESTOF]  Mark the beginning of the Best Of Bulletin Maker Section
  138. clrhead = Specifies PCB colour code for the title                (def=@X09)
  139. clrrank = Specifies PCB colour code for Rank Number              (def=@X0E)
  140. clrname = Specifies PCB colour code for User Name                (def=@X0A)
  141. clrmsgs = Specifies PCB colour code for User Number of Message   (def=@X0E)
  142. clrdnld = Specifies PCB colour code for User Number of Download  (def=@X0E)
  143. clrupld = Specifies PCB colour code for User Number of Upload    (def=@X0E)
  144. clrcall = Specifies PCB colour code for User Number of Calls     (def=@X0E)
  145. clrpnts = Specifies PCB colour code for User Points              (def=@X0C)
  146.  
  147. minsec  = Specifies the minimum security level the user must have to be
  148.           Included in the bulletin
  149. maxsec  = Specifies the maximum security level the user must have to be
  150.           Included in the bulletin
  151. maxuser = Specifies the maximum number of users that will be listed in the
  152.           bulletin
  153.  
  154.  
  155. msgspnt = Specifies the number of points that you will give your users
  156.           for each message posted
  157. dnldpnt = Specifies the number of points that you will give your users
  158.           for each file downloaded
  159. upldpnt = Specifies the number of points that you will give your users
  160.           for each file uploaded
  161. callpnt = Specifies the number of points that you will give your users
  162.           for each call
  163.  
  164. bullet  = Specifies the name of the bullet that RnRUS will create
  165.           (Without path and extention, ex : BULLET1)
  166.           this option tells RnRUS to Start processing and must be the
  167.           last one of the section
  168.  
  169. ==================-------------------------------------------------------
  170. The BULLET section
  171. ==================-------------------------------------------------------
  172. [BULLET]  Specifies the beggining of the BULLET section
  173. calbycal= Specifies the name of the bullet that RnRUS will create
  174.           (Without path and extention, ex : BULLET1)
  175.           This bulletin will show you a statistical display of your users
  176.           sort by number of calls
  177. calbyage= Specifies the name of the bullet that RnRUS will create
  178.           (Without path and extention, ex : BULLET1)
  179.           This bulletin will show you a statistical display of your users
  180.           sort by age
  181. calbysec= Specifies the name of the bullet that RnRUS will create
  182.           (Without path and extention, ex : BULLET1)
  183.           This bulletin will show you a statistical display of your users
  184.           sort by security levels.
  185.  
  186. ==================-------------------------------------------------------
  187. The DELUSER section
  188. ==================-------------------------------------------------------
  189. [DELUSER] Mark the beginning of the Best Of Bulletin Maker Section
  190. markdel  = Specifies if RnRUS must mark as deleted user who hasn't
  191.            logged on since the number of days specified by 'daysago='
  192.            Choice are : Y or N
  193.            If you choose N, then RnRUS will only make the report
  194.            specified by 'sendnote='
  195.  
  196. minsec  = Specifies the minimun security level that the user must have
  197.           to be listed in the bullet
  198. maxsec  = Specifies the maximun security level that the user must have
  199.           to be listed in the bullet
  200.  
  201. logon   = Specifies the name of the logon note that is to be created
  202.           (Without path and extention, ex : '1' if you want the sysop
  203.            to receive the report)
  204.  
  205. daysago = Specifies the number of days before RnRUS must look to tell
  206.           a user must be reported or mark as deleted
  207.           this option tells RnRUS to Start processing and must be the
  208.           last one of the section
  209.  
  210.  
  211. ==================-------------------------------------------------------
  212. The DROPCAR section
  213. ==================-------------------------------------------------------
  214. [DROPCAR]
  215. minsec  = Specifies the minimum security level the user must have to 
  216.           receive a drop note
  217. maxsec  = Specifies the maximum security level the user must have to 
  218.           receive a drop note
  219. sendnote= Specifies the complete path and name (without extention) of
  220.           the note that RnRUS will send to the user if he has droppped
  221.           Carrier.
  222.           If RnRUS search for a .BBS and a .ANS note to send
  223.           I've included in this package the file DRACDROP which are the
  224.           file (DROP.BBS and DROP.ANS) i'm sending to my users
  225. user    = @USER@ (Internally use of RnRUS, Specifies that RnRUS can
  226.                   start processing)
  227.  
  228.  
  229. You MUST use the DROPCAR option in the GOODBYE.BAT  file.
  230.  
  231. Example : GOODBYE.BAT
  232.         cd \tribbs\ut\rnrus
  233.         RnRUS DROPCAR
  234.         cd \tribbs
  235.         board
  236.  
  237. if you are using the LASTUS, NEWUS and DROPCAR section you can use
  238. the GOODBYE option
  239.  
  240. Example : GOODBYE.BAT
  241.         cd \tribbs\ut\rnrus
  242.         RnRUS GOODBYE
  243.         cd \tribbs
  244.         board
  245.  
  246.  
  247. ==================-------------------------------------------------------
  248. The LASTUS section
  249. ==================-------------------------------------------------------
  250. [LASTUS]  Specifies the beginning of the LASTUS section
  251. clrhead = Specifies the PCB colour code for the Heading         (def=@X1F)
  252. clrcallt= Specifies the PCB colour code for the Total BBS calls (def=@X0B)
  253. clrcalld= Specifies the PCB colour code for the BBS day calls   (def=@X09)
  254. clrname = Specifies the PCB colour code for the log on  name    (def=@X0C)
  255. clrdate = Specifies the PCB colour code for the log on  date    (def=@X0E)
  256. clron   = Specifies the PCB colour code for the log on  hour    (def=@X0E)
  257. clroff  = Specifies the PCB colour code for the log off hour    (def=@X0E)
  258. clrspeed= Specifies the PCB colour code for the log on  speed   (def=@X0A)
  259.  
  260. minsec  = Specifies the minimun security level that the user must have
  261.           to be listed in the bullet
  262. maxsec  = Specifies the maximun security level that the user must have
  263.           to be listed in the bullet
  264. maxuser = Specifies the maximum number of users that will be listed in the
  265.           bulletin
  266.  
  267. logon   = Specifies the name of the logon note that is to be created
  268.           (Without path and extention, ex : LOGON3)
  269. bullet  = Specifies the name of the bullet that is to be created
  270.           (Without path and extention, ex : BULLET1)
  271.  
  272. user    = @USER@ (Internally use of RnRUS, Specifies that RnRUS can
  273.                   start processing)
  274.  
  275. !!! You MUST use the LASTUS option in the GOODBYE.BAT  file. !!!
  276.  
  277. Example : GOODBYE.BAT
  278.         cd \tribbs\ut\rnrus
  279.         RnRUS LASTUS
  280.         cd \tribbs
  281.         board
  282.  
  283. if you are using the LASTUS, NEWUS and DROPCAR section you can use
  284. the GOODBYE option
  285.  
  286. Example : GOODBYE.BAT
  287.         cd \tribbs\ut\rnrus
  288.         RnRUS GOODBYE
  289.         cd \tribbs
  290.         board
  291.  
  292.  
  293. ==================-------------------------------------------------------
  294. The NEWUS section
  295. ==================-------------------------------------------------------
  296. [NEWUS]
  297. clrhead = Specifies the PCB colour code for the Heading         (def=@X1F)
  298. clrname = Specifies the PCB colour code for the log on  name    (def=@X0C)
  299. clrdate = Specifies the PCB colour code for the log on  date    (def=@X0E)
  300. clrspeed= Specifies the PCB colour code for the log on  speed   (def=@X0A)
  301.  
  302. maxuser = Specifies the maximum number of users that will be listed in the
  303.           bulletin
  304.  
  305. logon   = Specifies the name of the logon note that is to be created
  306.           (Without path and extention, ex : LOGON3)
  307. bullet  = Specifies the name of the bullet that is to be created
  308.           (Without path and extention, ex : BULLET1)
  309.  
  310. user    = @USER@ (Internally use of RnRUS, Specifies that RnRUS can
  311.                   start processing)
  312.  
  313. !!! You MUST use the NEWUS option in the GOODBYE.BAT  file. !!!
  314.  
  315. Example : GOODBYE.BAT
  316.         cd \tribbs\ut\rnrus
  317.         RnRUS NEWUS
  318.         cd \tribbs
  319.         board
  320.  
  321. if you are using the LASTUS, NEWUS and DROPCAR section you can use
  322. the GOODBYE option
  323.  
  324. Example : GOODBYE.BAT
  325.         cd \tribbs\ut\rnrus
  326.         RnRUS GOODBYE
  327.         cd \tribbs
  328.         board
  329.  
  330.                             Future Versions
  331.                             ===============
  332.  
  333. I'm thinking of adding in RnRUS :
  334.  A user birthday greater
  335.  A user password error checker (if the user has made 3 password errors
  336.   then RnRUS will mark him for delete or send him a warning note)
  337.  
  338. if you see something that could improve this one then request me all
  339. the features that you have in mind (see at the end of this documentation
  340. how to contact me)
  341.  
  342.  
  343.                         Registration Information
  344.                         ========================
  345.  Unregistered copies are completely functional.
  346.  You will only see the smallest "Evaluation Version" that you've ever seen
  347.  at the beginning of the display screen, cause I HATE soft that makes you
  348.  fell like a robber.
  349.  You will also have to wait 15 seconds at the end of the computing
  350.  (except in GOODBYE mode cause I hate softs that makes your users pay for
  351.  a soft that their sysop didn't register)
  352.  
  353.  This lets you test the program with its true look and feel.
  354.  
  355.  Please encourage me to continue this policy by registering.
  356.  
  357.  RnRUS registration is only $15 like all the RnR softwares ....
  358.  Not too expensive isn't it ??
  359.  
  360.  (Print out REGISTER.FRM for complete ordering information)
  361.  
  362.  After i receive your registration form, you will receive an activation code. 
  363. Because the program is not crippled, the effect your activation code will 
  364. have, will be the elimination of the noisy and annoying shareware message 
  365. and the program will be shown as Registered on the file's listing.
  366.  
  367.  You will also be able to add a statement in the config file that will
  368. suppress all advertisements and copyrights from RnRUS in your screen and
  369. listing.
  370.  
  371.  
  372.                             Support & Contact
  373.                             =================
  374.  
  375. Support may be found on :
  376.  
  377.  - Blue Suede Shoes BBS (33-1) 53 79 01 44 (France)
  378.  - TriBBS Support echo on WME and FIDO. 
  379.  - Fidonet  Netmail 2:320/310 
  380.  - InterNet E-mail at leguen@musical.fdn.org
  381.  
  382.                                  Thanks
  383.                                  =======
  384. All of you that have already registered some RnR software and helps me
  385.  going on devellopements for TriBBS utilities.
  386. Joel Beernaert for
  387.  - being the first one to register RnRFL, RnRUS and RnRMS
  388. Jean-Philippe Luiggi for
  389.  - Showing me TRIBBS and helping me setting it up
  390.  - testing RnRUS and giving me some idea to improve it
  391. Mark Goodwin for
  392.  - TriBBS of course ;-)
  393.  - Continuously improving TriBBS to make it the best and cheaper BBS
  394.    software
  395. My wife for
  396.  - Stopping shouting at me sometimes when I'm working on my computer :-)
  397.