docs/CommandGuide/llvmc.pod

   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 =head2 Built-in Options
  21
  22 LLVMC has some built-in options that can't be overridden in the
  23 configuration libraries.
  24
  25 =over
  26
  27 =item B<-o> I<filename>
  28
  29 Output file name.
  30
  31 =item B<-x> I<language>
  32
  33 Specify the language of the following input files until the next B<-x>
  34 option.
  35
  36 =item B<-load> I<plugin_name>
  37
  38 Load the specified plugin DLL. Example:
  39 S<-load $LLVM_DIR/Release/lib/LLVMCSimple.so>.
  40
  41 =item B<-v> or B<--verbose>
  42
  43 Enable verbose mode, i.e. print out all executed commands.
  44
  45 =item B<--check-graph>
  46
  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
  51 LLVMC plugins.
  52
  53 =item B<--view-graph>
  54
  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.
  58
  59 =item B<--write-graph>
  60
  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.
  65
  66 =item B<--save-temps>
  67
  68 Write temporary files to the current directory and do not delete them
  69 on exit. Hidden option, useful for debugging.
  70
  71 =item B<--help>
  72
  73 Print a summary of command-line options and exit.
  74
  75 =item B<--help-hidden>
  76
  77 Print a summary of command-line options and exit. Print help even for
  78 options intended for developers.
  79
  80 =item B<--version>
  81
  82 Print version information and exit.
  83
  84 =item B<@>I<file>
  85
  86 Read command-line options from I<file>. The options read are inserted
  87 in place of the original @I<file> option. If I<file> does not exist, or
  88 cannot be read, then the option will be treated literally, and not
  89 removed.
  90
  91 Options in I<file> are separated by whitespace. A whitespace character
  92 may be included in an option by surrounding the entire option in
  93 either single or double quotes. Any character (including a backslash)
  94 may be included by prefixing the character to be included with a
  95 backslash. The file may itself contain additional @I<file> options;
  96 any such options will be processed recursively.
  97
  98
  99 =back
 100
 101
 102 =head2 Control Options
 103
 104 By default, LLVMC is built with some standard configuration libraries
 105 that define the following options:
 106
 107 =over
 108
 109 =item B<-clang>
 110
 111 Use Clang instead of llvm-gcc.
 112
 113 =item B<-opt>
 114
 115 Enable optimization passes with B<opt>. To pass options to the B<opt> program
 116 use the B<-Wo,> option.
 117
 118 =item B<-I> I<directory>
 119
 120 Add a directory to the header file search path.  This option can be
 121 repeated.
 122
 123 =item B<-L> I<directory>
 124
 125 Add I<directory> to the library search path.  This option can be
 126 repeated.
 127
 128 =item B<-l>I<name>
 129
 130 Link in the library libI<name>.[bc | a | so].  This library should
 131 be a bitcode library.
 132
 133 =item B<-emit-llvm>
 134
 135 Make the output be LLVM bitcode (with B<-c>) or assembly (with B<-S>) instead
 136 of native object (or assembly).  If B<-emit-llvm> is given without either B<-c>
 137 or B<-S> it has no effect.
 138
 139 =item B<-Wa>
 140
 141 Pass options to assembler.
 142
 143 =item B<-Wl>
 144
 145 Pass options to linker.
 146
 147 =item B<-Wo>
 148
 149 Pass options to opt.
 150
 151 =back
 152
 153 =head1 EXIT STATUS
 154
 155 If B<llvmc> succeeds, it will exit with code 0.  Otherwise, if an
 156 error occurs, it will exit with a non-zero value. If one of the
 157 compilation tools returns a non-zero status, pending actions will be
 158 discarded and B<llvmc> will return the same result code as the failing
 159 compilation tool.
 160
 161 =head1 SEE ALSO
 162
 163 L<llvm-gcc|llvmgcc>, L<llvm-g++|llvmgxx>, L<llvm-as|llvm-as>,
 164 L<llvm-dis|llvm-dis>, L<llc|llc>, L<llvm-link|llvm-link>
 165
 166 =head1 AUTHORS
 167
 168 Maintained by the LLVM Team (L<http://llvm.org>).
 169
 170 =cut