summaryrefslogtreecommitdiff
path: root/gnu/usr.bin/clang/llvm-config
diff options
context:
space:
mode:
authorJonathan Gray <jsg@cvs.openbsd.org>2019-03-05 14:01:09 +0000
committerJonathan Gray <jsg@cvs.openbsd.org>2019-03-05 14:01:09 +0000
commit4c48a13c977c87b6d73fd38635e4de2580f63f93 (patch)
tree6c6f88ec817a6ee0f572d68b61ab785c772efe57 /gnu/usr.bin/clang/llvm-config
parent5f4ff9fdd7d3334abf4f66de54cee28c8d406cac (diff)
add llvm-config.1 from llvm-config.rst
Generated with gmake and py-sphinx installed via cd /usr/src/gnu/llvm/docs && gmake -f Makefile.sphinx man
Diffstat (limited to 'gnu/usr.bin/clang/llvm-config')
-rw-r--r--gnu/usr.bin/clang/llvm-config/Makefile3
-rw-r--r--gnu/usr.bin/clang/llvm-config/llvm-config.1209
2 files changed, 210 insertions, 2 deletions
diff --git a/gnu/usr.bin/clang/llvm-config/Makefile b/gnu/usr.bin/clang/llvm-config/Makefile
index 56eb9ed5775..14de86eda2c 100644
--- a/gnu/usr.bin/clang/llvm-config/Makefile
+++ b/gnu/usr.bin/clang/llvm-config/Makefile
@@ -1,8 +1,7 @@
-# $OpenBSD: Makefile,v 1.1 2019/03/05 01:55:18 jsg Exp $
+# $OpenBSD: Makefile,v 1.2 2019/03/05 14:01:08 jsg Exp $
PROG= llvm-config
BINDIR= /usr/bin
-NOMAN=
NATIVE_ARCHS=AArch64 ARM Mips PowerPC Sparc X86
diff --git a/gnu/usr.bin/clang/llvm-config/llvm-config.1 b/gnu/usr.bin/clang/llvm-config/llvm-config.1
new file mode 100644
index 00000000000..05ed4c89543
--- /dev/null
+++ b/gnu/usr.bin/clang/llvm-config/llvm-config.1
@@ -0,0 +1,209 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "LLVM-CONFIG" "1" "2019-03-05" "7" "LLVM"
+.SH NAME
+llvm-config \- Print LLVM compilation options
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.sp
+\fBllvm\-config\fP \fIoption\fP [\fIcomponents\fP\&...]
+.SH DESCRIPTION
+.sp
+\fBllvm\-config\fP 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.
+.SH EXAMPLES
+.sp
+To link against the JIT:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+g++ \(gallvm\-config \-\-cxxflags\(ga \-o HowToUseJIT.o \-c HowToUseJIT.cpp
+g++ \(gallvm\-config \-\-ldflags\(ga \-o HowToUseJIT HowToUseJIT.o \e
+ \(gallvm\-config \-\-libs engine bcreader scalaropts\(ga
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH OPTIONS
+.sp
+\fB\-\-version\fP
+.INDENT 0.0
+.INDENT 3.5
+Print the version number of LLVM.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-help\fP
+.INDENT 0.0
+.INDENT 3.5
+Print a summary of \fBllvm\-config\fP arguments.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-prefix\fP
+.INDENT 0.0
+.INDENT 3.5
+Print the installation prefix for LLVM.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-src\-root\fP
+.INDENT 0.0
+.INDENT 3.5
+Print the source root from which LLVM was built.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-obj\-root\fP
+.INDENT 0.0
+.INDENT 3.5
+Print the object root used to build LLVM.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-bindir\fP
+.INDENT 0.0
+.INDENT 3.5
+Print the installation directory for LLVM binaries.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-includedir\fP
+.INDENT 0.0
+.INDENT 3.5
+Print the installation directory for LLVM headers.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-libdir\fP
+.INDENT 0.0
+.INDENT 3.5
+Print the installation directory for LLVM libraries.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-cxxflags\fP
+.INDENT 0.0
+.INDENT 3.5
+Print the C++ compiler flags needed to use LLVM headers.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-ldflags\fP
+.INDENT 0.0
+.INDENT 3.5
+Print the flags needed to link against LLVM libraries.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-libs\fP
+.INDENT 0.0
+.INDENT 3.5
+Print all the libraries needed to link against the specified LLVM
+\fIcomponents\fP, including any dependencies.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-libnames\fP
+.INDENT 0.0
+.INDENT 3.5
+Similar to \fB\-\-libs\fP, but prints the bare filenames of the libraries
+without \fB\-l\fP or pathnames. Useful for linking against a not\-yet\-installed
+copy of LLVM.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-libfiles\fP
+.INDENT 0.0
+.INDENT 3.5
+Similar to \fB\-\-libs\fP, 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.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-components\fP
+.INDENT 0.0
+.INDENT 3.5
+Print all valid component names.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-targets\-built\fP
+.INDENT 0.0
+.INDENT 3.5
+Print the component names for all targets supported by this copy of LLVM.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\-\-build\-mode\fP
+.INDENT 0.0
+.INDENT 3.5
+Print the build mode used when LLVM was built (e.g. Debug or Release)
+.UNINDENT
+.UNINDENT
+.SH COMPONENTS
+.sp
+To print a list of all available components, run \fBllvm\-config
+\-\-components\fP\&. In most cases, components correspond directly to LLVM
+libraries. Useful "virtual" components include:
+.sp
+\fBall\fP
+.INDENT 0.0
+.INDENT 3.5
+Includes all LLVM libraries. The default if no components are specified.
+.UNINDENT
+.UNINDENT
+.sp
+\fBbackend\fP
+.INDENT 0.0
+.INDENT 3.5
+Includes either a native backend or the C backend.
+.UNINDENT
+.UNINDENT
+.sp
+\fBengine\fP
+.INDENT 0.0
+.INDENT 3.5
+Includes either a native JIT or the bitcode interpreter.
+.UNINDENT
+.UNINDENT
+.SH EXIT STATUS
+.sp
+If \fBllvm\-config\fP succeeds, it will exit with 0. Otherwise, if an error
+occurs, it will exit with a non\-zero value.
+.SH AUTHOR
+Maintained by The LLVM Team (http://llvm.org/).
+.SH COPYRIGHT
+2003-2019, LLVM Project
+.\" Generated by docutils manpage writer.
+.