home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / RAI119G.RAR / RAINFO.DOK < prev    next >
Text File  |  1993-03-19  |  15KB  |  472 lines
  1.  
  2.        RAInfo
  3.  
  4.        Letzte Änderung: 19. März 93
  5.        Copyright 1992, 1993 by Duncan McNutt
  6.        FIDO: 2:249/100
  7.  
  8.        For the English documentation please read RAInfo.DOC (with a C)
  9.  
  10.  
  11.  
  12. -----------------------------------------------------------------------
  13.  
  14.  
  15. Inhalt:
  16.   I. Was ist RAInfo
  17.     Was muß ich wissen?
  18.     Features
  19.     Registrierung
  20.     Haftung
  21.  
  22.   II. Installation
  23.  
  24.   III. Aufruf
  25.  
  26.   IV. Konfiguration
  27.     ANSI & ASCII
  28.     Beispiel Menü
  29.     Sysop Informationen
  30.     Sprachen
  31.     Allgemein
  32.  
  33.   V. Technische Informationen
  34.  
  35.   VI. History:
  36.  
  37.  
  38.  
  39. -----------------------------------------------------------------------
  40.  
  41. I. Was ist RAInfo:
  42. ~~~~~~~~~~~~~~~~~~
  43.  
  44. RAInfo ist ein Informations Programm für das BBS System Remote Access.
  45. Es arbeitet mit der Version 2.x von Remote Access oder neuer. (Für
  46. ältere Versionen von RA bitte verwenden sie RAInfo 1.10).
  47.  
  48. Ausgegeben werden unter anderem Statistiken (in ASCII und ANSI Format)
  49. sowie Informationen die nur für den Sysop von Interesse sind. Es ist
  50. voll konfigurierbar und ersetzt alle mir bekannten Statistik und
  51. Informations Programme.
  52.  
  53. Was muß ich Wissen?
  54. -------------------
  55.  
  56. Diese Dokumentation ist auch für den geübten Sysop unbedingt notwendig,
  57. ich möchte darum bitten sie zumindest kurz zu überfliegen.
  58.  
  59. Am wichtigsten sind Kapitel I, II und III.
  60.  
  61. Features
  62. --------
  63.  
  64. Kapitel IV enthällt eine genaue Beschreibung der Features.
  65.  
  66.  o  Voll konfigurierbar
  67.     -  Welche Listen werden gemacht
  68.     -  Farben und Zeichensatz
  69.     -  Sprache
  70.     -  und viel mehr...
  71.  o  Komplette Statistiken
  72.       - Alle möglichen Top 10 Listen
  73.       - Top 10 Zusammenfassung
  74.       - Sprachbenutzungs Report
  75.       - Userlevel Report
  76.       - Userstatus Report
  77.       - Feature Report
  78.       - Sysop definierte Feature Report
  79.       - Exclude von bestimmte Fileareas
  80.       - Exclude von bestimmten Files (*)
  81.       - Geburtstags Liste (*)
  82.  o  Sysop definierte Userlevel
  83.  o  Sysop definierte Userstatus
  84.  o  Mehrsprachige Ausgaben (*)
  85.  o  Ein Quick Modus für ein update der Statistiken nach jedem User-
  86.     Logoff (*)
  87.  o  Getrennte User / Sysop Listen
  88.  o  Zusätzliche Sysop Informationen
  89.       - System Auslastung:
  90.          - Timelog und Event Auswertung (man sieht welchen Einfluss
  91.             Events auf das System haben)
  92.          - Informationen über Fileareas und Nachrichtenbretter
  93.          - LIMITS.CTL und Flags Auswertung.
  94.          - Shells aufgerufen (*)
  95.          - Up/Downloads, durchschnittliche Effizienz/cps/KB (*)
  96.          - Transferprotocoll Auswertung (*)
  97.          - Messageareas verwendet (*)
  98.          - Fileareas verwendet (*)
  99.          - Neue Benutzer (*)
  100.          - Gelöschte Benutzer (*)
  101.          - Connects, Logons, Logoffs, Abrüche... (*)
  102.       - Benutzer Angaben:
  103.          - Alter der Benutzer
  104.          - Passwort Länge
  105.          - Korrektheit der Datumsangaben
  106.       - Warnungen an den Sysop bei bestimmten Systemzuständen (*)
  107.  o Share Unterstützung (Netzwerke & Multitasking)
  108.  o CD-ROM Unterstützung
  109.  o Messages an Benutzer und den Sysop
  110.       - Herzlichen Glückwunsch an Benutzer (*)
  111.       - Willkommen an neuen Benutzer (*)
  112.       - Danke für den Upload (*)
  113.       - RAIShort an Sysop (*)
  114.  
  115. Die mit (*) gekennzeichneten Features sind nur in der registrierten
  116. Version aktiv. 
  117.  
  118. Beachten sie bitte, daß schon die unregistrierte Version mehr Features
  119. hat, als andere Programme dieser art.
  120.  
  121.  
  122. Registrierung
  123. -------------
  124.  
  125. Wenn man das Programm registriert, werden einige zustzliche Features
  126. angeboten.
  127.  
  128. Registrieren ist durch die Überweisung von DM 25.- an Duncan McNutt,
  129. Dresdner Bank 6368-Bad Vilbel, Bankleitzahl: 50080000, Konto: 621736900.
  130. Euroschecks und Bargeld an: Duncan McNutt, Am Bier 9, D-6000 Frankfurt
  131. 50. Die Registrierung gilt bis Version 2.9.
  132.  
  133. Wer keine FIDO Adresse hat, muss einen an sich selbst adressierten,
  134. frankierten Briefumschlag mitschicken.
  135.  
  136.  
  137. Haftung
  138. -------
  139.  
  140. Es wird keine Haftung für dieses Programm angeboten, der Betreiber des
  141. Programms übernimmt jegliche Verantwortung für das System auf dem er
  142. dieses Programm laufen lässt. Ich habe jedoch versucht das Programm so
  143. Stabil wie möglich zu machen.
  144.  
  145.  
  146.  
  147. -----------------------------------------------------------------------
  148.  
  149. II. Installation:
  150. ~~~~~~~~~~~~~~~~~
  151.  
  152. 1) Files in ein leeres Directory auspacken.
  153.  
  154. 2) Eine der beiden .LNG Dateien in RAINFO.LNG umbenennen.
  155.  
  156. 3) Die Environment Variable RA wird abgefragt. Diese muß also gesetzt
  157. sein.
  158.  
  159. 4) Mit 'RAIConf' das Programm Konfigurieren und die eigenen Wünsche
  160. ins Config eintragen. Wer damit Probleme hat sollte sich Kapitel IV
  161. durchlesen (siehe unten).
  162.  
  163. 5) Wen Du willst, daß es Messages generiert (nur in der Registrierten
  164. Version) dann mußt Du MBUtil (ein Teil des GEcho Packets) installieren.
  165. Ansonsten bist Du jetzt fertig.
  166.  
  167. Um MBUtil einzustellen musst Du eine Umgebungsvariable GE setzen, so daß
  168. sie auf das Direktory zeigt in dem die MBUtil Dateien liegen.  Dann mußt
  169. Du GSetup aufrufen und folgende Informationen eintragen:
  170.      - System data.Pathnames
  171.      - System data.Origin lines
  172.      - Miscellaneous.Global Options
  173.      - Miscellaneous.MBUtil Options
  174. MBUtil muß im Pfad sein, so daß RAInfo es finden kann.
  175.  
  176.  
  177. Zu den Dateien:
  178. ---------------
  179.  
  180. RAInfo.Doc        Diese Dokumentation
  181.  
  182. RAIinfo.Exe       Das Programm
  183. RAIConf.Exe       Das konfigurations Programm
  184.  
  185. English.Lng und
  186. German.Lng        Die Sprach Definitionsdatein, diese sollten
  187.                   normallerwiese nicht geandert werden.
  188.                   Zumindest eine muß RAINFO.LNG heißen und im Direktory
  189.                   liegen wo RAInfo aufgerufen wird.
  190.  
  191. Stats.*           Beispiel Menü für Dein Remote Access.
  192.  
  193.  
  194.  
  195. -----------------------------------------------------------------------
  196.  
  197. III. Aufruf:
  198. ~~~~~~~~~~~~
  199.  
  200. 1) Zum Ausprobieren RAINFO.EXE (mit oder ohne -s) aufrufen. RAInfo, muß
  201. in dem Direktory aufgerufen werden wo Du es installiert hast.
  202.  
  203. Es genieriert in Deinem 'default' Textedirektory Dateien mit dem Namen
  204. 'RAI_xxxx.ASC' und 'RAI_xxxx.ANS', diese Dateien sind für die User der
  205. BBS gedacht. Ferner wird eine Datei RAILONG.TXT ausgegeben in dem alle
  206. Informationen für den Sysop stehen.
  207.  
  208.  
  209. Wenn Du wass falsch machst gibt er Dir folgende Informationen:
  210.  
  211.     Usage: RAINFO [-s | -u | -q]
  212.  
  213.       -s  Print out stats for SysOp only.
  214.       Only the short report to the screen and the RAILONG.TXT are
  215.       generated.
  216.  
  217.       -u  Print out stats for users only.
  218.       Only the .ANS/.ASC files are generated.
  219.  
  220.       -q  quick, only do those user stats that may have changed by a
  221.       user login. Use this after a user has logged out of the BBS.
  222.           (This option is only available when you have registered).
  223.  
  224.       It does NOT do the Filearea reports, this is because reading
  225.       the FILES.BBS slows things down too much.
  226.  
  227.  
  228. 2) In die .BAT Dateien einbauen...
  229.  
  230.    - In die tägliche (maintenance) Batch Datei:
  231.  
  232.       REM  RAInfo aufruf, Sysop Info in RAILong.TXT und RAIShort.TXT
  233.       cd\ra\util\rainfo
  234.       rainfo
  235.  
  236.    - In der registrierten Version kann man einen 'Schnell' Modus
  237.      aufrufen. In die BBS Batch Datei, nachdem jeder Benutzer die BBS
  238.      verlässt fügt man folgendes ein:
  239.  
  240.       REM RAInfo Userstatistiken auf neusten stand bringen
  241.       REM   Fehlermeldungen ins System Log schreiben
  242.       cd\ra\util\rainfo
  243.       rainfo -q >> \ra\ra.log
  244.  
  245.  
  246.  
  247. -----------------------------------------------------------------------
  248.  
  249. IV. Konfiguration:
  250. ~~~~~~~~~~~~~~~~~~
  251.  
  252. ANSI & ASCII
  253. ------------
  254.  
  255. Das Programm generiert ANSI und ASCII Dateien für die User. Diese
  256. können mit oder ohne IBM Graphikzeichen und selbst gewählten Farben
  257. (für ANSI) ausgegeben werden. Somit ist eine individuelle Anpassung an
  258. die Menüs der eigenen BBS möglich.
  259.  
  260. Bei den ASCII Dateien kann auch angeben werden ob ein FormFeed Zeichen
  261. am Anfang gesetzt werden soll oder nicht.
  262.  
  263. Man kann die Augegebenen Dateien entweder über einen Type 45
  264. Menüeintrag einzeln angeben, oder alle zusammen als ein großes Listing
  265. ausgeben. Im Letzteren Fall muß das FormFeed Zeichen aus den ASCII
  266. Dateien rausgelassen werden.
  267.  
  268.  
  269. Beispiel Menü
  270. -------------
  271.  
  272. Wenn eine Anzeige über Menüs gewünscht wird dan kann man die
  273. mitgeliefterten STATS.MNU und STATS.A* Dateien verwenden als Basis für
  274. ein eigenes Menü.
  275.  
  276. Das Beispiel STATS.MNU geht davon aus, daß alle Anzeigen generiert
  277. werden. Neue Benutzer haben ein Level von midestens 5, registrierte
  278. Benutzer haben in dem Menü ein Level von mindestens 9 und Benutzer die
  279. Zugriff auf die kompletten Fileareas haben haben einen Level von
  280. mindestens 50. Man sollte diese Levels in dem Menü dem eignem System
  281. anpassen. Der Prompt ist so gestaltet, daß der Benutzer daran erkennen
  282. kann welche Auswahl möglichkeiten er hat.  Dies ist ein Feature, welches
  283. der Andrew für mich in RA eingebaut hat, man sieht also, daß es sich lohnt
  284. seine Software zu registrieren.
  285.  
  286.  Beispiel für die .BAT Datei, wenn ein großes Listing gewünscht wird:
  287.       cd\ra\util\rainfo
  288.       rainfo > raishort.txt
  289.       cd \ra\txtfiles
  290.       del rai_long.ans
  291.       REM Echo a Control-L into rai_long.asc to clear screen
  292.       echo ^L>rai_long.asc
  293.       for %f in (rai_*.asc) do type %f >>rai_long.asc
  294.       for %f in (rai_*.ans) do type %f >>rai_long.ans
  295.  
  296. Folgende Dateien werden erzeugt:
  297.  
  298. rai_fld.a*       Fileareas mit den meisten Downloads          (Top 10)
  299. rai_fls.a*       Fileareas mit den meisten Files              (Top 10)
  300. rai_afld.a*      Alle Fileareas mit den meisten Downloads     (Top 10)
  301. rai_afls.a*      Alle Fileareas mit dem meisten Files         (Top 10)
  302. rai_tpf.a*       Die beliebtesten Files                       (Top 10)
  303. rai_atpf.a*      Alle beliebtesten Files                      (Top 10)
  304.  
  305. rai_mesg.a*      Die Messageareas mit den meisten Nachrichten (Top 10)
  306.  
  307. rai_call.a*      Die Benutzer die am meisten anrufen          (Top 10)
  308. rai_dl.a*        Die Benutzer die am meisten Downloaden       (Top 10)
  309. rai_dlk.a*       Die Benutzer die am meisten Downloaden (KB)  (Top 10)
  310. rai_mswr.a*      Die Benutzer die am meisten online
  311.                   Nachrichten schreiben                       (Top 10)
  312. rai_upl.a*       Die Benutzer die am meisten Uploaden         (Top 10)
  313. rai_uplk.a*      Die Benutzer die am meisten Uploaden (KB)    (Top 10)
  314.  
  315. rai_t10s.a*      Die Zusammenfassung, minima/maxima der Top 10 Listen
  316.  
  317. rai_sysl.a*      Die vom Sysop definierten Benutzer-Levels
  318. rai_syss.a*      Die vom Sysop definierten Benutzer-Status
  319. rai_sysf.a*      Nutzung der vom Sysop definierten Features
  320. rai_feat.a*      Nutzung der RA Features
  321. rai_lang.a*      Nutzung der Sprachen
  322. rai_birt.a*      Wer hat Geburtstag
  323.  
  324.  
  325. Sysop Informationen
  326. -------------------
  327.  
  328. Für den Sysop wird eine Zusammenfassung in die Datei RAIShort.TXT, diese
  329. kann auch als Message in einer Area Deiner wahl ausgegeben werden.
  330.  
  331. Eine komplette Ausgabe aller Informationen für den Sysop wird in der
  332. Datei RAILong.TXT ausgegeben.  Die enthaltenen Informationen sind nicht
  333. für die Benutzer gedacht.
  334.  
  335. Ich denke die Ausgaben sind selbsterklärend.
  336.  
  337.  
  338. Sprachen
  339. --------
  340.  
  341. In der registrierten Version, schaut RAInfo in jedem Textfile-Directory
  342. für jede Sprache nach ob da ein RAINFO.LNG liegt. Wenn ja werden dort
  343. .ANS und .ASC Dateien generiert.
  344.  
  345. Wenn einer (oder mehrere) der Textfile-Directories keine RAINFO.LNG
  346. Datei hat generiert RAInfo im Default Textfiledirectory die
  347. *.ANS/*.ASC Dateien. Es benutzt dazu die RAInfo.LNG Datei die im
  348. RAInfo Direktory liegt.
  349.  
  350.  
  351. Allgemein
  352. ---------
  353.  
  354. Was wird ausgegeben:
  355.  
  356. Welche Statistiken/Informationen generiert werden kann man im Configfile
  357. angeben. Nicht alle Informationen kann man für die Benutzer ausgeben,
  358. diese sind dem Sysop vorbehalten.
  359.  
  360. TOP 1:
  361.  
  362. Wenn der Sysop einige der Top 10 Listen nicht haben will, kann er
  363. (optional) von den Listen die er NICHT gewählt hat, aber den Benutzern
  364. zur Verfügung stellt, nur den ersten Eintrag der Top 10 Listen sehen.
  365. Damit weis er zumindest die wichtigsten Fakten. Dies ist der TOP 1
  366. Eintrag in der Konfiguration.
  367.  
  368. Exclude Files:
  369.  
  370. In der registrierten Version kann man, für die Top 10 Files (welche
  371. Files werden am meisten downgeloadet) bis zu 20 Files aus der
  372. Liste raushalten ("exclude").  Dies ist nützlich für Dateien wie zum
  373. Beisppiel die BBS Fileliste.
  374.  
  375. Exclude Fileareas:
  376.  
  377. Für die Top 10 Fileareas, kann man bis zu 30 Fileareas aus der Liste
  378. raushalten... es gibt dann jeweils zwei Listen, eine mit den "excluded"
  379. Areas und eine ohne sie. Dem Sysop können wahlweise nur die Listen mit
  380. allen Areas oder beide Listen angezeigt werden.
  381.  
  382. Benutzerlevel, Benutzerstatus und Sysop Features:
  383.  
  384. Man kann seine eigenen Benutzerlevel, Benutzerstatus und selbst
  385. gebastelte Features ausgeben.
  386.  
  387.     - User Level, hier kann man angeben welche Flags/Level ein
  388.       Benutzer haben muß, um einen bestimmten Level zu bekommen.
  389.  
  390.     - User Status, hier kann man Level UNABHäNGIGE Einstufungen
  391.       aufführen. Beispiel: Benutzer die über 18 sind.
  392.  
  393.     - Sysop Defined Features: hiermit kann man die Features aufführen
  394.       die man selbst in die BBS (zB: anhand von Flags) eingebaut hat.
  395.  
  396.  
  397.  
  398. -----------------------------------------------------------------------
  399.  
  400. V. Technische Informationen:
  401. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  402.  
  403. Folgende Dateien werden ausgewertet:
  404.  
  405.     config.ra
  406.     events.ra
  407.     timelog.bbs
  408.     files.ra
  409.     <Filearea Pfade>\files.bbs
  410.     language.ra
  411.     limits.ctl
  412.     messages.ra
  413.     msgidx.bbs
  414.     msginfo.bbs
  415.     users.bbs
  416.     usersxi.bbs
  417.     protocol.ra
  418.     ra.log
  419.  
  420. Das Programm unterstützt "Share"ing. Netzwerke und Multitasking sind
  421. also kein Problem.
  422.  
  423. Die Filelistpfade werden korrekt abgefragt, also ist CD-ROM
  424. Unterstützung auch kein Problem.
  425.  
  426. Es laüft nur mit DOS 3.0 oder besser.
  427.  
  428. Folgendes ist nicht verfügbar ohne Key:
  429.  
  430.        o Multilanguage Support
  431.        o Der -q (Quick) Commandline Befehl
  432.        o Kommentare (Warnungen) an den Sysop
  433.        o Raushalten (exclude) von bestimmten Files aus den Top 10 Files
  434.          ! Raushalten von Fileareas geht !
  435.        o Birthday Liste
  436.        o Messages
  437.        o Einige der Sysop Informationen
  438.  
  439.  
  440.  
  441. -----------------------------------------------------------------------
  442.  
  443. VI. History:
  444. ~~~~~~~~~~~~
  445.  
  446. Version 1.00:  Initial Release
  447.  
  448. Version 1.01:  Speed up and documentation fix
  449.  
  450. Version 1.10:
  451.   Protocoll.RA and Logfile are evaluated
  452.   Sperate configuration program, compeltely rewritten with more options
  453.   User data speedup by a factor of 5
  454.   Messages to users and sysop
  455.     - Happy birthday to user
  456.     - Welcome to new user
  457.     - Thanks for upload
  458.     - RAIShort an Sysop
  459.   Key is placed in a separate file.
  460.   Bugfixes:
  461.     - Top10 Summary on -Q fixed
  462.     - Files.BBS counter logik improved, works with more external file doors
  463.     - Age calculation of the users corrected
  464.     - Some spelling mistakes fixed
  465.     - Config bugs fixed by rewrite
  466.     - Percent values now shown correctly if 100% or 0%
  467.  
  468. Cheers,
  469.    Duncan McNutt
  470.  
  471. <End Of Text>
  472.