Corrected usage synopsis.
[oota-llvm.git] / docs / CommandGuide / extract.html
1 <html>
2 <title>
3 LLVM: extract tool
4 </title>
5
6 <body>
7
8 <center>
9 <h1>LLVM: extract tool</h1>
10 </center>
11 <HR>
12
13 <h3>
14 NAME
15 </h3>
16
17 extract
18
19 <h3>
20 SYNOPSIS
21 </h3>
22
23 extract [options] [filename]
24 <h3>
25 DESCRIPTION
26 </h3>
27
28 The extract command takes the name of a function and extracts it from the
29 specified LLVM bytecode file.  It is primarily used as a debugging tool to
30 reduce test cases from larger programs that are triggering a bug.
31 <p>
32
33 In addition to extracting the bytecode of the specified function, extract will
34 also remove unreachable global variables, prototypes, and unused types.
35 <p>
36
37 The extract command will read its input from standard input if filename is
38 omitted or if filename is -.  The output is always written to standard output.
39
40 <h3>
41 OPTIONS
42 </h3>
43
44 <ul>
45         <li>-func &lt;function&gt;
46         <br>
47         Extract function from the LLVM bytecode.
48         <p>
49
50         <li> -help
51         <br>
52         Print a summary of command line options.
53         <p>
54
55         <li> -stats
56         <br>
57         Print statistics.
58         <p>
59
60         <li> -time-passes
61         <br>
62         Record the amount of time needed for each pass and print it to standard
63         error.
64 </ul>
65
66 <h3>
67 EXIT STATUS
68 </h3>
69
70 If extract succeeds, it will exit with 0.  Otherwise, if an error occurs, it
71 will exit with a non-zero value.
72
73 <h3>
74 SEE ALSO
75 </h3>
76 bugpoint
77
78 <HR>
79 <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>
80 </body>
81 </html>
82