FINDBUGS(1) FINDBUGS(1) NAME findbugs - static analysis tool to look for bugs in Java code SYNOPSIS findbugs [general options] [gui options] findbugs [general options] -textui [command line options...] [jar/zip/class files, directories...] DESCRIPTION FindBugs is a program which uses static analysis to look for bugs in Java code. Please see http://findbugs.sourceforge.net/ for more infromation about FindBugs. See FILES section of this manual page for information about documentation distributed with FindBugs. GENERAL OPTIONS -gui Use the Graphical UI (default behavior) -gui1 Use the older Graphical UI -textui Use the Text UI -jvmArgs args Pass args to JVM -maxHeap size Maximum Java heap size in megabytes (default=768) -javahome Specify location of JRE -help Display command line options -version Display FindBugs version -debug Enable debug tracing in FindBugs GUI OPTIONS -project analyze given project -home specify FindBugs home directory -pluginList specify list of plugin Jar files to load -effort[:min|less|default|more|max] set analysis effort level -adjustExperimental lower priority of experimental Bug Patterns -workHard ensure analysis effort is at least 'default' -conserveSpace same as -effort:min (for backward compatibility) -f set font size -clear clear saved GUI settings and exit -priority set analysis thread priority -loadbugs load bugs from saved analysis results -d or --nodock disable docking -look[:plastic|gtk|native] set UI look and feel COMMAND LINE OPTIONS General FindBugs options: -project analyze given project -home specify FindBugs home directory -pluginList specify list of plugin Jar files to load -effort[:min|less|default|more|max] set analysis effort level -adjustExperimental lower priority of experimental Bug Patterns -workHard ensure analysis effort is at least 'default' -conserveSpace same as -effort:min (for backward compatibility) -showPlugins show list of available detector plugins Output options: -timestampNow set timestamp of results to be current time -quiet suppress error messages -longBugCodes report long bug codes -progress display progress in terminal window -release set the release name of the analyzed application -experimental report all warnings including experimental bug patterns -low report all warnings -medium report only medium and high priority warnings [default] -high report only high priority warnings -sortByClass sort warnings by class -xml[:withMessages] XML output (optionally with messages) -xdocs xdoc XML output to use with Apache Maven -html[:stylesheet] Generate HTML output (default stylesheet is default.xsl) -emacs Use emacs reporting format -relaxed Relaxed reporting mode (more false positives!) -train[:outputDir] Save training data (experimental); output dir defaults to '.' -useTraining[:inputDir] Use training data (experimental); input dir defaults to '.' -sourceInfo Specify source info file (line numbers for fields/classes) -projectName Descriptive name of project -output Save output in named file Output filtering options: -bugCategories only report bugs in given categories -onlyAnalyze only analyze given classes and packages -excludeBugs exclude bugs that are also reported in the baseline xml output -exclude exclude bugs matching given filter -include include only bugs matching given filter -nested[:true|false] analyze nested jar/zip archives (default=true) Detector (visitor) configuration options: -visitors run only named visitors -omitVisitors omit named visitors -chooseVisitors <+v1,-v2,...> selectively enable/disable detectors -choosePlugins <+p1,-p2,...> selectively enable/disable plugins -adjustPriority raise/lower priority of warnings for given visitor(s) Project configuration options: -auxclasspath set aux classpath for analysis -sourcepath set source path for analyzed classes -exitcode set exit code of process -noClassOk output empty warning file if no classes are specified -xargs get list of classfiles/jarfiles from standard input rather than command line User annotation persistence options: -uaPlugin class name of user annotation plugin -uaPluginProps specify configuration properties for user annotation plugin -uaSync fetch user annotations and apply them to new analysis results FILES /usr/findbugs/ installation directory /usr/findbugs/bin/ additional FindBugs commands /usr/findbugs/doc/index.html information and documentation for FindBugs /usr/findbugs/doc/manual/index.html FindBugs Manual COPYRIGHT FindBugs is free software distributed under the terms of the Lesser GNU Public License. The name FindBugs(tm) and the FindBugs logo are trade- marked by The University of Maryland. ATTRIBUTES See attributes(5) for descriptions of the following attributes: _______________________________________ | ATTRIBUTE TYPE | ATTRIBUTE VALUE| |_______________________________________ | Availability | SUNWfindbugs | |_______________________________________ | Interface Stability| Uncommitted | |____________________|_________________| NOTES Source for FindBugs is available on http://opensolaris.org. 2008 Oct 01 FINDBUGS(1)