home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / RAI119G.RAR / RAINFO.DOC < prev    next >
Text File  |  1993-03-19  |  15KB  |  463 lines
  1.  
  2.        RAInfo
  3.  
  4.        Last Change: 19 Mar. 93
  5.        Copyright 1992, 1993 by Duncan McNutt
  6.        FIDO: 2:249/100
  7.  
  8.        For the German documentation please read RAInfo.DOK (with a K)
  9.  
  10.  
  11.  
  12. -----------------------------------------------------------------------
  13.  
  14.  
  15. Contents:
  16.   I. What is RAInfo
  17.     What do I need to know?
  18.     Features
  19.     Registration
  20.     Liability
  21.  
  22.   II. Installation
  23.  
  24.   III. Usage
  25.  
  26.   IV. Configuration
  27.     ANSI & ASCII
  28.     Example Menus
  29.     Sysop Information
  30.     Language Support
  31.     General
  32.  
  33.   V. Technical Information
  34.  
  35.   VI. History:
  36.  
  37.  
  38.  
  39. -----------------------------------------------------------------------
  40.  
  41. I. What is RAInfo:
  42. ~~~~~~~~~~~~~~~~~~
  43.  
  44. RAInfo is an information program for the Remote Access BBS system.  It
  45. works with version 2.0 of Remote Access or newer.  (For Remote Access
  46. versions prior to version 2.0 please use RAInfo version 1.10)
  47.  
  48. Among other things, it supplies you with statistics (in ANSI and ASCII
  49. format) as well as information intended only for the Sysop.
  50. fully configurable and replaces all statistics and information programs
  51. known to me.
  52.  
  53.  
  54. What do I need to know?
  55. -----------------------
  56.  
  57. This documentation is need-to-know for advanced Sysops as well as
  58. beginners!  Please skim through it at least once.
  59.  
  60. The most important chapters are I, II and III.
  61.  
  62. Features
  63. --------
  64.  
  65. Chapter IV has a complete description of the Features.
  66.  
  67.  o  Totally configurable
  68.     -  Which lists should be made
  69.     -  colors and character set
  70.     -  different languages
  71.     -  and a lot more...
  72.  o  Complete statistics
  73.       - All of the possible top 10 lists
  74.       - Top 10 summary
  75.       - Language usage report
  76.       - User level report
  77.       - User status report
  78.       - Feature report
  79.       - Sysop defined features report
  80.       - Exclude of certain file areas
  81.       - Exclude of certain files (*)
  82.       - Birthday list (*)
  83.  o  Sysop defined user levels
  84.  o  Sysop defined user statuses
  85.  o  Output in multiple languages (*)
  86.  o  A quick update feature to update the statistics after every user
  87.      logoff (*)
  88.  o  Separate user and sysop lists
  89.  o  Additional sysop information
  90.       - System usage:
  91.          - Timelog and Event report (you see what effect the events have
  92.             on the system usage)
  93.          - Information about file and message areas
  94.          - LIMITS.CTL and flag reports.
  95.          - Shells called (*)
  96.          - Up/Downloads, average effeciency/cps/KB (*)
  97.          - Transfer protocoll usage (*)
  98.          - Messageareas used (*)
  99.          - Fileareas browsed (*)
  100.          - New Users (*)
  101.          - Deleted Users (*)
  102.          - Connects, Logons, Logoffs, Aborts... (*)
  103.       - User reports on:
  104.           - Age
  105.           - Password length
  106.           - Correctness of dates in the user database
  107.       - Warnings when certain limits have been reached (*)
  108.  o share is fully supported (used in networks and multitasking environments)
  109.  o CD-ROM support
  110.  o Messages to users and sysop
  111.       - Happy birthday to user (*)
  112.       - Welcome to new user (*)
  113.       - Thanks for upload (*)
  114.       - RAIShort to Sysop (*)
  115.  
  116. The features marked with a (*) are only available in the registered version.
  117.  
  118. Note that the unregistered features are already much more than any other
  119. program will give you.
  120.  
  121.  
  122. Registration
  123. ------------
  124.  
  125. When you register the program you have access to additional features.
  126.  
  127. Registration is possible via a bank transfer of US $15.- (DM 25.-) to
  128. Duncan McNutt, Dresdner Bank 6368-Bad-Vilbel, bank number: 50080000,
  129. account number: 621736900.  Eurochecks and cash can be sent to: Duncan
  130. McNutt, Am Bier 9, D-6000 Frankfurt 50, Germany.  The registration will
  131. last up to version 2.9.
  132.  
  133. If you do not have a FIDO EMail address I can send your Key to, then you
  134. must add a self addressed envelope.
  135.  
  136.  
  137. Liability
  138. ---------
  139.  
  140. I make no garantees to the suitability of this program for any
  141. purpose.  It proves useful to me and my beta testers, so I suspect it
  142. will do the same for you.  
  143.  
  144.  
  145.  
  146. -----------------------------------------------------------------------
  147.  
  148. II. Installation:
  149. ~~~~~~~~~~~~~~~~~
  150.  
  151. 1) Place the files in an empty directory.
  152.  
  153. 2) Rename one of the .LNG files in RAINFO.LNG.
  154.  
  155. 3) The environment variable RA must be set, this is required for the
  156. proper operation of Remote Access as well.
  157.  
  158. 4) Configure the program with "RAIConf", suitable defaults are given but
  159. you may want to change those, see chapter IV for detailed information.
  160.  
  161. 5) If you want to it generate messages (registered version only) in your
  162. BBS you need to install MBUtil (part of the GEcho mail package).
  163. Otherwise you are finished.
  164.  
  165. To set up MBUtil you need to set an Environment variable GE that points to
  166. the direktory in which you have MBUtil files.  Then you call GSetup and
  167. fill out the following information:
  168.      - System data.Pathnames
  169.      - System data.Origin lines
  170.      - Miscellaneous.Global Options
  171.      - Miscellaneous.MBUtil Options
  172. MBUtil must be in the PATH for RAInfo to find it.
  173.  
  174.  
  175. The Files:
  176. ----------
  177.  
  178. RAInfo.Doc        this documentation
  179.  
  180. RAIinfo.Exe       the program
  181. RAIConf.Exe       the configuration program
  182.  
  183. English.Lng and
  184. German.Lng        The Language definition files, these do not normally need
  185.                   to be changed.  One should be renamed RAINFO.LNG and 
  186.                   reside in the directory in which you installed RAInfo.
  187.  
  188. Stats.*           example menu for your Remote Access.
  189.  
  190.  
  191.  
  192. -----------------------------------------------------------------------
  193.  
  194. III. Usage:
  195. ~~~~~~~~~~~
  196.  
  197. 1) To try it out just run RAINFO.EXE (with or without -s).  You must
  198. run rainfo from the directory in which you installed.
  199.  
  200. It generates ANSI and ASCII statistics for your users in your default
  201. text directory, these are called 'RAI_xxxx.ASC' and 'RAI_xxxx.ANS'. It
  202. also generates a file called RAILONG.TXT which is intended for the
  203. Sysop.
  204.  
  205. If you type in something wrong RAInfo will display the following:
  206.  
  207.     Usage: RAINFO [-s | -u | -q]
  208.  
  209.       -s  Print out stats for SysOp only.
  210.       Only the short report to the screen and the RAILONG.TXT are
  211.       generated.
  212.  
  213.       -u  Print out stats for users only.
  214.       Only the .ANS/.ASC files are generated.
  215.  
  216.       -q  quick, only do those user stats that may have changed by a
  217.       user login.  Use this after a user has logged out of the BBS.
  218.           (This option is only available when you have registered).
  219.  
  220.       It does NOT do the file area reports, this is because reading
  221.       the FILES.BBS slows things down too much.
  222.  
  223.  
  224. 2) Installing RAInfo into your batch files...
  225.  
  226.    - In your daily maintenance batch:
  227.  
  228.       REM  RAInfo, Sysop Info in RAILong.TXT and RAIShort.TXT
  229.       cd\ra\util\rainfo
  230.       rainfo
  231.  
  232.    - In the registered version you can add a quick update feature.
  233.      In the BBS batch file, right after the user leaves the BBS add
  234.      the following:
  235.  
  236.       REM RAInfo, get user statistics up to date
  237.       REM   error messages go into the system log
  238.       cd\ra\util\rainfo
  239.       rainfo -q >> \ra\ra.log
  240.  
  241.  
  242.  
  243. -----------------------------------------------------------------------
  244.  
  245. IV. Configuration:
  246. ~~~~~~~~~~~~~~~~~
  247.  
  248. ANSI & ASCII
  249. ------------
  250.  
  251. The program generates ANSI and ASCII files for the user. These can
  252. contain IBM graphic characters if you wish and your choice of colors.
  253. This way the individual "look" of your BBS extends to these displays.
  254.  
  255. In the ASCII output you can choose whether the form feed character
  256. should be set at the beginning or not.
  257.  
  258. You can call up the displays individually via a Type 45 menu entry, or
  259. all at once as one big listing.  If you choose the latter you must
  260. leave out the form feed character in the ASCII files.
  261.  
  262.  
  263. Example Menu
  264. ------------
  265.  
  266. If you wish to show the statistics using a menu, you can use the
  267. supplied menu Stats.MNU and Stats.A* as a starting point.
  268.  
  269. The example stats menu assumes that: new users have a user level of 5,
  270. registered users have a level of at least 9 and the users who have
  271. acces to the complete file base have a level of 50 or more.  You should
  272. change these user level settings as appropiate for your own system.
  273. The prompt is set up in such a way so that the user can see which
  274. options are available to him.  This is a feature Andrew built into RA
  275. for me, so you can see it pays to register your software.
  276.  
  277.  Example for the batch file if you choose to have one large listing:
  278.       cd\ra\util\rainfo
  279.       rainfo > raishort.txt
  280.       cd \ra\txtfiles
  281.       del rai_long.ans
  282.       REM Echo a Control-L into rai_long.asc to clear screen
  283.       echo ^L>rai_long.asc
  284.       for %f in (rai_*.asc) do type %f >>rai_long.asc
  285.       for %f in (rai_*.ans) do type %f >>rai_long.ans
  286.  
  287. The following files are generated:
  288.  
  289. rai_fld.a*       File areas with the most downloads           (Top 10)
  290. rai_fls.a*       File areas with the most files               (Top 10)
  291. rai_afld.a*      All file areas with the most downloads       (Top 10)
  292. rai_afls.a*      All file areas with the most files           (Top 10)
  293. rai_tpf.a*       The most popular files                       (Top 10)
  294. rai_atpf.a*      The most popular files (all)                 (Top 10)
  295.  
  296. rai_mesg.a*      The message areas with the most messages     (Top 10)
  297.  
  298. rai_call.a*      The users who call the most                  (Top 10)
  299. rai_dl.a*        The users who download the most              (Top 10)
  300. rai_dlk.a*       The users who download the most (KB)         (Top 10)
  301. rai_mswr.a*      The users who write the most online
  302.                   messages                                    (Top 10)
  303. rai_upl.a*       The users who write upload the most          (Top 10)
  304. rai_uplk.a*      The users who write upload the most (KB)     (Top 10)
  305.  
  306. rai_t10s.a*      Summary, minimum/maximum of the top 10 lists
  307.  
  308. rai_sysl.a*      The sysop defined user levels
  309. rai_syss.a*      The sysop defined user statuses
  310. rai_sysf.a*      Usage report of the sysop defined features
  311. rai_feat.a*      Usage report of the RA features
  312. rai_lang.a*      Language usage report
  313. rai_birt.a*      Birthday list
  314.  
  315.  
  316. Sysop Information
  317. -----------------
  318.  
  319. The sysop gets a summary in the file RAIShort.TXT, this can be postet
  320. as a message to an area of your chioce.
  321.  
  322. A complete output of all information is in the file RAILONG.TXT, the
  323. contents of this file are not suitable for BBS Users.
  324.  
  325. I believe the output explains it self.
  326.  
  327.  
  328. Languages
  329. ---------
  330.  
  331. In the registered version, RAInfo checks each text file directory for a
  332. file named RAINFO.LNG.  If one is found it is used to generate .ANS and
  333. .ASC files in that directory.
  334.  
  335. If one or more text file directories do not contain a RAINFO.LNG file
  336. then the .ASC and .ANS files are generated in the default text file
  337. directory using the RAINFO.LNG found in the RAInfo installation
  338. directory.
  339.  
  340.  
  341. General
  342. -------
  343.  
  344. What is generated:
  345.  
  346. You can control which information or statistics are generated in the
  347. configuration.  Not all information is output in the user .ASC/.ANS
  348. files, some information is generated for the sysop only.
  349.  
  350. TOP 1:
  351.  
  352. If the sysop does not want to get all those Top 10 listings he can just
  353. get the top entry of those that he generates for his users.  This way
  354. he at least knows the most important details.  This is the "Top 1"
  355. entry in the configuration.
  356.  
  357. Exclude Files:
  358.  
  359. In the registered version you can exclude up to 20 files (by name) from
  360. the top 10 lists.  This is usefull for files such as the BBS file
  361. list.
  362.  
  363. Exclude File Areas:
  364.  
  365. For the Top 10 File Areas you can exclude up to 30 file areas.  Two
  366. different reports are then generated, one with all file areas and one
  367. without the excluded areas.  The sysop can display whichever one he
  368. chooses.  This is usefull if you have private file areas (eg: private
  369. user group or maintenance areas).
  370.  
  371. User Levels, User Statuses and Sysop Features:
  372.  
  373. The Sysop can define his own user levels, user statuses and feature
  374. definitions.  The following reports are controlled by entering user
  375. levels, flags, group status and subscription status.
  376.  
  377.     - User Levels: you can define which flags and levels a user must
  378.       have to be rated at a certain level.
  379.  
  380.     - User Statuses: you can define which flags and levels a user must
  381.       have to rate a certain status.  Example: users who have an "over
  382.       18" or "subscribing user" status.
  383.  
  384.     - Sysop Defined Features: often sysops add features of their own,
  385.       by using such mechanisms as the security flags.  These can also be
  386.       displayed.  Example: if a certain flag is set the user gets a
  387.       list of online users when he logs in to the system.
  388.  
  389.  
  390.  
  391. -----------------------------------------------------------------------
  392.  
  393. V. Technical Information:
  394. ~~~~~~~~~~~~~~~~~~~~~~~~~
  395.  
  396. The following files are searched:
  397.  
  398.     config.ra
  399.     events.ra
  400.     timelog.bbs
  401.     files.ra
  402.     <file area paths>\files.bbs
  403.     language.ra
  404.     limits.ctl
  405.     messages.ra
  406.     msgidx.bbs
  407.     msginfo.bbs
  408.     users.bbs
  409.     usersxi.bbs
  410.     protocol.ra
  411.     ra.log
  412.  
  413. Sharing is supported, so multitasking an networks are not a problem.
  414.  
  415. The file list paths are searched correctly so CD-ROMs are not a problem.
  416.  
  417. It only runs with DOS 3.0 or newer.
  418.  
  419. The following is not available without a registration key:
  420.  
  421.        o Multilanguage Support
  422.        o The -q (Quick) command line option
  423.        o Comments (warnings)
  424.        o Exclude of certain files by name from the top 10 lists
  425.          ! Exclude of file areas is possible !
  426.        o Birthday list
  427.        o Messages
  428.        o Some of the sysop reports
  429.  
  430.  
  431.  
  432. -----------------------------------------------------------------------
  433.  
  434. VI. History:
  435. ~~~~~~~~~~~~
  436.  
  437. Version 1.00:  Initial Release
  438.  
  439. Version 1.01:  Speed up and documentation fix
  440.  
  441. Version 1.10:
  442.   Protocoll.RA and Logfile are evaluated
  443.   Sperate configuration program, compeltely rewritten with more options
  444.   User data speedup by a factor of 5
  445.   Messages to users and sysop
  446.     - Happy birthday to user
  447.     - Welcome to new user
  448.     - Thanks for upload
  449.     - RAIShort an Sysop
  450.   Key is placed in a separate file.
  451.   Bugfixes:
  452.     - Top10 Summary on -Q fixed
  453.     - Files.BBS counter logik improved, works with more external file doors
  454.     - Age calculation of the users corrected
  455.     - Some spelling mistakes fixed
  456.     - Config bugs fixed by rewrite
  457.     - Percent values now shown correctly if 100% or 0%
  458.  
  459. Cheers,
  460.   Duncan McNutt
  461.  
  462. <End Of Text>
  463.