Adding a skeleton for the LLVM Command Guide.
[oota-llvm.git] / docs / CommandGuide / analyze.html
1 <html>
2 <title>
3 analyze
4 </title>
5
6 <body>
7
8 <center>
9 <h1>Low Level Virtual Machine</h1>
10 </center>
11 <HR>
12
13 <h3>
14 NAME
15 </h3>
16
17 analyze
18
19 <h3>
20 SYNOPSIS
21 </h3>
22
23 analyze [options] &lt; filename&gt;
24 <h3>
25 DESCRIPTION
26 </h3>
27
28 The analyze command performs various analysis of LLVM bytecode.  It will
29 usually print the results on standard output, but in a few cases it will print
30 output to standard error or generate a file with the analysis output (which is
31 usually done when generating output for another program).
32 <h3>
33 OPTIONS
34 </h3>
35
36 <ul>
37         <li> -help
38         <br>
39         Print a summary of command line options.
40         <p>
41
42         <li> -stats
43         <br>
44         Print statistics.
45         <p>
46
47         <li> -time-passes
48         <br>
49         Record the amount of time needed for each pass and print it to standard
50         error.
51         <p>
52
53         <li> -q
54         <br>
55         Quiet mode.  With this option, analysis pass names are not printed.
56         <p>
57
58         <li> -load &lt;plugin.so&gt;
59         <br>
60         Load the specified dynamic object with name plugin.so.  This file
61         should contain additional analysis passes that register themselves with
62         the analyze program after being loaded.
63         <p>
64         After being loaded, additional command line options are made available
65         for running additional analysis passes.  Use analyse -load
66         &lt;plugin.so&gt; -help to list the new list of available analysis
67         passes.
68         <p>
69 </ul>
70
71 <h3>
72 EXIT STATUS
73 </h3>
74
75 If analyze succeeds, it will exit with 0.  Otherwise, if an error occurs, it
76 will exit with a non-zero value.
77
78 <h3>
79 SEE ALSO
80 </h3>
81 opt
82
83 <HR>
84 University of Illinois at Urbana-Champaign
85 </body>
86 </html>
87