fix typo noticed by Joshua Pennington
[oota-llvm.git] / docs / CommandGuide / llvmgcc.pod
index 7e4923cb2019ff1cf141a34ebaf3af7829c5088b..0b2b1566824b71aad7f5ebd44d285cba8489b1d1 100644 (file)
@@ -2,26 +2,23 @@
 
 =head1 NAME
 
-llvmgcc - LLVM C front-end
+llvm-gcc - LLVM C front-end
 
 =head1 SYNOPSIS
 
-B<llvmgcc> [I<options>] I<filename>
+B<llvm-gcc> [I<options>] I<filename>
 
 =head1 DESCRIPTION
 
-The B<llvmgcc> command is the LLVM C front end.  It is a modified
-version of gcc that takes C programs and compiles them into LLVM
-bytecode or assembly language, depending upon the options.
+The B<llvm-gcc> command is the LLVM C front end.  It is a modified
+version of gcc that compiles C/ObjC programs into native objects, LLVM
+bitcode or LLVM assembly language, depending upon the options.
 
-Unless the B<-S> option is specified, B<llvmgcc> 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<llvmgcc>
-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-gcc> compiles to native objects just like GCC does. If the
+B<-emit-llvm> option is given then it will generate LLVM bitcode files instead.
+If B<-S> (assembly) is also given, then it will generate LLVM assembly. 
 
-Being derived from the GNU Compiler Collection, B<llvmgcc> has many
+Being derived from the GNU Compiler Collection, B<llvm-gcc> has many
 of gcc's features and accepts most of gcc's options.  It handles a
 number of gcc's extensions to the C programming language.
 
@@ -35,14 +32,14 @@ Print a summary of command line options.
 
 =item B<-S>
 
-Do not generate an LLVM bytecode file.  Rather, compile the source
+Do not generate an LLVM bitcode file.  Rather, compile the source
 file into an LLVM assembly language file.
 
 =item B<-c>
 
 Do not generate a linked executable.  Rather, compile the source
-file into an LLVM bytecode file.  This bytecode file can then be
-linked with other bytecode files later on to generate a full LLVM
+file into an LLVM bitcode file.  This bitcode file can then be
+linked with other bitcode files later on to generate a full LLVM
 executable.
 
 =item B<-o> I<filename>
@@ -62,26 +59,27 @@ repeated.
 =item B<-l>I<name>
 
 Link in the library libI<name>.[bc | a | so].  This library should
-be a bytecode library.
+be a bitcode library.
 
-=item B<-Wl,>I<option>
+=item B<-emit-llvm>
 
-Pass I<option> to the linker (usually gccld).
+Make the output be LLVM bitcode (or assembly) instead of native object (or
+assembly).
 
 =back
 
 =head1 EXIT STATUS
 
-If B<llvmgcc> succeeds, it will exit with 0.  Otherwise, if an error
+If B<llvm-gcc> succeeds, it will exit with 0.  Otherwise, if an error
 occurs, it will exit with a non-zero value.
 
 =head1 SEE ALSO
 
-L<llvmg++|llvmgxx>, L<gccas|gccas>, L<gccld|gccld>
+L<llvm-g++|llvmgxx>
 
 =head1 AUTHORS
 
-Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
+Maintained by the LLVM Team (L<http://llvm.org>).
 
 =cut