blob: de4655fc99a69484fa8ff656a9efe6de0393e1aa [file] [log] [blame]
John Criswell58ebcd02003-09-17 14:11:24 +00001<html>
2<title>
Chris Lattneree43b692003-09-25 19:50:05 +00003LLVM: extract tool
John Criswell58ebcd02003-09-17 14:11:24 +00004</title>
5
6<body>
7
8<center>
Chris Lattnerf8cf4162003-10-07 19:48:25 +00009<h1>LLVM: <tt>extract</tt> tool</h1>
John Criswell58ebcd02003-09-17 14:11:24 +000010</center>
11<HR>
12
Chris Lattnerf8cf4162003-10-07 19:48:25 +000013<h3>NAME</h3>
14<tt>extract</tt>
John Criswell58ebcd02003-09-17 14:11:24 +000015
16<h3>
17SYNOPSIS
18</h3>
19
Chris Lattnerf8cf4162003-10-07 19:48:25 +000020<tt>extract [options] [filename]</tt>
John Criswell58ebcd02003-09-17 14:11:24 +000021<h3>
22DESCRIPTION
23</h3>
24
Chris Lattnerf8cf4162003-10-07 19:48:25 +000025The <tt>extract</tt> command takes the name of a function and extracts it from
26the specified LLVM bytecode file. It is primarily used as a debugging tool to
John Criswell58ebcd02003-09-17 14:11:24 +000027reduce test cases from larger programs that are triggering a bug.
John Criswellac41ea22003-09-30 22:55:44 +000028<p>
29
Chris Lattnerf8cf4162003-10-07 19:48:25 +000030In addition to extracting the bytecode of the specified function,
31<tt>extract</tt> will also remove unreachable global variables, prototypes, and
32unused types.
John Criswellac41ea22003-09-30 22:55:44 +000033<p>
34
Chris Lattnerf8cf4162003-10-07 19:48:25 +000035The <tt>extract</tt> command reads its input from standard input if filename is
John Criswellac41ea22003-09-30 22:55:44 +000036omitted or if filename is -. The output is always written to standard output.
John Criswell58ebcd02003-09-17 14:11:24 +000037
38<h3>
39OPTIONS
40</h3>
41
42<ul>
43 <li>-func &lt;function&gt;
44 <br>
Chris Lattnerf8cf4162003-10-07 19:48:25 +000045 Extract the specified function from the LLVM bytecode.
John Criswell58ebcd02003-09-17 14:11:24 +000046 <p>
47
48 <li> -help
49 <br>
50 Print a summary of command line options.
51 <p>
John Criswell58ebcd02003-09-17 14:11:24 +000052</ul>
53
54<h3>
55EXIT STATUS
56</h3>
57
Chris Lattnerf8cf4162003-10-07 19:48:25 +000058If <tt>extract</tt> succeeds, it will exit with 0. Otherwise, if an error
59occurs, it will exit with a non-zero value.
John Criswell58ebcd02003-09-17 14:11:24 +000060
61<h3>
62SEE ALSO
63</h3>
Chris Lattnerf8cf4162003-10-07 19:48:25 +000064<a href="bugpoint.html"><tt>bugpoint</tt></a>
John Criswell58ebcd02003-09-17 14:11:24 +000065
66<HR>
67<a href="http://llvm.cs.uiuc.edu">LLVM Team</a>
68</body>
69</html>
70