Annotation of bayesjunktool/doc/README, revision 1.2

1.2     ! straxus     1: README for Bayes Junk Tool ver. 0.2
1.1       straxus     2: 
                      3: /****************\
                      4: |* INTRODUCTION *|
                      5: \****************/
                      6: 
1.2     ! straxus     7: This is the second release of this tool, and it is becoming a more
        !             8: refined piece of artwork (if I do say so myself :) ). There are
        !             9: many GUI and CLI refinements, and a few bugfixes as well. In
        !            10: addition, the community has stepped forward to provide sample
        !            11: token files for use with the tool. In particular, I would like to
        !            12: thank the following (in alphabetical order):
        !            13: 
        !            14: * Christian Hamacher
        !            15: * Dmitry Diskin
        !            16: * Jan Gundtofte-Bruun
        !            17: * Morten Hansen
        !            18: * Rob Stow
        !            19: 
1.1       straxus    20: At this point, I'll turn the doc over to the disclaimer found at
                     21: the top of all of my source files:
                     22: 
                     23:  * The terms for using this software are as follows:
1.2     ! straxus    24:  *
1.1       straxus    25:  * USE AT YOUR OWN RISK - if this program goes insane and takes
                     26:  * out several bystanders, don't come knocking on my door with
                     27:  * lawyers.
1.2     ! straxus    28:  *
1.1       straxus    29:  * If you want to extend or use this software for some sort of
                     30:  * commercial (read: money-making) software, tell me about it
                     31:  * first. I probably won't ask for a cut because the software
                     32:  * isn't that complicated, but I do want to know where my little
                     33:  * baby heads after it leaves my machine.
1.2     ! straxus    34:  *
        !            35:  * This project has become an official Mozdev project, and the
        !            36:  * website for it is http://bayesjunktool.mozdev.org. That is
        !            37:  * the best place to look for updates and information about this
        !            38:  * application. Updates are coming fast and furious right now,
        !            39:  * so it's a good idea to check it frequently.
        !            40:  *
1.1       straxus    41:  * If you have any questions about this program, feel free to
1.2     ! straxus    42:  * email any questions to bayesjunktool@mozdev.org. I'd love to
        !            43:  * hear how this program worked for you, or any suggestions or
        !            44:  * bugfixes that you believe this software should use. I believe
        !            45:  * that software should evolve and become better, so there's an
        !            46:  * extremely good chance your suggestion will make it into the
        !            47:  * next version.
        !            48:  *
1.1       straxus    49:  * Oh, and for those of you curious about the author's (my) name,
1.2     ! straxus    50:  * just email straxus@baynet.net and ask. :)
1.1       straxus    51: 
                     52: /****************\
                     53: |* REQUIREMENTS *|
                     54: \****************/
                     55: 
                     56: * Java 2 Standard Edition 1.4.1 (Due to the requirement for an
                     57: XML parser to import data from XML - if you remove the one method
                     58: that does XML importing in Analyzer.java, it will then only need
                     59: Java 1.3.1)
                     60: 
                     61: /************\
                     62: |* FEATURES *|
                     63: \************/
                     64: 
                     65: * Viewing of data contained with Mozilla's training.dat
1.2     ! straxus    66: 
1.1       straxus    67: * Exporting of data as HTML, XML, plain text, or well-formed .dat
                     68: (you can take a .dat and drop it in the Mozilla folder, and it
                     69: should work perfectly)
1.2     ! straxus    70: 
1.1       straxus    71: * GUI which allows adding new tokens, removing tokens, and editing
1.2     ! straxus    72: the counts associated with each token
        !            73: 
1.1       straxus    74: * Sorting of data on any column in the GUI. This allows you to see,
                     75: for example, the most frequently encountered good and bad tokens in
1.2     ! straxus    76: email
        !            77: 
1.1       straxus    78: * Importing of data from an existing training.dat or XML file and
1.2     ! straxus    79: merging with an existing token file. I believe this feature is
        !            80: important as it will allow a new user to get up and running very
1.1       straxus    81: quickly by importing a well-known XML file containing useful values
                     82: for spam tokens, thus greatly reducing the training period for
1.2     ! straxus    83: Mozilla's mail filters
        !            84: 
        !            85: * Collection of sample token files in XML and DAT format that are
        !            86: ready to be merged into an existing Mozilla training.dat
        !            87: 
        !            88: * Removal of certain sets of tokens based on their good or bad count
        !            89: 
        !            90: * Equivalent application functionality from both the command-line
        !            91: and the GUI
        !            92: 
        !            93: * Full JavaDoc of the Bayes Junk Tool API so that its functionality
        !            94: can be more easily incorporated into other programs
