1 .\" Man page generated from reStructuredText.

     2 .

     3 .TH "LLVM-CONFIG" "1" "2016-07-10" "3.8" "LLVM"

     4 .SH NAME

     5 llvm-config \- Print LLVM compilation options

     6 .

     7 .nr rst2man-indent-level 0

     8 .

     9 .de1 rstReportMargin

    10 \\$1 \\n[an-margin]

    11 level \\n[rst2man-indent-level]

    12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]

    13 -

    14 \\n[rst2man-indent0]

    15 \\n[rst2man-indent1]

    16 \\n[rst2man-indent2]

    17 ..

    18 .de1 INDENT

    19 .\" .rstReportMargin pre:

    20 . RS \\$1

    21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]

    22 . nr rst2man-indent-level +1

    23 .\" .rstReportMargin post:

    24 ..

    25 .de UNINDENT

    26 . RE

    27 .\" indent \\n[an-margin]

    28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]

    29 .nr rst2man-indent-level -1

    30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]

    31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u

    32 ..

    33 .SH SYNOPSIS

    34 .sp

    35 \fBllvm\-config\fP \fIoption\fP [\fIcomponents\fP\&...]

    36 .SH DESCRIPTION

    37 .sp

    38 \fBllvm\-config\fP makes it easier to build applications that use LLVM.  It can

    39 print the compiler flags, linker flags and object libraries needed to link

    40 against LLVM.

    41 .SH EXAMPLES

    42 .sp

    43 To link against the JIT:

    44 .INDENT 0.0

    45 .INDENT 3.5

    46 .sp

    47 .nf

    48 .ft C

    49 g++ \(gallvm\-config \-\-cxxflags\(ga \-o HowToUseJIT.o \-c HowToUseJIT.cpp

    50 g++ \(gallvm\-config \-\-ldflags\(ga \-o HowToUseJIT HowToUseJIT.o \e

    51     \(gallvm\-config \-\-libs engine bcreader scalaropts\(ga

    52 .ft P

    53 .fi

    54 .UNINDENT

    55 .UNINDENT

    56 .SH OPTIONS

    57 .sp

    58 \fB\-\-version\fP

    59 .INDENT 0.0

    60 .INDENT 3.5

    61 Print the version number of LLVM.

    62 .UNINDENT

    63 .UNINDENT

    64 .sp

    65 \fB\-help\fP

    66 .INDENT 0.0

    67 .INDENT 3.5

    68 Print a summary of \fBllvm\-config\fP arguments.

    69 .UNINDENT

    70 .UNINDENT

    71 .sp

    72 \fB\-\-prefix\fP

    73 .INDENT 0.0

    74 .INDENT 3.5

    75 Print the installation prefix for LLVM.

    76 .UNINDENT

    77 .UNINDENT

    78 .sp

    79 \fB\-\-src\-root\fP

    80 .INDENT 0.0

    81 .INDENT 3.5

    82 Print the source root from which LLVM was built.

    83 .UNINDENT

    84 .UNINDENT

    85 .sp

    86 \fB\-\-obj\-root\fP

    87 .INDENT 0.0

    88 .INDENT 3.5

    89 Print the object root used to build LLVM.

    90 .UNINDENT

    91 .UNINDENT

    92 .sp

    93 \fB\-\-bindir\fP

    94 .INDENT 0.0

    95 .INDENT 3.5

    96 Print the installation directory for LLVM binaries.

    97 .UNINDENT

    98 .UNINDENT

    99 .sp

   100 \fB\-\-includedir\fP

   101 .INDENT 0.0

   102 .INDENT 3.5

   103 Print the installation directory for LLVM headers.

   104 .UNINDENT

   105 .UNINDENT

   106 .sp

   107 \fB\-\-libdir\fP

   108 .INDENT 0.0

   109 .INDENT 3.5

   110 Print the installation directory for LLVM libraries.

   111 .UNINDENT

   112 .UNINDENT

   113 .sp

   114 \fB\-\-cxxflags\fP

   115 .INDENT 0.0

   116 .INDENT 3.5

   117 Print the C++ compiler flags needed to use LLVM headers.

   118 .UNINDENT

   119 .UNINDENT

   120 .sp

   121 \fB\-\-ldflags\fP

   122 .INDENT 0.0

   123 .INDENT 3.5

   124 Print the flags needed to link against LLVM libraries.

   125 .UNINDENT

   126 .UNINDENT

   127 .sp

   128 \fB\-\-libs\fP

   129 .INDENT 0.0

   130 .INDENT 3.5

   131 Print all the libraries needed to link against the specified LLVM

   132 \fIcomponents\fP, including any dependencies.

   133 .UNINDENT

   134 .UNINDENT

   135 .sp

   136 \fB\-\-libnames\fP

   137 .INDENT 0.0

   138 .INDENT 3.5

   139 Similar to \fB\-\-libs\fP, but prints the bare filenames of the libraries

   140 without \fB\-l\fP or pathnames.  Useful for linking against a not\-yet\-installed

   141 copy of LLVM.

   142 .UNINDENT

   143 .UNINDENT

   144 .sp

   145 \fB\-\-libfiles\fP

   146 .INDENT 0.0

   147 .INDENT 3.5

   148 Similar to \fB\-\-libs\fP, but print the full path to each library file.  This is

   149 useful when creating makefile dependencies, to ensure that a tool is relinked if

   150 any library it uses changes.

   151 .UNINDENT

   152 .UNINDENT

   153 .sp

   154 \fB\-\-components\fP

   155 .INDENT 0.0

   156 .INDENT 3.5

   157 Print all valid component names.

   158 .UNINDENT

   159 .UNINDENT

   160 .sp

   161 \fB\-\-targets\-built\fP

   162 .INDENT 0.0

   163 .INDENT 3.5

   164 Print the component names for all targets supported by this copy of LLVM.

   165 .UNINDENT

   166 .UNINDENT

   167 .sp

   168 \fB\-\-build\-mode\fP

   169 .INDENT 0.0

   170 .INDENT 3.5

   171 Print the build mode used when LLVM was built (e.g. Debug or Release)

   172 .UNINDENT

   173 .UNINDENT

   174 .SH COMPONENTS

   175 .sp

   176 To print a list of all available components, run \fBllvm\-config

   177 \-\-components\fP\&.  In most cases, components correspond directly to LLVM

   178 libraries.  Useful "virtual" components include:

   179 .sp

   180 \fBall\fP

   181 .INDENT 0.0

   182 .INDENT 3.5

   183 Includes all LLVM libraries.  The default if no components are specified.

   184 .UNINDENT

   185 .UNINDENT

   186 .sp

   187 \fBbackend\fP

   188 .INDENT 0.0

   189 .INDENT 3.5

   190 Includes either a native backend or the C backend.

   191 .UNINDENT

   192 .UNINDENT

   193 .sp

   194 \fBengine\fP

   195 .INDENT 0.0

   196 .INDENT 3.5

   197 Includes either a native JIT or the bitcode interpreter.

   198 .UNINDENT

   199 .UNINDENT

   200 .SH EXIT STATUS

   201 .sp

   202 If \fBllvm\-config\fP succeeds, it will exit with 0.  Otherwise, if an error

   203 occurs, it will exit with a non\-zero value.

   204 .SH AUTHOR

   205 Maintained by The LLVM Team (http://llvm.org/).

   206 .SH COPYRIGHT

   207 2003-2016, LLVM Project

   208 .\" Generated by docutils manpage writer.

   209 .