Add an !eq() operator to TableGen. It operates on strings only.
[oota-llvm.git] / docs / CommandGuide / opt.pod
index 6d409565e906abab0167174c04fdd0de77eebc38..d1d1db5ef67ed548938d1b9ab1f363d543bca7a4 100644 (file)
@@ -11,24 +11,25 @@ B<opt> [I<options>] [I<filename>]
 =head1 DESCRIPTION
 
 The B<opt> command is the modular LLVM optimizer and analyzer.  It takes LLVM 
-bytecode as input, runs the specified optimizations or analyses on it, and then
-outputs the optimized LLVM bytecode or the analysis results.  The function of 
+source files as input, runs the specified optimizations or analyses on it, and then
+outputs the optimized file or the analysis results.  The function of 
 B<opt> depends on whether the B<-analyze> option is given. 
 
-When B<-analyze> is specified, B<opt> performs various analyses of LLVM 
-bytecode.  It will usually print the results on standard output, but in a few 
-cases, it will print output to standard error or generate a file with the 
-analysis output, which is usually done when the output is meant for another 
-program.  
+When B<-analyze> is specified, B<opt> performs various analyses of the input
+source.  It will usually print the results on standard output, but in a few
+cases, it will print output to standard error or generate a file with the
+analysis output, which is usually done when the output is meant for another
+program.
 
 While B<-analyze> is I<not> given, B<opt> attempts to produce an optimized 
-bytecode file.  The optimizations available via B<opt> depend upon what 
+output file.  The optimizations available via B<opt> depend upon what 
 libraries were linked into it as well as any additional libraries that have 
 been loaded with the B<-load> option.  Use the B<-help> option to determine 
 what optimizations you can use.
 
 If I<filename> is omitted from the command line or is I<->, B<opt> reads its
-input from standard input. The input must be an LLVM bytecode file.
+input from standard input. Inputs can be in either the LLVM assembly language
+format (.ll) or the LLVM bitcode format (.bc).
 
 If an output filename is not specified with the B<-o> option, B<opt>
 writes its output to the standard output.
@@ -39,9 +40,9 @@ writes its output to the standard output.
 
 =item B<-f>
 
-Force overwrite.  Normally, B<opt> will refuse to overwrite an
-output file that already exists.  With this option, B<opt> will
-overwrite the output file and replace it with new bytecode.
+Enable binary output on terminals.  Normally, B<opt> will refuse to
+write raw bitcode output if the output stream is a terminal. With this option,
+B<opt> will write raw bitcode regardless of the output device.
 
 =item B<-help>
 
@@ -51,6 +52,10 @@ Print a summary of command line options.
 
 Specify the output filename.
 
+=item B<-S>
+
+Write output in LLVM intermediate language (instead of bitcode).
+
 =item B<-{passname}>
 
 B<opt> provides the ability to run any of LLVM's optimization or analysis passes