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