docs/CommandGuide/llvmgcc.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 llvmgcc - LLVM C front-end
   6
   7 =head1 SYNOPSIS
   8
   9 B<llvmgcc> [I<options>] I<filename>
  10
  11 =head1 DESCRIPTION
  12
  13 The B<llvmgcc> command is the LLVM C front end.  It is a modified
  14 version of gcc that takes C programs and compiles them into LLVM
  15 bytecode or assembly language, depending upon the options.
  16
  17 Unless the B<-S> option is specified, B<llvmgcc> will use the
  18 L<gccas|gccas> program to perform some optimizations and create an
  19 LLVM bytecode file. Unless the B<-c> option is specified, B<llvmgcc>
  20 will also use the L<gccld|gccld> program to perform further
  21 optimizations and link the resulting bytecode file(s) with support
  22 libraries to create an executable program.
  23
  24 Being derived from the GNU Compiler Collection, B<llvmgcc> has many
  25 of gcc's features and accepts most of gcc's options.  It handles a
  26 number of gcc's extensions to the C programming language.
  27
  28 =head1 OPTIONS
  29
  30 =over
  31
  32 =item B<--help>
  33
  34 Print a summary of command line options.
  35
  36 =item B<-S>
  37
  38 Do not generate an LLVM bytecode file.  Rather, compile the source
  39 file into an LLVM assembly language file.
  40
  41 =item B<-c>
  42
  43 Do not generate a linked executable.  Rather, compile the source
  44 file into an LLVM bytecode file.  This bytecode file can then be
  45 linked with other bytecode files later on to generate a full LLVM
  46 executable.
  47
  48 =item B<-o> I<filename>
  49
  50 Specify the output file to be I<filename>.
  51
  52 =item B<-I> I<directory>
  53
  54 Add a directory to the header file search path.  This option can be
  55 repeated.
  56
  57 =item B<-L> I<directory>
  58
  59 Add I<directory> to the library search path.  This option can be
  60 repeated.
  61
  62 =item B<-l>I<name>
  63
  64 Link in the library libI<name>.[bc | a | so].  This library should
  65 be a bytecode library.
  66
  67 =item B<-Wl,>I<option>
  68
  69 Pass I<option> to the linker (usually gccld).
  70
  71 =back
  72
  73 =head1 EXIT STATUS
  74
  75 If B<llvmgcc> succeeds, it will exit with 0.  Otherwise, if an error
  76 occurs, it will exit with a non-zero value.
  77
  78 =head1 SEE ALSO
  79
  80 L<llvmg++|llvmgxx>, L<gccas|gccas>, L<gccld|gccld>
  81
  82 =head1 AUTHORS
  83
  84 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
  85
  86 =cut
  87