validation fixes
[oota-llvm.git] / docs / CommandGuide / llvmgxx.pod
index b29174b107f3088020e006aa717a24100522c7f8..219d608b52b69231dd83b21fb07c7cfe4b029cf0 100644 (file)
@@ -2,26 +2,23 @@
 
 =head1 NAME
 
-llvmg++ - LLVM C++ front-end
+llvm-g++ - LLVM C++ front-end
 
 =head1 SYNOPSIS
 
-B<llvmg++> [I<options>] I<filename>
+B<llvm-g++> [I<options>] I<filename>
 
 =head1 DESCRIPTION
 
-The B<llvmg++> command is the LLVM C++ front end.  It is a modified
-version of g++ that takes C++ programs and compiles them into LLVM
-bytecode or assembly language, depending upon the options.
+The B<llvm-g++> command is the LLVM C++ front end.  It is a modified
+version of g++ that compiles C++/ObjC++ programs into native code, 
+LLVM bytecode or assembly language, depending upon the options.
 
-Unless the B<-S> option is specified, B<llvmg++> will use the
-L<gccas|gccas> program to perform some optimizations and create an
-LLVM bytecode file. Unless the B<-c> option is specified, B<llvmg++>
-will also use the L<gccld|gccld> program to perform further
-optimizations and link the resulting bytecode file(s) with support
-libraries to create an executable program.
+By default, B<llvm-g++> compiles to native objects just like GCC does. If the
+B<-emit-llvm> option is given then it will generate LLVM bytecode files instead.
+If B<-S> (assembly) is also given, then it will generate LLVM assembly. 
 
-Being derived from the GNU Compiler Collection, B<llvmg++> has many
+Being derived from the GNU Compiler Collection, B<llvm-g++> has many
 of g++'s features and accepts most of g++'s options.  It handles a
 number of g++'s extensions to the C++ programming language.
 
@@ -64,24 +61,25 @@ repeated.
 Link in the library libI<name>.[bc | a | so].  This library should
 be a bytecode library.
 
-=item B<-Wl,>I<option>
+=item B<-emit-llvm>
 
-Pass I<option> to the linker (usually gccld).
+Make the output be LLVM bytecode (or assembly) instead of native object (or
+assembly).
 
 =back
 
 =head1 EXIT STATUS
 
-If B<llvmg++> succeeds, it will exit with 0.  Otherwise, if an error
+If B<llvm-g++> succeeds, it will exit with 0.  Otherwise, if an error
 occurs, it will exit with a non-zero value.
 
 =head1 SEE ALSO
 
-L<llvmgcc>, L<gccas>, L<gccld>
+L<llvm-gcc|llvmgcc>
 
 =head1 AUTHORS
 
-Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
+Maintained by the LLVM Team (L<http://llvm.org>).
 
 =cut