Prevented ExceptionDemo example being built on WINDOWS via if( NOT WIN32 )

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

diff --git a/docs/CommandGuide/llvmgcc.pod b/docs/CommandGuide/llvmgcc.pod
index 4cbf728380149e6a1559d8fd4077b9e96c8d3f98..9892ca71861e37fd9f9bb4199041502b91050fd5 100644 (file)
--- a/docs/CommandGuide/llvmgcc.pod
+++ b/docs/CommandGuide/llvmgcc.pod
@@ -1,30 +1,28 @@
-
 =pod
 
 =head1 NAME
 
-llvmgcc - LLVM C front-end
+llvm-gcc - LLVM C front-end
 
 =head1 SYNOPSIS
 
-llvmgcc [options] 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> and B<-c> options are given then it will generate LLVM bitcode files
+instead. If B<-emit-llvm> and B<-S> are 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.
+number of gcc's extensions to the C programming language.  See the gcc
+documentation for details.
 
 =head1 OPTIONS
 
@@ -34,18 +32,6 @@ number of gcc's extensions to the C programming language.
 
 Print a summary of command line options.
 
-=item B<-S>
-
-Do not generate an LLVM bytecode 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
-executable.
-
 =item B<-o> I<filename>
 
 Specify the output file to be I<filename>.
@@ -63,26 +49,28 @@ 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 (with B<-c>) or assembly (with B<-s>) instead
+of native object (or assembly).  If B<-emit-llvm> is given without either B<-c>
+or B<-S> it has no effect.
 
 =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<llvmgxx>, L<gccas>, L<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