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>OPTIONS</h3>
  39
  40 <ul>
  41 <ul>
  42         <li> -f
  43         <br>
  44         Force overwrite.  Normally, <tt>extract</tt> will refuse to overwrite an
  45         output file that already exists.  With this option, <tt>extract</tt>
  46         will overwrite the output file and replace it with new bytecode.
  47         <p>
  48
  49         <li>-func &lt;function&gt;
  50         <br>
  51         Extract the specified function from the LLVM bytecode.
  52         <p>
  53
  54         <li> -help
  55         <br>
  56         Print a summary of command line options.
  57         <p>
  58
  59         <li> -o &lt;filename&gt;
  60         <br>
  61         Specify the output filename.  If filename is "-" (the default), then
  62         <tt>extract</tt> sends its output to standard output.
  63         <p>
  64
  65         <li> -stats
  66         <br>
  67         Print statistics.
  68         <p>
  69
  70         <li> -time-passes
  71         <br>
  72         Record the amount of time needed for each pass and print it to standard
  73         error.
  74         <p>
  75 </ul>
  76
  77 <h3>
  78 EXIT STATUS
  79 </h3>
  80
  81 If <tt>extract</tt> succeeds, it will exit with 0.  Otherwise, if an error
  82 occurs, it will exit with a non-zero value.
  83
  84 <h3>
  85 SEE ALSO
  86 </h3>
  87 <a href="bugpoint.html"><tt>bugpoint</tt></a>
  88
  89 <HR>
  90 Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
  91 </body>
  92 </html>
  93