Annotation of bayesjunktool/doc/README, revision 1.1

1.1     ! straxus     1: README for Mozilla Bayesian Filter Training File Analyzer ver. 0.1
        !             2: 
        !             3: /****************\
        !             4: |* INTRODUCTION *|
        !             5: \****************/
        !             6: 
        !             7: This is the first release of this tool, so there's not going to be
        !             8: a high level of refinement about it (although I have done my best).
        !             9: At this point, I'll turn the doc over to the disclaimer found at
        !            10: the top of all of my source files:
        !            11: 
        !            12:  * The terms for using this software are as follows:
        !            13:  * 
        !            14:  * USE AT YOUR OWN RISK - if this program goes insane and takes
        !            15:  * out several bystanders, don't come knocking on my door with
        !            16:  * lawyers.
        !            17:  * 
        !            18:  * If you want to extend or use this software for some sort of
        !            19:  * commercial (read: money-making) software, tell me about it
        !            20:  * first. I probably won't ask for a cut because the software
        !            21:  * isn't that complicated, but I do want to know where my little
        !            22:  * baby heads after it leaves my machine.
        !            23:  * 
        !            24:  * If you have any questions about this program, feel free to
        !            25:  * email me at straxus@baynet.net. I'd love to hear how this
        !            26:  * program worked for you, or any suggestions or bugfixes that
        !            27:  * you believe this software should use. I believe that software
        !            28:  * should evolve and become better, so there's an extremely good
        !            29:  * chance your suggestion will make it into the next version.
        !            30:  * 
        !            31:  * Oh, and for those of you curious about the author's (my) name,
        !            32:  * just email and ask. :)
        !            33: 
        !            34: /****************\
        !            35: |* REQUIREMENTS *|
        !            36: \****************/
        !            37: 
        !            38: * Java 2 Standard Edition 1.4.1 (Due to the requirement for an
        !            39: XML parser to import data from XML - if you remove the one method
        !            40: that does XML importing in Analyzer.java, it will then only need
        !            41: Java 1.3.1)
        !            42: 
        !            43: /************\
        !            44: |* FEATURES *|
        !            45: \************/
        !            46: 
        !            47: * Viewing of data contained with Mozilla's training.dat
        !            48: * Exporting of data as HTML, XML, plain text, or well-formed .dat
        !            49: (you can take a .dat and drop it in the Mozilla folder, and it
        !            50: should work perfectly)
        !            51: * GUI which allows adding new tokens, removing tokens, and editing
        !            52: the counts associated with each token.
        !            53: * Sorting of data on any column in the GUI. This allows you to see,
        !            54: for example, the most frequently encountered good and bad tokens in
        !            55: email.
        !            56: * Importing of data from an existing training.dat or XML file and
        !            57: merging with an existing training.dat. I believe this last feature
        !            58: is important as it will allow a new user to get up and running very
        !            59: quickly by importing a well-known XML file containing useful values
        !            60: for spam tokens, thus greatly reducing the training period for
        !            61: Mozilla's mail filters.
        !            62: 
        !            63: Valid command-line arguments for this program are:
        !            64: 
        !            65: -q, --quiet                                    == silent execution of program
        !            66: -g, --gui                                      == start up GUI version of program
        !            67: -h, -?, --help                                 == display program usage (this message)
        !            68: -o, --outputfile [filename]                    == path to program output file
        !            69: -f, --format [ xml | html | text | data ]      == program output format
        !            70: -i, --inputfile [filename]                     == path to Mozilla training.dat
        !            71: 
        !            72: Please note that the input file must include the training.dat
        !            73: filename, e.g. [path-to-profile]/xxxxxxxx.slt/training.dat
        !            74: 
        !            75: /*************\
        !            76: |* EXECUTION *|
        !            77: \*************/
        !            78: 
        !            79: To build the program, type the following in the installation
        !            80: directory of the program:
        !            81: 
        !            82: javac -d . mozilla_training_analyzer\*.java
        !            83: 
        !            84: Adjust the directory separator as required for your platform.
        !            85: 
        !            86: After compilation, to run the program, type:
        !            87: 
        !            88: java -cp . mozilla_training_analyzer.Analyzer [Analyzer options]
        !            89: 
        !            90: /***********\
        !            91: |* HISTORY *|
        !            92: \***********/
        !            93: 
        !            94: June 23rd, 2003 - Release 0.1
        !            95: * First release, baybee.

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>