Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(524)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: doc/manual/running.html

Issue 1232833004: Update findbugs from 3.0.0 to 3.0.1. (Closed) Base URL: https://chromium.googlesource.com/chromium/deps/findbugs.git@master
Patch Set: rebase again Created 5 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « doc/manual/rejarForAnalysis.html ('k') | doc/manual_ja.xml » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <html><head> 1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>Chapter&nbsp;4.&nbsp;Running FindBugs&#8482;</title><meta name="genera tor" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html " title="FindBugs&#8482; Manual"><link rel="up" href="index.html" title="FindBug s&#8482; Manual"><link rel="prev" href="building.html" title="Chapter&nbsp;3.&nb sp;Building FindBugs&#8482; from Source"><link rel="next" href="gui.html" title= "Chapter&nbsp;5.&nbsp;Using the FindBugs GUI"></head><body bgcolor="white" text= "black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><t able width="100%" summary="Navigation header"><tr><th colspan="3" align="center" >Chapter&nbsp;4.&nbsp;Running <span class="application">FindBugs</span>&#8482;</ th></tr><tr><td width="20%" align="left"><a accesskey="p" href="building.html">P rev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" alig n="right">&nbsp;<a accesskey="n" href="gui.html">Next</a></td></tr></table><hr>< /div><div class="chapter" title="Chapter&nbsp;4.&nbsp;Running FindBugs&#8482;">< div class="titlepage"><div><div><h2 class="title"><a name="running"></a>Chapter& nbsp;4.&nbsp;Running <span class="application">FindBugs</span>&#8482;</h2></div> </div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class= "sect1"><a href="running.html#d0e465">1. Quick Start</a></span></dt><dt><span cl ass="sect1"><a href="running.html#d0e503">2. Executing <span class="application" >FindBugs</span></a></span></dt><dt><span class="sect1"><a href="running.html#co mmandLineOptions">3. Command-line Options</a></span></dt></dl></div><p> 3 <title>Chapter&nbsp;4.&nbsp;Running FindBugs&#8482;</title><meta name="genera tor" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html " title="FindBugs&#8482; Manual"><link rel="up" href="index.html" title="FindBug s&#8482; Manual"><link rel="prev" href="building.html" title="Chapter&nbsp;3.&nb sp;Building FindBugs&#8482; from Source"><link rel="next" href="gui.html" title= "Chapter&nbsp;5.&nbsp;Using the FindBugs GUI"></head><body bgcolor="white" text= "black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><t able width="100%" summary="Navigation header"><tr><th colspan="3" align="center" >Chapter&nbsp;4.&nbsp;Running <span class="application">FindBugs</span>&#8482;</ th></tr><tr><td width="20%" align="left"><a accesskey="p" href="building.html">P rev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" alig n="right">&nbsp;<a accesskey="n" href="gui.html">Next</a></td></tr></table><hr>< /div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="running"></a>Chapter&nbsp;4.&nbsp;Running <span class="application">FindBu gs</span>&#8482;</h1></div></div></div><div class="toc"><p><b>Table of Contents< /b></p><dl class="toc"><dt><span class="sect1"><a href="running.html#d0e465">1. Quick Start</a></span></dt><dt><span class="sect1"><a href="running.html#d0e503" >2. Executing <span class="application">FindBugs</span></a></span></dt><dt><span class="sect1"><a href="running.html#commandLineOptions">3. Command-line Options </a></span></dt></dl></div><p>
4 <span class="application">FindBugs</span> has two user interfaces: a graphical u ser interface (GUI) and a 4 <span class="application">FindBugs</span> has two user interfaces: a graphical u ser interface (GUI) and a
5 command line user interface. This chapter describes 5 command line user interface. This chapter describes
6 how to run each of these user interfaces. 6 how to run each of these user interfaces.
7 </p><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right : 0.5in;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="warning.png"></td><th align=" left">Warning</th></tr><tr><td align="left" valign="top"><p> 7 </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" wi dth="25"><img alt="[Warning]" src="warning.png"></td><th align="left">Warning</t h></tr><tr><td align="left" valign="top"><p>
8 This chapter is in the process of being re-written. 8 This chapter is in the process of being re-written.
9 The rewrite is not complete yet. 9 The rewrite is not complete yet.
10 </p></td></tr></table></div><div class="sect1" title="1.&nbsp;Quick Star t"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a nam e="d0e465"></a>1.&nbsp;Quick Start</h2></div></div></div><p> 10 </p></td></tr></table></div><div class="sect1"><div class="titlepage"><d iv><div><h2 class="title" style="clear: both"><a name="d0e465"></a>1.&nbsp;Quick Start</h2></div></div></div><p>
11 If you are running <span class="application">FindBugs</span> on a Windo ws system, 11 If you are running <span class="application">FindBugs</span> on a Windo ws system,
12 double-click on the file <code class="filename"><em class="replaceable"> <code>%FINDBUGS_HOME%</code></em>\lib\findbugs.jar</code> to start the <span cla ss="application">FindBugs</span> GUI. 12 double-click on the file <code class="filename"><em class="replaceable"> <code>%FINDBUGS_HOME%</code></em>\lib\findbugs.jar</code> to start the <span cla ss="application">FindBugs</span> GUI.
13 </p><p> 13 </p><p>
14 On a Unix, Linux, or Mac OS X system, run the <code class="filename"><em class="replaceable"><code>$FINDBUGS_HOME</code></em>/bin/findbugs</code> 14 On a Unix, Linux, or Mac OS X system, run the <code class="filename"><em class="replaceable"><code>$FINDBUGS_HOME</code></em>/bin/findbugs</code>
15 script, or run the command </p><pre class="screen"> 15 script, or run the command </p><pre class="screen">
16 <span class="command"><strong>java -jar <em class="replaceable"><code>$FINDBUGS_ HOME</code></em>/lib/findbugs.jar</strong></span></pre><p> 16 <span class="command"><strong>java -jar <em class="replaceable"><code>$FINDBUGS_ HOME</code></em>/lib/findbugs.jar</strong></span></pre><p>
17 to run the <span class="application">FindBugs</span> GUI. 17 to run the <span class="application">FindBugs</span> GUI.
18 </p><p> 18 </p><p>
19 Refer to <a class="xref" href="gui.html" title="Chapter&nbsp;5.&nbsp;Using t he FindBugs GUI">Chapter&nbsp;5, <i>Using the <span class="application">FindBugs </span> GUI</i></a> for information on how to use the GUI. 19 Refer to <a class="xref" href="gui.html" title="Chapter&nbsp;5.&nbsp;Using t he FindBugs GUI">Chapter&nbsp;5, <i>Using the <span class="application">FindBugs </span> GUI</i></a> for information on how to use the GUI.
20 </p></div><div class="sect1" title="2.&nbsp;Executing FindBugs"><div class=" titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e503"></a> 2.&nbsp;Executing <span class="application">FindBugs</span></h2></div></div></di v><p> 20 </p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="tit le" style="clear: both"><a name="d0e503"></a>2.&nbsp;Executing <span class="appl ication">FindBugs</span></h2></div></div></div><p>
21 This section describes how to invoke the <span class="application">FindB ugs</span> program. 21 This section describes how to invoke the <span class="application">FindB ugs</span> program.
22 There are two ways to invoke <span class="application">FindBugs</span>: directly, or using a 22 There are two ways to invoke <span class="application">FindBugs</span>: directly, or using a
23 wrapper script. 23 wrapper script.
24 </p><div class="sect2" title="2.1.&nbsp;Direct invocation of FindBugs"><div class="titlepage"><div><div><h3 class="title"><a name="directInvocation"></a>2.1 .&nbsp;Direct invocation of <span class="application">FindBugs</span></h3></div> </div></div><p> 24 </p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="directInvocation"></a>2.1.&nbsp;Direct invocation of <span class="applica tion">FindBugs</span></h3></div></div></div><p>
25 The preferred method of running <span class="application">FindBugs</ span> is to directly execute 25 The preferred method of running <span class="application">FindBugs</ span> is to directly execute
26 <code class="filename"><em class="replaceable"><code>$FINDBUGS_HOME< /code></em>/lib/findbugs.jar</code> using the <span class="command"><strong>-jar </strong></span> 26 <code class="filename"><em class="replaceable"><code>$FINDBUGS_HOME< /code></em>/lib/findbugs.jar</code> using the <span class="command"><strong>-jar </strong></span>
27 command line switch of the JVM (<span class="command"><strong>java</ strong></span>) executable. 27 command line switch of the JVM (<span class="command"><strong>java</ strong></span>) executable.
28 (Versions of <span class="application">FindBugs</span> prior to 1.3. 5 required a wrapper script 28 (Versions of <span class="application">FindBugs</span> prior to 1.3. 5 required a wrapper script
29 to invoke <span class="application">FindBugs</span>.) 29 to invoke <span class="application">FindBugs</span>.)
30 </p><p> 30 </p><p>
31 The general syntax of invoking <span class="application">FindBugs</s pan> directly is the following: 31 The general syntax of invoking <span class="application">FindBugs</s pan> directly is the following:
32 </p><pre class="screen"> 32 </p><pre class="screen">
33 <span class="command"><strong>java <em class="replaceable"><code>[JVM argume nts]</code></em> -jar <em class="replaceable"><code>$FINDBUGS_HOME</code></em>/l ib/findbugs.jar <em class="replaceable"><code>options...</code></em></strong></s pan> 33 <span class="command"><strong>java <em class="replaceable"><code>[JVM argume nts]</code></em> -jar <em class="replaceable"><code>$FINDBUGS_HOME</code></em>/l ib/findbugs.jar <em class="replaceable"><code>options...</code></em></strong></s pan>
34 </pre><p> 34 </pre><p>
35 </p><div class="sect3" title="2.1.1.&nbsp;Choosing the User Interface">< div class="titlepage"><div><div><h4 class="title"><a name="chooseUI"></a>2.1.1.& nbsp;Choosing the User Interface</h4></div></div></div><p> 35 </p><div class="sect3"><div class="titlepage"><div><div><h4 class="title "><a name="chooseUI"></a>2.1.1.&nbsp;Choosing the User Interface</h4></div></div ></div><p>
36 The first command line option chooses the <span class="application"> FindBugs</span> user interface to execute. 36 The first command line option chooses the <span class="application"> FindBugs</span> user interface to execute.
37 Possible values are: 37 Possible values are:
38 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li c lass="listitem"><p> 38 </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style -type: disc; "><li class="listitem"><p>
39 <span class="command"><strong>-gui</strong></span>: runs the gra phical user interface (GUI) 39 <span class="command"><strong>-gui</strong></span>: runs the gra phical user interface (GUI)
40 </p></li><li class="listitem"><p> 40 </p></li><li class="listitem"><p>
41 <span class="command"><strong>-textui</strong></span>: runs the command line user interface 41 <span class="command"><strong>-textui</strong></span>: runs the command line user interface
42 </p></li><li class="listitem"><p> 42 </p></li><li class="listitem"><p>
43 <span class="command"><strong>-version</strong></span>: disp lays the <span class="application">FindBugs</span> version number 43 <span class="command"><strong>-version</strong></span>: disp lays the <span class="application">FindBugs</span> version number
44 </p></li><li class="listitem"><p> 44 </p></li><li class="listitem"><p>
45 <span class="command"><strong>-help</strong></span>: display s help information for the 45 <span class="command"><strong>-help</strong></span>: display s help information for the
46 <span class="application">FindBugs</span> command line user interface 46 <span class="application">FindBugs</span> command line user interface
47 </p></li><li class="listitem"><p> 47 </p></li><li class="listitem"><p>
48 <span class="command"><strong>-gui1</strong></span>: execute s the original (obsolete) 48 <span class="command"><strong>-gui1</strong></span>: execute s the original (obsolete)
49 <span class="application">FindBugs</span> graphical user int erface 49 <span class="application">FindBugs</span> graphical user int erface
50 </p></li></ul></div></div><div class="sect3" title="2.1.2.&nbsp; Java Virtual Machine (JVM) arguments"><div class="titlepage"><div><div><h4 class ="title"><a name="jvmArgs"></a>2.1.2.&nbsp;Java Virtual Machine (JVM) arguments< /h4></div></div></div><p> 50 </p></li></ul></div></div><div class="sect3"><div class="titlepa ge"><div><div><h4 class="title"><a name="jvmArgs"></a>2.1.2.&nbsp;Java Virtual M achine (JVM) arguments</h4></div></div></div><p>
51 Several Java Virtual Machine arguments are useful when invoking 51 Several Java Virtual Machine arguments are useful when invoking
52 <span class="application">FindBugs</span>. 52 <span class="application">FindBugs</span>.
53 </p><div class="variablelist"><dl><dt><span class="term"><span class ="command"><strong>-Xmx<em class="replaceable"><code>NN</code></em>m</strong></s pan></span></dt><dd><p> 53 </p><div class="variablelist"><dl class="variablelist"><dt><span cla ss="term"><span class="command"><strong>-Xmx<em class="replaceable"><code>NN</co de></em>m</strong></span></span></dt><dd><p>
54 Set the maximum Java heap size to <em class="replace able"><code>NN</code></em> 54 Set the maximum Java heap size to <em class="replace able"><code>NN</code></em>
55 megabytes. <span class="application">FindBugs</span > generally requires a large amount of 55 megabytes. <span class="application">FindBugs</span > generally requires a large amount of
56 memory. For a very large project, using 1500 megaby tes 56 memory. For a very large project, using 1500 megaby tes
57 is not unusual. 57 is not unusual.
58 </p></dd><dt><span class="term"><span class="command"><s trong>-D<em class="replaceable"><code>name</code></em>=<em class="replaceable">< code>value</code></em></strong></span></span></dt><dd><p> 58 </p></dd><dt><span class="term"><span class="command"><s trong>-D<em class="replaceable"><code>name</code></em>=<em class="replaceable">< code>value</code></em></strong></span></span></dt><dd><p>
59 Set a Java system property. For example, you might use the 59 Set a Java system property. For example, you might use the
60 argument <span class="command"><strong>-Duser.langua ge=ja</strong></span> to display 60 argument <span class="command"><strong>-Duser.langua ge=ja</strong></span> to display
61 GUI messages in Japanese. 61 GUI messages in Japanese.
62 </p></dd></dl></div></div></div><div class="sect2" title ="2.2.&nbsp;Invocation of FindBugs using a wrapper script"><div class="titlepage "><div><div><h3 class="title"><a name="wrapperScript"></a>2.2.&nbsp;Invocation o f <span class="application">FindBugs</span> using a wrapper script</h3></div></d iv></div><p> 62 </p></dd></dl></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="wrapperScript"></a>2.2.&n bsp;Invocation of <span class="application">FindBugs</span> using a wrapper scri pt</h3></div></div></div><p>
63 Another way to run <span class="application">FindBugs</span> is to u se a wrapper script. 63 Another way to run <span class="application">FindBugs</span> is to u se a wrapper script.
64 </p><p> 64 </p><p>
65 On Unix-like systems, use the following command to invoke the wrapper script: 65 On Unix-like systems, use the following command to invoke the wrapper script:
66 </p><pre class="screen"> 66 </p><pre class="screen">
67 <code class="prompt">$ </code><span class="command"><strong><em class="replaceab le"><code>$FINDBUGS_HOME</code></em>/bin/findbugs <em class="replaceable"><code> options...</code></em></strong></span> 67 <code class="prompt">$ </code><span class="command"><strong><em class="replaceab le"><code>$FINDBUGS_HOME</code></em>/bin/findbugs <em class="replaceable"><code> options...</code></em></strong></span>
68 </pre><p> 68 </pre><p>
69 </p><p> 69 </p><p>
70 On Windows systems, the command to invoke the wrapper script is 70 On Windows systems, the command to invoke the wrapper script is
71 </p><pre class="screen"> 71 </p><pre class="screen">
72 <code class="prompt">C:\My Directory&gt;</code><span class="command"><strong><em class="replaceable"><code>%FINDBUGS_HOME%</code></em>\bin\findbugs.bat <em clas s="replaceable"><code>options...</code></em></strong></span> 72 <code class="prompt">C:\My Directory&gt;</code><span class="command"><strong><em class="replaceable"><code>%FINDBUGS_HOME%</code></em>\bin\findbugs.bat <em clas s="replaceable"><code>options...</code></em></strong></span>
73 </pre><p> 73 </pre><p>
74 </p><p> 74 </p><p>
75 On both Unix-like and Windows systems, you can simply add the <code class="filen ame"><em class="replaceable"><code>$FINDBUGS_HOME</code></em>/bin</code> 75 On both Unix-like and Windows systems, you can simply add the <code class="filen ame"><em class="replaceable"><code>$FINDBUGS_HOME</code></em>/bin</code>
76 directory to your <code class="filename">PATH</code> environment variable and th en invoke 76 directory to your <code class="filename">PATH</code> environment variable and th en invoke
77 FindBugs using the <span class="command"><strong>findbugs</strong></span> comman d. 77 FindBugs using the <span class="command"><strong>findbugs</strong></span> comman d.
78 </p><div class="sect3" title="2.2.1.&nbsp;Wrapper script command line options">< div class="titlepage"><div><div><h4 class="title"><a name="wrapperOptions"></a>2 .2.1.&nbsp;Wrapper script command line options</h4></div></div></div><p>The <spa n class="application">FindBugs</span> wrapper scripts support the following comm and-line options. 78 </p><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a nam e="wrapperOptions"></a>2.2.1.&nbsp;Wrapper script command line options</h4></div ></div></div><p>The <span class="application">FindBugs</span> wrapper scripts su pport the following command-line options.
79 Note that these command line options are <span class="emphasis"><em>not< /em></span> handled by 79 Note that these command line options are <span class="emphasis"><em>not< /em></span> handled by
80 the <span class="application">FindBugs</span> program per se; rather, th ey are handled by the wrapper 80 the <span class="application">FindBugs</span> program per se; rather, th ey are handled by the wrapper
81 script. 81 script.
82 </p><div class="variablelist"><dl><dt><span class="term"><span class="co mmand"><strong>-jvmArgs <em class="replaceable"><code>args</code></em></strong>< /span></span></dt><dd><p> 82 </p><div class="variablelist"><dl class="variablelist"><dt><span class=" term"><span class="command"><strong>-jvmArgs <em class="replaceable"><code>args< /code></em></strong></span></span></dt><dd><p>
83 Specifies arguments to pass to the JVM. For example, you might want 83 Specifies arguments to pass to the JVM. For example, you might want
84 to set a JVM property: 84 to set a JVM property:
85 </p><pre class="screen"> 85 </p><pre class="screen">
86 <code class="prompt">$ </code><span class="command"><strong>findbugs -textui -jv mArgs "-Duser.language=ja" <em class="replaceable"><code>myApp.jar</code></em></ strong></span> 86 <code class="prompt">$ </code><span class="command"><strong>findbugs -textui -jv mArgs "-Duser.language=ja" <em class="replaceable"><code>myApp.jar</code></em></ strong></span>
87 </pre><p> 87 </pre><p>
88 </p></dd><dt><span class="term"><span class="command"><strong>-javahome < em class="replaceable"><code>directory</code></em></strong></span></span></dt><d d><p> 88 </p></dd><dt><span class="term"><span class="command"><strong>-javahome < em class="replaceable"><code>directory</code></em></strong></span></span></dt><d d><p>
89 Specifies the directory containing the JRE (Java Runtime Environment) to 89 Specifies the directory containing the JRE (Java Runtime Environment) to
90 use to execute <span class="application">FindBugs</span>. 90 use to execute <span class="application">FindBugs</span>.
91 </p></dd><dt><span class="term"><span class="command"><strong>-maxHeap <em class="replaceable"><code>size</code></em></strong></span></span></dt><dd><p> 91 </p></dd><dt><span class="term"><span class="command"><strong>-maxHeap <em class="replaceable"><code>size</code></em></strong></span></span></dt><dd><p>
92 Specifies the maximum Java heap size in megabytes. The default is 256. 92 Specifies the maximum Java heap size in megabytes. The default is 256.
93 More memory may be required to analyze very large programs or libraries. 93 More memory may be required to analyze very large programs or libraries.
94 </p></dd><dt><span class="term"><span class="command"><strong>-debug</stro ng></span></span></dt><dd><p> 94 </p></dd><dt><span class="term"><span class="command"><strong>-debug</stro ng></span></span></dt><dd><p>
95 Prints a trace of detectors run and classes analyzed to standard output. 95 Prints a trace of detectors run and classes analyzed to standard output.
96 Useful for troubleshooting unexpected analysis failures. 96 Useful for troubleshooting unexpected analysis failures.
97 </p></dd><dt><span class="term"><span class="command"><strong>-property</s trong></span> <em class="replaceable"><code>name=value</code></em></span></dt><d d><p> 97 </p></dd><dt><span class="term"><span class="command"><strong>-property</s trong></span> <em class="replaceable"><code>name=value</code></em></span></dt><d d><p>
98 This option sets a system property.&nbsp; <span class="application">FindBu gs</span> uses system properties 98 This option sets a system property.&nbsp; <span class="application">FindBu gs</span> uses system properties
99 to configure analysis options. See <a class="xref" href="analysisprops.ht ml" title="Chapter&nbsp;9.&nbsp;Analysis Properties">Chapter&nbsp;9, <i>Analysis Properties</i></a>. 99 to configure analysis options. See <a class="xref" href="analysisprops.ht ml" title="Chapter&nbsp;9.&nbsp;Analysis Properties">Chapter&nbsp;9, <i>Analysis Properties</i></a>.
100 You can use this option multiple times in order to set multiple properties . 100 You can use this option multiple times in order to set multiple properties .
101 Note: In most versions of Windows, the <em class="replaceable"><code>name= value</code></em> 101 Note: In most versions of Windows, the <em class="replaceable"><code>name= value</code></em>
102 string must be in quotes. 102 string must be in quotes.
103 </p></dd></dl></div></div></div></div><div class="sect1" title="3.&nbsp;Co mmand-line Options"><div class="titlepage"><div><div><h2 class="title" style="cl ear: both"><a name="commandLineOptions"></a>3.&nbsp;Command-line Options</h2></d iv></div></div><p> 103 </p></dd></dl></div></div></div></div><div class="sect1"><div class="title page"><div><div><h2 class="title" style="clear: both"><a name="commandLineOption s"></a>3.&nbsp;Command-line Options</h2></div></div></div><p>
104 This section describes the command line options supported by <span class="ap plication">FindBugs</span>. 104 This section describes the command line options supported by <span class="ap plication">FindBugs</span>.
105 These command line options may be used when invoking <span class="applicatio n">FindBugs</span> directly, 105 These command line options may be used when invoking <span class="applicatio n">FindBugs</span> directly,
106 or when using a wrapper script. 106 or when using a wrapper script.
107 </p><div class="sect2" title="3.1.&nbsp;Common command-line options"><div class= "titlepage"><div><div><h3 class="title"><a name="d0e796"></a>3.1.&nbsp;Common co mmand-line options</h3></div></div></div><p> 107 </p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a nam e="d0e796"></a>3.1.&nbsp;Common command-line options</h3></div></div></div><p>
108 These options may be used with both the GUI and command-line interfaces. 108 These options may be used with both the GUI and command-line interfaces.
109 </p><div class="variablelist"><dl><dt><span class="term"><span class="command">< strong>-effort:min</strong></span></span></dt><dd><p> 109 </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><s pan class="command"><strong>-effort:min</strong></span></span></dt><dd><p>
110 This option disables analyses that increase precision but also 110 This option disables analyses that increase precision but also
111 increase memory consumption. You may want to try this option if 111 increase memory consumption. You may want to try this option if
112 you find that <span class="application">FindBugs</span> runs out of memory , or takes an unusually 112 you find that <span class="application">FindBugs</span> runs out of memory , or takes an unusually
113 long time to complete its analysis. 113 long time to complete its analysis.
114 </p></dd><dt><span class="term"><span class="command"><strong>-effort:max< /strong></span></span></dt><dd><p> 114 </p></dd><dt><span class="term"><span class="command"><strong>-effort:max< /strong></span></span></dt><dd><p>
115 Enable analyses which increase precision and find more bugs, but which 115 Enable analyses which increase precision and find more bugs, but which
116 may require more memory and take more time to complete. 116 may require more memory and take more time to complete.
117 </p></dd><dt><span class="term"><span class="command"><strong>-project</st rong></span> <em class="replaceable"><code>project</code></em></span></dt><dd><p > 117 </p></dd><dt><span class="term"><span class="command"><strong>-project</st rong></span> <em class="replaceable"><code>project</code></em></span></dt><dd><p >
118 Specify a project to be analyzed. The project file you specify should 118 Specify a project to be analyzed. The project file you specify should
119 be one that was created using the GUI interface. It will typically end 119 be one that was created using the GUI interface. It will typically end
120 in the extension <code class="filename">.fb</code> or <code class="filename" >.fbp</code>. 120 in the extension <code class="filename">.fb</code> or <code class="filename" >.fbp</code>.
121 </p></dd></dl></div></div><div class="sect2" title="3.2.&nbsp;GUI Options">< div class="titlepage"><div><div><h3 class="title"><a name="d0e836"></a>3.2.&nbsp ;GUI Options</h3></div></div></div><p> 121 </p></dd></dl></div></div><div class="sect2"><div class="titlepage"><div><di v><h3 class="title"><a name="d0e836"></a>3.2.&nbsp;GUI Options</h3></div></div>< /div><p>
122 These options are only accepted by the Graphical User Interface. 122 These options are only accepted by the Graphical User Interface.
123 123
124 </p><div class="variablelist"><dl><dt><span class="term"><span class="command">< strong>-look:</strong></span><em class="replaceable"><code>plastic|gtk|native</c ode></em></span></dt><dd><p> 124 </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><s pan class="command"><strong>-look:</strong></span><em class="replaceable"><code> plastic|gtk|native</code></em></span></dt><dd><p>
125 Set Swing look and feel. 125 Set Swing look and feel.
126 </p></dd></dl></div><p> 126 </p></dd></dl></div><p>
127 </p></div><div class="sect2" title="3.3.&nbsp;Text UI Options"><div class="title page"><div><div><h3 class="title"><a name="d0e852"></a>3.3.&nbsp;Text UI Options </h3></div></div></div><p> 127 </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"> <a name="d0e852"></a>3.3.&nbsp;Text UI Options</h3></div></div></div><p>
128 These options are only accepted by the Text User Interface. 128 These options are only accepted by the Text User Interface.
129 </p><div class="variablelist"><dl><dt><span class="term"><span class="command">< strong>-sortByClass</strong></span></span></dt><dd><p> 129 </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><s pan class="command"><strong>-sortByClass</strong></span></span></dt><dd><p>
130 Sort reported bug instances by class name. 130 Sort reported bug instances by class name.
131 </p></dd><dt><span class="term"><span class="command"><strong>-include</s trong></span> <em class="replaceable"><code>filterFile.xml</code></em></span></d t><dd><p> 131 </p></dd><dt><span class="term"><span class="command"><strong>-include</s trong></span> <em class="replaceable"><code>filterFile.xml</code></em></span></d t><dd><p>
132 Only report bug instances that match the filter specified by <em class="r eplaceable"><code>filterFile.xml</code></em>. 132 Only report bug instances that match the filter specified by <em class="r eplaceable"><code>filterFile.xml</code></em>.
133 See <a class="xref" href="filter.html" title="Chapter&nbsp;8.&nbsp;Filter Files">Chapter&nbsp;8, <i>Filter Files</i></a>. 133 See <a class="xref" href="filter.html" title="Chapter&nbsp;8.&nbsp;Filter Files">Chapter&nbsp;8, <i>Filter Files</i></a>.
134 </p></dd><dt><span class="term"><span class="command"><strong>-exclude</s trong></span> <em class="replaceable"><code>filterFile.xml</code></em></span></d t><dd><p> 134 </p></dd><dt><span class="term"><span class="command"><strong>-exclude</s trong></span> <em class="replaceable"><code>filterFile.xml</code></em></span></d t><dd><p>
135 Report all bug instances except those matching the filter specified by <e m class="replaceable"><code>filterFile.xml</code></em>. 135 Report all bug instances except those matching the filter specified by <e m class="replaceable"><code>filterFile.xml</code></em>.
136 See <a class="xref" href="filter.html" title="Chapter&nbsp;8.&nbsp;Filter Files">Chapter&nbsp;8, <i>Filter Files</i></a>. 136 See <a class="xref" href="filter.html" title="Chapter&nbsp;8.&nbsp;Filter Files">Chapter&nbsp;8, <i>Filter Files</i></a>.
137 </p></dd><dt><span class="term"><span class="command"><strong>-onlyAnalyz e</strong></span> <em class="replaceable"><code>com.foobar.MyClass,com.foobar.my pkg.*</code></em></span></dt><dd><p> 137 </p></dd><dt><span class="term"><span class="command"><strong>-onlyAnalyz e</strong></span> <em class="replaceable"><code>com.foobar.MyClass,com.foobar.my pkg.*</code></em></span></dt><dd><p>
138 Restrict analysis to find bugs to given comma-separated list of 138 Restrict analysis to find bugs to given comma-separated list of
139 classes and packages. 139 classes and packages.
(...skipping 69 matching lines...) Expand 10 before | Expand all | Expand 10 after
209 </p></dd><dt><span class="term"><span class="command"><strong>-analyzeFromFi le</strong></span> <em class="replaceable"><code>filepath</code></em></span></dt ><dd><p> 209 </p></dd><dt><span class="term"><span class="command"><strong>-analyzeFromFi le</strong></span> <em class="replaceable"><code>filepath</code></em></span></dt ><dd><p>
210 Read the files to analyze from file, each line adds new 210 Read the files to analyze from file, each line adds new
211 entry to the classpath for analysis. 211 entry to the classpath for analysis.
212 </p></dd><dt><span class="term"><span class="command"><strong>-userPrefs</st rong></span> <em class="replaceable"><code>edu.umd.cs.findbugs.core.prefs</code> </em></span></dt><dd><p> 212 </p></dd><dt><span class="term"><span class="command"><strong>-userPrefs</st rong></span> <em class="replaceable"><code>edu.umd.cs.findbugs.core.prefs</code> </em></span></dt><dd><p>
213 Set the path of the user preferences file to use, which might override some of the options abobe. 213 Set the path of the user preferences file to use, which might override some of the options abobe.
214 Specifying <code class="literal">userPrefs</code> as first argument would me an some later 214 Specifying <code class="literal">userPrefs</code> as first argument would me an some later
215 options will override them, as last argument would mean they will override s ome previous options). 215 options will override them, as last argument would mean they will override s ome previous options).
216 This rationale behind this option is to reuse FindBugs Eclipse project setti ngs for command 216 This rationale behind this option is to reuse FindBugs Eclipse project setti ngs for command
217 line execution. 217 line execution.
218 </p></dd></dl></div></div></div></div><div class="navfooter"><hr><table widt h="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accessk ey="p" href="building.html">Prev</a>&nbsp;</td><td width="20%" align="center">&n bsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="gui.html">Ne xt</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;3.&nb sp;Building <span class="application">FindBugs</span>&#8482; from Source&nbsp;</ td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></t d><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;5.&nbsp;Using th e <span class="application">FindBugs</span> GUI</td></tr></table></div></body></ html> 218 </p></dd></dl></div></div></div></div><div class="navfooter"><hr><table widt h="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accessk ey="p" href="building.html">Prev</a>&nbsp;</td><td width="20%" align="center">&n bsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="gui.html">Ne xt</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;3.&nb sp;Building <span class="application">FindBugs</span>&#8482; from Source&nbsp;</ td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></t d><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;5.&nbsp;Using th e <span class="application">FindBugs</span> GUI</td></tr></table></div></body></ html>
OLDNEW
« no previous file with comments | « doc/manual/rejarForAnalysis.html ('k') | doc/manual_ja.xml » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698