diff options
author | mike-m <mikem.llvm@gmail.com> | 2010-05-07 00:28:04 +0000 |
---|---|---|
committer | mike-m <mikem.llvm@gmail.com> | 2010-05-07 00:28:04 +0000 |
commit | e2c3a49c8029ebd9ef530101cc24c66562e3dff5 (patch) | |
tree | 91bf9600cc8df90cf99751a8f8bafc317cffc91e /docs/CommandGuide/llvm-config.pod | |
parent | c10b5afbe8138b0fdf3af4ed3e1ddf96cf3cb4cb (diff) | |
download | external_llvm-e2c3a49c8029ebd9ef530101cc24c66562e3dff5.zip external_llvm-e2c3a49c8029ebd9ef530101cc24c66562e3dff5.tar.gz external_llvm-e2c3a49c8029ebd9ef530101cc24c66562e3dff5.tar.bz2 |
Revert r103213. It broke several sections of live website.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@103219 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandGuide/llvm-config.pod')
-rw-r--r-- | docs/CommandGuide/llvm-config.pod | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/docs/CommandGuide/llvm-config.pod b/docs/CommandGuide/llvm-config.pod new file mode 100644 index 0000000..4e38dae --- /dev/null +++ b/docs/CommandGuide/llvm-config.pod @@ -0,0 +1,131 @@ +=pod + +=head1 NAME + +llvm-config - Print LLVM compilation options + +=head1 SYNOPSIS + +B<llvm-config> I<option> [I<components>...] + +=head1 DESCRIPTION + +B<llvm-config> makes it easier to build applications that use LLVM. It can +print the compiler flags, linker flags and object libraries needed to link +against LLVM. + +=head1 EXAMPLES + +To link against the JIT: + + g++ `llvm-config --cxxflags` -o HowToUseJIT.o -c HowToUseJIT.cpp + g++ `llvm-config --ldflags` -o HowToUseJIT HowToUseJIT.o \ + `llvm-config --libs engine bcreader scalaropts` + +=head1 OPTIONS + +=over + +=item B<--version> + +Print the version number of LLVM. + +=item B<-help> + +Print a summary of B<llvm-config> arguments. + +=item B<--prefix> + +Print the installation prefix for LLVM. + +=item B<--src-root> + +Print the source root from which LLVM was built. + +=item B<--obj-root> + +Print the object root used to build LLVM. + +=item B<--bindir> + +Print the installation directory for LLVM binaries. + +=item B<--includedir> + +Print the installation directory for LLVM headers. + +=item B<--libdir> + +Print the installation directory for LLVM libraries. + +=item B<--cxxflags> + +Print the C++ compiler flags needed to use LLVM headers. + +=item B<--ldflags> + +Print the flags needed to link against LLVM libraries. + +=item B<--libs> + +Print all the libraries needed to link against the specified LLVM +I<components>, including any dependencies. + +=item B<--libnames> + +Similar to B<--libs>, but prints the bare filenames of the libraries +without B<-l> or pathnames. Useful for linking against a not-yet-installed +copy of LLVM. + +=item B<--libfiles> + +Similar to B<--libs>, but print the full path to each library file. This is +useful when creating makefile dependencies, to ensure that a tool is relinked if +any library it uses changes. + +=item B<--components> + +Print all valid component names. + +=item B<--targets-built> + +Print the component names for all targets supported by this copy of LLVM. + +=item B<--build-mode> + +Print the build mode used when LLVM was built (e.g. Debug or Release) + +=back + +=head1 COMPONENTS + +To print a list of all available components, run B<llvm-config +--components>. In most cases, components correspond directly to LLVM +libraries. Useful "virtual" components include: + +=over + +=item B<all> + +Includes all LLVM libaries. The default if no components are specified. + +=item B<backend> + +Includes either a native backend or the C backend. + +=item B<engine> + +Includes either a native JIT or the bitcode interpreter. + +=back + +=head1 EXIT STATUS + +If B<llvm-config> succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. + +=head1 AUTHORS + +Maintained by the LLVM Team (L<http://llvm.org>). + +=cut |