Add a link from the LLVM release notes to the Clang release notes.
[oota-llvm.git] / docs / CommandGuide / llvm-extract.pod
index 77f5ee8153fb3b7e501e2f45d9ae2f5a8a125618..67f00f0b8615643e82768edbd98306f9c957e614 100644 (file)
@@ -11,10 +11,10 @@ B<llvm-extract> [I<options>] B<--func> I<function-name> [I<filename>]
 =head1 DESCRIPTION
 
 The B<llvm-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 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,
+In addition to extracting the bitcode of the specified function,
 B<llvm-extract> will also remove unreachable global variables, prototypes, and
 unused types.
 
@@ -28,15 +28,33 @@ unless the B<-o> option is specified (see below).
 
 =item B<-f>
 
-Force overwrite.  Normally, B<llvm-extract> will refuse to overwrite an
-output file that already exists.  With this option, B<llvm-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<--rfunc> I<function-regular-expr>
+
+Extract the function(s) matching I<function-regular-expr> from the LLVM bitcode.
+All functions matching the regular expression will be extracted.  May be 
+specified multiple times.
+
+=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<--rglob> I<glob-regular-expr>
+
+Extract the global variable(s) matching I<global-regular-expr> from the LLVM
+bitcode. All global variables matching the regular expression will be extracted.
+May be specified multiple times.
+
+=item B<-help>
 
 Print a summary of command line options.
 
@@ -45,6 +63,10 @@ Print a summary of command line options.
 Specify the output filename.  If filename is "-" (the default), then
 B<llvm-extract> sends its output to standard output.
 
+=item B<-S>
+
+Write output in LLVM intermediate language (instead of bitcode).
+
 =back
 
 =head1 EXIT STATUS
@@ -58,6 +80,6 @@ L<bugpoint|bugpoint>
 
 =head1 AUTHORS
 
-Maintained by the LLVM Team (L<http://llvm.org>).
+Maintained by the LLVM Team (L<http://llvm.org/>).
 
 =cut