A minor fix
[oota-llvm.git] / docs / CommandGuide / extract.html
index 275b9b1e0c6a0d887204cc7369828486d7c7a22a..1e2301d1eb1cb3fba47f071a471c7a7f629094fc 100644 (file)
@@ -1,33 +1,39 @@
 <html>
 <title>
-extract
+LLVM: extract tool
 </title>
 
-<body>
+<body bgcolor=white>
 
 <center>
-<h1>Low Level Virtual Machine</h1>
+<h1>LLVM: <tt>extract</tt> tool</h1>
 </center>
 <HR>
 
-<h3>
-NAME
-</h3>
-
-extract
+<h3>NAME</h3>
+<tt>extract</tt>
 
 <h3>
 SYNOPSIS
 </h3>
 
-extract [options] &lt;filename&gt; [filename ...]
+<tt>extract [options] [filename]</tt>
 <h3>
 DESCRIPTION
 </h3>
 
-The extract command takes the name of a function and extracts it from the
-specified LLVM bytecode file.  It is primarily used as a debugging tool to
+The <tt>extract</tt> command takes the name of a function and extracts it from
+the specified LLVM bytecode file.  It is primarily used as a debugging tool to
 reduce test cases from larger programs that are triggering a bug.
+<p>
+
+In addition to extracting the bytecode of the specified function,
+<tt>extract</tt> will also remove unreachable global variables, prototypes, and
+unused types.
+<p>
+
+The <tt>extract</tt> command reads its input from standard input if filename is
+omitted or if filename is -.  The output is always written to standard output.
 
 <h3>
 OPTIONS
@@ -36,39 +42,29 @@ OPTIONS
 <ul>
        <li>-func &lt;function&gt;
        <br>
-       Extract function from the LLVM bytecode.
+       Extract the specified function from the LLVM bytecode.
        <p>
 
        <li> -help
        <br>
        Print a summary of command line options.
        <p>
-
-       <li> -stats
-       <br>
-       Print statistics.
-       <p>
-
-       <li> -time-passes
-       <br>
-       Record the amount of time needed for each pass and print it to standard
-       error.
 </ul>
 
 <h3>
 EXIT STATUS
 </h3>
 
-If extract succeeds, it will exit with 0.  Otherwise, if an error occurs, it
-will exit with a non-zero value.
+If <tt>extract</tt> succeeds, it will exit with 0.  Otherwise, if an error
+occurs, it will exit with a non-zero value.
 
 <h3>
 SEE ALSO
 </h3>
-bugpoint
+<a href="bugpoint.html"><tt>bugpoint</tt></a>
 
 <HR>
-<a href="http://llvm.cs.uiuc.edu">LLVM Team</a>
+Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
 </body>
 </html>