Dragonegg release notes.

[oota-llvm.git] / docs / CommandGuide / llvm-extract.pod

diff --git a/docs/CommandGuide/llvm-extract.pod b/docs/CommandGuide/llvm-extract.pod
index 3232d8ef21d2e78d77790c6f567b8e0051074a89..d4baab73991a8b1005a29691edcafe08fd91e491 100644 (file)
--- a/docs/CommandGuide/llvm-extract.pod
+++ b/docs/CommandGuide/llvm-extract.pod
@@ -2,23 +2,23 @@
 
 =head1 NAME
 
-extract - extract a function from an LLVM module
+llvm-extract - extract a function from an LLVM module
 
 =head1 SYNOPSIS
 
-B<extract> [I<options>] B<--func> I<function-name> [I<filename>]
+B<llvm-extract> [I<options>] B<--func> I<function-name> [I<filename>]
 
 =head1 DESCRIPTION
 
-The B<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 B<llvm-extract> command takes the name of a function and extracts it from
+the specified LLVM bitcode file.  It is primarily used as a debugging tool to
 reduce test cases from larger programs that are triggering a bug.
 
-In addition to extracting the bytecode of the specified function,
-B<extract> will also remove unreachable global variables, prototypes, and
+In addition to extracting the bitcode of the specified function,
+B<llvm-extract> will also remove unreachable global variables, prototypes, and
 unused types.
 
-The B<extract> command reads its input from standard input if filename is
+The B<llvm-extract> command reads its input from standard input if filename is
 omitted or if filename is -.  The output is always written to standard output,
 unless the B<-o> option is specified (see below).
 
@@ -28,37 +28,38 @@ unless the B<-o> option is specified (see below).
 
 =item B<-f>
 
-Force overwrite.  Normally, B<extract> will refuse to overwrite an
-output file that already exists.  With this option, B<extract>
-will overwrite the output file and replace it with new bytecode.
+Enable binary output on terminals.  Normally, B<llvm-extract> will refuse to
+write raw bitcode output if the output stream is a terminal. With this option,
+B<llvm-extract> will write raw bitcode regardless of the output device.
 
 =item B<--func> I<function-name>
 
-Extract the function named I<function-name> from the LLVM bytecode.
+Extract the function named I<function-name> from the LLVM bitcode. May be
+specified multiple times to extract multiple functions at once.
 
-=item B<--help>
+=item B<--glob> I<global-name>
+
+Extract the global variable named I<global-name> from the LLVM bitcode. May be
+specified multiple times to extract multiple global variables at once.
+
+=item B<-help>
 
 Print a summary of command line options.
 
 =item B<-o> I<filename>
 
 Specify the output filename.  If filename is "-" (the default), then
-B<extract> sends its output to standard output.
-
-=item B<--stats>
-
-Print statistics.
+B<llvm-extract> sends its output to standard output.
 
-=item B<--time-passes>
+=item B<-S>
 
-Record the amount of time needed for each pass and print it to standard
-error.
+Write output in LLVM intermediate language (instead of bitcode).
 
 =back
 
 =head1 EXIT STATUS
 
-If B<extract> succeeds, it will exit with 0.  Otherwise, if an error
+If B<llvm-extract> succeeds, it will exit with 0.  Otherwise, if an error
 occurs, it will exit with a non-zero value.
 
 =head1 SEE ALSO
@@ -67,6 +68,6 @@ L<bugpoint|bugpoint>
 
 =head1 AUTHORS
 
-Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
+Maintained by the LLVM Team (L<http://llvm.org>).
 
 =cut