freebsd-skq/usr.bin/clang/llvm-extract/llvm-extract.1
Dimitry Andric 7ae0e2c9f0 Upgrade our copy of llvm/clang to trunk r162107. With thanks to
Benjamin Kramer and Joerg Sonnenberger for their input and fixes.
2012-08-20 18:33:03 +00:00

129 lines
3.5 KiB
Groff

.\" $FreeBSD$
.TH "LLVM-EXTRACT" "1" "2012-08-16" "3.2" "LLVM"
.SH NAME
llvm-extract \- extract a function from an LLVM module
.
.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
..
.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.sp
\fBllvm\-extract\fP [\fIoptions\fP] \fB\-\-func\fP \fIfunction\-name\fP [\fIfilename\fP]
.SH DESCRIPTION
.sp
The \fBllvm\-extract\fP command takes the name of a function and extracts it from
the specified LLVM bitcode file. It is primarily used as a debugging tool to
reduce test cases from larger programs that are triggering a bug.
.sp
In addition to extracting the bitcode of the specified function,
\fBllvm\-extract\fP will also remove unreachable global variables, prototypes, and
unused types.
.sp
The \fBllvm\-extract\fP command reads its input from standard input if filename is
omitted or if filename is \-. The output is always written to standard output,
unless the \fB\-o\fP option is specified (see below).
.SH OPTIONS
.sp
\fB\-f\fP
.INDENT 0.0
.INDENT 3.5
Enable binary output on terminals. Normally, \fBllvm\-extract\fP will refuse to
write raw bitcode output if the output stream is a terminal. With this option,
\fBllvm\-extract\fP will write raw bitcode regardless of the output device.
.UNINDENT
.UNINDENT
.sp
\fB\-\-func\fP \fIfunction\-name\fP
.INDENT 0.0
.INDENT 3.5
Extract the function named \fIfunction\-name\fP from the LLVM bitcode. May be
specified multiple times to extract multiple functions at once.
.UNINDENT
.UNINDENT
.sp
\fB\-\-rfunc\fP \fIfunction\-regular\-expr\fP
.INDENT 0.0
.INDENT 3.5
Extract the function(s) matching \fIfunction\-regular\-expr\fP from the LLVM bitcode.
All functions matching the regular expression will be extracted. May be
specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-\-glob\fP \fIglobal\-name\fP
.INDENT 0.0
.INDENT 3.5
Extract the global variable named \fIglobal\-name\fP from the LLVM bitcode. May be
specified multiple times to extract multiple global variables at once.
.UNINDENT
.UNINDENT
.sp
\fB\-\-rglob\fP \fIglob\-regular\-expr\fP
.INDENT 0.0
.INDENT 3.5
Extract the global variable(s) matching \fIglobal\-regular\-expr\fP from the LLVM
bitcode. All global variables matching the regular expression will be extracted.
May be specified multiple times.
.UNINDENT
.UNINDENT
.sp
\fB\-help\fP
.INDENT 0.0
.INDENT 3.5
Print a summary of command line options.
.UNINDENT
.UNINDENT
.sp
\fB\-o\fP \fIfilename\fP
.INDENT 0.0
.INDENT 3.5
Specify the output filename. If filename is "\-" (the default), then
\fBllvm\-extract\fP sends its output to standard output.
.UNINDENT
.UNINDENT
.sp
\fB\-S\fP
.INDENT 0.0
.INDENT 3.5
Write output in LLVM intermediate language (instead of bitcode).
.UNINDENT
.UNINDENT
.SH EXIT STATUS
.sp
If \fBllvm\-extract\fP succeeds, it will exit with 0. Otherwise, if an error
occurs, it will exit with a non\-zero value.
.SH SEE ALSO
.sp
bugpoint|bugpoint
.SH AUTHOR
Maintained by The LLVM Team (http://llvm.org/).
.SH COPYRIGHT
2012, LLVM Project
.\" Generated by docutils manpage writer.
.