| Mikhail Glushenkov | a606d1f | 2008-11-25 21:38:38 +0000 | [diff] [blame^] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | llvmc - The LLVM Compiler Driver (WIP) |
| 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| 9 | B<llvmc> [I<options>] I<filenames...> |
| 10 | |
| 11 | =head1 DESCRIPTION |
| 12 | |
| 13 | B<llvmc> is a configurable driver for invoking other LLVM (and non-LLVM) tools |
| 14 | in order to compile, optimize and link software for multiple languages. For |
| 15 | those familiar with FSF's B<gcc> tool, it is very similar. Please note that |
| 16 | B<llvmc> is considered an experimental tool. |
| 17 | |
| 18 | =head1 OPTIONS |
| 19 | |
| 20 | =over |
| 21 | |
| 22 | =item B<--help> |
| 23 | |
| 24 | Print a summary of command line options. |
| 25 | |
| 26 | =item B<-o> I<filename> |
| 27 | |
| 28 | Specify the output file to be I<filename>. |
| 29 | |
| 30 | =item B<-I> I<directory> |
| 31 | |
| 32 | Add a directory to the header file search path. This option can be |
| 33 | repeated. |
| 34 | |
| 35 | =item B<-L> I<directory> |
| 36 | |
| 37 | Add I<directory> to the library search path. This option can be |
| 38 | repeated. |
| 39 | |
| 40 | =item B<-l>I<name> |
| 41 | |
| 42 | Link in the library libI<name>.[bc | a | so]. This library should |
| 43 | be a bitcode library. |
| 44 | |
| 45 | =item B<-emit-llvm> |
| 46 | |
| 47 | Make the output be LLVM bitcode (with B<-c>) or assembly (with B<-s>) instead |
| 48 | of native object (or assembly). If B<-emit-llvm> is given without either B<-c> |
| 49 | or B<-S> it has no effect. |
| 50 | |
| 51 | =back |
| 52 | |
| 53 | =head1 EXIT STATUS |
| 54 | |
| 55 | If B<llvmc> succeeds, it will exit with 0. Otherwise, if an error |
| 56 | occurs, it will exit with a non-zero value. If one of the compilation |
| 57 | tools returns a non-zero status, pending actions will be discarded and |
| 58 | B<llvmc> will return the same result code as the failing compilation |
| 59 | tool. |
| 60 | |
| 61 | =head1 SEE ALSO |
| 62 | |
| 63 | L<llvm-gcc|llvmgcc>, L<llvm-g++|llvmgxx>, L<llvm-as|llvm-as>, |
| 64 | L<llvm-dis|llvm-dis>, L<llc|llc>, L<llvm-link|llvm-link> |
| 65 | |
| 66 | =head1 AUTHORS |
| 67 | |
| 68 | Maintained by the LLVM Team (L<http://llvm.org>). |
| 69 | |
| 70 | =cut |