view head/usr.bin/clang/llvm-extract/llvm-extract.1 @ 373:a085b3559102

Update to FreeBSD-HEAD @232391
date Fri, 02 Mar 2012 17:02:21 +0200
children f2935497fa04
line wrap: on
line source
.\" $FreeBSD: head/usr.bin/clang/llvm-extract/llvm-extract.1 231057 2012-02-05 23:56:22Z dim $
.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
.de Vb \" Begin verbatim text
.ft CW
.ne \\$1
.de Ve \" End verbatim text
.ft R
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
.    nr % 0
.    rr F
.el \{\
.    de IX
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.rm #[ #] #H #V #F C
.\" ========================================================================
.TH LLVM-EXTRACT 1 "2011-10-17" "LLVM 3.0" "LLVM Command Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
llvm\-extract \- extract a function from an LLVM module
\&\fBllvm-extract\fR [\fIoptions\fR] \fB\-\-func\fR \fIfunction-name\fR [\fIfilename\fR]
The \fBllvm-extract\fR command takes the name of a function and extracts it from
the specified \s-1LLVM\s0 bitcode file.  It is primarily used as a debugging tool to
reduce test cases from larger programs that are triggering a bug.
In addition to extracting the bitcode of the specified function,
\&\fBllvm-extract\fR will also remove unreachable global variables, prototypes, and
unused types.
The \fBllvm-extract\fR 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\fR option is specified (see below).
.IX Header "OPTIONS"
.IP "\fB\-f\fR" 4
.IX Item "-f"
Enable binary output on terminals.  Normally, \fBllvm-extract\fR will refuse to
write raw bitcode output if the output stream is a terminal. With this option,
\&\fBllvm-extract\fR will write raw bitcode regardless of the output device.
.IP "\fB\-\-func\fR \fIfunction-name\fR" 4
.IX Item "--func function-name"
Extract the function named \fIfunction-name\fR from the \s-1LLVM\s0 bitcode. May be
specified multiple times to extract multiple functions at once.
.IP "\fB\-\-rfunc\fR \fIfunction-regular-expr\fR" 4
.IX Item "--rfunc function-regular-expr"
Extract the function(s) matching \fIfunction-regular-expr\fR from the \s-1LLVM\s0 bitcode.
All functions matching the regular expression will be extracted.  May be 
specified multiple times.
.IP "\fB\-\-glob\fR \fIglobal-name\fR" 4
.IX Item "--glob global-name"
Extract the global variable named \fIglobal-name\fR from the \s-1LLVM\s0 bitcode. May be
specified multiple times to extract multiple global variables at once.
.IP "\fB\-\-rglob\fR \fIglob-regular-expr\fR" 4
.IX Item "--rglob glob-regular-expr"
Extract the global variable(s) matching \fIglobal-regular-expr\fR from the \s-1LLVM\s0
bitcode. All global variables matching the regular expression will be extracted.
May be specified multiple times.
.IP "\fB\-help\fR" 4
.IX Item "-help"
Print a summary of command line options.
.IP "\fB\-o\fR \fIfilename\fR" 4
.IX Item "-o filename"
Specify the output filename.  If filename is \*(L"\-\*(R" (the default), then
\&\fBllvm-extract\fR sends its output to standard output.
.IP "\fB\-S\fR" 4
.IX Item "-S"
Write output in \s-1LLVM\s0 intermediate language (instead of bitcode).
If \fBllvm-extract\fR succeeds, it will exit with 0.  Otherwise, if an error
occurs, it will exit with a non-zero value.
.IX Header "SEE ALSO"
.IX Header "AUTHORS"
Maintained by the \s-1LLVM\s0 Team (<>).