1.1       straxus    95: 
                     96: Valid command-line arguments for this program are:
                     97: 
1.2     ! straxus    98: -q, --quiet == silent execution of program
        !            99: -g, --gui == start up GUI version of program
        !           100: -h, -?, --help == display program usage (this message)
        !           101: -v, --version == display program version
        !           102: -f, --format [ xml | html | text | data ] == program output format
        !           103: -rg, --remove-good [number] == Remove all tokens with a good or bad count
        !           104: -rb, --remove-bad [number]  == less than the given number. If both are
        !           105: specified, those tokens which satisfy either one OR the other will be kept.
        !           106: -o, --outputfile [filename] == path to program output file
        !           107: -m, --merge [filename] == path to XML or .dat file to merge with inputfile
        !           108: -i, --inputfile [filename] == path to Mozilla training.dat
1.1       straxus   109: 
                    110: Please note that the input file must include the training.dat
                    111: filename, e.g. [path-to-profile]/xxxxxxxx.slt/training.dat
                    112: 
                    113: /*************\
                    114: |* EXECUTION *|
                    115: \*************/
                    116: 
1.2     ! straxus   117: * To build the program, type the following in the installation
1.1       straxus   118: directory of the program:
                    119: 
                    120: javac -d . mozilla_training_analyzer\*.java
                    121: 
1.2     ! straxus   122: Adjust the directory separator as required for your platform. If you
        !           123: have downloaded the version of the Bayes Junk Tool which already
        !           124: includes binaries, this step is not necessary.
1.1       straxus   125: 
1.2     ! straxus   126: * After compilation, to run the program, type:
1.1       straxus   127: 
                    128: java -cp . mozilla_training_analyzer.Analyzer [Analyzer options]
                    129: 
1.2     ! straxus   130: * To generate JavaDoc for the program's APIs, run the following
        !           131: command in the installation directory of the program:
        !           132: 
        !           133: javadoc -sourcepath mozilla_training_analyzer\*.java -package -use -d doc
        !           134: 
        !           135: This will generate the documentation in a "doc" subdirectory.
        !           136: 
1.1       straxus   137: /***********\
                    138: |* HISTORY *|
                    139: \***********/
                    140: 
1.2     ! straxus   141: July 23rd, 2003 - Release 0.2
        !           142: 
        !           143: --NEW FEATURES--
        !           144: 
        !           145: * It is now possible to remove tokens based on their good and/or bad
        !           146: count. For instance, you can choose to remove all tokens with a good
        !           147: count which is less than 5.
        !           148: 
        !           149: * It is now possible to select a group of tokens in the GUI and
        !           150: delete them. Before, only one token at a time could be selected and
        !           151: deleted.
        !           152: 
        !           153: * It is now possible to begin with an XML file as the input file.
        !           154: Before, the input file could only be a well-formed DAT file.
        !           155: 
        !           156: * A status bar has been added to the bottom of the GUI which
        !           157: displays the name of the file being viewed, the number of tokens in
        !           158: total, and the number of tokens selected.
        !           159: 
        !           160: * The program now has a flag which displays its version information.
        !           161: 
        !           162: * The GUI now has a graphical About box.
        !           163: 
        !           164: * A combination of the -g and either -h or -v will cause the version
        !           165: or help information to appear in GUI form. Before, it would be
        !           166: displayed on the command-line.
        !           167: 
        !           168: * The Open, Import, and Save file dialogs have been greatly sped up.
        !           169: 
        !           170: * A set of "Getting Started" XML and DAT token files are now
        !           171: included with the application.
        !           172: 
        !           173: --BUGFIXES--
        !           174: 
        !           175: * Fixed problem encountered on some systems which caused the JVM to
        !           176: throw an OutOfMemoryError while generating output files for large
        !           177: token files (bug 3943)
        !           178: 
        !           179: * It is now possible to merge a file on the command-line (bug 4094)
        !           180: 
        !           181: * The File Chooser will now remember the last directory it was in
        !           182: rather than resetting to the home directory every time (bug 4108)
        !           183: 
        !           184: 
1.1       straxus   185: June 23rd, 2003 - Release 0.1
1.2     ! straxus   186: 
1.1       straxus   187: * First release, baybee.

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