home *** CD-ROM | disk | FTP | other *** search
-
-
- **** ** **** ****** ** **
- ** ** ** ** ** ****** ** **
- ** ** ** ** ** **** ***** ****
- ** ** ** ** *** ** ** ** ** ** ** v 1.01
- ** ** ** ** ** ** ** ** ** ** ****
- ** ** ** ** ** ** ** ** ***** ** ** by Michael
- **** ****** ***** ** **** ** ** ** Dreher
- **
- What is it ??
- ~~~~~~~~~~~~~
- Just a simple but powerful proggie to generate Top-X-lists of your
- users' activities, such as Top-X.Downloaders, -Callers, -Msg-Readers..
-
-
- Why DLGTopX and not DLGTop10 ??
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Because you are not limited to a Top-10 or a Top-15 or whatsoever,
- but can do as many users in the list as you want (ok, it's not
- really unlimited, but Top-x00 should be no problem, it has been
- tested with some thousand and worked ok :-)
-
-
- What can it do ??
- ~~~~~~~~~~~~~~~~~
-
- - DLGTopX will generate lists with:
-
- - Up-/Downloaders (Files and Bytes)
- - Msg-Readers/Writers
- - Callers
- - Chatters
- - UserAge
-
- - Each list has a summary/average shown at the bottom, which also can
- be used as variables in the TopXSummary-File (see below...)
-
- - For special purposes, there is the possibility to exclude a user
- from any list (e.g. the SysOp, since he will be always the
- Top-Caller/Msg-Reader/Writer :-)
-
- - The Top-User of each list will be informed via his User:*/event.log
- (only when using config-file, switchable..)
-
- - You can even make some "inverted" list, with the "Bottom-on-Top",
- try it :-)
-
- - any ideas ?? send them to:
-
- Marcus Kuba @ 2:244/7253 (DLGTopX-World-Support :-) or
- Michael D. Deberg @ 1:232/300 (DLGTopX-USA-Support)
-
-
- How does it work ??
- ~~~~~~~~~~~~~~~~~~~
- DLGTopX needs an ASCII-file with formatted user-data, done with
- DFExport (included in the DLG Professional BB/OS-package..) (later
- versions will perhaps no longer need this, but since the Data-Files
- of DLG Pro are subject to change, we did it the simple and save way
- and used DFExport :-)
-
- It scans the Data of this file, calculates the Top-X-list of the
- specified criteria (Down/Uploads, Msgs, Calls,...) and writes it to
- a file you can later show in the BBS (e.g. add a menu-entry which
- uses DF to display it...)
-
- To run DLGTopX, you should make some script that calls DFExport
- first to do the ASCII-file and then lets DLGTopX do its work.
-
- The command-line for DLGTopX is:
-
- DLGTopX <userfilename> <outputfilename> <listnumber> [X] [Sysopname] [-]
-
- where <userfilename> is the path to the file generated with DFExport
- (see the files in this archive...)
- <outputfilename> is the path/filename of the generated list
- <listnumber> is the parameternumber to sort on, where:
-
- 0 -> number of downloads
- 1 -> downloaded bytes
- 2 -> number of uploads
- 3 -> uploaded bytes
- 4 -> messages written
- 5 -> messages read
- 6 -> number of calls
- 7 -> number of chats
- 8 -> user's age
-
- [X] is the number of output users (default 10)
- [Sysopname] is the Name of the Sysop to exclude from TopXlist
- [-] tells DLGTopX to sort invers (lowest on top)
-
-
- If you use a config-file (recommended..), the command-line is:
-
- DLGTopX config <configfilename>
-
- where "config" is a fixed switch to tell DLGTopX to use the file
- <configfilename> to look which lists to generate and where
- to put them.
-
- The format of the config-file is as follows:
-
- ---------------cut here----------
- <userfilename>
- <outputfilename>
- <listnumber> [X] [Sysopname] [-] [+]
- .
- .
- .
- overall <formfilename> <summaryfile>
- .
- .
- ---------------cut here----------
-
- Where <userfilename> is the same as above, the Filename of the
- DFExport-ASCII-file
- <outputfilename> is the path and prefix to all the generated
- lists, each ending with <listnumber>
-
- <listnumber> [X] [Sysopname] [-] are the same as above
-
- [+] is a flag whether or not to inform the
- user of being the Top-???
-
- There can be one <listnumber> [X] [Sysopname] [-] [+] line for each
- of the <listnumbers> (plus one for each with the [-]-flag)
-
- If you don't need any of the [X] [Sysopname] ... -flags and wish to
- use the default, you MUST enter a "" (twice a " :-) for it.
-
- Examples:
- ~~~~~~~~~
- 4 15 "Marcus Kuba" "" +
- \ | | | |
- \| | | inform Top-User
- | | normal sort (no Bottom-on-Top)
- | exclude the SysOp
- create a Top-15 Message-Writer list
-
- 6 "" "" - ""
- \ | | | |
- \| | | don't inform User
- | | reverse sort (Bottom-on-Top)
- | don't exclude anyone
- create a "Bottom-10-Caller" list
-
- 7
- \ | | | |
- \|<-|<-|<-|--- oops, no Data, but not necessary with ALL default
- | | | |
- create a standard Top-10-Chatter list, no exclusion, no reverse
- sort, no info
-
- I hope it's clear now ???
-
-
- BE CAREFUL: The configfile may NOT include any commentlines or empty
- lines !!! I don't think that this could cause any loss
- of data, but DLGTopX certainly will NOT work properly !
-
- (We know that this could be better, but it just would take more time
- for parsing the configfile and checking for any bugs in it, and we
- don't wanna spend our time with debugging configfiles instead of
- adding new useful features to the program :-)
-
-
- The "overall"-switch:
- ~~~~~~~~~~~~~~~~~~~~~
- with the "overall"-switch, you can make textfiles including the
- summary- and average-data of each CREATED Top-X-list, for example to
- put them at the login or somewhere else in the BBS. You can specify
- as much "overall..."-lines as you want.
-
- <formfilename> is the inputfile with the switches
- <summaryfile> is the outputfile with the numbers
-
- The inputfile has no special format, so here just a list of the
- switches:
- sum: average:
- DLs <- @0 @9
- DLbytes <- @1 @10
- ULs <- @2 @11
- ULbytes <- @3 @12
- MsgsWritten <- @4 @13
- MsgsRead <- @5 @14
- Calls <- @6 @15
- Chats <- @7 @16
- Number of Users <- @8 @17
- Full date <- @18
- Eventlog date <- @19
-
-
- If you try to use a switch which has not been created (e.g. using @4
- and there was no line telling DLGTopX to create the Top-X-Msg-Writer
- list), then this switch will be replaced by a "0" !!
-
- You can put a ".y" after the switch, telling DLGTopX that this
- number shall be right-justified with y characters width (try it out,
- and you'll now what I mean, it's something like DF's option of
- making TAB's in the display-files)
-
- Sorry, all output will be RIGHT-justified (not LEFT, like when using
- DF..), because we think that NUMBERS look better this way :-)
-
- Look at the included example-files, you'll see how it' works.
-
-
- How must I install it ??
- ~~~~~~~~~~~~~~~~~~~~~~~~
- Oh, this is quite simple, just copy the files from this Archive to
- the appropriate directories and read all the scripts and examples:
-
- TopX.form -> DLGConfig:Text/
- TopXsummary.form -> DLGConfig:Text/
- DLGTopX.cfg -> DLGConfig:Misc/
- DLGTopX.batch -> DLGConfig:Batch/
- DLGTopX -> anywhere in your Path, e.g. in the C:-directory
-
- Then make an event, which call's the DLGTopX.batch every day (every
- user ?? :-) and add a menu which uses DF to show the files...
-
-
- CopyRight:
- ~~~~~~~~~~
- DLGTopX is shareware, if you like it and use it, we recommend a
- shareware-fee of let's say $10 (15 DM) or send us YOUR proggies to
- use with DLG Pro..
-
- author:
-
- Michael Dreher
- Wielandstr. 12
-
- 7250 Leonberg
-
- West Germany
-
- Fido Netmail: 2:244/7253 Intuition Base ++49-7152-45768 HST DUAL V.42bis
-
- or write to:
-
- Marcus Kuba, SysOp: 2:244/7253 (Intuition-Base, DLGTopX and
- CONTRIS!-Support-BBS :-)
-
- Special thanks:
- ~~~~~~~~~~~~~~~
- Marcus Kuba : - He had the ideas for this program and he
- was the first tester.
- - He wrote this documentation.
-
- Heiko Richter : - He was the first (and only ???) who payed the shareware-fee
-
- Michael D. Deberg: - for his support in the USA
-
-