Paragon UserInfo V4.0R Users Guide ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Author: Craig Pinfold Operating System: Commodore AMIGA Personal Computers, AmigaDOS 1.2 or higher, 1 megabyte RAM minimum. Software Version: UserInfo 4.0D Requirements: An Amiga of any type with at least 1 megabyte of memory, to run the Paragon BBS system as well as UserInfo periodically at the same time. And an additional 20K bytes of Stack. Copyright 1990 Craig Pinfold. All Rights Reserved. Trademarks: AMIGA, AmigaDOS and Amiga Workbench are trademarks of Commodore-Amiga, Inc. Paragon is a trademark of Inner Circle Software. Any other Trademarks belong to there respectful owners. NOTICE: This program will only continue to be enhanced if I see that people are willing to contribute a minimal REGISTRATION fee(See end of file). Also: This archive contains a partially working copy only, it is not the release version. The release version will allow for everything you read below, this version only allows for a set number of 7 users to be listed in each file. Also only a set number of top 7 files to be listed in each top X downloaded files file. NOTE: You must set it up as per below even though you only have the demonstration version. Overview: Paragon UserInfo was written to produce statistics from the data files of the Paragon BBS system. It will produce statistics for each user in descending order up to the number of users you want. It will do this on the number of bytes uploaded, bytes downloaded, messages written, calls made to system and total points accumulated. You must provide the number of points given for each category above. These may be negative numbers so that you can subtract points for downloading. You also decide how many users will be listed. In time UserInfo will become a complete statistics package for the Paragon BBS system. It will produce statistics of the top downloaded files for all the areas that you specify, you may also specify the number of files listed. How to set up the `CONFIG' file: First of all we'll look at an example of a `normal' configuration file. -------------------------- cut here ---------------------------- F_AREA : 2 F_NAME : 10 : General. : PARAGON:BULS/BUL11.TXT CALLPOINTS : 1 DOWNPOINTS : -1 AUTHORPOINTS : 1 UPPOINTS : 2 NOUSERS : 50 DOWNLOAD : Paragon:BULS/BUL6.TXT UPLOAD : Paragon:buls/BUL5.TXT CALLER : Paragon:BULS/BUL8.TXT AUTHORS : Paragon:BULS/BUL7.TXT POINTS : Paragon:BULS/BUL9.TXT FILEPATH : Paragon:filez/ ------------------------- cut here ----------------------------- There is an example configuration files included with UserInfo, the files produced when UserInfo is run with this configuration file are included. We'll divide it into three areas for simplicity, Area 1: the section with `F_AREA' and `F_NAME'. The first area may be ommited if you do not require that bulletins be made for the top X number of files in any areas. The second section is from `CALLPOINTS' to `NOUSERS' inclusive. This section may not be ommited under any circumstance. The next section will be from `DOWNLOAD' to the end of the file. In between each section there should be NO blank lines or comment lines, support for this may be included in the next version. Area 1: This section is to tell UserInfo the file section number, number of users to be listed, name of the file area and output filename. This filename is usually that of a bulletin. The first `TAG', `F_AREA' is to tell UserInfo what the area number is. If you want a top X number of files downloaded for file area 1, you would make that line say `F_AREA : 1'. The next tag which should be on the next line and should be `F_NAME' after the space and colon you should have a space and the number of files you want listed. After the next space, colon and space you should put the name of the file area. The next name after another space, colon and space is the name of the file you want the statistics to be written to. This should be the full path and filename. If the name of that area was `General.' and you wanted the top 10 downloaded files listed and the top 10 downloaded files to be listed in a file called `HD:BUL1.TXT' the line would read `F_NAME : 10 : General. : HD:BUL1.TXT'. Take note that you cannot have a space in the name of the area. This area can be done in sets so if you use 40 file areas you would REPEAT the first two lines in sets, that would then make this area 80 lines. It would look like so if you did the top file lists for 3 directories. ------------------------ cut here ------------------------------ F_AREA : 1 F_NAME : 12 : Area_1. : HD:BUL3.TXT F_AREA : 2 F_NAME : 15 : Area_2. : HD:BUL2.TXT F_AREA : 3 F_NAME : 17 : Area_3. : HD:BUL1.TXT ------------------------- cut here ----------------------------- Notice that you must have an extension on the filename for the output file. So this is the format of the configuration files first section: --------------------------- cut here --------------------------- F_AREA : X F_NAME : Y : NAME : FILENAME --------------------------- cut here --------------------------- Where X is the file area number and Y is the number of files you want listed, NAME is the name of the file area, it cannot have ANY spaces in it. FILENAME is the name of the output file, it must end in something, in other words if you want the filename to be called `BUL9.TXT'. You must enter it as so and NOT as `BUL9' and pray that UserInfo adds it on, it will not as of the writing of this documentation. Also this section CAN be left out entirely if you do not want any top X downloaded files in any areas. Area2: This is the area where you define how many points the user will get for each category, such as uploading and downloading. It is very easy to fill out, the TAG's can be in any order but they must ALL be there, you can give the user points in the range from -99 to +99. Here is what each TAG is for: --------------------------- cut here --------------------------- CALLPOINTS : Points per call a user gets. DOWNPOINTS : Points per every 1000 bytes downloaded. (Should be negative) AUTHORPOINTS : Points for every message written. UPPOINTS : Points for every 1000 bytes uploaded. -------------------------- cut here ---------------------------- There is also one other thing that should be in this section, that is the number of users listed in every file that is produced. This affects how many users are listed in each file but not each individual file. (One of the next two versions will allow for different numbers of users in each file as well as the option to set the highest and lowest access levels.) This line of the configuration file should look like. -------------------------- cut here ---------------------------- NOUSERS : X -------------------------- cut here ---------------------------- Where X is the number of users you want listed in each of the four files. So if X was 20 you would get the top 20 users listed for each section. Area 3: The third section is used to tell UserInfo what files to output to and also the path to the file data section. The file data is the `UdX.DAT' and `UdX.VER' files, the X is the file area number minus one. This section must be third and should take the form of: -------------------------- cut here ---------------------------- DOWNLOAD : Path and filename, must have an ending if you want one. UPLOAD : Path and filename, must have an ending if you want one. CALLER : Path and filename, must have an ending if you want one. AUTHORS : Path and filename, must have an ending if you want one. POINTS : Path and filename, must have an ending if you want one. FILEPATH : Path to the file data directory. -------------------------- cut here ---------------------------- So valid entries for this section would be: -------------------------- cut here ---------------------------- DOWNLOAD : Paragon:BULS/BUL6.TXT UPLOAD : Paragon:buls/BUL5.TXT CALLER : Paragon:BULS/BUL8.TXT AUTHORS : Paragon:BULS/BUL7.TXT POINTS : Paragon:BULS/BUL9.TXT FILEPATH : Paragon:filez/ -------------------------- cut here ---------------------------- How to use UserInfo V4.0: To use `UserInfo' you must do these steps: 1: Place UserInfo somewhere so that you can run it. 2: Make sure your stack has been raised approx. 20K bytes. 3: Make sure `Paragon:' is assigned to your main BBS directory. 4: Make sure that you have edited your `UserInfo.CFG' file. 5: Also check that it is in your logical S: directory. 6: Run `UserInfo'. If you have done these things and have no problems you can skip the next few paragraphs, they go into detail about running `UserInfo'. 1: To use UserInfo you must first place UserInfo somewhere on one of your disks, hard disk or otherwise it does not matter. I suggest that you put it in your logical C: directory, if you do not know where this is please refer to your AmigaDOS manual. I would not recommend that you use UserInfo on a floppy based system, doing so may cause UserInfo to run for more than 10 - 15 minutes. This is because of the slow speed of floppy drives. 2: Because UserInfo deals with such large amounts of data it requires some overhead stack space(system memory), it requires an additional 20000 bytes of stack, to find out what your stack should be set to just run `stack' it will tell you how much stack you are currently using, merely add 20000 bytes to that and type `stack New_Stack_Size', where `New_Stack_Size' is the new size that you calculated. If you are experienced with the AmigaDOS operating system you can change the stack size that you calculate, it can be lower. For example, I run Paragon Line 1, Local Node and Parcon as well as a text editor, and UserInfo on just 70000 bytes of stack which is 10000 bytes less than I advised, it all depends on your individual circumstances. Then all you have to do is run it from any CLI window, by typing `UserInfo' or the full path and then `UserInfo'. 3: Then be sure that you have assigned a directory of `Paragon:' to your main BBS directory. This must have been done to be running Paragon at the same time. If you are still not sure type `assign' this will show you all the logical and assigned directories. Somewhere it should say `Paragon: DRIVE:PATH', where `DRIVE:PATH' is the path to your main BBS directory. If you are not running Paragon at the same time then all that is needed is that you type `assign Paragon: DRIVE:PATH' in any CLI window. 4: Make sure it has been edited to do what you want, according to the section of this documentation called "How to set up the `CONFIG' file", above. 5: Then you must place `UserInfo.CFG' in your logical S: directory, again if you don't know where this is please refer to your AmigaDOS manual. It is also possible to place the `UserInfo.CFG' file in the current directory, UserInfo can find it there as well. If you do not want to put it in either of these places it is possible to put it in a directory and then execute UserInfo like so: `UserInfo DRIVE:PATH/FILENAME', where FILENAME is the configuration file. 6: Merely type 'UserInfo' or the above in any CLI window. It will run through and you should see it tell you what it will be doing or any errors in the configuration file that it encounters. Copyright NOTICE: UserInfo 4.0 is `myware', which means: UserInfo 4.0 is copyrighted, including later versions of UserInfo which have been modified. Unauthorised copying is forbidden, illegal and immoral. Also unauthorised use of UserInfo is also forbidden, illegal and immoral. I authorize the copying and use of UserInfo for a 14 day period unless, the below said sum of money is sent to the address below. At such time as the mailing of said monies UserInfo may continue to be used. This does not apply to modified copies, or later versions, they may not be copied at all under any circumstance except for the purpose of archival backups by registered users(See below). You may be held legally responsible for any copyright infringement that is caused or encouraged by your failure to abide by these terms. You may not modify, adapt, translate, reverse engineer, disassemble, or decompile UserInfo 4.0. You may not assign, rent or lease any version of UserInfo without prior written consent from Craig Pinfold. I will periodically update and revise UserInfo 4.0, these updates will be sent to REGISTERED owners(See below) only. It is ILLEGAL to use this program, UserInfo 4.0 for more than 14 days without sending in the below requested sum of money. Using UserInfo 4.0 for more than the said period of time is a direct copyright infringement and can be subject to criminal prosecution, under the copyright act. To become a REGISTERED user you must send a contribution of at least TWELVE CANADIAN dollars plus THREE Canadian dollars shipping and handling, Cheque or money order, payable to `Craig Pinfold' at: 30 Harpers Croft Unionville, ONT Canada. L3R 6L2 Please include your FULL mailing address and the version of UserInfo that you have. You will be sent a fully working version of UserInfo V4.0 on an 880K floppy disk. This version will not be released to anyone except REGISTERED users. There will be a THREE dollar Shipping and Handling charge. This is not a charge for this version, merely the cost of sending this version to you. The release of UserInfo V4.5 will be sometime before the end of March. This version will include the following changes/improvements: The output of a log file The option of automatically adding a `header' to the top of the output files. Further automation, a smaller/easier configuration file. Graphical output of the percentage of X baud callers. BOTH .TXT(Text) and .GR1(ANSI Graphics) file outputs. Version 5.0 will cost an additional $7 Canadian dollars and $3 Canadian Dollars for Shipping and Handling for REGISTERED users only, and between $25 and $35 dollars for unregistered users. It will have the following improvements, the release date has not yet been determined: The output of .GR2 and .GR3 files for IBM text and IBM/ANSI. The output of percentage of system usage. The choice of what access levels that are listed in the Points, Caller, Download, Upload and Message lists. This will be very useful for not allowing the SysOp to be listed, etc. POSSIBLY the addition of overall message and file base usage. This would be in a bar graph format. POSSIBLY the addition of the percentage of door usage. This would be bar graph format. POSSIBLY the use of a window for output, and also a countdown timer so that it would be run every X minutes/hours. Any other good suggestions I receive WILL be incorporated into this version. To make a suggestion please send correspondence to the address listed above. In other words, it will become a complete statistics package for the Paragon BBS system. .fin.