.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
.TH FINDBUGS "1" "March 2018" "findbugs 3.1.0-dev-20180312-UNKNOWN" "User Commands"
.SH NAME
findbugs \- Static Java Code Analyzer
.SH SYNOPSIS
.B findbugs
[\fI\,general options\/\fR] \fI\,-textui \/\fR[\fI\,command line options\/\fR...] [\fI\,jar/zip/class files, directories\/\fR...]
.SH DESCRIPTION
No files to be analyzed
.SS "General options:"
.TP
\fB\-jvmArgs\fR args
Pass args to JVM
.TP
\fB\-maxHeap\fR size
Maximum Java heap size in megabytes (default=768)
.TP
\fB\-javahome\fR <dir>
Specify location of JRE
.IP
General FindBugs options:
.TP
\fB\-project\fR <project>
analyze given project
.TP
\fB\-home\fR <home directory>
specify FindBugs home directory
.TP
\fB\-pluginList\fR <jar1[:jar2...]>
specify list of plugin Jar files to load
.TP
\fB\-effort[\fR:min|less|default|more|max]
set analysis effort level
.TP
\fB\-adjustExperimental\fR
lower priority of experimental Bug Patterns
.TP
\fB\-workHard\fR
ensure analysis effort is at least 'default'
.TP
\fB\-conserveSpace\fR
same as \fB\-effort\fR:min (for backward compatibility)
.TP
\fB\-showPlugins\fR
show list of available detector plugins
.TP
\fB\-userPrefs\fR <filename>
user preferences file, e.g /path/to/project/.settings/edu.umd.cs.findbugs.core.prefs for Eclipse projects
.IP
Output options:
.TP
\fB\-timestampNow\fR
set timestamp of results to be current time
.TP
\fB\-quiet\fR
suppress error messages
.TP
\fB\-longBugCodes\fR
report long bug codes
.TP
\fB\-progress\fR
display progress in terminal window
.TP
\fB\-release\fR <release name>
set the release name of the analyzed application
.TP
\fB\-experimental\fR
report of any confidence level including experimental bug patterns
.TP
\fB\-low\fR
report warnings of any confidence level
.TP
\fB\-medium\fR
report only medium and high confidence warnings [default]
.TP
\fB\-high\fR
report only high confidence warnings
.TP
\fB\-maxRank\fR <rank>
only report issues with a bug rank at least as scary as that provided
.TP
\fB\-dontCombineWarnings\fR
Don't combine warnings that differ only in line number
.TP
\fB\-sortByClass\fR
sort warnings by class
.TP
\fB\-xml[\fR:withMessages]
XML output (optionally with messages)
.TP
\fB\-xdocs\fR
xdoc XML output to use with Apache Maven
.TP
\fB\-html[\fR:stylesheet]
Generate HTML output (default stylesheet is default.xsl)
.TP
\fB\-emacs\fR
Use emacs reporting format
.TP
\fB\-relaxed\fR
Relaxed reporting mode (more false positives!)
.TP
\fB\-train[\fR:outputDir]
Save training data (experimental); output dir defaults to '.'
.TP
\fB\-useTraining[\fR:inputDir]
Use training data (experimental); input dir defaults to '.'
.TP
\fB\-redoAnalysis\fR <filename>
Redo analysis using configureation from previous analysis
.TP
\fB\-sourceInfo\fR <filename>
Specify source info file (line numbers for fields/classes)
.TP
\fB\-projectName\fR <project name>
Descriptive name of project
.TP
\fB\-reanalyze\fR <filename>
redo analysis in provided file
.TP
\fB\-output\fR <filename>
Save output in named file
.TP
\fB\-nested[\fR:true|false]
analyze nested jar/zip archives (default=true)
.IP
Output filtering options:
.TP
\fB\-bugCategories\fR <cat1[,cat2...]>
only report bugs in given categories
.TP
\fB\-onlyAnalyze\fR <classes/packages>
only analyze given classes and packages; end with .* to indicate classes in a package, .\- to indicate a package prefix
.TP
\fB\-excludeBugs\fR <baseline bugs>
exclude bugs that are also reported in the baseline xml output
.TP
\fB\-exclude\fR <filter file>
exclude bugs matching given filter
.TP
\fB\-include\fR <filter file>
include only bugs matching given filter
.TP
\fB\-applySuppression\fR
Exclude any bugs that match suppression filter loaded from fbp file
.IP
Detector (visitor) configuration options:
.TP
\fB\-visitors\fR <v1[,v2...]>
run only named visitors
.TP
\fB\-omitVisitors\fR <v1[,v2...]>
omit named visitors
.TP
\fB\-chooseVisitors\fR <+v1,\-v2,...>
selectively enable/disable detectors
.TP
\fB\-choosePlugins\fR <+p1,\-p2,...>
selectively enable/disable plugins
.HP
\fB\-adjustPriority\fR <v1=(raise|lower)[,...]> raise/lower priority of warnings for given visitor(s)
.IP
Project configuration options:
.TP
\fB\-auxclasspath\fR <classpath>
set aux classpath for analysis
.TP
\fB\-auxclasspathFromInput\fR
read aux classpath from standard input
.TP
\fB\-auxclasspathFromFile\fR <filepath>
read aux classpaths from a designated file
.TP
\fB\-sourcepath\fR <source path>
set source path for analyzed classes
.TP
\fB\-exitcode\fR
set exit code of process
.TP
\fB\-noClassOk\fR
output empty warning file if no classes are specified
.TP
\fB\-xargs\fR
get list of classfiles/jarfiles from standard input rather than command line
.TP
\fB\-analyzeFromFile\fR <filepath>
get the list of class/jar files from a designated file
.TP
\fB\-cloud\fR <id>
set cloud id
.TP
\fB\-cloudProperty\fR <key=value>
set cloud property
.TP
\fB\-bugReporters\fR <name,name2,\-name3>
bug reporter decorators to explicitly enable/disable
.TP
\fB\-printConfiguration\fR
print configuration and exit, without running analysis
.TP
\fB\-version\fR
print version, check for updates and exit, without running analysis
.SH "SEE ALSO"
The full documentation for
.B findbugs
is maintained as a Texinfo manual.  If the
.B info
and
.B findbugs
programs are properly installed at your site, the command
.IP
.B info findbugs
.PP
should give you access to the complete manual.