5 llvmc - The LLVM Compiler Driver (WIP)
9 B<llvmc> [I<options>] I<filenames...>
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.
20 =head2 Built-in Options
22 LLVMC has some built-in options that can't be overridden in the
23 configuration libraries.
27 =item B<-o> I<filename>
31 =item B<-x> I<language>
33 Specify the language of the following input files until the next B<-x>
36 =item B<-load> I<plugin_name>
38 Load the specified plugin DLL. Example:
39 S<-load $LLVM_DIR/Release/lib/LLVMCSimple.so>.
41 =item B<-v> or B<--verbose>
43 Enable verbose mode, i.e. print out all executed commands.
45 =item B<--check-graph>
47 Check the compilation for common errors like mismatched output/input language
48 names, multiple default edges and cycles. Because of plugins, these checks can't
49 be performed at compile-time. Exit with code zero if no errors were found, and
50 return the number of found errors otherwise. Hidden option, useful for debugging
55 Show a graphical representation of the compilation graph and exit. Requires that
56 you have I<dot> and I<gv> programs installed. Hidden option, useful for
57 debugging LLVMC plugins.
59 =item B<--write-graph>
61 Write a I<compilation-graph.dot> file in the current directory with the
62 compilation graph description in Graphviz format (identical to the file used by
63 the B<--view-graph> option). The B<-o> option can be used to set the output file
64 name. Hidden option, useful for debugging LLVMC plugins.
68 Write temporary files to the current directory and do not delete them on
69 exit. This option can also take an argument: the I<--save-temps=obj> switch will
70 write files into the directory specified with the I<-o> option. The
71 I<--save-temps=cwd> and I<--save-temps> switches are both synonyms for the
74 =item B<--temp-dir> I<directory>
76 Write temporary files to the specified directory. This option overrides
81 Print a summary of command-line options and exit.
83 =item B<--help-hidden>
85 Print a summary of command-line options and exit. Print help even for
86 options intended for developers.
90 Print version information and exit.
94 Read command-line options from I<file>. The options read are inserted
95 in place of the original @I<file> option. If I<file> does not exist, or
96 cannot be read, then the option will be treated literally, and not
99 Options in I<file> are separated by whitespace. A whitespace character
100 may be included in an option by surrounding the entire option in
101 either single or double quotes. Any character (including a backslash)
102 may be included by prefixing the character to be included with a
103 backslash. The file may itself contain additional @I<file> options;
104 any such options will be processed recursively.
110 =head2 Control Options
112 By default, LLVMC is built with some standard configuration libraries
113 that define the following options:
119 Use Clang instead of llvm-gcc.
123 Enable optimization passes with B<opt>. To pass options to the B<opt> program
124 use the B<-Wo,> option.
126 =item B<-I> I<directory>
128 Add a directory to the header file search path. This option can be
131 =item B<-L> I<directory>
133 Add I<directory> to the library search path. This option can be
138 Link in the library libI<name>.[bc | a | so]. This library should
139 be a bitcode library.
143 Make the output be LLVM bitcode (with B<-c>) or assembly (with B<-S>) instead
144 of native object (or assembly). If B<-emit-llvm> is given without either B<-c>
145 or B<-S> it has no effect.
149 Pass options to assembler.
153 Pass options to linker.
163 If B<llvmc> succeeds, it will exit with code 0. Otherwise, if an
164 error occurs, it will exit with a non-zero value. If one of the
165 compilation tools returns a non-zero status, pending actions will be
166 discarded and B<llvmc> will return the same result code as the failing
171 L<llvm-gcc|llvmgcc>, L<llvm-g++|llvmgxx>, L<llvm-as|llvm-as>,
172 L<llvm-dis|llvm-dis>, L<llc|llc>, L<llvm-link|llvm-link>
176 Maintained by the LLVM Team (L<http://llvm.org>).